mirror of
https://github.com/moodle/moodle.git
synced 2025-04-21 16:32:18 +02:00
Merge branch 'MDL-84555-main' of https://github.com/ferranrecio/moodle
This commit is contained in:
commit
c8e4bbe938
14
.upgradenotes/MDL-84555-2025031404100029.yml
Normal file
14
.upgradenotes/MDL-84555-2025031404100029.yml
Normal file
@ -0,0 +1,14 @@
|
||||
issueNumber: MDL-84555
|
||||
notes:
|
||||
core_course:
|
||||
- message: >-
|
||||
New core_course\output\activity_icon class to render activity icons with
|
||||
or without purpose color. This output will centralize the way Moodle
|
||||
renders activity icons
|
||||
type: improved
|
||||
core:
|
||||
- message: >-
|
||||
The new PHP enum core\output\local\properties\iconsize can be used to limit
|
||||
the amount of icons sizes an output component can use. The enum has the
|
||||
same values available in the theme_boost scss.
|
||||
type: improved
|
@ -9,43 +9,100 @@ tags:
|
||||
- Available
|
||||
- '4.0'
|
||||
- Updated
|
||||
- '4.4'
|
||||
- '5.0'
|
||||
---
|
||||
|
||||
## Activity icon types
|
||||
|
||||
Moodle activity icons are single black SVG icons that are stored in `mod/PLUGINNAME/pix/monologo.svg`.
|
||||
|
||||
### Minimal activity icons
|
||||
## Rendering activity icons
|
||||
|
||||
The `core_course\output\activity_icon` class is used to render activity icons. It can be used in several ways depending on the context. Also, there is the `core_course\activity_icon` template that can be included directly from mustache templates.
|
||||
|
||||
### Rendering the activity plugin icon
|
||||
|
||||
The following example shows how to render the default activity icon:
|
||||
|
||||
{{< php >}}
|
||||
use core_course\output\activity_icon;
|
||||
$renderer = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
|
||||
$icon = activity_icon::from_modname('quiz');
|
||||
|
||||
echo $renderer->render($icon);
|
||||
{{< /php >}}
|
||||
|
||||
By default, the activity icon will be rendered colored with the activity purpose color (see below).
|
||||
|
||||
### Rendering the activity icon from a cm_info object
|
||||
|
||||
Specific activity instances can have their own custom icons. For example, the `mod_resource` displays the MIME type icon for the resource. To render the activity icon from a `cm_info` object, use the static constructor `from_cm_info`. The method will return an instance of `activity_icon` with the icon URL set to the custom icon if necessary.
|
||||
|
||||
It is possible to render the activity icon from a `cm_info` object:
|
||||
|
||||
{{< php >}}
|
||||
use core_course\output\activity_icon;
|
||||
$renderer = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
$cminfo = get_fast_modinfo($courseid)->get_cm($cmid);
|
||||
|
||||
$icon = activity_icon::from_cm_info($cminfo);
|
||||
|
||||
echo $renderer->render($icon);
|
||||
{{< /php >}}
|
||||
|
||||
### Rendering the activity icon in dark color
|
||||
|
||||
There are pages like the gradebook where the activity icons must be rendered in black color for accessibility or usability reasons. The `core_course\output\activity_icon` class has a `set_colourize` method to define if the icon must be colorized or not.
|
||||
|
||||
The following example shows how to render the default activity icon in black:
|
||||
|
||||
{{< php >}}
|
||||
use core_course\output\activity_icon;
|
||||
$renderer = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
|
||||
$icon = activity_icon::from_modname('quiz')
|
||||
->set_colourize(false);
|
||||
|
||||
echo $renderer->render($icon);
|
||||
{{< /php >}}
|
||||
|
||||
### Set the activity icon size
|
||||
|
||||
When rendered in a page with limited space the icons will be shown in their original design, for example on the course gradebook where activity show in the grade table header.
|
||||
|
||||
> NOTE: The icon is using the ```.icon``` CSS class which limits the maximum width and height. It's recommended to define width and height into the SVG.
|
||||
The `core_course\output\activity_icon` class has a `set_icon_size` method to define the icon size. The method accepts any value from `core\output\local\properties\iconsize` enum.
|
||||
|
||||
{{< example >}}
|
||||
<div class="d-flex mb-3">
|
||||
<div class="d-flex border align-items-center p-1">
|
||||
{{< image "quiz/monologo.svg" "Quiz icon" "icon">}} Multiple choice quiz 1
|
||||
</div>
|
||||
</div>
|
||||
{{< /example >}}
|
||||
The following example shows how to render the default activity icon with a custom size:
|
||||
|
||||
### Coloured activity icons
|
||||
{{< php >}}
|
||||
use core_course\output\activity_icon;
|
||||
use core\output\local\properties\iconsize;
|
||||
$renderer = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
|
||||
In places like the course page and the activity chooser icons have a more prominent role and they should be rendered outlined colored against a transparent background.
|
||||
$icon = activity_icon::from_modname('quiz')
|
||||
->set_icon_size(iconsize::SIZE4);
|
||||
|
||||
The CSS classes for these icons are ```activityiconcontainer``` wrapper class with the added activity name. And the ```activityicon``` class for the image. See the template ```course/format/templates/local/content/cm/title.mustache``` for more info.
|
||||
echo $renderer->render($icon);
|
||||
{{< /php >}}
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer assessment me-3">
|
||||
{{< image "quiz/monologo.svg" "Quiz icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="text-uppercase small">quiz</div>
|
||||
<div class="activityname"><a href="#">Multiple choice quiz 1</a></div>
|
||||
</div>
|
||||
</div>
|
||||
### Add extra classes to the activity icon
|
||||
|
||||
### Activity purposes
|
||||
The `core_course\output\activity_icon` class has a `set_extra_classes` method to add extra classes to the icon container.
|
||||
|
||||
The following example shows how to render the default activity icon with extra classes:
|
||||
|
||||
{{< php >}}
|
||||
use core_course\output\activity_icon;
|
||||
$renderer = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
|
||||
$icon = activity_icon::from_modname('quiz')
|
||||
->set_extra_classes(['my-extra-class']);
|
||||
|
||||
echo $renderer->render($icon);
|
||||
{{< /php >}}
|
||||
|
||||
## Activity purposes
|
||||
|
||||
In the HTML for the example above you might notice the ```assessment``` css class after ```.activityiconcontainer```. This class is the result of assigning a *purpose* to the quiz activity in ```/mod/quiz/lib.php```.
|
||||
|
||||
@ -94,16 +151,24 @@ $info = new cached_cm_info();
|
||||
$info->iconurl = new moodle_url('https://moodle.org/theme/moodleorg/pix/moodle_logo_small.svg');
|
||||
{{< /php >}}
|
||||
|
||||
To get this customised icon, use:
|
||||
To get this customised icon url, use:
|
||||
|
||||
{{< php >}}
|
||||
$iconurl = get_fast_modinfo($courseid)->get_cm($cmid)->get_icon_url()->out(false);
|
||||
{{< /php >}}
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer lti me-3">
|
||||
And to render the custom icon:
|
||||
|
||||
{{< php >}}
|
||||
use core_course\output\activity_icon;
|
||||
|
||||
echo $OUTPUT->render(activity_icon::from_cm_info($cminfo));
|
||||
{{< /php >}}
|
||||
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer lti me-3">
|
||||
<img alt="lti icon" title="lti icon" src="https://moodle.org/theme/moodleorg/pix/moodle_logo_small.svg" class="activityicon "> </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">external</div>
|
||||
<div class="activityname"><a href="#">External tool module</a></div>
|
||||
</div>
|
||||
@ -125,10 +190,10 @@ function h5pactivity_is_branded(): bool {
|
||||
}
|
||||
{{< /php >}}
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer me-3">
|
||||
{{< image "h5pactivity/monologo.svg" "H5P activity icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">h5pactivity</div>
|
||||
<div class="activityname"><a href="#">H5P module</a></div>
|
||||
</div>
|
||||
@ -136,64 +201,64 @@ function h5pactivity_is_branded(): bool {
|
||||
|
||||
## Examples
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer administration me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer administration me-3">
|
||||
{{< image "quiz/monologo.svg" "Admin icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Administration</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer assessment me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer assessment me-3">
|
||||
{{< image "quiz/monologo.svg" "Assessment icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Assessment</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer collaboration me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer collaboration me-3">
|
||||
{{< image "wiki/monologo.svg" "Collaboration icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Collaboration</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer communication me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer communication me-3">
|
||||
{{< image "choice/monologo.svg" "Communication icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Communication</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer interactivecontent me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer interactivecontent me-3">
|
||||
{{< image "lesson/monologo.svg" "Interactive content icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Interactive content</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer content me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer content me-3">
|
||||
{{< image "book/monologo.svg" "Resource icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Resource</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="media mb-3">
|
||||
<div class="activityiconcontainer me-3">
|
||||
<div class="d-flex mb-3">
|
||||
<div class="flex-shrink-0 activityiconcontainer me-3">
|
||||
{{< image "lti/monologo.svg" "Other icon" "activityicon">}} </div>
|
||||
<div class="media-body align-self-center">
|
||||
<div class="flex-grow-1 align-self-center">
|
||||
<div class="text-uppercase small">Other</div>
|
||||
<div class="activityname"><a href="#">Module name</a></div>
|
||||
</div>
|
||||
|
@ -22,6 +22,9 @@
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
use core_course\output\activity_icon;
|
||||
use core\output\local\properties\iconsize;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die;
|
||||
|
||||
global $CFG;
|
||||
@ -203,12 +206,20 @@ class core_backup_renderer extends plugin_renderer_base {
|
||||
$table->data = array();
|
||||
}
|
||||
$name = get_string('pluginname', $activity->modulename);
|
||||
$icon = new image_icon('monologo', '', $activity->modulename);
|
||||
$table->data[] = array(
|
||||
$this->output->render($icon).$name,
|
||||
$icon = activity_icon::from_modname($activity->modulename)
|
||||
->set_icon_size(iconsize::SIZE4)
|
||||
->set_colourize(false);
|
||||
|
||||
$content = $this->output->container(
|
||||
contents: $this->output->render($icon) . $name,
|
||||
classes: 'd-flex align-items-center',
|
||||
);
|
||||
|
||||
$table->data[] = [
|
||||
$content,
|
||||
format_string($activity->title),
|
||||
($activity->settings[$activitykey.'_userinfo']) ? $yestick : $notick,
|
||||
);
|
||||
];
|
||||
}
|
||||
if (!empty($table)) {
|
||||
$html .= $this->backup_detail_pair(get_string('sectionactivities', 'backup'), html_writer::table($table));
|
||||
|
@ -21,8 +21,8 @@
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
namespace block_recentlyaccesseditems\external;
|
||||
defined('MOODLE_INTERNAL') || die();
|
||||
|
||||
use core_course\output\activity_icon;
|
||||
use renderer_base;
|
||||
use moodle_url;
|
||||
|
||||
@ -51,22 +51,18 @@ class recentlyaccesseditems_item_exporter extends \core\external\exporter {
|
||||
protected function get_other_values(renderer_base $output) {
|
||||
global $CFG;
|
||||
require_once($CFG->libdir.'/modinfolib.php');
|
||||
$iconurl = get_fast_modinfo($this->data->courseid)->cms[$this->data->cmid]->get_icon_url();
|
||||
$iconclass = $iconurl->get_param('filtericon') ? '' : 'nofilter';
|
||||
|
||||
$isbranded = component_callback('mod_' . $this->data->modname, 'is_branded') !== null ? : false;
|
||||
$renderer = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
$cminfo = get_fast_modinfo($this->data->courseid)->get_cm($this->data->cmid);
|
||||
$icon = activity_icon::from_cm_info($cminfo);
|
||||
|
||||
return array(
|
||||
'viewurl' => (new moodle_url('/mod/'.$this->data->modname.'/view.php',
|
||||
array('id' => $this->data->cmid)))->out(false),
|
||||
'courseviewurl' => (new moodle_url('/course/view.php', array('id' => $this->data->courseid)))->out(false),
|
||||
'icon' => \html_writer::img(
|
||||
$iconurl,
|
||||
get_string('pluginname', $this->data->modname),
|
||||
['title' => get_string('pluginname', $this->data->modname), 'class' => "icon $iconclass"]
|
||||
),
|
||||
'icon' => $renderer->render($icon),
|
||||
'purpose' => plugin_supports('mod', $this->data->modname, FEATURE_MOD_PURPOSE, MOD_PURPOSE_OTHER),
|
||||
'branded' => $isbranded,
|
||||
'branded' => $icon->is_branded(),
|
||||
);
|
||||
}
|
||||
|
||||
|
@ -26,13 +26,12 @@
|
||||
namespace core_completion;
|
||||
|
||||
use core\context;
|
||||
use core\output\local\properties\iconsize;
|
||||
use core_course\output\activity_icon;
|
||||
use stdClass;
|
||||
use context_course;
|
||||
use cm_info;
|
||||
use tabobject;
|
||||
use lang_string;
|
||||
use moodle_url;
|
||||
defined('MOODLE_INTERNAL') || die;
|
||||
|
||||
/**
|
||||
* Bulk activity completion manager class
|
||||
@ -105,6 +104,7 @@ class manager {
|
||||
* @return array
|
||||
*/
|
||||
public function get_activities($cmids, $withcompletiondetails = false) {
|
||||
$output = \core\di::get(\core\output\renderer_helper::class)->get_core_renderer();
|
||||
$moduleinfo = get_fast_modinfo($this->courseid);
|
||||
$activities = [];
|
||||
foreach ($cmids as $cmid) {
|
||||
@ -112,11 +112,16 @@ class manager {
|
||||
if (!$mod->uservisible) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$icon = activity_icon::from_cm_info($mod)
|
||||
->set_icon_size(iconsize::SIZE5);
|
||||
|
||||
$moduleobject = new stdClass();
|
||||
$moduleobject->cmid = $cmid;
|
||||
$moduleobject->modname = $mod->get_formatted_name();
|
||||
$moduleobject->icon = $mod->get_icon_url()->out();
|
||||
$moduleobject->url = $mod->url;
|
||||
$moduleobject->activityicon = $icon->export_for_template($output);
|
||||
$moduleobject->canmanage = $withcompletiondetails && self::can_edit_bulk_completion($this->courseid, $mod);
|
||||
|
||||
// Get activity completion information.
|
||||
|
233
course/classes/output/activity_icon.php
Normal file
233
course/classes/output/activity_icon.php
Normal file
@ -0,0 +1,233 @@
|
||||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
namespace core_course\output;
|
||||
|
||||
use core\component;
|
||||
use core\output\local\properties\iconsize;
|
||||
use core\output\renderable;
|
||||
use core\output\renderer_base;
|
||||
use core\output\templatable;
|
||||
use core\url;
|
||||
use cm_info;
|
||||
|
||||
/**
|
||||
* Class activity_icon
|
||||
*
|
||||
* @package core_course
|
||||
* @copyright 2025 Ferran Recio <ferran@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
class activity_icon implements renderable, templatable {
|
||||
|
||||
/** @var string optional text title */
|
||||
protected string $title = '';
|
||||
|
||||
/** @var string Extra container classes. */
|
||||
protected string $extraclasses = '';
|
||||
|
||||
/** @var bool Determine if the icon must be colored or not. */
|
||||
protected bool $colourize = true;
|
||||
|
||||
/** @var iconsize set the icon size */
|
||||
protected iconsize $iconsize = iconsize::UNDEFINED;
|
||||
|
||||
/** @var url The icon URL. */
|
||||
protected url $iconurl;
|
||||
|
||||
/** @var string The module purpose */
|
||||
protected string $purpose;
|
||||
|
||||
/** @var bool is branded */
|
||||
protected bool $isbranded;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param string $modname the module name
|
||||
*/
|
||||
protected function __construct(
|
||||
/** @var string the module name */
|
||||
protected string $modname,
|
||||
) {
|
||||
$this->isbranded = component_callback('mod_' . $this->modname, 'is_branded', [], false) ? true : false;
|
||||
$this->purpose = plugin_supports('mod', $this->modname, FEATURE_MOD_PURPOSE, MOD_PURPOSE_OTHER);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an activity icon from a cm_info object.
|
||||
*
|
||||
* @param cm_info $cm
|
||||
* @return self
|
||||
*/
|
||||
public static function from_cm_info(cm_info $cm): self {
|
||||
$result = new self($cm->modname);
|
||||
$result->iconurl = $cm->get_icon_url();
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an activity icon from a module name.
|
||||
*
|
||||
* @param string $modname
|
||||
* @return self
|
||||
*/
|
||||
public static function from_modname(string $modname): self {
|
||||
return new self($modname);
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the title.
|
||||
*
|
||||
* @param string $title
|
||||
* @return self
|
||||
*/
|
||||
public function set_title(string $title): self {
|
||||
$this->title = $title;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the colourize icon value.
|
||||
*
|
||||
* @param bool $colourize
|
||||
* @return self
|
||||
*/
|
||||
public function set_colourize(bool $colourize): self {
|
||||
$this->colourize = $colourize;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the extra classes.
|
||||
*
|
||||
* @param string $extraclasses
|
||||
* @return self
|
||||
*/
|
||||
public function set_extra_classes(string $extraclasses): self {
|
||||
$this->extraclasses = $extraclasses;
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the icon size.
|
||||
*
|
||||
* @param iconsize $iconsize
|
||||
* @return self
|
||||
*/
|
||||
public function set_icon_size(iconsize $iconsize): self {
|
||||
$this->iconsize = $iconsize;
|
||||
return $this;
|
||||
}
|
||||
|
||||
#[\Override]
|
||||
public function export_for_template(renderer_base $output): array {
|
||||
if (!isset($this->iconurl)) {
|
||||
$this->iconurl = $this->get_icon_url($output);
|
||||
}
|
||||
$needfiltering = $this->colourize && $this->iconurl->get_param('filtericon');
|
||||
$iconclass = $needfiltering ? '' : 'nofilter';
|
||||
|
||||
$data = [
|
||||
'icon' => $this->iconurl,
|
||||
'iconclass' => $iconclass,
|
||||
'modname' => $this->modname,
|
||||
'pluginname' => get_string('pluginname', 'mod_' . $this->modname),
|
||||
'purpose' => $this->purpose,
|
||||
'branded' => $this->isbranded,
|
||||
'extraclasses' => $this->extraclasses . $this->iconsize->classes(),
|
||||
];
|
||||
|
||||
if (!empty($this->title)) {
|
||||
$data['title'] = $this->title;
|
||||
}
|
||||
|
||||
return $data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the icon URL.
|
||||
*
|
||||
* @param renderer_base $output
|
||||
* @return url
|
||||
*/
|
||||
public function get_icon_url(renderer_base $output): url {
|
||||
$icon = $output->image_url('monologo', $this->modname);
|
||||
// Legacy activity modules may only have an `icon` icon instead of a `monologo` icon.
|
||||
$ismonologo = component::has_monologo_icon('mod', $this->modname);
|
||||
|
||||
if ($ismonologo) {
|
||||
// The filtericon param is used to determine if the icon should be colored or not.
|
||||
// The name of the param is not colorize to preserve backward compatibility.
|
||||
$icon->param('filtericon', 1);
|
||||
}
|
||||
return $icon;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the module is branded.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function is_branded(): bool {
|
||||
return $this->isbranded;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the colourize icon value.
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
public function get_colourize(): bool {
|
||||
return $this->colourize;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the title text.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_title(): string {
|
||||
return $this->title;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the extra classes.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_extra_classes(): string {
|
||||
return $this->extraclasses;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the icon size.
|
||||
*
|
||||
* @return iconsize
|
||||
*/
|
||||
public function get_icon_size(): iconsize {
|
||||
return $this->iconsize;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the activity purpose.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function get_purpose(): string {
|
||||
return $this->purpose;
|
||||
}
|
||||
}
|
@ -15,6 +15,7 @@
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
use core_completion\manager;
|
||||
use core_course\output\activity_icon;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die;
|
||||
|
||||
@ -32,7 +33,7 @@ class core_course_bulk_activity_completion_renderer extends plugin_renderer_base
|
||||
/**
|
||||
* Render the bulk completion tab.
|
||||
*
|
||||
* @param Array|stdClass $data the context data to pass to the template.
|
||||
* @param array|stdClass $data the context data to pass to the template.
|
||||
* @return bool|string
|
||||
*/
|
||||
public function bulkcompletion($data) {
|
||||
@ -71,6 +72,8 @@ class core_course_bulk_activity_completion_renderer extends plugin_renderer_base
|
||||
$module->open = false;
|
||||
}
|
||||
|
||||
$module->activityicon = activity_icon::from_modname($module->name)->export_for_template($this);
|
||||
|
||||
$moduleform = manager::get_module_form($module->name, $course);
|
||||
if ($moduleform) {
|
||||
$module->formhtml = $modform->render();
|
||||
|
@ -19,9 +19,8 @@ namespace core_courseformat\output\local\overview;
|
||||
use core\context\course as context_course;
|
||||
use core\output\named_templatable;
|
||||
use core\output\renderable;
|
||||
use core\output\notification;
|
||||
use core\plugin_manager;
|
||||
use core\url;
|
||||
use core_course\output\activity_icon;
|
||||
use core_collator;
|
||||
use stdClass;
|
||||
|
||||
@ -155,10 +154,12 @@ class overviewpage implements renderable, named_templatable {
|
||||
* @return string The HTML string for the activity overview icon.
|
||||
*/
|
||||
private function get_activity_overview_icon(\renderer_base $output, string $modname): string {
|
||||
// Resource is a generic term for all modules with MOD_ARCHETYPE_RESOURCE.
|
||||
// We group all of them under the mod_page icon.
|
||||
if ($modname === 'resource') {
|
||||
return $output->pix_icon('monologo', '', 'mod_page', ['class' => 'icon iconsize-medium']);
|
||||
$modname = 'page';
|
||||
}
|
||||
return $output->pix_icon('monologo', '', "mod_$modname", ['class' => 'icon iconsize-medium']);
|
||||
return $output->render(activity_icon::from_modname($modname));
|
||||
}
|
||||
|
||||
/**
|
||||
|
44
course/templates/activity_icon.mustache
Normal file
44
course/templates/activity_icon.mustache
Normal file
@ -0,0 +1,44 @@
|
||||
{{!
|
||||
This file is part of Moodle - http://moodle.org/
|
||||
|
||||
Moodle is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
Moodle is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
}}
|
||||
{{!
|
||||
@template core_course/activity_icon
|
||||
|
||||
Displays an activity plugin icon.
|
||||
|
||||
Example context (json):
|
||||
{
|
||||
"icon": "../../../pix/help.svg",
|
||||
"iconclass": "",
|
||||
"purpose": "content",
|
||||
"branded": 0,
|
||||
"pluginname": "File",
|
||||
"title": "File",
|
||||
"extraclasses": "mycustomclass"
|
||||
}
|
||||
}}
|
||||
<div
|
||||
class="activity-icon activityiconcontainer {{!
|
||||
}}{{purpose}} {{#branded}}isbranded{{/branded}} {{extraclasses}}"
|
||||
>
|
||||
<img
|
||||
src="{{{icon}}}"
|
||||
class="activityicon icon {{iconclass}}"
|
||||
data-region="activity-icon"
|
||||
alt="{{#title}}{{#cleanstr}} activityicon, moodle, {{{pluginname}}} {{/cleanstr}}{{/title}}"
|
||||
{{#title}}title="{{{title}}}"{{/title}}
|
||||
>
|
||||
</div>
|
@ -36,27 +36,32 @@
|
||||
<div class="row mb-1">
|
||||
<div class="activityinstance col-6">
|
||||
<div class="mod-indent-outer"></div>
|
||||
<div>
|
||||
<div class="d-flex align-items-center align-self-start gap-3 mb-2">
|
||||
{{#canmanage}}
|
||||
<label class="accesshide" for="selectactivity_{{cmid}}">{{#str}}select, completion{{/str}} {{modname}}</label>
|
||||
<input type="checkbox" id="selectactivity_{{cmid}}" class="me-1" name="cmid[]" data-section="{{sectionnumber}}" value="{{cmid}}" aria-label="{{#str}}checkactivity, completion, {{{modname}}}{{/str}}">
|
||||
<input type="checkbox" id="selectactivity_{{cmid}}" name="cmid[]" data-section="{{sectionnumber}}" value="{{cmid}}" aria-label="{{#str}}checkactivity, completion, {{{modname}}}{{/str}}">
|
||||
{{/canmanage}}
|
||||
<a href="{{url}}">
|
||||
<img src="{{icon}}" class="activityicon" alt="">
|
||||
<span class="instancename">{{{modname}}}</span>
|
||||
<a href="{{url}}" class="activityiconcontainer">
|
||||
{{#activityicon}}
|
||||
{{> core_course/activity_icon}}
|
||||
{{/activityicon}}
|
||||
{{^activityicon}}
|
||||
<img src="{{icon}}" class="activityicon" alt="">
|
||||
{{/activityicon}}
|
||||
<span class="instancename">{{{modname}}}</span>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
<div class="activity-completionstatus col-6" id="completionstatus_{{cmid}}">
|
||||
<div class="col-sm-1 ps-0">
|
||||
<div class="activity-completionstatus col-6 d-flex align-items-start gap-1" id="completionstatus_{{cmid}}">
|
||||
<div>
|
||||
{{#completionstatus.icon}}
|
||||
{{{completionstatus.icon}}}
|
||||
{{/completionstatus.icon}}
|
||||
{{^completionstatus.icon}}
|
||||
<span class="me-3"></span>
|
||||
<span class="me-4"> </span>
|
||||
{{/completionstatus.icon}}
|
||||
</div>
|
||||
<div class="col-sm-11 ps-0">
|
||||
<div>
|
||||
<span class="text-muted muted">{{{completionstatus.string}}}</span>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -50,7 +50,7 @@
|
||||
</div>
|
||||
<div class="row mb-1">
|
||||
<div class="col-6">
|
||||
<input type="checkbox" class="mastercheck me-1" aria-label="{{#str}}checkall, completion{{/str}}">
|
||||
<input type="checkbox" class="mastercheck me-3" aria-label="{{#str}}checkall, completion{{/str}}">
|
||||
<label class="fw-bold">{{#str}}activitieslabel, core_completion{{/str}}</label>
|
||||
</div>
|
||||
<div class="col-6">
|
||||
@ -64,7 +64,7 @@
|
||||
<div class="mb-1">
|
||||
<div class="row mb-1">
|
||||
<div class="col-sm-12">
|
||||
<input type="checkbox" data-section-master="{{sectionnumber}}" class="me-1" aria-label="{{#str}}checkallsection, completion, {{{name}}}{{/str}}">
|
||||
<input type="checkbox" data-section-master="{{sectionnumber}}" class="me-3" aria-label="{{#str}}checkallsection, completion, {{{name}}}{{/str}}">
|
||||
<h3 class="d-inline-block">{{{name}}}</h3>
|
||||
</div>
|
||||
</div>
|
||||
|
@ -48,7 +48,9 @@
|
||||
{{#canmanage}}
|
||||
{{<core/local/collapsable_section}}
|
||||
{{$titlecontent}}
|
||||
<img class="activityicon ms-2" src="{{icon}}" alt="" aria-hidden="true">
|
||||
{{#activityicon}}
|
||||
{{>core_course/activity_icon}}
|
||||
{{/activityicon}}
|
||||
<span class="activityname ms-3 mb-0">{{{formattedname}}}</span>
|
||||
{{/titlecontent}}
|
||||
{{$elementid}}activitycompletioncollapse-{{id}}{{/elementid}}
|
||||
|
46
lib/classes/output/local/properties/iconsize.php
Normal file
46
lib/classes/output/local/properties/iconsize.php
Normal file
@ -0,0 +1,46 @@
|
||||
<?php
|
||||
// This file is part of Moodle - http://moodle.org/
|
||||
//
|
||||
// Moodle is free software: you can redistribute it and/or modify
|
||||
// it under the terms of the GNU General Public License as published by
|
||||
// the Free Software Foundation, either version 3 of the License, or
|
||||
// (at your option) any later version.
|
||||
//
|
||||
// Moodle is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// You should have received a copy of the GNU General Public License
|
||||
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
namespace core\output\local\properties;
|
||||
|
||||
/**
|
||||
* Icon sizes property enum.
|
||||
*
|
||||
* @package core
|
||||
* @copyright 2024 Ferran Recio <ferran@moodle.com>
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
enum iconsize: string {
|
||||
case UNDEFINED = '';
|
||||
case SIZE0 = 'icon-size-0';
|
||||
case SIZE1 = 'icon-size-1';
|
||||
case SIZE2 = 'icon-size-2';
|
||||
case SIZE3 = 'icon-size-3';
|
||||
case SIZE4 = 'icon-size-4';
|
||||
case SIZE5 = 'icon-size-5';
|
||||
case SIZE6 = 'icon-size-6';
|
||||
case SIZE7 = 'icon-size-7';
|
||||
|
||||
|
||||
/**
|
||||
* Returns the CSS classes for the property based on its type.
|
||||
*
|
||||
* @return string The CSS classes.
|
||||
*/
|
||||
public function classes(): string {
|
||||
return ' ' . $this->value;
|
||||
}
|
||||
}
|
@ -16,6 +16,9 @@
|
||||
|
||||
namespace core_report\output;
|
||||
|
||||
use core\output\local\properties\iconsize;
|
||||
use core_course\output\activity_icon;
|
||||
|
||||
/**
|
||||
* Course sections, subsections and activities structure for reports.
|
||||
*
|
||||
@ -281,8 +284,12 @@ class coursestructure implements \renderable, \templatable {
|
||||
'visible' => $cm->visible,
|
||||
'cells' => [],
|
||||
];
|
||||
|
||||
$activityicon = activity_icon::from_cm_info($cm)
|
||||
->set_icon_size(iconsize::SIZE4);
|
||||
|
||||
$dataactivity['activitycolumn'] = [
|
||||
'activityicon' => $output->pix_icon('monologo', $modulename, $cm->modname, ['class' => 'icon']),
|
||||
'activityicon' => $output->render($activityicon),
|
||||
'link' => "$CFG->wwwroot/mod/$cm->modname/view.php?id=$cm->id",
|
||||
'text' => $cm->name,
|
||||
];
|
||||
|
@ -23,6 +23,9 @@
|
||||
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
||||
*/
|
||||
|
||||
use core\output\local\properties\iconsize;
|
||||
use core_course\output\activity_icon;
|
||||
|
||||
defined('MOODLE_INTERNAL') || die;
|
||||
|
||||
require_once(__DIR__.'/lib.php');
|
||||
@ -31,7 +34,9 @@ require_once($CFG->dirroot.'/course/lib.php');
|
||||
function report_outline_print_row($mod, $instance, $result) {
|
||||
global $OUTPUT, $CFG;
|
||||
|
||||
$image = $OUTPUT->image_icon('monologo', $mod->modfullname, $mod->modname);
|
||||
$activityicon = activity_icon::from_cm_info($mod)
|
||||
->set_icon_size(iconsize::SIZE4);
|
||||
$image = $OUTPUT->render($activityicon);
|
||||
|
||||
echo "<tr>";
|
||||
echo "<td valign=\"top\">$image</td>";
|
||||
|
@ -42,9 +42,13 @@
|
||||
}}
|
||||
<tr>
|
||||
{{#activitycolumn}}
|
||||
<td class="cell activityname {{#indelegated}}delegated{{/indelegated}}{{^indelegated}}ps-5{{/indelegated}}">
|
||||
{{{ activityicon }}}
|
||||
{{#link}}<a href="{{ link }}">{{/link}}{{{ text }}}{{#link}}</a>{{/link}}
|
||||
<td class="cell activityname {{!
|
||||
}}{{#indelegated}}delegated{{/indelegated}}{{^indelegated}}ps-5{{/indelegated}}"
|
||||
>
|
||||
<div class="d-flex align-items-center">
|
||||
{{{ activityicon }}}
|
||||
{{#link}}<a href="{{ link }}">{{/link}}{{{ text }}}{{#link}}</a>{{/link}}
|
||||
</div>
|
||||
{{^visible}}
|
||||
<div class="activity-badges my-1" data-region="visibility">
|
||||
<span class="badge rounded-pill bg-secondary text-dark">{{#pix}}i/show, core{{/pix}}{{#str}}hiddenfromstudents{{/str}}</span>
|
||||
|
@ -195,13 +195,10 @@ img.icon {
|
||||
// Revisit these styles when MDL-78284 lands with new icons.
|
||||
// Icon container will be removed and icons will be used directly.
|
||||
.activityiconcontainer {
|
||||
width: $activity-iconcontainer-width;
|
||||
height: $activity-iconcontainer-height;
|
||||
display: inline-flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
border-radius: 4px;
|
||||
padding: 0.7rem;
|
||||
.activityicon,
|
||||
.icon {
|
||||
margin: 0;
|
||||
|
@ -28846,13 +28846,10 @@ img.icon {
|
||||
}
|
||||
|
||||
.activityiconcontainer {
|
||||
width: 52px;
|
||||
height: 52px;
|
||||
display: inline-flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
border-radius: 4px;
|
||||
padding: 0.7rem;
|
||||
}
|
||||
.activityiconcontainer .activityicon,
|
||||
.activityiconcontainer .icon {
|
||||
|
@ -28846,13 +28846,10 @@ img.icon {
|
||||
}
|
||||
|
||||
.activityiconcontainer {
|
||||
width: 52px;
|
||||
height: 52px;
|
||||
display: inline-flex;
|
||||
justify-content: center;
|
||||
align-items: center;
|
||||
border-radius: 4px;
|
||||
padding: 0.7rem;
|
||||
}
|
||||
.activityiconcontainer .activityicon,
|
||||
.activityiconcontainer .icon {
|
||||
|
Loading…
x
Reference in New Issue
Block a user