Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?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/>.

declare(strict_types=1);

namespace core_reportbuilder\external;

use core_collator;
use core_component;
< use core_plugin_manager;
use renderer_base; use core_reportbuilder\local\audiences\base; /** * Custom report audience cards exporter class * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_audience_cards_exporter extends custom_report_menu_cards_exporter { /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { $menucards = []; // Iterate over all audience types. $audiences = core_component::get_component_classes_in_namespace(null, 'reportbuilder\\audience'); $audiencekeyindex = 0; foreach ($audiences as $class => $path) { if (is_subclass_of($class, base::class)) { $audience = $class::instance(); if (!$audience->user_can_add()) { continue; }
< // The name of each card will be the component the audience belongs to. < [$component] = explode('\\', $class); < if ($plugininfo = core_plugin_manager::instance()->get_plugin_info($component)) { < $componentname = $plugininfo->displayname; < } else { < $componentname = get_string('site'); < } <
// New menu card per component.
> $componentname = $audience->get_component_displayname();
if (!array_key_exists($componentname, $menucards)) { $menucards[$componentname] = [ 'name' => $componentname, 'key' => 'index' . ++$audiencekeyindex, 'items' => [], ]; } // Append menu card item per audience. $menucards[$componentname]['items'][] = [ 'name' => $audience->get_name(), 'identifier' => get_class($audience), 'title' => get_string('addaudience', 'core_reportbuilder', $audience->get_name()), 'action' => 'add-audience', 'disabled' => !$audience->is_available(), ]; } } // Order items in each menu card alphabetically. array_walk($menucards, static function(array &$menucard): void { core_collator::asort_array_of_arrays_by_key($menucard['items'], 'name'); $menucard['items'] = array_values($menucard['items']); }); return [ 'menucards' => array_values($menucards), ]; } }