File manager - Edit - /home/u466501803/domains/qurdis.my.id/public_html/reportbuilder.zip
Back
PK a<�\���w� � lib.phpnu �[��� <?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/>. /** * Callback methods for reportbuilder component * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); use core\output\inplace_editable; use core_reportbuilder\form\audience; use core_reportbuilder\form\filter; use core_reportbuilder\local\helpers\audience as audience_helper; use core_reportbuilder\local\models\report; use core_tag\output\{tagfeed, tagindex}; /** * Return the filters form fragment * * @param array $params * @return string */ function core_reportbuilder_output_fragment_filters_form(array $params): string { $filtersform = new filter(null, null, 'post', '', [], true, [ 'reportid' => $params['reportid'], 'parameters' => $params['parameters'], ]); $filtersform->set_data_for_dynamic_submission(); return $filtersform->render(); } /** * Return the audience form fragment * * @param array $params * @return string */ function core_reportbuilder_output_fragment_audience_form(array $params): string { global $PAGE; $audienceform = new audience(null, null, 'post', '', [], true, [ 'reportid' => $params['reportid'], 'classname' => $params['classname'], ]); $audienceform->set_data_for_dynamic_submission(); $context = [ 'instanceid' => 0, 'heading' => $params['title'], 'headingeditable' => $params['title'], 'form' => $audienceform->render(), 'canedit' => true, 'candelete' => true, 'showormessage' => $params['showormessage'], ]; $renderer = $PAGE->get_renderer('core_reportbuilder'); return $renderer->render_from_template('core_reportbuilder/local/audience/form', $context); } /** * Callback to return tagged reports * * @param core_tag_tag $tag * @param bool $exclusivemode * @param int|null $fromcontextid * @param int|null $contextid * @param bool $recurse * @param int $page * @return tagindex */ function core_reportbuilder_get_tagged_reports( core_tag_tag $tag, bool $exclusivemode = false, ?int $fromcontextid = 0, ?int $contextid = 0, bool $recurse = true, int $page = 0, ): tagindex { global $OUTPUT; // Limit the returned list to those reports the current user can access. [$where, $params] = audience_helper::user_reports_list_access_sql('it'); $tagcount = $tag->count_tagged_items('core_reportbuilder', 'reportbuilder_report', $where, $params); $perpage = $exclusivemode ? 20 : 5; $pagecount = ceil($tagcount / $perpage); $content = ''; if ($tagcount > 0) { $tagfeed = new tagfeed(); $pixicon = new pix_icon('i/report', new lang_string('customreport', 'core_reportbuilder')); $reports = $tag->get_tagged_items('core_reportbuilder', 'reportbuilder_report', $page * $perpage, $perpage, $where, $params); foreach ($reports as $report) { $tagfeed->add( $OUTPUT->render($pixicon), html_writer::link( new moodle_url('/reportbuilder/view.php', ['id' => $report->id]), (new report(0, $report))->get_formatted_name(), ), ); } $content = $OUTPUT->render_from_template('core_tag/tagfeed', $tagfeed->export_for_template($OUTPUT)); } return new tagindex($tag, 'core_reportbuilder', 'reportbuilder_report', $content, $exclusivemode, $fromcontextid, $contextid, $recurse, $page, $pagecount); } /** * Plugin inplace editable implementation * * @param string $itemtype * @param int $itemid * @param string $newvalue * @return inplace_editable|null */ function core_reportbuilder_inplace_editable(string $itemtype, int $itemid, string $newvalue): ?inplace_editable { switch ($itemtype) { case 'reportname': return \core_reportbuilder\output\report_name_editable::update($itemid, $newvalue); case 'columnheading': return \core_reportbuilder\output\column_heading_editable::update($itemid, $newvalue); case 'columnaggregation': return \core_reportbuilder\output\column_aggregation_editable::update($itemid, $newvalue); case 'filterheading': return \core_reportbuilder\output\filter_heading_editable::update($itemid, $newvalue); case 'audienceheading': return \core_reportbuilder\output\audience_heading_editable::update($itemid, $newvalue); case 'schedulename': return \core_reportbuilder\output\schedule_name_editable::update($itemid, $newvalue); } return null; } PK a<�\���Ť � classes/permission.phpnu �[��� <?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; use context; use context_system; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\helpers\audience; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\base; /** * Report permission class * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class permission { /** * Require given user can view reports list * * @param int|null $userid User ID to check, or the current user if omitted * @param context|null $context * @throws report_access_exception */ public static function require_can_view_reports_list(?int $userid = null, ?context $context = null): void { if (!static::can_view_reports_list($userid, $context)) { throw new report_access_exception(); } } /** * Whether given user can view reports list * * @param int|null $userid User ID to check, or the current user if omitted * @param context|null $context * @return bool */ public static function can_view_reports_list(?int $userid = null, ?context $context = null): bool { global $CFG; if ($context === null) { $context = context_system::instance(); } return !empty($CFG->enablecustomreports) && has_any_capability([ 'moodle/reportbuilder:edit', 'moodle/reportbuilder:editall', 'moodle/reportbuilder:view', 'moodle/reportbuilder:viewall', ], $context, $userid); } /** * Require given user can view report * * @param report $report * @param int|null $userid User ID to check, or the current user if omitted * @throws report_access_exception */ public static function require_can_view_report(report $report, ?int $userid = null): void { if (!static::can_view_report($report, $userid)) { throw new report_access_exception('errorreportview'); } } /** * Whether given user can view report * * @param report $report * @param int|null $userid User ID to check, or the current user if omitted * @return bool */ public static function can_view_report(report $report, ?int $userid = null): bool { if (!static::can_view_reports_list($userid, $report->get_context())) { return false; } if (has_capability('moodle/reportbuilder:viewall', $report->get_context(), $userid)) { return true; } if (self::can_edit_report($report, $userid)) { return true; } $reports = audience::user_reports_list($userid); return in_array($report->get('id'), $reports); } /** * Require given user can edit report * * @param report $report * @param int|null $userid User ID to check, or the current user if omitted * @throws report_access_exception */ public static function require_can_edit_report(report $report, ?int $userid = null): void { if (!static::can_edit_report($report, $userid)) { throw new report_access_exception('errorreportedit'); } } /** * Whether given user can edit report * * @param report $report * @param int|null $userid User ID to check, or the current user if omitted * @return bool */ public static function can_edit_report(report $report, ?int $userid = null): bool { global $CFG, $USER; if (empty($CFG->enablecustomreports)) { return false; } // We can only edit custom reports. if ($report->get('type') !== base::TYPE_CUSTOM_REPORT) { return false; } // To edit their own reports, users must have either of the 'edit' or 'editall' capabilities. For reports belonging // to other users, they must have the specific 'editall' capability. $userid = $userid ?: (int) $USER->id; if ($report->get('usercreated') === $userid) { return has_any_capability([ 'moodle/reportbuilder:edit', 'moodle/reportbuilder:editall', ], $report->get_context(), $userid); } else { return has_capability('moodle/reportbuilder:editall', $report->get_context(), $userid); } } /** * Whether given user can create a new report * * @param int|null $userid User ID to check, or the current user if omitted * @param context|null $context * @return bool */ public static function can_create_report(?int $userid = null, ?context $context = null): bool { global $CFG; if ($context === null) { $context = context_system::instance(); } return !empty($CFG->enablecustomreports) && has_any_capability([ 'moodle/reportbuilder:edit', 'moodle/reportbuilder:editall', ], $context, $userid) && !manager::report_limit_reached(); } /** * Require given user can create a new report * * @param int|null $userid User ID to check, or the current user if omitted * @param context|null $context * @throws report_access_exception */ public static function require_can_create_report(?int $userid = null, ?context $context = null): void { if (!static::can_create_report($userid, $context)) { throw new report_access_exception('errorreportcreate'); } } } PK a<�\�!�LB B : classes/external/custom_report_audience_cards_exporter.phpnu �[��� <?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 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; } // 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), ]; } } PK a<�\8�4�� � + classes/external/systemreports/retrieve.phpnu �[��� <?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\systemreports; use core_external\external_api; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_function_parameters; use core_external\external_value; use core_external\external_warnings; use core_reportbuilder\system_report_factory; use core_reportbuilder\external\system_report_data_exporter; /** * External method for retrieving system report content * * @package core_reportbuilder * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class retrieve extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'source' => new external_value(PARAM_RAW, 'Report class path'), 'context' => self::get_context_parameters(), 'component' => new external_value(PARAM_COMPONENT, 'Report component', VALUE_DEFAULT, ''), 'area' => new external_value(PARAM_AREA, 'Report area', VALUE_DEFAULT, ''), 'itemid' => new external_value(PARAM_INT, 'Report item ID', VALUE_DEFAULT, 0), 'parameters' => new external_multiple_structure( new external_single_structure([ 'name' => new external_value(PARAM_RAW), 'value' => new external_value(PARAM_RAW), ]), 'Report parameters', VALUE_DEFAULT, [] ), 'page' => new external_value(PARAM_INT, 'Page number', VALUE_DEFAULT, 0), 'perpage' => new external_value(PARAM_INT, 'Reports per page', VALUE_DEFAULT, 10), ]); } /** * External method execution * * @param string $source * @param array $context * @param string $component * @param string $area * @param int $itemid * @param array[] $parameters * @param int $page * @param int $perpage * @return array[] */ public static function execute( string $source, array $context, string $component = '', string $area = '', int $itemid = 0, array $parameters = [], int $page = 0, int $perpage = 10, ): array { global $PAGE; [ 'source' => $source, 'context' => $context, 'component' => $component, 'area' => $area, 'itemid' => $itemid, 'parameters' => $parameters, 'page' => $page, 'perpage' => $perpage, ] = self::validate_parameters(self::execute_parameters(), [ 'source' => $source, 'context' => $context, 'component' => $component, 'area' => $area, 'itemid' => $itemid, 'parameters' => $parameters, 'page' => $page, 'perpage' => $perpage, ]); $context = self::get_context_from_params($context); self::validate_context($context); // Flatten the report parameters. $parameters = array_combine(array_column($parameters, 'name'), array_column($parameters, 'value')); $report = system_report_factory::create($source, $context, $component, $area, $itemid, $parameters); $report->require_can_view(); $output = $PAGE->get_renderer('core'); return [ 'data' => (array) (new system_report_data_exporter(null, [ 'report' => $report, 'page' => $page, 'perpage' => $perpage, ]))->export($output), 'warnings' => [], ]; } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'data' => system_report_data_exporter::get_read_structure(), 'warnings' => new external_warnings(), ]); } } PK a<�\��~�� � + classes/external/systemreports/can_view.phpnu �[��� <?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\systemreports; use core_external\external_api; use core_external\external_multiple_structure; use core_external\external_single_structure; use core_external\external_function_parameters; use core_external\external_value; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\system_report_factory; /** * External method for validating access to a system report * * @package core_reportbuilder * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class can_view extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'source' => new external_value(PARAM_RAW, 'Report class path'), 'context' => self::get_context_parameters(), 'component' => new external_value(PARAM_COMPONENT, 'Report component', VALUE_DEFAULT, ''), 'area' => new external_value(PARAM_AREA, 'Report area', VALUE_DEFAULT, ''), 'itemid' => new external_value(PARAM_INT, 'Report item ID', VALUE_DEFAULT, 0), 'parameters' => new external_multiple_structure( new external_single_structure([ 'name' => new external_value(PARAM_RAW), 'value' => new external_value(PARAM_RAW), ]), 'Report parameters', VALUE_DEFAULT, [] ), ]); } /** * External method execution * * @param string $source * @param array $context * @param string $component * @param string $area * @param int $itemid * @param array[] $parameters * @return bool */ public static function execute( string $source, array $context, string $component = '', string $area = '', int $itemid = 0, array $parameters = [], ): bool { [ 'source' => $source, 'context' => $context, 'component' => $component, 'area' => $area, 'itemid' => $itemid, 'parameters' => $parameters, ] = self::validate_parameters(self::execute_parameters(), [ 'source' => $source, 'context' => $context, 'component' => $component, 'area' => $area, 'itemid' => $itemid, 'parameters' => $parameters, ]); $context = self::get_context_from_params($context); self::validate_context($context); // Flatten the report parameters. $parameters = array_combine(array_column($parameters, 'name'), array_column($parameters, 'value')); try { $report = system_report_factory::create($source, $context, $component, $area, $itemid, $parameters); $report->require_can_view(); } catch (report_access_exception $exception) { return false; } return true; } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL); } } PK a<�\� q� � % classes/external/audiences/delete.phpnu �[��� <?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\audiences; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\local\helpers\audience; use core_reportbuilder\manager; use core_reportbuilder\permission; /** * External method for deleting a report audience * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class delete extends external_api { /** * Describes the parameters for get_users_courses. * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters( [ 'reportid' => new external_value(PARAM_INT, 'Report id'), 'instanceid' => new external_value(PARAM_INT, 'Audience instance id'), ] ); } /** * External function to delete a report audience instance. * * @param int $reportid * @param int $instanceid * @return bool */ public static function execute(int $reportid, int $instanceid): bool { [ 'reportid' => $reportid, 'instanceid' => $instanceid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'instanceid' => $instanceid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); return audience::delete_report_audience($reportid, $instanceid); } /** * Describes the data returned from the external function. * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL, '', VALUE_REQUIRED); } } PK a<�\e8�x� � 0 classes/external/system_report_data_exporter.phpnu �[��� <?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 renderer_base; use core\external\exporter; use core_reportbuilder\system_report; use core_reportbuilder\table\system_report_table; /** * System report data exporter class * * @package core_reportbuilder * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_data_exporter extends exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => system_report::class, 'page' => 'int', 'perpage' => 'int', ]; } /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'headers' => [ 'type' => PARAM_RAW, 'multiple' => true, ], 'rows' => [ 'type' => [ 'columns' => [ 'type' => PARAM_RAW, 'null' => NULL_ALLOWED, 'multiple' => true, ], ], 'multiple' => true, ], 'totalrowcount' => ['type' => PARAM_INT], ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { global $DB; /** @var system_report $report */ $report = $this->related['report']; $table = system_report_table::create($report->get_report_persistent()->get('id'), $report->get_parameters()); $table->guess_base_url(); $table->setup(); // Internally the current page is zero-based, but this method expects value plus one. $table->set_page_number($this->related['page'] + 1); $table->query_db($this->related['perpage'], false); // Ensure we only return defined columns, excluding those such as "select all" and "actions". $columnsbyalias = $report->get_active_columns_by_alias(); $tableheaders = array_combine(array_flip($table->columns), $table->headers); $tableheaders = array_intersect_key($tableheaders, $columnsbyalias); $tablerows = []; foreach ($table->rawdata as $record) { $columns = array_intersect_key($table->format_row($record), $columnsbyalias); $tablerows[] = [ 'columns' => array_values($columns), ]; } $table->close_recordset(); return [ 'headers' => array_values($tableheaders), 'rows' => $tablerows, 'totalrowcount' => $DB->count_records_sql($table->countsql, $table->countparams), ]; } } PK a<�\V�t~ ~ 8 classes/external/custom_report_column_cards_exporter.phpnu �[��� <?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 renderer_base; use core_reportbuilder\datasource; /** * Custom report column 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_column_cards_exporter extends custom_report_menu_cards_exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => datasource::class, ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var datasource $report */ $report = $this->related['report']; $menucards = []; foreach ($report->get_columns() as $column) { if ($column->get_is_deprecated()) { continue; } // New menu card per entity. $entityname = $column->get_entity_name(); if (!array_key_exists($entityname, $menucards)) { $menucards[$entityname] = [ 'name' => (string) $report->get_entity_title($entityname), 'key' => $entityname, 'items' => [], ]; } // Append menu card item per column. $menucards[$entityname]['items'][] = [ 'name' => $column->get_title(), 'identifier' => $column->get_unique_identifier(), 'title' => get_string('addcolumn', 'core_reportbuilder', $column->get_title()), 'action' => 'report-add-column', ]; } return [ 'menucards' => array_values($menucards), ]; } } PK a<�\�M��� � % classes/external/reports/retrieve.phpnu �[��� <?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\reports; use core_reportbuilder\manager; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_external\external_warnings; use core_reportbuilder\permission; use core_reportbuilder\external\{custom_report_data_exporter, custom_report_details_exporter}; /** * External method for retrieving custom report content * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class retrieve extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'page' => new external_value(PARAM_INT, 'Page number', VALUE_DEFAULT, 0), 'perpage' => new external_value(PARAM_INT, 'Reports per page', VALUE_DEFAULT, 10), ]); } /** * External method execution * * @param int $reportid * @param int $page * @param int $perpage * @return array */ public static function execute(int $reportid, int $page = 0, int $perpage = 10): array { global $PAGE; [ 'reportid' => $reportid, 'page' => $page, 'perpage' => $perpage, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'page' => $page, 'perpage' => $perpage, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); $persistent = $report->get_report_persistent(); permission::require_can_view_report($persistent); $output = $PAGE->get_renderer('core'); return [ 'details' => (array) (new custom_report_details_exporter($persistent))->export($output), 'data' => (array) (new custom_report_data_exporter(null, [ 'report' => $report, 'page' => $page, 'perpage' => $perpage, ]))->export($output), 'warnings' => [], ]; } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'details' => custom_report_details_exporter::get_read_structure(), 'data' => custom_report_data_exporter::get_read_structure(), 'warnings' => new external_warnings(), ]); } } PK a<�\qO(�� � ! classes/external/reports/view.phpnu �[��� <?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\reports; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_external\external_warnings; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\event\report_viewed; /** * External method to record the viewing of a report * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class view extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), ]); } /** * External method execution * * @param int $reportid * @return array */ public static function execute(int $reportid): array { [ 'reportid' => $reportid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); $persistent = $report->get_report_persistent(); permission::require_can_view_report($persistent); // Trigger the report viewed event. report_viewed::create_from_object($persistent)->trigger(); return [ 'status' => true, 'warnings' => [], ]; } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'status' => new external_value(PARAM_BOOL, 'Success'), 'warnings' => new external_warnings(), ]); } } PK a<�\���E E classes/external/reports/get.phpnu �[��� <?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\reports; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\output\custom_report; use core_reportbuilder\external\custom_report_exporter; use moodle_url; /** * External method for getting a custom report * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'editmode' => new external_value(PARAM_BOOL, 'Whether editing mode is enabled', VALUE_DEFAULT, 0), 'pagesize' => new external_value(PARAM_INT, 'Page size', VALUE_DEFAULT, 0), ]); } /** * External method execution * * @param int $reportid * @param bool $editmode * @param int $pagesize * @return array */ public static function execute(int $reportid, bool $editmode, int $pagesize = 0): array { global $PAGE, $OUTPUT; [ 'reportid' => $reportid, 'editmode' => $editmode, 'pagesize' => $pagesize, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'editmode' => $editmode, 'pagesize' => $pagesize, ]); $report = manager::get_report_from_id($reportid); if ($pagesize > 0) { $report->set_default_per_page($pagesize); } self::validate_context($report->get_context()); if ($editmode) { permission::require_can_edit_report($report->get_report_persistent()); } else { permission::require_can_view_report($report->get_report_persistent()); } // Set current URL and force bootstrap_renderer to initiate moodle page. $PAGE->set_url(new moodle_url('/')); $OUTPUT->header(); $PAGE->start_collecting_javascript_requirements(); $renderer = $PAGE->get_renderer('core_reportbuilder'); $context = (new custom_report($report->get_report_persistent(), $editmode))->export_for_template($renderer); $context->javascript = $PAGE->requires->get_end_code(); return (array)$context; } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_exporter::get_read_structure(); } } PK a<�\S���a a $ classes/external/reports/listing.phpnu �[��� <?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\reports; use context_system; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_multiple_structure; use core_external\external_function_parameters; use core_external\external_warnings; use stdClass; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_details_exporter; use core_reportbuilder\local\helpers\audience; use core_reportbuilder\local\models\report; /** * External method for listing users' custom reports * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class listing extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'page' => new external_value(PARAM_INT, 'Page number', VALUE_DEFAULT, 0), 'perpage' => new external_value(PARAM_INT, 'Reports per page', VALUE_DEFAULT, 10), ]); } /** * External method execution * * @param int $page * @param int $perpage * @return array */ public static function execute(int $page = 0, int $perpage = 10): array { global $DB, $PAGE; [ 'page' => $page, 'perpage' => $perpage, ] = self::validate_parameters(self::execute_parameters(), [ 'page' => $page, 'perpage' => $perpage, ]); $context = context_system::instance(); self::validate_context($context); permission::require_can_view_reports_list(null, $context); // Filter list of reports by those the user can access. [$where, $params] = audience::user_reports_list_access_sql('r'); $reports = $DB->get_records_sql(" SELECT r.* FROM {" . report::TABLE . "} r WHERE r.type = 0 AND {$where} ORDER BY r.name, r.id", $params, $page * $perpage, $perpage); $output = $PAGE->get_renderer('core'); return [ 'reports' => array_map(static function(stdClass $report) use ($output): array { $exporter = new custom_report_details_exporter(new report(0, $report)); return (array) $exporter->export($output); }, $reports), 'warnings' => [], ]; } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return new external_single_structure([ 'reports' => new external_multiple_structure(custom_report_details_exporter::get_read_structure()), 'warnings' => new external_warnings(), ]); } } PK a<�\F�o # classes/external/reports/delete.phpnu �[��� <?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\reports; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; use core_reportbuilder\local\models\report as report_model; /** * External method for deleting reports * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class delete extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), ]); } /** * External method execution * * @param int $reportid * @return bool */ public static function execute(int $reportid): bool { [ 'reportid' => $reportid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, ]); // Load the report model for deletion. Note we don't use the manager class because it validates the report source, // and we want user to be able to delete report, even if it's no longer associated with a valid source. $report = new report_model($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report); return report::delete_report($reportid); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL, 'Success'); } } PK a<�\ �� � % classes/external/schedules/toggle.phpnu �[��� <?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\schedules; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\schedule; /** * External method for toggling report schedules * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class toggle extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'scheduleid' => new external_value(PARAM_INT, 'Schedule ID'), 'enabled' => new external_value(PARAM_BOOL, 'Schedule enabled'), ]); } /** * External method execution * * @param int $reportid * @param int $scheduleid * @param bool $enabled * @return bool */ public static function execute(int $reportid, int $scheduleid, bool $enabled): bool { [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, 'enabled' => $enabled, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, 'enabled' => $enabled, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); return schedule::toggle_schedule($reportid, $scheduleid, $enabled); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL); } } PK a<�\TR� % classes/external/schedules/delete.phpnu �[��� <?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\schedules; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\schedule; /** * External method for deleting report schedules * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class delete extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'scheduleid' => new external_value(PARAM_INT, 'Schedule ID'), ]); } /** * External method execution * * @param int $reportid * @param int $scheduleid * @return bool */ public static function execute(int $reportid, int $scheduleid): bool { [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); return schedule::delete_schedule($reportid, $scheduleid); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL); } } PK a<�\MU��� � # classes/external/schedules/send.phpnu �[��� <?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\schedules; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\task\send_schedule; /** * External method for sending report schedules * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class send extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'scheduleid' => new external_value(PARAM_INT, 'Schedule ID'), ]); } /** * External method execution * * @param int $reportid * @param int $scheduleid * @return bool */ public static function execute(int $reportid, int $scheduleid): bool { [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); $sendschedule = new send_schedule(); $sendschedule->set_custom_data([ 'reportid' => $reportid, 'scheduleid' => $scheduleid, ]); return (bool) \core\task\manager::queue_adhoc_task($sendschedule); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL); } } PK a<�\�'�� � classes/external/columns/add.phpnu �[��� <?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\columns; use core_reportbuilder\external\custom_report_columns_sorting_exporter; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; /** * External method for adding report columns * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class add extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'uniqueidentifier' => new external_value(PARAM_RAW, 'Unique identifier of the column'), ]); } /** * External method execution * * @param int $reportid * @param string $uniqueidentifier * @return array */ public static function execute(int $reportid, string $uniqueidentifier): array { global $PAGE; [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::add_report_column($reportid, $uniqueidentifier); $exporter = new custom_report_columns_sorting_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_columns_sorting_exporter::get_read_structure(); } } PK a<�\_g�IZ Z % classes/external/columns/sort/get.phpnu �[��� <?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\columns\sort; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_columns_sorting_exporter; /** * External method for retrieving report column sorting * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class get extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), ]); } /** * External method execution * * @param int $reportid * @return array */ public static function execute(int $reportid): array { global $PAGE; [ 'reportid' => $reportid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); $exporter = new custom_report_columns_sorting_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_columns_sorting_exporter::get_read_structure(); } } PK a<�\kx-C C ( classes/external/columns/sort/toggle.phpnu �[��� <?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\columns\sort; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; use core_reportbuilder\external\custom_report_columns_sorting_exporter; /** * External method for toggling report column sorting * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class toggle extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'columnid' => new external_value(PARAM_INT, 'Column ID'), 'enabled' => new external_value(PARAM_BOOL, 'Sort enabled'), 'direction' => new external_value(PARAM_INT, 'Sort direction', VALUE_DEFAULT, SORT_ASC), ]); } /** * External method execution * * @param int $reportid * @param int $columnid * @param bool $enabled * @param int $direction * @return array */ public static function execute(int $reportid, int $columnid, bool $enabled, int $direction = SORT_ASC): array { global $PAGE; [ 'reportid' => $reportid, 'columnid' => $columnid, 'enabled' => $enabled, 'direction' => $direction, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'columnid' => $columnid, 'enabled' => $enabled, 'direction' => $direction, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::toggle_report_column_sorting($reportid, $columnid, $enabled, $direction); $exporter = new custom_report_columns_sorting_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_columns_sorting_exporter::get_read_structure(); } } PK a<�\^y�b b ) classes/external/columns/sort/reorder.phpnu �[��� <?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\columns\sort; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; use core_reportbuilder\external\custom_report_columns_sorting_exporter; /** * External method for re-ordering report column sorting * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reorder extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'columnid' => new external_value(PARAM_INT, 'Column ID'), 'position' => new external_value(PARAM_INT, 'New column sort position'), ]); } /** * External method execution * * @param int $reportid * @param int $columnid * @param int $position * @return array */ public static function execute(int $reportid, int $columnid, int $position): array { global $PAGE; [ 'reportid' => $reportid, 'columnid' => $columnid, 'position' => $position, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'columnid' => $columnid, 'position' => $position, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::reorder_report_column_sorting($reportid, $columnid, $position); $exporter = new custom_report_columns_sorting_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_columns_sorting_exporter::get_read_structure(); } } PK a<�\�T�t t # classes/external/columns/delete.phpnu �[��� <?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\columns; use core_reportbuilder\external\custom_report_columns_sorting_exporter; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; /** * External method for deleting report columns * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class delete extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'columnid' => new external_value(PARAM_INT, 'Column ID'), ]); } /** * External method execution * * @param int $reportid * @param int $columnid * @return array */ public static function execute(int $reportid, int $columnid): array { global $PAGE; [ 'reportid' => $reportid, 'columnid' => $columnid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'columnid' => $columnid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::delete_report_column($reportid, $columnid); $exporter = new custom_report_columns_sorting_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_columns_sorting_exporter::get_read_structure(); } } PK a<�\v`G� � $ classes/external/columns/reorder.phpnu �[��� <?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\columns; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\report; /** * External method for re-ordering report columns * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reorder extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'columnid' => new external_value(PARAM_INT, 'Column ID'), 'position' => new external_value(PARAM_INT, 'New column position') ]); } /** * External method execution * * @param int $reportid * @param int $columnid * @param int $position * @return bool */ public static function execute(int $reportid, int $columnid, int $position): bool { [ 'reportid' => $reportid, 'columnid' => $columnid, 'position' => $position, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'columnid' => $columnid, 'position' => $position, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); return report::reorder_report_column($reportid, $columnid, $position); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL, 'Success'); } } PK a<�\3;[� � # classes/external/conditions/add.phpnu �[��� <?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\conditions; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_conditions_exporter; use core_reportbuilder\local\helpers\report; /** * External method for adding report conditions * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class add extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'uniqueidentifier' => new external_value(PARAM_RAW, 'Unique identifier of the condition'), ]); } /** * External method execution * * @param int $reportid * @param string $uniqueidentifier * @return array */ public static function execute(int $reportid, string $uniqueidentifier): array { global $PAGE, $OUTPUT; [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::add_report_condition($reportid, $uniqueidentifier); // Set current URL and force bootstrap_renderer to initiate moodle page. $PAGE->set_url('/'); $OUTPUT->header(); $PAGE->start_collecting_javascript_requirements(); $exporter = new custom_report_conditions_exporter(null, ['report' => $report]); $export = $exporter->export($PAGE->get_renderer('core')); $export->javascript = $PAGE->requires->get_end_code(); return (array) $export; } /** * External method return value * * @return external_value */ public static function execute_returns(): external_single_structure { return custom_report_conditions_exporter::get_read_structure(); } } PK a<�\ ɮy y % classes/external/conditions/reset.phpnu �[��� <?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\conditions; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_conditions_exporter; /** * External method for resetting report conditions * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reset extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), ]); } /** * External method execution * * @param int $reportid * @return array */ public static function execute(int $reportid): array { global $PAGE, $OUTPUT; [ 'reportid' => $reportid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); $report->set_condition_values([]); // Set current URL and force bootstrap_renderer to initiate moodle page. $PAGE->set_url('/'); $OUTPUT->header(); $PAGE->start_collecting_javascript_requirements(); $exporter = new custom_report_conditions_exporter(null, ['report' => $report]); $export = $exporter->export($PAGE->get_renderer('core')); $export->javascript = $PAGE->requires->get_end_code(); return (array) $export; } /** * External method return value * * @return external_value */ public static function execute_returns(): external_single_structure { return custom_report_conditions_exporter::get_read_structure(); } } PK a<�\�FTu� � & classes/external/conditions/delete.phpnu �[��� <?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\conditions; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_conditions_exporter; use core_reportbuilder\local\helpers\report; /** * External method for deleting report conditions * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class delete extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'conditionid' => new external_value(PARAM_INT, 'Condition ID'), ]); } /** * External method execution * * @param int $reportid * @param int $conditionid * @return array */ public static function execute(int $reportid, int $conditionid): array { global $PAGE, $OUTPUT; [ 'reportid' => $reportid, 'conditionid' => $conditionid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'conditionid' => $conditionid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::delete_report_condition($reportid, $conditionid); // Set current URL and force bootstrap_renderer to initiate moodle page. $PAGE->set_url('/'); $OUTPUT->header(); $PAGE->start_collecting_javascript_requirements(); $exporter = new custom_report_conditions_exporter(null, ['report' => $report]); $export = $exporter->export($PAGE->get_renderer('core')); $export->javascript = $PAGE->requires->get_end_code(); return (array) $export; } /** * External method return value * * @return external_value */ public static function execute_returns(): external_single_structure { return custom_report_conditions_exporter::get_read_structure(); } } PK a<�\��4g g ' classes/external/conditions/reorder.phpnu �[��� <?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\conditions; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_conditions_exporter; use core_reportbuilder\local\helpers\report; /** * External method for re-ordering report conditions * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reorder extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'conditionid' => new external_value(PARAM_INT, 'Condition ID'), 'position' => new external_value(PARAM_INT, 'New condition position') ]); } /** * External method execution * * @param int $reportid * @param int $conditionid * @param int $position * @return array */ public static function execute(int $reportid, int $conditionid, int $position): array { global $PAGE, $OUTPUT; [ 'reportid' => $reportid, 'conditionid' => $conditionid, 'position' => $position, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'conditionid' => $conditionid, 'position' => $position, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::reorder_report_condition($reportid, $conditionid, $position); // Set current URL and force bootstrap_renderer to initiate moodle page. $PAGE->set_url('/'); $OUTPUT->header(); $PAGE->start_collecting_javascript_requirements(); $exporter = new custom_report_conditions_exporter(null, ['report' => $report]); $export = $exporter->export($PAGE->get_renderer('core')); $export->javascript = $PAGE->requires->get_end_code(); return (array) $export; } /** * External method return value * * @return external_value */ public static function execute_returns(): external_single_structure { return custom_report_conditions_exporter::get_read_structure(); } } PK a<�\��\Q Q + classes/external/custom_report_exporter.phpnu �[��� <?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 renderer_base; use core\persistent; use core\external\persistent_exporter; use core_reportbuilder\manager; use core_reportbuilder\datasource; use core_reportbuilder\form\filter as form_filter; use core_reportbuilder\local\models\report; use core_reportbuilder\table\custom_report_table; use core_reportbuilder\table\custom_report_table_filterset; use core_reportbuilder\table\custom_report_table_view; use core_reportbuilder\table\custom_report_table_view_filterset; use core_table\local\filter\integer_filter; /** * Custom report exporter class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_exporter extends persistent_exporter { /** @var report The persistent object we will export. */ protected $persistent = null; /** @var bool */ protected $editmode; /** @var string */ protected $download; /** * report_exporter constructor. * * @param persistent $persistent * @param array $related * @param bool $editmode * @param string $download */ public function __construct(persistent $persistent, array $related = [], bool $editmode = true, string $download = '') { parent::__construct($persistent, $related); $this->editmode = $editmode; $this->download = $download; } /** * Return the name of the class we are exporting * * @return string */ protected static function define_class(): string { return report::class; } /** * Return a list of objects that are related to the persistent * * @return array */ protected static function define_related(): array { return [ 'pagesize' => 'int?', ]; } /** * Return a list of additional properties used only for display * * @return array */ protected static function define_other_properties(): array { return [ 'table' => ['type' => PARAM_RAW], 'filtersapplied' => ['type' => PARAM_INT], 'filterspresent' => ['type' => PARAM_BOOL], 'filtersform' => ['type' => PARAM_RAW], 'attributes' => [ 'type' => [ 'name' => ['type' => PARAM_TEXT], 'value' => ['type' => PARAM_TEXT] ], 'multiple' => true, ], 'classes' => ['type' => PARAM_TEXT], 'editmode' => ['type' => PARAM_BOOL], 'sidebarmenucards' => [ 'type' => custom_report_column_cards_exporter::read_properties_definition(), 'optional' => true, ], 'conditions' => [ 'type' => custom_report_conditions_exporter::read_properties_definition(), 'optional' => true, ], 'filters' => [ 'type' => custom_report_filters_exporter::read_properties_definition(), 'optional' => true, ], 'sorting' => [ 'type' => custom_report_columns_sorting_exporter::read_properties_definition(), 'optional' => true, ], 'cardview' => [ 'type' => custom_report_card_view_exporter::read_properties_definition(), 'optional' => true, ], 'javascript' => ['type' => PARAM_RAW], ]; } /** * Get additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var datasource $report */ $report = manager::get_report_from_persistent($this->persistent); $filterspresent = false; $filtersform = ''; $attributes = []; if ($this->editmode) { $table = custom_report_table::create($this->persistent->get('id')); $table->set_filterset(new custom_report_table_filterset()); } else { // We store the pagesize within the table filterset so that it's available between AJAX requests. $filterset = new custom_report_table_view_filterset(); $filterset->add_filter(new integer_filter('pagesize', null, [$this->related['pagesize']])); $table = custom_report_table_view::create($this->persistent->get('id'), $this->download); $table->set_filterset($filterset); // Generate filters form if report contains any filters. $filterspresent = !empty($report->get_active_filters()); if ($filterspresent && empty($this->download)) { $filtersform = $this->generate_filters_form()->render(); } // Get the report classes and attributes. $reportattributes = $report->get_attributes(); if (isset($reportattributes['class'])) { $classes = $reportattributes['class']; unset($reportattributes['class']); } $attributes = array_map(static function($key, $value): array { return ['name' => $key, 'value' => $value]; }, array_keys($reportattributes), $reportattributes); } // If we are editing we need all this information for the template. $editordata = []; if ($this->editmode) { $menucardsexporter = new custom_report_column_cards_exporter(null, ['report' => $report]); $editordata['sidebarmenucards'] = (array) $menucardsexporter->export($output); $conditionsexporter = new custom_report_conditions_exporter(null, ['report' => $report]); $editordata['conditions'] = (array) $conditionsexporter->export($output); $filtersexporter = new custom_report_filters_exporter(null, ['report' => $report]); $editordata['filters'] = (array) $filtersexporter->export($output); $sortingexporter = new custom_report_columns_sorting_exporter(null, ['report' => $report]); $editordata['sorting'] = (array) $sortingexporter->export($output); $cardviewexporter = new custom_report_card_view_exporter(null, ['report' => $report]); $editordata['cardview'] = (array) $cardviewexporter->export($output); } return [ 'table' => $output->render($table), 'filtersapplied' => $report->get_applied_filter_count(), 'filterspresent' => $filterspresent, 'filtersform' => $filtersform, 'attributes' => $attributes, 'classes' => $classes ?? '', 'editmode' => $this->editmode, 'javascript' => '', ] + $editordata; } /** * Generate filters form for the report * * @return form_filter */ private function generate_filters_form(): form_filter { $filtersform = new form_filter(null, null, 'post', '', [], true, [ 'reportid' => $this->persistent->get('id'), 'parameters' => json_encode([]), ]); $filtersform->set_data_for_dynamic_submission(); return $filtersform; } } PK a<�\8w�<X X 6 classes/external/custom_report_conditions_exporter.phpnu �[��� <?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 renderer_base; use core\external\exporter; use core_reportbuilder\datasource; use core_reportbuilder\form\condition; use core_reportbuilder\local\report\filter; /** * Custom report conditions exporter class * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_conditions_exporter extends exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => datasource::class, ]; } /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'hasavailableconditions' => [ 'type' => PARAM_BOOL, ], 'availableconditions' => [ 'type' => [ 'optiongroup' => [ 'type' => [ 'text' => ['type' => PARAM_TEXT], 'values' => [ 'type' => [ 'value' => ['type' => PARAM_TEXT], 'visiblename' => ['type' => PARAM_TEXT], ], 'multiple' => true, ], ], ], ], 'multiple' => true, ], 'hasactiveconditions' => [ 'type' => PARAM_BOOL, ], 'activeconditionsform' => [ 'type' => PARAM_RAW, ], 'helpicon' => [ 'type' => PARAM_RAW, ], 'javascript' => [ 'type' => PARAM_RAW, 'optional' => true, ], ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var datasource $report */ $report = $this->related['report']; // Current condition instances contained in the report. $conditions = $report->get_active_conditions(); $conditionidentifiers = array_map(static function(filter $condition): string { return $condition->get_unique_identifier(); }, $conditions); $availableconditions = []; // Populate available conditions. foreach ($report->get_conditions() as $condition) { // Conditions can only be added once per report, skip if it already exists. if (in_array($condition->get_unique_identifier(), $conditionidentifiers) || $condition->get_is_deprecated()) { continue; } $entityname = $condition->get_entity_name(); if (!array_key_exists($entityname, $availableconditions)) { $availableconditions[$entityname] = [ 'optiongroup' => [ 'text' => $report->get_entity_title($entityname)->out(), 'values' => [], ], ]; } $availableconditions[$entityname]['optiongroup']['values'][] = [ 'value' => $condition->get_unique_identifier(), 'visiblename' => $condition->get_header(), ]; } // Generate conditions form if any present. $conditionspresent = !empty($conditions); if ($conditionspresent) { $conditionsform = new condition(null, null, 'post', '', [], true, [ 'reportid' => $report->get_report_persistent()->get('id'), ]); $conditionsform->set_data_for_dynamic_submission(); } return [ 'hasavailableconditions' => !empty($availableconditions), 'availableconditions' => array_values($availableconditions), 'hasactiveconditions' => $conditionspresent, 'activeconditionsform' => $conditionspresent ? $conditionsform->render() : '', 'helpicon' => $output->help_icon('conditions', 'core_reportbuilder'), ]; } } PK a<�\ O�� � 3 classes/external/custom_report_filters_exporter.phpnu �[��� <?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 renderer_base; use core\external\exporter; use core_reportbuilder\datasource; use core_reportbuilder\local\report\filter; use core_reportbuilder\output\filter_heading_editable; /** * Custom report filters exporter class * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_filters_exporter extends exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => datasource::class, ]; } /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'hasavailablefilters' => [ 'type' => PARAM_BOOL, ], 'availablefilters' => [ 'type' => [ 'optiongroup' => [ 'type' => [ 'text' => ['type' => PARAM_TEXT], 'values' => [ 'type' => [ 'value' => ['type' => PARAM_TEXT], 'visiblename' => ['type' => PARAM_TEXT], ], 'multiple' => true, ], ], ], ], 'multiple' => true, ], 'hasactivefilters' => [ 'type' => PARAM_BOOL, ], 'activefilters' => [ 'type' => [ 'id' => ['type' => PARAM_INT], 'heading' => ['type' => PARAM_TEXT], 'headingeditable' => ['type' => PARAM_RAW], 'sortorder' => ['type' => PARAM_INT], 'movetitle' => ['type' => PARAM_TEXT], 'entityname' => ['type' => PARAM_TEXT], ], 'multiple' => true, ], 'helpicon' => [ 'type' => PARAM_RAW, ], ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var datasource $report */ $report = $this->related['report']; // Current filter instances contained in the report. $filters = $report->get_active_filters(); $filteridentifiers = array_map(static function(filter $filter): string { return $filter->get_unique_identifier(); }, $filters); $availablefilters = $activefilters = []; // Populate available filters. foreach ($report->get_filters() as $filter) { // Filters can only be added once per report, skip if it already exists. if (in_array($filter->get_unique_identifier(), $filteridentifiers) || $filter->get_is_deprecated()) { continue; } $entityname = $filter->get_entity_name(); if (!array_key_exists($entityname, $availablefilters)) { $availablefilters[$entityname] = [ 'optiongroup' => [ 'text' => $report->get_entity_title($entityname)->out(), 'values' => [], ], ]; } $availablefilters[$entityname]['optiongroup']['values'][] = [ 'value' => $filter->get_unique_identifier(), 'visiblename' => $filter->get_header(), ]; } // Populate active filters. $filterinstances = $report->get_filter_instances(); foreach ($filterinstances as $filterinstance) { $persistent = $filterinstance->get_filter_persistent(); $entityname = $filterinstance->get_entity_name(); $displayvalue = $filterinstance->get_header(); $editable = new filter_heading_editable(0, $persistent); $activefilters[] = [ 'id' => $persistent->get('id'), 'entityname' => $report->get_entity_title($entityname)->out(), 'heading' => $displayvalue, 'headingeditable' => $editable->render($output), 'sortorder' => $persistent->get('filterorder'), 'movetitle' => get_string('movefilter', 'core_reportbuilder', $displayvalue), ]; } return [ 'hasavailablefilters' => !empty($availablefilters), 'availablefilters' => array_values($availablefilters), 'hasactivefilters' => !empty($activefilters), 'activefilters' => $activefilters, 'helpicon' => $output->help_icon('filters', 'core_reportbuilder'), ]; } } PK a<�\����= = 6 classes/external/custom_report_menu_cards_exporter.phpnu �[��� <?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\external\exporter; /** * Custom report menu cards exporter abstract class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class custom_report_menu_cards_exporter extends exporter { /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'menucards' => [ 'type' => [ 'name' => [ 'type' => PARAM_TEXT, ], 'key' => [ 'type' => PARAM_TEXT, ], 'items' => [ 'type' => [ 'name' => [ 'type' => PARAM_TEXT, ], 'identifier' => [ 'type' => PARAM_TEXT, ], 'title' => [ 'type' => PARAM_TEXT, ], 'action' => [ 'type' => PARAM_TEXT, ], 'disabled' => [ 'type' => PARAM_BOOL, 'optional' => true, 'default' => false, ], ], 'optional' => true, 'multiple' => true, ], ], 'optional' => true, 'multiple' => true, ], ]; } } PK a<�\��gʰ � classes/external/filters/add.phpnu �[��� <?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\filters; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_filters_exporter; use core_reportbuilder\local\helpers\report; /** * External method for adding report filters * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class add extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'uniqueidentifier' => new external_value(PARAM_RAW, 'Unique identifier of the filter'), ]); } /** * External method execution * * @param int $reportid * @param string $uniqueidentifier * @return array */ public static function execute(int $reportid, string $uniqueidentifier): array { global $PAGE; [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::add_report_filter($reportid, $uniqueidentifier); $exporter = new custom_report_filters_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_filters_exporter::get_read_structure(); } } PK a<�\Hp�� " classes/external/filters/reset.phpnu �[��� <?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\filters; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\user_filter_manager; /** * External method for resetting report filters * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reset extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'parameters' => new external_value(PARAM_RAW, 'JSON encoded report parameters', VALUE_DEFAULT, ''), ]); } /** * External method execution * * @param int $reportid * @param string $parameters JSON encoded parameters used to re-create the report, for instance for those reports that * require parameters as part of their {@see \core_reportbuilder\system_report::can_view} implementation * @return bool */ public static function execute(int $reportid, string $parameters = ''): bool { [ 'reportid' => $reportid, 'parameters' => $parameters, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'parameters' => $parameters, ]); $report = manager::get_report_from_id($reportid, (array) json_decode($parameters)); self::validate_context($report->get_context()); // System report permission is implicitly handled, we need to make sure custom report can be viewed. $persistent = $report->get_report_persistent(); if ($persistent->get('type') === $report::TYPE_CUSTOM_REPORT) { permission::require_can_view_report($persistent); } return user_filter_manager::reset_all($reportid); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL, 'Success'); } } PK a<�\h�j�� � classes/external/filters/set.phpnu �[��� <?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\filters; use core_external\external_api; use core_external\external_value; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; /** * External method for setting report filter values * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class set extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'parameters' => new external_value(PARAM_RAW, 'JSON encoded report parameters', VALUE_DEFAULT, ''), 'values' => new external_value(PARAM_RAW, 'JSON encoded filter values'), ]); } /** * External method execution * * @param int $reportid * @param string $parameters * @param string $values * @return bool */ public static function execute(int $reportid, string $parameters, string $values): bool { [ 'reportid' => $reportid, 'parameters' => $parameters, 'values' => $values, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'parameters' => $parameters, 'values' => $values, ]); $report = manager::get_report_from_id($reportid, (array) json_decode($parameters)); self::validate_context($report->get_context()); // System report permission is implicitly handled, we need to make sure custom report can be viewed. $persistent = $report->get_report_persistent(); if ($persistent->get('type') === $report::TYPE_CUSTOM_REPORT) { permission::require_can_view_report($persistent); } return $report->set_filter_values((array) json_decode($values)); } /** * External method return value * * @return external_value */ public static function execute_returns(): external_value { return new external_value(PARAM_BOOL, 'Success'); } } PK a<�\���\ \ # classes/external/filters/delete.phpnu �[��� <?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\filters; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_filters_exporter; use core_reportbuilder\local\helpers\report; /** * External method for deleting report filters * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class delete extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'filterid' => new external_value(PARAM_INT, 'Filter ID'), ]); } /** * External method execution * * @param int $reportid * @param int $filterid * @return array */ public static function execute(int $reportid, int $filterid): array { global $PAGE; [ 'reportid' => $reportid, 'filterid' => $filterid, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'filterid' => $filterid, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::delete_report_filter($reportid, $filterid); $exporter = new custom_report_filters_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_filters_exporter::get_read_structure(); } } PK a<�\�\��0 0 $ classes/external/filters/reorder.phpnu �[��� <?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\filters; use core_external\external_api; use core_external\external_value; use core_external\external_single_structure; use core_external\external_function_parameters; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\external\custom_report_filters_exporter; use core_reportbuilder\local\helpers\report; /** * External method for re-ordering report filters * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reorder extends external_api { /** * External method parameters * * @return external_function_parameters */ public static function execute_parameters(): external_function_parameters { return new external_function_parameters([ 'reportid' => new external_value(PARAM_INT, 'Report ID'), 'filterid' => new external_value(PARAM_INT, 'Filter ID'), 'position' => new external_value(PARAM_INT, 'New filter position') ]); } /** * External method execution * * @param int $reportid * @param int $filterid * @param int $position * @return array */ public static function execute(int $reportid, int $filterid, int $position): array { global $PAGE; [ 'reportid' => $reportid, 'filterid' => $filterid, 'position' => $position, ] = self::validate_parameters(self::execute_parameters(), [ 'reportid' => $reportid, 'filterid' => $filterid, 'position' => $position, ]); $report = manager::get_report_from_id($reportid); self::validate_context($report->get_context()); permission::require_can_edit_report($report->get_report_persistent()); report::reorder_report_filter($reportid, $filterid, $position); $exporter = new custom_report_filters_exporter(null, [ 'report' => $report, ]); return (array) $exporter->export($PAGE->get_renderer('core')); } /** * External method return value * * @return external_single_structure */ public static function execute_returns(): external_single_structure { return custom_report_filters_exporter::get_read_structure(); } } PK a<�\/~�jC C 3 classes/external/custom_report_details_exporter.phpnu �[��� <?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_user; use renderer_base; use core\external\persistent_exporter; use core_reportbuilder\datasource; use core_reportbuilder\manager; use core_reportbuilder\local\models\report; use core_tag\external\{tag_item_exporter, util}; use core_user\external\user_summary_exporter; /** * Custom report details 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_details_exporter extends persistent_exporter { /** @var report The persistent object we will export. */ protected $persistent = null; /** * Return the name of the class we are exporting * * @return string */ protected static function define_class(): string { return report::class; } /** * Return a list of additional properties used only for display * * @return array */ protected static function define_other_properties(): array { return [ 'sourcename' => [ 'type' => PARAM_RAW, 'null' => NULL_ALLOWED, ], 'tags' => [ 'type' => tag_item_exporter::read_properties_definition(), 'multiple' => true, ], 'modifiedby' => ['type' => user_summary_exporter::read_properties_definition()], ]; } /** * Get additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { $source = $this->persistent->get('source'); $usermodified = core_user::get_user($this->persistent->get('usermodified')); return [ 'sourcename' => manager::report_source_exists($source, datasource::class) ? $source::get_name() : null, 'tags' => util::get_item_tags('core_reportbuilder', 'reportbuilder_report', $this->persistent->get('id')), 'modifiedby' => (new user_summary_exporter($usermodified))->export($output), ]; } } PK a<�\߃�� � + classes/external/system_report_exporter.phpnu �[��� <?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\external\persistent_exporter; use core_table\local\filter\integer_filter; use core_table\local\filter\string_filter; use core_reportbuilder\system_report; use core_reportbuilder\form\filter; use core_reportbuilder\local\models\report; use core_reportbuilder\table\system_report_table; use core_reportbuilder\table\system_report_table_filterset; use renderer_base; /** * Report exporter class * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_exporter extends persistent_exporter { /** * Return the name of the class we are exporting * * @return string */ protected static function define_class(): string { return report::class; } /** * Return a list of objects that are related to the persistent * * @return array */ protected static function define_related(): array { return [ 'source' => system_report::class, 'parameters' => 'string', ]; } /** * Return a list of additional properties used only for display * * @return array */ protected static function define_other_properties(): array { return [ 'table' => ['type' => PARAM_RAW], 'parameters' => ['type' => PARAM_RAW], 'filterspresent' => ['type' => PARAM_BOOL], 'filtersapplied' => ['type' => PARAM_INT], 'filtersform' => ['type' => PARAM_RAW], 'attributes' => [ 'type' => [ 'name' => ['type' => PARAM_TEXT], 'value' => ['type' => PARAM_TEXT] ], 'multiple' => true, ], 'classes' => ['type' => PARAM_TEXT], ]; } /** * Get additional values to inject while exporting * * @uses \core_reportbuilder\output\renderer::render_system_report_table() * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var system_report $source */ $source = $this->related['source']; /** @var string $parameters */ $parameters = $this->related['parameters']; /** @var int $reportid */ $reportid = $this->persistent->get('id'); // We store the report ID and parameters within the table filterset so that they are available between AJAX requests. $filterset = new system_report_table_filterset(); $filterset->add_filter(new integer_filter('reportid', null, [$reportid])); $filterset->add_filter(new string_filter('parameters', null, [$parameters])); $params = (array) json_decode($parameters, true); $table = system_report_table::create($reportid, $params); $table->set_filterset($filterset); // Generate filters form if report uses the default form, and contains any filters. $filterspresent = $source->get_filter_form_default() && !empty($source->get_active_filters()); if ($filterspresent && empty($params['download'])) { $filtersform = new filter(null, null, 'post', '', [], true, [ 'reportid' => $reportid, 'parameters' => $parameters, ]); $filtersform->set_data_for_dynamic_submission(); } // Get the report classes and attributes. $sourceattributes = $source->get_attributes(); if (isset($sourceattributes['class'])) { $classes = $sourceattributes['class']; unset($sourceattributes['class']); } $attributes = array_map(static function($key, $value): array { return ['name' => $key, 'value' => $value]; }, array_keys($sourceattributes), $sourceattributes); return [ 'table' => $output->render($table), 'parameters' => $parameters, 'filterspresent' => $filterspresent, 'filtersapplied' => $source->get_applied_filter_count(), 'filtersform' => $filterspresent ? $filtersform->render() : '', 'attributes' => $attributes, 'classes' => $classes ?? '', ]; } } PK a<�\�"� � 5 classes/external/custom_report_card_view_exporter.phpnu �[��� <?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 renderer_base; use core\external\exporter; use core_reportbuilder\datasource; use core_reportbuilder\form\card_view; /** * Custom report card view exporter class * * @package core_reportbuilder * @copyright 2021 Mikel Martín <mikel@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_card_view_exporter extends exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => datasource::class, ]; } /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'form' => [ 'type' => PARAM_RAW, ], 'helpicon' => [ 'type' => PARAM_RAW, ], ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var datasource $report */ $report = $this->related['report']; $reportid = $report->get_report_persistent()->get('id'); $reportsettings = $report->get_settings_values(); $cardviewsettings = [ 'showfirsttitle' => $reportsettings['cardview_showfirsttitle'] ?? 0, 'visiblecolumns' => $reportsettings['cardview_visiblecolumns'] ?? 1, ]; $cardviewform = new card_view(null, null, 'post', '', [], true, array_merge(['reportid' => $reportid], $cardviewsettings)); $cardviewform->set_data_for_dynamic_submission(); return [ 'form' => $cardviewform->render(), 'helpicon' => $output->help_icon('cardview', 'core_reportbuilder'), ]; } } PK a<�\r��.� � 0 classes/external/custom_report_data_exporter.phpnu �[��� <?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 renderer_base; use core\external\exporter; use core_reportbuilder\datasource; use core_reportbuilder\table\custom_report_table_view; /** * Custom report data 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_data_exporter extends exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => datasource::class, 'page' => 'int', 'perpage' => 'int', ]; } /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'headers' => [ 'type' => PARAM_RAW, 'multiple' => true, ], 'rows' => [ 'type' => [ 'columns' => [ 'type' => PARAM_RAW, 'null' => NULL_ALLOWED, 'multiple' => true, ], ], 'multiple' => true, ], 'totalrowcount' => ['type' => PARAM_INT], ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { global $DB; /** @var datasource $report */ $report = $this->related['report']; $table = custom_report_table_view::create($report->get_report_persistent()->get('id')); $table->setup(); // Internally the current page is zero-based, but this method expects value plus one. $table->set_page_number($this->related['page'] + 1); $table->query_db($this->related['perpage'], false); $tablerows = []; foreach ($table->rawdata as $record) { $tablerows[] = [ 'columns' => array_values($table->format_row($record)), ]; } $table->close_recordset(); return [ 'headers' => $table->headers, 'rows' => $tablerows, 'totalrowcount' => $DB->count_records_sql($table->countsql, $table->countparams), ]; } } PK a<�\g�oLb b ; classes/external/custom_report_columns_sorting_exporter.phpnu �[��� <?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 pix_icon; use renderer_base; use core\external\exporter; use core_reportbuilder\datasource; use core_reportbuilder\local\report\column; /** * Custom report columns sorting exporter class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_columns_sorting_exporter extends exporter { /** * Return a list of objects that are related to the exporter * * @return array */ protected static function define_related(): array { return [ 'report' => datasource::class, ]; } /** * Return the list of additional properties for read structure and export * * @return array[] */ protected static function define_other_properties(): array { return [ 'hassortablecolumns' => [ 'type' => PARAM_BOOL, ], 'sortablecolumns' => [ 'type' => [ 'id' => ['type' => PARAM_INT], 'title' => ['type' => PARAM_TEXT], 'heading' => ['type' => PARAM_TEXT], 'sortdirection' => ['type' => PARAM_INT], 'sortenabled' => ['type' => PARAM_BOOL], 'sortorder' => ['type' => PARAM_INT], 'sorticon' => [ 'type' => [ 'key' => ['type' => PARAM_RAW], 'component' => ['type' => PARAM_COMPONENT], 'title' => ['type' => PARAM_NOTAGS], ], ], 'movetitle' => ['type' => PARAM_TEXT], 'sortenabledtitle' => ['type' => PARAM_TEXT], ], 'multiple' => true, ], 'helpicon' => [ 'type' => PARAM_RAW, ], ]; } /** * Get the additional values to inject while exporting * * @param renderer_base $output * @return array */ protected function get_other_values(renderer_base $output): array { /** @var datasource $report */ $report = $this->related['report']; // Filter/retrieve all "sortable" active columns. $sortablecolumns = array_filter($report->get_active_columns(), function(column $column): bool { return $column->get_is_sortable(); }); $sortablecolumns = array_map(function(column $column) use ($report): array { $persistent = $column->get_persistent(); $columntitle = $column->get_title(); $columnheading = $persistent->get_formatted_heading($report->get_context()); $sortenabledtitle = $persistent->get('sortenabled') ? 'columnsortdisable' : 'columnsortenable'; // The icon should reflect the current sort order, with prompt to invert the order. if ($persistent->get('sortdirection') === SORT_ASC) { $sorticon = 't/sort_asc'; $sorticonstr = 'columnsortdirectiondesc'; } else { $sorticon = 't/sort_desc'; $sorticonstr = 'columnsortdirectionasc'; } return [ 'id' => $persistent->get('id'), 'title' => $columntitle, 'heading' => $columnheading !== '' ? $columnheading : $columntitle, 'sortdirection' => $persistent->get('sortdirection'), 'sortenabled' => $persistent->get('sortenabled'), 'sortorder' => $persistent->get('sortorder'), 'sorticon' => (new pix_icon($sorticon, get_string($sorticonstr, 'core_reportbuilder', $columntitle))) ->export_for_pix(), 'movetitle' => get_string('movesorting', 'core_reportbuilder', $columntitle), 'sortenabledtitle' => get_string($sortenabledtitle, 'core_reportbuilder', $columntitle), ]; }, $sortablecolumns); core_collator::asort_array_of_arrays_by_key($sortablecolumns, 'sortorder', core_collator::SORT_NUMERIC); return [ 'hassortablecolumns' => !empty($sortablecolumns), 'sortablecolumns' => array_values($sortablecolumns), 'helpicon' => $output->help_icon('sorting', 'core_reportbuilder'), ]; } } PK a<�\UzG+ G+ classes/system_report.phpnu �[��� <?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; use action_menu_filler; use coding_exception; use core_reportbuilder\exception\report_access_exception; use html_writer; use stdClass; use core\output\checkbox_toggleall; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\action; use core_reportbuilder\local\report\base; use core_reportbuilder\local\report\column; /** * Base class for system reports * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class system_report extends base { /** @var array $parameters */ private $parameters; /** @var string[] $basefields List of base fields */ private $basefields = []; /** @var callable $checkboxcallback */ private $checkboxcallback = null; /** @var bool $filterformdefault Whether to use the default filters form */ private $filterformdefault = true; /** @var action|action_menu_filler[] $actions */ private $actions = []; /** @var column $initialsortcolumn */ private $initialsortcolumn; /** @var int $initialsortdirection */ private $initialsortdirection; /** * System report constructor. * * @param report $report * @param array $parameters */ final public function __construct(report $report, array $parameters) { $this->parameters = $parameters; parent::__construct($report); } /** * Provide default implementation of the report name. Extending classes can implement this method to provide their own name * * @return string */ public static function get_name(): string { $classparts = explode('\\', get_called_class()); $classname = end($classparts); // Try to make human readable, capitalized and with spaces. return ucfirst(str_replace('_', ' ', $classname)); } /** * Validates access to view this report * * This is necessary to implement independently of the page that would typically embed the report because * subsequent pages are requested via AJAX requests, and access should be validated each time * * Report parameters should also be considered when implementing this method * * @return bool */ abstract protected function can_view(): bool; /** * Validate access to the report * * @throws report_access_exception */ final public function require_can_view(): void { if (!$this->can_view()) { throw new report_access_exception(); } } /** * Report validation * * @throws report_access_exception If user cannot access the report * @throws coding_exception If no default column are specified */ protected function validate(): void { parent::validate(); $this->require_can_view(); // Ensure the report has some default columns specified. if (empty($this->get_columns())) { throw new coding_exception('No columns added'); } } /** * Add list of fields that have to be always included in SQL query for actions and row classes * * @param string $sql SQL clause for the list of fields that only uses main table or base joins */ final protected function add_base_fields(string $sql): void { $this->basefields[] = $sql; } /** * Return report base fields * * @return array */ final public function get_base_fields(): array { return $this->basefields; } /** * Define toggle all checkbox for the report, required row data should be defined by calling {@see add_base_fields} * * @param callable $callback Callback to return value/label for each checkbox, implementing the following signature: * function(stdClass $row): ?array containing value/label pair, or null if the checkbox should not be shown for the row */ final protected function set_checkbox_toggleall(callable $callback): void { $this->checkboxcallback = $callback; } /** * Return instance of toggle all checkbox, if previously defined by {@see set_checkbox_toggleall} * * @param bool $ismaster * @param stdClass|null $row * @return checkbox_toggleall|null */ final public function get_checkbox_toggleall(bool $ismaster, ?stdClass $row = null): ?checkbox_toggleall { if (!is_callable($this->checkboxcallback)) { return null; } // Generic content for the master checkbox, execute callback for those belonging to each row. if ($ismaster) { $value = ''; $label = get_string('selectall'); } else { $checkboxdata = ($this->checkboxcallback)($row); if ($checkboxdata === null) { return null; } [$value, $label] = $checkboxdata; } return new checkbox_toggleall('report-select-all', $ismaster, [ 'id' => html_writer::random_id(), 'name' => 'report-select-row[]', 'value' => $value, 'label' => $label, 'labelclasses' => 'accesshide', ]); } /** * Override whether to use the default system report filters form, for instance this can be disabled if the UI requires * it's own custom filter management form for a specific report * * @param bool $filterformdefault */ final public function set_filter_form_default(bool $filterformdefault = true): void { $this->filterformdefault = $filterformdefault; } /** * Whether to use the default filters form * * @return bool */ final public function get_filter_form_default(): bool { return $this->filterformdefault; } /** * Adds an action to the report * * @param action $action */ final public function add_action(action $action): void { $this->actions[] = $action; } /** * Adds action divider to the report * */ final public function add_action_divider(): void { $divider = new action_menu_filler(); // We need to set as not primary action because we just need add an action divider, not a new action item. $divider->primary = false; $this->actions[] = $divider; } /** * Whether report has any actions * * @return bool */ final public function has_actions(): bool { return !empty($this->actions); } /** * Return report actions * * @return action|action_menu_filler[] */ final public function get_actions(): array { return $this->actions; } /** * Set all report parameters * * @param array $parameters */ final public function set_parameters(array $parameters): void { $this->parameters = $parameters; } /** * Return all report parameters * * @return array */ final public function get_parameters(): array { return $this->parameters; } /** * Return specific report parameter * * Capability/permission checks relating to parameters retrieved here should also be considered in your {@see can_view} method * * @param string $param * @param mixed $default * @param string $type * @return mixed */ final public function get_parameter(string $param, $default, string $type) { if (!array_key_exists($param, $this->parameters)) { return $default; } return clean_param($this->parameters[$param], $type); } /** * Output the report * * @uses \core_reportbuilder\output\renderer::render_system_report() * * @return string */ final public function output(): string { global $PAGE; /** @var \core_reportbuilder\output\renderer $renderer */ $renderer = $PAGE->get_renderer('core_reportbuilder'); $report = new \core_reportbuilder\output\system_report($this->get_report_persistent(), $this, $this->parameters); return $renderer->render($report); } /** * CSS classes to add to the row. Can be overridden by system reports do define class to be added to output according to * content of each row * * @param stdClass $row * @return string */ public function get_row_class(stdClass $row): string { return ''; } /** * Called before rendering each row. Can be overridden to pre-fetch/create objects and store them in the class, which can * later be used in column and action callbacks * * @param stdClass $row */ public function row_callback(stdClass $row): void { return; } /** * Validates access to download this report. * * @return bool */ final public function can_be_downloaded(): bool { return $this->can_view() && $this->is_downloadable(); } /** * Return list of column names that will be excluded when table is downloaded. Extending classes should override this method * as appropriate * * @return string[] Array of column unique identifiers */ public function get_exclude_columns_for_download(): array { return []; } /** * Set initial sort column and sort direction for the report * * @param string $uniqueidentifier * @param int $sortdirection One of SORT_ASC or SORT_DESC * @throws coding_exception */ public function set_initial_sort_column(string $uniqueidentifier, int $sortdirection): void { if (!$sortcolumn = $this->get_column($uniqueidentifier)) { throw new coding_exception('Unknown column identifier', $uniqueidentifier); } $this->initialsortcolumn = $sortcolumn; $this->initialsortdirection = $sortdirection; } /** * Get initial sort column * * @return column|null */ public function get_initial_sort_column(): ?column { return $this->initialsortcolumn; } /** * Get initial sort column direction * * @return int */ public function get_initial_sort_direction(): int { return $this->initialsortdirection; } } PK a<�\�6{� � ) classes/output/schedule_name_editable.phpnu �[��� <?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\output; use core\output\inplace_editable; use core_external\external_api; use core_reportbuilder\permission; use core_reportbuilder\local\models\schedule; /** * Schedule name editable component * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class schedule_name_editable extends inplace_editable { /** * Class constructor * * @param int $scheduleid * @param schedule|null $schedule */ public function __construct(int $scheduleid, ?schedule $schedule = null) { if ($schedule === null) { $schedule = new schedule($scheduleid); } $report = $schedule->get_report(); $editable = permission::can_edit_report($report); $displayvalue = $schedule->get_formatted_name($report->get_context()); parent::__construct('core_reportbuilder', 'schedulename', $schedule->get('id'), $editable, $displayvalue, $schedule->get('name'), get_string('editschedulename', 'core_reportbuilder')); } /** * Update schedule persistent and return self, called from inplace_editable callback * * @param int $scheduleid * @param string $value * @return self */ public static function update(int $scheduleid, string $value): self { $schedule = new schedule($scheduleid); $report = $schedule->get_report(); external_api::validate_context($report->get_context()); permission::require_can_edit_report($report); $value = trim(clean_param($value, PARAM_TEXT)); if ($value !== '') { $schedule ->set('name', $value) ->update(); } return new self(0, $schedule); } } PK a<�\ꋧ�� � classes/output/system_report.phpnu �[��� <?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\output; use renderable; use renderer_base; use stdClass; use templatable; use core_reportbuilder\system_report as system_report_base; use core_reportbuilder\external\system_report_exporter; use core_reportbuilder\local\models\report; /** * System report output class * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report implements renderable, templatable { /** @var report $report */ protected $report; /** @var system_report_base $source */ protected $source; /** @var array $parameters */ protected $parameters; /** * Class constructor * * @param report $report * @param system_report_base $source * @param array $parameters */ public function __construct(report $report, system_report_base $source, array $parameters) { $this->report = $report; $this->source = $source; $this->parameters = $parameters; } /** * Export report data suitable for a template * * @param renderer_base $output * @return stdClass */ public function export_for_template(renderer_base $output): stdClass { $exporter = new system_report_exporter($this->report, [ 'source' => $this->source, 'parameters' => json_encode($this->parameters), ]); return $exporter->export($output); } } PK a<�\�,�u� � classes/output/renderer.phpnu �[��� <?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\output; use html_writer; use moodle_url; use plugin_renderer_base; use core_reportbuilder\table\custom_report_table; use core_reportbuilder\table\custom_report_table_view; use core_reportbuilder\table\system_report_table; use core_reportbuilder\local\models\report; /** * Report renderer class * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class renderer extends plugin_renderer_base { /** * Render a system report * * @param system_report $report * @return string */ protected function render_system_report(system_report $report): string { $context = $report->export_for_template($this); return $this->render_from_template('core_reportbuilder/report', $context); } /** * Render a system report table * * @param system_report_table $table * @return string */ protected function render_system_report_table(system_report_table $table): string { ob_start(); $table->out($table->get_default_per_page(), false); $output = ob_get_contents(); ob_end_clean(); return $output; } /** * Render a custom report * * @param custom_report $report * @return string */ protected function render_custom_report(custom_report $report): string { $context = $report->export_for_template($this); return $this->render_from_template('core_reportbuilder/local/dynamictabs/editor', $context); } /** * Render a custom report table * * @param custom_report_table $table * @return string */ protected function render_custom_report_table(custom_report_table $table): string { ob_start(); $table->out($table->get_default_per_page(), false); $output = ob_get_contents(); ob_end_clean(); return $output; } /** * Render a custom report table (view only mode) * * @param custom_report_table_view $table * @return string */ protected function render_custom_report_table_view(custom_report_table_view $table): string { ob_start(); $table->out($table->get_default_per_page(), false); $output = ob_get_contents(); ob_end_clean(); return $output; } /** * Renders the New report button * * @return string */ public function render_new_report_button(): string { return html_writer::tag('button', get_string('newreport', 'core_reportbuilder'), [ 'class' => 'btn btn-primary my-auto', 'data-action' => 'report-create', ]); } /** * Renders full page editor header * * @param report $report * @return string */ public function render_fullpage_editor_header(report $report): string { $reportname = $report->get_formatted_name(); $editdetailsbutton = html_writer::tag('button', get_string('editdetails', 'core_reportbuilder'), [ 'class' => 'btn btn-outline-secondary me-2', 'data-action' => 'report-edit', 'data-report-id' => $report->get('id') ]); $closebutton = html_writer::link(new moodle_url('/reportbuilder/index.php'), get_string('close', 'core_reportbuilder'), [ 'class' => 'btn btn-secondary', 'title' => get_string('closeeditor', 'core_reportbuilder', $reportname), 'role' => 'button' ]); $context = [ 'title' => $reportname, 'buttons' => $editdetailsbutton . $closebutton, ]; return $this->render_from_template('core_reportbuilder/editor_navbar', $context); } } PK a<�\)���4 4 * classes/output/column_heading_editable.phpnu �[��� <?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\output; use core\output\inplace_editable; use core_external\external_api; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\models\column; /** * Column heading editable component * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class column_heading_editable extends inplace_editable { /** * Class constructor * * @param int $columnid * @param column|null $column */ public function __construct(int $columnid, ?column $column = null) { if ($column === null) { $column = new column($columnid); } $report = $column->get_report(); $editable = permission::can_edit_report($report); $columninstance = manager::get_report_from_persistent($report) ->get_column($column->get('uniqueidentifier')); // Use column defined title if custom heading not set. if ('' !== $value = (string) $column->get('heading')) { $displayvalue = $column->get_formatted_heading($report->get_context()); } else { $displayvalue = $value = $columninstance->get_title(); } parent::__construct('core_reportbuilder', 'columnheading', $column->get('id'), $editable, $displayvalue, $value, get_string('renamecolumn', 'core_reportbuilder', $columninstance->get_title())); } /** * Update column persistent and return self, called from inplace_editable callback * * @param int $columnid * @param string $value * @return self */ public static function update(int $columnid, string $value): self { $column = new column($columnid); $report = $column->get_report(); external_api::validate_context($report->get_context()); permission::require_can_edit_report($report); $value = clean_param($value, PARAM_TEXT); $column ->set('heading', trim($value)) ->update(); return new self(0, $column); } } PK a<�\�}]�; ; , classes/output/audience_heading_editable.phpnu �[��� <?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\output; use core\output\inplace_editable; use core_external\external_api; use core_reportbuilder\permission; use core_reportbuilder\local\audiences\base; use core_reportbuilder\local\models\audience; /** * Audience heading editable component * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class audience_heading_editable extends inplace_editable { /** * Class constructor * * @param int $audienceid * @param audience|null $audience */ public function __construct(int $audienceid, ?audience $audience = null) { if ($audience === null) { $audience = new audience($audienceid); } $report = $audience->get_report(); $editable = permission::can_edit_report($report); $audienceinstance = base::instance(0, $audience->to_record()); // Use audience defined title if custom heading not set. if ('' !== $value = (string) $audience->get('heading')) { $displayvalue = $audience->get_formatted_heading($report->get_context()); } else { $displayvalue = $value = $audienceinstance->get_name(); } parent::__construct('core_reportbuilder', 'audienceheading', $audience->get('id'), $editable, $displayvalue, $value, get_string('renameaudience', 'core_reportbuilder', $audienceinstance->get_name())); } /** * Update audience persistent and return self, called from inplace_editable callback * * @param int $audienceid * @param string $value * @return self */ public static function update(int $audienceid, string $value): self { $audience = new audience($audienceid); $report = $audience->get_report(); external_api::validate_context($report->get_context()); permission::require_can_edit_report($report); $value = clean_param($value, PARAM_TEXT); $audience ->set('heading', $value) ->update(); return new self(0, $audience); } } PK a<�\.d�v. . ' classes/output/report_name_editable.phpnu �[��� <?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\output; use html_writer; use moodle_url; use core\output\inplace_editable; use core_external\external_api; use core_reportbuilder\permission; use core_reportbuilder\local\models\report; /** * Report name editable component * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report_name_editable extends inplace_editable { /** * Class constructor * * @param int $reportid * @param report|null $report The report persistent, note that in addition to id/name properties being present we also * require the following to be correctly set in order to perform permission checks: contextid/type/usercreated */ public function __construct(int $reportid, ?report $report = null) { if ($report === null) { $report = new report($reportid); } $editable = permission::can_edit_report($report); $url = $editable ? new moodle_url('/reportbuilder/edit.php', ['id' => $report->get('id')]) : new moodle_url('/reportbuilder/view.php', ['id' => $report->get('id')]); $displayvalue = html_writer::link($url, $report->get_formatted_name()); parent::__construct('core_reportbuilder', 'reportname', $report->get('id'), $editable, $displayvalue, $report->get('name'), get_string('editreportname', 'core_reportbuilder')); } /** * Update report persistent and return self, called from inplace_editable callback * * @param int $reportid * @param string $value * @return self */ public static function update(int $reportid, string $value): self { $report = new report($reportid); external_api::validate_context($report->get_context()); permission::require_can_edit_report($report); $value = trim(clean_param($value, PARAM_TEXT)); if ($value !== '') { $report ->set('name', $value) ->update(); } return new self(0, $report); } } PK a<�\�}b�� � classes/output/custom_report.phpnu �[��� <?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\output; use core_reportbuilder\manager; use core_reportbuilder\external\custom_report_exporter; use core_reportbuilder\local\models\report; use renderable; use renderer_base; use stdClass; use templatable; /** * Custom report output class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report implements renderable, templatable { /** @var report $reportpersistent */ protected $persistent; /** @var bool $editmode */ protected $editmode; /** @var string $download */ protected $download; /** * Class constructor * * @param report $reportpersistent * @param bool $editmode * @param string $download */ public function __construct(report $reportpersistent, bool $editmode = true, string $download = '') { $this->persistent = $reportpersistent; $this->editmode = $editmode; $this->download = $download; } /** * Export report data suitable for a template * * @param renderer_base $output * @return stdClass */ public function export_for_template(renderer_base $output): stdClass { $report = manager::get_report_from_persistent($this->persistent); $exporter = new custom_report_exporter($this->persistent, [ 'pagesize' => $report->get_default_per_page(), ], $this->editmode, $this->download); return $exporter->export($output); } } PK a<�\\ qE . classes/output/column_aggregation_editable.phpnu �[��� <?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\output; use core\output\inplace_editable; use core_external\external_api; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\aggregation; use core_reportbuilder\local\models\column; /** * Column aggregation editable component * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class column_aggregation_editable extends inplace_editable { /** * Class constructor * * @param int $columnid * @param column|null $column */ public function __construct(int $columnid, ?column $column = null) { if ($column === null) { $column = new column($columnid); } $report = $column->get_report(); $editable = permission::can_edit_report($report); $columninstance = manager::get_report_from_persistent($report) ->get_column($column->get('uniqueidentifier')); $currentvalue = (string) $column->get('aggregation'); $editlabel = get_string('aggregatecolumn', 'core_reportbuilder', $columninstance->get_title()); parent::__construct('core_reportbuilder', 'columnaggregation', $column->get('id'), $editable, null, $currentvalue, $editlabel, $editlabel); // List of available aggregation methods for the column type, minus any specifically disabled. $options = aggregation::get_column_aggregations($columninstance->get_type(), $columninstance->get_disabled_aggregation()); $this->set_type_select(['' => get_string('aggregationnone', 'core_reportbuilder')] + $options); } /** * Update column persistent and return self, called from inplace_editable callback * * @param int $columnid * @param string $value * @return self */ public static function update(int $columnid, string $value): self { $column = new column($columnid); $report = $column->get_report(); external_api::validate_context($report->get_context()); permission::require_can_edit_report($report); $value = clean_param($value, PARAM_TEXT); $column ->set('aggregation', $value) ->update(); return new self(0, $column); } } PK a<�\�G�O= = * classes/output/filter_heading_editable.phpnu �[��� <?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\output; use core\output\inplace_editable; use core_external\external_api; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\models\filter; /** * Filter heading editable component * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class filter_heading_editable extends inplace_editable { /** * Class constructor * * @param int $filterid * @param filter|null $filter */ public function __construct(int $filterid, ?filter $filter = null) { if ($filter === null) { $filter = new filter($filterid); } $report = $filter->get_report(); $editable = permission::can_edit_report($report); $filterinstance = manager::get_report_from_persistent($report) ->get_filter($filter->get('uniqueidentifier')); // Use filter defined header if custom heading not set. if ('' !== $value = (string) $filter->get('heading')) { $displayvalue = $filter->get_formatted_heading($report->get_context()); } else { $displayvalue = $value = $filterinstance->get_header(); } parent::__construct('core_reportbuilder', 'filterheading', $filter->get('id'), $editable, $displayvalue, $value, get_string('renamefilter', 'core_reportbuilder', $filterinstance->get_header())); } /** * Update filter persistent and return self, called from inplace_editable callback * * @param int $filterid * @param string $value * @return self */ public static function update(int $filterid, string $value): self { $filter = new filter($filterid); $report = $filter->get_report(); external_api::validate_context($report->get_context()); permission::require_can_edit_report($report); $value = clean_param($value, PARAM_TEXT); $filter ->set('heading', trim($value)) ->update(); return new self(0, $filter); } } PK a<�\�M�'l l ( classes/output/dynamictabs/schedules.phpnu �[��� <?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\output\dynamictabs; use context_system; use renderer_base; use core\output\dynamic_tabs\base; use core_reportbuilder\permission; use core_reportbuilder\system_report_factory; use core_reportbuilder\local\models\report; use core_reportbuilder\local\systemreports\report_schedules; /** * Schedules dynamic tab * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class schedules extends base { /** * Export this for use in a mustache template context * * @param renderer_base $output * @return array */ public function export_for_template(renderer_base $output): array { $report = system_report_factory::create(report_schedules::class, context_system::instance(), '', '', 0, ['reportid' => $this->data['reportid']]); return [ 'reportid' => $this->data['reportid'], 'report' => $report->output(), ]; } /** * The label to be displayed on the tab * * @return string */ public function get_tab_label(): string { return get_string('schedules', 'core_reportbuilder'); } /** * Check permission of the current user to access this tab * * @return bool */ public function is_available(): bool { return permission::can_edit_report(new report($this->data['reportid'])); } /** * Template to use to display tab contents * * @return string */ public function get_template(): string { return 'core_reportbuilder/local/dynamictabs/schedules'; } } PK a<�\�]0� � ' classes/output/dynamictabs/audience.phpnu �[��� <?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\output\dynamictabs; use core\output\dynamic_tabs\base; use core_reportbuilder\external\custom_report_audience_cards_exporter; use core_reportbuilder\local\helpers\audience as audience_helper; use core_reportbuilder\local\models\report; use core_reportbuilder\output\audience_heading_editable; use core_reportbuilder\permission; use renderer_base; /** * Audience dynamic tab * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class audience extends base { /** * Export this for use in a mustache template context. * * @param renderer_base $output * @return array */ public function export_for_template(renderer_base $output): array { $reportid = (int) $this->data['reportid']; // Get all the audiences types to populate the left menu. $menucardsexporter = new custom_report_audience_cards_exporter(null); $menucards = (array) $menucardsexporter->export($output); // Get all current audiences instances for this report. $audienceinstances = $this->get_all_report_audiences($reportid); return [ 'tabheading' => get_string('audience', 'core_reportbuilder'), 'reportid' => $reportid, 'contextid' => (new report($reportid))->get('contextid'), 'sidebarmenucards' => $menucards, 'instances' => $audienceinstances, 'hasinstances' => !empty($audienceinstances), ]; } /** * The label to be displayed on the tab * * @return string */ public function get_tab_label(): string { return get_string('audience', 'core_reportbuilder'); } /** * Check permission of the current user to access this tab * * @return bool */ public function is_available(): bool { $reportpersistent = new report((int)$this->data['reportid']); return permission::can_edit_report($reportpersistent); } /** * Template to use to display tab contents * * @return string */ public function get_template(): string { return 'core_reportbuilder/local/dynamictabs/audience'; } /** * Get all current audiences instances for this report. * * @param int $reportid * @return array */ private function get_all_report_audiences(int $reportid): array { global $PAGE; $renderer = $PAGE->get_renderer('core'); $audienceinstances = []; $showormessage = false; // Retrieve list of audiences that are used in report schedules, to warn user when editing. $scheduleaudiences = audience_helper::get_audiences_for_report_schedules($reportid); $reportaudiences = audience_helper::get_base_records($reportid); foreach ($reportaudiences as $reportaudience) { $persistent = $reportaudience->get_persistent(); $canedit = $reportaudience->user_can_edit(); $editable = new audience_heading_editable(0, $persistent); $audienceinstances[] = [ 'instanceid' => $persistent->get('id'), 'description' => $reportaudience->get_description(), 'heading' => $reportaudience->get_name(), 'headingeditable' => $editable->render($renderer), 'editwarning' => in_array($persistent->get('id'), $scheduleaudiences) ? get_string('audienceusedbyschedule', 'core_reportbuilder') : '', 'canedit' => $canedit, 'candelete' => $canedit, 'showormessage' => $showormessage, ]; $showormessage = true; } return $audienceinstances; } } PK a<�\4 �aa a % classes/output/dynamictabs/access.phpnu �[��� <?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\output\dynamictabs; use context_system; use core\output\dynamic_tabs\base; use core_reportbuilder\local\models\report; use core_reportbuilder\local\systemreports\report_access_list; use core_reportbuilder\permission; use core_reportbuilder\system_report_factory; use renderer_base; /** * Access dynamic tab * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class access extends base { /** * Export this for use in a mustache template context. * * @param renderer_base $output * @return array */ public function export_for_template(renderer_base $output): array { $report = system_report_factory::create(report_access_list::class, context_system::instance(), '', '', 0, ['id' => $this->data['reportid']]); $data['report'] = $report->output(); return $data; } /** * The label to be displayed on the tab * * @return string */ public function get_tab_label(): string { return get_string('access', 'core_reportbuilder'); } /** * Check permission of the current user to access this tab * * @return bool */ public function is_available(): bool { $reportpersistent = new report((int)$this->data['reportid']); return permission::can_edit_report($reportpersistent); } /** * Template to use to display tab contents * * @return string */ public function get_template(): string { return 'core_reportbuilder/local/dynamictabs/access'; } } PK a<�\c���h h % classes/output/dynamictabs/editor.phpnu �[��� <?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\output\dynamictabs; use core\output\dynamic_tabs\base; use core_reportbuilder\local\models\report; use core_reportbuilder\output\custom_report; use core_reportbuilder\permission; use renderer_base; use stdClass; /** * Editor dynamic tab * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class editor extends base { /** * Export this for use in a mustache template context. * * @param renderer_base $output * @return stdClass */ public function export_for_template(renderer_base $output) { global $PAGE; /** @var \core_reportbuilder\output\renderer $renderer */ $renderer = $PAGE->get_renderer('core_reportbuilder'); $reportpersistent = new report((int)$this->data['reportid']); return (new custom_report($reportpersistent))->export_for_template($renderer); } /** * The label to be displayed on the tab * * @return string */ public function get_tab_label(): string { return get_string('editor', 'core_reportbuilder'); } /** * Check permission of the current user to access this tab * * @return bool */ public function is_available(): bool { $reportpersistent = new report((int)$this->data['reportid']); return permission::can_edit_report($reportpersistent); } /** * Template to use to display tab contents * * @return string */ public function get_template(): string { return 'core_reportbuilder/local/dynamictabs/editor'; } } PK a<�\+-�8> 8> classes/privacy/provider.phpnu �[��� <?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\privacy; use context; use stdClass; use core_privacy\local\metadata\collection; use core_privacy\local\request\approved_contextlist; use core_privacy\local\request\approved_userlist; use core_privacy\local\request\contextlist; use core_privacy\local\request\core_userlist_provider; use core_privacy\local\request\transform; use core_privacy\local\request\userlist; use core_privacy\local\request\user_preference_provider; use core_privacy\local\request\writer; use core_reportbuilder\manager; use core_reportbuilder\local\helpers\user_filter_manager; use core_reportbuilder\local\helpers\schedule as schedule_helper; use core_reportbuilder\local\models\audience; use core_reportbuilder\local\models\column; use core_reportbuilder\local\models\filter; use core_reportbuilder\local\models\report; use core_reportbuilder\local\models\schedule; /** * Privacy Subsystem for core_reportbuilder * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class provider implements \core_privacy\local\metadata\provider, \core_privacy\local\request\plugin\provider, core_userlist_provider, user_preference_provider { /** * Returns metadata about the component * * @param collection $collection * @return collection */ public static function get_metadata(collection $collection): collection { $collection->add_database_table(report::TABLE, [ 'name' => 'privacy:metadata:report:name', 'source' => 'privacy:metadata:report:source', 'conditiondata' => 'privacy:metadata:report:conditiondata', 'settingsdata' => 'privacy:metadata:report:settingsdata', 'uniquerows' => 'privacy:metadata:report:uniquerows', 'usercreated' => 'privacy:metadata:report:usercreated', 'usermodified' => 'privacy:metadata:report:usermodified', 'timecreated' => 'privacy:metadata:report:timecreated', 'timemodified' => 'privacy:metadata:report:timemodified', ], 'privacy:metadata:report'); $collection->add_database_table(column::TABLE, [ 'uniqueidentifier' => 'privacy:metadata:column:uniqueidentifier', 'usercreated' => 'privacy:metadata:column:usercreated', 'usermodified' => 'privacy:metadata:column:usermodified', ], 'privacy:metadata:column'); $collection->add_database_table(filter::TABLE, [ 'uniqueidentifier' => 'privacy:metadata:filter:uniqueidentifier', 'usercreated' => 'privacy:metadata:filter:usercreated', 'usermodified' => 'privacy:metadata:filter:usermodified', ], 'privacy:metadata:filter'); $collection->add_database_table(audience::TABLE, [ 'classname' => 'privacy:metadata:audience:classname', 'configdata' => 'privacy:metadata:audience:configdata', 'heading' => 'privacy:metadata:audience:heading', 'usercreated' => 'privacy:metadata:audience:usercreated', 'usermodified' => 'privacy:metadata:audience:usermodified', 'timecreated' => 'privacy:metadata:audience:timecreated', 'timemodified' => 'privacy:metadata:audience:timemodified', ], 'privacy:metadata:audience'); $collection->add_database_table(schedule::TABLE, [ 'name' => 'privacy:metadata:schedule:name', 'enabled' => 'privacy:metadata:schedule:enabled', 'audiences' => 'privacy:metadata:schedule:audiences', 'format' => 'privacy:metadata:schedule:format', 'subject' => 'privacy:metadata:schedule:subject', 'message' => 'privacy:metadata:schedule:message', 'userviewas' => 'privacy:metadata:schedule:userviewas', 'timescheduled' => 'privacy:metadata:schedule:timescheduled', 'recurrence' => 'privacy:metadata:schedule:recurrence', 'reportempty' => 'privacy:metadata:schedule:reportempty', 'usercreated' => 'privacy:metadata:schedule:usercreated', 'usermodified' => 'privacy:metadata:schedule:usermodified', 'timecreated' => 'privacy:metadata:schedule:timecreated', 'timemodified' => 'privacy:metadata:schedule:timemodified', ], 'privacy:metadata:schedule'); $collection->add_user_preference('core_reportbuilder', 'privacy:metadata:preference:reportfilter'); return $collection; } /** * Export all user preferences for the component * * @param int $userid */ public static function export_user_preferences(int $userid): void { $preferencestring = get_string('privacy:metadata:preference:reportfilter', 'core_reportbuilder'); $filters = user_filter_manager::get_all_for_user($userid); foreach ($filters as $key => $filter) { writer::export_user_preference('core_reportbuilder', $key, json_encode($filter, JSON_PRETTY_PRINT), $preferencestring ); } } /** * Get export sub context for a report * * @param report $report * @return array */ public static function get_export_subcontext(report $report): array { $reportnode = implode('-', [ $report->get('id'), clean_filename($report->get_formatted_name()), ]); return [get_string('reportbuilder', 'core_reportbuilder'), $reportnode]; } /** * Get the list of contexts that contain user information for the specified user * * @param int $userid * @return contextlist */ public static function get_contexts_for_userid(int $userid): contextlist { $contextlist = new contextlist(); // Locate all contexts for reports the user has created, or reports they have created audience/schedules for. $sql = ' SELECT r.contextid FROM {' . report::TABLE . '} r WHERE r.type = 0 AND (r.usercreated = ? OR r.usermodified = ? OR r.id IN ( SELECT a.reportid FROM {' . audience::TABLE . '} a WHERE a.usercreated = ? OR a.usermodified = ? UNION SELECT s.reportid FROM {' . schedule::TABLE . '} s WHERE s.usercreated = ? OR s.usermodified = ? ) )'; return $contextlist->add_from_sql($sql, array_fill(0, 6, $userid)); } /** * Get users in context * * @param userlist $userlist */ public static function get_users_in_context(userlist $userlist): void { $select = 'r.type = :type AND r.contextid = :contextid'; $params = ['type' => 0, 'contextid' => $userlist->get_context()->id]; // Users who have created reports. $sql = 'SELECT r.usercreated, r.usermodified FROM {' . report::TABLE . '} r WHERE ' . $select; $userlist->add_from_sql('usercreated', $sql, $params); $userlist->add_from_sql('usermodified', $sql, $params); // Users who have created audiences. $sql = 'SELECT a.usercreated, a.usermodified FROM {' . audience::TABLE . '} a JOIN {' . report::TABLE . '} r ON r.id = a.reportid WHERE ' . $select; $userlist->add_from_sql('usercreated', $sql, $params); $userlist->add_from_sql('usermodified', $sql, $params); // Users who have created schedules. $sql = 'SELECT s.usercreated, s.usermodified FROM {' . schedule::TABLE . '} s JOIN {' . report::TABLE . '} r ON r.id = s.reportid WHERE ' . $select; $userlist->add_from_sql('usercreated', $sql, $params); $userlist->add_from_sql('usermodified', $sql, $params); } /** * Export all user data for the specified user in the specified contexts * * @param approved_contextlist $contextlist */ public static function export_user_data(approved_contextlist $contextlist): void { if (empty($contextlist->count())) { return; } $user = $contextlist->get_user(); // We need to get all reports that the user has created, or reports they have created audience/schedules for. $select = 'type = 0 AND (usercreated = ? OR usermodified = ? OR id IN ( SELECT a.reportid FROM {' . audience::TABLE . '} a WHERE a.usercreated = ? OR a.usermodified = ? UNION SELECT s.reportid FROM {' . schedule::TABLE . '} s WHERE s.usercreated = ? OR s.usermodified = ? ))'; $params = array_fill(0, 6, $user->id); foreach (report::get_records_select($select, $params) as $report) { $subcontext = static::get_export_subcontext($report); self::export_report($subcontext, $report); $select = 'reportid = ? AND (usercreated = ? OR usermodified = ?)'; $params = [$report->get('id'), $user->id, $user->id]; // Audiences. if ($audiences = audience::get_records_select($select, $params)) { static::export_audiences($report->get_context(), $subcontext, $audiences); } // Schedules. if ($schedules = schedule::get_records_select($select, $params)) { static::export_schedules($report->get_context(), $subcontext, $schedules); } } } /** * Delete data for all users in context * * @param context $context */ public static function delete_data_for_all_users_in_context(context $context): void { // We don't perform any deletion of user data. } /** * Delete data for user * * @param approved_contextlist $contextlist */ public static function delete_data_for_user(approved_contextlist $contextlist): void { // We don't perform any deletion of user data. } /** * Delete data for users * * @param approved_userlist $userlist */ public static function delete_data_for_users(approved_userlist $userlist): void { // We don't perform any deletion of user data. } /** * Export given report in context * * @param array $subcontext * @param report $report */ protected static function export_report(array $subcontext, report $report): void { // Show the source name, if it exists. $source = $report->get('source'); if (manager::report_source_exists($source)) { $source = call_user_func([$source, 'get_name']); } $reportdata = (object) [ 'name' => $report->get_formatted_name(), 'source' => $source, 'conditiondata' => $report->get('conditiondata'), 'settingsdata' => $report->get('settingsdata'), 'uniquerows' => transform::yesno($report->get('uniquerows')), 'usercreated' => transform::user($report->get('usercreated')), 'usermodified' => transform::user($report->get('usermodified')), 'timecreated' => transform::datetime($report->get('timecreated')), 'timemodified' => transform::datetime($report->get('timemodified')), ]; writer::with_context($report->get_context())->export_data($subcontext, $reportdata); } /** * Export given audiences in context * * @param context $context * @param array $subcontext * @param audience[] $audiences */ protected static function export_audiences(context $context, array $subcontext, array $audiences): void { $audiencedata = array_map(static function(audience $audience) use ($context): stdClass { // Show the audience name, if it exists. $classname = $audience->get('classname'); if (class_exists($classname)) { $classname = $classname::instance()->get_name(); } return (object) [ 'classname' => $classname, 'heading' => $audience->get_formatted_heading($context), 'configdata' => $audience->get('configdata'), 'usercreated' => transform::user($audience->get('usercreated')), 'usermodified' => transform::user($audience->get('usermodified')), 'timecreated' => transform::datetime($audience->get('timecreated')), 'timemodified' => transform::datetime($audience->get('timemodified')), ]; }, $audiences); writer::with_context($context)->export_related_data($subcontext, 'audiences', (object) ['data' => $audiencedata]); } /** * Export given schedules in context * * @param context $context * @param array $subcontext * @param schedule[] $schedules */ protected static function export_schedules(context $context, array $subcontext, array $schedules): void { $formatoptions = schedule_helper::get_format_options(); $recurrenceoptions = schedule_helper::get_recurrence_options(); $viewasoptions = schedule_helper::get_viewas_options(); $reportemptyoptions = schedule_helper::get_report_empty_options(); $scheduledata = array_map(static function(schedule $schedule) use ( $context, $formatoptions, $recurrenceoptions, $viewasoptions, $reportemptyoptions): stdClass { // The "User view as" property will be either creator, recipient or a specific userid. $userviewas = $schedule->get('userviewas'); return (object) [ 'name' => $schedule->get_formatted_name($context), 'enabled' => transform::yesno($schedule->get('enabled')), 'format' => $formatoptions[$schedule->get('format')], 'timescheduled' => transform::datetime($schedule->get('timescheduled')), 'recurrence' => $recurrenceoptions[$schedule->get('recurrence')], 'userviewas' => $viewasoptions[$userviewas] ?? transform::user($userviewas), 'audiences' => $schedule->get('audiences'), 'subject' => $schedule->get('subject'), 'message' => format_text($schedule->get('message'), $schedule->get('messageformat'), ['context' => $context]), 'reportempty' => $reportemptyoptions[$schedule->get('reportempty')], 'usercreated' => transform::user($schedule->get('usercreated')), 'usermodified' => transform::user($schedule->get('usermodified')), 'timecreated' => transform::datetime($schedule->get('timecreated')), 'timemodified' => transform::datetime($schedule->get('timemodified')), ]; }, $schedules); writer::with_context($context)->export_related_data($subcontext, 'schedules', (object) ['data' => $scheduledata]); } } PK a<�\�� " classes/event/audience_updated.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\audience; use moodle_url; /** * Report builder custom report audience created event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - int reportid: The id of the report * } */ class audience_updated extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = audience::TABLE; $this->data['crud'] = 'u'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report audience object * * @param audience $audience * @return self */ public static function create_from_object(audience $audience): self { $eventparams = [ 'context' => $audience->get_report()->get_context(), 'objectid' => $audience->get('id'), 'other' => [ 'reportid' => $audience->get('reportid'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $audience->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('audienceupdated', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { $reportid = $this->other['reportid']; return "The user with id '$this->userid' updated the audience with id '$this->objectid' in the custom report" . " with id '$reportid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } if (!isset($this->other['reportid'])) { throw new coding_exception('The \'reportid\' must be set in other.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->other['reportid']], 'audience'); } } PK a<�\R� " classes/event/audience_deleted.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\audience; use moodle_url; /** * Report builder custom report audience deleted event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - int reportid: The id of the report * } */ class audience_deleted extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = audience::TABLE; $this->data['crud'] = 'd'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report audience object * * @param audience $audience * @return self */ public static function create_from_object(audience $audience): self { $eventparams = [ 'context' => $audience->get_report()->get_context(), 'objectid' => $audience->get('id'), 'other' => [ 'reportid' => $audience->get('reportid'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $audience->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('audiencedeletedevent', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { $reportid = $this->other['reportid']; return "The user with id '$this->userid' deleted the audience with id '$this->objectid' in the custom report" . " with id '$reportid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } if (!isset($this->other['reportid'])) { throw new coding_exception('The \'reportid\' must be set in other.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->other['reportid']], 'audience'); } } PK a<�\�\ � " classes/event/schedule_deleted.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\schedule; use moodle_url; /** * Report builder custom report schedule created event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - int reportid: The id of the report * } */ class schedule_deleted extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = schedule::TABLE; $this->data['crud'] = 'd'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report schedule object * * @param schedule $schedule * @return self */ public static function create_from_object(schedule $schedule): self { $eventparams = [ 'context' => $schedule->get_report()->get_context(), 'objectid' => $schedule->get('id'), 'other' => [ 'reportid' => $schedule->get('reportid'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $schedule->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('scheduledeleted', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { $reportid = $this->other['reportid']; return "The user with id '$this->userid' deleted the schedule with id '$this->objectid' in the custom report" . " with id '$reportid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } if (!isset($this->other['reportid'])) { throw new coding_exception('The \'reportid\' must be set in other.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->other['reportid']], 'schedules'); } } PK a<�\�X�?? ? classes/event/report_created.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\report; use moodle_url; /** * Report builder custom report created event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - string name: The name of the report * - string source: The report source class * } */ class report_created extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = report::TABLE; $this->data['crud'] = 'c'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report object * * @param report $report * @return self */ public static function create_from_object(report $report): self { $eventparams = [ 'context' => $report->get_context(), 'objectid' => $report->get('id'), 'other' => [ 'name' => $report->get('name'), 'source' => $report->get('source'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $report->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('reportcreated', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' created the custom report with id '$this->objectid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->objectid]); } } PK a<�\�g�Y Y classes/event/report_deleted.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\report; /** * Report builder custom report deleted event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - string name: The name of the report * - string source: The report source class * } */ class report_deleted extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = report::TABLE; $this->data['crud'] = 'd'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report object * * @param report $report * @return self */ public static function create_from_object(report $report): self { $eventparams = [ 'context' => $report->get_context(), 'objectid' => $report->get('id'), 'other' => [ 'name' => $report->get('name'), 'source' => $report->get('source'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $report->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('reportdeleted', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' deleted the custom report with id '$this->objectid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } } } PK a<�\E%; ; classes/event/report_viewed.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\report; use moodle_url; /** * Report builder custom report viewed event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - string name: The name of the report * - string source: The report source class * } */ class report_viewed extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = report::TABLE; $this->data['crud'] = 'r'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report object * * @param report $report * @return self */ public static function create_from_object(report $report): self { $eventparams = [ 'context' => $report->get_context(), 'objectid' => $report->get('id'), 'other' => [ 'name' => $report->get('name'), 'source' => $report->get('source'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $report->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('reportviewed', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' viewed the custom report with id '$this->objectid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/view.php', ['id' => $this->objectid]); } } PK a<�\�o " classes/event/schedule_updated.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\schedule; use moodle_url; /** * Report builder custom report schedule updated event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - int reportid: The id of the report * } */ class schedule_updated extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = schedule::TABLE; $this->data['crud'] = 'u'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report schedule object * * @param schedule $schedule * @return self */ public static function create_from_object(schedule $schedule): self { $eventparams = [ 'context' => $schedule->get_report()->get_context(), 'objectid' => $schedule->get('id'), 'other' => [ 'reportid' => $schedule->get('reportid'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $schedule->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('scheduleupdated', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { $reportid = $this->other['reportid']; return "The user with id '$this->userid' updated the schedule with id '$this->objectid' in the custom report" . " with id '$reportid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } if (!isset($this->other['reportid'])) { throw new coding_exception('The \'reportid\' must be set in other.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->other['reportid']], 'schedules'); } } PK a<�\e�� � " classes/event/audience_created.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\audience; use moodle_url; /** * Report builder custom report audience created event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - int reportid: The id of the report * } */ class audience_created extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = audience::TABLE; $this->data['crud'] = 'c'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report audience object * * @param audience $audience * @return self */ public static function create_from_object(audience $audience): self { $eventparams = [ 'context' => $audience->get_report()->get_context(), 'objectid' => $audience->get('id'), 'other' => [ 'reportid' => $audience->get('reportid'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $audience->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('audiencecreated', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { $reportid = $this->other['reportid']; return "The user with id '$this->userid' created an audience in the custom report with id '$reportid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } if (!isset($this->other['reportid'])) { throw new coding_exception('The \'reportid\' must be set in other.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->other['reportid']], 'audience'); } } PK a<�\�{�/? ? classes/event/report_updated.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\report; use moodle_url; /** * Report builder custom report updated event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - string name: The name of the report * - string source: The report source class * } */ class report_updated extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = report::TABLE; $this->data['crud'] = 'u'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report object * * @param report $report * @return self */ public static function create_from_object(report $report): self { $eventparams = [ 'context' => $report->get_context(), 'objectid' => $report->get('id'), 'other' => [ 'name' => $report->get('name'), 'source' => $report->get('source'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $report->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('reportupdated', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { return "The user with id '$this->userid' updated the custom report with id '$this->objectid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->objectid]); } } PK a<�\zl��� � " classes/event/schedule_created.phpnu �[��� <?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\event; use coding_exception; use core\event\base; use core_reportbuilder\local\models\schedule; use moodle_url; /** * Report builder custom report schedule created event class. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later * * @property-read array $other { * Extra information about the event. * * - int reportid: The id of the report * } */ class schedule_created extends base { /** * Initialise the event data. */ protected function init() { $this->data['objecttable'] = schedule::TABLE; $this->data['crud'] = 'c'; $this->data['edulevel'] = self::LEVEL_OTHER; } /** * Creates an instance from a report schedule object * * @param schedule $schedule * @return self */ public static function create_from_object(schedule $schedule): self { $eventparams = [ 'context' => $schedule->get_report()->get_context(), 'objectid' => $schedule->get('id'), 'other' => [ 'reportid' => $schedule->get('reportid'), ] ]; $event = self::create($eventparams); $event->add_record_snapshot($event->objecttable, $schedule->to_record()); return $event; } /** * Returns localised general event name. * * @return string */ public static function get_name() { return get_string('schedulecreated', 'core_reportbuilder'); } /** * Returns non-localised description of what happened. * * @return string */ public function get_description() { $reportid = $this->other['reportid']; return "The user with id '$this->userid' created a schedule in the custom report with id '$reportid'."; } /** * Custom validations. * * @throws coding_exception */ protected function validate_data(): void { parent::validate_data(); if (!isset($this->objectid)) { throw new coding_exception('The \'objectid\' must be set.'); } if (!isset($this->other['reportid'])) { throw new coding_exception('The \'reportid\' must be set in other.'); } } /** * Returns relevant URL. * * @return moodle_url */ public function get_url(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->other['reportid']], 'schedules'); } } PK a<�\ L� � ! classes/system_report_factory.phpnu �[��� <?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; use context; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\base; use core_reportbuilder\exception\source_invalid_exception; /** * Factory class for creating system report instances * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_factory { /** * Create and return instance of given system report source * * @param string $source Class path of system report definition * @param context $context * @param string $component * @param string $area * @param int $itemid * @param array $parameters Simple key/value pairs, accessed inside reports using $this->get_parameter() * @return system_report * @throws source_invalid_exception */ public static function create(string $source, context $context, string $component = '', string $area = '', int $itemid = 0, array $parameters = []): system_report { // Exit early if source isn't a system report. if (!manager::report_source_exists($source, system_report::class)) { throw new source_invalid_exception($source); } $report = static::get_report_persistent($source, $context, $component, $area, $itemid); return manager::get_report_from_persistent($report, $parameters); } /** * Given a report source, with accompanying context information, return a persistent report instance * * @param string $source * @param context $context * @param string $component * @param string $area * @param int $itemid * @return report */ private static function get_report_persistent(string $source, context $context, string $component = '', string $area = '', int $itemid = 0): report { $reportdata = [ 'type' => base::TYPE_SYSTEM_REPORT, 'source' => $source, 'contextid' => $context->id, 'component' => $component, 'area' => $area, 'itemid' => $itemid, ]; if ($report = report::get_record($reportdata)) { return $report; } return manager::create_report_persistent((object) $reportdata); } } PK a<�\9wMi� � classes/manager.phpnu �[��� <?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; use core_collator; use core_component; use core_plugin_manager; use stdClass; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\base; use core_reportbuilder\exception\{source_invalid_exception, source_unavailable_exception}; /** * Report management class * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class manager { /** @var base $instances */ private static $instances = []; /** * Return an instance of a report class from the given report persistent * * We statically cache the list of loaded reports per user during request lifecycle, to allow this method to be called * repeatedly without potential performance problems initialising the same report multiple times * * @param report $report * @param array $parameters * @return base * @throws source_invalid_exception * @throws source_unavailable_exception */ public static function get_report_from_persistent(report $report, array $parameters = []): base { global $USER; // Cached instance per report/user, to account for initialization dependent on current user. $instancekey = $report->get('id') . ':' . ($USER->id ?? 0); if (!array_key_exists($instancekey, static::$instances)) { $source = $report->get('source'); // Throw exception for invalid or unavailable report source. if (!self::report_source_exists($source)) { throw new source_invalid_exception($source); } else if (!self::report_source_available($source)) { throw new source_unavailable_exception($source); } static::$instances[$instancekey] = new $source($report, $parameters); } return static::$instances[$instancekey]; } /** * Run reset code after tests to reset the instance cache */ public static function reset_caches(): void { if (PHPUNIT_TEST || defined('BEHAT_TEST')) { static::$instances = []; } } /** * Return an instance of a report class from the given report ID * * @param int $reportid * @param array $parameters * @return base */ public static function get_report_from_id(int $reportid, array $parameters = []): base { $report = new report($reportid); return self::get_report_from_persistent($report, $parameters); } /** * Verify that report source exists and extends appropriate base classes * * @param string $source Full namespaced path to report definition * @param string $additionalbaseclass Specify addition base class that given classname should extend * @return bool */ public static function report_source_exists(string $source, string $additionalbaseclass = ''): bool { return (class_exists($source) && is_subclass_of($source, base::class) && (empty($additionalbaseclass) || is_subclass_of($source, $additionalbaseclass))); } /** * Verify given report source is available. Note that it is assumed caller has already checked that it exists * * @param string $source * @return bool */ public static function report_source_available(string $source): bool { return call_user_func([$source, 'is_available']); } /** * Create new report persistent * * @param stdClass $reportdata * @return report */ public static function create_report_persistent(stdClass $reportdata): report { return (new report(0, $reportdata))->create(); } /** * Return an array of all valid report sources across the site * * @return array[][] Indexed by [component => [class => name]] */ public static function get_report_datasources(): array { $sources = array(); $datasources = core_component::get_component_classes_in_namespace(null, 'reportbuilder\\datasource'); foreach ($datasources as $class => $path) { if (self::report_source_exists($class, datasource::class) && self::report_source_available($class)) { // Group each report source by the component that it belongs to. [$component] = explode('\\', $class); if ($plugininfo = core_plugin_manager::instance()->get_plugin_info($component)) { $componentname = $plugininfo->displayname; } else { $componentname = get_string('site'); } $sources[$componentname][$class] = call_user_func([$class, 'get_name']); } } // Order source for each component alphabetically. array_walk($sources, static function(array &$componentsources): void { core_collator::asort($componentsources); }); return $sources; } /** * Configured site limit for number of custom reports threshold has been reached * * @return bool */ public static function report_limit_reached(): bool { global $CFG; return (!empty($CFG->customreportslimit) && (int) $CFG->customreportslimit <= report::count_records(['type' => base::TYPE_CUSTOM_REPORT])); } } PK a<�\%��8W8 W8 classes/datasource.phpnu �[��� <?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; use coding_exception; use core_reportbuilder\local\helpers\report; use core_reportbuilder\local\models\column as column_model; use core_reportbuilder\local\models\filter as filter_model; use core_reportbuilder\local\report\base; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; /** * Class datasource * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class datasource extends base { /** @var float[] $elementsmodified Track the time elements of specific reports have been added, updated, removed */ private static $elementsmodified = []; /** @var array $activecolumns */ private $activecolumns; /** @var array $activefilters */ private $activefilters; /** @var array $activeconditions */ private $activeconditions; /** * Add default datasource columns to the report * * Uses column data returned by the source {@see get_default_columns} and {@see get_default_column_sorting} methods * * @throws coding_exception If default column sorting refers to an invalid column */ public function add_default_columns(): void { $reportid = $this->get_report_persistent()->get('id'); // Retrieve default column sorting, and track index of both sorted/non-sorted columns. $columnidentifiers = $this->get_default_columns(); $defaultcolumnsorting = $this->get_default_column_sorting(); $defaultcolumnsortinginvalid = array_diff_key($defaultcolumnsorting, array_fill_keys($columnidentifiers, 1)); if (count($defaultcolumnsortinginvalid) > 0) { throw new coding_exception('Invalid column name', array_key_first($defaultcolumnsortinginvalid)); } $columnnonsortingindex = count($defaultcolumnsorting) + 1; foreach ($columnidentifiers as $uniqueidentifier) { $column = report::add_report_column($reportid, $uniqueidentifier); // After adding the column, toggle sorting according to defaults provided by the datasource. $sortorder = array_search($uniqueidentifier, array_keys($defaultcolumnsorting)); if ($sortorder !== false) { $column->set_many([ 'sortenabled' => true, 'sortdirection' => $defaultcolumnsorting[$uniqueidentifier], 'sortorder' => $sortorder + 1, ])->update(); } else if (!empty($defaultcolumnsorting)) { $column->set('sortorder', $columnnonsortingindex++)->update(); } } } /** * Return the default columns that will be added to the report upon creation, by {@see add_default_columns} * * @return string[] */ abstract public function get_default_columns(): array; /** * Return the default column sorting that will be set for the report upon creation, by {@see add_default_columns} * * When overriding this method in child classes, column identifiers specified must refer to default columns returned from * the {@see get_default_columns} method * * @return int[] array [column identifier => SORT_ASC/SORT_DESC] */ public function get_default_column_sorting(): array { return []; } /** * Override parent method, returning only those columns specifically added to the custom report (rather than all that are * available) * * @return column[] */ public function get_active_columns(): array { $reportid = $this->get_report_persistent()->get('id'); // Determine whether we already retrieved the columns since the report was last modified. self::$elementsmodified += [$reportid => -1]; if ($this->activecolumns !== null && $this->activecolumns['builttime'] > self::$elementsmodified[$reportid]) { return $this->activecolumns['values']; } $this->activecolumns = ['builttime' => microtime(true), 'values' => []]; $activecolumns = column_model::get_records(['reportid' => $reportid], 'columnorder'); foreach ($activecolumns as $index => $column) { $instance = $this->get_column($column->get('uniqueidentifier')); // Ensure the column is still present and available. if ($instance !== null && $instance->get_is_available()) { if ($instance->get_is_deprecated()) { debugging("The column '{$instance->get_unique_identifier()}' is deprecated, please do not use it any more." . " {$instance->get_is_deprecated_message()}", DEBUG_DEVELOPER); } // We should clone the report column to ensure if it's added twice to a report, each operates independently. $this->activecolumns['values'][] = clone $instance ->set_index($index) ->set_persistent($column) ->set_aggregation($column->get('aggregation')); } } return $this->activecolumns['values']; } /** * Add default datasource filters to the report * * This method is optional and can be called when the report is created to add the default filters defined in the * selected datasource. */ public function add_default_filters(): void { $reportid = $this->get_report_persistent()->get('id'); $filteridentifiers = $this->get_default_filters(); foreach ($filteridentifiers as $uniqueidentifier) { report::add_report_filter($reportid, $uniqueidentifier); } } /** * Return the filters that will be added to the report once is created * * @return string[] */ abstract public function get_default_filters(): array; /** * Override parent method, returning only those filters specifically added to the custom report (rather than all that are * available) * * @return filter[] */ public function get_active_filters(): array { $reportid = $this->get_report_persistent()->get('id'); // Determine whether we already retrieved the filters since the report was last modified. self::$elementsmodified += [$reportid => -1]; if ($this->activefilters !== null && $this->activefilters['builttime'] > self::$elementsmodified[$reportid]) { return $this->activefilters['values']; } $this->activefilters = ['builttime' => microtime(true), 'values' => []]; $activefilters = filter_model::get_filter_records($reportid, 'filterorder'); foreach ($activefilters as $filter) { $instance = $this->get_filter($filter->get('uniqueidentifier')); // Ensure the filter is still present and available. if ($instance !== null && $instance->get_is_available()) { if ($instance->get_is_deprecated()) { debugging("The filter '{$instance->get_unique_identifier()}' is deprecated, please do not use it any more." . " {$instance->get_is_deprecated_message()}", DEBUG_DEVELOPER); } $this->activefilters['values'][$instance->get_unique_identifier()] = $instance->set_persistent($filter); } } return $this->activefilters['values']; } /** * Add conditions from the given entity name to be available to use in a custom report * * Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*'] * * @param string $entityname * @param string[] $include Include only these conditions, if omitted then include all * @param string[] $exclude Exclude these conditions, if omitted then exclude none * @throws coding_exception If both $include and $exclude are non-empty */ final protected function add_conditions_from_entity(string $entityname, array $include = [], array $exclude = []): void { if (!empty($include) && !empty($exclude)) { throw new coding_exception('Cannot specify conditions to include and exclude simultaneously'); } $entity = $this->get_entity($entityname); // Retrieve filtered conditions from entity, respecting given $include/$exclude parameters. $conditions = array_filter($entity->get_conditions(), function(filter $condition) use ($include, $exclude): bool { if (!empty($include)) { return $this->report_element_search($condition->get_name(), $include); } if (!empty($exclude)) { return !$this->report_element_search($condition->get_name(), $exclude); } return true; }); foreach ($conditions as $condition) { $this->add_condition($condition); } } /** * Add default datasource conditions to the report * * This method is optional and can be called when the report is created to add the default conditions defined in the * selected datasource. */ public function add_default_conditions(): void { $reportid = $this->get_report_persistent()->get('id'); $conditionidentifiers = $this->get_default_conditions(); foreach ($conditionidentifiers as $uniqueidentifier) { report::add_report_condition($reportid, $uniqueidentifier); } // Set the default condition values if they have been set in the datasource. $this->set_condition_values($this->get_default_condition_values()); } /** * Return the conditions that will be added to the report once is created * * @return string[] */ abstract public function get_default_conditions(): array; /** * Return the default condition values that will be added to the report once is created * * For any of the default conditions returned by the method {@see get_default_conditions} is * possible to set the initial values. * * @return array */ public function get_default_condition_values(): array { return []; } /** * Override parent method, returning only those conditions specifically added to the custom report (rather than all that are * available) * * @param bool $checkavailable * @return filter[] */ public function get_active_conditions(bool $checkavailable = true): array { $reportid = $this->get_report_persistent()->get('id'); // Determine whether we already retrieved the conditions since the report was last modified. self::$elementsmodified += [$reportid => -1]; if ($this->activeconditions !== null && $this->activeconditions['builttime'] > self::$elementsmodified[$reportid]) { return $this->activeconditions['values']; } $this->activeconditions = ['builttime' => microtime(true), 'values' => []]; $activeconditions = filter_model::get_condition_records($reportid, 'filterorder'); foreach ($activeconditions as $condition) { $instance = $this->get_condition($condition->get('uniqueidentifier')); // Ensure the condition is still present and available (if checking available status). if ($instance !== null && (!$checkavailable || $instance->get_is_available())) { if ($instance->get_is_deprecated()) { debugging("The condition '{$instance->get_unique_identifier()}' is deprecated, please do not use it any more." . " {$instance->get_is_deprecated_message()}", DEBUG_DEVELOPER); } $this->activeconditions['values'][$instance->get_unique_identifier()] = $instance->set_persistent($condition); } } return $this->activeconditions['values']; } /** * Adds all columns/filters/conditions from the given entity to the report at once * * @param string $entityname * @param string[] $limitcolumns Include only these columns * @param string[] $limitfilters Include only these filters * @param string[] $limitconditions Include only these conditions */ final protected function add_all_from_entity( string $entityname, array $limitcolumns = [], array $limitfilters = [], array $limitconditions = [], ): void { $this->add_columns_from_entity($entityname, $limitcolumns); $this->add_filters_from_entity($entityname, $limitfilters); $this->add_conditions_from_entity($entityname, $limitconditions); } /** * Adds all columns/filters/conditions from all the entities added to the report at once * * @param string[] $entitynames If specified, then only these entity elements are added (otherwise all) */ final protected function add_all_from_entities(array $entitynames = []): void { foreach ($this->get_entities() as $entity) { $entityname = $entity->get_entity_name(); if (!empty($entitynames) && array_search($entityname, $entitynames) === false) { continue; } $this->add_all_from_entity($entityname); } } /** * Indicate that report elements have been modified, e.g. columns/filters/conditions have been added, removed or updated * * @param int $reportid */ final public static function report_elements_modified(int $reportid): void { self::$elementsmodified[$reportid] = microtime(true); } } PK a<�\�Y�� � ) classes/reportbuilder/audience/admins.phpnu �[��� <?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\reportbuilder\audience; use MoodleQuickForm; use core_reportbuilder\local\audiences\base; use core_reportbuilder\local\helpers\database; /** * Administrators audience type * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class admins extends base { /** * Add audience elements to the current form * * @param MoodleQuickForm $mform */ public function get_config_form(MoodleQuickForm $mform): void { $mform->addElement('static', 'admins', get_string('siteadministrators', 'core_role')); } /** * Return SQL to retrieve users that match this audience * * @param string $usertablealias * @return array [$join, $select, $params] */ public function get_sql(string $usertablealias): array { global $CFG, $DB; $siteadmins = array_map('intval', explode(',', $CFG->siteadmins)); [$select, $params] = $DB->get_in_or_equal($siteadmins, SQL_PARAMS_NAMED, database::generate_param_name('_')); return ['', "{$usertablealias}.id {$select}", $params]; } /** * Return name of this audience * * @return string */ public function get_name(): string { return get_string('siteadministrators', 'core_role'); } /** * Return description of this audience. * * @return string */ public function get_description(): string { $siteadmins = array_map('fullname', get_admins()); return $this->format_description_for_multiselect($siteadmins); } /** * Whether the current user is able to add this audience * * @return bool */ public function user_can_add(): bool { return is_siteadmin(); } /** * Whether the current user is able to edit this audience * * @return bool */ public function user_can_edit(): bool { return $this->user_can_add(); } } PK a<�\��]�` ` + classes/reportbuilder/audience/allusers.phpnu �[��� <?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\reportbuilder\audience; use context_system; use core_reportbuilder\local\audiences\base; use core_reportbuilder\local\helpers\database; use MoodleQuickForm; /** * The backend class for All users audience type * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class allusers extends base { /** * Adds audience's elements to the given mform * * @param MoodleQuickForm $mform The form to add elements to */ public function get_config_form(MoodleQuickForm $mform): void { $mform->addElement('static', 'allsiteusers', get_string('allsiteusers', 'core_reportbuilder')); } /** * Helps to build SQL to retrieve users that matches the current report audience * * @param string $usertablealias * @return array array of three elements [$join, $where, $params] */ public function get_sql(string $usertablealias): array { global $CFG; $guestuser = database::generate_param_name(); return ['', "$usertablealias.suspended = 0 AND $usertablealias.deleted = 0 AND $usertablealias.id <> :{$guestuser}", [$guestuser => $CFG->siteguest]]; } /** * Return user friendly name of this audience type * * @return string */ public function get_name(): string { return get_string('allusers', 'core_reportbuilder'); } /** * Return the description for the audience. * * @return string */ public function get_description(): string { return get_string('allsiteusers', 'core_reportbuilder'); } /** * If the current user is able to add this audience. * * @return bool */ public function user_can_add(): bool { return has_capability('moodle/user:viewalldetails', context_system::instance()); } /** * If the current user is able to edit this audience. * * @return bool */ public function user_can_edit(): bool { return has_capability('moodle/user:viewalldetails', context_system::instance()); } } PK a<�\~y!>� � ) classes/reportbuilder/audience/manual.phpnu �[��� <?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\reportbuilder\audience; use context_system; use core_reportbuilder\local\audiences\base; use core_reportbuilder\local\helpers\database; use core_user; use MoodleQuickForm; /** * The backend class for Manually added users audience type * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class manual extends base { /** * Adds audience's elements to the given mform * * @param MoodleQuickForm $mform The form to add elements to */ public function get_config_form(MoodleQuickForm $mform): void { // Users selector. $options = [ 'ajax' => 'core_user/form_user_selector', 'multiple' => true, 'valuehtmlcallback' => function($userid) { $user = core_user::get_user($userid); return fullname($user, has_capability('moodle/site:viewfullnames', context_system::instance())); } ]; $mform->addElement('autocomplete', 'users', get_string('addusers', 'core_reportbuilder'), [], $options); $mform->addRule('users', null, 'required', null, 'client'); } /** * Helps to build SQL to retrieve users that matches the current report audience * * @param string $usertablealias * @return array array of three elements [$join, $where, $params] */ public function get_sql(string $usertablealias): array { global $DB; $users = $this->get_configdata()['users']; [$insql, $inparams] = $DB->get_in_or_equal($users, SQL_PARAMS_NAMED, database::generate_param_name('_')); return ['', "{$usertablealias}.id $insql", $inparams]; } /** * Return user friendly name of this audience type * * @return string */ public function get_name(): string { return get_string('manuallyaddedusers', 'core_reportbuilder'); } /** * Return the description for the audience. * * @return string */ public function get_description(): string { global $DB; $canviewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance()); $userslist = []; $userids = $this->get_configdata()['users']; [$sort] = users_order_by_sql(); $users = $DB->get_records_list('user', 'id', $userids, $sort); foreach ($users as $user) { $userslist[] = fullname($user, $canviewfullnames); } return $this->format_description_for_multiselect($userslist); } /** * If the current user is able to add this audience. * * @return bool */ public function user_can_add(): bool { return has_capability('moodle/user:viewalldetails', context_system::instance()); } /** * If the current user is able to edit this audience. * * @return bool */ public function user_can_edit(): bool { return has_capability('moodle/user:viewalldetails', context_system::instance()); } } PK a<�\�x�� � - classes/reportbuilder/audience/systemrole.phpnu �[��� <?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\reportbuilder\audience; use context_system; use core_reportbuilder\local\audiences\base; use core_reportbuilder\local\helpers\database; use MoodleQuickForm; /** * The backend class for Has system role audience type * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class systemrole extends base { /** * Adds audience's elements to the given mform * * @param MoodleQuickForm $mform The form to add elements to */ public function get_config_form(MoodleQuickForm $mform): void { $roles = get_assignable_roles(context_system::instance(), ROLENAME_ALIAS); $mform->addElement('autocomplete', 'roles', get_string('selectrole', 'role'), $roles, ['multiple' => true]); $mform->addRule('roles', null, 'required', null, 'client'); } /** * Helps to build SQL to retrieve users that matches the current audience * * @param string $usertablealias * @return array array of three elements [$join, $where, $params] */ public function get_sql(string $usertablealias): array { global $DB; $roles = $this->get_configdata()['roles']; [$insql, $inparams] = $DB->get_in_or_equal($roles, SQL_PARAMS_NAMED, database::generate_param_name('_')); // Ensure parameter names and aliases are unique, as the same audience type can be added multiple times to a report. $paramcontextid = database::generate_param_name(); [$roleassignments, $context] = database::generate_aliases(2); $join = " JOIN {role_assignments} {$roleassignments} ON {$roleassignments}.userid = {$usertablealias}.id JOIN {context} {$context} ON {$context}.id = {$roleassignments}.contextid"; $where = "{$roleassignments}.contextid = :{$paramcontextid} AND {$roleassignments}.roleid {$insql}"; return [$join, $where, $inparams + [$paramcontextid => context_system::instance()->id]]; } /** * Return user friendly name of this audience type * * @return string */ public function get_name(): string { return get_string('hassystemrole', 'core_reportbuilder'); } /** * Return the description for the audience. * * @return string */ public function get_description(): string { global $DB; $rolesids = $this->get_configdata()['roles']; $roles = $DB->get_records_list('role', 'id', $rolesids, 'sortorder'); $rolesfixed = role_fix_names($roles, context_system::instance(), ROLENAME_ALIAS, true); return $this->format_description_for_multiselect($rolesfixed); } /** * If the current user is able to add this audience. * * @return bool */ public function user_can_add(): bool { // Check if user is able to assign any role from the system context. $roles = get_assignable_roles(context_system::instance(), ROLENAME_ALIAS); if (empty($roles)) { return false; } return true; } /** * If the current user is able to edit this audience. * * @return bool */ public function user_can_edit(): bool { global $DB; // Check if user can assign all saved role types on this audience instance. $roleids = $this->get_configdata()['roles']; $roles = get_assignable_roles(context_system::instance(), ROLENAME_ALIAS); // Check that all saved roles still exist. [$insql, $inparams] = $DB->get_in_or_equal($roleids, SQL_PARAMS_NAMED); $records = $DB->get_records_select('role', "id $insql", $inparams); if (!empty(array_diff(array_keys($records), array_keys($roles)))) { return false; } return true; } } PK a<�\�g�� � . classes/exception/source_invalid_exception.phpnu �[��� <?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\exception; use moodle_exception; /** * Invalid report source exception * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class source_invalid_exception extends moodle_exception { /** * Constructor * * @param string $source */ public function __construct(string $source) { parent::__construct('errorsourceinvalid', 'reportbuilder', '', null, $source); } } PK a<�\:�� � - classes/exception/report_access_exception.phpnu �[��� <?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\exception; use moodle_exception; /** * User cannot access report exception * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report_access_exception extends moodle_exception { /** * Constructor * * @param string $errorcode */ public function __construct(string $errorcode = 'errorreportview') { parent::__construct($errorcode, 'reportbuilder'); } } PK a<�\�X� � 2 classes/exception/source_unavailable_exception.phpnu �[��� <?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\exception; use moodle_exception; /** * Unavailable report source exception * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class source_unavailable_exception extends moodle_exception { /** * Constructor * * @param string $source */ public function __construct(string $source) { parent::__construct('errorsourceunavailable', 'reportbuilder', '', null, $source); } } PK a<�\ �� classes/task/send_schedule.phpnu �[��� <?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\task; use core\{clock, di}; use core\task\adhoc_task; use core_user; use core_reportbuilder\local\helpers\schedule as helper; use core_reportbuilder\local\models\schedule; use moodle_exception; /** * Ad-hoc task for sending a single report schedule * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class send_schedule extends adhoc_task { use \core\task\logging_trait; /** * Return name of the task * * @return string */ public function get_name(): string { return get_string('tasksendschedule', 'core_reportbuilder'); } /** * Execute the task */ public function execute(): void { global $CFG, $USER, $DB; [ 'reportid' => $reportid, 'scheduleid' => $scheduleid, ] = (array) $this->get_custom_data(); // Custom reports are disabled. if (empty($CFG->enablecustomreports)) { return; } $schedule = schedule::get_record(['id' => $scheduleid, 'reportid' => $reportid]); if ($schedule === false) { $this->log('Invalid schedule', 0); return; } $this->log_start('Sending schedule: ' . $schedule->get_formatted_name()); $scheduleattachment = null; $originaluser = $USER; // Get the schedule creator, ensure it's an active account. try { $schedulecreator = core_user::get_user($schedule->get('usercreated'), '*', MUST_EXIST); core_user::require_active_user($schedulecreator); } catch (moodle_exception $exception) { $this->log('Invalid schedule creator: ' . $exception->getMessage(), 0); return; } // Switch to schedule creator, and retrieve list of recipient users. \core\cron::setup_user($schedulecreator); $users = helper::get_schedule_report_users($schedule); if (count($users) > 0) { $scheduleuserviewas = $schedule->get('userviewas'); $schedulereportempty = $schedule->get('reportempty'); // Handle schedule configuration as to who the report should be viewed as. if ($scheduleuserviewas === schedule::REPORT_VIEWAS_CREATOR) { $scheduleattachment = helper::get_schedule_report_file($schedule); } else if ($scheduleuserviewas !== schedule::REPORT_VIEWAS_RECIPIENT) { // Get the user to view the schedule report as, ensure it's an active account. try { $scheduleviewas = core_user::get_user($scheduleuserviewas, '*', MUST_EXIST); core_user::require_active_user($scheduleviewas); } catch (moodle_exception $exception) { $this->log('Invalid schedule view as user: ' . $exception->getMessage(), 0); return; } \core\cron::setup_user($scheduleviewas); $scheduleattachment = helper::get_schedule_report_file($schedule); } // Apply special handling if report is empty (default is to send it anyway). if ($schedulereportempty === schedule::REPORT_EMPTY_DONT_SEND && $scheduleattachment !== null && helper::get_schedule_report_count($schedule) === 0) { $this->log('Empty report, skipping'); } else { // Now iterate over recipient users, send the report to each. foreach ($users as $user) { $this->log('Sending to: ' . fullname($user, true)); // If we already created the attachment, send that. Otherwise generate per recipient. if ($scheduleattachment !== null) { helper::send_schedule_message($schedule, $user, $scheduleattachment); } else { \core\cron::setup_user($user); if ($schedulereportempty === schedule::REPORT_EMPTY_DONT_SEND && helper::get_schedule_report_count($schedule) === 0) { $this->log('Empty report, skipping', 2); continue; } $recipientattachment = helper::get_schedule_report_file($schedule); helper::send_schedule_message($schedule, $user, $recipientattachment); $recipientattachment->delete(); } } } } // Finish, clean up (set persistent property manually to avoid updating it's user/time modified data). $DB->set_field($schedule::TABLE, 'timelastsent', di::get(clock::class)->time(), [ 'id' => $schedule->get('id'), ]); if ($scheduleattachment !== null) { $scheduleattachment->delete(); } $this->log_finish('Sending schedule complete'); // Restore cron user to original state. \core\cron::setup_user($originaluser); } } PK a<�\|15� � classes/task/send_schedules.phpnu �[��� <?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\task; use core\{clock, di}; use core\task\scheduled_task; use core_reportbuilder\local\helpers\schedule; use core_reportbuilder\local\models\schedule as model; /** * Scheduled task for sending queued report schedules * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class send_schedules extends scheduled_task { /** * Return name of the task * * @return string */ public function get_name(): string { return get_string('tasksendschedules', 'core_reportbuilder'); } /** * Execute the task, request all pending schedules to be sent */ public function execute(): void { global $DB; $schedules = model::get_records_select('enabled = 1 AND timenextsend <= :time', [ 'time' => di::get(clock::class)->time(), ]); $schedules = array_filter($schedules, [schedule::class, 'should_send_schedule']); // Loop over all schedules for sending, execute corresponding task to send each individually. foreach ($schedules as $schedule) { $sendschedule = new send_schedule(); $sendschedule->set_custom_data([ 'reportid' => $schedule->get('reportid'), 'scheduleid' => $schedule->get('id'), ]); $sendschedule->execute(); // Calculate next send time (set persistent property manually to avoid updating it's user/time modified data). $DB->set_field($schedule::TABLE, 'timenextsend', schedule::calculate_next_send_time($schedule->read()), ['id' => $schedule->get('id')]); } } } PK a<�\f�j�� � / classes/table/custom_report_table_filterset.phpnu �[��� <?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\table; use core_table\local\filter\filterset; /** * Custom report dynamic table filterset class * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_table_filterset extends filterset { /** * Get the required filters * * @return array. */ public function get_required_filters(): array { return []; } } PK a<�\��6�p= p= % classes/table/custom_report_table.phpnu �[��� <?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\table; use core\output\notification; use html_writer; use moodle_exception; use moodle_url; use stdClass; use core_reportbuilder\{datasource, manager}; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\column; use core_reportbuilder\output\column_aggregation_editable; use core_reportbuilder\output\column_heading_editable; /** * Custom report dynamic table class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_table extends base_report_table { /** @var datasource $report */ protected $report; /** @var string Unique ID prefix for the table */ private const UNIQUEID_PREFIX = 'custom-report-table-'; /** @var bool Whether report is being edited (we don't want user filters/sorting to be applied when editing) */ protected const REPORT_EDITING = true; /** @var float $querytimestart Time we began executing table SQL */ private $querytimestart = 0.0; /** * Table constructor. Note that the passed unique ID value must match the pattern "custom-report-table-(\d+)" so that * dynamic updates continue to load the same report * * @param string $uniqueid * @param string $download * @throws moodle_exception For invalid unique ID */ public function __construct(string $uniqueid, string $download = '') { if (!preg_match('/^' . self::UNIQUEID_PREFIX . '(?<id>\d+)$/', $uniqueid, $matches)) { throw new moodle_exception('invalidcustomreportid', 'core_reportbuilder', '', null, $uniqueid); } parent::__construct($uniqueid); $this->define_baseurl(new moodle_url('/reportbuilder/edit.php', ['id' => $matches['id']])); // Load the report persistent, and accompanying report instance. $this->persistent = new report($matches['id']); $this->report = manager::get_report_from_persistent($this->persistent); $fields = $groupby = []; $maintable = $this->report->get_main_table(); $maintablealias = $this->report->get_main_table_alias(); $joins = $this->report->get_joins(); [$where, $params] = $this->report->get_base_condition(); $this->set_attribute('data-region', 'reportbuilder-table'); $this->set_attribute('class', $this->attributes['class'] . ' reportbuilder-table'); // Download options. $this->showdownloadbuttonsat = [TABLE_P_BOTTOM]; $this->is_downloading($download ?? null, $this->persistent->get_formatted_name()); // Retrieve all report columns, exit early if there are none. Defining empty columns prevents errors during out(). $columns = $this->get_active_columns(); if (empty($columns)) { $this->init_sql("{$maintablealias}.*", "{{$maintable}} {$maintablealias}", $joins, '1=0', []); $this->define_columns([0]); return; } // If we are aggregating any columns, we should group by the remaining ones. $aggregatedcolumns = array_filter($columns, static function(column $column): bool { return !empty($column->get_aggregation()); }); $hasaggregatedcolumns = !empty($aggregatedcolumns); // Also take account of the report setting to show unique rows (only if no columns are being aggregated). $showuniquerows = !$hasaggregatedcolumns && $this->persistent->get('uniquerows'); $columnheaders = $columnsattributes = []; foreach ($columns as $column) { $columnheading = $column->get_persistent()->get_formatted_heading($this->report->get_context()); $columnheaders[$column->get_column_alias()] = $columnheading !== '' ? $columnheading : $column->get_title(); // We need to determine for each column whether we should group by its fields, to support aggregation. if ($showuniquerows || ($hasaggregatedcolumns && empty($column->get_aggregation()))) { $groupby = array_merge($groupby, $column->get_groupby_sql()); } // Add each columns fields, joins and params to our report. $fields = array_merge($fields, $column->get_fields()); $joins = array_merge($joins, $column->get_joins()); $params = array_merge($params, $column->get_params()); // Disable sorting for some columns. if (!$column->get_is_sortable()) { $this->no_sorting($column->get_column_alias()); } // Add column attributes needed for card view. $settings = $this->report->get_settings_values(); $showfirsttitle = $settings['cardview_showfirsttitle'] ?? false; $visiblecolumns = max($settings['cardview_visiblecolumns'] ?? 1, count($this->columns)); if ($showfirsttitle || $column->get_persistent()->get('columnorder') > 1) { $column->add_attributes(['data-cardtitle' => $columnheaders[$column->get_column_alias()]]); } if ($column->get_persistent()->get('columnorder') > $visiblecolumns) { $column->add_attributes(['data-cardviewhidden' => '']); } // Generate column attributes to be included in each cell. $columnsattributes[$column->get_column_alias()] = $column->get_attributes(); } $this->define_columns(array_keys($columnheaders)); $this->define_headers(array_values($columnheaders)); // Add column attributes to the table. $this->set_columnsattributes($columnsattributes); // Table configuration. $this->initialbars(false); $this->collapsible(false); $this->pageable(true); $this->set_default_per_page($this->report->get_default_per_page()); // Initialise table SQL properties. $this->set_report_editing(static::REPORT_EDITING); $fieldsql = implode(', ', $fields); $this->init_sql($fieldsql, "{{$maintable}} {$maintablealias}", $joins, $where, $params, $groupby); } /** * Return a new instance of the class for given report ID * * @param int $reportid * @param string $download * @return static */ public static function create(int $reportid, string $download = ''): self { return new static(self::UNIQUEID_PREFIX . $reportid, $download); } /** * Get user preferred sort columns, overriding those of parent. If user has no preferences then use report defaults * * @return array */ public function get_sort_columns(): array { $sortcolumns = parent::get_sort_columns(); if ($this->editing || empty($sortcolumns)) { $sortcolumns = []; $columns = $this->get_active_columns(); // We need to sort the columns by the configured sorting order. usort($columns, static function(column $a, column $b): int { return ($a->get_persistent()->get('sortorder') < $b->get_persistent()->get('sortorder')) ? -1 : 1; }); foreach ($columns as $column) { $persistent = $column->get_persistent(); if ($column->get_is_sortable() && $persistent->get('sortenabled')) { $sortcolumns[$column->get_column_alias()] = $persistent->get('sortdirection'); } } } return $sortcolumns; } /** * Format each row of returned data, executing defined callbacks for the row and each column * * @param array|stdClass $row * @return array */ public function format_row($row) { $columns = $this->get_active_columns(); $formattedrow = []; foreach ($columns as $column) { $formattedrow[$column->get_column_alias()] = $column->format_value((array) $row); } return $formattedrow; } /** * Download is disabled when editing the report * * @return string */ public function download_buttons(): string { return ''; } /** * Get the columns of the custom report, returned instances being valid and available for the user * * @return column[] */ protected function get_active_columns(): array { return $this->report->get_active_columns(); } /** * Override parent method for printing headers so we can render our custom controls in each cell */ public function print_headers() { global $OUTPUT, $PAGE; $columns = $this->get_active_columns(); if (empty($columns)) { return; } $columns = array_values($columns); $renderer = $PAGE->get_renderer('core'); echo html_writer::start_tag('thead'); echo html_writer::start_tag('tr'); foreach ($this->headers as $index => $title) { $column = $columns[$index]; $headingeditable = new column_heading_editable(0, $column->get_persistent()); $aggregationeditable = new column_aggregation_editable(0, $column->get_persistent()); // Render table header cell, with all editing controls. $headercell = $OUTPUT->render_from_template('core_reportbuilder/table_header_cell', [ 'entityname' => $this->report->get_entity_title($column->get_entity_name()), 'name' => $column->get_title(), 'headingeditable' => $headingeditable->render($renderer), 'aggregationeditable' => $aggregationeditable->render($renderer), 'movetitle' => get_string('movecolumn', 'core_reportbuilder', $column->get_title()), ]); echo html_writer::tag('th', $headercell, [ 'class' => 'border-end border-start', 'scope' => 'col', 'data-region' => 'column-header', 'data-column-id' => $column->get_persistent()->get('id'), 'data-column-name' => $column->get_title(), 'data-column-position' => $index + 1, ]); } echo html_writer::end_tag('tr'); echo html_writer::end_tag('thead'); } /** * Override print_nothing_to_display to ensure that column headers are always added. */ public function print_nothing_to_display() { global $OUTPUT; $this->start_html(); $this->print_headers(); echo html_writer::end_tag('table'); echo html_writer::end_tag('div'); $this->wrap_html_finish(); // With the live editing disabled we need to notify user that data is shown only in preview mode. if ($this->editing && !self::show_live_editing()) { $notificationmsg = get_string('customreportsliveeditingdisabled', 'core_reportbuilder'); $notificationtype = notification::NOTIFY_WARNING; } else { $notificationmsg = get_string('nothingtodisplay'); $notificationtype = notification::NOTIFY_INFO; } $notification = (new notification($notificationmsg, $notificationtype, false)) ->set_extra_classes(['mt-3']); echo $OUTPUT->render($notification); echo $this->get_dynamic_table_html_end(); } /** * Provide additional table debugging during editing */ public function wrap_html_finish(): void { global $OUTPUT; if ($this->editing && debugging('', DEBUG_DEVELOPER)) { $params = array_map(static function(string $param, $value): array { return ['param' => $param, 'value' => var_export($value, true)]; }, array_keys($this->sql->params), $this->sql->params); echo $OUTPUT->render_from_template('core_reportbuilder/local/report/debug', [ 'query' => $this->get_table_sql(), 'params' => $params, 'duration' => $this->querytimestart ? format_time($this->querytimestart - microtime(true)) : null, ]); } } /** * Override get_row_cells_html to add an extra cell with the toggle button for card view. * * @param string $rowid * @param array $row * @param array|null $suppresslastrow * @return string */ public function get_row_cells_html(string $rowid, array $row, ?array $suppresslastrow): string { $html = parent::get_row_cells_html($rowid, $row, $suppresslastrow); // Add extra 'td' in the row with card toggle button (only visible in card view). $visiblecolumns = $this->report->get_settings_values()['cardview_visiblecolumns'] ?? 1; if ($visiblecolumns < count($this->columns)) { $buttonicon = html_writer::tag('i', '', ['class' => 'fa fa-angle-down']); // We need a cleaned version (without tags/entities) of the first row column to use as toggle button. $rowfirstcolumn = strip_tags((string) reset($row)); $buttontitle = $rowfirstcolumn !== '' ? get_string('showhide', 'core_reportbuilder', html_entity_decode($rowfirstcolumn, ENT_COMPAT)) : get_string('showhidecard', 'core_reportbuilder'); $button = html_writer::tag('button', $buttonicon, [ 'type' => 'button', 'class' => 'btn collapsed', 'title' => $buttontitle, 'data-toggle' => 'collapse', 'data-action' => 'toggle-card' ]); $html .= html_writer::tag('td', $button, ['class' => 'card-toggle d-none']); } return $html; } /** * Overriding this method to handle live editing setting. * @param int $pagesize * @param bool $useinitialsbar * @param string $downloadhelpbutton */ public function out($pagesize, $useinitialsbar, $downloadhelpbutton = '') { $this->pagesize = $pagesize; $this->setup(); // If the live editing setting is disabled, we not need to fetch custom report data except in preview mode. if (!$this->editing || self::show_live_editing()) { $this->querytimestart = microtime(true); $this->query_db($pagesize, $useinitialsbar); $this->build_table(); $this->close_recordset(); } $this->finish_output(); } /** * Whether or not report data should be included in the table while in editing mode * * @return bool */ private static function show_live_editing(): bool { global $CFG; return !empty($CFG->customreportsliveediting); } /** * Check if the user has the capability to access this table. * * @return bool Return true if capability check passed. */ public function has_capability(): bool { return \core_reportbuilder\permission::can_edit_report($this->persistent); } } PK a<�\�X�*�( �( # classes/table/base_report_table.phpnu �[��� <?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\table; use context; use moodle_url; use renderable; use table_sql; use html_writer; use core_table\dynamic; use core_reportbuilder\local\helpers\database; use core_reportbuilder\local\filters\base; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\base as base_report; use core_reportbuilder\local\report\filter; use core\output\notification; defined('MOODLE_INTERNAL') || die; require_once("{$CFG->libdir}/tablelib.php"); /** * Base report dynamic table class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class base_report_table extends table_sql implements dynamic, renderable { /** @var report $persistent */ protected $persistent; /** @var base_report $report */ protected $report; /** @var string $groupbysql */ protected $groupbysql = ''; /** @var bool $editing */ protected $editing = false; /** * Initialises table SQL properties * * @param string $fields * @param string $from * @param array $joins * @param string $where * @param array $params * @param array $groupby */ protected function init_sql(string $fields, string $from, array $joins, string $where, array $params, array $groupby = []): void { $wheres = []; if ($where !== '') { $wheres[] = $where; } // Track the index of conditions/filters as we iterate over them. $conditionindex = $filterindex = 0; // For each condition, we need to ensure their values are always accounted for in the report. $conditionvalues = $this->report->get_condition_values(); foreach ($this->report->get_active_conditions(false) as $condition) { [$conditionsql, $conditionparams] = $this->get_filter_sql($condition, $conditionvalues, 'c' . $conditionindex++); if ($conditionsql !== '') { $joins = array_merge($joins, $condition->get_joins()); $wheres[] = "({$conditionsql})"; $params = array_merge($params, $conditionparams); } } // For each filter, we also need to apply their values (will differ according to user viewing the report). if (!$this->editing) { $filtervalues = $this->report->get_filter_values(); foreach ($this->report->get_active_filters() as $filter) { [$filtersql, $filterparams] = $this->get_filter_sql($filter, $filtervalues, 'f' . $filterindex++); if ($filtersql !== '') { $joins = array_merge($joins, $filter->get_joins()); $wheres[] = "({$filtersql})"; $params = array_merge($params, $filterparams); } } } // Join all the filters into a SQL WHERE clause, falling back to all records. if (!empty($wheres)) { $wheresql = implode(' AND ', $wheres); } else { $wheresql = '1=1'; } if (!empty($groupby)) { $this->groupbysql = 'GROUP BY ' . implode(', ', $groupby); } // Add unique table joins. $from .= ' ' . implode(' ', array_unique($joins)); $this->set_sql($fields, $from, $wheresql, $params); $counttablealias = database::generate_alias(); $this->set_count_sql(" SELECT COUNT(1) FROM (SELECT {$fields} FROM {$from} WHERE {$wheresql} {$this->groupbysql} ) {$counttablealias}", $params); } /** * Whether the current report table is being edited, in which case certain actions are not applied to it, e.g. user filtering * and sorting. Default class value is false * * @param bool $editing */ public function set_report_editing(bool $editing): void { $this->editing = $editing; } /** * Return SQL fragments from given filter instance suitable for inclusion in table SQL * * @param filter $filter * @param array $filtervalues * @param string $paramprefix * @return array [$sql, $params] */ private function get_filter_sql(filter $filter, array $filtervalues, string $paramprefix): array { /** @var base $filterclass */ $filterclass = $filter->get_filter_class(); // Retrieve SQL fragments from the filter instance, process parameters if required. [$sql, $params] = $filterclass::create($filter)->get_sql_filter($filtervalues); if ($paramprefix !== '' && count($params) > 0) { return database::sql_replace_parameters( $sql, $params, fn(string $param) => "{$paramprefix}_{$param}", ); } return [$sql, $params]; } /** * Generate suitable SQL for the table * * @return string */ protected function get_table_sql(): string { $sql = "SELECT {$this->sql->fields} FROM {$this->sql->from} WHERE {$this->sql->where} {$this->groupbysql}"; $sort = $this->get_sql_sort(); if ($sort) { $sql .= " ORDER BY {$sort}"; } return $sql; } /** * Override parent method of the same, to make use of a recordset and avoid issues with duplicate values in the first column * * @param int $pagesize * @param bool $useinitialsbar */ public function query_db($pagesize, $useinitialsbar = true): void { global $DB; if (!$this->is_downloading()) { $this->pagesize($pagesize, $DB->count_records_sql($this->countsql, $this->countparams)); $this->rawdata = $DB->get_recordset_sql($this->get_table_sql(), $this->sql->params, $this->get_page_start(), $this->get_page_size()); } else { $this->rawdata = $DB->get_recordset_sql($this->get_table_sql(), $this->sql->params); } } /** * Override parent method of the same, to ensure that any columns with custom sort fields are accounted for * * Because the base table_sql has "special" handling of fullname columns {@see table_sql::contains_fullname_columns}, we need * to handle that here to ensure that any that are being sorted take priority over reportbuilders own aliases of the same * columns. This prevents them appearing multiple times in a query, which SQL Server really doesn't like * * @return string */ public function get_sql_sort() { $columnsbyalias = $this->report->get_active_columns_by_alias(); $columnsortby = []; // First pass over sorted columns, to extract all the fullname fields from table_sql. $sortedcolumns = $this->get_sort_columns(); $sortedcolumnsfullname = array_filter($sortedcolumns, static function(string $alias): bool { return !preg_match('/^c[\d]+_/', $alias); }, ARRAY_FILTER_USE_KEY); // Iterate over all sorted report columns, replace with columns own fields if applicable. foreach ($sortedcolumns as $alias => $order) { $column = $columnsbyalias[$alias] ?? null; // If the column is not being aggregated and defines custom sort fields, then use them. if ($column && !$column->get_aggregation() && ($sortfields = $column->get_sort_fields())) { foreach ($sortfields as $sortfield) { $columnsortby[$sortfield] = $order; } } else { $columnsortby[$alias] = $order; } } // Now ensure that any fullname sorted columns have duplicated aliases removed. $columnsortby = array_filter($columnsortby, static function(string $alias) use ($sortedcolumnsfullname): bool { if (preg_match('/^c[\d]+_(?<column>.*)$/', $alias, $matches)) { return !array_key_exists($matches['column'], $sortedcolumnsfullname); } return true; }, ARRAY_FILTER_USE_KEY); return static::construct_order_by($columnsortby); } /** * Get the context for the table (that of the report persistent) * * @return context */ public function get_context(): context { return $this->persistent->get_context(); } /** * Set the base URL of the table to the current page URL */ public function guess_base_url(): void { $this->baseurl = new moodle_url('/'); } /** * Override print_nothing_to_display to modity the output styles. */ public function print_nothing_to_display() { global $OUTPUT; echo $this->get_dynamic_table_html_start(); echo $this->render_reset_button(); if ($notice = $this->report->get_default_no_results_notice()) { echo $OUTPUT->render(new notification($notice->out(), notification::NOTIFY_INFO, false)); } echo $this->get_dynamic_table_html_end(); } /** * Override start of HTML to remove top pagination. */ public function start_html() { // Render the dynamic table header. echo $this->get_dynamic_table_html_start(); // Render button to allow user to reset table preferences. echo $this->render_reset_button(); $this->wrap_html_start(); $this->set_caption($this->report::get_name(), ['class' => 'sr-only']); echo html_writer::start_tag('div'); echo html_writer::start_tag('table', $this->attributes) . $this->render_caption(); } } PK a<�\�.)� � / classes/table/system_report_table_filterset.phpnu �[��� <?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\table; use core_table\local\filter\filterset; use core_table\local\filter\integer_filter; use core_table\local\filter\string_filter; /** * System report dynamic table filterset class * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_table_filterset extends filterset { /** * Get the required filters * * @return array. */ public function get_required_filters(): array { return [ 'reportid' => integer_filter::class, 'parameters' => string_filter::class, ]; } } PK a<�\%�a/3 3 % classes/table/system_report_table.phpnu �[��� <?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\table; use action_menu; use action_menu_filler; use core_table\local\filter\filterset; use html_writer; use moodle_exception; use stdClass; use core_reportbuilder\{manager, system_report}; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\column; /** * System report dynamic table class * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_table extends base_report_table { /** @var system_report $report */ protected $report; /** @var string Unique ID prefix for the table */ private const UNIQUEID_PREFIX = 'system-report-table-'; /** * Table constructor. Note that the passed unique ID value must match the pattern "system-report-table-(\d+)" so that * dynamic updates continue to load the same report * * @param string $uniqueid * @param array $parameters * @throws moodle_exception For invalid unique ID */ public function __construct(string $uniqueid, array $parameters = []) { if (!preg_match('/^' . self::UNIQUEID_PREFIX . '(?<id>\d+)$/', $uniqueid, $matches)) { throw new moodle_exception('invalidsystemreportid', 'core_reportbuilder', '', null, $uniqueid); } parent::__construct($uniqueid); // If we are loading via a dynamic table AJAX request, defer the report loading until the filterset is added to // the table, as it is used to populate the report $parameters during construction. $serviceinfo = optional_param('info', null, PARAM_RAW); if ($serviceinfo !== 'core_table_get_dynamic_table_content') { $this->load_report_instance((int) $matches['id'], $parameters); } } /** * Load the report persistent, and accompanying system report instance. * * @param int $reportid * @param array $parameters */ private function load_report_instance(int $reportid, array $parameters): void { global $PAGE; $this->persistent = new report($reportid); $this->report = manager::get_report_from_persistent($this->persistent, $parameters); // TODO: can probably be removed pending MDL-72974. $PAGE->set_context($this->persistent->get_context()); $fields = $this->report->get_base_fields(); $groupby = []; $maintable = $this->report->get_main_table(); $maintablealias = $this->report->get_main_table_alias(); $joins = $this->report->get_joins(); [$where, $params] = $this->report->get_base_condition(); $this->set_attribute('data-region', 'reportbuilder-table'); $this->set_attribute('class', $this->attributes['class'] . ' reportbuilder-table'); // Download options. $this->showdownloadbuttonsat = [TABLE_P_BOTTOM]; $this->is_downloading($parameters['download'] ?? null, $this->report->get_downloadfilename()); // Retrieve all report columns. If we are downloading the report, remove as required. $columns = $this->report->get_active_columns(); if ($this->is_downloading()) { $columns = array_diff_key($columns, array_flip($this->report->get_exclude_columns_for_download())); } // If we are aggregating any columns, we should group by the remaining ones. $aggregatedcolumns = array_filter($columns, static function(column $column): bool { return !empty($column->get_aggregation()); }); $hasaggregatedcolumns = !empty($aggregatedcolumns); if ($hasaggregatedcolumns) { $groupby = $fields; } $columnheaders = $columnsattributes = []; // Check whether report has checkbox toggle defined, note that select all is excluded during download. if (($checkbox = $this->report->get_checkbox_toggleall(true)) && !$this->is_downloading()) { $columnheaders['selectall'] = $PAGE->get_renderer('core')->render($checkbox); $this->no_sorting('selectall'); } $columnindex = 1; foreach ($columns as $identifier => $column) { $column->set_index($columnindex++); $columnheaders[$column->get_column_alias()] = $column->get_title(); // Specify whether column should behave as a user fullname column unless the column has a custom title set. if (preg_match('/^user:fullname.*$/', $column->get_unique_identifier()) && !$column->has_custom_title()) { $this->userfullnamecolumns[] = $column->get_column_alias(); } // We need to determine for each column whether we should group by its fields, to support aggregation. if ($hasaggregatedcolumns && empty($column->get_aggregation())) { $groupby = array_merge($groupby, $column->get_groupby_sql()); } // Add each columns fields, joins and params to our report. $fields = array_merge($fields, $column->get_fields()); $joins = array_merge($joins, $column->get_joins()); $params = array_merge($params, $column->get_params()); // Disable sorting for some columns. if (!$column->get_is_sortable()) { $this->no_sorting($column->get_column_alias()); } // Generate column attributes to be included in each cell. $columnsattributes[$column->get_column_alias()] = $column->get_attributes(); } // If the report has any actions then append appropriate column, note that actions are excluded during download. if ($this->report->has_actions() && !$this->is_downloading()) { $columnheaders['actions'] = html_writer::tag('span', get_string('actions', 'core_reportbuilder'), [ 'class' => 'sr-only', ]); $this->no_sorting('actions'); } $this->define_columns(array_keys($columnheaders)); $this->define_headers(array_values($columnheaders)); // Add column attributes to the table. $this->set_columnsattributes($columnsattributes); // Initial table sort column. if ($sortcolumn = $this->report->get_initial_sort_column()) { $this->sortable(true, $sortcolumn->get_column_alias(), $this->report->get_initial_sort_direction()); } // Table configuration. $this->initialbars(false); $this->collapsible(false); $this->pageable(true); $this->set_default_per_page($this->report->get_default_per_page()); // Initialise table SQL properties. $fieldsql = implode(', ', $fields); $this->init_sql($fieldsql, "{{$maintable}} {$maintablealias}", $joins, $where, $params, $groupby); } /** * Return a new instance of the class for given report ID. We include report parameters here so they are present during * initialisation * * @param int $reportid * @param array $parameters * @return static */ public static function create(int $reportid, array $parameters): self { return new static(self::UNIQUEID_PREFIX . $reportid, $parameters); } /** * Set the filterset in the table class. We set the report parameters here so that they are persisted while paging * * @param filterset $filterset */ public function set_filterset(filterset $filterset): void { $reportid = $filterset->get_filter('reportid')->current(); $parameters = $filterset->get_filter('parameters')->current(); $this->load_report_instance($reportid, json_decode($parameters, true)); parent::set_filterset($filterset); } /** * Override parent method for retrieving row class with that defined by the system report * * @param array|stdClass $row * @return string */ public function get_row_class($row) { return $this->report->get_row_class((object) $row); } /** * Format each row of returned data, executing defined callbacks for the row and each column * * @param array|stdClass $row * @return array */ public function format_row($row) { global $PAGE; $this->report->row_callback((object) $row); // Walk over the row, and for any key that matches one of our column aliases, call that columns format method. $columnsbyalias = $this->report->get_active_columns_by_alias(); $row = (array) $row; array_walk($row, static function(&$value, $key) use ($columnsbyalias, $row): void { if (array_key_exists($key, $columnsbyalias)) { $value = $columnsbyalias[$key]->format_value($row); } }); // Check whether report has checkbox toggle defined. if ($checkbox = $this->report->get_checkbox_toggleall(false, (object) $row)) { $row['selectall'] = $PAGE->get_renderer('core')->render($checkbox); } // Now check for any actions. if ($this->report->has_actions()) { $row['actions'] = $this->format_row_actions((object) $row); } return $row; } /** * Return formatted actions column for the row * * @param stdClass $row * @return string */ private function format_row_actions(stdClass $row): string { global $OUTPUT; $menu = new action_menu(); $menu->set_menu_trigger( $OUTPUT->pix_icon('i/menu', get_string('actions', 'core_reportbuilder')), 'btn btn-icon d-flex align-items-center justify-content-center no-caret', ); $actions = array_filter($this->report->get_actions(), function($action) use ($row) { // Only return dividers and action items who can be displayed for current users. return $action instanceof action_menu_filler || $action->get_action_link($row); }); $totalactions = count($actions); $actionvalues = array_values($actions); foreach ($actionvalues as $position => $action) { if ($action instanceof action_menu_filler) { $ispreviousdivider = array_key_exists($position - 1, $actionvalues) && ($actionvalues[$position - 1] instanceof action_menu_filler); $isnextdivider = array_key_exists($position + 1, $actionvalues) && ($actionvalues[$position + 1] instanceof action_menu_filler); $isfirstdivider = ($position === 0); $islastdivider = ($position === $totalactions - 1); // Avoid add divider at last/first position and having multiple fillers in a row. if ($ispreviousdivider || $isnextdivider || $isfirstdivider || $islastdivider) { continue; } $actionlink = $action; } else { // Ensure the action link can be displayed for the current row. $actionlink = $action->get_action_link($row); } if ($actionlink) { $menu->add($actionlink); } } return $OUTPUT->render($menu); } /** * Get the html for the download buttons * * @return string */ public function download_buttons(): string { global $OUTPUT; if ($this->report->can_be_downloaded() && !$this->is_downloading()) { return $OUTPUT->download_dataformat_selector( get_string('downloadas', 'table'), new \moodle_url('/reportbuilder/download.php'), 'download', [ 'id' => $this->persistent->get('id'), 'parameters' => json_encode($this->report->get_parameters()), ] ); } return ''; } /** * Check if the user has the capability to access this table. * * @return bool Return true if capability check passed. */ public function has_capability(): bool { try { $this->report->require_can_view(); return true; } catch (\core_reportbuilder\exception\report_access_exception $e) { return false; } } } PK a<�\�#� � * classes/table/custom_report_table_view.phpnu �[��� <?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\table; use moodle_url; /** * Custom report view dynamic table class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_table_view extends custom_report_table { /** @var bool We're pre/viewing the report, not editing it */ protected const REPORT_EDITING = false; /** * Override printed headers, to use those of grandparent class */ public function print_headers() { $columns = $this->get_active_columns(); if (empty($columns)) { return; } base_report_table::print_headers(); } /** * Override base implementation, return pagesize as defined in table filterset * * @return int */ public function get_default_per_page(): int { $filterset = $this->get_filterset(); return $filterset->get_filter('pagesize')->current(); } /** * Get the html for the download buttons * * @return string */ public function download_buttons(): string { global $OUTPUT; if (!$this->is_downloading()) { return $OUTPUT->download_dataformat_selector( get_string('downloadas', 'table'), new moodle_url('/reportbuilder/download.php'), 'download', ['id' => $this->persistent->get('id')] ); } return ''; } /** * Check if the user has the capability to access this table. * * @return bool Return true if capability check passed. */ public function has_capability(): bool { return \core_reportbuilder\permission::can_view_report($this->persistent); } } PK a<�\�%��3 3 4 classes/table/custom_report_table_view_filterset.phpnu �[��� <?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\table; use core_table\local\filter\filterset; use core_table\local\filter\integer_filter; /** * Custom report dynamic table filterset class * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_report_table_view_filterset extends filterset { /** * Get the required filters * * @return array. */ public function get_required_filters(): array { return [ 'pagesize' => integer_filter::class, ]; } } PK a<�\[D�Z Z classes/form/card_view.phpnu �[��� <?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\form; use context; use moodle_url; use core_form\dynamic_form; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\report\base; use core_reportbuilder\local\models\report; /** * Card view dynamic form * * @package core_reportbuilder * @copyright 2021 Mikel Martín <mikel@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class card_view extends dynamic_form { /** * Return instance of the report using the card view form * * @return base */ private function get_report(): base { $report = new report($this->optional_param('reportid', 0, PARAM_INT)); $parameters = (array) json_decode($this->optional_param('parameters', '', PARAM_RAW)); return manager::get_report_from_persistent($report, $parameters); } /** * Returns context where this form is used * * @return context */ protected function get_context_for_dynamic_submission(): context { return $this->get_report()->get_context(); } /** * Check if current user has access to this form, otherwise throw exception */ public function check_access_for_dynamic_submission(): void { permission::require_can_edit_report($this->get_report()->get_report_persistent()); } /** * Store the conditions values and operators * * @return bool */ public function process_dynamic_submission(): bool { $values = $this->get_data(); $settings = [ 'cardview_showfirsttitle' => (int)$values->showfirsttitle, // Minimum value for 'cardview_visiblecolumns' should be 1. 'cardview_visiblecolumns' => max((int)$values->visiblecolumns, 1) ]; return $this->get_report()->set_settings_values($settings); } /** * Load in existing data as form defaults */ public function set_data_for_dynamic_submission(): void { $report = $this->get_report(); $settings = $report->get_settings_values(); $defaults = [ // Maximum value for 'cardview_visiblecolumns' should be the report total number of columns. 'visiblecolumns' => min($settings['cardview_visiblecolumns'] ?? 1, count($report->get_active_columns())), 'showfirsttitle' => $settings['cardview_showfirsttitle'] ?? 0, ]; $this->set_data(array_merge($defaults, $this->_ajaxformdata)); } /** * Returns url to set in $PAGE->set_url() when form is being rendered or submitted via AJAX * * @return moodle_url */ protected function get_page_url_for_dynamic_submission(): moodle_url { return new moodle_url('/reportbuilder/edit.php'); } /** * Card view form definition */ public function definition(): void { $report = $this->get_report(); $mform = $this->_form; $mform->addElement('hidden', 'reportid'); $mform->setType('reportid', PARAM_INT); // Generate select options from 1 to report total number of columns. $visiblecolumns = range(1, max(count($report->get_active_columns()), 1)); $mform->addElement('select', 'visiblecolumns', get_string('cardviewvisiblecolumns', 'core_reportbuilder'), array_combine($visiblecolumns, $visiblecolumns)); $mform->setType('visiblecolumns', PARAM_INT); $mform->addElement('selectyesno', 'showfirsttitle', get_string('cardviewfirstcolumntitle', 'core_reportbuilder')); $mform->setType('showfirsttitle', PARAM_BOOL); $mform->disable_form_change_checker(); $this->add_action_buttons(false); } } PK a<�\� �~�% �% classes/form/schedule.phpnu �[��� <?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\form; use context; use core_user; use html_writer; use moodle_url; use core\output\notification; use core_form\dynamic_form; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\helpers\audience; use core_reportbuilder\local\helpers\schedule as helper; use core_reportbuilder\local\models\schedule as model; use core_reportbuilder\local\report\base; /** * Schedule form * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class schedule extends dynamic_form { /** * Return instance of the system report using the filter form * * @return base */ private function get_report(): base { $reportid = $this->optional_param('reportid', 0, PARAM_INT); return manager::get_report_from_id($reportid); } /** * Return the context for the form, it should be that of the report itself * * @return context */ protected function get_context_for_dynamic_submission(): context { return $this->get_report()->get_context(); } /** * Ensure current user is able to use this form * * A {@see \core_reportbuilder\exception\report_access_exception} will be thrown if they can't */ protected function check_access_for_dynamic_submission(): void { $persistent = $this->get_report()->get_report_persistent(); permission::require_can_edit_report($persistent); } /** * Form definition */ protected function definition() { global $OUTPUT; $mform = $this->_form; $mform->addElement('hidden', 'reportid'); $mform->setType('reportid', PARAM_INT); $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); // General fields. $mform->addElement('header', 'headergeneral', get_string('general')); $mform->addElement('text', 'name', get_string('name')); $mform->setType('name', PARAM_TEXT); $mform->addRule('name', null, 'required', null, 'client'); $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255); $mform->addElement('select', 'format', get_string('format'), helper::get_format_options()); $mform->setType('format', PARAM_PLUGIN); $mform->addElement('date_time_selector', 'timescheduled', get_string('startingfrom'), ['optional' => false]); $mform->setType('timescheduled', PARAM_INT); $mform->addElement('select', 'recurrence', get_string('recurrence', 'core_reportbuilder'), helper::get_recurrence_options()); $mform->setType('recurrence', PARAM_INT); // View report data as. $context = $this->get_context_for_dynamic_submission(); if (has_capability('moodle/reportbuilder:scheduleviewas', $context)) { $mform->addElement('select', 'userviewas', get_string('scheduleviewas', 'core_reportbuilder'), helper::get_viewas_options()); $mform->setType('userviewas', PARAM_INT); $options = [ 'ajax' => 'core_user/form_user_selector', 'multiple' => false, 'valuehtmlcallback' => function($userid) use ($context): string { $user = core_user::get_user($userid); return fullname($user, has_capability('moodle/site:viewfullnames', $context)); } ]; $mform->addElement('autocomplete', 'user', get_string('user'), [], $options)->setHiddenLabel(true); $mform->hideIf('user', 'userviewas', 'neq', model::REPORT_VIEWAS_USER); } // Audience fields. $mform->addElement('header', 'headeraudience', get_string('audience', 'core_reportbuilder')); $mform->setExpanded('headeraudience', true); $audiences = audience::get_base_records($this->optional_param('reportid', 0, PARAM_INT)); if (empty($audiences)) { $notification = new notification(get_string('noaudiences', 'core_reportbuilder'), notification::NOTIFY_INFO, false); $mform->addElement('static', 'noaudiences', '', $OUTPUT->render($notification)); } $audiencecheckboxes = []; foreach ($audiences as $audience) { $persistent = $audience->get_persistent(); // Check for a custom name, otherwise fall back to default. if ('' === $audiencelabel = $persistent->get_formatted_heading($context)) { $audiencelabel = get_string('audiencelabel', 'core_reportbuilder', (object) [ 'name' => $audience->get_name(), 'description' => $audience->get_description(), ]); } $audiencecheckboxes[] = $mform->createElement('checkbox', $persistent->get('id'), $audiencelabel); } $mform->addElement('group', 'audiences', '', $audiencecheckboxes, html_writer::div('', 'w-100 mb-2')); // Message fields. $mform->addElement('header', 'headermessage', get_string('messagecontent', 'core_reportbuilder')); $mform->addElement('text', 'subject', get_string('messagesubject', 'core_reportbuilder')); $mform->setType('subject', PARAM_TEXT); $mform->addRule('subject', null, 'required', null, 'client'); $mform->addRule('subject', get_string('maximumchars', '', 255), 'maxlength', 255); $mform->addElement('editor', 'message', get_string('messagebody', 'core_reportbuilder'), null, ['autosave' => false]); $mform->setType('message', PARAM_RAW); $mform->addRule('message', null, 'required', null, 'client'); // Advanced. $mform->addElement('header', 'headeradvanced', get_string('advanced')); $mform->addElement('select', 'reportempty', get_string('scheduleempty', 'core_reportbuilder'), helper::get_report_empty_options()); $mform->setType('reportempty', PARAM_INT); } /** * Load form data if we are editing an existing schedule */ public function set_data_for_dynamic_submission(): void { $reportid = $this->optional_param('reportid', 0, PARAM_INT); $scheduleid = $this->optional_param('id', 0, PARAM_INT); if ($scheduleid > 0) { $schedule = model::get_record(['id' => $scheduleid, 'reportid' => $reportid]); $data = (array) $schedule->to_record(); // Pre-process some of the form fields. if (!in_array($data['userviewas'], [model::REPORT_VIEWAS_CREATOR, model::REPORT_VIEWAS_RECIPIENT])) { $data['user'] = $data['userviewas']; $data['userviewas'] = model::REPORT_VIEWAS_USER; } $audiences = json_decode($data['audiences']); $data['audiences'] = array_fill_keys($audiences, 1); $data['message'] = [ 'text' => $data['message'], 'format' => $data['messageformat'], ]; $this->set_data($data); } else { $this->set_data(['reportid' => $reportid]); } } /** * Form validation * * @param array $data * @param array $files * @return array */ public function validation($data, $files): array { $errors = parent::validation($data, $files); if (trim($data['name']) === '') { $errors['name'] = get_string('required'); } // Make sure specific user was selected, if required. if (array_key_exists('userviewas', $data) && (int) $data['userviewas'] === model::REPORT_VIEWAS_USER && empty($data['user'])) { $errors['user'] = get_string('required'); } if (empty($data['audiences'])) { $errors['audiences'] = get_string('required'); } return $errors; } /** * Process form submission */ public function process_dynamic_submission(): void { $data = $this->get_data(); // Pre-process some of the form fields. if (property_exists($data, 'userviewas') && (int) $data->userviewas === model::REPORT_VIEWAS_USER) { $data->userviewas = (int) $data->user; } $data->audiences = json_encode(array_keys($data->audiences)); ['text' => $data->message, 'format' => $data->messageformat] = $data->message; if ($data->id) { helper::update_schedule($data); } else { helper::create_schedule($data); } } /** * URL of the page using this form * * @return moodle_url */ protected function get_page_url_for_dynamic_submission(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->optional_param('reportid', 0, PARAM_INT)], 'schedules'); } } PK a<�\��: : classes/form/report.phpnu �[��� <?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\form; use context; use context_system; use core_reportbuilder\permission; use moodle_url; use core_form\dynamic_form; use core_reportbuilder\datasource; use core_reportbuilder\manager; use core_reportbuilder\local\helpers\report as reporthelper; use core_tag_tag; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("$CFG->libdir/formslib.php"); /** * Report details form * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report extends dynamic_form { /** * Return instance of the custom report we are editing, or null when creating a new report * * @return datasource|null */ protected function get_custom_report(): ?datasource { if ($reportid = $this->optional_param('id', 0, PARAM_INT)) { /** @var datasource $customreport */ $customreport = manager::get_report_from_id($reportid); return $customreport; } return null; } /** * Return the context for the form, it should be that of the custom report itself, or system when creating a new report * * @return context */ public function get_context_for_dynamic_submission(): context { if ($report = $this->get_custom_report()) { return $report->get_context(); } else { return context_system::instance(); } } /** * Ensure current user is able to use this form * * A {@see \core_reportbuilder\exception\report_access_exception} will be thrown if they can't */ protected function check_access_for_dynamic_submission(): void { $report = $this->get_custom_report(); if ($report) { permission::require_can_edit_report($report->get_report_persistent()); } else { permission::require_can_create_report(); } } /** * Form definition */ public function definition() { $mform = $this->_form; $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); $mform->addElement('text', 'name', get_string('name')); $mform->setType('name', PARAM_TEXT); $mform->addRule('name', null, 'required', null, 'client'); $mform->addRule('name', get_string('maximumchars', '', 255), 'maxlength', 255); // Allow user to select report source if creating a new report. if (!$this->get_custom_report()) { $default = ['' => ['' => get_string('selectareportsource', 'core_reportbuilder')]]; $mform->addElement('selectgroups', 'source', get_string('reportsource', 'core_reportbuilder'), array_merge($default, manager::get_report_datasources())); $mform->addRule('source', null, 'required', null, 'client'); $mform->addHelpButton('source', 'reportsource', 'core_reportbuilder'); $mform->addElement('advcheckbox', 'includedefaultsetup', get_string('includedefaultsetup', 'core_reportbuilder')); $mform->setDefault('includedefaultsetup', 1); $mform->addHelpButton('includedefaultsetup', 'includedefaultsetup', 'core_reportbuilder'); } $mform->addElement('advcheckbox', 'uniquerows', get_string('uniquerows', 'core_reportbuilder')); $mform->addHelpButton('uniquerows', 'uniquerows', 'core_reportbuilder'); $mform->addElement('tags', 'tags', get_string('tags'), [ 'component' => 'core_reportbuilder', 'itemtype' => 'reportbuilder_report', ]); } /** * Process the form submission * * @return string The URL to advance to upon completion */ public function process_dynamic_submission() { $data = $this->get_data(); if ($data->id) { $reportpersistent = reporthelper::update_report($data); } else { $reportpersistent = reporthelper::create_report($data, (bool)$data->includedefaultsetup); } return (new moodle_url('/reportbuilder/edit.php', ['id' => $reportpersistent->get('id')]))->out(false); } /** * Load in existing data as form defaults */ public function set_data_for_dynamic_submission(): void { if ($persistent = $this->get_custom_report()?->get_report_persistent()) { $tags = core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $persistent->get('id')); $this->set_data(array_merge((array) $persistent->to_record(), ['tags' => $tags])); } } /** * URL of the page using this form * * @return moodle_url */ public function get_page_url_for_dynamic_submission(): moodle_url { return new moodle_url('/reportbuilder/index.php'); } /** * Perform some extra moodle validation * * @param array $data * @param array $files * @return array */ public function validation($data, $files): array { $errors = []; if (trim($data['name']) === '') { $errors['name'] = get_string('required'); } return $errors; } } PK a<�\W�7� � classes/form/audience.phpnu �[��� <?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\form; use context; use core_form\dynamic_form; use core_reportbuilder\local\audiences\base; use core_reportbuilder\output\audience_heading_editable; use core_reportbuilder\permission; use moodle_url; use stdClass; /** * Dynamic audience form * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class audience extends dynamic_form { /** * Audience we work with * * @return base */ protected function get_audience(): base { $id = $this->optional_param('id', 0, PARAM_INT); $record = new stdClass(); if (!$id) { // New instance, pre-define report id and classname. $record->reportid = $this->optional_param('reportid', null, PARAM_INT); $record->classname = $this->optional_param('classname', null, PARAM_RAW_TRIMMED); } return base::instance($id, $record); } /** * Form definition. */ public function definition() { $mform = $this->_form; $mform->addElement('hidden', 'id'); $mform->setType('id', PARAM_INT); $mform->addElement('hidden', 'reportid'); $mform->setType('reportid', PARAM_INT); $mform->addElement('hidden', 'classname'); $mform->setType('classname', PARAM_RAW_TRIMMED); // Embed form defined in audience class. $audience = $this->get_audience(); $audience->get_config_form($mform); $this->add_action_buttons(); } /** * Form validation. * * @param array $data array of ("fieldname"=>value) of submitted data * @param array $files array of uploaded files "element_name"=>tmp_file_path * @return array of "element_name"=>"error_description" if there are errors, * or an empty array if everything is OK (true allowed for backwards compatibility too). */ public function validation($data, $files) { $audience = $this->get_audience(); return $audience->validate_config_form($data); } /** * Returns context where this form is used * * @return context */ protected function get_context_for_dynamic_submission(): context { return $this->get_audience()->get_persistent()->get_report()->get_context(); } /** * Ensure current user is able to use this form * * A {@see \core_reportbuilder\exception\report_access_exception} will be thrown if they can't */ protected function check_access_for_dynamic_submission(): void { $audience = $this->get_audience(); $report = $audience->get_persistent()->get_report(); permission::require_can_edit_report($report); // Check whether we are able to add/edit the current audience. $audience->get_persistent()->get('id') === 0 ? $audience->require_user_can_add() : $audience->require_user_can_edit(); } /** * Process the form submission, used if form was submitted via AJAX */ public function process_dynamic_submission() { global $PAGE; $formdata = $this->get_data(); $audience = $this->get_audience(); $configdata = $audience::retrieve_configdata($formdata); if (!$formdata->id) { // New audience. $audience = $audience::create($formdata->reportid, $configdata); } else { // Editing audience. $audience->update_configdata($configdata); } $persistent = $audience->get_persistent(); $editable = new audience_heading_editable(0, $persistent); return [ 'instanceid' => $persistent->get('id'), 'heading' => $editable->render($PAGE->get_renderer('core')), 'description' => $audience->get_description(), ]; } /** * Load in existing data as form defaults */ public function set_data_for_dynamic_submission(): void { $audience = $this->get_audience(); $persistent = $audience->get_persistent(); // Populate form data based on whether we are editing/creating an audience. if ($persistent->get('id') !== 0) { $formdata = [ 'id' => $persistent->get('id'), 'reportid' => $persistent->get('reportid'), 'classname' => $persistent->get('classname'), ] + $audience->get_configdata(); } else { $formdata = [ 'reportid' => $this->optional_param('reportid', null, PARAM_INT), 'classname' => $this->optional_param('classname', null, PARAM_RAW_TRIMMED), ]; } $this->set_data($formdata); } /** * Page url * * @return moodle_url */ protected function get_page_url_for_dynamic_submission(): moodle_url { return new moodle_url('/reportbuilder/edit.php', ['id' => $this->optional_param('reportid', 0, PARAM_INT)]); } } PK a<�\�2�4i i classes/form/filter.phpnu �[��� <?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\form; use context; use core_reportbuilder\local\report\base; use core_reportbuilder\permission; use moodle_url; use core_form\dynamic_form; use core_reportbuilder\manager; use core_reportbuilder\local\models\report; use core_reportbuilder\local\models\filter as filter_model; /** * Dynamic filter form * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class filter extends dynamic_form { /** * Return instance of the system report using the filter form * * @return base */ private function get_report(): base { $reportpersistent = new report($this->optional_param('reportid', 0, PARAM_INT)); $parameters = (array) json_decode($this->optional_param('parameters', '', PARAM_RAW)); return manager::get_report_from_persistent($reportpersistent, $parameters); } /** * Return the context for the form, it should be that of the system report itself * * @return context */ protected function get_context_for_dynamic_submission(): context { return ($this->get_report())->get_context(); } /** * Ensure current user is able to use this form * * A {@see \core_reportbuilder\exception\report_access_exception} will be thrown if they can't */ protected function check_access_for_dynamic_submission(): void { $reportpersistent = $this->get_report()->get_report_persistent(); if ($reportpersistent->get('type') === base::TYPE_CUSTOM_REPORT) { permission::require_can_view_report($reportpersistent); } else { $this->get_report()->require_can_view(); } } /** * Process the form submission * * @return int Number of applied filter instances */ public function process_dynamic_submission() { $values = $this->get_data(); // Remove some unneeded fields, apply filters. unset($values->reportid, $values->parameters); $this->get_report()->set_filter_values((array) $values); return $this->get_report()->get_applied_filter_count(); } /** * Load in existing data as form defaults */ public function set_data_for_dynamic_submission(): void { $defaults = [ 'reportid' => $this->optional_param('reportid', 0, PARAM_INT), 'parameters' => $this->optional_param('parameters', 0, PARAM_RAW), ]; $this->set_data(array_merge($defaults, $this->get_report()->get_filter_values())); } /** * URL of the page using this form * * @return moodle_url */ protected function get_page_url_for_dynamic_submission(): moodle_url { return new moodle_url('/'); } /** * Filter form definition. It should provide necessary field itself, then allow all report filters to add their own elements */ protected function definition() { global $OUTPUT; $mform = $this->_form; $mform->addElement('hidden', 'reportid'); $mform->setType('reportid', PARAM_INT); $mform->addElement('hidden', 'parameters'); $mform->setType('parameters', PARAM_RAW); // Allow each filter instance to add itself to this form, wrapping each inside custom header/footer template. $filterinstances = $this->get_report()->get_filter_instances(); foreach ($filterinstances as $filterinstance) { $header = $filterinstance->get_header(); // Check if filter has a custom header set. if ($persistent = $filterinstance->get_filter_persistent()) { if ('' !== (string) $persistent->get('heading')) { $header = $persistent->get_formatted_heading($this->get_report()->get_context()); } } $mform->addElement('html', $OUTPUT->render_from_template('core_reportbuilder/local/filters/header', [ 'name' => $header, ])); $filterinstance->setup_form($mform); $mform->addElement('html', $OUTPUT->render_from_template('core_reportbuilder/local/filters/footer', [])); } $this->set_display_vertical(); // We'll add a second submit button to the form that will be used to reset current report filters. $mform->registerNoSubmitButton('resetfilters'); $buttons = []; $buttons[] = $mform->createElement('submit', 'submitbutton', get_string('apply', 'core_reportbuilder')); $buttons[] = $mform->createElement('submit', 'resetfilters', get_string('resetall', 'core_reportbuilder'), null, null, ['customclassoverride' => 'btn-link ms-1']); $mform->addGroup($buttons, 'buttonar', get_string('formactions', 'core_form'), '', false) ->setHiddenLabel(true); $mform->closeHeaderBefore('buttonar'); $mform->disable_form_change_checker(); } } PK a<�\�ਚ � classes/form/condition.phpnu �[��� <?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\form; use context; use moodle_url; use core_form\dynamic_form; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\local\report\base; use core_reportbuilder\local\models\report; /** * Dynamic condition form * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class condition extends dynamic_form { /** * Return instance of the report using the condition form * * @return base */ private function get_report(): base { $report = new report($this->optional_param('reportid', 0, PARAM_INT)); $parameters = (array) json_decode($this->optional_param('parameters', '', PARAM_RAW)); return manager::get_report_from_persistent($report, $parameters); } /** * Return the context for the form, it should be that of the system report itself * * @return context */ protected function get_context_for_dynamic_submission(): context { return $this->get_report()->get_context(); } /** * Ensure current user is able to use this form * * A {@see \core_reportbuilder\exception\report_access_exception} will be thrown if they can't */ protected function check_access_for_dynamic_submission(): void { permission::require_can_edit_report($this->get_report()->get_report_persistent()); } /** * Process the form submission * * @return bool */ public function process_dynamic_submission() { $values = $this->get_data(); // Remove some unneeded fields. unset($values->reportid, $values->parameters); return $this->get_report()->set_condition_values((array) $values); } /** * Load in existing data as form defaults */ public function set_data_for_dynamic_submission(): void { $defaults = [ 'reportid' => $this->optional_param('reportid', 0, PARAM_INT), 'parameters' => $this->optional_param('parameters', 0, PARAM_RAW), ]; $this->set_data(array_merge($defaults, $this->get_report()->get_condition_values())); } /** * URL of the page using this form * * @return moodle_url */ protected function get_page_url_for_dynamic_submission(): moodle_url { return new moodle_url('/'); } /** * Condition form definition */ protected function definition() { global $OUTPUT; $mform = $this->_form; $mform->addElement('hidden', 'reportid'); $mform->setType('reportid', PARAM_INT); $mform->addElement('hidden', 'parameters'); $mform->setType('parameters', PARAM_RAW); // Wrap the form elements inside an outer container, as drag/drop requires draggable elements to be immediate // descendants of said container. Note this is identified by it's data-region property in the editor module. $mform->addElement('html', '<div class="list-group mt-2" data-region="active-conditions">'); // Allow each condition instance to add itself to this form, wrapping each inside custom header/footer template. $conditioninstances = $this->get_report()->get_condition_instances(); foreach ($conditioninstances as $conditioninstance) { $persistent = $conditioninstance->get_filter_persistent(); $entityname = $conditioninstance->get_entity_name(); $displayvalue = $conditioninstance->get_header(); $mform->addElement('html', $OUTPUT->render_from_template('core_reportbuilder/local/conditions/header', [ 'id' => $persistent->get('id'), 'entityname' => $this->get_report()->get_entity_title($entityname), 'heading' => $displayvalue, 'sortorder' => $persistent->get('filterorder'), 'movetitle' => get_string('movecondition', 'core_reportbuilder', $displayvalue), ])); $conditioninstance->setup_form($mform); $mform->addElement('html', $OUTPUT->render_from_template('core_reportbuilder/local/conditions/footer', [])); } $mform->addElement('html', '</div>'); $this->set_display_vertical(); // We'll add a second submit button to the form that will be used to reset current report conditions. $mform->registerNoSubmitButton('resetconditions'); $buttons = []; $buttons[] = $mform->createElement('submit', 'submitbutton', get_string('apply', 'core_reportbuilder')); $buttons[] = $mform->createElement('submit', 'resetconditions', get_string('resetall', 'core_reportbuilder'), null, null, ['customclassoverride' => 'btn-link ms-1']); $mform->addGroup($buttons, 'buttonar', get_string('formactions', 'core_form'), '', false) ->setHiddenLabel(true); $mform->closeHeaderBefore('buttonar'); $mform->disable_form_change_checker(); } } PK a<�\�U�u�. �. classes/local/entities/base.phpnu �[��� <?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\local\entities; use coding_exception; use core_reportbuilder\local\helpers\{database, join_trait}; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; use lang_string; /** * Base class for all report entities * * @package core_reportbuilder * @copyright 2019 Marina Glancy <marina@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class base { use join_trait; /** @var string $entityname Internal reference to name of entity */ private $entityname = null; /** @var lang_string $entitytitle Used as a title for the entity in reports */ private $entitytitle = null; /** @var array $tablealiases Database tables that this entity uses and their aliases */ private $tablealiases = []; /** @var array $tablejoinaliases Database tables that have already been joined to the report and their aliases */ private $tablejoinaliases = []; /** @var column[] $columns List of columns for the entity */ private $columns = []; /** @var filter[] $filters List of filters for the entity */ private $filters = []; /** @var filter[] $conditions List of conditions for the entity */ private $conditions = []; /** * Database tables that this entity uses * * Must be overridden by the entity to list all database tables that it expects to be present in the main * SQL or in JOINs added to this entity * * @todo in Moodle 4.8 - make abstract when support for {@see get_default_table_aliases} is finally removed * * @return string[] */ protected function get_default_tables(): array { static $debuggingshown; // The default implementation falls back to retrieving deprecated table aliases to determine our table names. $tablenamealiases = $this->get_default_table_aliases(); if (!empty($tablenamealiases) && !$debuggingshown) { debugging('The function get_default_table_aliases() is deprecated, please define the entity' . ' tables with get_default_tables() in ' . static::class, DEBUG_DEVELOPER); // Don't be too spammy with the debugging, this method is called multiple times per entity load. $debuggingshown = true; } return array_keys($tablenamealiases); } /** * Database tables that this entity uses and their default aliases (note that these aliases are now ignored) * * @return string[] Array of $tablename => $alias * * @deprecated since Moodle 4.4 - aliases are now autogenerated, please implement {@see get_default_tables} instead */ protected function get_default_table_aliases(): array { return []; } /** * The default title for this entity * * @return lang_string */ abstract protected function get_default_entity_title(): lang_string; /** * Initialise the entity, called automatically when it is added to a report * * This is where entity defines all its columns and filters by calling: * - {@see add_column} * - {@see add_filter} * - etc * * @return self */ abstract public function initialise(): self; /** * The default machine-readable name for this entity that will be used in the internal names of the columns/filters * * @return string */ private function get_default_entity_name(): string { $namespace = explode('\\', get_called_class()); return end($namespace); } /** * Set entity name * * @param string $entityname * @return self */ final public function set_entity_name(string $entityname): self { $this->entityname = $entityname; return $this; } /** * Return entity name * * @return string */ final public function get_entity_name(): string { return $this->entityname ?? $this->get_default_entity_name(); } /** * Set entity title * * @param lang_string $title * @return self */ final public function set_entity_title(lang_string $title): self { $this->entitytitle = $title; return $this; } /** * Get entity title * * @return lang_string */ final public function get_entity_title(): lang_string { return $this->entitytitle ?? $this->get_default_entity_title(); } /** * Override the default alias for given database table used in entity queries, for instance when the same table is used * by multiple entities and you want them each to refer to it by the same alias * * @param string $tablename One of the tables set by {@see get_default_tables} * @param string $alias * @return self * @throws coding_exception For invalid table name */ final public function set_table_alias(string $tablename, string $alias): self { $tablenames = $this->get_default_tables(); if (!in_array($tablename, $tablenames)) { throw new coding_exception('Invalid table name', $tablename); } $this->tablealiases[$tablename] = $alias; return $this; } /** * Override multiple default database table aliases used in entity queries as per {@see set_table_alias} * * @param array $aliases Array of tablename => alias values * @return self */ final public function set_table_aliases(array $aliases): self { foreach ($aliases as $tablename => $alias) { $this->set_table_alias($tablename, $alias); } return $this; } /** * Returns an alias used in the queries for a given table * * @param string $tablename One of the tables set by {@see get_default_tables} * @return string * @throws coding_exception For invalid table name */ final public function get_table_alias(string $tablename): string { $tablenames = $this->get_default_tables(); if (!in_array($tablename, $tablenames)) { throw new coding_exception('Invalid table name', $tablename); } // We don't have the alias yet, generate a new one. if (!array_key_exists($tablename, $this->tablealiases)) { $this->set_table_alias($tablename, database::generate_alias()); } return $this->tablealiases[$tablename]; } /** * Returns aliases used in the queries for all tables * * @return string[] */ final public function get_table_aliases(): array { $tablenames = $this->get_default_tables(); return array_combine($tablenames, array_map([$this, 'get_table_alias'], $tablenames)); } /** * Set the alias for given database table that has already been added to the report. Enables entities to avoid additional * joins on the same table by allowing re-use of existing table aliases in their own queries, {@see has_table_join_alias} * * @param string $tablename * @param string $alias * @return self */ final public function set_table_join_alias(string $tablename, string $alias): self { $this->tablejoinaliases[$tablename] = $alias; // Internally set the same table alias for the entity. return $this->set_table_alias($tablename, $alias); } /** * Determine whether defined table join alias was specified. Call {@see get_table_alias} to retrieve said value * * @param string $tablename * @return bool */ final public function has_table_join_alias(string $tablename): bool { return array_key_exists($tablename, $this->tablejoinaliases); } /** * Helper method for returning joins necessary for retrieving tags related to the current entity * * Both 'tag' and 'tag_instance' aliases must be returned by the entity {@see get_default_tables} method * * @param string $component * @param string $itemtype * @param string $itemidfield * @return string[] */ final protected function get_tag_joins_for_entity(string $component, string $itemtype, string $itemidfield): array { $taginstancealias = $this->get_table_alias('tag_instance'); $tagalias = $this->get_table_alias('tag'); return [ "LEFT JOIN {tag_instance} {$taginstancealias} ON {$taginstancealias}.component = '{$component}' AND {$taginstancealias}.itemtype = '{$itemtype}' AND {$taginstancealias}.itemid = {$itemidfield}", "LEFT JOIN {tag} {$tagalias} ON {$tagalias}.id = {$taginstancealias}.tagid", ]; } /** * Add a column to the entity * * @param column $column * @return self */ final protected function add_column(column $column): self { $this->columns[$column->get_name()] = $column; return $this; } /** * Returns entity columns * * @return column[] */ final public function get_columns(): array { return $this->columns; } /** * Returns an entity column * * @param string $name * @return column * @throws coding_exception For invalid column name */ final public function get_column(string $name): column { if (!array_key_exists($name, $this->columns)) { throw new coding_exception('Invalid column name', $name); } return $this->columns[$name]; } /** * Add a filter to the entity * * @param filter $filter * @return self */ final protected function add_filter(filter $filter): self { $this->filters[$filter->get_name()] = $filter; return $this; } /** * Returns entity filters * * @return filter[] */ final public function get_filters(): array { return $this->filters; } /** * Returns an entity filter * * @param string $name * @return filter * @throws coding_exception For invalid filter name */ final public function get_filter(string $name): filter { if (!array_key_exists($name, $this->filters)) { throw new coding_exception('Invalid filter name', $name); } return $this->filters[$name]; } /** * Add a condition to the entity * * @param filter $condition * @return $this */ final protected function add_condition(filter $condition): self { $this->conditions[$condition->get_name()] = $condition; return $this; } /** * Returns entity conditions * * @return filter[] */ final public function get_conditions(): array { return $this->conditions; } /** * Returns an entity condition * * @param string $name * @return filter * @throws coding_exception For invalid condition name */ final public function get_condition(string $name): filter { if (!array_key_exists($name, $this->conditions)) { throw new coding_exception('Invalid condition name', $name); } return $this->conditions[$name]; } } PK a<�\�_��5V 5V classes/local/entities/user.phpnu �[��� <?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\local\entities; use context_helper; use context_system; use context_user; use core\context; use core_component; use core_date; use core_user; use html_writer; use lang_string; use moodle_url; use stdClass; use theme_config; use core_user\fields; use core_reportbuilder\local\filters\boolean_select; use core_reportbuilder\local\filters\date; use core_reportbuilder\local\filters\select; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\filters\user as user_filter; use core_reportbuilder\local\helpers\user_profile_fields; use core_reportbuilder\local\helpers\format; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; /** * User entity class implementation. * * This entity defines all the user columns and filters to be used in any report. * * @package core_reportbuilder * @copyright 2020 Sara Arjona <sara@moodle.com> based on Marina Glancy code. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user extends base { /** * Database tables that this entity uses * * @return string[] */ protected function get_default_tables(): array { return [ 'user', 'context', 'tag_instance', 'tag', ]; } /** * The default title for this entity * * @return lang_string */ protected function get_default_entity_title(): lang_string { return new lang_string('entityuser', 'core_reportbuilder'); } /** * Initialise the entity * * @return base */ public function initialise(): base { $tablealias = $this->get_table_alias('user'); $userprofilefields = (new user_profile_fields( "{$tablealias}.id", $this->get_entity_name(), )) ->add_joins($this->get_joins()); $columns = array_merge($this->get_all_columns(), $userprofilefields->get_columns()); foreach ($columns as $column) { $this->add_column($column); } // All the filters defined by the entity can also be used as conditions. $filters = array_merge($this->get_all_filters(), $userprofilefields->get_filters()); foreach ($filters as $filter) { $this ->add_condition($filter) ->add_filter($filter); } return $this; } /** * Returns column that corresponds to the given identity field, profile field identifiers will be converted to those * used by the {@see user_profile_fields} helper * * @param string $identityfield Field from the user table, or a custom profile field * @return column */ public function get_identity_column(string $identityfield): column { if (preg_match(fields::PROFILE_FIELD_REGEX, $identityfield, $matches)) { $identityfield = 'profilefield_' . $matches[1]; } return $this->get_column($identityfield); } /** * Returns columns that correspond to the site configured identity fields * * @param context $context * @param string[] $excluding * @return column[] */ public function get_identity_columns(context $context, array $excluding = []): array { $identityfields = fields::for_identity($context)->excluding(...$excluding)->get_required_fields(); return array_map([$this, 'get_identity_column'], $identityfields); } /** * Returns filter that corresponds to the given identity field, profile field identifiers will be converted to those * used by the {@see user_profile_fields} helper * * @param string $identityfield Field from the user table, or a custom profile field * @return filter */ public function get_identity_filter(string $identityfield): filter { if (preg_match(fields::PROFILE_FIELD_REGEX, $identityfield, $matches)) { $identityfield = 'profilefield_' . $matches[1]; } return $this->get_filter($identityfield); } /** * Returns filters that correspond to the site configured identity fields * * @param context $context * @param string[] $excluding * @return filter[] */ public function get_identity_filters(context $context, array $excluding = []): array { $identityfields = fields::for_identity($context)->excluding(...$excluding)->get_required_fields(); return array_map([$this, 'get_identity_filter'], $identityfields); } /** * Return joins necessary for retrieving tags * * @return string[] */ public function get_tag_joins(): array { return $this->get_tag_joins_for_entity('core', 'user', $this->get_table_alias('user') . '.id'); } /** * Returns list of all available columns * * These are all the columns available to use in any report that uses this entity. * * @return column[] */ protected function get_all_columns(): array { global $DB; $usertablealias = $this->get_table_alias('user'); $contexttablealias = $this->get_table_alias('context'); $fullnameselect = self::get_name_fields_select($usertablealias); $fullnamesort = explode(', ', $fullnameselect); $userpictureselect = fields::for_userpic()->get_sql($usertablealias, false, '', '', false)->selects; $viewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance()); // Fullname column. $columns[] = (new column( 'fullname', new lang_string('fullname'), $this->get_entity_name() )) ->add_joins($this->get_joins()) ->add_fields($fullnameselect) ->set_is_sortable($this->is_sortable('fullname'), $fullnamesort) ->add_callback(static function($value, stdClass $row) use ($viewfullnames): string { // Ensure we have at least one field present. if (count(array_filter((array) $row, fn($field) => $field !== null)) === 0) { return ''; } // Ensure we populate all required name properties. $namefields = fields::get_name_fields(); foreach ($namefields as $namefield) { $row->{$namefield} = $row->{$namefield} ?? ''; } return fullname($row, $viewfullnames); }); // Formatted fullname columns (with link, picture or both). $fullnamefields = [ 'fullnamewithlink' => new lang_string('userfullnamewithlink', 'core_reportbuilder'), 'fullnamewithpicture' => new lang_string('userfullnamewithpicture', 'core_reportbuilder'), 'fullnamewithpicturelink' => new lang_string('userfullnamewithpicturelink', 'core_reportbuilder'), ]; foreach ($fullnamefields as $fullnamefield => $fullnamelang) { $column = (new column( $fullnamefield, $fullnamelang, $this->get_entity_name() )) ->add_joins($this->get_joins()) ->add_fields($fullnameselect) ->add_field("{$usertablealias}.id") ->set_is_sortable($this->is_sortable($fullnamefield), $fullnamesort) ->add_callback(static function($value, stdClass $row) use ($fullnamefield, $viewfullnames): string { global $OUTPUT; // Ensure we have at least one field present. if (count(array_filter((array) $row, fn($field) => $field !== null)) === 0) { return ''; } // Ensure we populate all required name properties. $namefields = fields::get_name_fields(); foreach ($namefields as $namefield) { $row->{$namefield} = $row->{$namefield} ?? ''; } if ($fullnamefield === 'fullnamewithlink') { return html_writer::link(new moodle_url('/user/profile.php', ['id' => $row->id]), fullname($row, $viewfullnames)); } if ($fullnamefield === 'fullnamewithpicture') { return $OUTPUT->user_picture($row, ['link' => false, 'alttext' => false]) . fullname($row, $viewfullnames); } if ($fullnamefield === 'fullnamewithpicturelink') { return html_writer::link(new moodle_url('/user/profile.php', ['id' => $row->id]), $OUTPUT->user_picture($row, ['link' => false, 'alttext' => false]) . fullname($row, $viewfullnames)); } return (string) $value; }); // Picture fields need some more data. if (strpos($fullnamefield, 'picture') !== false) { $column->add_fields($userpictureselect); } $columns[] = $column; } // Picture column. $columns[] = (new column( 'picture', new lang_string('userpicture', 'core_reportbuilder'), $this->get_entity_name() )) ->add_joins($this->get_joins()) ->add_fields($userpictureselect) ->set_is_sortable($this->is_sortable('picture')) ->add_callback(static function($value, stdClass $row): string { global $OUTPUT; return !empty($row->id) ? $OUTPUT->user_picture($row, ['link' => false, 'alttext' => false]) : ''; }); // Add all other user fields. $userfields = $this->get_user_fields(); foreach ($userfields as $userfield => $userfieldlang) { $columntype = $this->get_user_field_type($userfield); $columnfieldsql = "{$usertablealias}.{$userfield}"; if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') { $columnfieldsql = $DB->sql_order_by_text($columnfieldsql, 1024); } $column = (new column( $userfield, $userfieldlang, $this->get_entity_name() )) ->add_joins($this->get_joins()) ->set_type($columntype) ->add_field($columnfieldsql, $userfield) ->set_is_sortable($this->is_sortable($userfield)) ->add_callback([$this, 'format'], $userfield); // Join on the context table so that we can use it for formatting these columns later. if ($userfield === 'description') { $column ->add_join("LEFT JOIN {context} {$contexttablealias} ON {$contexttablealias}.contextlevel = " . CONTEXT_USER . " AND {$contexttablealias}.instanceid = {$usertablealias}.id") ->add_fields("{$usertablealias}.descriptionformat, {$usertablealias}.id") ->add_fields(context_helper::get_preload_record_columns_sql($contexttablealias)); } $columns[] = $column; } return $columns; } /** * Check if this field is sortable * * @param string $fieldname * @return bool */ protected function is_sortable(string $fieldname): bool { // Some columns can't be sorted, like longtext or images. $nonsortable = [ 'description', 'picture', ]; return !in_array($fieldname, $nonsortable); } /** * Formats the user field for display. * * @param mixed $value Current field value. * @param stdClass $row Complete row. * @param string $fieldname Name of the field to format. * @return string */ public function format($value, stdClass $row, string $fieldname): string { global $CFG; if ($this->get_user_field_type($fieldname) === column::TYPE_BOOLEAN) { return format::boolean_as_text($value); } if ($this->get_user_field_type($fieldname) === column::TYPE_TIMESTAMP) { return format::userdate($value, $row); } // If the column has corresponding filter, determine the value from its options. $options = $this->get_options_for($fieldname); if ($options !== null && array_key_exists($value, $options)) { return $options[$value]; } if ($fieldname === 'description') { if (empty($row->id)) { return ''; } require_once("{$CFG->libdir}/filelib.php"); context_helper::preload_from_record($row); $context = context_user::instance($row->id); $description = file_rewrite_pluginfile_urls($value, 'pluginfile.php', $context->id, 'user', 'profile', null); return format_text($description, $row->descriptionformat, ['context' => $context->id]); } return s($value); } /** * Returns a SQL statement to select all user fields necessary for fullname() function * * Note the implementation here is similar to {@see fields::get_sql_fullname} but without concatenation * * @param string $usertablealias * @return string */ public static function get_name_fields_select(string $usertablealias = 'u'): string { $namefields = fields::get_name_fields(true); $viewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance()); $dummyfullname = core_user::get_dummy_fullname(null, ['override' => $viewfullnames]); // Extract any name fields from the fullname format in the order that they appear. $matchednames = array_values(order_in_string($namefields, $dummyfullname)); $userfields = array_map(static function(string $userfield) use ($usertablealias): string { if (!empty($usertablealias)) { $userfield = "{$usertablealias}.{$userfield}"; } return $userfield; }, $matchednames); return implode(', ', $userfields); } /** * User fields * * @return lang_string[] */ protected function get_user_fields(): array { return [ 'firstname' => new lang_string('firstname'), 'lastname' => new lang_string('lastname'), 'email' => new lang_string('email'), 'city' => new lang_string('city'), 'country' => new lang_string('country'), 'lang' => new lang_string('language'), 'timezone' => new lang_string('timezone'), 'theme' => new lang_string('theme'), 'description' => new lang_string('description'), 'firstnamephonetic' => new lang_string('firstnamephonetic'), 'lastnamephonetic' => new lang_string('lastnamephonetic'), 'middlename' => new lang_string('middlename'), 'alternatename' => new lang_string('alternatename'), 'idnumber' => new lang_string('idnumber'), 'institution' => new lang_string('institution'), 'department' => new lang_string('department'), 'phone1' => new lang_string('phone1'), 'phone2' => new lang_string('phone2'), 'address' => new lang_string('address'), 'lastaccess' => new lang_string('lastaccess'), 'suspended' => new lang_string('suspended'), 'confirmed' => new lang_string('confirmed', 'admin'), 'username' => new lang_string('username'), 'auth' => new lang_string('authentication', 'moodle'), 'moodlenetprofile' => new lang_string('moodlenetprofile', 'user'), 'timecreated' => new lang_string('timecreated', 'core_reportbuilder'), 'timemodified' => new lang_string('timemodified', 'core_reportbuilder'), 'lastip' => new lang_string('lastip'), ]; } /** * Return appropriate column type for given user field * * @param string $userfield * @return int */ protected function get_user_field_type(string $userfield): int { switch ($userfield) { case 'description': $fieldtype = column::TYPE_LONGTEXT; break; case 'confirmed': case 'suspended': $fieldtype = column::TYPE_BOOLEAN; break; case 'lastaccess': case 'timecreated': case 'timemodified': $fieldtype = column::TYPE_TIMESTAMP; break; default: $fieldtype = column::TYPE_TEXT; break; } return $fieldtype; } /** * Return list of all available filters * * @return filter[] */ protected function get_all_filters(): array { global $DB; $filters = []; $tablealias = $this->get_table_alias('user'); // Fullname filter. $canviewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance()); [$fullnamesql, $fullnameparams] = fields::get_sql_fullname($tablealias, $canviewfullnames); $filters[] = (new filter( text::class, 'fullname', new lang_string('fullname'), $this->get_entity_name(), $fullnamesql, $fullnameparams )) ->add_joins($this->get_joins()); // User fields filters. $fields = $this->get_user_fields(); foreach ($fields as $field => $name) { $filterfieldsql = "{$tablealias}.{$field}"; if ($this->get_user_field_type($field) === column::TYPE_LONGTEXT) { $filterfieldsql = $DB->sql_cast_to_char($filterfieldsql); } $optionscallback = [static::class, 'get_options_for_' . $field]; if (is_callable($optionscallback)) { $classname = select::class; } else if ($this->get_user_field_type($field) === column::TYPE_BOOLEAN) { $classname = boolean_select::class; } else if ($this->get_user_field_type($field) === column::TYPE_TIMESTAMP) { $classname = date::class; } else { $classname = text::class; } $filter = (new filter( $classname, $field, $name, $this->get_entity_name(), $filterfieldsql )) ->add_joins($this->get_joins()); // Populate filter options by callback, if available. if (is_callable($optionscallback)) { $filter->set_options_callback($optionscallback); } $filters[] = $filter; } // User select filter. $filters[] = (new filter( user_filter::class, 'userselect', new lang_string('userselect', 'core_reportbuilder'), $this->get_entity_name(), "{$tablealias}.id" )) ->add_joins($this->get_joins()); return $filters; } /** * Gets list of options if the filter supports it * * @param string $fieldname * @return null|array */ protected function get_options_for(string $fieldname): ?array { static $cached = []; if (!array_key_exists($fieldname, $cached)) { $callable = [static::class, 'get_options_for_' . $fieldname]; if (is_callable($callable)) { $cached[$fieldname] = $callable(); } else { $cached[$fieldname] = null; } } return $cached[$fieldname]; } /** * List of options for the field auth * * @return string[] */ public static function get_options_for_auth(): array { $authlist = array_keys(core_component::get_plugin_list('auth')); return array_map( fn(string $auth) => get_auth_plugin($auth)->get_title(), array_combine($authlist, $authlist), ); } /** * List of options for the field country. * * @return string[] */ public static function get_options_for_country(): array { return get_string_manager()->get_list_of_countries(); } /** * List of options for the field lang. * * @return string[] */ public static function get_options_for_lang(): array { return get_string_manager()->get_list_of_translations(); } /** * List of options for the field timezone. * * @return string[] */ public static function get_options_for_timezone(): array { return core_date::get_list_of_timezones(null, true); } /** * List of options for the field theme. * * @return string[] */ public static function get_options_for_theme(): array { return array_map( fn(theme_config $theme) => $theme->get_theme_name(), get_list_of_themes(), ); } } PK a<�\%�5 c> c> ! classes/local/entities/course.phpnu �[��� <?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\local\entities; use context_course; use context_helper; use core_reportbuilder\local\filters\boolean_select; use core_reportbuilder\local\filters\course_selector; use core_reportbuilder\local\filters\date; use core_reportbuilder\local\filters\select; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\helpers\custom_fields; use core_reportbuilder\local\helpers\format; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; use html_writer; use lang_string; use stdClass; use theme_config; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/course/lib.php'); /** * Course entity class implementation * * This entity defines all the course columns and filters to be used in any report. * * @package core_reportbuilder * @copyright 2021 Sara Arjona <sara@moodle.com> based on Marina Glancy code. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class course extends base { /** * Database tables that this entity uses * * @return string[] */ protected function get_default_tables(): array { return [ 'course', 'context', 'tag_instance', 'tag', ]; } /** * The default title for this entity in the list of columns/filters in the report builder. * * @return lang_string */ protected function get_default_entity_title(): lang_string { return new lang_string('entitycourse', 'core_reportbuilder'); } /** * Initialise the entity * * @return base */ public function initialise(): base { $tablealias = $this->get_table_alias('course'); $customfields = (new custom_fields( "{$tablealias}.id", $this->get_entity_name(), 'core_course', 'course', )) ->add_joins($this->get_joins()); $columns = array_merge($this->get_all_columns(), $customfields->get_columns()); foreach ($columns as $column) { $this->add_column($column); } // All the filters defined by the entity can also be used as conditions. $filters = array_merge($this->get_all_filters(), $customfields->get_filters()); foreach ($filters as $filter) { $this ->add_condition($filter) ->add_filter($filter); } return $this; } /** * Return syntax for joining on the context table * * @return string */ public function get_context_join(): string { $coursealias = $this->get_table_alias('course'); $contextalias = $this->get_table_alias('context'); return "LEFT JOIN {context} {$contextalias} ON {$contextalias}.contextlevel = " . CONTEXT_COURSE . " AND {$contextalias}.instanceid = {$coursealias}.id"; } /** * Course fields. * * @return array */ protected function get_course_fields(): array { return [ 'fullname' => new lang_string('fullnamecourse'), 'shortname' => new lang_string('shortnamecourse'), 'idnumber' => new lang_string('idnumbercourse'), 'summary' => new lang_string('coursesummary'), 'format' => new lang_string('format'), 'startdate' => new lang_string('startdate'), 'enddate' => new lang_string('enddate'), 'visible' => new lang_string('coursevisibility'), 'groupmode' => new lang_string('groupmode', 'group'), 'groupmodeforce' => new lang_string('groupmodeforce', 'group'), 'lang' => new lang_string('forcelanguage'), 'calendartype' => new lang_string('forcecalendartype', 'calendar'), 'theme' => new lang_string('theme'), 'enablecompletion' => new lang_string('enablecompletion', 'completion'), 'downloadcontent' => new lang_string('downloadcoursecontent', 'course'), 'timecreated' => new lang_string('timecreated', 'core_reportbuilder'), 'timemodified' => new lang_string('timemodified', 'core_reportbuilder'), ]; } /** * Check if this field is sortable * * @param string $fieldname * @return bool */ protected function is_sortable(string $fieldname): bool { // Some columns can't be sorted, like longtext or images. $nonsortable = [ 'summary', ]; return !in_array($fieldname, $nonsortable); } /** * Return appropriate column type for given user field * * @param string $coursefield * @return int */ protected function get_course_field_type(string $coursefield): int { switch ($coursefield) { case 'downloadcontent': case 'enablecompletion': case 'groupmodeforce': case 'visible': $fieldtype = column::TYPE_BOOLEAN; break; case 'startdate': case 'enddate': case 'timecreated': case 'timemodified': $fieldtype = column::TYPE_TIMESTAMP; break; case 'summary': $fieldtype = column::TYPE_LONGTEXT; break; case 'groupmode': $fieldtype = column::TYPE_INTEGER; break; case 'calendartype': case 'idnumber': case 'format': case 'fullname': case 'lang': case 'shortname': case 'theme': default: $fieldtype = column::TYPE_TEXT; break; } return $fieldtype; } /** * Return joins necessary for retrieving tags * * @return string[] */ public function get_tag_joins(): array { return $this->get_tag_joins_for_entity('core', 'course', $this->get_table_alias('course') . '.id'); } /** * Returns list of all available columns. * * These are all the columns available to use in any report that uses this entity. * * @return column[] */ protected function get_all_columns(): array { global $DB; $coursefields = $this->get_course_fields(); $tablealias = $this->get_table_alias('course'); $contexttablealias = $this->get_table_alias('context'); // Columns course full name with link, course short name with link and course id with link. $fields = [ 'coursefullnamewithlink' => 'fullname', 'courseshortnamewithlink' => 'shortname', 'courseidnumberewithlink' => 'idnumber', ]; foreach ($fields as $key => $field) { $column = (new column( $key, new lang_string($key, 'core_reportbuilder'), $this->get_entity_name() )) ->add_joins($this->get_joins()) ->set_type(column::TYPE_TEXT) ->add_fields("{$tablealias}.{$field} as $key, {$tablealias}.id") ->set_is_sortable(true) ->add_callback(static function(?string $value, stdClass $row): string { if ($value === null) { return ''; } context_helper::preload_from_record($row); return html_writer::link(course_get_url($row->id), format_string($value, true, ['context' => context_course::instance($row->id)])); }); // Join on the context table so that we can use it for formatting these columns later. if ($key === 'coursefullnamewithlink') { $column->add_join($this->get_context_join()) ->add_fields(context_helper::get_preload_record_columns_sql($contexttablealias)); } $columns[] = $column; } foreach ($coursefields as $coursefield => $coursefieldlang) { $columntype = $this->get_course_field_type($coursefield); $columnfieldsql = "{$tablealias}.{$coursefield}"; if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') { $columnfieldsql = $DB->sql_order_by_text($columnfieldsql, 1024); } $column = (new column( $coursefield, $coursefieldlang, $this->get_entity_name() )) ->add_joins($this->get_joins()) ->set_type($columntype) ->add_field($columnfieldsql, $coursefield) ->add_callback([$this, 'format'], $coursefield) ->set_is_sortable($this->is_sortable($coursefield)); // Join on the context table so that we can use it for formatting these columns later. if ($coursefield === 'summary' || $coursefield === 'shortname' || $coursefield === 'fullname') { $column->add_join($this->get_context_join()) ->add_field("{$tablealias}.id", 'courseid') ->add_fields(context_helper::get_preload_record_columns_sql($contexttablealias)); } $columns[] = $column; } return $columns; } /** * Returns list of all available filters * * @return array */ protected function get_all_filters(): array { global $DB; $filters = []; $tablealias = $this->get_table_alias('course'); $fields = $this->get_course_fields(); foreach ($fields as $field => $name) { $filterfieldsql = "{$tablealias}.{$field}"; if ($this->get_course_field_type($field) === column::TYPE_LONGTEXT) { $filterfieldsql = $DB->sql_cast_to_char($filterfieldsql); } $optionscallback = [static::class, 'get_options_for_' . $field]; if (is_callable($optionscallback)) { $filterclass = select::class; } else if ($this->get_course_field_type($field) === column::TYPE_BOOLEAN) { $filterclass = boolean_select::class; } else if ($this->get_course_field_type($field) === column::TYPE_TIMESTAMP) { $filterclass = date::class; } else { $filterclass = text::class; } $filter = (new filter( $filterclass, $field, $name, $this->get_entity_name(), $filterfieldsql )) ->add_joins($this->get_joins()); // Populate filter options by callback, if available. if (is_callable($optionscallback)) { $filter->set_options_callback($optionscallback); } $filters[] = $filter; } // We add our own custom course selector filter. $filters[] = (new filter( course_selector::class, 'courseselector', new lang_string('courseselect', 'core_reportbuilder'), $this->get_entity_name(), "{$tablealias}.id" )) ->add_joins($this->get_joins()); return $filters; } /** * Gets list of options if the filter supports it * * @param string $fieldname * @return null|array */ protected function get_options_for(string $fieldname): ?array { static $cached = []; if (!array_key_exists($fieldname, $cached)) { $callable = [static::class, 'get_options_for_' . $fieldname]; if (is_callable($callable)) { $cached[$fieldname] = $callable(); } else { $cached[$fieldname] = null; } } return $cached[$fieldname]; } /** * List of options for the field groupmode. * * @return array */ public static function get_options_for_groupmode(): array { return [ NOGROUPS => get_string('groupsnone', 'group'), SEPARATEGROUPS => get_string('groupsseparate', 'group'), VISIBLEGROUPS => get_string('groupsvisible', 'group'), ]; } /** * List of options for the field format. * * @return array */ public static function get_options_for_format(): array { global $CFG; require_once($CFG->dirroot.'/course/lib.php'); $options = []; $courseformats = get_sorted_course_formats(true); foreach ($courseformats as $courseformat) { $options[$courseformat] = get_string('pluginname', "format_{$courseformat}"); } return $options; } /** * List of options for the field theme. * * @return array */ public static function get_options_for_theme(): array { return array_map( fn(theme_config $theme) => $theme->get_theme_name(), get_list_of_themes(), ); } /** * List of options for the field lang. * * @return array */ public static function get_options_for_lang(): array { return get_string_manager()->get_list_of_translations(); } /** * List of options for the field. * * @return array */ public static function get_options_for_calendartype(): array { return \core_calendar\type_factory::get_list_of_calendar_types(); } /** * Formats the course field for display. * * @param mixed $value Current field value. * @param stdClass $row Complete row. * @param string $fieldname Name of the field to format. * @return string */ public function format($value, stdClass $row, string $fieldname): string { if ($this->get_course_field_type($fieldname) === column::TYPE_TIMESTAMP) { return format::userdate($value, $row); } if ($this->get_course_field_type($fieldname) === column::TYPE_BOOLEAN) { return format::boolean_as_text($value); } // If the column has corresponding filter, determine the value from its options. $options = $this->get_options_for($fieldname); if ($options !== null && array_key_exists($value, $options)) { return $options[$value]; } if (in_array($fieldname, ['fullname', 'shortname'])) { if (!$row->courseid) { return ''; } context_helper::preload_from_record($row); $context = context_course::instance($row->courseid); return format_string($value, true, ['context' => $context->id, 'escape' => false]); } if (in_array($fieldname, ['summary'])) { if (!$row->courseid) { return ''; } context_helper::preload_from_record($row); $context = context_course::instance($row->courseid); $summary = file_rewrite_pluginfile_urls($row->summary, 'pluginfile.php', $context->id, 'course', 'summary', null); return format_text($summary); } return s($value); } } PK a<�\����p �p classes/local/report/base.phpnu �[��� <?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\local\report; use coding_exception; use context; use lang_string; use core_reportbuilder\local\entities\base as entity_base; use core_reportbuilder\local\filters\base as filter_base; use core_reportbuilder\local\helpers\database; use core_reportbuilder\local\helpers\user_filter_manager; use core_reportbuilder\local\models\report; /** * Base class for all reports * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class base { /** @var int Custom report type value */ public const TYPE_CUSTOM_REPORT = 0; /** @var int System report type value */ public const TYPE_SYSTEM_REPORT = 1; /** @var int Default paging limit */ public const DEFAULT_PAGESIZE = 30; /** @var report $report Report persistent */ private $report; /** @var string $maintable */ private $maintable = ''; /** @var string $maintablealias */ private $maintablealias = ''; /** @var array $sqljoins */ private $sqljoins = []; /** @var array $sqlwheres */ private $sqlwheres = []; /** @var array $sqlparams */ private $sqlparams = []; /** @var entity_base[] $entities */ private $entities = []; /** @var lang_string[] */ private $entitytitles = []; /** @var column[] $columns */ private $columns = []; /** @var filter[] $conditions */ private $conditions = []; /** @var filter[] $filters */ private $filters = []; /** @var bool $downloadable Set if the report can be downloaded */ private $downloadable = false; /** @var string $downloadfilename Name of the downloaded file */ private $downloadfilename = ''; /** @var int Default paging size */ private $defaultperpage = self::DEFAULT_PAGESIZE; /** @var array $attributes */ private $attributes = []; /** @var lang_string $noresultsnotice */ private $noresultsnotice; /** * Base report constructor * * @param report $report */ public function __construct(report $report) { $this->report = $report; $this->noresultsnotice = new lang_string('nothingtodisplay'); // Initialise and validate the report. $this->initialise(); $this->validate(); } /** * Returns persistent class used when initialising this report * * @return report */ final public function get_report_persistent(): report { return $this->report; } /** * Return user friendly name of the report * * @return string */ abstract public static function get_name(): string; /** * Initialise report. Specify which columns, filters, etc should be present * * To set the base query use: * - {@see set_main_table} * - {@see add_base_condition_simple} or {@see add_base_condition_sql} * - {@see add_join} * * To add content to the report use: * - {@see add_entity} * - {@see add_column} * - {@see add_filter} * - etc */ abstract protected function initialise(): void; /** * Get the report availability. Sub-classes should override this method to declare themselves unavailable, for example if * they require classes that aren't present due to missing plugin * * @return bool */ public static function is_available(): bool { return true; } /** * Perform some basic validation about expected class properties * * @throws coding_exception */ protected function validate(): void { if (empty($this->maintable)) { throw new coding_exception('Report must define main table by calling $this->set_main_table()'); } if (empty($this->columns)) { throw new coding_exception('Report must define at least one column by calling $this->add_column()'); } } /** * Set the main table and alias for the SQL query * * @param string $tablename * @param string $tablealias */ final public function set_main_table(string $tablename, string $tablealias = ''): void { $this->maintable = $tablename; $this->maintablealias = $tablealias; } /** * Get the main table name * * @return string */ final public function get_main_table(): string { return $this->maintable; } /** * Get the alias for the main table * * @return string */ final public function get_main_table_alias(): string { return $this->maintablealias; } /** * Adds report JOIN clause that is always added * * @param string $join * @param array $params * @param bool $validateparams Some queries might add non-standard params and validation could fail */ protected function add_join(string $join, array $params = [], bool $validateparams = true): void { if ($validateparams) { database::validate_params($params); } $this->sqljoins[trim($join)] = trim($join); $this->sqlparams += $params; } /** * Return report JOIN clauses * * @return array */ public function get_joins(): array { return array_values($this->sqljoins); } /** * Define simple "field = value" clause to apply to the report query * * @param string $fieldname * @param mixed $fieldvalue */ final public function add_base_condition_simple(string $fieldname, $fieldvalue): void { if ($fieldvalue === null) { $this->add_base_condition_sql("{$fieldname} IS NULL"); } else { $fieldvalueparam = database::generate_param_name(); $this->add_base_condition_sql("{$fieldname} = :{$fieldvalueparam}", [ $fieldvalueparam => $fieldvalue, ]); } } /** * Define more complex/non-empty clause to apply to the report query * * @param string $where * @param array $params Note that the param names should be generated by {@see database::generate_param_name} */ final public function add_base_condition_sql(string $where, array $params = []): void { // Validate parameters always, so that potential errors are caught early. database::validate_params($params); if ($where !== '') { $this->sqlwheres[] = trim($where); $this->sqlparams = $params + $this->sqlparams; } } /** * Return base select/params for the report query * * @return array [string $select, array $params] */ final public function get_base_condition(): array { return [ implode(' AND ', $this->sqlwheres), $this->sqlparams, ]; } /** * Adds given entity, along with it's columns and filters, to the report * * @param entity_base $entity */ final protected function add_entity(entity_base $entity): void { $entityname = $entity->get_entity_name(); $this->annotate_entity($entityname, $entity->get_entity_title()); $this->entities[$entityname] = $entity->initialise(); } /** * Returns the entity added to the report from the given entity name * * @param string $name * @return entity_base * @throws coding_exception */ final protected function get_entity(string $name): entity_base { if (!array_key_exists($name, $this->entities)) { throw new coding_exception('Invalid entity name', $name); } return $this->entities[$name]; } /** * Returns the list of all the entities added to the report * * @return entity_base[] */ final protected function get_entities(): array { return $this->entities; } /** * Define a new entity for the report * * @param string $name * @param lang_string $title * @throws coding_exception */ final protected function annotate_entity(string $name, lang_string $title): void { if ($name === '' || $name !== clean_param($name, PARAM_ALPHANUMEXT)) { throw new coding_exception('Entity name must be comprised of alphanumeric character, underscore or dash'); } if (array_key_exists($name, $this->entitytitles)) { throw new coding_exception('Duplicate entity name', $name); } $this->entitytitles[$name] = $title; } /** * Returns title of given report entity * * @param string $name * @return lang_string * @throws coding_exception */ final public function get_entity_title(string $name): lang_string { if (!array_key_exists($name, $this->entitytitles)) { throw new coding_exception('Invalid entity name', $name); } return $this->entitytitles[$name]; } /** * Adds a column to the report * * @param column $column * @return column * @throws coding_exception */ final protected function add_column(column $column): column { if (!array_key_exists($column->get_entity_name(), $this->entitytitles)) { throw new coding_exception('Invalid entity name', $column->get_entity_name()); } $name = $column->get_name(); if (empty($name) || $name !== clean_param($name, PARAM_ALPHANUMEXT)) { throw new coding_exception('Column name must be comprised of alphanumeric character, underscore or dash'); } $uniqueidentifier = $column->get_unique_identifier(); if (array_key_exists($uniqueidentifier, $this->columns)) { throw new coding_exception('Duplicate column identifier', $uniqueidentifier); } $this->columns[$uniqueidentifier] = $column; return $column; } /** * Add given column to the report from an entity * * The entity must have already been added to the report before calling this method * * @param string $uniqueidentifier * @return column */ final protected function add_column_from_entity(string $uniqueidentifier): column { [$entityname, $columnname] = explode(':', $uniqueidentifier, 2); return $this->add_column($this->get_entity($entityname)->get_column($columnname)); } /** * Add columns from the given entity name to be available to use in a custom report * * Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*'] * * @param string $entityname * @param string[] $include Include only these columns, if omitted then include all * @param string[] $exclude Exclude these columns, if omitted then exclude none * @throws coding_exception If both $include and $exclude are non-empty */ final protected function add_columns_from_entity(string $entityname, array $include = [], array $exclude = []): void { if (!empty($include) && !empty($exclude)) { throw new coding_exception('Cannot specify columns to include and exclude simultaneously'); } $entity = $this->get_entity($entityname); // Retrieve filtered columns from entity, respecting given $include/$exclude parameters. $columns = array_filter($entity->get_columns(), function(column $column) use ($include, $exclude): bool { if (!empty($include)) { return $this->report_element_search($column->get_name(), $include); } if (!empty($exclude)) { return !$this->report_element_search($column->get_name(), $exclude); } return true; }); foreach ($columns as $column) { $this->add_column($column); } } /** * Add given columns to the report from one or more entities * * Each entity must have already been added to the report before calling this method * * @param string[] $columns Unique identifier of each entity column */ final protected function add_columns_from_entities(array $columns): void { foreach ($columns as $column) { $this->add_column_from_entity($column); } } /** * Return report column by unique identifier * * @param string $uniqueidentifier * @return column|null */ final public function get_column(string $uniqueidentifier): ?column { return $this->columns[$uniqueidentifier] ?? null; } /** * Return all available report columns * * @return column[] */ final public function get_columns(): array { return array_filter($this->columns, static function(column $column): bool { return $column->get_is_available(); }); } /** * Return all active report columns (by default, all available columns) * * @return column[] */ public function get_active_columns(): array { $columns = $this->get_columns(); foreach ($columns as $column) { if ($column->get_is_deprecated()) { debugging("The column '{$column->get_unique_identifier()}' is deprecated, please do not use it any more." . " {$column->get_is_deprecated_message()}", DEBUG_DEVELOPER); } } return $columns; } /** * Return all active report columns, keyed by their alias (only active columns in a report would have a valid alias/index) * * @return column[] */ final public function get_active_columns_by_alias(): array { $columns = []; foreach ($this->get_active_columns() as $column) { $columns[$column->get_column_alias()] = $column; } return $columns; } /** * Adds a condition to the report * * @param filter $condition * @return filter * @throws coding_exception */ final protected function add_condition(filter $condition): filter { if (!array_key_exists($condition->get_entity_name(), $this->entitytitles)) { throw new coding_exception('Invalid entity name', $condition->get_entity_name()); } $name = $condition->get_name(); if (empty($name) || $name !== clean_param($name, PARAM_ALPHANUMEXT)) { throw new coding_exception('Condition name must be comprised of alphanumeric character, underscore or dash'); } $uniqueidentifier = $condition->get_unique_identifier(); if (array_key_exists($uniqueidentifier, $this->conditions)) { throw new coding_exception('Duplicate condition identifier', $uniqueidentifier); } $this->conditions[$uniqueidentifier] = $condition; return $condition; } /** * Add given condition to the report from an entity * * The entity must have already been added to the report before calling this method * * @param string $uniqueidentifier * @return filter */ final protected function add_condition_from_entity(string $uniqueidentifier): filter { [$entityname, $conditionname] = explode(':', $uniqueidentifier, 2); return $this->add_condition($this->get_entity($entityname)->get_condition($conditionname)); } /** * Add given conditions to the report from one or more entities * * Each entity must have already been added to the report before calling this method * * @param string[] $conditions Unique identifier of each entity condition */ final protected function add_conditions_from_entities(array $conditions): void { foreach ($conditions as $condition) { $this->add_condition_from_entity($condition); } } /** * Return report condition by unique identifier * * @param string $uniqueidentifier * @return filter|null */ final public function get_condition(string $uniqueidentifier): ?filter { return $this->conditions[$uniqueidentifier] ?? null; } /** * Return all available report conditions * * @return filter[] */ final public function get_conditions(): array { return array_filter($this->conditions, static function(filter $condition): bool { return $condition->get_is_available(); }); } /** * Return all active report conditions (by default, all available conditions) * * @param bool $checkavailable * @return filter[] */ public function get_active_conditions(bool $checkavailable = true): array { $conditions = $this->get_conditions(); foreach ($conditions as $condition) { if ($condition->get_is_deprecated()) { debugging("The condition '{$condition->get_unique_identifier()}' is deprecated, please do not use it any more." . " {$condition->get_is_deprecated_message()}", DEBUG_DEVELOPER); } } return $conditions; } /** * Return all active report condition instances * * @return filter_base[] */ final public function get_condition_instances(): array { return array_map(static function(filter $condition): filter_base { /** @var filter_base $conditionclass */ $conditionclass = $condition->get_filter_class(); return $conditionclass::create($condition); }, $this->get_active_conditions()); } /** * Set the condition values of the report * * @param array $values * @return bool */ final public function set_condition_values(array $values): bool { $this->report->set('conditiondata', json_encode($values)) ->save(); return true; } /** * Get the condition values of the report * * @return array */ final public function get_condition_values(): array { $conditions = (string) $this->report->get('conditiondata'); return (array) json_decode($conditions); } /** * Set the settings values of the report * * @param array $values * @return bool */ final public function set_settings_values(array $values): bool { $currentsettings = $this->get_settings_values(); $settings = array_merge($currentsettings, $values); $this->report->set('settingsdata', json_encode($settings)) ->save(); return true; } /** * Get the settings values of the report * * @return array */ final public function get_settings_values(): array { $settings = (string) $this->report->get('settingsdata'); return (array) json_decode($settings); } /** * Adds a filter to the report * * @param filter $filter * @return filter * @throws coding_exception */ final protected function add_filter(filter $filter): filter { if (!array_key_exists($filter->get_entity_name(), $this->entitytitles)) { throw new coding_exception('Invalid entity name', $filter->get_entity_name()); } $name = $filter->get_name(); if (empty($name) || $name !== clean_param($name, PARAM_ALPHANUMEXT)) { throw new coding_exception('Filter name must be comprised of alphanumeric character, underscore or dash'); } $uniqueidentifier = $filter->get_unique_identifier(); if (array_key_exists($uniqueidentifier, $this->filters)) { throw new coding_exception('Duplicate filter identifier', $uniqueidentifier); } $this->filters[$uniqueidentifier] = $filter; return $filter; } /** * Add given filter to the report from an entity * * The entity must have already been added to the report before calling this method * * @param string $uniqueidentifier * @return filter */ final protected function add_filter_from_entity(string $uniqueidentifier): filter { [$entityname, $filtername] = explode(':', $uniqueidentifier, 2); return $this->add_filter($this->get_entity($entityname)->get_filter($filtername)); } /** * Add filters from the given entity name to be available to use in a custom report * * Wildcard matching is supported with '*' in both $include and $exclude, e.g. ['customfield*'] * * @param string $entityname * @param string[] $include Include only these filters, if omitted then include all * @param string[] $exclude Exclude these filters, if omitted then exclude none * @throws coding_exception If both $include and $exclude are non-empty */ final protected function add_filters_from_entity(string $entityname, array $include = [], array $exclude = []): void { if (!empty($include) && !empty($exclude)) { throw new coding_exception('Cannot specify filters to include and exclude simultaneously'); } $entity = $this->get_entity($entityname); // Retrieve filtered filters from entity, respecting given $include/$exclude parameters. $filters = array_filter($entity->get_filters(), function(filter $filter) use ($include, $exclude): bool { if (!empty($include)) { return $this->report_element_search($filter->get_name(), $include); } if (!empty($exclude)) { return !$this->report_element_search($filter->get_name(), $exclude); } return true; }); foreach ($filters as $filter) { $this->add_filter($filter); } } /** * Add given filters to the report from one or more entities * * Each entity must have already been added to the report before calling this method * * @param string[] $filters Unique identifier of each entity filter */ final protected function add_filters_from_entities(array $filters): void { foreach ($filters as $filter) { $this->add_filter_from_entity($filter); } } /** * Return report filter by unique identifier * * @param string $uniqueidentifier * @return filter|null */ final public function get_filter(string $uniqueidentifier): ?filter { return $this->filters[$uniqueidentifier] ?? null; } /** * Return all available report filters * * @return filter[] */ final public function get_filters(): array { return array_filter($this->filters, static function(filter $filter): bool { return $filter->get_is_available(); }); } /** * Return all active report filters (by default, all available filters) * * @return filter[] */ public function get_active_filters(): array { $filters = $this->get_filters(); foreach ($filters as $filter) { if ($filter->get_is_deprecated()) { debugging("The filter '{$filter->get_unique_identifier()}' is deprecated, please do not use it any more." . " {$filter->get_is_deprecated_message()}", DEBUG_DEVELOPER); } } return $filters; } /** * Return all active report filter instances * * @return filter_base[] */ final public function get_filter_instances(): array { return array_map(static function(filter $filter): filter_base { /** @var filter_base $filterclass */ $filterclass = $filter->get_filter_class(); return $filterclass::create($filter); }, $this->get_active_filters()); } /** * Set the filter values of the report * * @param array $values * @return bool */ final public function set_filter_values(array $values): bool { return user_filter_manager::set($this->report->get('id'), $values); } /** * Get the filter values of the report * * @return array */ final public function get_filter_values(): array { return user_filter_manager::get($this->report->get('id')); } /** * Return the number of filter instances that are being applied based on the report's filter values (i.e. user has * configured them from their initial "Any value" state) * * @return int */ final public function get_applied_filter_count(): int { $values = $this->get_filter_values(); $applied = array_filter($this->get_filter_instances(), static function(filter_base $filter) use ($values): bool { return $filter->applies_to_values($values); }); return count($applied); } /** * Set if the report can be downloaded. * * @param bool $downloadable * @param string|null $downloadfilename If downloadable, then the name of the file (defaults to the name of the current report) */ final public function set_downloadable(bool $downloadable, ?string $downloadfilename = null): void { $this->downloadable = $downloadable; $this->downloadfilename = $downloadfilename ?? static::get_name(); } /** * Get if the report can be downloaded. * * @return bool */ final public function is_downloadable(): bool { return $this->downloadable; } /** * Return the downloadable report filename * * @return string */ final public function get_downloadfilename(): string { return $this->downloadfilename; } /** * Returns the report context * * @return context */ public function get_context(): context { return $this->report->get_context(); } /** * Set the default 'per page' size * * @param int $defaultperpage */ public function set_default_per_page(int $defaultperpage): void { $this->defaultperpage = $defaultperpage; } /** * Set the default lang string for the notice used when no results are found. * * Note this should be called from within the report class instance itself (ideally it would be protected) * * @param lang_string|null $notice string, or null to tell the report to omit the notice entirely. */ public function set_default_no_results_notice(?lang_string $notice): void { $this->noresultsnotice = $notice; } /** * Get the default lang string for the notice used when no results are found. * * @return lang_string|null the lang_string instance or null if the report prefers not to use one. */ public function get_default_no_results_notice(): ?lang_string { return $this->noresultsnotice; } /** * Default 'per page' size * * @return int */ public function get_default_per_page(): int { return $this->defaultperpage; } /** * Add report attributes (data-, class, etc.) that will be included in HTML when report is displayed * * @param array $attributes * @return self */ public function add_attributes(array $attributes): self { $this->attributes = $attributes + $this->attributes; return $this; } /** * Returns the report HTML attributes * * @return array */ public function get_attributes(): array { return $this->attributes; } /** * Search for given element within list of search items, supporting '*' wildcards * * @param string $element * @param string[] $search * @return bool */ final protected function report_element_search(string $element, array $search): bool { foreach ($search as $item) { // Simple matching. if ($element === $item) { return true; } // Wildcard matching. if (strpos($item, '*') !== false) { $pattern = '/^' . str_replace('\*', '.*', preg_quote($item)) . '$/'; return (bool) preg_match($pattern, $element); } } return false; } } PK a<�\��� � classes/local/report/action.phpnu �[��� <?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\local\report; use action_menu_link; use lang_string; use moodle_url; use pix_icon; use popup_action; use stdClass; /** * Class to represent a report action * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class action { /** @var moodle_url $url */ protected $url; /** @var pix_icon $icon */ protected $icon; /** @var array $attributes */ protected $attributes; /** @var bool $popup */ protected $popup; /** @var callable[] $callbacks */ protected $callbacks = []; /** @var lang_string|string $title */ protected $title; /** * Create an instance of an action to be added to a report. Both the parameters of the URL, and the attributes parameter * support placeholders which will be replaced with appropriate row values, e.g.: * * new action(new moodle_url('/', ['id' => ':id']), new pix_icon(...), ['data-id' => ':id']) * * Note that all expected placeholders should be added as base fields to the report * * @param moodle_url $url * @param pix_icon $icon * @param string[] $attributes Array of attributes to include in action, each will be cast to string prior to use * @param bool $popup * @param ?lang_string $title */ public function __construct( moodle_url $url, pix_icon $icon, array $attributes = [], bool $popup = false, ?lang_string $title = null ) { $this->url = $url; $this->icon = $icon; $this->attributes = $attributes; $this->popup = $popup; // If title is not passed, check the title attribute from the icon. $this->title = $title ?? $icon->attributes['title'] ?? ''; } /** * Adds callback to the action. Used to verify action is available to current user, or preprocess values used in placeholders * * Multiple callbacks can be added. If at least one returns false then the action will not be displayed * * @param callable $callback * @return self */ public function add_callback(callable $callback): self { $this->callbacks[] = $callback; return $this; } /** * Return action menu link suitable for output, or null if the action cannot be displayed (because one of its callbacks * returned false, {@see add_callback}) * * @param stdClass $row * @return action_menu_link|null */ public function get_action_link(stdClass $row): ?action_menu_link { foreach ($this->callbacks as $callback) { $row = clone $row; // Clone so we don't modify the shared row inside a callback. if (!$callback($row)) { return null; } } // Create a new moodle_url instance with our filled in placeholders for this row. $url = new moodle_url( $this->url->out_omit_querystring(true), self::replace_placeholders($this->url->params(), $row) ); // Ensure we have a title attribute set, if one wasn't already provided. if (!array_key_exists('title', $this->attributes)) { $this->attributes['title'] = (string) $this->title; } $this->attributes['aria-label'] = $this->attributes['title']; if ($this->popup) { $this->attributes['data-action'] = 'report-action-popup'; $this->attributes['data-popup-action'] = json_encode(new popup_action('click', $url)); } // Interpolate any placeholders with correct values. $attributes = self::replace_placeholders($this->attributes, $row); // Ensure title attribute isn't duplicated. $title = $attributes['title']; unset($attributes['title']); return new action_menu_link($url, $this->icon, $title, null, $attributes); } /** * Given an array of values, replace all placeholders with corresponding property of the given row * * @param string[] $values * @param stdClass $row * @return array */ private static function replace_placeholders(array $values, stdClass $row): array { return array_map(static function($value) use ($row) { return preg_replace_callback('/^:(?<property>.*)$/', static function(array $matches) use ($row): string { return (string) ($row->{$matches['property']} ?? ''); }, (string) $value); }, $values); } } PK a<�\�P�j( j( classes/local/report/filter.phpnu �[��� <?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\local\report; use lang_string; use moodle_exception; use core_reportbuilder\local\filters\base; use core_reportbuilder\local\helpers\{database, join_trait}; use core_reportbuilder\local\models\filter as filter_model; /** * Class to represent a report filter * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class filter { use join_trait; /** @var string $fieldsql */ private $fieldsql = ''; /** @var array $fieldparams */ private $fieldparams = []; /** @var bool $available */ private $available = true; /** @var bool $deprecated */ private $deprecated = false; /** @var string $deprecatedmessage */ private $deprecatedmessage; /** @var mixed $options */ private $options; /** @var array $limitoperators */ private $limitoperators = []; /** @var filter_model $persistent */ private $persistent; /** * Filter constructor * * @param string $filterclass Filter type class to use, must extend {@see base} filter class * @param string $name Internal name of the filter * @param lang_string $header Title of the filter used in reports * @param string $entityname Name of the entity this filter belongs to. Typically when creating filters within entities * this value should be the result of calling {@see get_entity_name}, however if creating filters inside reports directly * it should be the name of the entity as passed to {@see \core_reportbuilder\local\report\base::annotate_entity} * @param string $fieldsql SQL clause to use for filtering, {@see set_field_sql} * @param array $fieldparams * @throws moodle_exception For invalid filter class */ public function __construct( /** @var string Filter type class to use, must extend {@see base} filter class */ private readonly string $filterclass, /** @var string Internal name of the filter */ private readonly string $name, /** @var lang_string Title of the filter used in reports */ private lang_string $header, /** @var string Name of the entity this filter belongs to */ private readonly string $entityname, string $fieldsql = '', array $fieldparams = [], ) { if (!class_exists($filterclass) || !is_subclass_of($filterclass, base::class)) { throw new moodle_exception('filterinvalid', 'reportbuilder', '', null, $filterclass); } if ($fieldsql !== '') { $this->set_field_sql($fieldsql, $fieldparams); } } /** * Get filter class path * * @return string */ public function get_filter_class(): string { return $this->filterclass; } /** * Get filter name * * @return string */ public function get_name(): string { return $this->name; } /** * Return header * * @return string */ public function get_header(): string { return $this->header->out(); } /** * Set header * * @param lang_string $header * @return self */ public function set_header(lang_string $header): self { $this->header = $header; return $this; } /** * Return filter entity name * * @return string */ public function get_entity_name(): string { return $this->entityname; } /** * Return unique identifier for this filter * * @return string */ public function get_unique_identifier(): string { return $this->get_entity_name() . ':' . $this->get_name(); } /** * Get SQL expression for the field * * @return string */ public function get_field_sql(): string { return $this->fieldsql; } /** * Get the SQL params for the field being filtered * * @return array */ public function get_field_params(): array { return $this->fieldparams; } /** * Retrieve SQL expression and parameters for the field * * @param int $index * @return array [$sql, [...$params]] */ public function get_field_sql_and_params(int $index = 0): array { $fieldsql = $this->get_field_sql(); $fieldparams = $this->get_field_params(); // Shortcut if there aren't any parameters. if (empty($fieldparams)) { return [$fieldsql, $fieldparams]; } // Simple callback for replacement of parameter names within filter SQL. $transform = function(string $param) use ($index): string { return "{$param}_{$index}"; }; $paramnames = array_keys($fieldparams); $sql = database::sql_replace_parameter_names($fieldsql, $paramnames, $transform); $params = []; foreach ($paramnames as $paramname) { $paramnametransform = $transform($paramname); $params[$paramnametransform] = $fieldparams[$paramname]; } return [$sql, $params]; } /** * Set the SQL expression for the field that is being filtered. It will be passed to the filter class * * @param string $sql * @param array $params * @return self */ public function set_field_sql(string $sql, array $params = []): self { $this->fieldsql = $sql; $this->fieldparams = $params; return $this; } /** * Return available state of the filter for the current user * * @return bool */ public function get_is_available(): bool { return $this->available; } /** * Conditionally set whether the filter is available. For instance the filter may be added to a report with the * expectation that only some users are able to see it * * @param bool $available * @return self */ public function set_is_available(bool $available): self { $this->available = $available; return $this; } /** * Set deprecated state of the filter, in which case it will still be shown when already present in existing reports but * won't be available for selection in the report editor * * @param string $deprecatedmessage * @return self */ public function set_is_deprecated(string $deprecatedmessage = ''): self { $this->deprecated = true; $this->deprecatedmessage = $deprecatedmessage; return $this; } /** * Return deprecated state of the filter * * @return bool */ public function get_is_deprecated(): bool { return $this->deprecated; } /** * Return deprecated message of the filter * * @return string */ public function get_is_deprecated_message(): string { return $this->deprecatedmessage; } /** * Set the options for the filter in the format that the filter class expected (e.g. the "select" filter expects an array) * * This method should only be used if the options do not require any calculations/queries, in which * case {@see set_options_callback} should be used. For performance, {@see get_string} shouldn't be used either, use of * {@see lang_string} is instead encouraged * * @param mixed $options * @return self */ public function set_options($options): self { $this->options = $options; return $this; } /** * Set the options for the filter to be returned by a callback (that receives no arguments) in the format that the filter * class expects * * @param callable $callback * @return self */ public function set_options_callback(callable $callback): self { $this->options = $callback; return $this; } /** * Get the options for the filter, returning via the the previously set options or generated via defined options callback * * @return mixed */ public function get_options() { if (is_callable($this->options)) { $callable = $this->options; $this->options = ($callable)(); } return $this->options; } /** * Set a limited subset of operators that should be used for the filter, refer to each filter class to find defined * operator constants * * @param array $limitoperators Simple array of operator values * @return self */ public function set_limited_operators(array $limitoperators): self { $this->limitoperators = $limitoperators; return $this; } /** * Filter given operators to include only those previously defined by {@see set_limited_operators} * * @param array $operators All operators as defined by the filter class * @return array */ public function restrict_limited_operators(array $operators): array { if (empty($this->limitoperators)) { return $operators; } return array_intersect_key($operators, array_flip($this->limitoperators)); } /** * Set filter persistent * * @param filter_model $persistent * @return self */ public function set_persistent(filter_model $persistent): self { $this->persistent = $persistent; return $this; } /** * Return filter persistent * * @return filter_model|null */ public function get_persistent(): ?filter_model { return $this->persistent ?? null; } } PK a<�\�h�:�\ �\ classes/local/report/column.phpnu �[��� <?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\local\report; use coding_exception; use lang_string; use core_reportbuilder\local\helpers\{aggregation, database, join_trait}; use core_reportbuilder\local\aggregation\base; use core_reportbuilder\local\models\column as column_model; /** * Class to represent a report column * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class column { use join_trait; /** @var int Column type is integer */ public const TYPE_INTEGER = 1; /** @var int Column type is text */ public const TYPE_TEXT = 2; /** @var int Column type is timestamp */ public const TYPE_TIMESTAMP = 3; /** @var int Column type is boolean */ public const TYPE_BOOLEAN = 4; /** @var int Column type is float */ public const TYPE_FLOAT = 5; /** @var int Column type is long text */ public const TYPE_LONGTEXT = 6; /** @var int $index Column index within a report */ private $index; /** @var bool $hascustomcolumntitle Used to store if the column has been given a custom title */ private $hascustomcolumntitle = false; /** @var int $type Column data type (one of the TYPE_* class constants) */ private $type = self::TYPE_TEXT; /** @var array $fields */ private $fields = []; /** @var array $params */ private $params = []; /** @var string $groupbysql */ private $groupbysql; /** @var array[] $callbacks Array of [callable, additionalarguments] */ private $callbacks = []; /** @var base|null $aggregation Aggregation type to apply to column */ private $aggregation = null; /** @var array $disabledaggregation Aggregation types explicitly disabled */ private $disabledaggregation = []; /** @var bool $issortable Used to indicate if a column is sortable */ private $issortable = false; /** @var array $sortfields Fields to sort the column by */ private $sortfields = []; /** @var array $attributes */ private $attributes = []; /** @var bool $available Used to know if column is available to the current user or not */ private $available = true; /** @var bool $deprecated */ private $deprecated = false; /** @var string $deprecatedmessage */ private $deprecatedmessage; /** @var column_model $persistent */ private $persistent; /** * Column constructor * * For better readability use chainable methods, for example: * * $report->add_column( * (new column('name', new lang_string('name'), 'user')) * ->add_join('left join {table} t on t.id = p.tableid') * ->add_field('t.name') * ->add_callback([format::class, 'format_string'])); * * @param string $name Internal name of the column * @param lang_string|null $title Title of the column used in reports (null for blank) * @param string $entityname Name of the entity this column belongs to. Typically when creating columns within entities * this value should be the result of calling {@see get_entity_name}, however if creating columns inside reports directly * it should be the name of the entity as passed to {@see \core_reportbuilder\local\report\base::annotate_entity} */ public function __construct( /** @var string Internal name of the column */ private string $name, /** @var lang_string|null Title of the column used in reports */ private ?lang_string $title, /** @var string Name of the entity this column belongs to */ private readonly string $entityname, ) { } /** * Set column name * * @param string $name * @return self */ public function set_name(string $name): self { $this->name = $name; return $this; } /** * Return column name * * @return mixed */ public function get_name(): string { return $this->name; } /** * Set column title * * @param lang_string|null $title * @return self */ public function set_title(?lang_string $title): self { $this->title = $title; $this->hascustomcolumntitle = true; return $this; } /** * Return column title * * @return string */ public function get_title(): string { return $this->title ? (string) $this->title : ''; } /** * Check whether this column has been given a custom title * * @return bool */ public function has_custom_title(): bool { return $this->hascustomcolumntitle; } /** * Get column entity name * * @return string */ public function get_entity_name(): string { return $this->entityname; } /** * Return unique identifier for this column * * @return string */ public function get_unique_identifier(): string { return $this->get_entity_name() . ':' . $this->get_name(); } /** * Set the column index within the current report * * @param int $index * @return self */ public function set_index(int $index): self { $this->index = $index; return $this; } /** * Set the column type, if not called then the type will be assumed to be {@see TYPE_TEXT} * * The type of a column is used to cast the first column field passed to any callbacks {@see add_callback} as well as the * aggregation options available for the column. It should represent how the column content is returned from callbacks * * * @param int $type * @return self * @throws coding_exception */ public function set_type(int $type): self { $allowedtypes = [ self::TYPE_INTEGER, self::TYPE_TEXT, self::TYPE_TIMESTAMP, self::TYPE_BOOLEAN, self::TYPE_FLOAT, self::TYPE_LONGTEXT, ]; if (!in_array($type, $allowedtypes)) { throw new coding_exception('Invalid column type', $type); } $this->type = $type; return $this; } /** * Return column type, that being one of the TYPE_* class constants * * @return int */ public function get_type(): int { return $this->type; } /** * Adds a field to be queried from the database that is necessary for this column * * Multiple fields can be added per column, this method may be called several times. Field aliases must be unique inside * any given column, but there will be no conflicts if the same aliases are used in other columns in the same report * * @param string $sql SQL query, this may be a simple "tablealias.fieldname" or a complex sub-query that returns only one field * @param string $alias * @param array $params * @return self * @throws coding_exception */ public function add_field(string $sql, string $alias = '', array $params = []): self { database::validate_params($params); // SQL ends with a space and a word - this looks like an alias was passed as part of the field. if (preg_match('/ \w+$/', $sql) && empty($alias)) { throw new coding_exception('Column alias must be passed as a separate argument', $sql); } // If no alias was specified, auto-detect it based on common patterns ("table.column" or just "column"). if (empty($alias) && preg_match('/^(\w+\.)?(?<fieldname>\w+)$/', $sql, $matches)) { $alias = $matches['fieldname']; } if (empty($alias)) { throw new coding_exception('Complex columns must have an alias', $sql); } $this->fields[$alias] = $sql; $this->params += $params; return $this; } /** * Add a list of comma-separated fields * * @param string $sql * @param array $params * @return self */ public function add_fields(string $sql, array $params = []): self { database::validate_params($params); // Split SQL into separate fields (separated by comma). $fields = preg_split('/\s*,\s*/', $sql); foreach ($fields as $field) { // Split each field into expression, <field> <as> <alias> where "as" and "alias" are optional. $fieldparts = preg_split('/\s+/', $field); if (count($fieldparts) == 2 || (count($fieldparts) == 3 && strtolower($fieldparts[1]) === 'as')) { $sql = reset($fieldparts); $alias = array_pop($fieldparts); $this->add_field($sql, $alias); } else { $this->add_field($field); } } $this->params += $params; return $this; } /** * Given a param name, add a unique prefix to ensure that the same column with params can be added multiple times to a report * * @param string $name * @return string */ private function unique_param_name(string $name): string { return "p{$this->index}_{$name}"; } /** * Helper method to take all fields added to the column, and return appropriate SQL and alias * * @return array[] */ private function get_fields_sql_alias(): array { $fields = []; foreach ($this->fields as $alias => $sql) { // Ensure parameter names within SQL are prefixed with column index. $params = array_keys($this->params); $sql = database::sql_replace_parameter_names($sql, $params, function(string $param): string { return $this->unique_param_name($param); }); $fields[$alias] = [ 'sql' => $sql, 'alias' => substr("c{$this->index}_{$alias}", 0, 30), ]; } return $fields; } /** * Return array of SQL expressions for each field of this column * * @return array */ public function get_fields(): array { $fieldsalias = $this->get_fields_sql_alias(); if (!empty($this->aggregation)) { $fieldsaliassql = array_column($fieldsalias, 'sql'); $field = reset($fieldsalias); // If aggregating the column, generate SQL from column fields and use it to generate aggregation SQL. $columnfieldsql = $this->aggregation::get_column_field_sql($fieldsaliassql); $aggregationfieldsql = $this->aggregation::get_field_sql($columnfieldsql, $this->get_type()); $fields = ["{$aggregationfieldsql} AS {$field['alias']}"]; } else { $fields = array_map(static function(array $field): string { return "{$field['sql']} AS {$field['alias']}"; }, $fieldsalias); } return array_values($fields); } /** * Return column parameters, prefixed by the current index to allow the column to be added multiple times to a report * * @return array */ public function get_params(): array { $params = []; foreach ($this->params as $name => $value) { $paramname = $this->unique_param_name($name); $params[$paramname] = $value; } return $params; } /** * Return an alias for this column (the generated alias of it's first field) * * @return string * @throws coding_exception */ public function get_column_alias(): string { if (!$fields = $this->get_fields_sql_alias()) { throw new coding_exception('Column ' . $this->get_unique_identifier() . ' contains no fields'); } return reset($fields)['alias']; } /** * Define suitable SQL fragment for grouping by the columns fields. This will be returned from {@see get_groupby_sql} if set * * @param string $groupbysql * @return self */ public function set_groupby_sql(string $groupbysql): self { $this->groupbysql = $groupbysql; return $this; } /** * Return suitable SQL fragment for grouping by the column fields (during aggregation) * * @return array */ public function get_groupby_sql(): array { global $DB; // Return defined value if it's already been set during column definition. if (!empty($this->groupbysql)) { return [$this->groupbysql]; } $fieldsalias = $this->get_fields_sql_alias(); // Note that we can reference field aliases in GROUP BY only in MySQL/Postgres. $usealias = in_array($DB->get_dbfamily(), ['mysql', 'postgres']); $columnname = $usealias ? 'alias' : 'sql'; return array_column($fieldsalias, $columnname); } /** * Adds column callback (in the case there are multiple, they will be called iteratively - the result of each passed * along to the next in the chain) * * The callback should implement the following signature (where $value is the first column field, $row is all column * fields, $additionalarguments are those passed to this method, and $aggregation indicates the current aggregation type * being applied to the column): * * function($value, stdClass $row, $additionalarguments, ?string $aggregation): string * * The type of the $value parameter passed to the callback is determined by calling {@see set_type}, this type is preserved * if the column is part of a report source and is being aggregated. For entities that can be left joined to a report, the * first argument of the callback must be nullable (as it should also be if the first column field is itself nullable). * * @param callable $callable * @param mixed $additionalarguments * @return self */ public function add_callback(callable $callable, $additionalarguments = null): self { $this->callbacks[] = [$callable, $additionalarguments]; return $this; } /** * Sets column callback. This will overwrite any previously added callbacks {@see add_callback} * * @param callable $callable * @param mixed $additionalarguments * @return self */ public function set_callback(callable $callable, $additionalarguments = null): self { $this->callbacks = []; return $this->add_callback($callable, $additionalarguments); } /** * Set column aggregation type * * @param string|null $aggregation Type of aggregation, e.g. 'sum', 'count', etc * @return self * @throws coding_exception For invalid aggregation type, or one that is incompatible with column type */ public function set_aggregation(?string $aggregation): self { if (!empty($aggregation)) { $aggregation = aggregation::get_full_classpath($aggregation); if (!aggregation::valid($aggregation) || !$aggregation::compatible($this->get_type())) { throw new coding_exception('Invalid column aggregation', $aggregation); } } $this->aggregation = $aggregation; return $this; } /** * Get column aggregation type * * @return base|null */ public function get_aggregation(): ?string { return $this->aggregation; } /** * Set disabled aggregation methods for the column. Typically only those methods suitable for the current column type are * available: {@see aggregation::get_column_aggregations}, however in some cases we may want to disable specific methods * * @param array $disabledaggregation Array of types, e.g. ['min', 'sum'] * @return self */ public function set_disabled_aggregation(array $disabledaggregation): self { $this->disabledaggregation = $disabledaggregation; return $this; } /** * Disable all aggregation methods for the column, for instance when current database can't aggregate fields that contain * sub-queries * * @return self */ public function set_disabled_aggregation_all(): self { $aggregationnames = array_map(static function(string $aggregation): string { return $aggregation::get_class_name(); }, aggregation::get_aggregations()); return $this->set_disabled_aggregation($aggregationnames); } /** * Return those aggregations methods explicitly disabled for the column * * @return array */ public function get_disabled_aggregation(): array { return $this->disabledaggregation; } /** * Sets the column as sortable * * @param bool $issortable * @param array $sortfields Define the fields that should be used when the column is sorted, typically a subset of the fields * selected for the column, via {@see add_field}. If omitted then the first selected field is used * @return self */ public function set_is_sortable(bool $issortable, array $sortfields = []): self { $this->issortable = $issortable; $this->sortfields = $sortfields; return $this; } /** * Return sortable status of column * * @return bool */ public function get_is_sortable(): bool { // Defer sortable status to aggregation type if column is being aggregated. if (!empty($this->aggregation)) { return $this->aggregation::sortable($this->issortable); } return $this->issortable; } /** * Return fields to use for sorting of the column, where available the field aliases will be returned * * @return array */ public function get_sort_fields(): array { $fieldsalias = $this->get_fields_sql_alias(); return array_map(static function(string $sortfield) use ($fieldsalias): string { // Check whether sortfield refers to a defined field alias. if (array_key_exists($sortfield, $fieldsalias)) { return $fieldsalias[$sortfield]['alias']; } // Check whether sortfield refers to field SQL. foreach ($fieldsalias as $field) { if (strcasecmp($sortfield, $field['sql']) === 0) { $sortfield = $field['alias']; break; } } return $sortfield; }, $this->sortfields); } /** * Extract all values from given row for this column * * @param array $row * @return array */ private function get_values(array $row): array { $values = []; // During aggregation we only get a single alias back, subsequent aliases won't exist. foreach ($this->get_fields_sql_alias() as $alias => $field) { $values[$alias] = $row[$field['alias']] ?? null; } return $values; } /** * Return the default column value, that being the value of it's first field * * @param array $values * @param int $columntype * @return mixed */ public static function get_default_value(array $values, int $columntype) { $value = reset($values); if ($value === null) { return $value; } // Ensure default value is cast to it's strict type. switch ($columntype) { case self::TYPE_INTEGER: case self::TYPE_TIMESTAMP: $value = (int) $value; break; case self::TYPE_FLOAT: $value = (float) $value; break; case self::TYPE_BOOLEAN: $value = (bool) $value; break; } return $value; } /** * Return column value based on complete table row * * @param array $row * @return mixed */ public function format_value(array $row) { $values = $this->get_values($row); $value = self::get_default_value($values, $this->get_type()); // If column is being aggregated then defer formatting to them, otherwise loop through all column callbacks. if (!empty($this->aggregation)) { $value = $this->aggregation::format_value($value, $values, $this->callbacks, $this->get_type()); } else { foreach ($this->callbacks as $callback) { [$callable, $arguments] = $callback; $value = ($callable)($value, (object) $values, $arguments, null); } } return $value; } /** * Add column attributes (data-, class, etc.) that will be included in HTML when column is displayed * * @param array $attributes * @return self */ public function add_attributes(array $attributes): self { $this->attributes = $attributes + $this->attributes; return $this; } /** * Returns the column HTML attributes * * @return array */ public function get_attributes(): array { return $this->attributes; } /** * Return available state of the column for the current user. For instance the column may be added to a report with the * expectation that only some users are able to see it * * @return bool */ public function get_is_available(): bool { return $this->available; } /** * Conditionally set whether the column is available. * * @param bool $available * @return self */ public function set_is_available(bool $available): self { $this->available = $available; return $this; } /** * Set deprecated state of the column, in which case it will still be shown when already present in existing reports but * won't be available for selection in the report editor * * @param string $deprecatedmessage * @return self */ public function set_is_deprecated(string $deprecatedmessage = ''): self { $this->deprecated = true; $this->deprecatedmessage = $deprecatedmessage; return $this; } /** * Return deprecated state of the column * * @return bool */ public function get_is_deprecated(): bool { return $this->deprecated; } /** * Return deprecated message of the column * * @return string */ public function get_is_deprecated_message(): string { return $this->deprecatedmessage; } /** * Set column persistent * * @param column_model $persistent * @return self */ public function set_persistent(column_model $persistent): self { $this->persistent = $persistent; return $this; } /** * Return column persistent * * @return mixed */ public function get_persistent(): column_model { return $this->persistent; } } PK a<�\��� 2 classes/local/systemreports/report_access_list.phpnu �[��� <?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\local\systemreports; use core_reportbuilder\local\models\audience; use core_reportbuilder\local\models\report; use core_reportbuilder\permission; use core_reportbuilder\system_report; use core_reportbuilder\local\entities\user; use core_reportbuilder\local\helpers\audience as audience_helper; /** * Report access list * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report_access_list extends system_report { /** * Initialise the report */ protected function initialise(): void { $userentity = new user(); $userentityalias = $userentity->get_table_alias('user'); $this->set_main_table('user', $userentityalias); $this->add_entity($userentity); // Find users allowed to view the report thru the report audiences. $audiences = audience::get_records(['reportid' => $this->get_parameter('id', 0, PARAM_INT)]); [$wheres, $params] = audience_helper::user_audience_sql($audiences, $userentityalias); if (count($wheres) > 0) { $select = '(' . implode(' OR ', $wheres) . ')'; } else { $select = "1=0"; } $this->add_base_condition_sql($select, $params); $this->add_base_condition_simple("{$userentityalias}.deleted", 0); $this->add_columns($userentity); $this->add_filters($userentity); $this->set_downloadable(false); } /** * Ensure we can view the report * * @return bool */ protected function can_view(): bool { $reportid = $this->get_parameter('id', 0, PARAM_INT); $report = report::get_record(['id' => $reportid], MUST_EXIST); return permission::can_edit_report($report); } /** * Add columns to report * * @param user $userentity */ protected function add_columns(user $userentity): void { $this->add_column($userentity->get_column('fullnamewithpicturelink')); // Include all identity field columns. $identitycolumns = $userentity->get_identity_columns($this->get_context()); foreach ($identitycolumns as $identitycolumn) { $this->add_column($identitycolumn); } $this->set_initial_sort_column('user:fullnamewithpicturelink', SORT_ASC); } /** * Add filters to report * * @param user $userentity */ protected function add_filters(user $userentity): void { $this->add_filter($userentity->get_filter('fullname')); // Include all identity field filters. $identityfilters = $userentity->get_identity_filters($this->get_context()); foreach ($identityfilters as $identityfilter) { $this->add_filter($identityfilter); } } } PK a<�\��UGP, P, 0 classes/local/systemreports/report_schedules.phpnu �[��� <?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\local\systemreports; use context; use lang_string; use moodle_url; use pix_icon; use stdClass; use core_reportbuilder\permission; use core_reportbuilder\system_report; use core_reportbuilder\local\entities\user; use core_reportbuilder\local\filters\date; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\helpers\format; use core_reportbuilder\local\models\report; use core_reportbuilder\local\models\schedule; use core_reportbuilder\local\report\action; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; use core_reportbuilder\output\schedule_name_editable; /** * Report schedules list * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report_schedules extends system_report { /** * The name of our internal report entity * * @return string */ private function get_schedule_entity_name(): string { return 'schedule'; } /** * Initialise the report */ protected function initialise(): void { $this->set_main_table(schedule::TABLE, 'sc'); $this->add_join('JOIN {' . report::TABLE . '} rb ON rb.id = sc.reportid'); $this->add_base_condition_simple('sc.reportid', $this->get_parameter('reportid', 0, PARAM_INT)); // Select fields required for actions, permission checks, and row class callbacks. $this->add_base_fields('sc.id, sc.name, sc.enabled, rb.contextid'); // Join user entity for "User modified" column. $entityuser = new user(); $entityuseralias = $entityuser->get_table_alias('user'); $this->add_entity($entityuser ->add_join("JOIN {user} {$entityuseralias} ON {$entityuseralias}.id = sc.usermodified") ); // Define our internal entity for schedule elements. $this->annotate_entity($this->get_schedule_entity_name(), new lang_string('schedules', 'core_reportbuilder')); $this->add_columns(); $this->add_filters(); $this->add_actions(); $this->set_downloadable(false); } /** * Ensure we can view the report * * @return bool */ protected function can_view(): bool { $reportid = $this->get_parameter('reportid', 0, PARAM_INT); $report = report::get_record(['id' => $reportid], MUST_EXIST); return permission::can_edit_report($report); } /** * Dim the table row for disabled schedules * * @param stdClass $row * @return string */ public function get_row_class(stdClass $row): string { return $row->enabled ? '' : 'text-muted'; } /** * Add columns to report */ protected function add_columns(): void { $tablealias = $this->get_main_table_alias(); // Enable toggle column. $this->add_column((new column( 'enabled', null, $this->get_schedule_entity_name() )) ->set_type(column::TYPE_BOOLEAN) ->add_fields("{$tablealias}.enabled, {$tablealias}.id") ->set_is_sortable(false) ->set_callback(static function(bool $enabled, stdClass $row): string { global $PAGE; $renderer = $PAGE->get_renderer('core_reportbuilder'); $attributes = [ ['name' => 'id', 'value' => $row->id], ['name' => 'action', 'value' => 'schedule-toggle'], ['name' => 'state', 'value' => $row->enabled], ]; $label = $row->enabled ? get_string('disableschedule', 'core_reportbuilder') : get_string('enableschedule', 'core_reportbuilder'); return $renderer->render_from_template('core/toggle', [ 'id' => 'schedule-toggle-' . $row->id, 'checked' => $row->enabled, 'dataattributes' => $attributes, 'label' => $label, 'labelclasses' => 'sr-only' ]); }) ); // Report name column. $this->add_column((new column( 'name', new lang_string('name'), $this->get_schedule_entity_name() )) ->set_type(column::TYPE_TEXT) // We need enough fields to re-create the persistent and pass to the editable component. ->add_fields("{$tablealias}.id, {$tablealias}.name, {$tablealias}.reportid") ->set_is_sortable(true, ["{$tablealias}.name"]) ->add_callback(function(string $value, stdClass $schedule): string { global $PAGE; $editable = new schedule_name_editable(0, new schedule(0, $schedule)); return $editable->render($PAGE->get_renderer('core')); }) ); // Time scheduled column. $this->add_column((new column( 'timescheduled', new lang_string('startingfrom'), $this->get_schedule_entity_name() )) ->set_type(column::TYPE_TIMESTAMP) ->add_fields("{$tablealias}.timescheduled") ->set_is_sortable(true) ->add_callback([format::class, 'userdate']) ); // Time last sent column. $this->add_column((new column( 'timelastsent', new lang_string('timelastsent', 'core_reportbuilder'), $this->get_schedule_entity_name() )) ->set_type(column::TYPE_TIMESTAMP) ->add_fields("{$tablealias}.timelastsent") ->set_is_sortable(true) ->add_callback(static function(int $timelastsent, stdClass $row): string { if ($timelastsent === 0) { return get_string('never'); } return format::userdate($timelastsent, $row); }) ); // Format column. $this->add_column((new column( 'format', new lang_string('format'), $this->get_schedule_entity_name() )) ->set_type(column::TYPE_TEXT) ->add_fields("{$tablealias}.format") ->set_is_sortable(true) ->add_callback(static function(string $format): string { if (get_string_manager()->string_exists('dataformat', 'dataformat_' . $format)) { return get_string('dataformat', 'dataformat_' . $format); } else { return $format; } }) ); // Time created column. $this->add_column((new column( 'timecreated', new lang_string('timecreated', 'core_reportbuilder'), $this->get_schedule_entity_name() )) ->set_type(column::TYPE_TIMESTAMP) ->add_fields("{$tablealias}.timecreated") ->set_is_sortable(true) ->add_callback([format::class, 'userdate']) ); // Time modified column. $this->add_column((new column( 'timemodified', new lang_string('timemodified', 'core_reportbuilder'), $this->get_schedule_entity_name() )) ->set_type(column::TYPE_TIMESTAMP) ->add_fields("{$tablealias}.timemodified") ->set_is_sortable(true) ->add_callback([format::class, 'userdate']) ); // The user who modified the schedule. $this->add_column_from_entity('user:fullname') ->set_title(new lang_string('usermodified', 'core_reportbuilder')); // Initial sorting. $this->set_initial_sort_column('schedule:timecreated', SORT_DESC); } /** * Add filters to report */ protected function add_filters(): void { $tablealias = $this->get_main_table_alias(); // Name filter. $this->add_filter((new filter( text::class, 'name', new lang_string('name'), $this->get_schedule_entity_name(), "{$tablealias}.name" ))); // Time created filter. $this->add_filter((new filter( date::class, 'timelastsent', new lang_string('timelastsent', 'core_reportbuilder'), $this->get_schedule_entity_name(), "{$tablealias}.timelastsent" )) ->set_limited_operators([ date::DATE_ANY, date::DATE_EMPTY, date::DATE_RANGE, date::DATE_PREVIOUS, date::DATE_CURRENT, ]) ); } /** * Add actions to report */ protected function add_actions(): void { // Edit action. $this->add_action(new action( new moodle_url('#'), new pix_icon('t/edit', ''), ['data-action' => 'schedule-edit', 'data-schedule-id' => ':id'], false, new lang_string('editscheduledetails', 'core_reportbuilder') )); // Send now action. $this->add_action((new action( new moodle_url('#'), new pix_icon('t/email', ''), ['data-action' => 'schedule-send', 'data-schedule-id' => ':id', 'data-schedule-name' => ':name'], false, new lang_string('sendschedule', 'core_reportbuilder') )) ->add_callback(function(stdClass $row): bool { // Ensure data name attribute is properly formatted. $row->name = (new schedule(0, $row))->get_formatted_name( context::instance_by_id($row->contextid)); return true; }) ); // Delete action. $this->add_action((new action( new moodle_url('#'), new pix_icon('t/delete', ''), [ 'data-action' => 'schedule-delete', 'data-schedule-id' => ':id', 'data-schedule-name' => ':name', 'class' => 'text-danger', ], false, new lang_string('deleteschedule', 'core_reportbuilder') )) ->add_callback(function(stdClass $row): bool { // Ensure data name attribute is properly formatted. $row->name = (new schedule(0, $row))->get_formatted_name( context::instance_by_id($row->contextid)); return true; }) ); } } PK a<�\��U��. �. , classes/local/systemreports/reports_list.phpnu �[��� <?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\local\systemreports; use html_writer; use lang_string; use moodle_url; use pix_icon; use stdClass; use core_reportbuilder\datasource; use core_reportbuilder\manager; use core_reportbuilder\system_report; use core_reportbuilder\local\entities\user; use core_reportbuilder\local\filters\date; use core_reportbuilder\local\filters\tags; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\filters\select; use core_reportbuilder\local\helpers\audience; use core_reportbuilder\local\helpers\format; use core_reportbuilder\local\report\action; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; use core_reportbuilder\output\report_name_editable; use core_reportbuilder\local\models\report; use core_reportbuilder\permission; use core_tag\reportbuilder\local\entities\tag; use core_tag_tag; /** * Reports list * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class reports_list extends system_report { /** * The name of our internal report entity * * @return string */ private function get_report_entity_name(): string { return 'report'; } /** * Initialise the report */ protected function initialise(): void { $this->set_main_table('reportbuilder_report', 'rb'); $this->add_base_condition_simple('rb.type', self::TYPE_CUSTOM_REPORT); // Select fields required for actions, permission checks, and row class callbacks. $this->add_base_fields('rb.id, rb.name, rb.source, rb.type, rb.usercreated, rb.contextid'); // Limit the returned list to those reports the current user can access. [$where, $params] = audience::user_reports_list_access_sql('rb'); $this->add_base_condition_sql($where, $params); // Join user entity for "User modified" column. $entityuser = new user(); $entityuseralias = $entityuser->get_table_alias('user'); $this->add_entity($entityuser ->add_join("JOIN {user} {$entityuseralias} ON {$entityuseralias}.id = rb.usermodified") ); // Join tag entity. $entitytag = new tag(); $this->add_entity($entitytag ->add_joins($entitytag->get_tag_joins('core_reportbuilder', 'reportbuilder_report', 'rb.id')) ); // Define our internal entity for report elements. $this->annotate_entity($this->get_report_entity_name(), new lang_string('customreports', 'core_reportbuilder')); $this->add_columns(); $this->add_filters(); $this->add_actions(); $this->set_downloadable(false); } /** * Ensure we can view the report * * @return bool */ protected function can_view(): bool { return permission::can_view_reports_list(); } /** * Dim the table row for invalid datasource * * @param stdClass $row * @return string */ public function get_row_class(stdClass $row): string { return $this->report_source_valid($row->source) ? '' : 'text-muted'; } /** * Add columns to report */ protected function add_columns(): void { $tablealias = $this->get_main_table_alias(); // Report name column. $this->add_column((new column( 'name', new lang_string('name'), $this->get_report_entity_name() )) ->set_type(column::TYPE_TEXT) // We need enough fields to re-create the persistent and pass to the editable component. ->add_fields(implode(', ', [ "{$tablealias}.id", "{$tablealias}.name", "{$tablealias}.contextid", "{$tablealias}.type", "{$tablealias}.usercreated", ])) ->set_is_sortable(true, ["{$tablealias}.name"]) ->add_callback(static function(string $value, stdClass $report): string { global $PAGE; $editable = new report_name_editable(0, new report(0, $report)); return $editable->render($PAGE->get_renderer('core')); }) ); // Report source column. $this->add_column((new column( 'source', new lang_string('reportsource', 'core_reportbuilder'), $this->get_report_entity_name() )) ->set_type(column::TYPE_TEXT) ->add_fields("{$tablealias}.source") ->set_is_sortable(true) ->add_callback(function(string $value, stdClass $row) { if (!$this->report_source_valid($value)) { // Add danger badge if report source is not valid (either it's missing, or has errors). return html_writer::span(get_string('errorsourceinvalid', 'core_reportbuilder'), 'badge bg-danger text-white'); } return call_user_func([$value, 'get_name']); }) ); // Tags column. $this->add_column_from_entity('tag:name') ->set_title(new lang_string('tags')) ->set_aggregation('groupconcat') ->set_is_available(core_tag_tag::is_enabled('core_reportbuilder', 'reportbuilder_report') === true); // Time created column. $this->add_column((new column( 'timecreated', new lang_string('timecreated', 'core_reportbuilder'), $this->get_report_entity_name() )) ->set_type(column::TYPE_TIMESTAMP) ->add_fields("{$tablealias}.timecreated") ->set_is_sortable(true) ->add_callback([format::class, 'userdate']) ); // Time modified column. $this->add_column((new column( 'timemodified', new lang_string('timemodified', 'core_reportbuilder'), $this->get_report_entity_name() )) ->set_type(column::TYPE_TIMESTAMP) ->add_fields("{$tablealias}.timemodified") ->set_is_sortable(true) ->add_callback([format::class, 'userdate']) ); // The user who modified the report. $this->add_column_from_entity('user:fullname') ->set_title(new lang_string('usermodified', 'reportbuilder')); // Initial sorting. $this->set_initial_sort_column('report:timecreated', SORT_DESC); } /** * Add filters to report */ protected function add_filters(): void { $tablealias = $this->get_main_table_alias(); // Name filter. $this->add_filter((new filter( text::class, 'name', new lang_string('name'), $this->get_report_entity_name(), "{$tablealias}.name" ))); // Source filter. $this->add_filter((new filter( select::class, 'source', new lang_string('reportsource', 'core_reportbuilder'), $this->get_report_entity_name(), "{$tablealias}.source" )) ->set_options_callback(static function(): array { return manager::get_report_datasources(); }) ); // Tags filter. $this->add_filter((new filter( tags::class, 'tags', new lang_string('tags'), $this->get_report_entity_name(), "{$tablealias}.id", )) ->set_options([ 'component' => 'core_reportbuilder', 'itemtype' => 'reportbuilder_report', ]) ->set_is_available(core_tag_tag::is_enabled('core_reportbuilder', 'reportbuilder_report') === true) ); // Time created filter. $this->add_filter((new filter( date::class, 'timecreated', new lang_string('timecreated', 'core_reportbuilder'), $this->get_report_entity_name(), "{$tablealias}.timecreated" )) ->set_limited_operators([ date::DATE_ANY, date::DATE_RANGE, ]) ); } /** * Add actions to report */ protected function add_actions(): void { // Edit content action. $this->add_action((new action( new moodle_url('/reportbuilder/edit.php', ['id' => ':id']), new pix_icon('t/right', ''), [], false, new lang_string('editreportcontent', 'core_reportbuilder') )) ->add_callback(function(stdClass $row): bool { return $this->report_source_valid($row->source) && permission::can_edit_report(new report(0, $row)); }) ); // Edit details action. $this->add_action((new action( new moodle_url('#'), new pix_icon('i/settings', ''), ['data-action' => 'report-edit', 'data-report-id' => ':id'], false, new lang_string('editreportdetails', 'core_reportbuilder') )) ->add_callback(function(stdClass $row): bool { return $this->report_source_valid($row->source) && permission::can_edit_report(new report(0, $row)); }) ); // Preview action. $this->add_action((new action( new moodle_url('/reportbuilder/view.php', ['id' => ':id']), new pix_icon('i/search', ''), [], false, new lang_string('viewreport', 'core_reportbuilder') )) ->add_callback(function(stdClass $row): bool { // We check this only to give the action to editors, because normal users can just click on the report name. return $this->report_source_valid($row->source) && permission::can_edit_report(new report(0, $row)); }) ); // Delete action. $this->add_action((new action( new moodle_url('#'), new pix_icon('t/delete', ''), [ 'data-action' => 'report-delete', 'data-report-id' => ':id', 'data-report-name' => ':name', 'class' => 'text-danger', ], false, new lang_string('deletereport', 'core_reportbuilder') )) ->add_callback(function(stdClass $row): bool { // Ensure data name attribute is properly formatted. $report = new report(0, $row); $row->name = $report->get_formatted_name(); // We don't check whether report is valid to ensure editor can always delete them. return permission::can_edit_report($report); }) ); } /** * Helper to determine whether given report source is valid (it both exists, and is available) * * @param string $source * @return bool */ private function report_source_valid(string $source): bool { return manager::report_source_exists($source, datasource::class) && manager::report_source_available($source); } } PK a<�\��0�$ �$ classes/local/audiences/base.phpnu �[��� <?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\local\audiences; use core_plugin_manager; use MoodleQuickForm; use stdClass; use core\output\notification; use core_reportbuilder\external\custom_report_audience_cards_exporter; use core_reportbuilder\local\helpers\database; use core_reportbuilder\local\models\audience; use core_reportbuilder\exception\report_access_exception; /** * Audience base class * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class base { /** @var int Maximim number of multi-select elements to show in description, before appending "plus X more" */ private const MULTI_SELECT_LIMIT = 5; /** @var audience The persistent object associated with this audience */ protected $audience; /** * Protected constructor, please use the static instance method. */ protected function __construct() { } /** * Creates an instance of audience type, with persistent. Typically by loading an existing record, however in the absence of * specified classname (in the case of {@see custom_report_audience_cards_exporter}) we create one based on the current class * * @param int $id * @param null|stdClass $record * @return self|null */ final public static function instance(int $id = 0, ?stdClass $record = null): ?self { $persistent = new audience($id, $record); // Populate persistent classname automatically if not set (e.g. when not loading an existing instance). if (!$classname = $persistent->get('classname')) { $classname = get_called_class(); $persistent->set('classname', $classname); } // Check if audience type class still exists in the system. if (!class_exists($classname)) { return null; } $instance = new $classname(); $instance->audience = $persistent; return $instance; } /** * Creates a new audience and saves it to database * * @param int $reportid * @param array $configdata * @return self */ final public static function create(int $reportid, array $configdata): self { $record = new stdClass(); $record->reportid = $reportid; $record->classname = get_called_class(); $record->configdata = json_encode($configdata); $instance = self::instance(0, $record); $instance->audience->save(); return $instance; } /** * Return display name of the component the audience belongs to * * @return string */ final public function get_component_displayname(): string { [$component] = explode('\\', get_class($this)); if ($plugininfo = core_plugin_manager::instance()->get_plugin_info($component)) { return $plugininfo->displayname; } // Return generic site text for those audiences belonging to core subsystems. return get_string('site'); } /** * Helps to build SQL to retrieve users that matches the current audience * * Implementations must use {@see database::generate_alias} and {@see database::generate_param_name} for table/column * aliases and parameter names * * @param string $usertablealias * @return array array of three elements [$join, $where, $params] */ abstract public function get_sql(string $usertablealias): array; /** * Returns string for audience category. * * @return string * * @deprecated since Moodle 4.2 - please do not use this function any more, {@see get_component_displayname} */ final public function get_category(): string { debugging('The function ' . __FUNCTION__ . '() is deprecated, please do not use it any more. ' . 'See class \'get_component_displayname\' method for replacement', DEBUG_DEVELOPER); return $this->get_component_displayname(); } /** * If the current user is able to add this audience type * * @return bool */ abstract public function user_can_add(): bool; /** * If the current user is able to edit this audience type * * @return bool */ abstract public function user_can_edit(): bool; /** * If the current user is able to use this audience type * * This method needs to return true if audience type is available to user for * reasons other than permission check, which is done in {@see user_can_add}. * (e.g. user can add cohort audience type only if there is at least one cohort * they can access). * * @return bool */ public function is_available(): bool { return true; } /** * Return user friendly name of the audience type * * @return string */ abstract public function get_name(): string; /** * Return the description of this audience type * * @return string */ abstract public function get_description(): string; /** * Helper to format descriptions for audience types that may contain many selected elements, limiting number show according * to {@see MULTI_SELECT_LIMIT} constant value * * @param array $elements * @return string */ protected function format_description_for_multiselect(array $elements): string { global $OUTPUT; // Warn user if there are no elements (because they may no longer exist). $elementcount = count($elements); if ($elementcount === 0) { $notification = new notification(get_string('nothingtodisplay'), notification::NOTIFY_WARNING); return $OUTPUT->render($notification); } $listseparator = get_string('listsep', 'langconfig') . ' '; if ($elementcount > self::MULTI_SELECT_LIMIT) { $elements = array_slice($elements, 0, self::MULTI_SELECT_LIMIT); // Append overflow element. $elementoverflow = $elementcount - self::MULTI_SELECT_LIMIT; $params = [ 'elements' => implode($listseparator, $elements), 'morecount' => $elementoverflow, ]; $description = get_string('audiencemultiselectpostfix', 'core_reportbuilder', $params); } else { $description = implode($listseparator, $elements); } return $description; } /** * Adds audience-specific form elements * * @param MoodleQuickForm $mform The form to add elements to */ abstract public function get_config_form(MoodleQuickForm $mform): void; /** * Validates the configform of the condition. * * @param array $data Data from the form * @return array Array with errors for each element */ public function validate_config_form(array $data): array { return []; } /** * Returns configdata as an associative array * * @return array decoded configdata */ final public function get_configdata(): array { return json_decode($this->audience->get('configdata'), true); } /** * Update configdata in audience persistent * * @param array $configdata */ final public function update_configdata(array $configdata): void { $this->audience->set('configdata', json_encode($configdata)); $this->audience->save(); } /** * Returns $configdata from form data suitable for use in DB record. * * @param stdClass $data data obtained from $mform->get_data() * @return array $configdata */ final public static function retrieve_configdata(stdClass $data): array { $configdata = (array) $data; $invalidkeys = array_fill_keys(['id', 'reportid', 'classname'], ''); return array_diff_key($configdata, $invalidkeys); } /** * Return audience persistent. * * @return audience */ public function get_persistent(): audience { return $this->audience; } /** * Require current user is able to add this audience type * * @throws report_access_exception */ final public function require_user_can_add(): void { if (!$this->user_can_add()) { throw new report_access_exception('errorreportedit'); } } /** * Require current user is able to edit this audience type * * @throws report_access_exception */ final public function require_user_can_edit(): void { if (!$this->user_can_edit()) { throw new report_access_exception('errorreportedit'); } } } PK a<�\0� 7 7 ! classes/local/models/schedule.phpnu �[��� <?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\local\models; use context; use core_reportbuilder\event\schedule_created; use core_reportbuilder\event\schedule_deleted; use core_reportbuilder\event\schedule_updated; use lang_string; use core\persistent; /** * Persistent class to represent a report schedule * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class schedule extends persistent { /** @var string Table name */ public const TABLE = 'reportbuilder_schedule'; /** @var int Send report schedule as viewed by recipient */ public const REPORT_VIEWAS_RECIPIENT = -1; /** @var int Send report schedule as viewed by creator */ public const REPORT_VIEWAS_CREATOR = 0; /** @var int Send report schedule as viewed by specific user */ public const REPORT_VIEWAS_USER = 1; /** @var int No recurrence */ public const RECURRENCE_NONE = 0; /** @var int Daily recurrence */ public const RECURRENCE_DAILY = 1; /** @var int Daily recurrence for week days only */ public const RECURRENCE_WEEKDAYS = 2; /** @var int Weekly recurrence */ public const RECURRENCE_WEEKLY = 3; /** @var int Monthly recurrence */ public const RECURRENCE_MONTHLY = 4; /** @var int Annual recurrence */ public const RECURRENCE_ANNUALLY = 5; /** @var int Send schedule with empty report */ public const REPORT_EMPTY_SEND_EMPTY = 0; /** @var int Send schedule without report */ public const REPORT_EMPTY_SEND_WITHOUT = 1; /** @var int Don't send schedule if report is empty */ public const REPORT_EMPTY_DONT_SEND = 2; /** * Return the definition of the properties of this model. * * @return array */ protected static function define_properties(): array { return [ 'reportid' => [ 'type' => PARAM_INT, ], 'name' => [ 'type' => PARAM_TEXT, ], 'enabled' => [ 'type' => PARAM_BOOL, 'default' => true, ], 'audiences' => [ 'type' => PARAM_RAW, 'default' => '[]', ], 'format' => [ 'type' => PARAM_PLUGIN, ], 'subject' => [ 'type' => PARAM_TEXT, ], 'message' => [ 'type' => PARAM_CLEANHTML, ], 'messageformat' => [ 'type' => PARAM_INT, 'default' => FORMAT_HTML, 'choices' => [ FORMAT_MOODLE, FORMAT_HTML, FORMAT_PLAIN, FORMAT_MARKDOWN, ], ], 'userviewas' => [ 'type' => PARAM_INT, 'default' => self::REPORT_VIEWAS_CREATOR, ], 'timescheduled' => [ 'type' => PARAM_INT, ], 'recurrence' => [ 'type' => PARAM_INT, 'default' => self::RECURRENCE_NONE, 'choices' => [ self::RECURRENCE_NONE, self::RECURRENCE_DAILY, self::RECURRENCE_WEEKDAYS, self::RECURRENCE_WEEKLY, self::RECURRENCE_MONTHLY, self::RECURRENCE_ANNUALLY, ], ], 'reportempty' => [ 'type' => PARAM_INT, 'default' => self::REPORT_EMPTY_SEND_EMPTY, 'choices' => [ self::REPORT_EMPTY_SEND_EMPTY, self::REPORT_EMPTY_SEND_WITHOUT, self::REPORT_EMPTY_DONT_SEND, ], ], 'timelastsent' => [ 'type' => PARAM_INT, 'default' => 0, ], 'timenextsend' => [ 'type' => PARAM_INT, 'default' => 0, ], 'usercreated' => [ 'type' => PARAM_INT, 'default' => static function(): int { global $USER; return (int) $USER->id; }, ], ]; } /** * Validate reportid property * * @param int $reportid * @return bool|lang_string */ protected function validate_reportid(int $reportid) { if (!report::record_exists($reportid)) { return new lang_string('invaliddata', 'error'); } return true; } /** * Return the report this schedule belongs to * * @return report */ public function get_report(): report { return new report($this->get('reportid')); } /** * Return formatted schedule name * * @param context|null $context If the context of the report is already known, it should be passed here * @return string */ public function get_formatted_name(?context $context = null): string { if ($context === null) { $context = $this->get_report()->get_context(); } return format_string($this->raw_get('name'), true, ['context' => $context]); } /** * Hook to execute after creation */ protected function after_create(): void { schedule_created::create_from_object($this)->trigger(); } /** * Hook to execute after update * * @param bool $result */ protected function after_update($result): void { if ($result) { schedule_updated::create_from_object($this)->trigger(); } } /** * Hook to execute after deletion * * @param bool $result */ protected function after_delete($result): void { if ($result) { schedule_deleted::create_from_object($this)->trigger(); } } } PK a<�\���� � classes/local/models/report.phpnu �[��� <?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\local\models; use context; use context_system; use core\persistent; use core_reportbuilder\event\report_created; use core_reportbuilder\event\report_deleted; use core_reportbuilder\event\report_updated; use core_reportbuilder\local\report\base; /** * Persistent class to represent a report * * @package core_reportbuilder * @copyright 2018 Alberto Lara Hernández <albertolara@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report extends persistent { /** @var string The table name. */ public const TABLE = 'reportbuilder_report'; /** * Return the definition of the properties of this model * * @return array */ protected static function define_properties(): array { return [ 'name' => [ 'type' => PARAM_TEXT, 'null' => NULL_ALLOWED, 'default' => null, ], 'source' => [ 'type' => PARAM_RAW, ], 'type' => [ 'type' => PARAM_INT, 'choices' => [ base::TYPE_CUSTOM_REPORT, base::TYPE_SYSTEM_REPORT, ], ], 'uniquerows' => [ 'type' => PARAM_BOOL, 'default' => false, ], 'conditiondata' => [ 'type' => PARAM_RAW, 'null' => NULL_ALLOWED, 'default' => null, ], 'settingsdata' => [ 'type' => PARAM_RAW, 'null' => NULL_ALLOWED, 'default' => null, ], 'contextid' => [ 'type' => PARAM_INT, 'default' => static function(): int { return context_system::instance()->id; } ], 'component' => [ 'type' => PARAM_COMPONENT, 'default' => '', ], 'area' => [ 'type' => PARAM_AREA, 'default' => '', ], 'itemid' => [ 'type' => PARAM_INT, 'default' => 0, ], 'usercreated' => [ 'type' => PARAM_INT, 'default' => static function(): int { global $USER; return (int) $USER->id; }, ], ]; } /** * Trigger report created event when persistent is created */ protected function after_create(): void { if ($this->get('type') === base::TYPE_CUSTOM_REPORT) { report_created::create_from_object($this)->trigger(); } } /** * Cascade report deletion, first deleting any linked persistents */ protected function before_delete(): void { $reportparams = ['reportid' => $this->get('id')]; // Columns. foreach (column::get_records($reportparams) as $column) { $column->delete(); } // Filters. foreach (filter::get_records($reportparams) as $filter) { $filter->delete(); } // Audiences. foreach (audience::get_records($reportparams) as $audience) { $audience->delete(); } // Schedules. foreach (schedule::get_records($reportparams) as $schedule) { $schedule->delete(); } } /** * Throw report deleted event when persistent is deleted * * @param bool $result */ protected function after_delete($result): void { if (!$result || $this->get('type') === base::TYPE_SYSTEM_REPORT) { return; } report_deleted::create_from_object($this)->trigger(); } /** * Throw report updated event when persistent is updated * * @param bool $result */ protected function after_update($result): void { if (!$result || $this->get('type') === base::TYPE_SYSTEM_REPORT) { return; } report_updated::create_from_object($this)->trigger(); } /** * Return report context, used by exporters * * @return context */ public function get_context(): context { return context::instance_by_id($this->raw_get('contextid')); } /** * Return formatted report name * * @return string */ public function get_formatted_name(): string { return format_string($this->raw_get('name'), true, ['context' => $this->get_context(), 'escape' => true]); } } PK a<�\���� � ! classes/local/models/audience.phpnu �[��� <?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\local\models; use context; use core_reportbuilder\event\audience_created; use core_reportbuilder\event\audience_deleted; use core_reportbuilder\event\audience_updated; use lang_string; use core\persistent; use core_reportbuilder\local\helpers\audience as helper; /** * Persistent class to represent a report audience * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class audience extends persistent { /** @var string Table name */ public const TABLE = 'reportbuilder_audience'; /** * Return the definition of the properties of this model. * * @return array */ protected static function define_properties(): array { return [ 'reportid' => [ 'type' => PARAM_INT, ], 'heading' => [ 'type' => PARAM_TEXT, 'null' => NULL_ALLOWED, 'default' => null, ], 'classname' => [ 'type' => PARAM_TEXT, ], 'configdata' => [ 'type' => PARAM_RAW, 'default' => '{}', ], 'usercreated' => [ 'type' => PARAM_INT, 'default' => static function(): int { global $USER; return (int) $USER->id; }, ], ]; } /** * Validate reportid property * * @param int $reportid * @return bool|lang_string */ protected function validate_reportid(int $reportid) { if (!report::record_exists($reportid)) { return new lang_string('invaliddata', 'error'); } return true; } /** * Hook to execute after creation */ protected function after_create(): void { audience_created::create_from_object($this)->trigger(); helper::purge_caches(); } /** * Hook to execute after update * * @param bool $result */ protected function after_update($result): void { if ($result) { audience_updated::create_from_object($this)->trigger(); helper::purge_caches(); } } /** * Hook to execute after deletion * * @param bool $result */ protected function after_delete($result): void { if ($result) { audience_deleted::create_from_object($this)->trigger(); helper::purge_caches(); } } /** * Return the report this audience belongs to * * @return report */ public function get_report(): report { return new report($this->get('reportid')); } /** * Return formatted audience heading * * @param context|null $context If the context of the report is already known, it should be passed here * @return string */ public function get_formatted_heading(?context $context = null): string { if ($context === null) { $context = $this->get_report()->get_context(); } return format_string($this->raw_get('heading'), true, ['context' => $context]); } } PK a<�\�7T� � classes/local/models/filter.phpnu �[��� <?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\local\models; use context; use lang_string; use core\persistent; use core_reportbuilder\datasource; /** * Persistent class to represent a report filter/condition * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class filter extends persistent { /** @var string The table name. */ public const TABLE = 'reportbuilder_filter'; /** * Return the definition of the properties of this model. * * @return array */ protected static function define_properties(): array { return [ 'reportid' => [ 'type' => PARAM_INT, ], 'uniqueidentifier' => [ 'type' => PARAM_RAW, ], 'heading' => [ 'type' => PARAM_TEXT, 'null' => NULL_ALLOWED, 'default' => null, ], 'iscondition' => [ 'type' => PARAM_BOOL, 'default' => false, ], 'filterorder' => [ 'type' => PARAM_INT, ], 'usercreated' => [ 'type' => PARAM_INT, 'default' => static function(): int { global $USER; return (int) $USER->id; }, ], ]; } /** * Validate reportid property * * @param int $reportid * @return bool|lang_string */ protected function validate_reportid(int $reportid) { if (!report::record_exists($reportid)) { return new lang_string('invaliddata', 'error'); } return true; } /** * Ensure report source is notified of new filter */ protected function after_create(): void { datasource::report_elements_modified($this->get('reportid')); } /** * Ensure report source is notified of updated filter * * @param bool $result */ protected function after_update($result): void { if ($result) { datasource::report_elements_modified($this->get('reportid')); } } /** * Ensure report source is notified of deleted filter * * @param bool $result */ protected function after_delete($result): void { if ($result) { datasource::report_elements_modified($this->get('reportid')); } } /** * Return the report this filter belongs to * * @return report */ public function get_report(): report { return new report($this->get('reportid')); } /** * Return filter record * * @param int $reportid * @param int $filterid * @return false|static */ public static function get_filter_record(int $reportid, int $filterid) { return self::get_record(['id' => $filterid, 'reportid' => $reportid, 'iscondition' => 0]); } /** * Return filter records for report * * @param int $reportid * @param string $sort * @param string $order * @return static[] */ public static function get_filter_records(int $reportid, string $sort = '', string $order = 'ASC'): array { return self::get_records(['reportid' => $reportid, 'iscondition' => 0], $sort, $order); } /** * Return condition record * * @param int $reportid * @param int $conditionid * @return false|static */ public static function get_condition_record(int $reportid, int $conditionid) { return self::get_record(['id' => $conditionid, 'reportid' => $reportid, 'iscondition' => 1]); } /** * Return condition records for report * * @param int $reportid * @param string $sort * @param string $order * @return static[] */ public static function get_condition_records(int $reportid, string $sort = '', string $order = 'ASC'): array { return self::get_records(['reportid' => $reportid, 'iscondition' => 1], $sort, $order); } /** * Helper method to return the current maximum filter order value for a report * * @param int $reportid * @param bool $iscondition * @return int */ public static function get_max_filterorder(int $reportid, bool $iscondition = false): int { global $DB; $params = ['reportid' => $reportid, 'iscondition' => (int) $iscondition]; return (int) $DB->get_field(static::TABLE, "MAX(filterorder)", $params, MUST_EXIST); } /** * Return formatted filter heading * * @param context|null $context If the context of the report is already known, it should be passed here * @return string */ public function get_formatted_heading(?context $context = null): string { if ($context === null) { $context = $this->get_report()->get_context(); } return format_string($this->raw_get('heading'), true, ['context' => $context]); } } PK a<�\R�j�� � classes/local/models/column.phpnu �[��� <?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\local\models; use context; use lang_string; use core\persistent; use core_reportbuilder\datasource; /** * Persistent class to represent a report column * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class column extends persistent { /** @var string The table name. */ public const TABLE = 'reportbuilder_column'; /** * Return the definition of the properties of this model. * * @return array */ protected static function define_properties(): array { return [ 'reportid' => [ 'type' => PARAM_INT, ], 'uniqueidentifier' => [ 'type' => PARAM_RAW, ], 'aggregation' => [ 'type' => PARAM_ALPHANUMEXT, 'default' => null, 'null' => NULL_ALLOWED, ], 'heading' => [ 'type' => PARAM_TEXT, 'default' => null, 'null' => NULL_ALLOWED, ], 'columnorder' => [ 'type' => PARAM_INT, ], 'sortenabled' => [ 'type' => PARAM_BOOL, 'default' => false, ], 'sortdirection' => [ 'type' => PARAM_INT, 'choices' => [SORT_ASC, SORT_DESC], 'default' => SORT_ASC, ], 'sortorder' => [ 'type' => PARAM_INT, 'default' => null, 'null' => NULL_ALLOWED, ], 'usercreated' => [ 'type' => PARAM_INT, 'default' => static function(): int { global $USER; return (int) $USER->id; }, ], ]; } /** * Validate reportid property * * @param int $reportid * @return bool|lang_string */ protected function validate_reportid(int $reportid) { if (!report::record_exists($reportid)) { return new lang_string('invaliddata', 'error'); } return true; } /** * Return the report this column belongs to * * @return report */ public function get_report(): report { return new report($this->get('reportid')); } /** * Ensure report source is notified of new column */ protected function after_create(): void { datasource::report_elements_modified($this->get('reportid')); } /** * Ensure report source is notified of updated column * * @param bool $result */ protected function after_update($result): void { if ($result) { datasource::report_elements_modified($this->get('reportid')); } } /** * Ensure report source is notified of deleted column * * @param bool $result */ protected function after_delete($result): void { if ($result) { datasource::report_elements_modified($this->get('reportid')); } } /** * Helper method to return the current maximum column order value for a report * * @param int $reportid * @param string $columnname * @return int */ public static function get_max_columnorder(int $reportid, string $columnname): int { global $DB; return (int) $DB->get_field(static::TABLE, "MAX({$columnname})", ['reportid' => $reportid], MUST_EXIST); } /** * Return formatted column name * * @param context|null $context If the context of the report is already known, it should be passed here * @return string */ public function get_formatted_heading(?context $context = null): string { if ($context === null) { $context = $this->get_report()->get_context(); } return format_string($this->raw_get('heading'), true, ['context' => $context]); } } PK a<�\Y��"� � ! classes/local/aggregation/sum.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Column sum aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class sum extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationsum', 'core_reportbuilder'); } /** * This aggregation can be performed on all numeric and boolean columns * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return in_array($columntype, [ column::TYPE_INTEGER, column::TYPE_FLOAT, column::TYPE_BOOLEAN, ]); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { return "SUM({$field})"; } /** * Return formatted value for column when applying aggregation * * For boolean columns we return the sum of the true values, numeric columns execute original callbacks if present * * @param mixed $value * @param array $values * @param array $callbacks * @param int $columntype * @return mixed */ public static function format_value($value, array $values, array $callbacks, int $columntype) { $firstvalue = reset($values); if ($firstvalue === null) { return null; } if ($columntype === column::TYPE_BOOLEAN || empty($callbacks)) { $decimalpoints = (int) ($columntype === column::TYPE_FLOAT); return format_float((float) $firstvalue, $decimalpoints); } return parent::format_value($value, $values, $callbacks, $columntype); } } PK a<�\8�/. . " classes/local/aggregation/base.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Base class for column aggregation types * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class base { /** * Return the class name of the aggregation type * * @return string */ final public static function get_class_name(): string { $namespacedclass = explode('\\', get_called_class()); return end($namespacedclass); } /** * Return the display name of the aggregation * * @return lang_string */ abstract public static function get_name(): lang_string; /** * Whether the aggregation is compatible with the given column type * * @param int $columntype The type as defined by the {@see column::set_type} method * @return bool */ abstract public static function compatible(int $columntype): bool; /** * Whether the aggregation is sortable, by default return the sortable status of the column itself * * @param bool $columnsortable * @return bool */ public static function sortable(bool $columnsortable): bool { return $columnsortable; } /** * Return SQL suitable for using within {@see get_field_sql} for column fields, by default just the first one * * @param string[] $sqlfields * @return string */ public static function get_column_field_sql(array $sqlfields): string { return reset($sqlfields); } /** * Helper method for concatenating given fields for a column, so they are suitable for aggregation * * @param string[] $sqlfields * @param string $delimeter * @param string $coalescechar * @return string */ final protected static function get_column_fields_concat( array $sqlfields, string $delimeter = ',', string $coalescechar = ' ' ): string { global $DB; // We need to ensure all values are char. $sqlfieldrequirescast = in_array($DB->get_dbfamily(), ['mssql', 'oracle', 'postgres']); $concatfields = []; foreach ($sqlfields as $sqlfield) { if ($sqlfieldrequirescast) { $sqlfield = $DB->sql_cast_to_char($sqlfield); } // Coalesce all the SQL fields. Ensure cross-DB compatibility, and that we always get string data back. $concatfields[] = "COALESCE({$sqlfield}, '{$coalescechar}')"; $concatfields[] = "'{$delimeter}'"; } // Slice off the last delimeter. return $DB->sql_concat(...array_slice($concatfields, 0, -1)); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ abstract public static function get_field_sql(string $field, int $columntype): string; /** * Return formatted value for column when applying aggregation, by default executing all callbacks on the value * * Should be overridden in child classes that need to format the column value differently (e.g. 'sum' would just show * a numeric count value) * * @param mixed $value * @param array $values * @param array $callbacks Array of column callbacks, {@see column::add_callback} for definition * @param int $columntype The original type of the column, to ensure it is preserved for callbacks * @return mixed */ public static function format_value($value, array $values, array $callbacks, int $columntype) { foreach ($callbacks as $callback) { [$callable, $arguments] = $callback; $value = ($callable)($value, (object) $values, $arguments, static::get_class_name()); } return $value; } } PK a<�\%��.� � + classes/local/aggregation/countdistinct.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Column count distinct aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class countdistinct extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationcountdistinct', 'core_reportbuilder'); } /** * This aggregation can be performed on all column types * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return true; } /** * Override base method to ensure all SQL fields are concatenated together if there are multiple * * @param array $sqlfields * @return string */ public static function get_column_field_sql(array $sqlfields): string { if (count($sqlfields) === 1) { return parent::get_column_field_sql($sqlfields); } return self::get_column_fields_concat($sqlfields); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { global $DB; if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') { $field = $DB->sql_compare_text($field, 255); } return "COUNT(DISTINCT {$field})"; } /** * Return formatted value for column when applying aggregation * * @param mixed $value * @param array $values * @param array $callbacks * @param int $columntype * @return int */ public static function format_value($value, array $values, array $callbacks, int $columntype): int { return (int) reset($values); } } PK a<�\���� � ! classes/local/aggregation/max.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Column max aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class max extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationmax', 'core_reportbuilder'); } /** * This aggregation can be performed on all numeric/date/boolean types * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return in_array($columntype, [ column::TYPE_INTEGER, column::TYPE_FLOAT, column::TYPE_TIMESTAMP, column::TYPE_BOOLEAN, ]); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { return "MAX({$field})"; } } PK a<�\��8-? ? % classes/local/aggregation/percent.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\helpers\format; use core_reportbuilder\local\report\column; /** * Column percent aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class percent extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationpercent', 'core_reportbuilder'); } /** * This aggregation can be performed on all boolean columns * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return in_array($columntype, [ column::TYPE_BOOLEAN, ]); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { return "AVG(1.0 * {$field}) * 100.0"; } /** * Return formatted value for column when applying aggregation * * @param mixed $value * @param array $values * @param array $callbacks * @param int $columntype * @return string */ public static function format_value($value, array $values, array $callbacks, int $columntype): string { if (reset($values) === null) { return ''; } return format::percent((float) reset($values)); } } PK a<�\� � � ! classes/local/aggregation/min.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Column min aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class min extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationmin', 'core_reportbuilder'); } /** * This aggregation can be performed on all numeric/date/boolean types * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return in_array($columntype, [ column::TYPE_INTEGER, column::TYPE_FLOAT, column::TYPE_TIMESTAMP, column::TYPE_BOOLEAN, ]); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { return "MIN({$field})"; } } PK a<�\���ch h ! classes/local/aggregation/avg.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Column average aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class avg extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationavg', 'core_reportbuilder'); } /** * This aggregation can be performed on all numeric columns * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return in_array($columntype, [ column::TYPE_INTEGER, column::TYPE_FLOAT, column::TYPE_BOOLEAN, ]); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { return "AVG(1.0 * {$field})"; } /** * Return formatted value for column when applying aggregation * * For boolean columns we return the average of the values (0..1), numeric columns execute original callbacks if present * * @param mixed $value * @param array $values * @param array $callbacks * @param int $columntype * @return mixed */ public static function format_value($value, array $values, array $callbacks, int $columntype) { if (reset($values) === null) { return null; } if ($columntype === column::TYPE_BOOLEAN || empty($callbacks)) { return format_float((float) reset($values), 1); } return parent::format_value($value, $values, $callbacks, $columntype); } } PK a<�\�]� # classes/local/aggregation/count.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\report\column; /** * Column count aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class count extends base { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationcount', 'core_reportbuilder'); } /** * This aggregation can be performed on all column types * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return true; } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { global $DB; if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') { $field = $DB->sql_compare_text($field, 255); } return "COUNT({$field})"; } /** * Return formatted value for column when applying aggregation * * @param mixed $value * @param array $values * @param array $callbacks * @param int $columntype * @return int */ public static function format_value($value, array $values, array $callbacks, int $columntype): int { return (int) reset($values); } } PK a<�\s@�b� � 1 classes/local/aggregation/groupconcatdistinct.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\helpers\database; /** * Column group concatenation distinct aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class groupconcatdistinct extends groupconcat { /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationgroupconcatdistinct', 'core_reportbuilder'); } /** * This aggregation can be performed on all non-timestamp columns in MySQL, Postgres and Oracle only * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { global $DB; $dbsupportedtype = in_array($DB->get_dbfamily(), [ 'mysql', 'postgres', 'oracle', ]); return $dbsupportedtype && parent::compatible($columntype); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { global $DB; $fieldsort = database::sql_group_concat_sort($field); // Postgres handles group concatenation differently in that it requires the expression to be cast to char, so we can't // simply pass "DISTINCT {$field}" to the {@see \moodle_database::sql_group_concat} method in all cases. if ($DB->get_dbfamily() === 'postgres') { $field = $DB->sql_cast_to_char($field); if ($fieldsort !== '') { $fieldsort = "ORDER BY {$fieldsort}"; } return "STRING_AGG(DISTINCT {$field}, '" . self::FIELD_VALUE_DELIMETER . "' {$fieldsort})"; } else { return $DB->sql_group_concat("DISTINCT {$field}", self::FIELD_VALUE_DELIMETER, $fieldsort); } } } PK a<�\��� ) classes/local/aggregation/groupconcat.phpnu �[��� <?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\local\aggregation; use lang_string; use core_reportbuilder\local\helpers\database; use core_reportbuilder\local\report\column; /** * Column group concatenation aggregation type * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class groupconcat extends base { /** @var string Character to use as a delimeter between column fields */ protected const COLUMN_FIELD_DELIMETER = '<|>'; /** @var string Character to use a null coalesce value */ protected const COLUMN_NULL_COALESCE = '<^>'; /** @var string Character to use as a delimeter between field values */ protected const FIELD_VALUE_DELIMETER = '<,>'; /** * Return aggregation name * * @return lang_string */ public static function get_name(): lang_string { return new lang_string('aggregationgroupconcat', 'core_reportbuilder'); } /** * This aggregation can be performed on all non-timestamp columns * * @param int $columntype * @return bool */ public static function compatible(int $columntype): bool { return !in_array($columntype, [ column::TYPE_TIMESTAMP, ]); } /** * Override base method to ensure all SQL fields are concatenated together if there are multiple * * @param array $sqlfields * @return string */ public static function get_column_field_sql(array $sqlfields): string { if (count($sqlfields) === 1) { return parent::get_column_field_sql($sqlfields); } return self::get_column_fields_concat($sqlfields, self::COLUMN_FIELD_DELIMETER, self::COLUMN_NULL_COALESCE); } /** * Return the aggregated field SQL * * @param string $field * @param int $columntype * @return string */ public static function get_field_sql(string $field, int $columntype): string { global $DB; $fieldsort = database::sql_group_concat_sort($field); return $DB->sql_group_concat($field, self::FIELD_VALUE_DELIMETER, $fieldsort); } /** * Return formatted value for column when applying aggregation, note we need to split apart the concatenated string * and apply callbacks to each concatenated value separately * * @param mixed $value * @param array $values * @param array $callbacks * @param int $columntype * @return mixed */ public static function format_value($value, array $values, array $callbacks, int $columntype) { $firstvalue = reset($values); if ($firstvalue === null) { return ''; } $formattedvalues = []; // Store original names of all values that would be present without aggregation. $valuenames = array_keys($values); $valuenamescount = count($valuenames); // Loop over each extracted value from the concatenated string. $values = explode(self::FIELD_VALUE_DELIMETER, (string)$firstvalue); foreach ($values as $value) { // Ensure we have equal number of value names/data, account for truncation by DB. $valuedata = explode(self::COLUMN_FIELD_DELIMETER, $value); if ($valuenamescount !== count($valuedata)) { continue; } // Re-construct original values, also ensuring any nulls contained within are restored. $originalvalues = array_map(static function(string $value): ?string { return $value === self::COLUMN_NULL_COALESCE ? null : $value; }, array_combine($valuenames, $valuedata)); $originalvalue = column::get_default_value($originalvalues, $columntype); // Once we've re-constructed each value, we can apply callbacks to it. $formattedvalues[] = parent::format_value($originalvalue, $originalvalues, $callbacks, $columntype); } $listseparator = get_string('listsep', 'langconfig') . ' '; return implode($listseparator, $formattedvalues); } } PK a<�\.9�q� � - classes/local/helpers/user_filter_manager.phpnu �[��� <?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\local\helpers; use core_text; /** * This class handles the setting and retrieving of a users' filter values for given reports * * It is currently using the user preference API as a storage mechanism * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user_filter_manager { /** @var int The size of each chunk, matching the maximum length of a single user preference */ private const PREFERENCE_CHUNK_SIZE = 1333; /** @var string The prefix used to name the stored user preferences */ private const PREFERENCE_NAME_PREFIX = 'reportbuilder-report-'; /** * Generate user preference name for given report * * @param int $reportid * @param int $index * @return string */ private static function user_preference_name(int $reportid, int $index): string { return static::PREFERENCE_NAME_PREFIX . "{$reportid}-{$index}"; } /** * Set user filters for given report * * @param int $reportid * @param array $values * @param int|null $userid * @return bool */ public static function set(int $reportid, array $values, ?int $userid = null): bool { $jsonvalues = json_encode($values); $jsonchunks = str_split($jsonvalues, static::PREFERENCE_CHUNK_SIZE); foreach ($jsonchunks as $index => $jsonchunk) { $userpreference = static::user_preference_name($reportid, $index); set_user_preference($userpreference, $jsonchunk, $userid); } // Ensure any subsequent preferences are reset (to account for number of chunks decreasing). static::reset_all($reportid, $userid, $index + 1); return true; } /** * Get user filters for given report * * @param int $reportid * @param int|null $userid * @return array */ public static function get(int $reportid, ?int $userid = null): array { $jsonvalues = ''; $index = 0; // We'll repeatedly append chunks to our JSON string, until we hit one that is below the maximum length. do { $userpreference = static::user_preference_name($reportid, $index++); $jsonchunk = get_user_preferences($userpreference, '', $userid); $jsonvalues .= $jsonchunk; } while (core_text::strlen($jsonchunk) === static::PREFERENCE_CHUNK_SIZE); return (array) json_decode($jsonvalues); } /** * Merge individual user filter values for given report * * @param int $reportid * @param array $values * @param int|null $userid * @return bool */ public static function merge(int $reportid, array $values, ?int $userid = null): bool { $existing = static::get($reportid, $userid); return static::set($reportid, array_merge($existing, $values), $userid); } /** * Reset all user filters for given report * * @param int $reportid * @param int|null $userid * @param int $index If specified, then preferences will be reset starting from this index * @return bool */ public static function reset_all(int $reportid, ?int $userid = null, int $index = 0): bool { // We'll repeatedly retrieve and reset preferences, until we hit one that is below the maximum length. do { $userpreference = static::user_preference_name($reportid, $index++); $jsonchunk = get_user_preferences($userpreference, '', $userid); unset_user_preference($userpreference, $userid); } while (core_text::strlen($jsonchunk) === static::PREFERENCE_CHUNK_SIZE); return true; } /** * Reset single user filter for given report * * @param int $reportid * @param string $uniqueidentifier * @param int|null $userid * @return bool */ public static function reset_single(int $reportid, string $uniqueidentifier, ?int $userid = null): bool { $originalvalues = static::get($reportid, $userid); // Remove any filters whose name is prefixed by given identifier. $values = array_filter($originalvalues, static function(string $filterkey) use ($uniqueidentifier): bool { return core_text::strpos($filterkey, $uniqueidentifier) !== 0; }, ARRAY_FILTER_USE_KEY); return static::set($reportid, $values, $userid); } /** * Get all report filters for given user * * This is primarily designed for the privacy provider, and allows us to preserve all the preference logic within this class. * * @param int $userid * @return array */ public static function get_all_for_user(int $userid): array { global $DB; $prefs = []; // We need to locate the first preference chunk of all report filters. $select = 'userid = :userid AND ' . $DB->sql_like('name', ':namelike'); $params = [ 'userid' => $userid, 'namelike' => $DB->sql_like_escape(static::PREFERENCE_NAME_PREFIX) . '%-0', ]; $preferences = $DB->get_fieldset_select('user_preferences', 'name', $select, $params); // Retrieve all found filters. foreach ($preferences as $preference) { preg_match('/^' . static::PREFERENCE_NAME_PREFIX . '(?<reportid>\d+)\-/', $preference, $matches); $prefs[static::PREFERENCE_NAME_PREFIX . $matches['reportid']] = static::get((int) $matches['reportid'], $userid); } return $prefs; } } PK a<�\>i��0 �0 ' classes/local/helpers/custom_fields.phpnu �[��� <?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\local\helpers; use core\lang_string; use core_customfield\data_controller; use core_customfield\field_controller; use core_customfield\handler; use core_reportbuilder\local\filters\{boolean_select, date, number, select, text}; use core_reportbuilder\local\report\{column, filter}; use stdClass; /** * Helper class for course custom fields. * * @package core_reportbuilder * @copyright 2021 Sara Arjona <sara@moodle.com> based on David Matamoros <davidmc@moodle.com> code. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class custom_fields { use join_trait; /** @var handler $handler The handler for the customfields */ private handler $handler; /** * Constructor * * @param string $tablefieldalias The table/field alias to match the instance ID when adding columns and filters. * @param string $entityname The entity name used when adding columns and filters. * @param string $component component name of full frankenstyle plugin name. * @param string $area name of the area (each component/plugin may define handlers for multiple areas). * @param int $itemid item id if the area uses them (usually not used). */ public function __construct( /** @var string The table/field alias to match the instance ID when adding columns and filters */ private readonly string $tablefieldalias, /** @var string The entity name used when adding columns and filters */ private readonly string $entityname, string $component, string $area, int $itemid = 0, ) { $this->handler = handler::get_handler($component, $area, $itemid); } /** * Get table alias for given custom field * * The entity name is used to ensure the alias differs when the entity is used multiple times within the same report, each * having their own table alias/join * * @param field_controller $field * @return string */ private function get_table_alias(field_controller $field): string { static $aliases = []; $aliaskey = "{$this->entityname}_{$field->get('id')}"; if (!array_key_exists($aliaskey, $aliases)) { $aliases[$aliaskey] = database::generate_alias(); } return $aliases[$aliaskey]; } /** * Get table join for given custom field * * @param field_controller $field * @return string */ private function get_table_join(field_controller $field): string { $customdatatablealias = $this->get_table_alias($field); return "LEFT JOIN {customfield_data} {$customdatatablealias} ON {$customdatatablealias}.fieldid = {$field->get('id')} AND {$customdatatablealias}.instanceid = {$this->tablefieldalias}"; } /** * Gets the custom fields columns for the report. * * Column will be named as 'customfield_' + customfield shortname. * * @return column[] */ public function get_columns(): array { global $DB; $columns = []; $categorieswithfields = $this->handler->get_categories_with_fields(); foreach ($categorieswithfields as $fieldcategory) { $categoryfields = $fieldcategory->get_fields(); foreach ($categoryfields as $field) { $datacontroller = data_controller::create(0, null, $field); $datafield = $datacontroller->datafield(); $customdatatablealias = $this->get_table_alias($field); $customdatasql = "{$customdatatablealias}.{$datafield}"; // Numeric column (non-text) should coalesce with default, as should text fields for Oracle, for aggregation. $columntype = $this->get_column_type($field, $datafield); if (!in_array($columntype, [column::TYPE_TEXT, column::TYPE_LONGTEXT])) { // See MDL-78783 regarding no bound parameters, and Oracle limitations of GROUP BY. $customdatasql = " CASE WHEN {$this->tablefieldalias} IS NOT NULL THEN COALESCE({$customdatasql}, " . (float) $datacontroller->get_default_value() . ") ELSE NULL END"; } else if ($columntype === column::TYPE_LONGTEXT && $DB->get_dbfamily() === 'oracle') { $customdatasql = $DB->sql_order_by_text($customdatasql, 1024); } // Select enough fields to re-create and format each custom field instance value. $customdatasqlextra = "{$customdatatablealias}.id, {$customdatatablealias}.contextid"; if ($datafield === 'value') { // We will take the format into account when displaying the individual values. $customdatasqlextra .= ", {$customdatatablealias}.valueformat, {$customdatatablealias}.valuetrust"; } $columns[] = (new column( 'customfield_' . $field->get('shortname'), new lang_string('customfieldcolumn', 'core_reportbuilder', $field->get_formatted_name(false)), $this->entityname )) ->add_joins($this->get_joins()) ->add_join($this->get_table_join($field)) ->add_field($customdatasql, $datafield) ->add_fields($customdatasqlextra) ->add_field($this->tablefieldalias, 'tablefieldalias') ->set_type($columntype) ->set_is_sortable($columntype !== column::TYPE_LONGTEXT) ->add_callback(static function($value, stdClass $row, field_controller $field, ?string $aggregation): string { if ($row->tablefieldalias === null && $value === null) { return ''; } // If aggregating numeric column, populate row ID to ensure the controller is created correctly. if (in_array((string) $aggregation, ['avg', 'max', 'min', 'sum'])) { $row->id ??= -1; } return (string) data_controller::create(0, $row, $field)->export_value(); }, $field) // Important. If the handler implements can_view() function, it will be called with parameter $instanceid=0. // This means that per-instance access validation will be ignored. ->set_is_available($this->handler->can_view($field, 0)); } } return $columns; } /** * Returns the column type * * @param field_controller $field * @param string $datafield * @return int */ private function get_column_type(field_controller $field, string $datafield): int { if ($field->get('type') === 'checkbox') { return column::TYPE_BOOLEAN; } if ($field->get('type') === 'date') { return column::TYPE_TIMESTAMP; } if ($field->get('type') === 'select') { return column::TYPE_TEXT; } if ($datafield === 'intvalue') { return column::TYPE_INTEGER; } if ($datafield === 'decvalue') { return column::TYPE_FLOAT; } if ($datafield === 'value') { return column::TYPE_LONGTEXT; } return column::TYPE_TEXT; } /** * Returns all available filters on custom fields. * * Filter will be named as 'customfield_' + customfield shortname. * * @return filter[] */ public function get_filters(): array { global $DB; $filters = []; $categorieswithfields = $this->handler->get_categories_with_fields(); foreach ($categorieswithfields as $fieldcategory) { $categoryfields = $fieldcategory->get_fields(); foreach ($categoryfields as $field) { $datacontroller = data_controller::create(0, null, $field); $datafield = $datacontroller->datafield(); $customdatatablealias = $this->get_table_alias($field); $customdatasql = "{$customdatatablealias}.{$datafield}"; $customdataparams = []; if ($datafield === 'value') { $customdatasql = $DB->sql_cast_to_char($customdatasql); } // Account for field default value, when joined to the instance table related to the custom fields. if (($fielddefault = $datacontroller->get_default_value()) !== null) { $paramdefault = database::generate_param_name(); // Oracle be crazy. $paramdefaultsql = ":{$paramdefault}"; if ($DB->get_dbfamily() === 'oracle' && in_array($datafield, ['intvalue', 'decvalue'])) { $paramdefaultsql = $DB->sql_cast_char2int($paramdefaultsql); } $customdatasql = " CASE WHEN {$this->tablefieldalias} IS NOT NULL THEN COALESCE({$customdatasql}, {$paramdefaultsql}) ELSE NULL END"; $customdataparams[$paramdefault] = $fielddefault; } $filter = (new filter( $this->get_filter_class_type($datacontroller), 'customfield_' . $field->get('shortname'), new lang_string('customfieldcolumn', 'core_reportbuilder', $field->get_formatted_name(false)), $this->entityname, $customdatasql, $customdataparams, )) ->add_joins($this->get_joins()) ->add_join($this->get_table_join($field)) ->set_is_available($this->handler->can_view($field, 0)); // If using a select filter, then populate the options. if ($filter->get_filter_class() === select::class) { $filter->set_options_callback(fn(): array => $field->get_options()); } $filters[] = $filter; } } return $filters; } /** * Returns class for the filter element that should be used for the field * * In some situation we can assume what kind of data is stored in the customfield plugin and we can * display appropriate filter form element. For all others assume text filter. * * @param data_controller $datacontroller * @return string */ private function get_filter_class_type(data_controller $datacontroller): string { $type = $datacontroller->get_field()->get('type'); switch ($type) { case 'checkbox': $classtype = boolean_select::class; break; case 'date': $classtype = date::class; break; case 'select': $classtype = select::class; break; default: // To support third party field type we need to account for stored numbers. $datafield = $datacontroller->datafield(); if ($datafield === 'intvalue' || $datafield === 'decvalue') { $classtype = number::class; } else { $classtype = text::class; } break; } return $classtype; } } PK a<�\�s��& �& - classes/local/helpers/user_profile_fields.phpnu �[��� <?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\local\helpers; use core\lang_string; use core_text; use core_reportbuilder\local\filters\{boolean_select, date, select, text}; use core_reportbuilder\local\report\{column, filter}; use profile_field_base; use stdClass; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot.'/user/profile/lib.php'); /** * Helper class for user profile fields. * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user_profile_fields { use join_trait; /** @var profile_field_base[] User profile fields */ private array $userprofilefields; /** * Constructor * * @param string $usertablefieldalias The table/field alias to match the user ID when adding columns and filters. * @param string $entityname The entity name used when adding columns and filters. */ public function __construct( /** @var string The table/field alias to match the user ID when adding columns and filters */ private readonly string $usertablefieldalias, /** @var string The entity name used when adding columns and filters */ private readonly string $entityname, ) { $this->userprofilefields = profile_get_user_fields_with_data(0); } /** * Get table alias for given profile field * * The entity name is used to ensure the alias differs when the entity is used multiple times within the same report, each * having their own table alias/join * * @param profile_field_base $profilefield * @return string */ private function get_table_alias(profile_field_base $profilefield): string { static $aliases = []; $aliaskey = "{$this->entityname}_{$profilefield->fieldid}"; if (!array_key_exists($aliaskey, $aliases)) { $aliases[$aliaskey] = database::generate_alias(); } return $aliases[$aliaskey]; } /** * Get table join for given profile field * * @param profile_field_base $profilefield * @return string */ private function get_table_join(profile_field_base $profilefield): string { $userinfotablealias = $this->get_table_alias($profilefield); return "LEFT JOIN {user_info_data} {$userinfotablealias} ON {$userinfotablealias}.userid = {$this->usertablefieldalias} AND {$userinfotablealias}.fieldid = {$profilefield->fieldid}"; } /** * Return the user profile fields visible columns. * * @return column[] */ public function get_columns(): array { global $DB; $columns = []; foreach ($this->userprofilefields as $profilefield) { $userinfotablealias = $this->get_table_alias($profilefield); $userinfosql = "{$userinfotablealias}.data"; if ($DB->get_dbfamily() === 'oracle') { $userinfosql = $DB->sql_order_by_text($userinfosql, 1024); } // Numeric column (non-text) should cast/coalesce with default, as should all fields for Oracle, for aggregation. $columntype = $this->get_user_field_type($profilefield->field->datatype); if (!in_array($columntype, [column::TYPE_TEXT, column::TYPE_LONGTEXT])) { // See MDL-78783 regarding no bound parameters, and Oracle limitations of GROUP BY. $userinfosql = " CASE WHEN {$this->usertablefieldalias} IS NOT NULL THEN " . $DB->sql_cast_char2int("COALESCE({$userinfosql}, '" . (float) $profilefield->field->defaultdata . "')") . " ELSE NULL END"; } $columnname = 'profilefield_' . core_text::strtolower($profilefield->field->shortname); $columns[$columnname] = (new column( $columnname, new lang_string('customfieldcolumn', 'core_reportbuilder', $profilefield->display_name(false)), $this->entityname )) ->add_joins($this->get_joins()) ->add_join($this->get_table_join($profilefield)) ->add_field($userinfosql, 'data') ->add_field("{$userinfotablealias}.dataformat") ->add_field($this->usertablefieldalias, 'userid') ->set_type($columntype) ->set_is_sortable($columntype !== column::TYPE_LONGTEXT) ->add_callback(static function($value, stdClass $row, profile_field_base $field): string { if ($row->userid === null && $value === null) { return ''; } $field->set_user_data( $row->data ?? $field->field->defaultdata, $row->dataformat ?? $field->field->defaultdataformat, ); return $field->display_data(); }, $profilefield) ->set_is_available($profilefield->is_visible()); } return array_values($columns); } /** * Get custom user profile fields filters. * * @return filter[] */ public function get_filters(): array { global $DB; $filters = []; foreach ($this->userprofilefields as $profilefield) { $userinfotablealias = $this->get_table_alias($profilefield); $userinfosql = "{$userinfotablealias}.data"; $userinfoparams = []; // Perform casts where necessary, as this is a text DB field. switch ($profilefield->field->datatype) { case 'checkbox': $classname = boolean_select::class; $userinfosql = $DB->sql_cast_char2int($userinfosql, true); break; case 'datetime': $classname = date::class; $userinfosql = $DB->sql_cast_char2int($userinfosql, true); break; case 'menu': $classname = select::class; $userinfosql = $DB->sql_cast_to_char($userinfosql); break; case 'text': case 'textarea': default: $classname = text::class; $userinfosql = $DB->sql_cast_to_char($userinfosql); break; } // Account for field default value, when joined to the user table. if (($fielddefault = $profilefield->field->defaultdata) !== null) { $paramdefault = database::generate_param_name(); // Oracle be crazy. $paramdefaultsql = ":{$paramdefault}"; if ($DB->get_dbfamily() === 'oracle' && in_array($profilefield->field->datatype, ['checkbox', 'datetime'])) { $paramdefaultsql = $DB->sql_cast_char2int($paramdefaultsql); } $userinfosql = " CASE WHEN {$this->usertablefieldalias} IS NOT NULL THEN COALESCE({$userinfosql}, {$paramdefaultsql}) ELSE NULL END"; $userinfoparams[$paramdefault] = $fielddefault; } $filtername = 'profilefield_' . core_text::strtolower($profilefield->field->shortname); $filter = (new filter( $classname, $filtername, new lang_string('customfieldcolumn', 'core_reportbuilder', $profilefield->display_name(false)), $this->entityname, $userinfosql, $userinfoparams, )) ->add_joins($this->get_joins()) ->add_join($this->get_table_join($profilefield)) ->set_is_available($profilefield->is_visible()); // If using a select filter, then populate the options. if ($filter->get_filter_class() === select::class) { $filter->set_options_callback(fn(): array => $profilefield->options); } $filters[$filtername] = $filter; } return array_values($filters); } /** * Get user profile field type for report. * * @param string $userfield user field. * @return int the constant equivalent to this custom field type. */ protected function get_user_field_type(string $userfield): int { switch ($userfield) { case 'checkbox': $customfieldtype = column::TYPE_BOOLEAN; break; case 'datetime': $customfieldtype = column::TYPE_TIMESTAMP; break; case 'textarea': $customfieldtype = column::TYPE_LONGTEXT; break; case 'menu': case 'text': default: $customfieldtype = column::TYPE_TEXT; break; } return $customfieldtype; } } PK a<�\�P2�7 �7 " classes/local/helpers/schedule.phpnu �[��� <?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\local\helpers; use context_user; use core\{clock, di}; use core_user; use invalid_parameter_exception; use stdClass; use stored_file; use table_dataformat_export_format; use core\message\message; use core\plugininfo\dataformat; use core_reportbuilder\local\models\audience as audience_model; use core_reportbuilder\local\models\schedule as model; use core_reportbuilder\table\custom_report_table_view; /** * Helper class for report schedule related methods * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class schedule { /** * Create report schedule, calculate when it should be next sent * * @param stdClass $data * @param int|null $timenow Deprecated since Moodle 4.5 - please use {@see clock} dependency injection * @return model */ public static function create_schedule(stdClass $data, ?int $timenow = null): model { if ($timenow !== null) { debugging('Passing $timenow is deprecated, please use \core\clock dependency injection', DEBUG_DEVELOPER); } $data->name = trim($data->name); $schedule = (new model(0, $data)); $schedule->set('timenextsend', self::calculate_next_send_time($schedule)); return $schedule->create(); } /** * Update report schedule * * @param stdClass $data * @return model * @throws invalid_parameter_exception */ public static function update_schedule(stdClass $data): model { $schedule = model::get_record(['id' => $data->id, 'reportid' => $data->reportid]); if ($schedule === false) { throw new invalid_parameter_exception('Invalid schedule'); } // Normalize model properties. $data = array_intersect_key((array) $data, model::properties_definition()); if (array_key_exists('name', $data)) { $data['name'] = trim($data['name']); } $schedule->set_many($data); $schedule->set('timenextsend', self::calculate_next_send_time($schedule)) ->update(); return $schedule; } /** * Toggle report schedule enabled * * @param int $reportid * @param int $scheduleid * @param bool $enabled * @return bool * @throws invalid_parameter_exception */ public static function toggle_schedule(int $reportid, int $scheduleid, bool $enabled): bool { $schedule = model::get_record(['id' => $scheduleid, 'reportid' => $reportid]); if ($schedule === false) { throw new invalid_parameter_exception('Invalid schedule'); } return $schedule->set('enabled', $enabled)->update(); } /** * Return array of users who match the audience records added to the given schedule * * @param model $schedule * @return stdClass[] */ public static function get_schedule_report_users(model $schedule): array { global $DB; $audienceids = (array) json_decode($schedule->get('audiences')); // Retrieve all selected audience records for the schedule. [$audienceselect, $audienceparams] = $DB->get_in_or_equal($audienceids, SQL_PARAMS_NAMED, 'aid', true, null); $audiences = audience_model::get_records_select("id {$audienceselect}", $audienceparams); // Now convert audiences to SQL for user retrieval. [$wheres, $params] = audience::user_audience_sql($audiences); if (count($wheres) === 0) { return []; } [$userorder] = users_order_by_sql('u'); $sql = 'SELECT u.* FROM {user} u WHERE (' . implode(' OR ', $wheres) . ') AND u.deleted = 0 ORDER BY ' . $userorder; return $DB->get_records_sql($sql, $params); } /** * Return count of schedule report rows * * @param model $schedule * @return int */ public static function get_schedule_report_count(model $schedule): int { global $DB; $table = custom_report_table_view::create($schedule->get('reportid')); $table->setup(); return $DB->count_records_sql($table->countsql, $table->countparams); } /** * Generate stored file instance for given schedule, in user draft * * @param model $schedule * @return stored_file */ public static function get_schedule_report_file(model $schedule): stored_file { global $CFG, $USER; require_once("{$CFG->libdir}/filelib.php"); $table = custom_report_table_view::create($schedule->get('reportid')); $table->setup(); $table->query_db(0, false); // Set up table as if it were being downloaded, retrieve appropriate export class (ensure output buffer is // cleaned in order to instantiate export class without exception). ob_start(); $table->download = $schedule->get('format'); $exportclass = new table_dataformat_export_format($table, $table->download); ob_end_clean(); // Create our schedule report stored file temporarily in user draft. $filerecord = [ 'contextid' => context_user::instance($USER->id)->id, 'component' => 'user', 'filearea' => 'draft', 'itemid' => file_get_unused_draft_itemid(), 'filepath' => '/', 'filename' => clean_filename($schedule->get_formatted_name()), ]; $storedfile = \core\dataformat::write_data_to_filearea( $filerecord, $table->download, $exportclass->format_data($table->headers), $table->rawdata, static function(stdClass $record, bool $supportshtml) use ($table, $exportclass): array { $record = $table->format_row($record); if (!$supportshtml) { $record = $exportclass->format_data($record); } return $record; } ); $table->close_recordset(); return $storedfile; } /** * Check whether given schedule needs to be sent * * @param model $schedule * @return bool */ public static function should_send_schedule(model $schedule): bool { if (!$schedule->get('enabled')) { return false; } $timenow = di::get(clock::class)->time(); // Ensure we've reached the initial scheduled start time. $timescheduled = $schedule->get('timescheduled'); if ($timescheduled > $timenow) { return false; } // If there's no recurrence, check whether it's been sent since initial scheduled start time. This ensures that even if // the schedule was manually sent beforehand, it'll still be automatically sent once the start time is first reached. if ($schedule->get('recurrence') === model::RECURRENCE_NONE) { return $schedule->get('timelastsent') < $timescheduled; } return $schedule->get('timenextsend') <= $timenow; } /** * Calculate the next time a schedule should be sent, based on it's recurrence and when it was initially scheduled. Ensures * returned value is after the current date * * @param model $schedule * @param int|null $timenow Deprecated since Moodle 4.5 - please use {@see clock} dependency injection * @return int */ public static function calculate_next_send_time(model $schedule, ?int $timenow = null): int { global $CFG; if ($timenow !== null) { debugging('Passing $timenow is deprecated, please use \core\clock dependency injection', DEBUG_DEVELOPER); } $timenow = di::get(clock::class)->time(); $recurrence = $schedule->get('recurrence'); $timescheduled = $schedule->get('timescheduled'); // If no recurrence is set or we haven't reached last sent date, return early. if ($recurrence === model::RECURRENCE_NONE || $timescheduled > $timenow) { return $timescheduled; } // Extract attributes from date (year, month, day, hours, minutes). [ 'year' => $year, 'mon' => $month, 'mday' => $day, 'wday' => $dayofweek, 'hours' => $hour, 'minutes' => $minute, ] = usergetdate($timescheduled, $CFG->timezone); switch ($recurrence) { case model::RECURRENCE_DAILY: $day += 1; break; case model::RECURRENCE_WEEKDAYS: $day += 1; $calendar = \core_calendar\type_factory::get_calendar_instance(); $weekend = get_config('core', 'calendar_weekend'); // Increment day until day of week falls on a weekday. while ((bool) ($weekend & (1 << (++$dayofweek % $calendar->get_num_weekdays())))) { $day++; } break; case model::RECURRENCE_WEEKLY: $day += 7; break; case model::RECURRENCE_MONTHLY: $month += 1; break; case model::RECURRENCE_ANNUALLY: $year += 1; break; } // We need to recursively increment the timestamp until we get one after the current time. $timestamp = make_timestamp($year, $month, $day, $hour, $minute, 0, $CFG->timezone); if ($timestamp < $timenow) { // Ensure we don't modify anything in the original model. $scheduleclone = new model(0, $schedule->to_record()); return self::calculate_next_send_time($scheduleclone->set('timescheduled', $timestamp)); } else { return $timestamp; } } /** * Send schedule message to user * * @param model $schedule * @param stdClass $user * @param stored_file $attachment * @return bool */ public static function send_schedule_message(model $schedule, stdClass $user, stored_file $attachment): bool { $message = new message(); $message->component = 'moodle'; $message->name = 'reportbuilderschedule'; $message->courseid = SITEID; $message->userfrom = core_user::get_noreply_user(); $message->userto = $user; $message->subject = $schedule->get('subject'); $message->fullmessage = $schedule->get('message'); $message->fullmessageformat = $schedule->get('messageformat'); $message->fullmessagehtml = $message->fullmessage; $message->smallmessage = $message->fullmessage; // Attach report to outgoing message. $message->attachment = $attachment; $message->attachname = $attachment->get_filename(); return (bool) message_send($message); } /** * Delete report schedule * * @param int $reportid * @param int $scheduleid * @return bool * @throws invalid_parameter_exception */ public static function delete_schedule(int $reportid, int $scheduleid): bool { $schedule = model::get_record(['id' => $scheduleid, 'reportid' => $reportid]); if ($schedule === false) { throw new invalid_parameter_exception('Invalid schedule'); } return $schedule->delete(); } /** * Return list of available data formats * * @return string[] */ public static function get_format_options(): array { $dataformats = dataformat::get_enabled_plugins(); return array_map(static function(string $pluginname): string { return get_string('dataformat', 'dataformat_' . $pluginname); }, $dataformats); } /** * Return list of available view as user options * * @return string[] */ public static function get_viewas_options(): array { return [ model::REPORT_VIEWAS_CREATOR => get_string('scheduleviewascreator', 'core_reportbuilder'), model::REPORT_VIEWAS_RECIPIENT => get_string('scheduleviewasrecipient', 'core_reportbuilder'), model::REPORT_VIEWAS_USER => get_string('userselect', 'core_reportbuilder'), ]; } /** * Return list of recurrence options * * @return string[] */ public static function get_recurrence_options(): array { return [ model::RECURRENCE_NONE => get_string('none'), model::RECURRENCE_DAILY => get_string('recurrencedaily', 'core_reportbuilder'), model::RECURRENCE_WEEKDAYS => get_string('recurrenceweekdays', 'core_reportbuilder'), model::RECURRENCE_WEEKLY => get_string('recurrenceweekly', 'core_reportbuilder'), model::RECURRENCE_MONTHLY => get_string('recurrencemonthly', 'core_reportbuilder'), model::RECURRENCE_ANNUALLY => get_string('recurrenceannually', 'core_reportbuilder'), ]; } /** * Return list of options for when report is empty * * @return string[] */ public static function get_report_empty_options(): array { return [ model::REPORT_EMPTY_SEND_EMPTY => get_string('scheduleemptysendwithattachment', 'core_reportbuilder'), model::REPORT_EMPTY_SEND_WITHOUT => get_string('scheduleemptysendwithoutattachment', 'core_reportbuilder'), model::REPORT_EMPTY_DONT_SEND => get_string('scheduleemptydontsend', 'core_reportbuilder'), ]; } } PK a<�\ �5� � $ classes/local/helpers/join_trait.phpnu �[��� <?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\local\helpers; /** * Trait for classes that expect to store SQL table joins * * @package core_reportbuilder * @copyright 2024 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ trait join_trait { /** @var string[] SQL table joins */ private array $joins = []; /** * Add single SQL table join * * @param string $join * @return static */ final public function add_join(string $join): static { $this->joins[trim($join)] = trim($join); return $this; } /** * Add multiple SQL table joins * * @param string[] $joins * @return static */ final public function add_joins(array $joins): static { foreach ($joins as $join) { $this->add_join($join); } return $this; } /** * Return SQL table joins * * @return string[] */ final public function get_joins(): array { return array_values($this->joins); } } PK a<�\��FP�< �< classes/local/helpers/report.phpnu �[��� <?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\local\helpers; use stdClass; use invalid_parameter_exception; use core\persistent; use core_reportbuilder\datasource; use core_reportbuilder\manager; use core_reportbuilder\local\models\column; use core_reportbuilder\local\models\filter; use core_reportbuilder\local\models\report as report_model; use core_tag_tag; /** * Helper class for manipulating custom reports and their elements (columns, filters, conditions, etc) * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class report { /** * Create custom report * * @param stdClass $data * @param bool $default If $default is set to true it will populate report with default layout as defined by the selected * source. These include pre-defined columns, filters and conditions. * @return report_model */ public static function create_report(stdClass $data, bool $default = true): report_model { $data->name = trim($data->name); $data->type = datasource::TYPE_CUSTOM_REPORT; // Create report persistent. $report = manager::create_report_persistent($data); // Add datasource default columns, filters and conditions to the report. if ($default) { $source = $report->get('source'); /** @var datasource $datasource */ $datasource = new $source($report); $datasource->add_default_columns(); $datasource->add_default_filters(); $datasource->add_default_conditions(); } // Report tags. if (property_exists($data, "tags")) { core_tag_tag::set_item_tags('core_reportbuilder', 'reportbuilder_report', $report->get('id'), $report->get_context(), $data->tags); } return $report; } /** * Update custom report * * @param stdClass $data * @return report_model */ public static function update_report(stdClass $data): report_model { $report = report_model::get_record(['id' => $data->id, 'type' => datasource::TYPE_CUSTOM_REPORT]); if ($report === false) { throw new invalid_parameter_exception('Invalid report'); } $report->set_many([ 'name' => trim($data->name), 'uniquerows' => $data->uniquerows, ])->update(); // Report tags. if (property_exists($data, "tags")) { core_tag_tag::set_item_tags('core_reportbuilder', 'reportbuilder_report', $report->get('id'), $report->get_context(), $data->tags); } return $report; } /** * Delete custom report * * @param int $reportid * @return bool * @throws invalid_parameter_exception */ public static function delete_report(int $reportid): bool { $report = report_model::get_record(['id' => $reportid, 'type' => datasource::TYPE_CUSTOM_REPORT]); if ($report === false) { throw new invalid_parameter_exception('Invalid report'); } // Report tags. core_tag_tag::remove_all_item_tags('core_reportbuilder', 'reportbuilder_report', $report->get('id')); return $report->delete(); } /** * Add given column to report * * @param int $reportid * @param string $uniqueidentifier * @return column * @throws invalid_parameter_exception */ public static function add_report_column(int $reportid, string $uniqueidentifier): column { $report = manager::get_report_from_id($reportid); // Ensure column is available. if (!array_key_exists($uniqueidentifier, $report->get_columns())) { throw new invalid_parameter_exception('Invalid column'); } $column = new column(0, (object) [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, 'columnorder' => column::get_max_columnorder($reportid, 'columnorder') + 1, 'sortorder' => column::get_max_columnorder($reportid, 'sortorder') + 1, ]); return $column->create(); } /** * Delete given column from report * * @param int $reportid * @param int $columnid * @return bool * @throws invalid_parameter_exception */ public static function delete_report_column(int $reportid, int $columnid): bool { global $DB; $column = column::get_record(['id' => $columnid, 'reportid' => $reportid]); if ($column === false) { throw new invalid_parameter_exception('Invalid column'); } // After deletion, re-index remaining report columns. if ($result = $column->delete()) { $sqlupdateorder = ' UPDATE {' . column::TABLE . '} SET columnorder = columnorder - 1 WHERE reportid = :reportid AND columnorder > :columnorder'; $DB->execute($sqlupdateorder, ['reportid' => $reportid, 'columnorder' => $column->get('columnorder')]); } return $result; } /** * Re-order given column within a report * * @param int $reportid * @param int $columnid * @param int $position * @return bool * @throws invalid_parameter_exception */ public static function reorder_report_column(int $reportid, int $columnid, int $position): bool { $column = column::get_record(['id' => $columnid, 'reportid' => $reportid]); if ($column === false) { throw new invalid_parameter_exception('Invalid column'); } // Get the rest of the report columns, excluding the one we are moving. $columns = column::get_records_select('reportid = :reportid AND id <> :id', [ 'reportid' => $reportid, 'id' => $columnid, ], 'columnorder'); return static::reorder_persistents_by_field($column, $columns, $position, 'columnorder'); } /** * Re-order given column sorting within a report * * @param int $reportid * @param int $columnid * @param int $position * @return bool * @throws invalid_parameter_exception */ public static function reorder_report_column_sorting(int $reportid, int $columnid, int $position): bool { $column = column::get_record(['id' => $columnid, 'reportid' => $reportid]); if ($column === false) { throw new invalid_parameter_exception('Invalid column'); } // Get the rest of the report columns, excluding the one we are moving. $columns = column::get_records_select('reportid = :reportid AND id <> :id', [ 'reportid' => $reportid, 'id' => $columnid, ], 'sortorder'); return static::reorder_persistents_by_field($column, $columns, $position, 'sortorder'); } /** * Toggle sorting options for given column within a report * * @param int $reportid * @param int $columnid * @param bool $enabled * @param int $direction * @return bool * @throws invalid_parameter_exception */ public static function toggle_report_column_sorting(int $reportid, int $columnid, bool $enabled, int $direction = SORT_ASC): bool { $column = column::get_record(['id' => $columnid, 'reportid' => $reportid]); if ($column === false) { throw new invalid_parameter_exception('Invalid column'); } return $column->set_many([ 'sortenabled' => $enabled, 'sortdirection' => $direction, ])->update(); } /** * Add given condition to report * * @param int $reportid * @param string $uniqueidentifier * @return filter * @throws invalid_parameter_exception */ public static function add_report_condition(int $reportid, string $uniqueidentifier): filter { $report = manager::get_report_from_id($reportid); // Ensure condition is available. if (!array_key_exists($uniqueidentifier, $report->get_conditions())) { throw new invalid_parameter_exception('Invalid condition'); } // Ensure condition wasn't already added. if (array_key_exists($uniqueidentifier, $report->get_active_conditions())) { throw new invalid_parameter_exception('Duplicate condition'); } $condition = new filter(0, (object) [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, 'iscondition' => true, 'filterorder' => filter::get_max_filterorder($reportid, true) + 1, ]); return $condition->create(); } /** * Delete given condition from report * * @param int $reportid * @param int $conditionid * @return bool * @throws invalid_parameter_exception */ public static function delete_report_condition(int $reportid, int $conditionid): bool { global $DB; $condition = filter::get_condition_record($reportid, $conditionid); if ($condition === false) { throw new invalid_parameter_exception('Invalid condition'); } // After deletion, re-index remaining report conditions. if ($result = $condition->delete()) { $sqlupdateorder = ' UPDATE {' . filter::TABLE . '} SET filterorder = filterorder - 1 WHERE reportid = :reportid AND filterorder > :filterorder AND iscondition = 1'; $DB->execute($sqlupdateorder, ['reportid' => $reportid, 'filterorder' => $condition->get('filterorder')]); } return $result; } /** * Re-order given condition within a report * * @param int $reportid * @param int $conditionid * @param int $position * @return bool * @throws invalid_parameter_exception */ public static function reorder_report_condition(int $reportid, int $conditionid, int $position): bool { $condition = filter::get_condition_record($reportid, $conditionid); if ($condition === false) { throw new invalid_parameter_exception('Invalid condition'); } // Get the rest of the report conditions, excluding the one we are moving. $conditions = filter::get_records_select('reportid = :reportid AND iscondition = 1 AND id <> :id', [ 'reportid' => $reportid, 'id' => $conditionid, ], 'filterorder'); return static::reorder_persistents_by_field($condition, $conditions, $position, 'filterorder'); } /** * Add given filter to report * * @param int $reportid * @param string $uniqueidentifier * @return filter * @throws invalid_parameter_exception */ public static function add_report_filter(int $reportid, string $uniqueidentifier): filter { $report = manager::get_report_from_id($reportid); // Ensure filter is available. if (!array_key_exists($uniqueidentifier, $report->get_filters())) { throw new invalid_parameter_exception('Invalid filter'); } // Ensure filter wasn't already added. if (array_key_exists($uniqueidentifier, $report->get_active_filters())) { throw new invalid_parameter_exception('Duplicate filter'); } $filter = new filter(0, (object) [ 'reportid' => $reportid, 'uniqueidentifier' => $uniqueidentifier, 'filterorder' => filter::get_max_filterorder($reportid) + 1, ]); return $filter->create(); } /** * Delete given filter from report * * @param int $reportid * @param int $filterid * @return bool * @throws invalid_parameter_exception */ public static function delete_report_filter(int $reportid, int $filterid): bool { global $DB; $filter = filter::get_filter_record($reportid, $filterid); if ($filter === false) { throw new invalid_parameter_exception('Invalid filter'); } // After deletion, re-index remaining report filters. if ($result = $filter->delete()) { $sqlupdateorder = ' UPDATE {' . filter::TABLE . '} SET filterorder = filterorder - 1 WHERE reportid = :reportid AND filterorder > :filterorder AND iscondition = 0'; $DB->execute($sqlupdateorder, ['reportid' => $reportid, 'filterorder' => $filter->get('filterorder')]); } return $result; } /** * Re-order given filter within a report * * @param int $reportid * @param int $filterid * @param int $position * @return bool * @throws invalid_parameter_exception */ public static function reorder_report_filter(int $reportid, int $filterid, int $position): bool { $filter = filter::get_filter_record($reportid, $filterid); if ($filter === false) { throw new invalid_parameter_exception('Invalid filter'); } // Get the rest of the report filters, excluding the one we are moving. $filters = filter::get_records_select('reportid = :reportid AND iscondition = 0 AND id <> :id', [ 'reportid' => $reportid, 'id' => $filterid, ], 'filterorder'); return static::reorder_persistents_by_field($filter, $filters, $position, 'filterorder'); } /** * @deprecated since Moodle 4.1 - please do not use this function any more, {@see custom_report_column_cards_exporter} */ #[\core\attribute\deprecated('custom_report_column_cards_exporter', since: '4.1', final: true)] public static function get_available_columns() { \core\deprecation::emit_deprecation([self::class, __FUNCTION__]); } /** * Helper method for re-ordering given persistents (columns, filters, etc) * * @param persistent $persistent The persistent we are moving * @param persistent[] $persistents The rest of the persistents * @param int $position * @param string $field The field we need to update * @return bool */ private static function reorder_persistents_by_field(persistent $persistent, array $persistents, int $position, string $field): bool { // Splice into new position. array_splice($persistents, $position - 1, 0, [$persistent]); $fieldorder = 1; foreach ($persistents as $persistent) { $persistent->set($field, $fieldorder++) ->update(); } return true; } } PK a<�\���ye( e( " classes/local/helpers/audience.phpnu �[��� <?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\local\helpers; use cache; use context; use context_system; use core_collator; use core_component; use core_reportbuilder\local\audiences\base; use core_reportbuilder\local\models\{audience as audience_model, schedule}; use invalid_parameter_exception; /** * Class containing report audience helper methods * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class audience { /** * Return audience instances for a given report. Note that any records pointing to invalid audience types will be excluded * * @param int $reportid * @return base[] */ public static function get_base_records(int $reportid): array { $records = audience_model::get_records(['reportid' => $reportid], 'id'); $instances = array_map(static function(audience_model $audience): ?base { return base::instance(0, $audience->to_record()); }, $records); // Filter and remove null elements (invalid audience types). return array_filter($instances); } /** * Returns list of report IDs that the specified user can access, based on audience configuration. This can be expensive if the * site has lots of reports, with lots of audiences, so we cache the result for the duration of the users session * * @param int|null $userid User ID to check, or the current user if omitted * @return int[] */ public static function get_allowed_reports(?int $userid = null): array { global $USER, $DB; $userid = $userid ?: (int) $USER->id; // Prepare cache, if we previously stored the users allowed reports then return that. $cache = cache::make('core', 'reportbuilder_allowed_reports'); $cachedreports = $cache->get($userid); if ($cachedreports !== false) { return $cachedreports; } $allowedreports = []; $reportaudiences = []; // Retrieve all audiences and group them by report for convenience. $audiences = audience_model::get_records(); foreach ($audiences as $audience) { $reportaudiences[$audience->get('reportid')][] = $audience; } foreach ($reportaudiences as $reportid => $audiences) { // Generate audience SQL based on those for the current report. [$wheres, $params] = self::user_audience_sql($audiences); if (count($wheres) === 0) { continue; } $paramuserid = database::generate_param_name(); $params[$paramuserid] = $userid; $sql = "SELECT DISTINCT(u.id) FROM {user} u WHERE (" . implode(' OR ', $wheres) . ") AND u.deleted = 0 AND u.id = :{$paramuserid}"; // If we have a matching record, user can view the report. if ($DB->record_exists_sql($sql, $params)) { $allowedreports[] = $reportid; } } // Store users allowed reports in cache. $cache->set($userid, $allowedreports); return $allowedreports; } /** * Purge the audience cache of allowed reports */ public static function purge_caches(): void { cache::make('core', 'reportbuilder_allowed_reports')->purge(); } /** * Generate SQL select clause and params for selecting reports specified user can access, based on audience configuration * * @param string $reporttablealias * @param int|null $userid User ID to check, or the current user if omitted * @return array */ public static function user_reports_list_sql(string $reporttablealias, ?int $userid = null): array { global $DB; $allowedreports = self::get_allowed_reports($userid); if (empty($allowedreports)) { return ['1=0', []]; } // Get all sql audiences. [$select, $params] = $DB->get_in_or_equal($allowedreports, SQL_PARAMS_NAMED, database::generate_param_name('_')); $sql = "{$reporttablealias}.id {$select}"; return [$sql, $params]; } /** * Return list of report ID's specified user can access, based on audience configuration * * @param int|null $userid User ID to check, or the current user if omitted * @return int[] */ public static function user_reports_list(?int $userid = null): array { global $DB; [$select, $params] = self::user_reports_list_sql('rb', $userid); $sql = "SELECT rb.id FROM {reportbuilder_report} rb WHERE {$select}"; return $DB->get_fieldset_sql($sql, $params); } /** * Returns SQL to limit the list of reports to those that the given user has access to * * - A user with 'viewall/editall' capability will have access to all reports * - A user with 'edit' capability will have access to: * - Those reports this user has created * - Those reports this user is in audience of * - Otherwise: * - Those reports this user is in audience of * * @param string $reporttablealias * @param int|null $userid User ID to check, or the current user if omitted * @param context|null $context * @return array */ public static function user_reports_list_access_sql( string $reporttablealias, ?int $userid = null, ?context $context = null ): array { global $DB, $USER; if ($context === null) { $context = context_system::instance(); } if (has_any_capability(['moodle/reportbuilder:editall', 'moodle/reportbuilder:viewall'], $context, $userid)) { return ['1=1', []]; } // Limit the returned list to those reports the user can see, by selecting based on report audience. [$reportselect, $params] = $DB->get_in_or_equal( self::user_reports_list($userid), SQL_PARAMS_NAMED, database::generate_param_name('_'), true, null, ); $where = "{$reporttablealias}.id {$reportselect}"; // User can also see any reports that they can edit. if (has_capability('moodle/reportbuilder:edit', $context, $userid)) { $paramuserid = database::generate_param_name(); $where = "({$reporttablealias}.usercreated = :{$paramuserid} OR {$where})"; $params[$paramuserid] = $userid ?? $USER->id; } return [$where, $params]; } /** * Return appropriate list of where clauses and params for given audiences * * @param audience_model[] $audiences * @param string $usertablealias * @return array[] [$wheres, $params] */ public static function user_audience_sql(array $audiences, string $usertablealias = 'u'): array { $wheres = $params = []; foreach ($audiences as $audience) { if ($instance = base::instance(0, $audience->to_record())) { $instancetablealias = database::generate_alias(); [$instancejoin, $instancewhere, $instanceparams] = $instance->get_sql($instancetablealias); $wheres[] = "{$usertablealias}.id IN ( SELECT {$instancetablealias}.id FROM {user} {$instancetablealias} {$instancejoin} WHERE {$instancewhere} )"; $params += $instanceparams; } } return [$wheres, $params]; } /** * Return a list of audiences that are used by any schedule of the given report * * @param int $reportid * @return int[] Array of audience IDs */ public static function get_audiences_for_report_schedules(int $reportid): array { global $DB; $audiences = $DB->get_fieldset_select(schedule::TABLE, 'audiences', 'reportid = ?', [$reportid]); // Reduce JSON encoded audience data of each schedule to an array of audience IDs. $audienceids = array_reduce($audiences, static function(array $carry, string $audience): array { return array_merge($carry, (array) json_decode($audience)); }, []); return array_unique($audienceids, SORT_NUMERIC); } /** * Delete given audience from report * * @param int $reportid * @param int $audienceid * @return bool * @throws invalid_parameter_exception */ public static function delete_report_audience(int $reportid, int $audienceid): bool { $audience = audience_model::get_record(['id' => $audienceid, 'reportid' => $reportid]); if ($audience === false) { throw new invalid_parameter_exception('Invalid audience'); } $instance = base::instance(0, $audience->to_record()); if ($instance && $instance->user_can_edit()) { $persistent = $instance->get_persistent(); $persistent->delete(); return true; } return false; } /** * @deprecated since Moodle 4.1 - please do not use this function any more, {@see custom_report_audience_cards_exporter} */ #[\core\attribute\deprecated('custom_report_audience_cards_exporter', since: '4.1', final: true)] public static function get_all_audiences_menu_types() { \core\deprecation::emit_deprecation([self::class, __FUNCTION__]); } } PK a<�\Go;9 9 " classes/local/helpers/database.phpnu �[��� <?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\local\helpers; use coding_exception; use core_text; /** * Helper functions for DB manipulations * * @package core_reportbuilder * @copyright 2019 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class database { /** @var string Prefix for generated aliases */ private const GENERATE_ALIAS_PREFIX = 'rbalias'; /** @var string Prefix for generated param names names */ private const GENERATE_PARAM_PREFIX = 'rbparam'; /** * Generates unique table/column alias that must be used in generated SQL * * @param string $suffix Optional string to append to alias * @return string */ public static function generate_alias(string $suffix = ''): string { static $aliascount = 0; return static::GENERATE_ALIAS_PREFIX . ($aliascount++) . $suffix; } /** * Generate multiple unique table/column aliases, see {@see generate_alias} for info * * @param int $count * @param string $suffix * @return string[] */ public static function generate_aliases(int $count, string $suffix = ''): array { return array_map([static::class, 'generate_alias'], array_fill(0, $count, $suffix)); } /** * Generates unique parameter name that must be used in generated SQL * * When passing the returned value to {@see \moodle_database::get_in_or_equal} it's recommended to define the suffix * * @param string $suffix Optional string to append to parameter name * @return string */ public static function generate_param_name(string $suffix = ''): string { static $paramcount = 0; return static::GENERATE_PARAM_PREFIX . ($paramcount++) . $suffix; } /** * Generate multiple unique parameter names, see {@see generate_param_name} for info * * @param int $count * @param string $suffix * @return string[] */ public static function generate_param_names(int $count, string $suffix = ''): array { return array_map([static::class, 'generate_param_name'], array_fill(0, $count, $suffix)); } /** * Validate that parameter names were generated using {@see generate_param_name}. * * @param array $params * @return bool * @throws coding_exception For invalid params. */ public static function validate_params(array $params): bool { $nonmatchingkeys = array_filter($params, static function($key): bool { return !preg_match('/^' . static::GENERATE_PARAM_PREFIX . '[\d]+/', $key); }, ARRAY_FILTER_USE_KEY); if (!empty($nonmatchingkeys)) { throw new coding_exception('Invalid parameter names', implode(', ', array_keys($nonmatchingkeys))); } return true; } /** * Replace parameter names within given SQL expression, allowing caller to specify callback to handle their replacement * primarily to ensure uniqueness when the expression is to be used as part of a larger query * * @param string $sql * @param array $params Parameter names * @param callable $callback Method that takes a single string parameter, and returns another string * @return string */ public static function sql_replace_parameter_names(string $sql, array $params, callable $callback): string { foreach ($params as $param) { // Pattern to look for param within the SQL. $pattern = '/:(?<param>' . preg_quote($param) . ')\b/'; $sql = preg_replace_callback($pattern, function(array $matches) use ($callback): string { return ':' . $callback($matches['param']); }, $sql); } return $sql; } /** * Replace parameter names within given SQL expression, returning updated SQL and parameter elements * * {@see sql_replace_parameter_names} * * @param string $sql * @param array $params Parameter name/values * @param callable $callback * @return array [$sql, $params] */ public static function sql_replace_parameters(string $sql, array $params, callable $callback): array { $transformedsql = static::sql_replace_parameter_names($sql, array_keys($params), $callback); $transformedparams = []; foreach ($params as $name => $value) { $transformedparams[$callback($name)] = $value; } return [$transformedsql, $transformedparams]; } /** * Generate SQL expression for sorting group concatenated fields * * @param string $field The original field or SQL expression * @param string|null $sort A valid SQL ORDER BY to sort the concatenated fields, if omitted then $field will be used * @return string */ public static function sql_group_concat_sort(string $field, ?string $sort = null): string { global $DB; // Fallback to sorting by the specified field, unless it contains parameters which would be duplicated. if ($sort === null && !preg_match('/[:?$]/', $field)) { $fieldsort = $field; } else { $fieldsort = $sort; } // Nothing to sort by. if ($fieldsort === null) { return ''; } // If the sort specifies a direction, we need to handle that differently in Postgres. if ($DB->get_dbfamily() === 'postgres') { $fieldsortdirection = ''; preg_match('/(?<direction>ASC|DESC)?$/i', $fieldsort, $matches); if (array_key_exists('direction', $matches)) { $fieldsortdirection = $matches['direction']; $fieldsort = core_text::substr($fieldsort, 0, -(core_text::strlen($fieldsortdirection))); } // Cast sort, stick the direction on the end. $fieldsort = $DB->sql_cast_to_char($fieldsort) . ' ' . $fieldsortdirection; } return $fieldsort; } } PK a<�\^�{l} } classes/local/helpers/format.phpnu �[��� <?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\local\helpers; use stdClass; /** * Class containing helper methods for formatting column data via callbacks * * @package core_reportbuilder * @copyright 2021 Sara Arjona <sara@moodle.com> based on Alberto Lara Hernández <albertolara@moodle.com> code. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class format { /** * Returns formatted date. * * @param int|null $value Unix timestamp * @param stdClass $row * @param string|null $format Format string for strftime * @return string */ public static function userdate(?int $value, stdClass $row, ?string $format = null): string { return $value ? userdate($value, $format) : ''; } /** * Returns formatted time duration (e.g. "3 days 4 hours") * * @param float|null $value * @param stdClass $row * @param int|null $precision * @return string */ public static function format_time(?float $value, stdClass $row, ?int $precision = 0): string { if ($value === null) { return ''; } $value = round($value, (int) $precision); if ($value === 0.0) { return '0 ' . get_string('secs', 'moodle'); } return format_time($value); } /** * Returns yes/no string depending on the given value * * @param bool|null $value * @return string */ public static function boolean_as_text(?bool $value): string { if ($value === null) { return ''; } return $value ? get_string('yes') : get_string('no'); } /** * Returns float value as a percentage * * @param float|null $value * @return string */ public static function percent(?float $value): string { if ($value === null) { return ''; } return get_string('percents', 'moodle', format_float($value)); } } PK a<�\�e� % classes/local/helpers/aggregation.phpnu �[��� <?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\local\helpers; use core_collator; use core_component; use core_reportbuilder\local\aggregation\base; /** * Helper class for column aggregation related methods * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class aggregation { /** * Helper method to convert aggregation class name into fully qualified namespaced class * * @param string $aggregation * @return string */ public static function get_full_classpath(string $aggregation): string { return "\\core_reportbuilder\\local\\aggregation\\{$aggregation}"; } /** * Validate whether given class is a valid aggregation type * * @param string $aggregationclass Fully qualified namespaced class, see {@see get_full_classpath} for converting value * stored in column persistent to full path * @return bool */ public static function valid(string $aggregationclass): bool { return class_exists($aggregationclass) && is_subclass_of($aggregationclass, base::class); } /** * Return list of all available/valid aggregation types * * @return base[] */ public static function get_aggregations(): array { $classes = core_component::get_component_classes_in_namespace('core_reportbuilder', 'local\\aggregation'); return array_filter(array_keys($classes), static function(string $class): bool { return static::valid($class); }); } /** * Get available aggregation types for given column type * * @param int $columntype * @param array $exclude List of types to exclude, e.g. ['min', 'sum'] * @return string[] Aggregation types indexed by [shortname => name] */ public static function get_column_aggregations(int $columntype, array $exclude = []): array { $types = []; $classes = static::get_aggregations(); foreach ($classes as $class) { if ($class::compatible($columntype) && !in_array($class::get_class_name(), $exclude)) { $types[$class::get_class_name()] = (string) $class::get_name(); } } core_collator::asort($types, core_collator::SORT_STRING); return $types; } } PK a<�\�(�b classes/local/filters/base.phpnu �[��� <?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\local\filters; use MoodleQuickForm; use core_reportbuilder\local\report\filter; use core_reportbuilder\local\models\filter as filter_model; /** * Base class for all report filters * * Filters provide a form for collecting user input, and then return appropriate SQL fragments based on these values * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class base { /** @var filter $filter */ protected $filter; /** @var string $name */ protected $name; /** * Do not allow the constructor to be called directly or overridden * * @param filter $filter */ private function __construct(filter $filter) { $this->filter = $filter; $this->name = $filter->get_unique_identifier(); } /** * Creates an instance of a filter type, based on supplied report filter instance * * The report filter instance is used by reports/entities to define what should be filtered against, e.g. a SQL fragment * * @param filter $filter The report filter instance * @return static */ final public static function create(filter $filter): self { $filterclass = $filter->get_filter_class(); return new $filterclass($filter); } /** * Returns the filter header * * @return string */ final public function get_header(): string { return $this->filter->get_header(); } /** * Returns the filter's entity name * * @return string */ final public function get_entity_name(): string { return $this->filter->get_entity_name(); } /** * Returns the filter persistent * * Note that filters for system reports don't store a persistent and will return null. * * @return filter_model|null */ final public function get_filter_persistent(): ?filter_model { return $this->filter->get_persistent(); } /** * Adds filter-specific form elements * * @param MoodleQuickForm $mform */ abstract public function setup_form(MoodleQuickForm $mform): void; /** * Returns the filter clauses to be used with SQL where * * Ideally the field SQL should be included only once in the returned expression, however if that is unavoidable then * use the {@see filter::get_field_sql_and_params} helper to ensure uniqueness of any parameters included within * * @param array $values * @return array [$sql, [...$params]] */ abstract public function get_sql_filter(array $values): array; /** * Given an array of current filter values for the report, determine whether the filter would apply to the report (i.e. user * has configured it from it's initial "Any value" state). A filter would typically be considered applied if it returns SQL * filter clauses, but child classes may override this method if they use different logic * * @param array $values * @return bool */ public function applies_to_values(array $values): bool { [$filtersql] = $this->get_sql_filter($values); return $filtersql !== ''; } /** * Return sample filter values, that when applied to a report would activate the filter - that is, cause the filter to return * SQL snippet. Should be overridden in child classes, to ensure compatibility with stress tests of reports * * @return array */ public function get_sample_values(): array { return []; } } PK a<�\5�!4� � classes/local/filters/number.phpnu �[��� <?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\local\filters; use core_reportbuilder\local\helpers\database; /** * Number report filter * * This filter accepts a number value to perform filtering on (note that the value will be cast to float prior to comparison) * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class number extends base { /** @var int Any value */ public const ANY_VALUE = 0; /** @var int Is not empty */ public const IS_NOT_EMPTY = 1; /** @var int Is empty */ public const IS_EMPTY = 2; /** @var int Less than */ public const LESS_THAN = 3; /** @var int Greater than */ public const GREATER_THAN = 4; /** @var int Equal to */ public const EQUAL_TO = 5; /** @var int Equal or less than */ public const EQUAL_OR_LESS_THAN = 6; /** @var int Equal or greater than */ public const EQUAL_OR_GREATER_THAN = 7; /** @var int Range */ public const RANGE = 8; /** * Returns an array of comparison operators * * @return array of comparison operators */ private function get_operators(): array { $operators = [ self::ANY_VALUE => get_string('filterisanyvalue', 'core_reportbuilder'), self::IS_NOT_EMPTY => get_string('filterisnotempty', 'core_reportbuilder'), self::IS_EMPTY => get_string('filterisempty', 'core_reportbuilder'), self::LESS_THAN => get_string('filterlessthan', 'core_reportbuilder'), self::GREATER_THAN => get_string('filtergreaterthan', 'core_reportbuilder'), self::EQUAL_TO => get_string('filterisequalto', 'core_reportbuilder'), self::EQUAL_OR_LESS_THAN => get_string('filterequalorlessthan', 'core_reportbuilder'), self::EQUAL_OR_GREATER_THAN => get_string('filterequalorgreaterthan', 'core_reportbuilder'), self::RANGE => get_string('filterrange', 'core_reportbuilder'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Adds controls specific to this filter in the form. * * @param \MoodleQuickForm $mform */ public function setup_form(\MoodleQuickForm $mform): void { $objs = []; $objs['select'] = $mform->createElement('select', $this->name . '_operator', get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()), $this->get_operators()); $mform->setType($this->name . '_operator', PARAM_INT); $objs['text'] = $mform->createElement('text', $this->name . '_value1', get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()), ['size' => 3]); $mform->setType($this->name . '_value1', PARAM_LOCALISEDFLOAT); $mform->setDefault($this->name . '_value1', 0); $mform->hideIf($this->name . '_value1', $this->name . '_operator', 'in', [self::ANY_VALUE, self::IS_NOT_EMPTY, self::IS_EMPTY]); $objs['text2'] = $mform->createElement('text', $this->name . '_value2', get_string('filterfieldto', 'core_reportbuilder', $this->get_header()), ['size' => 3]); $mform->setType($this->name . '_value2', PARAM_LOCALISEDFLOAT); $mform->setDefault($this->name . '_value2', 0); $mform->hideIf($this->name . '_value2', $this->name . '_operator', 'noteq', self::RANGE); $mform->addGroup($objs, $this->name . '_grp', $this->get_header(), '', false) ->setHiddenLabel(true); } /** * Return filter SQL * * @param array $values * @return array array of two elements - SQL query and named parameters */ public function get_sql_filter(array $values): array { global $DB; $operator = (int) ($values["{$this->name}_operator"] ?? self::ANY_VALUE); $value1 = $value2 = null; if (array_key_exists("{$this->name}_value1", $values)) { $value1 = unformat_float($values["{$this->name}_value1"]); } if (array_key_exists("{$this->name}_value2", $values)) { $value2 = unformat_float($values["{$this->name}_value2"]); } // Validate filter form values. if (!$this->validate_filter_values($operator, $value1, $value2)) { // Filter configuration is invalid. Ignore the filter. return ['', []]; } [$param, $param2] = database::generate_param_names(2); $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); switch ($operator) { case self::ANY_VALUE: return ['', []]; case self::IS_NOT_EMPTY: $res = "COALESCE({$fieldsql}, 0) <> 0"; break; case self::IS_EMPTY: $res = "COALESCE({$fieldsql}, 0) = 0"; break; case self::LESS_THAN: $res = $DB->sql_cast_char2real("({$fieldsql})") . " < :{$param}"; $params[$param] = $value1; break; case self::GREATER_THAN: $res = $DB->sql_cast_char2real("({$fieldsql})") . " > :{$param}"; $params[$param] = $value1; break; case self::EQUAL_TO: $res = $DB->sql_cast_char2real("({$fieldsql})") . " = :{$param}"; $params[$param] = $value1; break; case self::EQUAL_OR_LESS_THAN: $res = $DB->sql_cast_char2real("({$fieldsql})") . " <= :{$param}"; $params[$param] = $value1; break; case self::EQUAL_OR_GREATER_THAN: $res = $DB->sql_cast_char2real("({$fieldsql})") . " >= :{$param}"; $params[$param] = $value1; break; case self::RANGE: $res = $DB->sql_cast_char2real("({$fieldsql})") . " BETWEEN :{$param} AND :{$param2}"; $params[$param] = $value1; $params[$param2] = $value2; break; default: // Filter configuration is invalid. Ignore the filter. return ['', []]; } return [$res, $params]; } /** * Validate filter form values * * @param int $operator * @param float|null $value1 * @param float|null $value2 * @return bool */ private function validate_filter_values(int $operator, ?float $value1, ?float $value2): bool { // Check that for any of these operators value1 can not be null. $requirescomparisonvalue = [ self::LESS_THAN, self::GREATER_THAN, self::EQUAL_TO, self::EQUAL_OR_LESS_THAN, self::EQUAL_OR_GREATER_THAN ]; if (in_array($operator, $requirescomparisonvalue) && $value1 === null) { return false; } // When operator is between $value1 and $value2, can not be null. if (($operator === self::RANGE) && ($value1 === null || $value2 === null)) { return false; } return true; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::GREATER_THAN, "{$this->name}_value1" => 1, ]; } } PK a<�\�?A�@ �@ classes/local/filters/date.phpnu �[��� <?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\local\filters; use core\{clock, di}; use core\lang_string; use core_reportbuilder\local\helpers\database; use MoodleQuickForm; /** * Date report filter * * This filter accepts a unix timestamp to perform date filtering on * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class date extends base { /** @var int Any value */ public const DATE_ANY = 0; /** @var int Non-empty (positive) value */ public const DATE_NOT_EMPTY = 1; /** @var int Empty (zero) value */ public const DATE_EMPTY = 2; /** @var int Date within defined range */ public const DATE_RANGE = 3; /** @var int Date in the last [X relative date unit(s)] */ public const DATE_LAST = 4; /** @var int Date in the previous [X relative date unit(s)] Kept for backwards compatibility */ public const DATE_PREVIOUS = self::DATE_LAST; /** @var int Date in current [relative date unit] */ public const DATE_CURRENT = 5; /** @var int Date in the next [X relative date unit(s)] */ public const DATE_NEXT = 6; /** @var int Date in the past */ public const DATE_PAST = 7; /** @var int Date in the future */ public const DATE_FUTURE = 8; /** @var int Date before [X relative date unit(s)] */ public const DATE_BEFORE = 9; /** @var int Date after [X relative date unit(s)] */ public const DATE_AFTER = 10; /** @var int Relative date unit for a minute */ public const DATE_UNIT_MINUTE = 5; /** @var int Relative date unit for an hour */ public const DATE_UNIT_HOUR = 0; /** @var int Relative date unit for a day */ public const DATE_UNIT_DAY = 1; /** @var int Relative date unit for a week */ public const DATE_UNIT_WEEK = 2; /** @var int Relative date unit for a month */ public const DATE_UNIT_MONTH = 3; /** @var int Relative date unit for a month */ public const DATE_UNIT_YEAR = 4; /** * Return an array of operators available for this filter * * @return lang_string[] */ private function get_operators(): array { $operators = [ self::DATE_ANY => new lang_string('filterisanyvalue', 'core_reportbuilder'), self::DATE_NOT_EMPTY => new lang_string('filterisnotempty', 'core_reportbuilder'), self::DATE_EMPTY => new lang_string('filterisempty', 'core_reportbuilder'), self::DATE_RANGE => new lang_string('filterrange', 'core_reportbuilder'), self::DATE_BEFORE => new lang_string('filterdatebefore', 'core_reportbuilder'), self::DATE_AFTER => new lang_string('filterdateafter', 'core_reportbuilder'), self::DATE_LAST => new lang_string('filterdatelast', 'core_reportbuilder'), self::DATE_CURRENT => new lang_string('filterdatecurrent', 'core_reportbuilder'), self::DATE_NEXT => new lang_string('filterdatenext', 'core_reportbuilder'), self::DATE_PAST => new lang_string('filterdatepast', 'core_reportbuilder'), self::DATE_FUTURE => new lang_string('filterdatefuture', 'core_reportbuilder'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * Note that we cannot support float inputs in this filter currently, because decimals are not supported when calculating * relative timeframes according to {@link https://www.php.net/manual/en/datetime.formats.php} * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { // Operator selector. $operatorlabel = get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()); $typesnounit = [self::DATE_ANY, self::DATE_NOT_EMPTY, self::DATE_EMPTY, self::DATE_RANGE, self::DATE_PAST, self::DATE_FUTURE]; $elements[] = $mform->createElement('select', "{$this->name}_operator", $operatorlabel, $this->get_operators()); $mform->setType("{$this->name}_operator", PARAM_INT); $mform->setDefault("{$this->name}_operator", self::DATE_ANY); // Value selector for last and next operators. $valuelabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $elements[] = $mform->createElement('text', "{$this->name}_value", $valuelabel, ['size' => 3]); $mform->setType("{$this->name}_value", PARAM_INT); $mform->setDefault("{$this->name}_value", 1); $mform->hideIf("{$this->name}_value", "{$this->name}_operator", 'in', array_merge($typesnounit, [self::DATE_CURRENT])); // Unit selector for last and next operators. $unitlabel = get_string('filterfieldunit', 'core_reportbuilder', $this->get_header()); $units = [ self::DATE_UNIT_MINUTE => get_string('filterdateminutes', 'core_reportbuilder'), self::DATE_UNIT_HOUR => get_string('filterdatehours', 'core_reportbuilder'), self::DATE_UNIT_DAY => get_string('filterdatedays', 'core_reportbuilder'), self::DATE_UNIT_WEEK => get_string('filterdateweeks', 'core_reportbuilder'), self::DATE_UNIT_MONTH => get_string('filterdatemonths', 'core_reportbuilder'), self::DATE_UNIT_YEAR => get_string('filterdateyears', 'core_reportbuilder'), ]; $elements[] = $mform->createElement('select', "{$this->name}_unit", $unitlabel, $units); $mform->setType("{$this->name}_unit", PARAM_INT); $mform->setDefault("{$this->name}_unit", self::DATE_UNIT_DAY); $mform->hideIf("{$this->name}_unit", "{$this->name}_operator", 'in', $typesnounit); // Add operator/value/unit group. $mform->addGroup($elements, "{$this->name}_group", $this->get_header(), '', false) ->setHiddenLabel(true); // Date selectors for range operator. $mform->addElement('date_selector', "{$this->name}_from", get_string('filterfieldfrom', 'core_reportbuilder', $this->get_header()), ['optional' => true]); $mform->setType("{$this->name}_from", PARAM_INT); $mform->setDefault("{$this->name}_from", 0); $mform->hideIf("{$this->name}_from", "{$this->name}_operator", 'neq', self::DATE_RANGE); $mform->addElement('date_selector', "{$this->name}_to", get_string('filterfieldto', 'core_reportbuilder', $this->get_header()), ['optional' => true]); $mform->setType("{$this->name}_to", PARAM_INT); $mform->setDefault("{$this->name}_to", 0); $mform->hideIf("{$this->name}_to", "{$this->name}_operator", 'neq', self::DATE_RANGE); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $operator = (int) ($values["{$this->name}_operator"] ?? self::DATE_ANY); $dateunitvalue = (int) ($values["{$this->name}_value"] ?? 1); $dateunit = (int) ($values["{$this->name}_unit"] ?? self::DATE_UNIT_DAY); switch ($operator) { case self::DATE_NOT_EMPTY: $sql = "COALESCE({$fieldsql}, 0) <> 0"; break; case self::DATE_EMPTY: $sql = "COALESCE({$fieldsql}, 0) = 0"; break; case self::DATE_RANGE: $sql = ''; $datefrom = (int)($values["{$this->name}_from"] ?? 0); $dateto = (int)($values["{$this->name}_to"] ?? 0); [$paramdatefrom, $paramdateto] = database::generate_param_names(2); if ($datefrom > 0 && $dateto > 0) { $sql = "{$fieldsql} BETWEEN :{$paramdatefrom} AND :{$paramdateto}"; $params[$paramdatefrom] = $datefrom; $params[$paramdateto] = $dateto; } else if ($datefrom > 0) { $sql = "{$fieldsql} >= :{$paramdatefrom}"; $params[$paramdatefrom] = $datefrom; } else if ($dateto > 0) { $sql = "{$fieldsql} < :{$paramdateto}"; $params[$paramdateto] = $dateto; } break; case self::DATE_BEFORE: $param = database::generate_param_name(); // We can use the start date of the "Last" operator as the end date here. $sql = "{$fieldsql} < :{$param}"; $params[$param] = self::get_relative_timeframe(self::DATE_LAST, $dateunitvalue, $dateunit)[0]; break; case self::DATE_AFTER: $param = database::generate_param_name(); // We can use the end date of the "Next" operator as the start date here. $sql = "{$fieldsql} > :{$param}"; $params[$param] = self::get_relative_timeframe(self::DATE_NEXT, $dateunitvalue, $dateunit)[1]; break; // Relative helper method can handle these three cases. case self::DATE_LAST: case self::DATE_CURRENT: case self::DATE_NEXT: // Last and next operators require a unit value greater than zero. if ($operator !== self::DATE_CURRENT && $dateunitvalue === 0) { return ['', []]; } // Generate parameters and SQL clause for the relative date comparison. [$paramdatefrom, $paramdateto] = database::generate_param_names(2); $sql = "{$fieldsql} BETWEEN :{$paramdatefrom} AND :{$paramdateto}"; [ $params[$paramdatefrom], $params[$paramdateto], ] = self::get_relative_timeframe($operator, $dateunitvalue, $dateunit); break; case self::DATE_PAST: $param = database::generate_param_name(); $sql = "{$fieldsql} < :{$param}"; $params[$param] = di::get(clock::class)->time(); break; case self::DATE_FUTURE: $param = database::generate_param_name(); $sql = "{$fieldsql} > :{$param}"; $params[$param] = di::get(clock::class)->time(); break; default: // Invalid or inactive filter. return ['', []]; } return [$sql, $params]; } /** * Return start and end time of given relative date period * * @param int $operator One of the ::DATE_LAST/CURRENT/NEXT constants * @param int $dateunitvalue Unit multiplier of the date unit * @param int $dateunit One of the ::DATE_UNIT_* constants * @return int[] Timestamps representing the start/end of timeframe */ private static function get_relative_timeframe(int $operator, int $dateunitvalue, int $dateunit): array { // Initialise start/end time to now. $datestart = $dateend = di::get(clock::class)->now(); switch ($dateunit) { case self::DATE_UNIT_MINUTE: if ($operator === self::DATE_CURRENT) { $hour = (int) $datestart->format('G'); $minute = (int) $datestart->format('i'); $datestart = $datestart->setTime($hour, $minute); $dateend = $dateend->setTime($hour, $minute, 59); } else if ($operator === self::DATE_LAST) { $datestart = $datestart->modify("-{$dateunitvalue} minute"); } else if ($operator === self::DATE_NEXT) { $dateend = $dateend->modify("+{$dateunitvalue} minute"); } break; case self::DATE_UNIT_HOUR: if ($operator === self::DATE_CURRENT) { $hour = (int) $datestart->format('G'); $datestart = $datestart->setTime($hour, 0); $dateend = $dateend->setTime($hour, 59, 59); } else if ($operator === self::DATE_LAST) { $datestart = $datestart->modify("-{$dateunitvalue} hour"); } else if ($operator === self::DATE_NEXT) { $dateend = $dateend->modify("+{$dateunitvalue} hour"); } break; case self::DATE_UNIT_DAY: if ($operator === self::DATE_CURRENT) { $datestart = $datestart->setTime(0, 0); $dateend = $dateend->setTime(23, 59, 59); } else if ($operator === self::DATE_LAST) { $datestart = $datestart->modify("-{$dateunitvalue} day"); } else if ($operator === self::DATE_NEXT) { $dateend = $dateend->modify("+{$dateunitvalue} day"); } break; case self::DATE_UNIT_WEEK: if ($operator === self::DATE_CURRENT) { // The first day of the week is determined by site calendar configuration/preferences. $startweekday = \core_calendar\type_factory::get_calendar_instance()->get_starting_weekday(); $weekdays = ['sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat']; // If calculated start of week is after today (today is Tues/start of week is Weds), move back a week. $datestartnow = $datestart->getTimestamp(); $datestart = $datestart->modify($weekdays[$startweekday] . ' this week')->setTime(0, 0); if ($datestart->getTimestamp() > $datestartnow) { $datestart = $datestart->modify('-1 week'); } $dateend = $datestart->modify('+6 day')->setTime(23, 59, 59); } else if ($operator === self::DATE_LAST) { $datestart = $datestart->modify("-{$dateunitvalue} week"); } else if ($operator === self::DATE_NEXT) { $dateend = $dateend->modify("+{$dateunitvalue} week"); } break; case self::DATE_UNIT_MONTH: if ($operator === self::DATE_CURRENT) { $datestart = $datestart->modify('first day of this month')->setTime(0, 0); $dateend = $dateend->modify('last day of this month')->setTime(23, 59, 59); } else if ($operator === self::DATE_LAST) { $datestart = $datestart->modify("-{$dateunitvalue} month"); } else if ($operator === self::DATE_NEXT) { $dateend = $dateend->modify("+{$dateunitvalue} month"); } break; case self::DATE_UNIT_YEAR: if ($operator === self::DATE_CURRENT) { $datestart = $datestart->modify('first day of january this year')->setTime(0, 0); $dateend = $dateend->modify('last day of december this year')->setTime(23, 59, 59); } else if ($operator === self::DATE_LAST) { $datestart = $datestart->modify("-{$dateunitvalue} year"); } else if ($operator === self::DATE_NEXT) { $dateend = $dateend->modify("+{$dateunitvalue} year"); } break; } return [ $datestart->getTimestamp(), $dateend->getTimestamp(), ]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::DATE_CURRENT, "{$this->name}_unit" => self::DATE_UNIT_WEEK, ]; } } PK a<�\2���R R classes/local/filters/cohort.phpnu �[��� <?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\local\filters; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Cohort selector filter class implementation * * @package core_reportbuilder * @copyright 2024 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class cohort extends base { /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $mform->addElement( 'cohort', "{$this->name}_values", get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()), [ 'multiple' => true, ], )->setHiddenLabel(true); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $cohortids = $values["{$this->name}_values"] ?? []; if (empty($cohortids)) { return ['', []]; } [$cohortselect, $cohortparams] = $DB->get_in_or_equal( $cohortids, SQL_PARAMS_NAMED, database::generate_param_name('_'), ); return ["{$fieldsql} $cohortselect", array_merge($params, $cohortparams)]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_values" => [1], ]; } } PK a<�\��� " classes/local/filters/category.phpnu �[��� <?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\local\filters; use core_course_category; use lang_string; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Course category report filter * * The following optional array property can be passed to the {@see \core_reportbuilder\local\report\filter::set_options} method * when defining this filter, to define the capabilities passed to {@see \core_course_category::make_categories_list} * * ['requiredcapabilities' => '...'] * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class category extends base { /** @var int Category is equal to */ public const EQUAL_TO = 0; /** @var int Category is not equal to */ public const NOT_EQUAL_TO = 1; /** * Returns an array of comparison operators * * @return array */ private function get_operators(): array { $operators = [ self::EQUAL_TO => new lang_string('filterisequalto', 'core_reportbuilder'), self::NOT_EQUAL_TO => new lang_string('filterisnotequalto', 'core_reportbuilder'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $operatorlabel = get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()); $mform->addElement('select', "{$this->name}_operator", $operatorlabel, $this->get_operators()) ->setHiddenLabel(true); // See MDL-74627: in order to set the default value to "No selection" we need to prepend an empty value. $requiredcapabilities = $this->filter->get_options()['requiredcapabilities'] ?? ''; $categories = [0 => ''] + core_course_category::make_categories_list($requiredcapabilities); $valuelabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $mform->addElement('autocomplete', "{$this->name}_value", $valuelabel, $categories)->setHiddenLabel(true); $mform->addElement('advcheckbox', "{$this->name}_subcategories", get_string('includesubcategories')); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; [$fieldsql, $params] = $this->filter->get_field_sql_and_params(); $operator = (int) ($values["{$this->name}_operator"] ?? self::EQUAL_TO); $category = (int) ($values["{$this->name}_value"] ?? 0); $subcategories = !empty($values["{$this->name}_subcategories"]); // Invalid or inactive filter. if (empty($category)) { return ['', []]; } // Initial matching on selected category. $paramcategory = database::generate_param_name(); $params[$paramcategory] = $category; $sql = "{$fieldsql} = :{$paramcategory}"; // Sub-category matching on path of selected category. if ($subcategories) { // We need to re-use the original filter SQL here, while ensuring parameter uniqueness is preserved. [$fieldsql, $params1] = $this->filter->get_field_sql_and_params(1); $params = array_merge($params, $params1); $paramcategorypath = database::generate_param_name(); $params[$paramcategorypath] = "%/{$category}/%"; $sql .= " OR {$fieldsql} IN ( SELECT id FROM {course_categories} WHERE " . $DB->sql_like('path', ":{$paramcategorypath}") . " )"; } // If specified "Not equal to", then negate the entire clause. if ($operator === self::NOT_EQUAL_TO) { $sql = "NOT ({$sql})"; } return [$sql, $params]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_value" => 1, ]; } } PK a<�\}��:! :! classes/local/filters/tags.phpnu �[��� <?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\local\filters; use core_tag_tag; use lang_string; use MoodleQuickForm; use stdClass; use core_reportbuilder\local\helpers\database; use core_reportbuilder\local\report\filter; /** * Class containing logic for the tags filter * * The filter can operate in two modes: * * 1. Filtering of tags directly from the {tag} table, in which case the field SQL expression should return the ID of that table; * 2. Filtering of component tags, in which case the field SQL expression should return the ID of the component table that would * join to the {tag_instance} itemid field * * If filtering component tags then the following must be passed to the {@see filter::get_options} method when using this filter * in a report: ['component' => 'mycomponent', 'itemtype' => 'myitem'] * * @package core_reportbuilder * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class tags extends base { /** @var int Any value */ public const ANY_VALUE = 0; /** @var int Tags are present */ public const NOT_EMPTY = 1; /** @var int Filter for selected tags */ public const EQUAL_TO = 2; /** @var int Tags are not present */ public const EMPTY = 3; /** @var int Filter for excluded tags */ public const NOT_EQUAL_TO = 4; /** * Returns an array of comparison operators * * @return array */ private function get_operators(): array { $operators = [ self::ANY_VALUE => new lang_string('filterisanyvalue', 'core_reportbuilder'), self::NOT_EMPTY => new lang_string('filterisnotempty', 'core_reportbuilder'), self::EMPTY => new lang_string('filterisempty', 'core_reportbuilder'), self::EQUAL_TO => new lang_string('filterisequalto', 'core_reportbuilder'), self::NOT_EQUAL_TO => new lang_string('filterisnotequalto', 'core_reportbuilder'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { global $DB; $operatorlabel = get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()); $mform->addElement('select', "{$this->name}_operator", $operatorlabel, $this->get_operators()) ->setHiddenLabel(true); // If we're filtering component tags, show only those related to the component itself. $options = (array) $this->filter->get_options(); if (array_key_exists('component', $options) && array_key_exists('itemtype', $options)) { $taginstancejoin = 'JOIN {tag_instance} ti ON ti.tagid = t.id WHERE ti.component = :component AND ti.itemtype = :itemtype'; $params = array_intersect_key($options, array_flip(['component', 'itemtype'])); } else { $taginstancejoin = ''; $params = []; } $sql = "SELECT DISTINCT t.id, t.name, t.rawname FROM {tag} t {$taginstancejoin} ORDER BY t.name"; // Transform tag records into appropriate display name, for selection in the autocomplete element. $tags = array_map(static function(stdClass $record): string { return core_tag_tag::make_display_name($record); }, $DB->get_records_sql($sql, $params)); $valuelabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $mform->addElement('autocomplete', "{$this->name}_value", $valuelabel, $tags, ['multiple' => true]) ->setHiddenLabel(true); $mform->hideIf("{$this->name}_value", "{$this->name}_operator", 'in', [self::ANY_VALUE, self::EMPTY, self::NOT_EMPTY]); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $operator = (int) ($values["{$this->name}_operator"] ?? self::ANY_VALUE); $tags = (array) ($values["{$this->name}_value"] ?? []); // If we're filtering component tags, we need to perform [not] exists queries to ensure no row duplication occurs. $options = (array) $this->filter->get_options(); if (array_key_exists('component', $options) && array_key_exists('itemtype', $options)) { [$paramcomponent, $paramitemtype] = database::generate_param_names(2); $componenttagselect = <<<EOF SELECT 1 FROM {tag} t JOIN {tag_instance} ti ON ti.tagid = t.id WHERE ti.component = :{$paramcomponent} AND ti.itemtype = :{$paramitemtype} AND ti.itemid = {$fieldsql} EOF; $params[$paramcomponent] = $options['component']; $params[$paramitemtype] = $options['itemtype']; if ($operator === self::NOT_EMPTY) { $select = "EXISTS ({$componenttagselect})"; } else if ($operator === self::EMPTY) { $select = "NOT EXISTS ({$componenttagselect})"; } else if ($operator === self::EQUAL_TO && !empty($tags)) { [$tagselect, $tagselectparams] = $DB->get_in_or_equal($tags, SQL_PARAMS_NAMED, database::generate_param_name('_')); $select = "EXISTS ({$componenttagselect} AND t.id {$tagselect})"; $params = array_merge($params, $tagselectparams); } else if ($operator === self::NOT_EQUAL_TO && !empty($tags)) { [$tagselect, $tagselectparams] = $DB->get_in_or_equal($tags, SQL_PARAMS_NAMED, database::generate_param_name('_')); // We should also return those elements that aren't tagged at all. $select = "NOT EXISTS ({$componenttagselect} AND t.id {$tagselect})"; $params = array_merge($params, $tagselectparams); } else { // Invalid/inactive (any value) filter.. return ['', []]; } } else { // We're filtering directly from the tag table. if ($operator === self::NOT_EMPTY) { $select = "{$fieldsql} IS NOT NULL"; } else if ($operator === self::EMPTY) { $select = "{$fieldsql} IS NULL"; } else if ($operator === self::EQUAL_TO && !empty($tags)) { [$tagselect, $tagselectparams] = $DB->get_in_or_equal($tags, SQL_PARAMS_NAMED, database::generate_param_name('_')); $select = "{$fieldsql} {$tagselect}"; $params = array_merge($params, $tagselectparams); } else if ($operator === self::NOT_EQUAL_TO && !empty($tags)) { [$tagselect, $tagselectparams] = $DB->get_in_or_equal($tags, SQL_PARAMS_NAMED, database::generate_param_name('_'), false); // We should also return those elements that aren't tagged at all. $select = "COALESCE({$fieldsql}, 0) {$tagselect}"; $params = array_merge($params, $tagselectparams); } else { // Invalid/inactive (any value) filter.. return ['', []]; } } return [$select, $params]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::EQUAL_TO, "{$this->name}_value" => [1], ]; } } PK a<�\r� " classes/local/filters/duration.phpnu �[��� <?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\local\filters; use lang_string; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Duration report filter * * This filter accepts a number of seconds to perform filtering on (note that the value will be cast to float prior to comparison) * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class duration extends base { /** @var int Any value */ public const DURATION_ANY = 0; /** @var int Maximum duration */ public const DURATION_MAXIMUM = 1; /** @var int Minimum duration */ public const DURATION_MINIMUM = 2; /** * Return an array of operators available for this filter * * @return lang_string[] */ private function get_operators(): array { $operators = [ self::DURATION_ANY => new lang_string('filterisanyvalue', 'core_reportbuilder'), self::DURATION_MAXIMUM => new lang_string('filterlessthan', 'core_reportbuilder'), self::DURATION_MINIMUM => new lang_string('filtergreaterthan', 'core_reportbuilder'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $elements = []; // Operator. $operatorlabel = get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()); $elements[] = $mform->createElement('select', "{$this->name}_operator", $operatorlabel, $this->get_operators()); $mform->setType("{$this->name}_operator", PARAM_INT); $mform->setDefault("{$this->name}_operator", self::DURATION_ANY); // Value. $valuelabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $elements[] = $mform->createElement('text', "{$this->name}_value", $valuelabel, ['size' => 3]); $mform->setType("{$this->name}_value", PARAM_LOCALISEDFLOAT); $mform->setDefault("{$this->name}_value", 0); $mform->hideIf("{$this->name}_value", "{$this->name}_operator", 'eq', self::DURATION_ANY); // Unit. $unitlabel = get_string('filterfieldunit', 'core_reportbuilder', $this->get_header()); $units = [ 1 => get_string('filterdateseconds', 'core_reportbuilder'), MINSECS => get_string('filterdateminutes', 'core_reportbuilder'), HOURSECS => get_string('filterdatehours', 'core_reportbuilder'), DAYSECS => get_string('filterdatedays', 'core_reportbuilder'), WEEKSECS => get_string('filterdateweeks', 'core_reportbuilder'), ]; $elements[] = $mform->createElement('select', "{$this->name}_unit", $unitlabel, $units); $mform->setType("{$this->name}_unit", PARAM_INT); $mform->setDefault("{$this->name}_unit", 1); $mform->hideIf("{$this->name}_unit", "{$this->name}_operator", 'eq', self::DURATION_ANY); $mform->addGroup($elements, "{$this->name}_group", $this->get_header(), '', false) ->setHiddenLabel(true); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $operator = (int) ($values["{$this->name}_operator"] ?? self::DURATION_ANY); $durationvalue = unformat_float($values["{$this->name}_value"] ?? 0); $durationunit = (int) ($values["{$this->name}_unit"] ?? 0); $paramduration = database::generate_param_name(); $params[$paramduration] = $durationvalue * $durationunit; switch ($operator) { case self::DURATION_MAXIMUM: $sql = $DB->sql_cast_char2real("({$fieldsql})") . " <= :{$paramduration}"; break; case self::DURATION_MINIMUM: $sql = $DB->sql_cast_char2real("({$fieldsql})") . " >= :{$paramduration}"; break; default: // Invalid or inactive filter. return ['', []]; } return [$sql, $params]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::DURATION_MAXIMUM, "{$this->name}_value" => 2, "{$this->name}_unit" => MINSECS, ]; } } PK a<�\U�tlS S & classes/local/filters/autocomplete.phpnu �[��� <?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\local\filters; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Autocomplete report filter * * @package core_reportbuilder * @copyright 2022 Nathan Nguyen <nathannguyen@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class autocomplete extends base { /** * Return the options for the filter as an array, to be used to populate the select input field * * @return array */ protected function get_select_options(): array { return (array) $this->filter->get_options(); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $operatorlabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $values = [0 => ''] + $this->get_select_options(); $options = ['multiple' => true]; $mform->addElement('autocomplete', $this->name . '_values', $operatorlabel, $values, $options) ->setHiddenLabel(true); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $invalues = $values["{$this->name}_values"] ?? []; if (empty($invalues)) { return ['', []]; } [$insql, $inparams] = $DB->get_in_or_equal($invalues, SQL_PARAMS_NAMED, database::generate_param_name('_')); return ["{$fieldsql} $insql", array_merge($params, $inparams)]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_values" => [1], ]; } } PK a<�\�7` ` classes/local/filters/user.phpnu �[��� <?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\local\filters; use context_system; use core_user; use lang_string; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * User report filter * * This filter expects field SQL referring to a user ID (e.g. "{$tableuser}.id") * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class user extends base { /** @var int Filter for any user */ public const USER_ANY = 0; /** @var int Filter for current user */ public const USER_CURRENT = 1; /** @var int Filter for selected user */ public const USER_SELECT = 2; /** * Return an array of operators available for this filter * * @return lang_string[] */ private function get_operators(): array { $operators = [ self::USER_ANY => new lang_string('userany', 'core_reportbuilder'), self::USER_CURRENT => new lang_string('usercurrent', 'core_reportbuilder'), self::USER_SELECT => new lang_string('select'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $operatorlabel = get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()); $mform->addElement('select', "{$this->name}_operator", $operatorlabel, $this->get_operators()) ->setHiddenLabel(true); $mform->setType("{$this->name}_operator", PARAM_INT); $mform->setDefault("{$this->name}_operator", self::USER_ANY); // Specific user selection. $valuelabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $options = [ 'ajax' => 'core_user/form_user_selector', 'multiple' => true, 'valuehtmlcallback' => static function($userid): string { $user = core_user::get_user($userid); return fullname($user, has_capability('moodle/site:viewfullnames', context_system::instance())); } ]; $mform->addElement('autocomplete', "{$this->name}_value", $valuelabel, [], $options) ->setHiddenLabel(true); $mform->hideIf("{$this->name}_value", "{$this->name}_operator", 'neq', self::USER_SELECT); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB, $USER; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $operator = $values["{$this->name}_operator"] ?? self::USER_ANY; $userids = $values["{$this->name}_value"] ?? []; switch ($operator) { case self::USER_CURRENT: $paramuserid = database::generate_param_name(); $sql = "{$fieldsql} = :{$paramuserid}"; $params[$paramuserid] = $USER->id; break; case self::USER_SELECT: [$useridselect, $useridparams] = $DB->get_in_or_equal( $userids, SQL_PARAMS_NAMED, database::generate_param_name('_'), true, null, ); $sql = "{$fieldsql} {$useridselect}"; $params = array_merge($params, $useridparams); break; default: // Invalid or inactive filter. return ['', []]; } return [$sql, $params]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::USER_SELECT, "{$this->name}_value" => [1], ]; } } PK a<�\=uƃ) ) classes/local/filters/text.phpnu �[��� <?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\local\filters; use core_reportbuilder\local\helpers\database; /** * Text report filter * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class text extends base { /** @var int */ public const ANY_VALUE = 0; /** @var int */ public const CONTAINS = 1; /** @var int */ public const DOES_NOT_CONTAIN = 2; /** @var int */ public const IS_EQUAL_TO = 3; /** @var int */ public const IS_NOT_EQUAL_TO = 4; /** @var int */ public const STARTS_WITH = 5; /** @var int */ public const ENDS_WITH = 6; /** @var int */ public const IS_EMPTY = 7; /** @var int */ public const IS_NOT_EMPTY = 8; /** * Return an array of operators available for this filter * * @return array of comparison operators */ private function get_operators(): array { $operators = [ self::ANY_VALUE => get_string('filterisanyvalue', 'core_reportbuilder'), self::CONTAINS => get_string('filtercontains', 'core_reportbuilder'), self::DOES_NOT_CONTAIN => get_string('filterdoesnotcontain', 'core_reportbuilder'), self::IS_EQUAL_TO => get_string('filterisequalto', 'core_reportbuilder'), self::IS_NOT_EQUAL_TO => get_string('filterisnotequalto', 'core_reportbuilder'), self::STARTS_WITH => get_string('filterstartswith', 'core_reportbuilder'), self::ENDS_WITH => get_string('filterendswith', 'core_reportbuilder'), self::IS_EMPTY => get_string('filterisempty', 'core_reportbuilder'), self::IS_NOT_EMPTY => get_string('filterisnotempty', 'core_reportbuilder') ]; return $this->filter->restrict_limited_operators($operators); } /** * Adds controls specific to this filter in the form. * * Operator selector use the "$this->name . '_operator'" naming convention and the fields to enter custom values should * use "$this->name . '_value'" or _value1/_value2/... in case there is more than one field for their naming. * * @param \MoodleQuickForm $mform */ public function setup_form(\MoodleQuickForm $mform): void { $elements = []; $elements['operator'] = $mform->createElement('select', $this->name . '_operator', get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()), $this->get_operators()); $elements['value'] = $mform->createElement('text', $this->name . '_value', get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header())); $mform->addGroup($elements, $this->name . '_group', $this->get_header(), '', false) ->setHiddenLabel(true); $mform->setType($this->name . '_value', PARAM_RAW_TRIMMED); $mform->hideIf($this->name . '_value', $this->name . '_operator', 'eq', self::ANY_VALUE); $mform->hideIf($this->name . '_value', $this->name . '_operator', 'eq', self::IS_EMPTY); $mform->hideIf($this->name . '_value', $this->name . '_operator', 'eq', self::IS_NOT_EMPTY); } /** * Return filter SQL * * @param array $values * @return array array of two elements - SQL query and named parameters */ public function get_sql_filter(array $values): array { global $DB; $name = database::generate_param_name(); $operator = (int) ($values["{$this->name}_operator"] ?? self::ANY_VALUE); $value = trim($values["{$this->name}_value"] ?? ''); $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); // Validate filter form values. if (!$this->validate_filter_values($operator, $value)) { // Filter configuration is invalid. Ignore the filter. return ['', []]; } switch($operator) { case self::CONTAINS: $res = $DB->sql_like($fieldsql, ":$name", false, false); $value = $DB->sql_like_escape($value); $params[$name] = "%$value%"; break; case self::DOES_NOT_CONTAIN: $res = $DB->sql_like($fieldsql, ":$name", false, false, true); $value = $DB->sql_like_escape($value); $params[$name] = "%$value%"; break; case self::IS_EQUAL_TO: $res = $DB->sql_equal($fieldsql, ":$name", false, false); $params[$name] = $value; break; case self::IS_NOT_EQUAL_TO: $res = $DB->sql_equal($fieldsql, ":$name", false, false, true); $params[$name] = $value; break; case self::STARTS_WITH: $res = $DB->sql_like($fieldsql, ":$name", false, false); $value = $DB->sql_like_escape($value); $params[$name] = "$value%"; break; case self::ENDS_WITH: $res = $DB->sql_like($fieldsql, ":$name", false, false); $value = $DB->sql_like_escape($value); $params[$name] = "%$value"; break; case self::IS_EMPTY: $paramempty = database::generate_param_name(); $res = "COALESCE({$fieldsql}, :{$paramempty}) = :{$name}"; $params[$paramempty] = $params[$name] = ''; break; case self::IS_NOT_EMPTY: $paramempty = database::generate_param_name(); $res = "COALESCE({$fieldsql}, :{$paramempty}) != :{$name}"; $params[$paramempty] = $params[$name] = ''; break; default: // Filter configuration is invalid. Ignore the filter. return ['', []]; } return array($res, $params); } /** * Validate filter form values * * @param int $operator * @param string|null $value * @return bool */ private function validate_filter_values(int $operator, ?string $value): bool { $operatorsthatdontrequirevalue = [ self::ANY_VALUE, self::IS_EMPTY, self::IS_NOT_EMPTY, ]; if ($value === '' && !in_array($operator, $operatorsthatdontrequirevalue)) { return false; } return true; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::IS_EQUAL_TO, "{$this->name}_value" => 'test', ]; } } PK a<�\~]��� � ( classes/local/filters/boolean_select.phpnu �[��� <?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\local\filters; use lang_string; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Boolean report filter * * This filter accepts an expression that evaluates to 1 or 0, either a simple field such as "u.suspended", or a more complex * expression such as "CASE WHEN <EXPRESSION> THEN 1 ELSE 0 END" * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class boolean_select extends base { /** @var int Any value */ public const ANY_VALUE = 0; /** @var int Checked */ public const CHECKED = 1; /** @var int Not checked */ public const NOT_CHECKED = 2; /** * Return an array of operators available for this filter * * @return lang_string[] */ private function get_operators(): array { $operators = [ self::ANY_VALUE => new lang_string('filterisanyvalue', 'core_reportbuilder'), self::CHECKED => new lang_string('yes'), self::NOT_CHECKED => new lang_string('no'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $operatorlabel = get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()); $mform->addElement('select', "{$this->name}_operator", $operatorlabel, $this->get_operators()) ->setHiddenLabel(true); $mform->setType("{$this->name}_operator", PARAM_INT); $mform->setDefault("{$this->name}_operator", self::ANY_VALUE); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $paramname = database::generate_param_name(); $operator = $values["{$this->name}_operator"] ?? self::ANY_VALUE; switch ($operator) { case self::CHECKED: $fieldsql .= " = :{$paramname}"; $params[$paramname] = 1; break; case self::NOT_CHECKED: $fieldsql .= " = :{$paramname}"; $params[$paramname] = 0; break; default: // Invalid or inactive filter. return ['', []]; } return [$fieldsql, $params]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::CHECKED, ]; } } PK a<�\<u!0 0 classes/local/filters/select.phpnu �[��� <?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\local\filters; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Select report filter * * The options for the select are defined when creating the filter by calling {@see set_options} or {@see set_options_callback} * * To extend this class in your own filter (e.g. to pre-populate available options), you should override the {@see get_operators} * and/or {@see get_select_options} methods * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class select extends base { /** @var int Any value */ public const ANY_VALUE = 0; /** @var int Equal to */ public const EQUAL_TO = 1; /** @var int Not equal to */ public const NOT_EQUAL_TO = 2; /** * Returns an array of comparison operators * * @return array */ protected function get_operators(): array { $operators = [ self::ANY_VALUE => get_string('filterisanyvalue', 'core_reportbuilder'), self::EQUAL_TO => get_string('filterisequalto', 'core_reportbuilder'), self::NOT_EQUAL_TO => get_string('filterisnotequalto', 'core_reportbuilder') ]; return $this->filter->restrict_limited_operators($operators); } /** * Return the options for the filter as an array, to be used to populate the select input field * * @return array */ protected function get_select_options(): array { return (array) $this->filter->get_options(); } /** * Adds controls specific to this filter in the form. * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $elements = []; $elements['operator'] = $mform->createElement('select', $this->name . '_operator', get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()), $this->get_operators()); // If a multi-dimensional array is passed, we need to use a different element type. $options = $this->get_select_options(); $element = (count($options) == count($options, COUNT_RECURSIVE) ? 'select' : 'selectgroups'); $elements['value'] = $mform->createElement($element, $this->name . '_value', get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()), $options); $mform->addGroup($elements, $this->name . '_group', $this->get_header(), '', false) ->setHiddenLabel(true); $mform->hideIf($this->name . '_value', $this->name . '_operator', 'eq', self::ANY_VALUE); } /** * Return filter SQL * * Note that operators must be of type integer, while values can be integer or string. * * @param array $values * @return array array of two elements - SQL query and named parameters */ public function get_sql_filter(array $values): array { $name = database::generate_param_name(); $operator = $values["{$this->name}_operator"] ?? self::ANY_VALUE; $value = $values["{$this->name}_value"] ?? 0; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); // Validate filter form values. if (!$this->validate_filter_values((int) $operator, $value)) { // Filter configuration is invalid. Ignore the filter. return ['', []]; } switch ($operator) { case self::EQUAL_TO: $fieldsql .= "=:$name"; $params[$name] = $value; break; case self::NOT_EQUAL_TO: $fieldsql .= "<>:$name"; $params[$name] = $value; break; default: return ['', []]; } return [$fieldsql, $params]; } /** * Validate filter form values * * @param int|null $operator * @param mixed|null $value * @return bool */ private function validate_filter_values(?int $operator, $value): bool { return !($operator === null || $value === ''); } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::EQUAL_TO, "{$this->name}_value" => 1, ]; } } PK a<�\����� � " classes/local/filters/filesize.phpnu �[��� <?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\local\filters; use core_reportbuilder\local\helpers\database; use lang_string; use MoodleQuickForm; /** * Filesize report filter * * This filter accepts a number value to perform filtering on (note that the value will be cast to float prior to comparison) * * @package core_reportbuilder * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class filesize extends base { /** @var int Any value */ public const ANY_VALUE = 0; /** @var int Less than */ public const LESS_THAN = 3; /** @var int Greater than */ public const GREATER_THAN = 4; /** @var int Bytes */ public const SIZE_UNIT_BYTE = 1; /** @var int Kilobytes */ public const SIZE_UNIT_KILOBYTE = 1024; /** @var int Megabytes */ public const SIZE_UNIT_MEGABYTE = self::SIZE_UNIT_KILOBYTE * 1024; /** @var int Gigabytes */ public const SIZE_UNIT_GIGABYTE = self::SIZE_UNIT_MEGABYTE * 1024; /** * Return an array of operators available for this filter * * @return lang_string[] */ private function get_operators(): array { $operators = [ self::ANY_VALUE => new lang_string('filterisanyvalue', 'core_reportbuilder'), self::LESS_THAN => new lang_string('filterlessthan', 'core_reportbuilder'), self::GREATER_THAN => new lang_string('filtergreaterthan', 'core_reportbuilder'), ]; return $this->filter->restrict_limited_operators($operators); } /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { // Operator selector. $elements[] = $mform->createElement('select', "{$this->name}_operator", get_string('filterfieldoperator', 'core_reportbuilder', $this->get_header()), $this->get_operators()); $mform->setType("{$this->name}_operator", PARAM_INT); $mform->setDefault("{$this->name}_operator", self::ANY_VALUE); // Value selector. $elements[] = $mform->createElement('text', "{$this->name}_value1", get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()), ['size' => 4]); $mform->setType("{$this->name}_value1", PARAM_LOCALISEDFLOAT); $mform->setDefault("{$this->name}_value1", 1); $mform->hideIf("{$this->name}_value1", "{$this->name}_operator", 'eq', self::ANY_VALUE); // Unit selector. $units = [ self::SIZE_UNIT_BYTE => new lang_string('sizeb'), self::SIZE_UNIT_KILOBYTE => new lang_string('sizekb'), self::SIZE_UNIT_MEGABYTE => new lang_string('sizemb'), self::SIZE_UNIT_GIGABYTE => new lang_string('sizegb'), ]; $elements[] = $mform->createElement('select', "{$this->name}_unit", get_string('filterfieldunit', 'core_reportbuilder', $this->get_header()), $units); $mform->setType("{$this->name}_unit", PARAM_INT); $mform->setDefault("{$this->name}_unit", self::SIZE_UNIT_BYTE); $mform->hideIf("{$this->name}_unit", "{$this->name}_operator", 'eq', self::ANY_VALUE); $mform->addGroup($elements, "{$this->name}_group", $this->get_header(), '', false) ->setHiddenLabel(true); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $operator = (int) ($values["{$this->name}_operator"] ?? self::ANY_VALUE); $filesizevalue = unformat_float($values["{$this->name}_value1"] ?? 1); $filesizeunit = (int) ($values["{$this->name}_unit"] ?? self::SIZE_UNIT_BYTE); $paramfilesize = database::generate_param_name(); $params[$paramfilesize] = $filesizevalue * $filesizeunit; switch ($operator) { case self::LESS_THAN: $sql = $DB->sql_cast_char2real("({$fieldsql})") . " < :{$paramfilesize}"; break; case self::GREATER_THAN: $sql = $DB->sql_cast_char2real("({$fieldsql})") . " > :{$paramfilesize}"; break; default: // Invalid or inactive filter. return ['', []]; } return [$sql, $params]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_operator" => self::GREATER_THAN, "{$this->name}_value1" => 1, "{$this->name}_unit" => self::SIZE_UNIT_KILOBYTE, ]; } } PK a<�\�O�E E ) classes/local/filters/course_selector.phpnu �[��� <?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\local\filters; use MoodleQuickForm; use core_reportbuilder\local\helpers\database; /** * Course selector filter class implementation * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com>. * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class course_selector extends base { /** * Setup form * * @param MoodleQuickForm $mform */ public function setup_form(MoodleQuickForm $mform): void { $operatorlabel = get_string('filterfieldvalue', 'core_reportbuilder', $this->get_header()); $options = [ 'multiple' => true, ]; $mform->addElement('course', $this->name . '_values', $operatorlabel, $options) ->setHiddenLabel(true); } /** * Return filter SQL * * @param array $values * @return array */ public function get_sql_filter(array $values): array { global $DB; $fieldsql = $this->filter->get_field_sql(); $params = $this->filter->get_field_params(); $courseids = $values["{$this->name}_values"] ?? []; if (empty($courseids)) { return ['', []]; } [$courseselect, $courseparams] = $DB->get_in_or_equal($courseids, SQL_PARAMS_NAMED, database::generate_param_name('_')); return ["{$fieldsql} $courseselect", array_merge($params, $courseparams)]; } /** * Return sample filter values * * @return array */ public function get_sample_values(): array { return [ "{$this->name}_values" => [1], ]; } } PK a<�\�9� � edit.phpnu �[��� <?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/>. /** * Edit a custom report * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); use core\output\dynamic_tabs; use core_reportbuilder\manager; use core_reportbuilder\permission; use core_reportbuilder\output\dynamictabs\access; use core_reportbuilder\output\dynamictabs\audience; use core_reportbuilder\output\dynamictabs\editor; use core_reportbuilder\output\dynamictabs\schedules; require_once(__DIR__ . '/../config.php'); require_once("{$CFG->libdir}/adminlib.php"); $reportid = required_param('id', PARAM_INT); admin_externalpage_setup('customreports', null, ['id' => $reportid], new moodle_url('/reportbuilder/edit.php')); navigation_node::override_active_url(new moodle_url('/reportbuilder/index.php')); $report = manager::get_report_from_id($reportid); permission::require_can_edit_report($report->get_report_persistent()); $PAGE->set_context($report->get_context()); $PAGE->navbar->add(get_string('editreportcontent', 'core_reportbuilder'), $PAGE->url); $PAGE->set_pagelayout('popup'); /** @var \core_reportbuilder\output\renderer $renderer */ $renderer = $PAGE->get_renderer('core_reportbuilder'); $reportname = $report->get_report_persistent()->get_formatted_name(); $PAGE->set_title($reportname); echo $OUTPUT->header(); echo $renderer->render_fullpage_editor_header($report->get_report_persistent()); // Add dynamic tabs. $tabdata = ['reportid' => $reportid]; $tabs = [ new editor($tabdata), new audience($tabdata), new schedules($tabdata), new access($tabdata), ]; echo $OUTPUT->render_from_template('core/dynamic_tabs', (new dynamic_tabs($tabs))->export_for_template($OUTPUT)); echo $OUTPUT->footer(); PK a<�\@��� � download.phpnu �[��� <?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/>. /** * Download a report * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); use core_reportbuilder\permission; use core_reportbuilder\system_report_factory; require_once(__DIR__ . '/../config.php'); require_login(); $reportid = required_param('id', PARAM_INT); $download = required_param('download', PARAM_ALPHA); $parameters = optional_param('parameters', null, PARAM_RAW); $reportpersistent = new \core_reportbuilder\local\models\report($reportid); $context = $reportpersistent->get_context(); $PAGE->set_context($context); $PAGE->set_url(new moodle_url('/reportbuilder/download.php')); if ($reportpersistent->get('type') === \core_reportbuilder\local\report\base::TYPE_SYSTEM_REPORT) { $parameters = (array) json_decode($parameters); // Re-create the exact report that is being downloaded. $systemreport = system_report_factory::create($reportpersistent->get('source'), $context, $reportpersistent->get('component'), $reportpersistent->get('area'), $reportpersistent->get('itemid'), $parameters); if (!$systemreport->can_be_downloaded()) { throw new \core_reportbuilder\exception\report_access_exception(); } // Combine original report parameters with 'download' parameter. $parameters['download'] = $download; $outputreport = new \core_reportbuilder\output\system_report($reportpersistent, $systemreport, $parameters); echo $PAGE->get_renderer('core_reportbuilder')->render($outputreport); } else { permission::require_can_view_report($reportpersistent); $customreport = new \core_reportbuilder\output\custom_report($reportpersistent, false, $download); echo $PAGE->get_renderer('core_reportbuilder')->render($customreport); } PK a<�\�;v�� � UPGRADING.mdnu �[��� # core_reportbuilder (subsystem) Upgrade notes ## 4.5.2 ### Added - The `core_reportbuilder_testcase` class has been moved to new autoloaded `core_reportbuilder\tests\core_reportbuilder_testcase` location, affected tests no longer have to manually require `/reportbuilder/tests/helpers.php` For more information see [MDL-84000](https://tracker.moodle.org/browse/MDL-84000) ## 4.5.1 ### Changed - The `get_active_conditions` method of the base report class has a new `$checkavailable` parameter to determine whether to check the returned conditions availability For more information see [MDL-82809](https://tracker.moodle.org/browse/MDL-82809) ## 4.5 ### Added - The return type of the `set_checkbox_toggleall` callback, defined by system reports, can now be null. Use if the checkbox should not be shown for the row. For more information see [MDL-52046](https://tracker.moodle.org/browse/MDL-52046) - System reports now support native entity column aggregation via each columns `set_aggregation()` method For more information see [MDL-76392](https://tracker.moodle.org/browse/MDL-76392) - The following external methods now return tags data relevant to each custom report: - `core_reportbuilder_list_reports` - `core_reportbuilder_retrieve_report` For more information see [MDL-81433](https://tracker.moodle.org/browse/MDL-81433) - Added a new database helper method `sql_replace_parameters` to help ensure uniqueness of parameters within a SQL expression. For more information see [MDL-81434](https://tracker.moodle.org/browse/MDL-81434) - A new static method, `\core_reportbuilder\local\helpers\format::format_time()`, has been added for use in column callbacks that represent a duration of time (for example "3 days 4 hours"). For more information see [MDL-82466](https://tracker.moodle.org/browse/MDL-82466) - The following methods have been moved from `\core_reportbuilder\datasource` class to its parent class `\core_reportbuilder\base` to make them available for use in system reports: - `add_columns_from_entity()` - `add_filters_from_entity()` - `report_element_search()` For more information see [MDL-82529](https://tracker.moodle.org/browse/MDL-82529) ### Changed - In order to better support float values in filter forms, the following filter types now cast given SQL prior to comparison: - `duration` - `filesize` - `number` For more information see [MDL-81168](https://tracker.moodle.org/browse/MDL-81168) - The base datasource `\core_reportbuilder\datasource::add_all_from_entities()` method accepts a new optional `array $entitynames` parameter to specify which entities to add elements from. For more information see [MDL-81330](https://tracker.moodle.org/browse/MDL-81330) - All time-related code has been updated to the PSR-20 Clock interface, as such the following methods no longer accept a `$timenow` parameter (instead please use `\core\clock` dependency injection): - `core_reportbuilder_generator::create_schedule` - `core_reportbuilder\local\helpers\schedule::create_schedule()` - `core_reportbuilder\local\helpers\schedule::calculate_next_send_time()` For more information see [MDL-82041](https://tracker.moodle.org/browse/MDL-82041) - The following classes have been moved to use the new exception API as a L2 namespace: | Old class | New class | | ----------- | ----------- | | `\core_reportbuilder\report_access_exception` | `\core_reportbuilder\exception\report_access_exception` | | `\core_reportbuilder\source_invalid_exception` | `\core_reportbuilder\exception\source_invalid_exception` | | `\core_reportbuilder\source_unavailable_exception` | `\core_reportbuilder\exception\source_unavailable_exception` | For more information see [MDL-82133](https://tracker.moodle.org/browse/MDL-82133) ### Removed - Support for the following entity classes, renamed since 4.1, have now been removed completely: - `\core_admin\local\entities\task_log` - `\core_cohort\local\entities\cohort` - `\core_cohort\local\entities\cohort_member` - `\core_course\local\entities\course_category` - `\report_configlog\local\entities\config_change` For more information see [MDL-74583](https://tracker.moodle.org/browse/MDL-74583) - The following previously deprecated local helper methods have been removed and can no longer be used: - `\core_reportbuilder\local\helpers\audience::get_all_audiences_menu_types()` - `\core_reportbuilder\local\helpers\report::get_available_columns()` For more information see [MDL-76690](https://tracker.moodle.org/browse/MDL-76690) PK a<�\2W� index.phpnu �[��� <?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/>. /** * List of custom reports * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); use core_reportbuilder\permission; use core_reportbuilder\system_report_factory; use core_reportbuilder\local\systemreports\reports_list; require_once(__DIR__ . '/../config.php'); require_once("{$CFG->libdir}/adminlib.php"); admin_externalpage_setup('customreports'); $PAGE->requires->js_call_amd('core_reportbuilder/reports_list', 'init'); echo $OUTPUT->header(); echo html_writer::start_div('d-flex justify-content-between mb-2'); echo $OUTPUT->heading(get_string('customreports', 'core_reportbuilder')); if (permission::can_create_report()) { /** @var \core_reportbuilder\output\renderer $renderer */ $renderer = $PAGE->get_renderer('core_reportbuilder'); echo $renderer->render_new_report_button(); } echo html_writer::end_div(); $report = system_report_factory::create(reports_list::class, context_system::instance()); echo $report->output(); echo $OUTPUT->footer(); PK a<�\�� �� � view.phpnu �[��� <?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/>. /** * View a custom report * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); use core_reportbuilder\event\report_viewed; use core_reportbuilder\manager; use core_reportbuilder\output\custom_report; use core_reportbuilder\permission; require_once(__DIR__ . '/../config.php'); require_once("{$CFG->libdir}/adminlib.php"); $reportid = required_param('id', PARAM_INT); admin_externalpage_setup('customreports', null, ['id' => $reportid], new moodle_url('/reportbuilder/view.php')); navigation_node::override_active_url(new moodle_url('/reportbuilder/index.php')); $report = manager::get_report_from_id($reportid); permission::require_can_view_report($report->get_report_persistent()); $PAGE->set_context($report->get_context()); $PAGE->navbar->add(get_string('viewreport', 'core_reportbuilder'), $PAGE->url); /** @var \core_reportbuilder\output\renderer $renderer */ $renderer = $PAGE->get_renderer('core_reportbuilder'); $reportname = $report->get_report_persistent()->get_formatted_name(); $PAGE->set_title($reportname); $PAGE->set_heading($reportname); echo $OUTPUT->header(); $export = (new custom_report($report->get_report_persistent(), false))->export_for_template($renderer); echo $renderer->render_from_template('core_reportbuilder/report', $export); echo $OUTPUT->footer(); // Trigger report viewed event. report_viewed::create_from_object($report->get_report_persistent())->trigger(); PK a<�\��;<| | templates/toggle_card.mustachenu �[��� {{! 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_reportbuilder/toggle_card Template for empty_message Example context (json): { "collapsed": "collapsed", "id": "htmlid", "header": "Toggle card heading", "buttontitle": "Expand toggle card", "body": "This is the toggle card content" } }} <div class="card reportbuilder-toggle-card mb-2"> <div class="card-header p-0"> <div class="d-flex align-items-center mb-0 p-1"> <div class="ms-3"> <span class="me-1">{{$header}}{{/header}}</span> {{$helpicon}}{{/helpicon}} </div> <button class="btn toggle-card-button ms-auto {{$collapsed}}{{/collapsed}}" data-toggle="collapse" data-target="#{{$id}}{{uniqid}}{{/id}}" aria-expanded="true" aria-controls="{{$id}}{{uniqid}}{{/id}}" title="{{#str}}showhide, core_reportbuilder, {{$header}}{{/header}}{{/str}}" > <span class="collapsed-icon-container"><i class="toggle-card-icon fa fa-lg fa-angle-down"></i></span> <span class="expanded-icon-container"><i class="toggle-card-icon fa fa-lg fa-angle-up"></i></span> </button> </div> </div> <div id="{{$id}}{{uniqid}}{{/id}}" class="collapse {{$collapsed}}show{{/collapsed}}"> <div class="card-body p-0"> {{$body}}{{/body}} </div> </div> </div> PK a<�\a��A� � templates/report.mustachenu �[��� {{! 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_reportbuilder/report Template for a report Example context (json): { "id": 1, "contextid": 1, "type": 1, "parameters": [], "attributes": [{ "name": "data-custom", "value": "1" }], "table": "table", "filterspresent": true, "filtersform": "form" } }} <div class="reportbuilder-report {{classes}}" id="reportbuilder-report-{{uniqid}}" data-region="core_reportbuilder/report" data-report-id="{{id}}" data-report-type="{{type}}" data-report-parameters="{{parameters}}" {{#attributes}}{{name}}="{{value}}" {{/attributes}}> <div class="reportbuilder-wrapper"> {{#filterspresent}} <div class="dropdown d-flex justify-content-end"> {{>core_reportbuilder/local/filters/area}} </div> {{/filterspresent}} {{! Table }} <div class="mt-2"> {{{table}}} </div> </div> </div> {{#js}} require(['core_reportbuilder/report'], function(report) { report.init(); }); {{/js}} PK a<�\ �Ed� � templates/editor_navbar.mustachenu �[��� {{! 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_reportbuilder/editor_navbar This template renders the reportbuilder editor navbar Example context (json): { "title": "Report title", "buttons": "<button class='btn btn-secondary me-2'>Close</button>" } }} <nav class="navbar fixed-top navbar-light bg-white navbar-expand align-items-center" aria-label="{{#str}}sitemenubar, admin{{/str}}"> <div class="container-fluid"> <h1 class="h3 m-0 p-0">{{{title}}}</h1> <div class="ms-auto d-flex"> {{{buttons}}} </div> </div> </nav> PK a<�\Tz� � & templates/local/audience/form.mustachenu �[��� {{! 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_reportbuilder/local/audience/form Template for an audience form Example context (json): { "instanceid": 1, "classname": "some\\class\\name", "heading": "Title", "headingeditable": "Title (edit me)", "showormessage": 1, "editwarning": "Oh dear", "canedit": 1, "candelete": 1, "description": "description", "form": "form" } }} <div data-region="audience-card" class="instance-card" data-audience-id="{{instanceid}}" data-audience-title="{{heading}}" {{#editwarning}} data-audience-edit-warning="1" {{/editwarning}} > {{#showormessage}} <span class="audience-separator d-flex mb-3 justify-content-center align-items-center small text-muted font-weight-bold"> {{#str}} or, core_reportbuilder {{/str}} </span> {{/showormessage}} <div class="mb-3 card"> <div class="card-header p-0"> <div class="mb-0 d-flex"> <h3 class="h6 text-start m-0 align-self-center ps-3" data-region="audience-heading"> {{{headingeditable}}} </h3> <span class="ms-auto"> {{#canedit}} <button class="btn btn-link px-0" data-action="edit-audience" title="{{#str}} editaudience, core_reportbuilder, {{heading}} {{/str}}" aria-label="{{#str}} editaudience, core_reportbuilder, {{heading}} {{/str}}" {{^description}}disabled{{/description}}> {{#pix}} i/settings, core {{/pix}} </button> {{/canedit}} {{#candelete}} <button class="btn btn-link px-0 me-2" data-action="delete-audience" title="{{#str}} deleteaudience, core_reportbuilder, {{heading}} {{/str}}" aria-label="{{#str}} deleteaudience, core_reportbuilder, {{heading}} {{/str}}" {{^description}}disabled{{/description}}> {{#pix}} i/trash, core {{/pix}} </button> {{/candelete}} </span> </div> </div> <div class="card-body p-3" data-region="audience-form"> {{#editwarning}}<div class="alert alert-warning p-2">{{.}}</div>{{/editwarning}} <div data-region="audience-description" {{^description}}class="hidden"{{/description}}> {{{description}}} </div> <div data-region="audience-form-container" {{^form}}class="hidden"{{/form}}> <div class="alert alert-warning p-2" data-region="audience-not-saved">{{#str}} audiencenotsaved, core_reportbuilder {{/str}}</div> {{{form}}} </div> </div> </div> </div> PK a<�\�0̔D D % templates/local/report/debug.mustachenu �[��� {{! 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_reportbuilder/local/report/debug Template for custom report debug Example context (json): { "query": "SELECT foo FROM {bar} WHERE baz = :rbparam1", "params": [ { "param": "rbparam1", "value": 42 } ], "duration": "0.124 secs" } }} <details> <summary>{{#str}} debuginfo, core_debug {{/str}}</summary> <code class="d-block mb-2">{{query}}</code> {{#params}} <code class="d-block mb-2">{{param}} => {{value}}</code> {{/params}} {{#duration}}<code class="d-block">{{.}}</code>{{/duration}} </details> PK a<�\��� , templates/local/settings/conditions.mustachenu �[��� {{! 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_reportbuilder/local/settings/conditions Template for custom report conditions settings area Example context (json): { "conditions": [{ "hasavailableconditions": true, "availableconditions": [{ "optiongroup": [{ "text": "User", "values": [{ "value": 1, "visiblename": "User name" }] }] }], "hasactiveconditions": true, "activeconditionsform": "form" }] } }} <div class="p-2" data-region="settings-conditions"> {{#conditions}} {{#hasavailableconditions}} <div class="reportbuilder-conditions-select"> <label for="addconditionselect" class="sr-only">{{#str}} selectacondition, core_reportbuilder {{/str}}</label> <select id="addconditionselect" data-action="report-add-condition" class="w-100 custom-select"> <option value="0"></option> {{#availableconditions}} {{#optiongroup}} <option disabled class="suggestions-heading">{{text}}</option> {{#values}} <option value="{{value}}">{{visiblename}}</option> {{/values}} {{/optiongroup}} {{/availableconditions}} </select> </div> {{/hasavailableconditions}} <div class="reportbuilder-conditions-list" data-region="conditions-form"> {{#hasactiveconditions}} {{{activeconditionsform}}} {{/hasactiveconditions}} {{^hasactiveconditions}} {{< core_reportbuilder/local/settings/empty_message }} {{$nothingtoshow}} {{#str}} noconditions, core_reportbuilder {{/str}} {{/nothingtoshow}} {{/ core_reportbuilder/local/settings/empty_message }} {{/hasactiveconditions}} </div> {{/conditions}} </div> PK a<�\�nĿ � ) templates/local/settings/filters.mustachenu �[��� {{! 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_reportbuilder/local/settings/filters Template for custom report filters settings area Example context (json): { "filters": [{ "hasavailablefilters": true, "availablefilters": [{ "optiongroup": [{ "text": "User", "values": [{ "value": 1, "visiblename": "User name" }] }] }], "hasactivefilters": true, "activefilters": [{ "heading": "Email address", "entityname": "user", "headingeditable": "Email address" }] }] } }} <div class="p-2" data-region="settings-filters"> {{#filters}} {{#hasavailablefilters}} <div class="reportbuilder-filters-select"> <label for="addfilterselect" class="sr-only">{{#str}}selectafilter, core_reportbuilder{{/str}}</label> <select id="addfilterselect" name="addfilterselect" data-action="report-add-filter" class="w-100 custom-select"> <option value="0"></option> {{#availablefilters}} {{#optiongroup}} <option disabled class="suggestions-heading">{{text}}</option> {{#values}} <option value="{{value}}">{{visiblename}}</option> {{/values}} {{/optiongroup}} {{/availablefilters}} </select> </div> {{/hasavailablefilters}} <div data-region="active-filters" class="form-vertical"> {{#hasactivefilters}} <ul class="list-group reportbuilder-sortable-list mt-2 ms-0"> {{#activefilters}} <li class="list-group-item list-group-item-action d-flex align-items-start text-dark" data-region="active-filter" data-filter-id="{{id}}" data-filter-name="{{heading}}" data-filter-position="{{sortorder}}"> {{>core/drag_handle}} <div> <div class="d-flex"> <small class="text-muted text-uppercase">{{entityname}} • {{heading}}</small> </div> <div> {{{headingeditable}}} </div> </div> <button class="btn btn-link p-0 ms-auto" type="button" data-action="report-remove-filter" title="{{#str}}deletefilter, core_reportbuilder, {{{heading}}}{{/str}}" aria-label="{{#str}}deletefilter, core_reportbuilder, {{{heading}}}{{/str}}"> {{#pix}}e/cancel, core{{/pix}} </button> </li> {{/activefilters}} </ul> {{/hasactivefilters}} {{^hasactivefilters}} {{< core_reportbuilder/local/settings/empty_message }} {{$nothingtoshow}} {{#str}} nofilters, core_reportbuilder {{/str}} {{/nothingtoshow}} {{/ core_reportbuilder/local/settings/empty_message }} {{/hasactivefilters}} </div> {{/filters}} </div> PK a<�\��>� ) templates/local/settings/sorting.mustachenu �[��� {{! 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_reportbuilder/local/settings/sorting Template for custom report sortable columns settings area Example context (json): { "sorting": [{ "hassortablecolumns": true, "sortablecolumns": [{ "id": 1, "title": "Email address", "sortdirection": "4", "sortenabled": true, "sortenabledtitle": "Disable initial sorting for column 'Email address'", "sortorder": 1, "sorticon": [{ "key": "t/sort_asc", "component": "moodle", "title": "Change initial sorting for column 'Email address' to descending" }], "movetitle": "Move sorting for column 'Email address'", "heading": "Email address" }] }] } }} <div class="p-2" data-region="settings-sorting"> {{#sorting}} {{#hassortablecolumns}} <ul class="list-group reportbuilder-sortable-list ms-0"> {{#sortablecolumns}} <li class="list-group-item list-group-item-action d-flex align-items-center text-dark" data-column-sort-id="{{id}}" data-column-sort-name="{{title}}" data-column-sort-direction="{{sortdirection}}" data-column-sort-position="{{sortorder}}"> {{>core/drag_handle}} {{#sorticon}} <span class="float-end"> <button id="toggle-sort-direction-{{id}}" class="btn btn-link p-0" data-action="report-toggle-sort-direction" title="{{{title}}}" aria-label="{{{title}}}" {{^sortenabled}}disabled{{/sortenabled}}> {{#sorticon}}{{#pix}}{{key}}, {{component}}{{/pix}}{{/sorticon}} </button> </span> {{/sorticon}} <input id="toggle-sort-{{id}}" title="{{{sortenabledtitle}}}" data-action="report-toggle-column-sorting" type="checkbox" {{#sortenabled}}checked{{/sortenabled}}> <label for="toggle-sort-{{id}}" class="mb-0"> <span class="ms-2 text-dark {{^sortenabled}}text-muted{{/sortenabled}}">{{{heading}}}</span> <span class="sr-only">{{{sortenabledtitle}}}</span> </label> </li> {{/sortablecolumns}} </ul> {{/hassortablecolumns}} {{^hassortablecolumns}} {{< core_reportbuilder/local/settings/empty_message }} {{$nothingtoshow}}{{#str}} nosortablecolumns, core_reportbuilder {{/str}} {{/nothingtoshow}} {{/ core_reportbuilder/local/settings/empty_message }} {{/hassortablecolumns}} {{/sorting}} </div> PK a<�\Z8�KY Y / templates/local/settings/empty_message.mustachenu �[��� {{! 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_reportbuilder/local/settings/empty_message Template for empty_message Example context (json): { "nothingtoshow": "Nothing to show" } }} <div class="d-flex justify-content-center"> <div class="text-xs-center text-center mt-3" data-region="empty-message"> <p class="text-muted mt-3">{{$nothingtoshow}}{{nothingtoshow}}{{/nothingtoshow}}</p> </div> </div> PK a<�\ �-'� � + templates/local/settings/card_view.mustachenu �[��� {{! 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_reportbuilder/local/settings/card_view Template for custom report card view settings area Example context (json): { "cardview": { "form": "form" } } }} <div class="px-4 pt-4 pb-0" data-region="settings-cardview"> {{#cardview}} {{{form}}} {{/cardview}} </div> PK a<�\�b�97 7 & templates/local/settings/area.mustachenu �[��� {{! 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_reportbuilder/local/settings/area Template for system report filters area Example context (json): { "conditions": [{ "hasavailableconditions": true, "availableconditions": [{ "optiongroup": [{ "text": "User", "values": [{ "value": 1, "visiblename": "User name" }] }] }], "hasactiveconditions": true, "activeconditionsform": "form" }], "filters": [{ "hasavailablefilters": true, "availablefilters": [{ "optiongroup": [{ "text": "User", "values": [{ "value": 1, "visiblename": "User name" }] }] }], "hasactivefilters": true, "activefilters": [{ "heading": "Email address", "entityname": "user", "headingeditable": "Email address" }] }], "sorting": [{ "hassortablecolumns": true, "sortablecolumns": [{ "id": 1, "title": "Email address", "sortdirection": "4", "sortenabled": true, "sortenabledtitle": "Disable initial sorting for column 'Email address'", "sortorder": 1, "sorticon": [{ "key": "t/sort_asc", "component": "moodle", "title": "Change initial sorting for column 'Email address' to descending" }], "movetitle": "Move sorting for column 'Email address'", "heading": "Email address" }] }], "cardview": { "form": "form" } } }} <div class="reportbuilder-sidebar-settings d-flex flex-column mt-3 mt-lg-0 mb-3 mb-lg-0 ms-lg-3"> {{< core_reportbuilder/toggle_card }} {{$collapsed}}collapsed{{/collapsed}} {{$id}}settingsconditions{{/id}} {{$header}}{{#str}} conditions, core_reportbuilder {{/str}}{{/header}} {{$helpicon}}{{{conditions.helpicon}}}{{/helpicon}} {{$body}} {{> core_reportbuilder/local/settings/conditions}} {{/body}} {{/ core_reportbuilder/toggle_card }} {{< core_reportbuilder/toggle_card }} {{$collapsed}}collapsed{{/collapsed}} {{$id}}settingsfilters{{/id}} {{$header}}{{#str}} filters, core_reportbuilder {{/str}}{{/header}} {{$helpicon}}{{{filters.helpicon}}}{{/helpicon}} {{$body}} {{> core_reportbuilder/local/settings/filters}} {{/body}} {{/ core_reportbuilder/toggle_card }} {{< core_reportbuilder/toggle_card }} {{$collapsed}}collapsed{{/collapsed}} {{$id}}settingssorting{{/id}} {{$header}}{{#str}} sorting, core_reportbuilder {{/str}}{{/header}} {{$helpicon}}{{{sorting.helpicon}}}{{/helpicon}} {{$body}} {{> core_reportbuilder/local/settings/sorting}} {{/body}} {{/ core_reportbuilder/toggle_card }} {{< core_reportbuilder/toggle_card }} {{$collapsed}}collapsed{{/collapsed}} {{$id}}settingscardview{{/id}} {{$header}}{{#str}} cardview, core_reportbuilder {{/str}}{{/header}} {{$helpicon}}{{{cardview.helpicon}}}{{/helpicon}} {{$body}} {{> core_reportbuilder/local/settings/card_view}} {{/body}} {{/ core_reportbuilder/toggle_card }} </div> PK a<�\�X��� � * templates/local/sidebar-menu/card.mustachenu �[��� {{! 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_reportbuilder/local/sidebar-menu/card Template for showing a single report sidebar menu card. Example context (json): { "name": "General", "key": "general", "items": [{ "name": "Manually added users", "identifier": "core_reportbuilder:users" }] } }} <div data-region="sidebar-card"> {{< core_reportbuilder/toggle_card }} {{$id}}card_{{key}}{{/id}} {{$header}}{{name}}{{/header}} {{$body}} <div class="list-group list-group-flush"> {{#items}} {{> core_reportbuilder/local/sidebar-menu/card_item}} {{/items}} </div> {{/body}} {{/ core_reportbuilder/toggle_card }} </div> PK a<�\C�V / templates/local/sidebar-menu/card_item.mustachenu �[��� {{! 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_reportbuilder/local/sidebar-menu/card_item Template for showing a single element in a sidebar menu card. Example context (json): { "name": "Manually added users", "identifier": "tool_reportbuilder:users" } }} {{^disabled}} <a href="#" title="{{title}}" role="button" class="list-group-item list-group-item-action pe-2 bg-transparent" data-region="sidebar-item" data-action="{{action}}" data-unique-identifier="{{identifier}}" data-name="{{name}}" > <span class="d-flex align-items-center justify-content-between"> {{{name}}} {{#pix}} t/add, core {{/pix}} </span> </a> {{/disabled}} {{#disabled}} <div title="{{#str}} notavailable, core {{/str}}" class="list-group-item list-group-item-action pe-2 bg-transparent text-muted" data-region="sidebar-item" > <span class="d-flex align-items-center justify-content-between"> {{{name}}} {{#pix}} i/info, core {{/pix}} </span> </div> {{/disabled}} PK a<�\VM��; ; * templates/local/sidebar-menu/area.mustachenu �[��� {{! 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_reportbuilder/local/sidebar-menu/area Template for showing report sidebar menu. Example context (json): { "sidebarmenucards": [{ "menucards": [{ "name": "General", "items": [{ "name": "Manually added users", "identifier": "core_reportbuilder:users" }] }] }] } }} <div id="region-sidebar-menu-{{uniqid}}" class="reportbuilder-sidebar-menu d-flex flex-column me-lg-3 mb-3 mb-lg-0" data-region="sidebar-menu"> <div class="input-group mb-3"> <label for="reportbuilder-sidebar-search"> <span class="sr-only">{{#str}} search, core_search {{/str}}</span> </label> <input id="reportbuilder-sidebar-search" type="text" class="form-control rounded-start border-end-0" placeholder="{{#str}} search, core_search {{/str}}" aria-label="{{#str}} search, core_search {{/str}}" data-action="sidebar-search"> <div class="input-group-append"> <span class="input-group-text ps-2 pe-0 bg-white"> {{#pix}} a/search, core {{/pix}} </span> </div> </div> <div class="reportbuilder-sidebar-menu-cards"> {{#sidebarmenucards}} {{#menucards}} {{> core_reportbuilder/local/sidebar-menu/card}} {{/menucards}} {{/sidebarmenucards}} </div> </div> {{#js}} require(['core_reportbuilder/sidebar'], function(sidebar) { sidebar.init('#region-sidebar-menu-{{uniqid}}'); }); {{/js}} PK a<�\|��k, , * templates/local/conditions/header.mustachenu �[��� {{! 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_reportbuilder/local/conditions/header Template for the header of a condition instance within the condition form Example context (json): { "id": 1, "heading": "Date modified", "entityname": "Course" } }} <div class="condition list-group-item list-group-item-action text-dark" data-region="active-condition" data-condition-id="{{id}}" data-condition-name="{{heading}}" data-condition-position="{{sortorder}}"> <div class="condition-header d-flex align-items-start"> {{>core/drag_handle}} <div> <div class="d-flex"> <small class="text-muted text-uppercase">{{entityname}} • {{heading}}</small> </div> </div> <button class="btn btn-link p-0 ms-auto" type="button" data-action="report-remove-condition" title="{{#str}}deletecondition, core_reportbuilder, {{{heading}}}{{/str}}" aria-label="{{#str}}deletecondition, core_reportbuilder, {{{heading}}}{{/str}}"> {{#pix}}e/cancel, core{{/pix}} </button> </div> PK a<�\� Up p * templates/local/conditions/footer.mustachenu �[��� {{! 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_reportbuilder/local/conditions/footer Template for the footer of a filter instance within the filter form Example context (json): { } }} </div> PK a<�\g��r r ' templates/local/filters/header.mustachenu �[��� {{! 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_reportbuilder/local/filters/header Template for the header of a filter instance within the filter form Example context (json): { "name": "Date modified" } }} <div class="filter pb-3 mb-3" data-filter-for="{{name}}"> <div class="filter-header d-flex align-items-start justify-content-between"> <div class="filter-name text-truncate"> {{{name}}} </div> </div> PK a<�\5nk]m m ' templates/local/filters/footer.mustachenu �[��� {{! 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_reportbuilder/local/filters/footer Template for the footer of a filter instance within the filter form Example context (json): { } }} </div> PK a<�\U�S�U U % templates/local/filters/area.mustachenu �[��� {{! 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_reportbuilder/local/filters/area Template for system report filters area Example context (json): { "contextid": 1, "filtersapplied": 3, "filtersform": "form" } }} {{! Filters button }} <button class="btn btn-outline-secondary ms-2" type="button" id="dropdownFiltersButton" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" title="{{#str}} filters, moodle {{/str}}"> {{#pix}} i/filter, core {{/pix}} <span data-region="filter-button-label"> {{#filtersapplied}} {{#str}} filtersappliedx, core_reportbuilder, {{filtersapplied}} {{/str}} {{/filtersapplied}} {{^filtersapplied}} {{#str}} filters, moodle {{/str}} {{/filtersapplied}} </span> </button> {{! Filters content }} <div class="filters-dropdown dropdown-menu dropdown-menu-right moodle-has-zindex" aria-labelledby="dropdownFiltersButton"> <div id="filters" class="reportbuilder-filters-sidebar scroll-shadow" data-region="report-filters"> <div class="px-3 pt-3"> {{#filtersform}} <div class="reportbuilder-filters-wrapper" data-region="filters-form"> {{{filtersform}}} </div> {{/filtersform}} </div> </div> </div> {{#js}} require(['core_reportbuilder/filters'], function(filters) { filters.init('reportbuilder-report-{{uniqid}}', {{contextid}}); }); {{/js}} PK a<�\ߵ� � + templates/local/dynamictabs/access.mustachenu �[��� {{! 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_reportbuilder/local/dynamictabs/access Template for Access report Example context (json): { "report": "The report content" } }} <h2 class="sr-only">{{#str}} access, core_reportbuilder {{/str}}</h2> <div class="reportbuilder-access-container"> {{{ report }}} </div> PK a<�\��r r - templates/local/dynamictabs/audience.mustachenu �[��� {{! 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_reportbuilder/local/dynamictabs/audience Template for report audience Example context (json): { "reportid": 1, "contextid": 1, "hasinstances": 1, "instances": [{ "instanceid": 1, "heading": "Title", "headingeditable": "Title (edit me)", "showormessage": 1, "canedit": 1, "candelete": 1, "description": "description", "form": "form" }], "sidebarmenucards": [{ "menucards": [{ "name": "General", "items": [{ "name": "Manually added users", "identifier": "core_reportbuilder:users" }] }] }] } }} <h2 class="sr-only">{{#str}} audience, core_reportbuilder {{/str}}</h2> <div class="audiences-wrapper d-flex flex-column flex-lg-row"> <div id="audiences-menu"> {{! Sidebar }} {{> core_reportbuilder/local/sidebar-menu/area}} </div> <div id="audiences-container" class="reportbuilder-audiences-container d-flex flex-column flex-fill" data-region="audiences"> {{! No audience container }} <div class="justify-content-center {{#hasinstances}}hidden{{/hasinstances}}" data-region="no-instances-message"> <div class="alert alert-info mb-0">{{#str}} noaudiences, core_reportbuilder {{/str}}</div> </div> {{#instances}} {{> core_reportbuilder/local/audience/form}} {{/instances}} </div> </div> {{#js}} require(['core_reportbuilder/audience'], function(audience) { audience.init({{reportid}}, {{contextid}}); }); {{/js}} PK a<�\��� . templates/local/dynamictabs/schedules.mustachenu �[��� {{! 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_reportbuilder/local/dynamictabs/schedules Template for Schedules tab Example context (json): { "report": "The report content", "reportid": 10 } }} <div class="reportbuilder-schedules-container"> <div class="d-flex mb-2"> <button class="btn btn-primary ms-auto" data-action="schedule-create">{{#str}} newschedule, core_reportbuilder {{/str}}</button> </div> {{{ report }}} </div> {{#js}} require(['core_reportbuilder/schedules'], function(schedules) { schedules.init({{reportid}}); }); {{/js}} PK a<�\���k k + templates/local/dynamictabs/editor.mustachenu �[��� {{! 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_reportbuilder/local/dynamictabs/editor Template for the custom report editor Example context (json): { "id": 1, "type": 1, "table": "table", "editmode": true, "attributes": [{ "name": "data-custom", "value": "1" }], "sidebarmenucards": [{ "menucards": [{ "name": "General", "items": [{ "name": "Manually added users", "identifier": "core_reportbuilder:users" }] }] }], "conditions": [{ "hasavailableconditions": true, "availableconditions": [{ "optiongroup": [{ "text": "User", "values": [{ "value": 1, "visiblename": "User name" }] }] }], "hasactiveconditions": true, "activeconditionsform": "form" }], "filters": [{ "hasavailablefilters": true, "availablefilters": [{ "optiongroup": [{ "text": "User", "values": [{ "value": 1, "visiblename": "User name" }] }] }], "hasactivefilters": true, "activefilters": [{ "heading": "Email address", "entityname": "user", "headingeditable": "Email address" }] }], "sorting": [{ "hassortablecolumns": true, "sortablecolumns": [{ "id": 1, "title": "Email address", "sortdirection": "4", "sortenabled": true, "sortenabledtitle": "Disable initial sorting for column 'Email address'", "sortorder": 1, "sorticon": [{ "key": "t/sort_asc", "component": "moodle", "title": "Change initial sorting for column 'Email address' to descending" }], "movetitle": "Move sorting for column 'Email address'", "heading": "Email address" }] }], "cardview": { "form": "form" } } }} <h2 class="sr-only">{{#str}} editor, core_reportbuilder {{/str}}</h2> <div class="reportbuilder-report" id="reportbuilder-report-{{uniqid}}" data-region="core_reportbuilder/report" data-report-id="{{id}}" data-report-type="{{type}}" data-report-parameters="" {{#editmode}}data-editing{{/editmode}} {{#attributes}}{{name}}="{{value}}" {{/attributes}}> <div class="reportbuilder-wrapper d-flex flex-column flex-lg-row"> {{#editmode}} {{! Menu sidebar }} {{> core_reportbuilder/local/sidebar-menu/area}} {{/editmode}} {{! Report }} <div class="reportbuilder-report-container"> <div class="{{#editmode}}p-2 border{{/editmode}}"> <div data-region="core_reportbuilder/report-header" class="dropdown d-flex justify-content-end"> {{! Preview/Edit button }} <button data-action="toggle-edit-preview" class="btn btn-outline-secondary" {{#editmode}} data-edit-mode="1" title="{{#str}} switchpreview, core_reportbuilder {{/str}}" {{/editmode}} {{^editmode}} data-edit-mode="0" title="{{#str}} switchedit, core_reportbuilder {{/str}}" {{/editmode}} > {{#editmode}} {{#pix}} i/preview, core {{/pix}} {{#str}} preview, core {{/str}} {{/editmode}} {{^editmode}} {{#pix}} t/editstring, core {{/pix}} {{#str}} edit, core {{/str}} {{/editmode}} </button> {{^editmode}} {{! Filters }} {{#filterspresent}} {{>core_reportbuilder/local/filters/area}} {{/filterspresent}} {{/editmode}} </div> <div class="reportbuilder-editor-table-container mt-2"> {{! Table }} {{{table}}} </div> </div> </div> {{#editmode}} {{! Settings sidebar }} {{> core_reportbuilder/local/settings/area}} {{/editmode}} </div> </div> {{#js}} require(['core_reportbuilder/editor', 'core_reportbuilder/report'], function(editor, report) { editor.init(); report.init(); }); {{/js}} PK a<�\�P }� � $ templates/table_header_cell.mustachenu �[��� {{! 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_reportbuilder/table_header_cell This template renders the header of the columns Example context (json): { "entityname": "Stuff", "name": "Demo", "headingeditable": "Demo", "movetitle": "Move column 'Demo'" } }} <div class="d-flex justify-content-start"> <div class="me-2"> {{>core/drag_handle}} </div> <div class="w-100"> <div class="d-flex justify-content-between mb-2"> <small class="text-muted text-nowrap text-uppercase">{{entityname}} • {{name}}</small> <span class="text-nowrap"> <button class="btn btn-link p-0" data-action="report-remove-column" type="button" title="{{#str}}deletecolumn, core_reportbuilder, {{{name}}}{{/str}}" aria-label="{{#str}}deletecolumn, core_reportbuilder, {{{name}}}{{/str}}"> {{#pix}}e/cancel, core{{/pix}} </button> </span> </div> <h3 class="h5 text-nowrap">{{{headingeditable}}}</h3> <small class="text-muted text-nowrap">{{{aggregationeditable}}}</small> </div> </div> PK a<�\m��MZ! Z! + tests/behat/columnaggregationeditor.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom report columns aggregation In order to manage the aggregation for columns of custom reports As an admin I need to select an aggregation for columns Background: Given the following "users" exist: | username | firstname | lastname | email | confirmed | lastaccess | | user01 | Bill | Richie | user01@example.com | 1 | ##2 days ago## | | user02 | Ben | Richie | user02@example.com | 1 | ##3 days ago## | | user03 | Bill | Richie | user03@example.com | 0 | ##3 days ago## | Scenario Outline: Aggregate a text column Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:lastname | | My report | user:firstname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I set the "First name" column aggregation to "<aggregation>" Then I should see "Aggregated column 'First name'" And I should see "<output>" in the "Richie" "table_row" Examples: | aggregation | output | | Comma separated distinct values | Ben, Bill | | Comma separated values | Ben, Bill, Bill | | Count | 3 | | Count distinct | 2 | Scenario Outline: Aggregate a text column containing multiple fields Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:lastname | | My report | user:fullname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I set the "Full name" column aggregation to "<aggregation>" Then I should see "Aggregated column 'Full name'" And I should see "<output>" in the "Richie" "table_row" Examples: | aggregation | output | | Comma separated distinct values | Ben Richie, Bill Richie | | Comma separated values | Ben Richie, Bill Richie, Bill Richie | | Count | 3 | | Count distinct | 2 | Scenario Outline: Aggregate a time column Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:lastname | | My report | user:lastaccess | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I set the "Last access" column aggregation to "<aggregation>" Then I should see "Aggregated column 'Last access'" And I should see "<output>" in the "Richie" "table_row" Examples: | aggregation | output | | Count | 3 | | Count distinct | 2 | | Maximum | ##2 days ago##%A, %d %B %Y## | | Minimum | ##3 days ago##%A, %d %B %Y## | Scenario Outline: Aggregate a boolean column Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:lastname | | My report | user:confirmed | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I set the "Confirmed" column aggregation to "<aggregation>" Then I should see "Aggregated column 'Confirmed'" And I should see "<output>" in the "Richie" "table_row" Examples: | aggregation | output | | Comma separated distinct values | No, Yes | | Comma separated values | No, Yes, Yes | | Count | 3 | | Count distinct | 2 | | Maximum | Yes | | Minimum | No | | Average | 0.7 | | Percentage | 66.7% | | Sum | 2 | Scenario Outline: Aggregated columns display localised floats Given the following "language customisations" exist: | component | stringid | value | | core_langconfig | decsep | , | And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:lastname | | My report | user:confirmed | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I set the "Confirmed" column aggregation to "<aggregation>" Then I should see "Aggregated column 'Confirmed'" And I should see "<output>" in the "Richie" "table_row" Examples: | aggregation | output | | Average | 0,7 | | Percentage | 66,7% | Scenario Outline: Aggregated columns display localised list separators Given the following "language customisations" exist: | component | stringid | value | | core_langconfig | listsep | ; | And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:lastname | | My report | user:firstname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I set the "First name" column aggregation to "<aggregation>" Then I should see "Aggregated column 'First name'" And I should see "<output>" in the "Richie" "table_row" Examples: | aggregation | output | | Comma separated distinct values | Ben; Bill | | Comma separated values | Ben; Bill; Bill | Scenario: Show unique report rows Given the following "core_reportbuilder > Reports" exist: | name | source | default | uniquerows | | My report | core_user\reportbuilder\datasource\users | 0 | 1 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:firstname | | My report | user:lastname | When I am on the "My report" "reportbuilder > Editor" page logged in as "admin" Then the following should exist in the "reportbuilder-table" table: | -1- | -2- | | Admin | User | | Ben | Richie | | Bill | Richie | # Assert there is no 4th row (duplicate Bill Richie) because we're showing unique rows. And "//table[@data-region='reportbuilder-table']/tbody/tr[not(@class = 'emptyrow')][4]" "xpath_element" should not exist And I set the "First name" column aggregation to "Comma separated values" And the following should exist in the "reportbuilder-table" table: | -1- | -2- | | Admin | User | | Ben, Bill, Bill | Richie | PK a<�\�ڟ�} } # tests/behat/behat_reportbuilder.phpnu �[��� <?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); // NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php. require_once(__DIR__ . '/../../../lib/behat/behat_base.php'); use core_reportbuilder\local\aggregation\groupconcatdistinct; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\column; /** * Behat step definitions for Report builder * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_reportbuilder extends behat_base { /** * Convert page names to URLs for steps like 'When I am on the "[identifier]" "[page type]" page'. * * Recognised page names are: * | type | identifier | description | * | Editor | Report name | Custom report editor | * | View | Report name | Custom report view | * * @param string $type * @param string $identifier * @return moodle_url * @throws Exception for unrecognised report or page type */ protected function resolve_page_instance_url(string $type, string $identifier): moodle_url { if (!$report = report::get_record(['name' => $identifier])) { throw new Exception("Unknown report '{$identifier}'"); } switch ($type) { case 'Editor': return new moodle_url('/reportbuilder/edit.php', ['id' => $report->get('id')]); case 'View': return new moodle_url('/reportbuilder/view.php', ['id' => $report->get('id')]); default: throw new Exception("Unrecognised reportbuilder page type '{$type}'"); } } /** * Return the list of partial named selectors * * @return behat_component_named_selector[] */ public static function get_partial_named_selectors(): array { return [ new behat_component_named_selector('Filter', [ ".//*[@data-region='filters-form']//*[@data-filter-for=%locator%]", ]), new behat_component_named_selector('Condition', [ ".//*[@data-region='conditions-form']//*[@data-condition-name=%locator%]", ]), new behat_component_named_selector('Audience', [ ".//*[@data-region='audiences']//*[@data-audience-title=%locator%]", ]), ]; } /** * Set aggregation for given column in report editor (proxied so we can skip if aggregation type not available) * * @When I set the :column column aggregation to :aggregation * * @param string $column * @param string $aggregation * * @throws \Moodle\BehatExtension\Exception\SkippedException */ public function i_set_the_column_aggregation_to(string $column, string $aggregation): void { // Skip if aggregation type unavailable. $aggregationgroupconcatdistinct = (string) groupconcatdistinct::get_name(); if ($aggregation === $aggregationgroupconcatdistinct && !groupconcatdistinct::compatible(column::TYPE_TEXT)) { throw new \Moodle\BehatExtension\Exception\SkippedException("{$aggregationgroupconcatdistinct} not available"); } $editlabel = get_string('aggregatecolumn', 'core_reportbuilder', $column); $this->execute('behat_forms::i_set_the_field_to', [$this->escape($editlabel), $this->escape($aggregation)]); } /** * Press a given action from the action menu in a given report row * * @When I press :action action in the :row report row * * @param string $action * @param string $row */ public function i_press_action_in_the_report_row(string $action, string $row): void { $this->execute('behat_action_menu::i_choose_in_the_named_menu_in_container', [ $this->escape($action), get_string('actions', 'core_reportbuilder'), $this->escape($row), 'table_row', ]); } } PK a<�\���h�N �N ! tests/behat/customreports.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom reports In order to manage custom reports As an admin I need to create new and edit existing reports Scenario: Create custom report with default setup Given the following "users" exist: | username | firstname | lastname | suspended | | user1 | User | 1 | 1 | | user2 | User | 2 | 0 | And I log in as "admin" And I change window size to "large" When I navigate to "Reports > Report builder > Custom reports" in site administration And I click on "New report" "button" And I set the following fields in the "New report" "dialogue" to these values: | Name | My report | | Report source | Users | | Include default setup | 1 | And I click on "Save" "button" in the "New report" "dialogue" Then I should see "My report" # Confirm we see the default columns in the report. And I should see "Full name" in the "Users" "table" And I should see "Username" in the "Users" "table" And I should see "Email address" in the "Users" "table" # Confirm we see the default sorting in the report And "Admin User" "table_row" should appear before "User 2" "table_row" And I click on "Show/hide 'Sorting'" "button" And "Disable initial sorting for column 'Full name'" "checkbox" should exist in the "#settingssorting" "css_element" And I click on "Show/hide 'Sorting'" "button" # Confirm we only see not suspended users in the report. And I should see "Admin User" in the "Users" "table" And I should see "User 2" in the "Users" "table" And I should not see "User 1" in the "Users" "table" # Confirm we see the default conditions in the report. And I click on "Show/hide 'Conditions'" "button" Then I should see "Full name" in the "[data-region='settings-conditions']" "css_element" Then I should see "Username" in the "[data-region='settings-conditions']" "css_element" Then I should see "Email address" in the "[data-region='settings-conditions']" "css_element" Then I should see "Suspended" in the "[data-region='settings-conditions']" "css_element" And the following fields in the "Suspended" "core_reportbuilder > Condition" match these values: | Suspended operator | No | # Confirm we see the default filters in the report. And I click on "Switch to preview mode" "button" And I click on "Filters" "button" in the "[data-region='core_reportbuilder/report-header']" "css_element" Then I should see "Full name" in the "[data-region='report-filters']" "css_element" Then I should see "Username" in the "[data-region='report-filters']" "css_element" Then I should see "Email address" in the "[data-region='report-filters']" "css_element" And I click on "Close 'My report' editor" "button" And the following should exist in the "Reports list" table: | Name | Report source | Modified by | | My report | Users | Admin User | Scenario: Create custom report without default setup Given I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration And I click on "New report" "button" And I set the following fields in the "New report" "dialogue" to these values: | Report source | Users | | Include default setup | 0 | # Try to set the report name to some blank spaces. And I set the field "Name" in the "New report" "dialogue" to " " And I click on "Save" "button" in the "New report" "dialogue" And I should see "Required" And I set the field "Name" in the "New report" "dialogue" to "My report" And I click on "Save" "button" in the "New report" "dialogue" Then I should see "My report" And I should see "Nothing to display" And I click on "Close 'My report' editor" "button" And the following should exist in the "Reports list" table: | Name | Report source | | My report | Users | Scenario: Create custom report as a manager # Create a report that our manager can access, but not edit. Given the following "core_reportbuilder > Report" exists: | name | My report | | source | core_user\reportbuilder\datasource\users | And the following "core_reportbuilder > Audience" exists: | report | My report | | classname | core_reportbuilder\reportbuilder\audience\allusers | | configdata | | And the following "users" exist: | username | firstname | lastname | | manager1 | Manager | One | And the following "role assigns" exist: | user | role | contextlevel | reference | | manager1 | manager | System | | And I log in as "manager1" When I navigate to "Reports > Report builder > Custom reports" in site administration And I click on "New report" "button" And I set the following fields in the "New report" "dialogue" to these values: | Name | Manager report | | Report source | Users | | Tags | Cat, Dog | And I click on "Save" "button" in the "New report" "dialogue" And I click on "Close 'Manager report' editor" "button" And the following should exist in the "Reports list" table: | Name | Tags | Report source | | Manager report | Cat, Dog | Users | # Manager can edit their own report, but not those of other users. And I set the field "Edit report name" in the "Manager report" "table_row" to "Manager report (renamed)" Then the "Edit report content" item should exist in the "Actions" action menu of the "Manager report (renamed)" "table_row" And "Edit report name" "link" should not exist in the "My report" "table_row" And "Actions" "actionmenu" should not exist in the "My report" "table_row" Scenario: Rename custom report Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration # Try to set the report name to some blank spaces. It should simply ignore the change. And I set the field "Edit report name" in the "My report" "table_row" to " " And I set the field "Edit report name" in the "My report" "table_row" to "My renamed report" And I reload the page Then the following should exist in the "Reports list" table: | Name | Report source | | My renamed report | Users | Scenario: Rename custom report using filters Given the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration And I set the field "Edit report name" in the "My report" "table_row" to "<span class=\"multilang\" lang=\"en\">English</span><span class=\"multilang\" lang=\"es\">Spanish</span>" And I reload the page Then I should see "English" in the "Reports list" "table" And I should not see "Spanish" in the "Reports list" "table" # Confirm report name is correctly shown in action. And I press "Delete report" action in the "English" report row And I should see "Are you sure you want to delete the report 'English' and all associated data?" in the "Delete report" "dialogue" And I click on "Cancel" "button" in the "Delete report" "dialogue" Scenario: Edit custom report from the custom reports page Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration When I press "Edit report details" action in the "My report" report row And I set the following fields in the "Edit report details" "dialogue" to these values: | Name | My renamed report | | Tags | Cat, Dog | And I click on "Save" "button" in the "Edit report details" "dialogue" Then I should see "Report updated" And the following should exist in the "Reports list" table: | Name | Tags | Report source | | My renamed report | Cat, Dog | Users | Scenario Outline: Filter custom reports Given the following "core_reportbuilder > Reports" exist: | name | source | tags | | My users | core_user\reportbuilder\datasource\users | Cat, Dog | | My courses | core_course\reportbuilder\datasource\courses | | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration And the following should exist in the "Reports list" table: | Name | Tags | Report source | | My users | Cat, Dog | Users | | My courses | | Courses | And I click on "Filters" "button" And I set the following fields in the "<filter>" "core_reportbuilder > Filter" to these values: | <filter> operator | Is equal to | | <filter> value | <value> | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" Then I should see "Filters applied" And the following should exist in the "Reports list" table: | Name | Tags | Report source | | My users | Cat, Dog | Users | And I should not see "My courses" in the "Reports list" "table" Examples: | filter | value | | Name | My users | | Report source | Users | | Tags | Cat | Scenario: Filter custom reports by date Given the following "core_reportbuilder > Report" exists: | name | My report | | source | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration And I click on "Filters" "button" And I set the following fields in the "Time created" "core_reportbuilder > Filter" to these values: | Time created operator | Range | | Time created from | ##2 days ago## | | Time created to | ##tomorrow## | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" Then I should see "Filters applied" And I should see "My report" in the "Reports list" "table" And I set the field "Time created to" in the "Time created" "core_reportbuilder > Filter" to "##yesterday##" And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" And I should see "Nothing to display" And "Reports list" "table" should not exist Scenario: Reset filters in system report Given the following "core_reportbuilder > Report" exists: | name | My report | | source | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration And I click on "Filters" "button" And I set the following fields in the "Name" "core_reportbuilder > Filter" to these values: | Name operator | Contains | | Name value | Lionel | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" And I should see "Filters (1)" in the "#dropdownFiltersButton" "css_element" And I should see "Nothing to display" And I click on "Reset all" "button" in the "[data-region='report-filters']" "css_element" And I should not see "Filters (1)" in the "#dropdownFiltersButton" "css_element" And I should see "Filters" in the "#dropdownFiltersButton" "css_element" And "[data-region='report-filters']" "css_element" should be visible Then I should see "Filters reset" And the following fields in the "Name" "core_reportbuilder > Filter" match these values: | Name operator | Is any value | And I should see "My report" in the "Reports list" "table" Scenario: Custom report tags are not displayed if tagging is disabled Given the following config values are set as admin: | usetags | 0 | And the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration Then the following should exist in the "Reports list" table: | Name | Report source | | My report | Users | And "Tags" "link" should not exist in the "Reports list" "table" And I click on "Filters" "button" And "Tags" "core_reportbuilder > Filter" should not exist Scenario: Delete custom report Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I log in as "admin" When I navigate to "Reports > Report builder > Custom reports" in site administration And I press "Delete report" action in the "My report" report row And I click on "Delete" "button" in the "Delete report" "dialogue" Then I should see "Report deleted" And I should see "Nothing to display" Scenario: Switch between Preview and Edit mode Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" Then I should see "Preview" in the "[data-region='core_reportbuilder/report-header']" "css_element" And I should not see "Edit" in the "[data-region='core_reportbuilder/report-header']" "css_element" And I should not see "Filters" in the "[data-region='core_reportbuilder/report-header']" "css_element" And I should see "Full name" in the ".reportbuilder-sidebar-menu" "css_element" Then I click on "Switch to preview mode" "button" Then I should not see "Preview" in the "[data-region='core_reportbuilder/report-header']" "css_element" And I should see "Edit" in the "[data-region='core_reportbuilder/report-header']" "css_element" And I should see "Filters" in the "[data-region='core_reportbuilder/report-header']" "css_element" Then I click on "Switch to edit mode" "button" Then I should see "Preview" in the "[data-region='core_reportbuilder/report-header']" "css_element" And I should not see "Edit" in the "[data-region='core_reportbuilder/report-header']" "css_element" Scenario: Access report clicking on the report name Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | When I log in as "admin" And I navigate to "Reports > Report builder > Custom reports" in site administration And I click on "My report" "link" in the "My report" "table_row" Then I should see "Preview" in the "[data-region='core_reportbuilder/report']" "css_element" And I should not see "Edit" in the "[data-region='core_reportbuilder/report']" "css_element" And "button[title='Filters']" "css_element" should not exist in the "[data-region='core_reportbuilder/report']" "css_element" Scenario: Access report clicking on the view icon Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | When I log in as "admin" And I navigate to "Reports > Report builder > Custom reports" in site administration And I press "View" action in the "My report" report row Then I should not see "Preview" in the "[data-region='core_reportbuilder/report']" "css_element" And I should not see "Edit" in the "[data-region='core_reportbuilder/report']" "css_element" And "button[title='Filters']" "css_element" should exist in the "[data-region='core_reportbuilder/report']" "css_element" Scenario: Special characters in report name are shown correctly Given the following "core_reportbuilder > Reports" exist: | name | source | | My fish & chips report | core_user\reportbuilder\datasource\users | When I log in as "admin" And I navigate to "Reports > Report builder > Custom reports" in site administration And I press "Edit report content" action in the "My fish & chips report" report row Then I should see "My fish & chips report" in the "#region-main .navbar" "css_element" Scenario: Site report limit is observed when creating new reports Given the following config values are set as admin: | customreportslimit | 0 | And the following "core_reportbuilder > Reports" exist: | name | source | | Report users | core_user\reportbuilder\datasource\users | | Report courses | core_course\reportbuilder\datasource\courses | When I log in as "admin" And I navigate to "Reports > Report builder > Custom reports" in site administration Then "New report" "button" should exist And the following config values are set as admin: | customreportslimit | 2 | And I reload the page And "New report" "button" should not exist Scenario: Disable live editing of custom reports Given the following config values are set as admin: | customreportsliveediting | 0 | And the following "core_reportbuilder > Reports" exist: | name | source | | Report users | core_user\reportbuilder\datasource\users | When I am on the "Report users" "reportbuilder > Editor" page logged in as "admin" Then I should see "Viewing of report data while editing is disabled by the site administrator. Switch to preview mode to view the report." in the "[data-region='core_table/dynamic']" "css_element" And I click on "Switch to preview mode" "button" And I should see "admin" in the "Users" "table" And I click on "Close 'Report users' editor" "button" And I press "View" action in the "Report users" report row And I should see "admin" in the "Users" "table" Scenario Outline: Download custom report in different formats Given the following "users" exist: | username | firstname | lastname | | user1 | User | 1 | | user2 | User | 2 | And the following "core_reportbuilder > Reports" exist: | name | source | | Report users | core_user\reportbuilder\datasource\users | When I am on the "Report users" "reportbuilder > Editor" page logged in as "admin" And I click on "Switch to preview mode" "button" Then I set the field "Download table data as" to "<format>" And I press "Download" Examples: | format | | Comma separated values (.csv) | | Microsoft Excel (.xlsx) | | HTML table | | Javascript Object Notation (.json) | | OpenDocument (.ods) | | Portable Document Format (.pdf) | PK a<�\ ���- �- tests/behat/filtereditor.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom report filters In order to manage the filters of custom reports As an admin I need to add, edit and delete filters in a report Scenario: Add filter to report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Show/hide 'Filters'" "button" Then I should see "There are no filters selected" in the "[data-region='active-filters']" "css_element" And I set the field "Select a filter" to "Email address" And I should see "Added filter 'Email address'" And I should not see "There are no filters selected" in the "[data-region='active-filters']" "css_element" And I should see "Email address" in the "[data-region='active-filters']" "css_element" Scenario: Rename filter in report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Filters" exist: | report | uniqueidentifier | | My report | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on "Show/hide 'Filters'" "button" When I set the field "Rename filter 'Email address'" to "My Email filter" And I reload the page And I click on "Show/hide 'Filters'" "button" Then I should see "My Email filter" in the "[data-region='active-filters']" "css_element" Scenario: Rename filter in report using filters Given the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Filters" exist: | report | uniqueidentifier | | My report | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on "Show/hide 'Filters'" "button" When I set the field "Rename filter 'Email address'" to "<span class=\"multilang\" lang=\"en\">English</span><span class=\"multilang\" lang=\"es\">Spanish</span>" And I reload the page And I click on "Show/hide 'Filters'" "button" Then I should see "English" in the "[data-region='active-filters']" "css_element" And I should not see "Spanish" in the "[data-region='active-filters']" "css_element" Scenario: Rename filter in report using special characters Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Filters" exist: | report | uniqueidentifier | | My report | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on "Show/hide 'Filters'" "button" When I set the field "Rename filter 'Email address'" to "Fish & Chips" And I click on "Switch to preview mode" "button" And I click on "Filters" "button" Then I should see "Fish & Chips" in the "[data-region='report-filters']" "css_element" Scenario: Move filter in report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Filters" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | | My report | user:country | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Show/hide 'Filters'" "button" And I click on "Move filter 'Country'" "button" And I click on "After \"Full name\"" "link" in the "Move filter 'Country'" "dialogue" Then I should see "Moved filter 'Country'" And "Country" "text" should appear before "Email address" "text" Scenario: Delete filter from report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Filters" exist: | report | uniqueidentifier | | My report | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on "Show/hide 'Filters'" "button" And I click on "Delete filter 'Email address'" "button" And I click on "Delete" "button" in the "Delete filter 'Email address'" "dialogue" Then I should see "Deleted filter 'Email address'" And I should see "There are no filters selected" in the "[data-region='active-filters']" "css_element" And I should not see "Email address" in the "[data-region='active-filters']" "css_element" Scenario: Reset filters in custom report Given the following "core_reportbuilder > Reports" exist: | name | source | | My report | core_user\reportbuilder\datasource\users | And I am on the "My report" "reportbuilder > View" page logged in as "admin" When I click on "Filters" "button" And I set the following fields in the "Full name" "core_reportbuilder > Filter" to these values: | Full name operator | Contains | | Full name value | Lionel | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" And I should see "Filters (1)" in the "#dropdownFiltersButton" "css_element" And I should see "Nothing to display" And I click on "Reset all" "button" in the "[data-region='report-filters']" "css_element" And I should not see "Filters (1)" in the "#dropdownFiltersButton" "css_element" And I should see "Filters" in the "#dropdownFiltersButton" "css_element" And "[data-region='report-filters']" "css_element" should be visible Then I should see "Filters reset" And the following fields in the "Full name" "core_reportbuilder > Filter" match these values: | Full name operator | Is any value | And I should see "Admin User" in the "Users" "table" Scenario: Use report filters when previewing report Given the following "users" exist: | username | firstname | lastname | | user1 | User | 1 | | user2 | User | 2 | | user3 | User | 3 | And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | And the following "core_reportbuilder > Filters" exist: | report | uniqueidentifier | | My report | user:fullname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" And I should see "user1@example.com" in the ".reportbuilder-table" "css_element" And I should see "user2@example.com" in the ".reportbuilder-table" "css_element" And I should see "user3@example.com" in the ".reportbuilder-table" "css_element" When I click on "Switch to preview mode" "button" And I click on "Filters" "button" And I set the following fields in the "Full name" "core_reportbuilder > Filter" to these values: | Full name operator | Does not contain | | Full name value | User 2 | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" Then I should see "Filters applied" And I should see "Filters (1)" in the "#dropdownFiltersButton" "css_element" And the following should exist in the "reportbuilder-table" table: | Full name | Email address | | User 1 | user1@example.com | | User 3 | user3@example.com | And the following should not exist in the "reportbuilder-table" table: | Full name | Email address | | User 2 | user2@example.com | # Switching back to edit mode should not apply filters. And I click on "Switch to edit mode" "button" And I should see "user1@example.com" in the ".reportbuilder-table" "css_element" And I should see "user2@example.com" in the ".reportbuilder-table" "css_element" And I should see "user3@example.com" in the ".reportbuilder-table" "css_element" Scenario: Use report filters when previewing report that contains same condition Given the following "users" exist: | username | firstname | lastname | | user1 | User | 1 | | user2 | User | 2 | | user3 | User | 3 | And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | And the following "core_reportbuilder > Condition" exists: | report | My report | | uniqueidentifier | user:email | And the following "core_reportbuilder > Filter" exists: | report | My report | | uniqueidentifier | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" And I should see "user1@example.com" in the ".reportbuilder-table" "css_element" And I should see "user2@example.com" in the ".reportbuilder-table" "css_element" And I should see "user3@example.com" in the ".reportbuilder-table" "css_element" # Set a condition to the report. When I click on "Show/hide 'Conditions'" "button" And I set the following fields in the "Email address" "core_reportbuilder > Condition" to these values: | Email address operator | Is not equal to | | Email address value | user3@example.com | And I click on "Apply" "button" in the "#settingsconditions" "css_element" And I click on "Switch to preview mode" "button" And I click on "Filters" "button" And I set the following fields in the "Email address" "core_reportbuilder > Filter" to these values: | Email address operator | Is not equal to | | Email address value | user2@example.com | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" Then I should see "Filters applied" And I should see "Filters (1)" in the "#dropdownFiltersButton" "css_element" # Assert we haven't overridden the condition and user3 is still not showing in the report. And the following should exist in the "reportbuilder-table" table: | Full name | Email address | | User 1 | user1@example.com | And the following should not exist in the "reportbuilder-table" table: | Full name | Email address | | User 2 | user2@example.com | | User 3 | user3@example.com | PK a<�\��U tests/behat/columneditor.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom report columns In order to manage the columns of custom reports As an admin I need to add, edit and delete columns in a report Scenario: Add column to report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Add column 'Full name'" "link" Then I should see "Added column 'Full name'" And I should see "Full name" in the "reportbuilder-table" "table" Scenario: Search for and add column to report Given the following "core_reportbuilder > Report" exists: | name | My report | | source | core_user\reportbuilder\datasource\users | | default | 0 | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I set the field "Search" in the "[data-region=sidebar-menu]" "css_element" to "Last name" Then I should see "Last name" in the "[data-region=sidebar-menu]" "css_element" And I should not see "Email address" in the "[data-region=sidebar-menu]" "css_element" And I click on "Add column 'Last name'" "link" And I should see "Added column 'Last name'" And I should see "Last name" in the "reportbuilder-table" "table" Scenario: Rename column in report Given the following "core_reportbuilder > Report" exists: | name | My report | | source | core_user\reportbuilder\datasource\users | | default | 0 | And the following "core_reportbuilder > Column" exists: | report | My report | | uniqueidentifier | user:fullname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I set the field "Rename column 'Full name'" to "My renamed column" And I reload the page Then I should see "My renamed column" in the "reportbuilder-table" "table" Scenario: Rename column in report using filters Given the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I set the field "Rename column 'Full name'" to "<span class=\"multilang\" lang=\"en\">English</span><span class=\"multilang\" lang=\"es\">Spanish</span>" And I reload the page Then I should see "English" in the "reportbuilder-table" "table" And I should not see "Spanish" in the "reportbuilder-table" "table" Scenario: Move column in report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | | My report | user:lastaccess | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Move column 'Last access'" "button" And I click on "After \"Full name\"" "link" in the "Move column 'Last access'" "dialogue" Then I should see "Moved column 'Last access'" And "Last access" "text" should appear before "Email address" "text" Scenario: Delete column from report Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Delete column 'Full name'" "button" And I click on "Delete" "button" in the "Delete column 'Full name'" "dialogue" Then I should see "Deleted column 'Full name'" And I should see "Nothing to display" PK a<�\l7ZI I tests/behat/audience.featurenu �[��� @core_reportbuilder @javascript Feature: Configure access to reports based on intended audience As an admin I want to restrict which users have access to a report Background: Given the following "custom profile fields" exist: | datatype | shortname | name | | text | fruit | Fruit | And the following "users" exist: | username | firstname | middlename | lastname | email | profile_field_fruit | | user1 | User | One | 1 | user1@example.com | Apple | | user2 | User | Two | 2 | user2@example.com | Banana | | user3 | User | Three | 3 | user3@example.com | Banana | And the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 1 | Scenario: Configure report audience with manually added users audience type When I log in as "user1" And I follow "Reports" in the user menu And I should see "Nothing to display" And I log out And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Access" dynamic tab And I should see "Nothing to display" And I click on the "Audience" dynamic tab And I should see "There are no audiences for this report" And I click on "Add audience 'Manually added users'" "link" And I should see "Added audience 'Manually added users'" And I should see "Audience not saved" in the "Manually added users" "core_reportbuilder > Audience" And I set the following fields in the "Manually added users" "core_reportbuilder > Audience" to these values: | Add users manually | User 1,User 3 | And I press "Save changes" And I should see "Audience saved" And I should not see "Audience not saved" in the "Manually added users" "core_reportbuilder > Audience" And I should see "User 1, User 3" in the "Manually added users" "core_reportbuilder > Audience" And I should not see "There are no audiences for this report" And I click on the "Access" dynamic tab And I should see "User 1" in the "reportbuilder-table" "table" And I should not see "User 2" in the "reportbuilder-table" "table" And I should see "User 3" in the "reportbuilder-table" "table" And I log out And I log in as "user1" And I follow "Reports" in the user menu Then I should see "My report" in the "reportbuilder-table" "table" And I click on "My report" "link" in the "My report" "table_row" And I should see "User 1" in the "reportbuilder-table" "table" Scenario: Configure report audience with administrator audience type Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab When I click on "Add audience 'Site administrators'" "link" And I press "Save changes" Then I should see "Audience saved" And I click on the "Access" dynamic tab And I should see "Admin User" in the "reportbuilder-table" "table" And I should not see "User 1" in the "reportbuilder-table" "table" And I should not see "User 2" in the "reportbuilder-table" "table" And I should not see "User 3" in the "reportbuilder-table" "table" Scenario: Configure report audience with has system role audience type Given the following "role assigns" exist: | user | role | contextlevel | reference | | user2 | manager | System | | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab When I click on "Add audience 'Assigned system role'" "link" And I should see "Added audience 'Assigned system role'" And I set the following fields in the "Assigned system role" "core_reportbuilder > Audience" to these values: | Select a role | Manager | And I press "Save changes" Then I should see "Audience saved" And I should see "Manager" in the "Assigned system role" "core_reportbuilder > Audience" And I click on the "Access" dynamic tab And I should not see "User 1" in the "reportbuilder-table" "table" And I should see "User 2" in the "reportbuilder-table" "table" And I should not see "User 3" in the "reportbuilder-table" "table" And I log out And I am on the "My report" "reportbuilder > View" page logged in as "user2" And I should see "User 1" in the "reportbuilder-table" "table" Scenario: Configure report audience with Member of cohort audience type Given the following "cohorts" exist: | name | idnumber | | Cohort1 | cohort1 | And the following "cohort members" exist: | cohort | user | | cohort1 | user3 | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab When I click on "Add audience 'Member of cohort'" "link" And I should see "Added audience 'Member of cohort'" And I set the following fields in the "Member of cohort" "core_reportbuilder > Audience" to these values: | Select members from cohort | Cohort1 | And I press "Save changes" Then I should see "Audience saved" And I should see "Cohort1" in the "Member of cohort" "core_reportbuilder > Audience" And I click on the "Access" dynamic tab And I should not see "User 1" in the "reportbuilder-table" "table" And I should not see "User 2" in the "reportbuilder-table" "table" And I should see "User 3" in the "reportbuilder-table" "table" And I log out And I am on the "My report" "reportbuilder > View" page logged in as "user3" And I should see "User 1" in the "reportbuilder-table" "table" Scenario: Configure report audience with Member of cohort audience type with no cohorts available Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on the "Audience" dynamic tab Then "Add audience 'All users'" "link" should exist # This audience type should be disabled because there are no cohorts available. And "Add audience 'Member of cohort'" "link" should not exist And the "title" attribute of "//div[@data-region='sidebar-menu']/descendant::div[normalize-space(.)='Member of cohort']" "xpath_element" should contain "Not available" Scenario: Configure report audience as user who cannot use specific audience Given the following "users" exist: | username | firstname | lastname | | manager1 | Manager | 1 | And the following "role assigns" exist: | user | role | contextlevel | reference | | manager1 | manager | System | | And the following "permission overrides" exist: | capability | permission | role | contextlevel | reference | | moodle/reportbuilder:editall | Allow | manager | System | | | moodle/cohort:view | Prohibit | manager | System | | And I am on the "My report" "reportbuilder > Editor" page logged in as "manager1" When I click on the "Audience" dynamic tab Then I should not see "Member of cohort" in the "[data-region='sidebar-menu']" "css_element" Scenario: Search for and add audience to report Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab When I set the field "Search" in the "[data-region=sidebar-menu]" "css_element" to "All users" Then I should see "All users" in the "[data-region=sidebar-menu]" "css_element" And I should not see "Member of cohort" in the "[data-region=sidebar-menu]" "css_element" And I click on "Add audience 'All users'" "link" And I should see "Added audience 'All users'" And I press "Save changes" And I should see "Audience saved" Scenario: Rename report audience Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab And I click on "Add audience 'All users'" "link" And I press "Save changes" When I set the field "Rename audience 'All users'" to "All my lovely users" And I reload the page Then I should see "All my lovely users" in the "[data-region='audience-card']" "css_element" Scenario: Rename report audience using filters Given the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab And I click on "Add audience 'All users'" "link" And I press "Save changes" When I set the field "Rename audience 'All users'" to "<span class=\"multilang\" lang=\"en\">English</span><span class=\"multilang\" lang=\"es\">Spanish</span>" And I reload the page Then I should see "English" in the "[data-region='audience-card']" "css_element" And I should not see "Spanish" in the "[data-region='audience-card']" "css_element" Scenario: Delete report audience Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab And I click on "Add audience 'All users'" "link" And I press "Save changes" When I click on "Delete audience 'All users'" "button" And I should see "Are you sure you want to delete the audience 'All users'?" in the "Delete audience 'All users'" "dialogue" And I click on "Delete" "button" in the "Delete audience 'All users'" "dialogue" Then I should see "Deleted audience 'All users'" And "All users" "core_reportbuilder > Audience" should not exist And I should see "There are no audiences for this report" Scenario: Delete report audience used in schedule Given the following "core_reportbuilder > Audiences" exist: | report | configdata | | My report | | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab And I press "New schedule" And I set the following fields in the "New schedule" "dialogue" to these values: | Name | My schedule | | Starting from | ##tomorrow 11:00## | | All users | 1 | | Subject | Cause you know just what to say | | Body | And you know just what to do | And I click on "Save" "button" in the "New schedule" "dialogue" When I click on the "Audience" dynamic tab Then I should see "This audience is used in a schedule for this report" in the "All users" "core_reportbuilder > Audience" And I click on "Delete audience 'All users'" "button" And I should see "This audience is used in a schedule for this report" in the "Delete audience 'All users'" "dialogue" And I click on "Delete" "button" in the "Delete audience 'All users'" "dialogue" And I should see "Deleted audience 'All users'" And "All users" "core_reportbuilder > Audience" should not exist And I should see "There are no audiences for this report" Scenario: Edit report audience with manually added users audience type Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Access" dynamic tab And I should see "Nothing to display" And I click on the "Audience" dynamic tab And I click on "Add audience 'Manually added users'" "link" And I set the following fields in the "Manually added users" "core_reportbuilder > Audience" to these values: | Add users manually | User 1,User 3 | And I press "Save changes" When I press "Edit audience 'Manually added users'" And "User 1" "autocomplete_selection" in the "Manually added users" "core_reportbuilder > Audience" should be visible And "User 3" "autocomplete_selection" in the "Manually added users" "core_reportbuilder > Audience" should be visible And I set the following fields in the "Manually added users" "core_reportbuilder > Audience" to these values: | Add users manually | User 2 | And I press "Save changes" Then I should see "Audience saved" And I should see "User 2" in the "Manually added users" "core_reportbuilder > Audience" And I click on the "Access" dynamic tab And I should not see "User 1" in the "reportbuilder-table" "table" And I should see "User 2" in the "reportbuilder-table" "table" And I should not see "User 3" in the "reportbuilder-table" "table" Scenario: View configured user additional names on the access tab Given the following config values are set as admin: | alternativefullnameformat | firstname middlename lastname | And the following "core_reportbuilder > Audiences" exist: | report | configdata | | My report | | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on the "Access" dynamic tab Then I should see "User One 1" in the "reportbuilder-table" "table" And I should see "User Two 2" in the "reportbuilder-table" "table" And I should see "User Three 3" in the "reportbuilder-table" "table" # Now sort each of them. And I click on "First name" "link" in the "reportbuilder-table" "table" And "Admin User" "table_row" should appear before "User One 1" "table_row" And I click on "First name" "link" in the "reportbuilder-table" "table" And "User One 1" "table_row" should appear before "Admin User" "table_row" And I click on "Middle name" "link" in the "reportbuilder-table" "table" And "User Two 2" "table_row" should appear before "User One 1" "table_row" And I click on "Middle name" "link" in the "reportbuilder-table" "table" And "User One 1" "table_row" should appear before "User Two 2" "table_row" And I click on "Last name" "link" in the "reportbuilder-table" "table" And "User One 1" "table_row" should appear before "User Two 2" "table_row" And I click on "Last name" "link" in the "reportbuilder-table" "table" And "User Two 2" "table_row" should appear before "User One 1" "table_row" Scenario: View configured user identity fields on the access tab Given the following config values are set as admin: | showuseridentity | email,profile_field_fruit | And the following "core_reportbuilder > Audiences" exist: | report | configdata | | My report | | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on the "Access" dynamic tab Then the following should exist in the "reportbuilder-table" table: | -1- | Email address | Fruit | | User 1 | user1@example.com | Apple | | User 2 | user2@example.com | Banana | | User 3 | user3@example.com | Banana | # Now let's filter them. And I click on "Filters" "button" And I set the following fields in the "Fruit" "core_reportbuilder > Filter" to these values: | Fruit operator | Is equal to | | Fruit value | Banana | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" And I should not see "User 1" in the "reportbuilder-table" "table" And I should see "User 2" in the "reportbuilder-table" "table" And I should see "User 3" in the "reportbuilder-table" "table" And I set the following fields in the "Email address" "core_reportbuilder > Filter" to these values: | Email address operator | Contains | | Email address value | user2 | And I click on "Apply" "button" in the "[data-region='report-filters']" "css_element" And I should not see "User 1" in the "reportbuilder-table" "table" And I should see "User 2" in the "reportbuilder-table" "table" And I should not see "User 3" in the "reportbuilder-table" "table" Scenario: View report as a user with edit capability Given the following "roles" exist: | shortname | name | archetype | | viewreportsrole | Test role | | And the following "role assigns" exist: | user | role | contextlevel | reference | | user1 | viewreportsrole | System | | And the following "permission overrides" exist: | capability | permission | role | contextlevel | reference | | moodle/reportbuilder:editall | Prohibit | viewreportsrole | System | | | moodle/reportbuilder:edit | Allow | viewreportsrole | System | | | moodle/reportbuilder:view | Prohibit | viewreportsrole | System | | When I log in as "user1" And I follow "Reports" in the user menu And I should see "Nothing to display" And I click on "New report" "button" And I set the following fields in the "New report" "dialogue" to these values: | Name | My user1 report | | Report source | Users | | Include default setup | 1 | And I click on "Save" "button" in the "New report" "dialogue" And I click on "Close 'My user1 report' editor" "button" And I should see "My user1 report" in the "reportbuilder-table" "table" And I press "View report" action in the "My user1 report" report row And I should see "User 1" in the "reportbuilder-table" "table" Scenario: View report as a user with editall capability Given the following "roles" exist: | shortname | name | archetype | | viewreportsrole | Test role | | And the following "role assigns" exist: | user | role | contextlevel | reference | | user1 | viewreportsrole | System | | And the following "permission overrides" exist: | capability | permission | role | contextlevel | reference | | moodle/reportbuilder:editall | Allow | viewreportsrole | System | | | moodle/reportbuilder:edit | Prohibit | viewreportsrole | System | | | moodle/reportbuilder:view | Prohibit | viewreportsrole | System | | When I log in as "user1" And I follow "Reports" in the user menu Then I should see "My report" in the "reportbuilder-table" "table" And I press "View report" action in the "My report" report row And I should see "User 1" in the "reportbuilder-table" "table" PK a<�\��S S tests/behat/cardview.featurenu �[��� @core_reportbuilder @javascript Feature: Manage card view settings in the report editor In order to manage a report card view settings As an admin I need to be able to edit and save the form Background: Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | | My report | user:city | And the following "users" exist: | username | firstname | lastname | email | city | | l.smith | Lionel | Smith | lionel@example.com | Bilbao | Scenario: Edit card view settings form When I am on the "My report" "reportbuilder > Editor" page logged in as "admin" Then I change window size to "large" And I click on "Show/hide 'Card view'" "button" # Check default values. And the following fields match these values: | Columns visible | 1 | | First column title | No | And I set the following fields to these values: | Columns visible | 3 | | First column title | Yes | And I press "Save changes" And I should see "Card view settings saved" # Let's check that after switching to preview mode card view form gets rendered again. And I click on "Switch to preview mode" "button" And I click on "Switch to edit mode" "button" And I click on "Show/hide 'Card view'" "button" And the following fields match these values: | Columns visible | 3 | | First column title | Yes | And I click on "Delete column 'Full name'" "button" And I click on "Delete" "button" in the "Delete column 'Full name'" "dialogue" # Check that 'Columns visible' select updates taking into account report maximum columns. And the field "visiblecolumns" matches value "2" And the "visiblecolumns" select box should not contain "3" Scenario: Show Card view When I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" And I press "Switch to preview mode" And I change window size to "530x812" # Card view should just show user fullname while collapsed with default settings. And I should see "Lionel Smith" in the "reportbuilder-table" "table" And I should not see "lionel@example.com" in the "reportbuilder-table" "table" And I should not see "Bilbao" in the "reportbuilder-table" "table" And I click on "Show/hide 'Lionel Smith'" "button" in the "reportbuilder-table" "table" And I should see "Lionel Smith" in the "reportbuilder-table" "table" And I should see "lionel@example.com" in the "reportbuilder-table" "table" And I should see "Bilbao" in the "reportbuilder-table" "table" # Card view do not show first column title with default settings. And "[data-cardtitle=\"Full name\"]" "css_element" should not exist in the "reportbuilder-table" "table" And "[data-cardtitle=\"Email address\"]" "css_element" should exist in the "reportbuilder-table" "table" And "[data-cardtitle=\"City/town\"]" "css_element" should exist in the "reportbuilder-table" "table" # Change 'Columns visible' to 3 and 'First column title' to yes. And I change window size to "large" And I press "Switch to edit mode" And I click on "Show/hide 'Card view'" "button" And I set the following fields to these values: | Columns visible | 3 | | First column title | Yes | And I press "Save changes" # Check now all the columns are shown in the card and there is no toggle button. And I press "Switch to preview mode" And I change window size to "530x812" And I should see "Lionel Smith" in the "reportbuilder-table" "table" And I should see "lionel@example.com" in the "reportbuilder-table" "table" And I should see "Bilbao" in the "reportbuilder-table" "table" And "[data-cardtitle=\"Full name\"]" "css_element" should exist in the "reportbuilder-table" "table" And "[data-cardtitle=\"Email address\"]" "css_element" should exist in the "reportbuilder-table" "table" And "[data-cardtitle=\"City/town\"]" "css_element" should exist in the "reportbuilder-table" "table" And "Show/hide 'Lionel Smith'" "button" should not exist Scenario Outline: Toggle card view according to content of first column Given the following "core_reportbuilder > Reports" exist: | name | source | default | | New report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | New report | <firstcolumn> | | New report | user:email | And the following "core_reportbuilder > Conditions" exist: | report | uniqueidentifier | | New report | user:username | When I am on the "New report" "reportbuilder > Editor" page logged in as "admin" And I click on "Show/hide 'Conditions'" "button" # Make sure we're only viewing our test user in the report. And I set the following fields in the "Username" "core_reportbuilder > Condition" to these values: | Username operator | Is equal to | | Username value | l.smith | And I click on "Apply" "button" in the "[data-region='settings-conditions']" "css_element" # Now use the card show/hide toggle. And I change window size to "530x812" And I press "Switch to preview mode" And I should not see "lionel@example.com" in the "reportbuilder-table" "table" And I click on "<togglebutton>" "button" in the "reportbuilder-table" "table" Then I should see "lionel@example.com" in the "reportbuilder-table" "table" Examples: | firstcolumn | togglebutton | | user:fullnamewithlink | Show/hide 'Lionel Smith' | | user:firstname | Show/hide 'Lionel' | | user:idnumber | Show/hide card | PK a<�\�BTF F tests/behat/schedules.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom report schedules In order ot manage custom report schedules As an admin I need to create new and edit existing report schedules Background: Given the following "users" exist: | username | firstname | lastname | | user1 | User | One | | user2 | User | Two | | user3 | User | Three | And the following "core_reportbuilder > Report" exists: | name | My report | | source | core_user\reportbuilder\datasource\users | | default | 1 | And the following "core_reportbuilder > Audience" exists: | report | My report | | classname | core_reportbuilder\reportbuilder\audience\allusers | | configdata | | Scenario: Create report schedule Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab # Rename the existing audience. And I set the field "Rename audience 'All users'" to "All my lovely users" # Add a second audience. And I click on "Add audience 'Manually added users'" "link" And I set the field "Add users manually" to "User One, User Two" And I press "Save changes" When I click on the "Schedules" dynamic tab And I press "New schedule" And I set the following fields in the "New schedule" "dialogue" to these values: | Name | My schedule | | Starting from | ##tomorrow 11:00## | | Subject | You're all I've ever wanted | | Body | And my arms are open wide | # Confirm each audience is present in the form, select only the manually added users. And I should see "All my lovely users" in the "New schedule" "dialogue" And I set the field "Manually added users: User One, User Two" to "1" And I click on "Save" "button" in the "New schedule" "dialogue" Then I should see "Schedule created" And the following should exist in the "Report schedules" table: | Name | Starting from | Time last sent | Modified by | | My schedule | ##tomorrow 11:00##%A, %d %B %Y, %H:%M## | Never | Admin User | Scenario: Create report schedule for audience renamed using filters Given the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Audience" dynamic tab And I set the field "Rename audience 'All users'" to "<span class=\"multilang\" lang=\"en\">English</span><span class=\"multilang\" lang=\"es\">Spanish</span>" When I click on the "Schedules" dynamic tab And I press "New schedule" Then I should see "English" in the "New schedule" "dialogue" And I should not see "Spanish" in the "New schedule" "dialogue" And I click on "Cancel" "button" in the "New schedule" "dialogue" Scenario: Rename report schedule Given the following "core_reportbuilder > Schedule" exists: | report | My report | | name | My schedule | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab When I set the field "Edit schedule name" in the "My schedule" "table_row" to "My renamed schedule" And I reload the page Then I should see "My renamed schedule" in the "Report schedules" "table" Scenario: Rename report schedule using filters Given the "multilang" filter is "on" And the "multilang" filter applies to "content and headings" And the following "core_reportbuilder > Schedule" exists: | report | My report | | name | My schedule | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab When I set the field "Edit schedule name" in the "My schedule" "table_row" to "<span class=\"multilang\" lang=\"en\">English</span><span class=\"multilang\" lang=\"es\">Spanish</span>" And I reload the page Then I should see "English" in the "Report schedules" "table" And I should not see "Spanish" in the "Report schedules" "table" # Confirm schedule name is correctly shown in actions. And I press "Send schedule" action in the "English" report row And I should see "Are you sure you want to queue the schedule 'English' for sending immediately?" in the "Send schedule" "dialogue" And I click on "Cancel" "button" in the "Send schedule" "dialogue" And I press "Delete schedule" action in the "English" report row And I should see "Are you sure you want to delete the schedule 'English'?" in the "Delete schedule" "dialogue" And I click on "Cancel" "button" in the "Delete schedule" "dialogue" Scenario: Toggle report schedule Given the following "core_reportbuilder > Schedules" exist: | report | name | | My report | My schedule | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab When I click on "Disable schedule" "field" in the "My schedule" "table_row" Then the "class" attribute of "My schedule" "table_row" should contain "text-muted" And I click on "Enable schedule" "field" in the "My schedule" "table_row" Scenario: Edit report schedule Given the following "core_reportbuilder > Schedules" exist: | report | name | | My report | My schedule | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab When I press "Edit schedule details" action in the "My schedule" report row And I set the following fields in the "Edit schedule details" "dialogue" to these values: | Name | My updated schedule | | Starting from | ##tomorrow 11:00## | | All users: All site users | 1 | And I click on "Save" "button" in the "Edit schedule details" "dialogue" Then I should see "Schedule updated" And the following should exist in the "Report schedules" table: | Name | Starting from | | My updated schedule | ##tomorrow 11:00##%A, %d %B %Y, %H:%M## | Scenario: Send report schedule Given the following "core_reportbuilder > Schedules" exist: | report | name | | My report | My schedule | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab When I press "Send schedule" action in the "My schedule" report row And I click on "Confirm" "button" in the "Send schedule" "dialogue" Then I should see "Schedule sent" Scenario: Delete report schedule Given the following "core_reportbuilder > Schedules" exist: | report | name | | My report | My schedule | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I click on the "Schedules" dynamic tab When I press "Delete schedule" action in the "My schedule" report row And I click on "Delete" "button" in the "Delete schedule" "dialogue" Then I should see "Schedule deleted" And I should see "Nothing to display" PK a<�\_��S� � # tests/behat/conditioneditor.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom report conditions In order to manage the conditions of custom reports As an admin I need to add, edit and delete conditions in a report Background: Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | And the following "users" exist: | username | firstname | lastname | email | interests | | user01 | User | One | user01@example.com | lionel, dancing | | user02 | User | Two | user02@example.com | | Scenario: Add condition to report Given I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I click on "Show/hide 'Conditions'" "button" Then I should see "There are no conditions selected" in the "[data-region='settings-conditions']" "css_element" And I set the field "Select a condition" to "Email address" And I should see "Added condition 'Email address'" And I should not see "There are no conditions selected" in the "[data-region='settings-conditions']" "css_element" And I set the following fields in the "Email address" "core_reportbuilder > Condition" to these values: | Email address operator | Does not contain | | Email address value | user02 | And I click on "Apply" "button" in the "[data-region='settings-conditions']" "css_element" And I should see "Conditions applied" And I should see "User One" in the "reportbuilder-table" "table" And I should not see "User Two" in the "reportbuilder-table" "table" Scenario: Add tags condition to report Given the following "core_reportbuilder > Condition" exists: | report | My report | | uniqueidentifier | tag:name | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Show/hide 'Conditions'" "button" And I set the following fields in the "Tag name" "core_reportbuilder > Condition" to these values: | Tag name operator | Is equal to | | Tag name value | dancing | And I click on "Apply" "button" in the "[data-region='settings-conditions']" "css_element" Then I should see "Conditions applied" And I should see "User One" in the "reportbuilder-table" "table" And I should not see "User Two" in the "reportbuilder-table" "table" Scenario: Move condition in report Given the following "core_reportbuilder > Conditions" exist: | report | uniqueidentifier | | My report | user:fullname | | My report | user:email | | My report | user:country | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" When I click on "Show/hide 'Conditions'" "button" And I click on "Move condition 'Country'" "button" And I click on "After \"Full name\"" "link" in the "Move condition 'Country'" "dialogue" Then I should see "Moved condition 'Country'" And "Country" "text" should appear before "Email address" "text" Scenario: Delete condition from report Given the following "core_reportbuilder > Conditions" exist: | report | uniqueidentifier | | My report | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I click on "Show/hide 'Conditions'" "button" And I set the following fields in the "Email address" "core_reportbuilder > Condition" to these values: | Email address operator | Does not contain | | Email address value | user02 | And I click on "Apply" "button" in the "[data-region='settings-conditions']" "css_element" And I click on "Delete condition 'Email address'" "button" And I click on "Delete" "button" in the "Delete condition 'Email address'" "dialogue" Then I should see "Deleted condition 'Email address'" And I should see "There are no conditions selected" in the "[data-region='settings-conditions']" "css_element" And "[data-region='active-conditions']" "css_element" should not exist And I should see "User One" in the "reportbuilder-table" "table" And I should see "User Two" in the "reportbuilder-table" "table" Scenario: Reset conditions in report Given the following "core_reportbuilder > Conditions" exist: | report | uniqueidentifier | | My report | user:email | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" And I change window size to "large" When I click on "Show/hide 'Conditions'" "button" And I set the following fields in the "Email address" "core_reportbuilder > Condition" to these values: | Email address operator | Does not contain | | Email address value | example.com | And I click on "Apply" "button" in the "[data-region='settings-conditions']" "css_element" And I should see "Nothing to display" And I click on "Reset all" "button" in the "[data-region='settings-conditions']" "css_element" And I click on "Reset all" "button" in the "Reset conditions" "dialogue" Then I should see "Conditions reset" And the following fields in the "Email address" "core_reportbuilder > Condition" match these values: | Email address operator | Is any value | And I should see "User One" in the "reportbuilder-table" "table" And I should see "User Two" in the "reportbuilder-table" "table" PK a<�\|R�X� � ' tests/behat/columnsortingeditor.featurenu �[��� @core_reportbuilder @javascript Feature: Manage custom report columns sorting In order to manage the sorting for columns of custom reports As an admin I need to be able to enable/disable, change sort direction and reorder sorting for columns Background: Given the following "core_reportbuilder > Reports" exist: | name | source | default | | My report | core_user\reportbuilder\datasource\users | 0 | And the following "core_reportbuilder > Columns" exist: | report | uniqueidentifier | | My report | user:username | | My report | user:lastname | | My report | user:firstname | And the following "users" exist: | username | firstname | lastname | email | | user01 | Alice | Zebra | user01@example.com | | user02 | Zoe | Aardvark | user02@example.com | | user03 | Alice | Badger | user03@example.com | And I am on the "My report" "reportbuilder > Editor" page logged in as "admin" Scenario: Toggle column sorting in report Given I change window size to "large" And I click on "Show/hide 'Sorting'" "button" # This will be the fallback sort after toggling lastname sorting. And I click on "Enable initial sorting for column 'First name'" "checkbox" When I click on "Enable initial sorting for column 'Last name'" "checkbox" Then I should see "Updated sorting for column 'Last name'" And "user02" "table_row" should appear before "user01" "table_row" And I click on "Disable initial sorting for column 'Last name'" "checkbox" And I should see "Updated sorting for column 'Last name'" And "user01" "table_row" should appear before "user02" "table_row" Scenario: Change column sort direction in report Given I change window size to "large" And I click on "Show/hide 'Sorting'" "button" When I click on "Enable initial sorting for column 'Last name'" "checkbox" And I click on "Change initial sorting for column 'Last name' to descending" "button" Then I should see "Updated sorting for column 'Last name'" And "user01" "table_row" should appear before "user02" "table_row" And I click on "Change initial sorting for column 'Last name' to ascending" "button" And I should see "Updated sorting for column 'Last name'" And "user02" "table_row" should appear before "user01" "table_row" Scenario: Change column sort order in report Given I change window size to "large" And I click on "Show/hide 'Sorting'" "button" When I click on "Enable initial sorting for column 'Last name'" "checkbox" And I click on "Enable initial sorting for column 'First name'" "checkbox" And I click on "Move sorting for column 'First name'" "button" And I click on "To the top of the list" "link" in the "Move sorting for column 'First name'" "dialogue" Then I should see "Updated sorting for column 'First name'" And "First name" "text" should appear before "Last name" "text" in the "#settingssorting" "css_element" And "user01" "table_row" should appear before "user02" "table_row" Scenario: Change column sorting for column sorted by multiple fields Given I change window size to "large" And I click on "Add column 'Full name'" "link" And I click on "Show/hide 'Sorting'" "button" When I click on "Enable initial sorting for column 'Full name'" "checkbox" Then I should see "Updated sorting for column 'Full name'" # User1 = Alice Zebra; User2=Zoe Aardvark; User3 = Alice Badger. And "user03" "table_row" should appear before "user01" "table_row" And "user01" "table_row" should appear before "user02" "table_row" And I click on "Change initial sorting for column 'Full name' to descending" "button" And I should see "Updated sorting for column 'Full name'" And "user02" "table_row" should appear before "user01" "table_row" And "user01" "table_row" should appear before "user03" "table_row" Scenario: Configured report sorting is always applied when editing Given I change window size to "large" And I click on "Show/hide 'Sorting'" "button" # Sort by last name descending. When I click on "Enable initial sorting for column 'Last name'" "checkbox" Then "user02" "table_row" should appear before "user01" "table_row" # Switching to preview mode should observe report config. And I click on "Switch to preview mode" "button" And "user02" "table_row" should appear before "user01" "table_row" # Custom sorting for the user. And I click on "Sort by First name Ascending" "link" And "user01" "table_row" should appear before "user02" "table_row" # Switching back to edit mode should observe report config. And I click on "Switch to edit mode" "button" And "user02" "table_row" should appear before "user01" "table_row" Scenario: Sortable columns are updated when column is added to report Given I change window size to "large" And I click on "Show/hide 'Sorting'" "button" When I click on "Add column 'Full name'" "link" Then I should see "Full name" in the "#settingssorting" "css_element" Scenario: Sortable columns are updated when column is deleted from report Given I change window size to "large" And I click on "Show/hide 'Sorting'" "button" When I click on "Delete column 'Username'" "button" And I click on "Delete" "button" in the "Delete column 'Username'" "dialogue" Then I should not see "Username" in the "#settingssorting" "css_element" PK a<�\ � p�# �# - tests/classes/core_reportbuilder_testcase.phpnu �[��� <?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\tests; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\helpers\{aggregation, report, user_filter_manager}; use core_reportbuilder\table\custom_report_table_view; use Throwable; /** * Helper base class for reportbuilder unit tests * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ abstract class core_reportbuilder_testcase extends advanced_testcase { /** * Retrieve content for given report as array of report data * * @param int $reportid * @param int $pagesize * @param array $filtervalues * @return array[] */ protected function get_custom_report_content(int $reportid, int $pagesize = 30, array $filtervalues = []): array { $records = []; // Apply filter values. user_filter_manager::set($reportid, $filtervalues); // Create table instance. $table = custom_report_table_view::create($reportid); $table->setup(); $table->query_db($pagesize, false); // Extract raw data. foreach ($table->rawdata as $record) { $records[] = $table->format_row($record); } $table->close_recordset(); return $records; } /** * Stress test a report source by iterating over all it's columns, enabling sorting where possible and asserting we can * create a report for each * * @param string $source */ protected function datasource_stress_test_columns(string $source): void { /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Stress columns', 'source' => $source, 'default' => 0]); $instance = manager::get_report_from_persistent($report); // Iterate over each available column, ensure each works correctly independent of any others. foreach ($instance->get_columns() as $columnidentifier => $columninstance) { $column = report::add_report_column($report->get('id'), $columnidentifier); // Enable sorting of the column where possible. if ($columninstance->get_is_sortable()) { report::toggle_report_column_sorting($report->get('id'), $column->get('id'), true, SORT_DESC); } // We are only asserting the report returns content without errors, not the content itself. try { $content = $this->get_custom_report_content($report->get('id')); $this->assertNotEmpty($content); // Ensure appropriate debugging was triggered for deprecated column. if ($columninstance->get_is_deprecated()) { $this->assertDebuggingCalled(null, DEBUG_DEVELOPER); } } catch (Throwable $exception) { $this->fail("Error for column '{$columnidentifier}': " . $exception->getMessage()); } report::delete_report_column($report->get('id'), $column->get('id')); } } /** * Stress test a report source by iterating over all columns and asserting we can create a report while aggregating each * * @param string $source */ protected function datasource_stress_test_columns_aggregation(string $source): void { /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Stress aggregation', 'source' => $source, 'default' => 0]); $instance = manager::get_report_from_persistent($report); // Add every column. $columndeprecatedcount = 0; foreach ($instance->get_columns() as $columnidentifier => $column) { $columndeprecatedcount += (int) $column->get_is_deprecated(); report::add_report_column($report->get('id'), $columnidentifier); } // Now iterate over each column, and apply all suitable aggregation types. $columns = $instance->get_active_columns(); $this->assertDebuggingCalledCount($columndeprecatedcount, null, array_fill(0, $columndeprecatedcount, DEBUG_DEVELOPER)); foreach ($columns as $column) { $aggregations = aggregation::get_column_aggregations($column->get_type(), $column->get_disabled_aggregation()); foreach (array_keys($aggregations) as $aggregation) { $column->get_persistent()->set('aggregation', $aggregation)->update(); // We are only asserting the report returns content without errors, not the content itself. try { $content = $this->get_custom_report_content($report->get('id')); $this->assertNotEmpty($content); // Ensure appropriate debugging was triggered for deprecated columns. $this->assertDebuggingCalledCount($columndeprecatedcount, null, array_fill(0, $columndeprecatedcount, DEBUG_DEVELOPER)); } catch (Throwable $exception) { $this->fail("Error for column '{$column->get_unique_identifier()}' with aggregation '{$aggregation}': " . $exception->getMessage()); } } // Reset the column aggregation. $column->get_persistent()->set('aggregation', null)->update(); } } /** * Stress test a report source by iterating over all it's conditions and asserting we can create a report using each * * @param string $source * @param string $columnidentifier Should be a simple column, with as few fields and joins as possible, ideally selected * from the base table itself */ protected function datasource_stress_test_conditions(string $source, string $columnidentifier): void { /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Stress conditions', 'source' => $source, 'default' => 0]); $instance = manager::get_report_from_persistent($report); // Add single column only (to ensure no conditions have reliance on any columns). report::add_report_column($report->get('id'), $columnidentifier); // Iterate over each available condition, ensure each works correctly independent of any others. $conditionidentifiers = array_keys($instance->get_conditions()); foreach ($conditionidentifiers as $conditionidentifier) { $condition = report::add_report_condition($report->get('id'), $conditionidentifier); $conditioninstance = $instance->get_condition($condition->get('uniqueidentifier')); /** @var \core_reportbuilder\local\filters\base $conditionclass */ $conditionclass = $conditioninstance->get_filter_class(); // Set report condition values in order to activate it. $conditionvalues = $conditionclass::create($conditioninstance)->get_sample_values(); if (empty($conditionvalues)) { debugging("Missing sample values from filter '{$conditionclass}'", DEBUG_DEVELOPER); } $instance->set_condition_values($conditionvalues); // We are only asserting the report returns content without errors, not the content itself. try { $content = $this->get_custom_report_content($report->get('id')); $this->assertIsArray($content); // Ensure appropriate debugging was triggered for deprecated condition. if ($conditioninstance->get_is_deprecated()) { $this->assertDebuggingCalled(null, DEBUG_DEVELOPER); } } catch (Throwable $exception) { $this->fail("Error for condition '{$conditionidentifier}': " . $exception->getMessage()); } report::delete_report_condition($report->get('id'), $condition->get('id')); } } } PK a<�\���� � > tests/external/custom_report_columns_sorting_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_user\reportbuilder\datasource\users; /** * Unit tests for custom report column sorting exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_columns_sorting_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_columns_sorting_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add a couple of columns (enable sorting on the email column, move it to first place.). $columnfullname = $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname', 'sortenabled' => false, 'sortorder' => 2, ]); $columnemail = $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email', 'sortenabled' => true, 'sortdirection' => SORT_DESC, 'sortorder' => 1, ]); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_columns_sorting_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertTrue($export->hassortablecolumns); $this->assertCount(2, $export->sortablecolumns); [$sortcolumnemail, $sortcolumnfullname] = $export->sortablecolumns; // Email column. $this->assertEquals($columnemail->get('id'), $sortcolumnemail['id']); $this->assertEquals('Email address', $sortcolumnemail['heading']); $this->assertTrue($sortcolumnemail['sortenabled']); $this->assertEquals(1, $sortcolumnemail['sortorder']); $this->assertEquals(SORT_DESC, $sortcolumnemail['sortdirection']); $this->assertEquals('Disable initial sorting for column \'Email address\'', $sortcolumnemail['sortenabledtitle']); $this->assertEquals([ 'key' => 't/sort_desc', 'component' => 'moodle', 'title' => 'Change initial sorting for column \'Email address\' to ascending', ], $sortcolumnemail['sorticon']); // Fullname column. $this->assertEquals($columnfullname->get('id'), $sortcolumnfullname['id']); $this->assertEquals('Full name', $sortcolumnfullname['heading']); $this->assertFalse($sortcolumnfullname['sortenabled']); $this->assertEquals(2, $sortcolumnfullname['sortorder']); $this->assertEquals(SORT_ASC, $sortcolumnfullname['sortdirection']); $this->assertEquals('Enable initial sorting for column \'Full name\'', $sortcolumnfullname['sortenabledtitle']); $this->assertEquals([ 'key' => 't/sort_asc', 'component' => 'moodle', 'title' => 'Change initial sorting for column \'Full name\' to descending', ], $sortcolumnfullname['sorticon']); $this->assertNotEmpty($export->helpicon); } /** * Test exported data structure for report with columns, but they aren't sortable */ public function test_export_no_sortable_columns(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:picture']); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_columns_sorting_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertFalse($export->hassortablecolumns); $this->assertEmpty($export->sortablecolumns); } /** * Test exported data structure for report with no columns */ public function test_export_no_columns(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_columns_sorting_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertFalse($export->hassortablecolumns); $this->assertEmpty($export->sortablecolumns); } } PK a<�\�p�C C 8 tests/external/custom_report_card_view_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_user\reportbuilder\datasource\users; /** * Unit tests for custom report card view exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_card_view_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_card_view_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_card_view_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); // The exporter just returns two large pieces of HTML, assert they are non empty. $this->assertNotEmpty($export->form); $this->assertNotEmpty($export->helpicon); } } PK a<�\)��י � 6 tests/external/custom_report_details_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; /** * Unit tests for custom report details exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_details_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_details_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'tags' => ['cat', 'dog']]); $exporter = new custom_report_details_exporter($report); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); // The exporter outputs the persistent details, plus two other properties. $this->assertEquals($report->get('name'), $export->name); $this->assertEquals($report->get('source'), $export->source); // Source name should be the name of the source. $this->assertObjectHasProperty('sourcename', $export); $this->assertEquals(users::get_name(), $export->sourcename); // We use the tag exporter for report tags. $this->assertObjectHasProperty('tags', $export); $this->assertEquals(['cat', 'dog'], array_column($export->tags, 'name')); // We use the user exporter for the modifier of the report. $this->assertObjectHasProperty('modifiedby', $export); $this->assertEquals(fullname($user), $export->modifiedby->fullname); } } PK a<�\bbwy� � . tests/external/systemreports/retrieve_test.phpnu �[��� <?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\systemreports; use core\context\system; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\systemreports\reports_list; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for retrieving system report content * * @package core_reportbuilder * @covers \core_reportbuilder\external\systemreports\retrieve * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class retrieve_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Two reports, created one second apart to ensure consistent ordering by time created. $generator->create_report(['name' => 'My first report', 'source' => users::class]); $this->waitForSecond(); $generator->create_report(['name' => 'My second report', 'source' => users::class, 'tags' => ['cat', 'dog']]); // Retrieve paged results. $result = retrieve::execute(reports_list::class, ['contextid' => system::instance()->id], '', '', 0, [], 0, 1); $result = external_api::clean_returnvalue(retrieve::execute_returns(), $result); $this->assertArrayHasKey('data', $result); $this->assertEquals([ 'Name', 'Report source', 'Tags', 'Time created', 'Time modified', 'Modified by', ], $result['data']['headers']); $this->assertCount(1, $result['data']['rows']); [$name, $source, $tags, $timecreated, $timemodified, $modifiedby] = $result['data']['rows'][0]['columns']; $this->assertStringContainsString('My second report', $name); $this->assertEquals(users::get_name(), $source); $this->assertEquals('cat, dog', $tags); $this->assertNotEmpty($timecreated); $this->assertNotEmpty($timemodified); $this->assertEquals('Admin User', $modifiedby); $this->assertEquals(2, $result['data']['totalrowcount']); $this->assertEmpty($result['warnings']); } /** * Test execute method for a user without permission to view report */ public function test_execute_access_exception(): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); unassign_capability('moodle/reportbuilder:view', $userrole, system::instance()); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); retrieve::execute(reports_list::class, ['contextid' => system::instance()->id]); } } PK a<�\!��� � . tests/external/systemreports/can_view_test.phpnu �[��� <?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\systemreports; use core\context\system; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\local\systemreports\reports_list; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for validating access to a system report * * @package core_reportbuilder * @covers \core_reportbuilder\external\systemreports\can_view * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class can_view_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); $result = can_view::execute(reports_list::class, ['contextid' => system::instance()->id], '', '', 0, []); $result = external_api::clean_returnvalue(can_view::execute_returns(), $result); $this->assertTrue($result); } /** * Test execute method for a user without permission to view report */ public function test_execute_access_none(): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); unassign_capability('moodle/reportbuilder:view', $userrole, system::instance()); $result = can_view::execute(reports_list::class, ['contextid' => system::instance()->id], '', '', 0, []); $result = external_api::clean_returnvalue(can_view::execute_returns(), $result); $this->assertFalse($result); } } PK a<�\ �� � ( tests/external/audiences/delete_test.phpnu �[��� <?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\audiences; use context_system; use core_reportbuilder\local\models\audience; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for deleting report audiences * * @package core_reportbuilder * @covers \core_reportbuilder\external\audiences\delete * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class delete_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience1 = $generator->create_audience([ 'reportid' => $report->get('id'), 'configdata' => [], ]); $audience2 = $generator->create_audience([ 'reportid' => $report->get('id'), 'configdata' => [], ]); $audiences = audience::get_records(['reportid' => $report->get('id')]); $this->assertCount(2, $audiences); // Delete the first audience. $result = delete::execute($report->get('id'), $audience1->get_persistent()->get('id')); $result = external_api::clean_returnvalue(delete::execute_returns(), $result); $this->assertTrue($result); $audiences = audience::get_records(['reportid' => $report->get('id')]); $this->assertCount(1, $audiences); $audience = reset($audiences); $this->assertEquals($audience2->get_persistent()->get('id'), $audience->get('id')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience1 = $generator->create_audience([ 'reportid' => $report->get('id'), 'configdata' => [], ]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); delete::execute($report->get('id'), $audience1->get_persistent()->get('id')); } } PK a<�\�MWx x . tests/external/custom_report_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder\manager; use core_reportbuilder_generator; use moodle_url; use core_reportbuilder\local\helpers\user_filter_manager; use core_reportbuilder\local\filters\text; use core_user\reportbuilder\datasource\users; /** * Unit tests for custom report exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_exporter_test extends advanced_testcase { /** * Test exported data structure when editing a report */ public function test_export_editing(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); manager::get_report_from_persistent($report)->add_attributes(['data-foo' => 'bar', 'data-another' => '1']); $PAGE->set_url(new moodle_url('/')); $exporter = new custom_report_exporter($report, [], true); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertNotEmpty($export->table); $this->assertEquals(0, $export->filtersapplied); $this->assertFalse($export->filterspresent); $this->assertEmpty($export->filtersform); $this->assertTrue($export->editmode); $this->assertEmpty($export->attributes); // The following are all generated by additional exporters. $this->assertNotEmpty($export->sidebarmenucards); $this->assertNotEmpty($export->conditions); $this->assertNotEmpty($export->filters); $this->assertNotEmpty($export->sorting); $this->assertNotEmpty($export->cardview); } /** * Test exported data structure when viewing a report */ public function test_export_viewing(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); manager::get_report_from_persistent($report)->add_attributes(['data-foo' => 'bar', 'data-another' => '1']); $PAGE->set_url(new moodle_url('/')); $exporter = new custom_report_exporter($report, ['pagesize' => 10], false); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertNotEmpty($export->table); $this->assertEquals(0, $export->filtersapplied); $this->assertFalse($export->filterspresent); $this->assertEmpty($export->filtersform); $this->assertFalse($export->editmode); $this->assertEquals([ ['name' => 'data-foo', 'value' => 'bar'], ['name' => 'data-another', 'value' => '1'] ], $export->attributes); // The following are all generated by additional exporters, and should not be present when not editing. $this->assertObjectNotHasProperty('sidebarmenucards', $export); $this->assertObjectNotHasProperty('conditions', $export); $this->assertObjectNotHasProperty('filters', $export); $this->assertObjectNotHasProperty('sorting', $export); $this->assertObjectNotHasProperty('cardview', $export); } /** * Test exported data structure when filters are present */ public function test_export_filters_present(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $PAGE->set_url(new moodle_url('/')); $exporter = new custom_report_exporter($report, ['pagesize' => 10], false); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertTrue($export->filterspresent); $this->assertNotEmpty($export->filtersform); $this->assertEquals(0, $export->filtersapplied); } /** * Test exported data structure when filters are applied */ public function test_export_filters_applied(): void { global $PAGE; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Apply filter. user_filter_manager::set($report->get('id'), ['user:email_operator' => text::IS_NOT_EMPTY]); $PAGE->set_url(new moodle_url('/')); $exporter = new custom_report_exporter($report, ['pagesize' => 10], false); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertTrue($export->filterspresent); $this->assertNotEmpty($export->filtersform); $this->assertEquals(1, $export->filtersapplied); } } PK a<�\�cS� ' tests/external/reports/listing_test.phpnu �[��� <?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\reports; use context_system; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\report; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for listing reports * * @package core_reportbuilder * @covers \core_reportbuilder\external\reports\listing * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class listing_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create three reports. $reportone = $generator->create_report(['name' => 'Report one', 'source' => users::class, 'tags' => ['cat', 'dog']]); $reporttwo = $generator->create_report(['name' => 'Report two', 'source' => users::class]); $reportthree = $generator->create_report(['name' => 'Report three', 'source' => users::class]); // Create second user, with audience of both report one and two. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $generator->create_audience(['reportid' => $reportone->get('id'), 'configdata' => []]); $generator->create_audience(['reportid' => $reporttwo->get('id'), 'configdata' => []]); // Switch to second user, get their report listing. $result = listing::execute(); $result = external_api::clean_returnvalue(listing::execute_returns(), $result); // All data is generated by exporters, just assert relevant sample of each. $this->assertEquals(['Report one', 'Report two'], array_column($result['reports'], 'name')); $tagscolumn = array_column($result['reports'], 'tags'); $this->assertEquals([ ['cat', 'dog'], [], ], array_map(fn(array $tags) => array_column($tags, 'name'), $tagscolumn)); $this->assertEmpty($result['warnings']); } /** * Test execute method for a user without permission to view reports */ public function test_execute_access_exception(): void { global $DB; $this->resetAfterTest(); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user'], MUST_EXIST); assign_capability('moodle/reportbuilder:view', CAP_PROHIBIT, $userrole, context_system::instance(), true); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); listing::execute(); } } PK a<�\Tj �� � & tests/external/reports/delete_test.phpnu �[��� <?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\reports; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\report; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for deleting reports * * @package core_reportbuilder * @covers \core_reportbuilder\external\reports\delete * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class delete_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Sanity test. $this->assertCount(1, report::get_records()); $result = delete::execute($report->get('id')); $result = external_api::clean_returnvalue(delete::execute_returns(), $result); $this->assertTrue($result); // Retrieve reports. $this->assertEmpty(report::get_records()); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); delete::execute($report->get('id')); } } PK a<�\�tی ( tests/external/reports/retrieve_test.phpnu �[��� <?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\reports; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for retrieving custom report content * * @package core_reportbuilder * @covers \core_reportbuilder\external\reports\retrieve * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class retrieve_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); $this->getDataGenerator()->create_user(['firstname' => 'Zoe', 'lastname' => 'Zebra', 'email' => 'u1@example.com']); $this->getDataGenerator()->create_user(['firstname' => 'Charlie', 'lastname' => 'Carrot', 'email' => 'u2@example.com']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false, 'tags' => ['cat', 'dog']]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname', 'sortenabled' => 1]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // There are three users (admin plus the two previouly created), but we're paging the first two only. $result = retrieve::execute($report->get('id'), 0, 2); $result = external_api::clean_returnvalue(retrieve::execute_returns(), $result); // All data is generated by exporters, just assert relevant sample of each. $this->assertArrayHasKey('details', $result); $this->assertEquals('My report', $result['details']['name']); $this->assertEquals(['cat', 'dog'], array_column($result['details']['tags'], 'name')); $this->assertArrayHasKey('data', $result); $this->assertEquals(['Full name', 'Email address'], $result['data']['headers']); $this->assertEquals([ [ 'columns' => ['Admin User', 'admin@example.com'], ], [ 'columns' => ['Charlie Carrot', 'u2@example.com'], ], ], $result['data']['rows']); $this->assertEquals(3, $result['data']['totalrowcount']); $this->assertEmpty($result['warnings']); // Retrieve the second set of pages results. $result = retrieve::execute($report->get('id'), 1, 2); $result = external_api::clean_returnvalue(retrieve::execute_returns(), $result); // All data is generated by exporters, just assert relevant sample of each. $this->assertArrayHasKey('details', $result); $this->assertEquals('My report', $result['details']['name']); $this->assertEquals(['cat', 'dog'], array_column($result['details']['tags'], 'name')); $this->assertArrayHasKey('data', $result); $this->assertEquals(['Full name', 'Email address'], $result['data']['headers']); $this->assertEquals([ [ 'columns' => ['Zoe Zebra', 'u1@example.com'], ], ], $result['data']['rows']); $this->assertEquals(3, $result['data']['totalrowcount']); $this->assertEmpty($result['warnings']); } /** * Test execute method for a user without permission to view report */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); retrieve::execute($report->get('id')); } } PK a<�\�<�#+ + # tests/external/reports/get_test.phpnu �[��� <?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\reports; use context_system; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for getting reports * * @package core_reportbuilder * @covers \core_reportbuilder\external\reports\get * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class get_test extends externallib_advanced_testcase { /** * Text execute method for edit mode */ public function test_execute_editmode(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add two filters. $filterfullname = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $filteremail = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $result = get::execute($report->get('id'), true); $result = external_api::clean_returnvalue(get::execute_returns(), $result); $this->assertEquals($result['id'], $report->get('id')); $this->assertEquals($result['name'], 'My report'); $this->assertEquals($result['source'], users::class); $this->assertNotEmpty($result['table']); $this->assertNotEmpty($result['javascript']); $this->assertFalse($result['filterspresent']); $this->assertEmpty($result['filtersform']); $this->assertTrue($result['editmode']); // Confirm editor-specific data is returned. $this->assertNotEmpty($result['sidebarmenucards']); $this->assertNotEmpty($result['conditions']); $this->assertNotEmpty($result['filters']); $this->assertTrue($result['filters']['hasavailablefilters']); $this->assertNotEmpty($result['filters']['availablefilters']); $this->assertTrue($result['filters']['hasactivefilters']); $this->assertEquals($filterfullname->get('id'), $result['filters']['activefilters'][0]['id']); $this->assertEquals($filteremail->get('id'), $result['filters']['activefilters'][1]['id']); $this->assertNotEmpty($result['sorting']); $this->assertNotEmpty($result['cardview']); } /** * Text execute method for preview mode */ public function test_execute_previewmode(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add two filters. $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $result = get::execute($report->get('id'), false); $result = external_api::clean_returnvalue(get::execute_returns(), $result); $this->assertEquals($result['id'], $report->get('id')); $this->assertEquals($result['name'], 'My report'); $this->assertEquals($result['source'], users::class); $this->assertNotEmpty($result['table']); $this->assertNotEmpty($result['javascript']); $this->assertTrue($result['filterspresent']); $this->assertNotEmpty($result['filtersform']); $this->assertFalse($result['editmode']); // Confirm editor-specific data is not returned. $this->assertArrayNotHasKey('sidebarmenucards', $result); $this->assertArrayNotHasKey('conditions', $result); $this->assertArrayNotHasKey('filters', $result); $this->assertArrayNotHasKey('sorting', $result); $this->assertArrayNotHasKey('cardview', $result); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); get::execute($report->get('id'), true); } /** * Test execute method for a user without permission to view reports */ public function test_execute_view_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $contextid = context_system::instance()->id; $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); assign_capability('moodle/reportbuilder:view', CAP_PROHIBIT, $roleid, $contextid); role_assign($roleid, $user->id, $contextid); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); get::execute($report->get('id'), false); } } PK a<�\�6n31 1 $ tests/external/reports/view_test.phpnu �[��� <?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\reports; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\event\report_viewed; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\report; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for viewing reports * * @package core_reportbuilder * @covers \core_reportbuilder\external\reports\view * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class view_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Catch the events. $sink = $this->redirectEvents(); $result = view::execute($report->get('id')); $result = external_api::clean_returnvalue(view::execute_returns(), $result); $events = $sink->get_events(); $this->assertCount(1, $events); $sink->close(); $this->assertValidKeys($result, ['status', 'warnings']); $this->assertTrue($result['status']); $this->assertEmpty($result['warnings']); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(report_viewed::class, $event); $this->assertEquals(report::TABLE, $event->objecttable); $this->assertEquals($report->get('id'), $event->objectid); $this->assertEquals($report->get('name'), $event->other['name']); $this->assertEquals($report->get('source'), $event->other['source']); $this->assertEquals($report->get_context()->id, $event->contextid); } /** * Test execute method for a user without permission to view reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); view::execute($report->get('id')); } } PK a<�\%�)&& & ( tests/external/schedules/delete_test.phpnu �[��� <?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\schedules; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for deleting report schedules * * @package core_reportbuilder * @covers \core_reportbuilder\external\schedules\delete * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class delete_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $scheduleid = $schedule->get('id'); $result = delete::execute($report->get('id'), $scheduleid); $result = external_api::clean_returnvalue(delete::execute_returns(), $result); $this->assertTrue($result); $this->assertFalse($schedule::record_exists($scheduleid)); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); delete::execute($report->get('id'), $schedule->get('id')); } } PK a<�\N5��� � ( tests/external/schedules/toggle_test.phpnu �[��� <?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\schedules; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for toggling report schedules * * @package core_reportbuilder * @covers \core_reportbuilder\external\schedules\toggle * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class toggle_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule', 'enabled' => true]); // Confirm initial state. $this->assertTrue($schedule->get('enabled')); $result = toggle::execute($report->get('id'), $schedule->get('id'), false); $result = external_api::clean_returnvalue(toggle::execute_returns(), $result); $this->assertTrue($result); // Check enabled state was toggled. $schedule = $schedule->read(); $this->assertFalse($schedule->get('enabled')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); toggle::execute($report->get('id'), $schedule->get('id'), false); } } PK a<�\Oz"`6 6 & tests/external/schedules/send_test.phpnu �[��� <?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\schedules; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\task\send_schedule; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for sending report schedules * * @package core_reportbuilder * @covers \core_reportbuilder\external\schedules\send * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class send_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $result = send::execute($report->get('id'), $schedule->get('id')); $result = external_api::clean_returnvalue(send::execute_returns(), $result); $this->assertTrue($result); // Assert our adhoc-task was created. $tasks = \core\task\manager::get_adhoc_tasks(send_schedule::class); $this->assertCount(1, $tasks); $this->assertEquals((object) [ 'reportid' => $report->get('id'), 'scheduleid' => $schedule->get('id'), ], reset($tasks)->get_custom_data()); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); send::execute($report->get('id'), $schedule->get('id')); } } PK a<�\ ��� � = tests/external/custom_report_audience_cards_exporter_test.phpnu �[��� <?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 advanced_testcase; use context_system; /** * Unit tests for custom report audience cards exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_audience_cards_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_audience_cards_exporter_test extends advanced_testcase { /** * Test exported data/structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); $exporter = new custom_report_audience_cards_exporter(null); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertNotEmpty($export->menucards); // Test only the site audiences, so tests are unaffected by audiences within components. $menucardsite = array_filter($export->menucards, static function(array $menucard): bool { return $menucard['name'] === get_string('site'); }); $this->assertCount(1, $menucardsite); $menucardsite = reset($menucardsite); $this->assertNotEmpty($menucardsite['key']); $this->assertGreaterThanOrEqual(4, count($menucardsite['items'])); // Test the structure of the first menu card item. $menucarditem = reset($menucardsite['items']); $this->assertEquals([ 'name' => 'All users', 'identifier' => \core_reportbuilder\reportbuilder\audience\allusers::class, 'title' => 'Add audience \'All users\'', 'action' => 'add-audience', 'disabled' => false, ], $menucarditem); } /** * Test exported data when user cannot add some audience types */ public function test_export_audience_user_can_add(): void { global $DB, $PAGE; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); // This capability controls access to the all/manual users audiences. $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); assign_capability('moodle/user:viewalldetails', CAP_ALLOW, $userrole, context_system::instance()); $exporter = new custom_report_audience_cards_exporter(null); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertCount(1, $export->menucards); $this->assertEquals('Site', $export->menucards[0]['name']); $this->assertEquals([ 'All users', 'Manually added users', ], array_column($export->menucards[0]['items'], 'name')); } /** * Test exported data when user can add an audience type, but it isn't available */ public function test_export_audience_is_available(): void { global $DB, $PAGE; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); assign_capability('moodle/cohort:view', CAP_ALLOW, $userrole, context_system::instance()); $exporter = new custom_report_audience_cards_exporter(null); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertCount(1, $export->menucards); $this->assertEquals('Site', $export->menucards[0]['name']); // Cohort audience should be present, but disabled. $this->assertCount(1, $export->menucards[0]['items']); $this->assertEquals('Member of cohort', $export->menucards[0]['items'][0]['name']); $this->assertTrue($export->menucards[0]['items'][0]['disabled']); } } PK a<�\Y4g� � & tests/external/columns/delete_test.phpnu �[��� <?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\columns; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\column; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for deleting report columns * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\delete * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class delete_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add two columns. $columnfullname = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Delete the first column. $result = delete::execute($report->get('id'), $columnfullname->get('id')); $result = external_api::clean_returnvalue(delete::execute_returns(), $result); $this->assertTrue($result['hassortablecolumns']); $this->assertCount(1, $result['sortablecolumns']); $sortablecolumn = reset($result['sortablecolumns']); $this->assertEquals('Email address', $sortablecolumn['title']); $this->assertEquals(SORT_ASC, $sortablecolumn['sortdirection']); $this->assertEquals(0, $sortablecolumn['sortenabled']); $this->assertEquals(2, $sortablecolumn['sortorder']); $this->assertArrayHasKey('sorticon', $sortablecolumn); // Assert report columns. $columns = column::get_records(['reportid' => $report->get('id')]); $this->assertCount(1, $columns); $this->assertEquals('user:email', reset($columns)->get('uniqueidentifier')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); delete::execute($report->get('id'), $column->get('id')); } } PK a<�\��� # tests/external/columns/add_test.phpnu �[��� <?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\columns; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\column; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for adding report columns * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\add * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class add_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add column. $result = add::execute($report->get('id'), 'user:fullname'); $result = external_api::clean_returnvalue(add::execute_returns(), $result); $this->assertTrue($result['hassortablecolumns']); $this->assertCount(1, $result['sortablecolumns']); $sortablecolumn = reset($result['sortablecolumns']); $this->assertEquals('Full name', $sortablecolumn['title']); $this->assertEquals(SORT_ASC, $sortablecolumn['sortdirection']); $this->assertEquals(0, $sortablecolumn['sortenabled']); $this->assertEquals(1, $sortablecolumn['sortorder']); $this->assertArrayHasKey('sorticon', $sortablecolumn); // Assert report columns. $columns = column::get_records(['reportid' => $report->get('id')]); $this->assertCount(1, $columns); $this->assertEquals('user:fullname', reset($columns)->get('uniqueidentifier')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); add::execute($report->get('id'), 'user:fullname'); } } PK a<�\��~� � ' tests/external/columns/reorder_test.phpnu �[��� <?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\columns; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\column; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for re-ordering report columns * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\reorder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class reorder_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add four columns. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $columncity = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city column to second position. $result = reorder::execute($report->get('id'), $columncity->get('id'), 2); $result = external_api::clean_returnvalue(reorder::execute_returns(), $result); $this->assertTrue($result); // Assert report columns order. $columns = column::get_records(['reportid' => $report->get('id')], 'columnorder'); $columnidentifiers = array_map(static function(column $column): string { return $column->get('uniqueidentifier'); }, $columns); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $columnidentifiers); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); reorder::execute($report->get('id'), $column->get('id'), 1); } } PK a<�\���; ; ( tests/external/columns/sort/get_test.phpnu �[��� <?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\columns\sort; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for retrieving report column sorting * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\sort\get * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class get_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add some columns (note 'user:picture' is not a sortable column). $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:picture']); $result = get::execute($report->get('id')); $result = external_api::clean_returnvalue(get::execute_returns(), $result); $this->assertTrue($result['hassortablecolumns']); $sortablecolumntitles = array_column($result['sortablecolumns'], 'title'); $this->assertEquals([ 'Full name', 'Email address', ], $sortablecolumntitles); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); get::execute($report->get('id')); } } PK a<�\6Ut�m m , tests/external/columns/sort/reorder_test.phpnu �[��� <?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\columns\sort; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\column; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for re-ordering report column sorting * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\sort\reorder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class reorder_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add four columns. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $columncity = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city column sort order to second position. $result = reorder::execute($report->get('id'), $columncity->get('id'), 2); $result = external_api::clean_returnvalue(reorder::execute_returns(), $result); $this->assertTrue($result['hassortablecolumns']); $this->assertCount(4, $result['sortablecolumns']); $sortablecolumn = $result['sortablecolumns'][1]; $this->assertEquals('City/town', $sortablecolumn['title']); $this->assertEquals(SORT_ASC, $sortablecolumn['sortdirection']); $this->assertEquals(0, $sortablecolumn['sortenabled']); $this->assertEquals(2, $sortablecolumn['sortorder']); $this->assertArrayHasKey('sorticon', $sortablecolumn); // Assert report column sort order. $columns = column::get_records(['reportid' => $report->get('id')], 'sortorder'); $columnidentifiers = array_map(static function(column $column): string { return $column->get('uniqueidentifier'); }, $columns); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $columnidentifiers); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); reorder::execute($report->get('id'), $column->get('id'), 2); } } PK a<�\���M# # + tests/external/columns/sort/toggle_test.phpnu �[��� <?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\columns\sort; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\column; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for toggling report column sorting * * @package core_reportbuilder * @covers \core_reportbuilder\external\columns\sort\toggle * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class toggle_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Toggle sort descending. $result = toggle::execute($report->get('id'), $column->get('id'), true, SORT_DESC); $result = external_api::clean_returnvalue(toggle::execute_returns(), $result); $this->assertTrue($result['hassortablecolumns']); $this->assertCount(1, $result['sortablecolumns']); $sortablecolumn = reset($result['sortablecolumns']); $this->assertEquals('Email address', $sortablecolumn['title']); $this->assertEquals(SORT_DESC, $sortablecolumn['sortdirection']); $this->assertEquals(1, $sortablecolumn['sortenabled']); $this->assertEquals(1, $sortablecolumn['sortorder']); $this->assertArrayHasKey('sorticon', $sortablecolumn); // Confirm column was updated. $columnupdated = new column($column->get('id')); $this->assertTrue($columnupdated->get('sortenabled')); $this->assertEquals(SORT_DESC, $columnupdated->get('sortdirection')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); toggle::execute($report->get('id'), $column->get('id'), true, SORT_DESC); } } PK a<�\$܄̕ � ) tests/external/conditions/delete_test.phpnu �[��� <?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\conditions; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\filter; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for deleting report conditions * * @package core_reportbuilder * @covers \core_reportbuilder\external\conditions\delete * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class delete_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add two conditions. $conditionfullname = $generator->create_condition([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname', ]); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Delete the first condition. $result = delete::execute($report->get('id'), $conditionfullname->get('id')); $result = external_api::clean_returnvalue(delete::execute_returns(), $result); $this->assertTrue($result['hasactiveconditions']); $this->assertNotEmpty($result['activeconditionsform']); // Assert report conditions. $conditions = filter::get_condition_records($report->get('id')); $this->assertCount(1, $conditions); $this->assertEquals('user:email', reset($conditions)->get('uniqueidentifier')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $condition = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); delete::execute($report->get('id'), $condition->get('id')); } } PK a<�\S$�� ( tests/external/conditions/reset_test.phpnu �[��� <?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\conditions; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\manager; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for resetting report conditions * * @package core_reportbuilder * @covers \core_reportbuilder\external\conditions\reset * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class reset_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $instance = manager::get_report_from_persistent($report); $instance->set_condition_values(['foo' => 'bar']); $result = reset::execute($report->get('id')); $result = external_api::clean_returnvalue(reset::execute_returns(), $result); $this->assertTrue($result['hasactiveconditions']); $this->assertNotEmpty($result['activeconditionsform']); // Re-create the report instance, we should get an empty array back. $secondinstance = manager::get_report_from_persistent($report->read()); $this->assertEquals([], $secondinstance->get_condition_values()); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); reset::execute($report->get('id')); } } PK a<�\ۡ~�� � & tests/external/conditions/add_test.phpnu �[��� <?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\conditions; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\filter; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for adding report conditions * * @package core_reportbuilder * @covers \core_reportbuilder\external\conditions\add * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class add_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add condition. $result = add::execute($report->get('id'), 'user:fullname'); $result = external_api::clean_returnvalue(add::execute_returns(), $result); $this->assertTrue($result['hasactiveconditions']); $this->assertNotEmpty($result['activeconditionsform']); // Assert report conditions. $conditions = filter::get_condition_records($report->get('id')); $this->assertCount(1, $conditions); $this->assertEquals('user:fullname', reset($conditions)->get('uniqueidentifier')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); add::execute($report->get('id'), 'user:fullname'); } } PK a<�\,dN N * tests/external/conditions/reorder_test.phpnu �[��� <?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\conditions; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\filter; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for re-ordering report conditions * * @package core_reportbuilder * @covers \core_reportbuilder\external\conditions\reorder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class reorder_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add four conditions. $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $conditioncity = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city condition to second position. $result = reorder::execute($report->get('id'), $conditioncity->get('id'), 2); $result = external_api::clean_returnvalue(reorder::execute_returns(), $result); $this->assertTrue($result['hasactiveconditions']); $this->assertNotEmpty($result['activeconditionsform']); // Assert report conditions order. $conditions = filter::get_condition_records($report->get('id'), 'filterorder'); $conditionidentifiers = array_map(static function(filter $condition): string { return $condition->get('uniqueidentifier'); }, $conditions); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $conditionidentifiers); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $condition = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); reorder::execute($report->get('id'), $condition->get('id'), 1); } } PK a<�\��p� � 6 tests/external/custom_report_filters_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\helpers\report; use core_course\reportbuilder\datasource\courses; /** * Unit tests for custom report filters exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_filters_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_filters_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => courses::class, 'default' => false]); // Add a couple of filters. $filtercategoryname = $generator->create_filter([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'course_category:name', ]); $filtercourseidnumber = $generator->create_filter([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'course:idnumber', ]); // Move course ID number filter to first place. report::reorder_report_filter($report->get('id'), $filtercourseidnumber->get('id'), 1); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_filters_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertTrue($export->hasavailablefilters); // The root of the available filters property should contain each entity. $this->assertCount(4, $export->availablefilters); [$filterscategory, $filterscourse, $filterstag, $filtersfile] = $export->availablefilters; // Course category filters, assert structure of first item. $this->assertEquals('Course category', $filterscategory['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($filterscategory['optiongroup']['values'])); $this->assertEquals([ 'value' => 'course_category:text', 'visiblename' => 'Category name', ], $filterscategory['optiongroup']['values'][0]); // Course filters, assert structure of first item. $this->assertEquals('Course', $filterscourse['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($filterscourse['optiongroup']['values'])); $this->assertEquals([ 'value' => 'course:fullname', 'visiblename' => 'Course full name', ], $filterscourse['optiongroup']['values'][0]); // Make sure the active filters we added, aren't present in available filters. $filterscourseavailable = array_column($filterscourse['optiongroup']['values'], 'value'); $this->assertNotContains('course_category:name', $filterscourseavailable); $this->assertNotContains('course:idnumber', $filterscourseavailable); // Tag filters, assert structure of first item. $this->assertEquals('Tag', $filterstag['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($filterstag['optiongroup']['values'])); $this->assertEquals([ 'value' => 'tag:name', 'visiblename' => 'Tag name', ], $filterstag['optiongroup']['values'][0]); // File filters, assert structure of first item. $this->assertEquals('Course image', $filtersfile['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($filtersfile['optiongroup']['values'])); $this->assertEquals([ 'value' => 'file:name', 'visiblename' => 'Filename', ], $filtersfile['optiongroup']['values'][0]); $this->assertTrue($export->hasactivefilters); $this->assertCount(2, $export->activefilters); [$activefiltercourseidnumber, $activefiltercategoryname] = $export->activefilters; // Course ID number filter. $this->assertEquals($filtercourseidnumber->get('id'), $activefiltercourseidnumber['id']); $this->assertEquals('Course', $activefiltercourseidnumber['entityname']); $this->assertEquals('Course ID number', $activefiltercourseidnumber['heading']); $this->assertEquals(1, $activefiltercourseidnumber['sortorder']); // Course category filter. $this->assertEquals($filtercategoryname->get('id'), $activefiltercategoryname['id']); $this->assertEquals('Course category', $activefiltercategoryname['entityname']); $this->assertEquals('Select category', $activefiltercategoryname['heading']); $this->assertEquals(2, $activefiltercategoryname['sortorder']); $this->assertNotEmpty($export->helpicon); } /** * Test exported data structure for report with no filters */ public function test_export_no_filters(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => courses::class, 'default' => false]); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_filters_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertFalse($export->hasactivefilters); $this->assertEmpty($export->activefilters); } } PK a<�\e�7] 9 tests/external/custom_report_conditions_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_course\reportbuilder\datasource\courses; /** * Unit tests for custom report conditions exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_conditions_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_conditions_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => courses::class, 'default' => false]); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:shortname']); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_conditions_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertTrue($export->hasavailableconditions); // The root of the available conditions property should contain each entity. $this->assertCount(4, $export->availableconditions); [$conditionscategory, $conditionscourse, $conditionstag, $conditionsfile] = $export->availableconditions; // Course category conditions, assert structure of first item. $this->assertEquals('Course category', $conditionscategory['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($conditionscategory['optiongroup']['values'])); $this->assertEquals([ 'value' => 'course_category:name', 'visiblename' => 'Select category', ], $conditionscategory['optiongroup']['values'][0]); // Course conditions, assert structure of first item. $this->assertEquals('Course', $conditionscourse['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($conditionscourse['optiongroup']['values'])); $this->assertEquals([ 'value' => 'course:fullname', 'visiblename' => 'Course full name', ], $conditionscourse['optiongroup']['values'][0]); // Make sure the active condition we added, isn't present in available conditions. $this->assertNotContains('course:shortname', array_column($conditionscourse['optiongroup']['values'], 'value')); // Tag conditions, assert structure of first item. $this->assertEquals('Tag', $conditionstag['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($conditionstag['optiongroup']['values'])); $this->assertEquals([ 'value' => 'tag:name', 'visiblename' => 'Tag name', ], $conditionstag['optiongroup']['values'][0]); // File conditions, assert structure of first item. $this->assertEquals('Course image', $conditionsfile['optiongroup']['text']); $this->assertGreaterThanOrEqual(1, count($conditionsfile['optiongroup']['values'])); $this->assertEquals([ 'value' => 'file:name', 'visiblename' => 'Filename', ], $conditionsfile['optiongroup']['values'][0]); // The active conditions are contained inside form HTML, just assert there's something present. $this->assertTrue($export->hasactiveconditions); $this->assertNotEmpty($export->activeconditionsform); $this->assertNotEmpty($export->helpicon); } /** * Test exported data structure for report with no conditions */ public function test_export_no_conditions(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => courses::class, 'default' => false]); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_conditions_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertFalse($export->hasactiveconditions); $this->assertEmpty($export->activeconditionsform); } } PK a<�\�L��� � 3 tests/external/custom_report_data_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_user\reportbuilder\datasource\users; /** * Unit tests for custom report data exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_data_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_data_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); $this->getDataGenerator()->create_user(['firstname' => 'Zoe', 'lastname' => 'Zebra', 'email' => 'u1@example.com']); $this->getDataGenerator()->create_user(['firstname' => 'Charlie', 'lastname' => 'Carrot', 'email' => 'u2@example.com']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname', 'heading' => 'Lovely user', 'sortenabled' => 1, ]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_data_exporter(null, ['report' => $reportinstance, 'page' => 0, 'perpage' => 2]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); // There are three users (admin plus the two previouly created), but we're paging the first two only. $this->assertEquals(['Lovely user', 'Email address'], $export->headers); $this->assertEquals([ [ 'columns' => ['Admin User', 'admin@example.com'], ], [ 'columns' => ['Charlie Carrot', 'u2@example.com'], ], ], $export->rows); $this->assertEquals(3, $export->totalrowcount); } } PK a<�\��z z & tests/external/filters/delete_test.phpnu �[��� <?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\filters; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\filter; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for deleting report filters * * @package core_reportbuilder * @covers \core_reportbuilder\external\filters\delete * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class delete_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add two filters. $filterfullname = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Delete the first filter. $result = delete::execute($report->get('id'), $filterfullname->get('id')); $result = external_api::clean_returnvalue(delete::execute_returns(), $result); $this->assertTrue($result['hasavailablefilters']); $this->assertEquals('User', $result['availablefilters'][0]['optiongroup']['text']); $this->assertNotEmpty($result['availablefilters'][0]['optiongroup']['values']); $this->assertTrue($result['hasactivefilters']); $this->assertCount(1, $result['activefilters']); $this->assertEquals('Email address', $result['activefilters'][0]['heading']); // Assert report filters. $filters = filter::get_filter_records($report->get('id')); $this->assertCount(1, $filters); $this->assertEquals('user:email', reset($filters)->get('uniqueidentifier')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); delete::execute($report->get('id'), $filter->get('id')); } } PK a<�\�!B� % tests/external/filters/reset_test.phpnu �[��� <?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\filters; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\exception\report_access_exception; use core_external\external_api; use externallib_advanced_testcase; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests external filters reset class * * @package core_reportbuilder * @covers \core_reportbuilder\external\filters\reset * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class reset_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $instance = manager::get_report_from_persistent($report); $instance->set_filter_values([ 'entity:filter_operator' => 'something', 'entity:filter_value' => 42, ]); $result = reset::execute($report->get('id')); $result = external_api::clean_returnvalue(reset::execute_returns(), $result); $this->assertTrue($result); // We should get an empty array back. $this->assertEquals([], $instance->get_filter_values()); } /** * Test execute method for a user without permission to view the report */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); reset::execute($report->get('id')); } } PK a<�\`�^ � � # tests/external/filters/add_test.phpnu �[��� <?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\filters; use core_reportbuilder\manager; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\filter; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for adding report filters * * @package core_reportbuilder * @covers \core_reportbuilder\external\filters\add * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class add_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add filter. $result = add::execute($report->get('id'), 'user:fullname'); $result = external_api::clean_returnvalue(add::execute_returns(), $result); $this->assertTrue($result['hasavailablefilters']); $this->assertEquals('User', $result['availablefilters'][0]['optiongroup']['text']); $this->assertNotEmpty($result['availablefilters'][0]['optiongroup']['values']); $this->assertTrue($result['hasactivefilters']); $this->assertCount(1, $result['activefilters']); $this->assertEquals('Full name', $result['activefilters'][0]['heading']); // Assert report filters. $filters = filter::get_filter_records($report->get('id')); $this->assertCount(1, $filters); $this->assertEquals('user:fullname', reset($filters)->get('uniqueidentifier')); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); add::execute($report->get('id'), 'user:fullname'); } } PK a<�\qxĺ� � ' tests/external/filters/reorder_test.phpnu �[��� <?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\filters; use core_reportbuilder_generator; use core_external\external_api; use externallib_advanced_testcase; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder\local\models\filter; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests of external class for re-ordering report filters * * @package core_reportbuilder * @covers \core_reportbuilder\external\filters\reorder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class reorder_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add four filters. $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $filtercity = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city filter to second position. $result = reorder::execute($report->get('id'), $filtercity->get('id'), 2); $result = external_api::clean_returnvalue(reorder::execute_returns(), $result); $this->assertTrue($result['hasavailablefilters']); $this->assertEquals('User', $result['availablefilters'][0]['optiongroup']['text']); $this->assertNotEmpty($result['availablefilters'][0]['optiongroup']['values']); $this->assertTrue($result['hasactivefilters']); $this->assertCount(4, $result['activefilters']); // Assert report filters order. $filters = filter::get_filter_records($report->get('id'), 'filterorder'); $filteridentifiers = array_map(static function(filter $filter): string { return $filter->get('uniqueidentifier'); }, $filters); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $filteridentifiers); } /** * Test execute method for a user without permission to edit reports */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); reorder::execute($report->get('id'), $filter->get('id'), 1); } } PK a<�\�Gֱ* * # tests/external/filters/set_test.phpnu �[��� <?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\filters; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\exception\report_access_exception; use core_external\external_api; use externallib_advanced_testcase; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/webservice/tests/helpers.php"); /** * Unit tests external filters set class * * @package core_reportbuilder * @covers \core_reportbuilder\external\filters\set * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class set_test extends externallib_advanced_testcase { /** * Text execute method */ public function test_execute(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $values = [ 'entity:filter_operator' => 'something', 'entity:filter_value' => 42, ]; $result = set::execute($report->get('id'), '', json_encode($values)); $result = external_api::clean_returnvalue(set::execute_returns(), $result); $this->assertTrue($result); // We should get our original filter values back. $instance = manager::get_report_from_persistent($report); $this->assertEquals($values, $instance->get_filter_values()); } /** * Test execute method for a user without permission to view the report */ public function test_execute_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); set::execute($report->get('id'), '', json_encode(['foo' => 1])); } } PK a<�\Ͷ� 3 tests/external/system_report_data_exporter_test.phpnu �[��� <?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 advanced_testcase; use core\context\system; use core_reportbuilder_generator; use core_reportbuilder\system_report_factory; use core_reportbuilder\local\systemreports\reports_list; use core_user\reportbuilder\datasource\users; /** * Unit tests for system report data exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\system_report_data_exporter * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class system_report_data_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Two reports, created one second apart to ensure consistent ordering by time created. $generator->create_report(['name' => 'My first report', 'source' => users::class]); $this->waitForSecond(); $generator->create_report(['name' => 'My second report', 'source' => users::class, 'tags' => ['cat', 'dog']]); $reportinstance = system_report_factory::create(reports_list::class, system::instance()); $exporter = new system_report_data_exporter(null, ['report' => $reportinstance, 'page' => 0, 'perpage' => 1]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertEquals([ 'Name', 'Report source', 'Tags', 'Time created', 'Time modified', 'Modified by', ], $export->headers); $this->assertCount(1, $export->rows); [$name, $source, $tags, $timecreated, $timemodified, $modifiedby] = $export->rows[0]['columns']; $this->assertStringContainsString('My second report', $name); $this->assertEquals(users::get_name(), $source); $this->assertEquals('cat, dog', $tags); $this->assertNotEmpty($timecreated); $this->assertNotEmpty($timemodified); $this->assertEquals('Admin User', $modifiedby); $this->assertEquals(2, $export->totalrowcount); } } PK a<�\� y�� � . tests/external/system_report_exporter_test.phpnu �[��� <?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 advanced_testcase; use context_system; use moodle_url; use core_reportbuilder\system_report_available; use core_reportbuilder\system_report_factory; /** * Unit tests for system report exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\system_report_exporter * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class system_report_exporter_test extends advanced_testcase { /** * Load test fixture */ public static function setUpBeforeClass(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); parent::setUpBeforeClass(); } /** * Data provider for {@see test_export} * * @return array[] */ public static function export_provider(): array { return [ ['With filters' => true], ['Without filters' => false], ]; } /** * Text execute method * * @param bool $withfilters * * @dataProvider export_provider */ public function test_export(bool $withfilters): void { global $PAGE; $this->resetAfterTest(); // Prevent debug warnings from flexible_table. $PAGE->set_url(new moodle_url('/')); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance(), '', '', 0, ['withfilters' => $withfilters])->add_attributes(['data-foo' => 'bar', 'data-another' => '1']); $exporter = new system_report_exporter($systemreport->get_report_persistent(), [ 'source' => $systemreport, 'parameters' => json_encode($systemreport->get_parameters()), ]); $data = $exporter->export($PAGE->get_renderer('core_reportbuilder')); $this->assertNotEmpty($data->table); if ($withfilters) { $this->assertEquals('{"withfilters":true}', $data->parameters); $this->assertTrue($data->filterspresent); $this->assertNotEmpty($data->filtersform); } else { $this->assertEquals('{"withfilters":false}', $data->parameters); $this->assertFalse($data->filterspresent); $this->assertEmpty($data->filtersform); } $this->assertEquals([ ['name' => 'data-foo', 'value' => 'bar'], ['name' => 'data-another', 'value' => '1'] ], $data->attributes); } } PK a<�\3PL� � ; tests/external/custom_report_column_cards_exporter_test.phpnu �[��� <?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 advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_course\reportbuilder\datasource\courses; /** * Unit tests for custom report column cards exporter * * @package core_reportbuilder * @covers \core_reportbuilder\external\custom_report_column_cards_exporter * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_report_column_cards_exporter_test extends advanced_testcase { /** * Test exported data structure */ public function test_export(): void { global $PAGE; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => courses::class]); $reportinstance = manager::get_report_from_persistent($report); $exporter = new custom_report_column_cards_exporter(null, ['report' => $reportinstance]); $export = $exporter->export($PAGE->get_renderer('core_reportbuilder')); // The root of the menu cards property should contain each entity. $this->assertCount(4, $export->menucards); [$menucardcategory, $menucardcourse, $menucardtag, $menucardfile] = $export->menucards; // Course category entity menu card. $this->assertEquals('Course category', $menucardcategory['name']); $this->assertEquals('course_category', $menucardcategory['key']); $this->assertNotEmpty($menucardcategory['items']); // Test the structure of the first menu card item. $menucarditem = reset($menucardcategory['items']); $this->assertEquals([ 'name' => 'Category name', 'identifier' => 'course_category:name', 'title' => 'Add column \'Category name\'', 'action' => 'report-add-column', ], $menucarditem); // Course entity menu card. $this->assertEquals('Course', $menucardcourse['name']); $this->assertEquals('course', $menucardcourse['key']); $this->assertNotEmpty($menucardcourse['items']); // Test the structure of the first menu card item. $menucarditem = reset($menucardcourse['items']); $this->assertEquals([ 'name' => 'Course full name with link', 'identifier' => 'course:coursefullnamewithlink', 'title' => 'Add column \'Course full name with link\'', 'action' => 'report-add-column', ], $menucarditem); // Tag entity menu card. $this->assertEquals('Tag', $menucardtag['name']); $this->assertEquals('tag', $menucardtag['key']); $this->assertNotEmpty($menucardtag['items']); // Test the structure of the first menu card item. $menucarditem = reset($menucardtag['items']); $this->assertEquals([ 'name' => 'Tag name', 'identifier' => 'tag:name', 'title' => 'Add column \'Tag name\'', 'action' => 'report-add-column', ], $menucarditem); // File entity menu card. $this->assertEquals('Course image', $menucardfile['name']); $this->assertEquals('file', $menucardfile['key']); $this->assertNotEmpty($menucardfile['items']); // Test the structure of the first menu card item. $menucarditem = reset($menucardfile['items']); $this->assertEquals([ 'name' => 'Filename', 'identifier' => 'file:name', 'title' => 'Add column \'Filename\'', 'action' => 'report-add-column', ], $menucarditem); } } PK a<�\v���� � tests/lib_test.phpnu �[��� <?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; use advanced_testcase; use core_reportbuilder_generator; use core_tag_tag; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); global $CFG; require_once("{$CFG->dirroot}/reportbuilder/lib.php"); /** * Unit tests for the component callbacks * * @package core_reportbuilder * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class lib_test extends advanced_testcase { /** * Test getting tagged reports * * @covers ::core_reportbuilder_get_tagged_reports */ public function test_core_reportbuilder_get_tagged_reports(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create three tagged reports. $reportone = $generator->create_report(['name' => 'Report 1', 'source' => users::class, 'tags' => ['cat']]); $reporttwo = $generator->create_report(['name' => 'Report 2', 'source' => users::class, 'tags' => ['dog']]); $reportthree = $generator->create_report(['name' => 'Report 3', 'source' => users::class, 'tags' => ['cat']]); // Add all users audience to report one and two. $generator->create_audience(['reportid' => $reportone->get('id'), 'configdata' => []]); $generator->create_audience(['reportid' => $reporttwo->get('id'), 'configdata' => []]); $tag = core_tag_tag::get_by_name(0, 'cat'); // Current user can only access report one with "cat" tag. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $tagindex = core_reportbuilder_get_tagged_reports($tag); $this->assertStringContainsString($reportone->get_formatted_name(), $tagindex->content); $this->assertStringNotContainsString($reporttwo->get_formatted_name(), $tagindex->content); $this->assertStringNotContainsString($reportthree->get_formatted_name(), $tagindex->content); // Admin can access both reports with "cat" tag. $this->setAdminUser(); $tagindex = core_reportbuilder_get_tagged_reports($tag); $this->assertStringContainsString($reportone->get_formatted_name(), $tagindex->content); $this->assertStringNotContainsString($reporttwo->get_formatted_name(), $tagindex->content); $this->assertStringContainsString($reportthree->get_formatted_name(), $tagindex->content); } } PK a<�\�=�� , tests/fixtures/system_report_unavailable.phpnu �[��� <?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; defined('MOODLE_INTERNAL') || die(); require_once(__DIR__ . '/system_report_available.php'); /** * Testable unavailable system report fixture * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_unavailable extends system_report_available { /** * Explicitly set availability of report to false * * @return bool */ public static function is_available(): bool { return false; } } PK a<�\nr*N� � * tests/fixtures/system_report_available.phpnu �[��� <?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; use core_reportbuilder\local\report\action; use lang_string; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; use moodle_url; use pix_icon; /** * Testable system report fixture * * @package core_reportbuilder * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class system_report_available extends system_report { /** * Initialise the report */ protected function initialise(): void { $this->set_main_table('user', 'u'); $this->annotate_entity('user', new lang_string('user')); $this->add_column((new column( 'username', new lang_string('username'), 'user' )) ->add_joins($this->get_joins()) ->add_field('u.firstname') ); $withfilters = $this->get_parameter('withfilters', false, PARAM_BOOL); if ($withfilters) { $this->add_filter((new filter( text::class, 'username', new lang_string('username'), 'user', 'u.username' )) ->add_joins($this->get_joins()) ); } $withactions = $this->get_parameter('withactions', false, PARAM_BOOL); if ($withactions) { $this->add_action(new action( new moodle_url('/user/profile.php', ['id' => ':id']), new pix_icon('e/search', get_string('view')), [], true, )); } } /** * Ensure we can view the report * * @return bool */ protected function can_view(): bool { return true; } /** * Explicitly set availability of report * * @return bool */ public static function is_available(): bool { return true; } } PK a<�\��g / tests/fixtures/testable_system_report_table.phpnu �[��� <?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; use stdClass; use core_reportbuilder\table\system_report_table; /** * Testable system report table for getting report data * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class testable_system_report_table extends system_report_table { /** * Format each row of returned data, replacing aliased column names with the original * * @param array|stdClass $row * @return array */ public function format_row($row): array { $record = parent::format_row($row); $result = []; $columns = $this->report->get_columns(); foreach ($columns as $column) { $result[$column->get_name()] = $record[$column->get_column_alias()]; } return $result; } /** * Return all table rows * * @return array */ public function get_table_rows(): array { global $PAGE; $PAGE->set_url('/'); $result = []; $this->guess_base_url(); $this->setup(); $this->query_db(0, false); foreach ($this->rawdata as $record) { $result[] = $this->format_row($record); } $this->close_recordset(); return $result; } } PK a<�\J<7 * tests/output/report_name_editable_test.phpnu �[��� <?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\output; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; /** * Unit tests for the report name editable class * * @package core_reportbuilder * @covers \core_reportbuilder\output\report_name_editable * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class report_name_editable_test extends advanced_testcase { /** * Test update method */ public function test_update(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $editable = report_name_editable::update($report->get('id'), 'New name'); $result = $editable->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('New name', $result['value']); // Reload persistent, assert update. $this->assertEquals('New name', $report->read()->get('name')); } /** * Test update method for a user without permission to edit reports */ public function test_update_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); report_name_editable::update($report->get('id'), 'New name'); } /** * Test update method via component callback * * @covers ::core_reportbuilder_inplace_editable */ public function test_update_callback(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $params = ['reportname', $report->get('id'), 'New name']; $editable = component_callback('core_reportbuilder', 'inplace_editable', $params); $this->assertInstanceOf(report_name_editable::class, $editable); // Reload persistent, assert update. $this->assertEquals('New name', $report->read()->get('name')); } } PK a<�\� �ų � 1 tests/output/column_aggregation_editable_test.phpnu �[��� <?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\output; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; /** * Unit tests for the column aggregation editable class * * @package core_reportbuilder * @covers \core_reportbuilder\output\column_aggregation_editable * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class column_aggregation_editable_test extends advanced_testcase { /** * Test update method */ public function test_update(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $editable = column_aggregation_editable::update($column->get('id'), 'count'); $result = $editable->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('count', $result['value']); // Reload persistent, assert update. $this->assertEquals('count', $column->read()->get('aggregation')); } /** * Test update method for a user without permission to edit reports */ public function test_update_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); column_aggregation_editable::update($column->get('id'), 'New name'); } /** * Test update method via component callback * * @covers ::core_reportbuilder_inplace_editable */ public function test_update_callback(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $params = ['columnaggregation', $column->get('id'), 'count']; $editable = component_callback('core_reportbuilder', 'inplace_editable', $params); $this->assertInstanceOf(column_aggregation_editable::class, $editable); // Reload persistent, assert update. $this->assertEquals('count', $column->read()->get('aggregation')); } } PK a<�\��Qמ � - tests/output/filter_heading_editable_test.phpnu �[��� <?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\output; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; /** * Unit tests for the filter heading editable class * * @package core_reportbuilder * @covers \core_reportbuilder\output\filter_heading_editable * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class filter_heading_editable_test extends advanced_testcase { /** * Test update method */ public function test_update(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $editable = filter_heading_editable::update($filter->get('id'), 'New name'); $result = $editable->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('New name', $result['value']); // Reload persistent, assert update. $this->assertEquals('New name', $filter->read()->get('heading')); } /** * Test update method for a user without permission to edit reports */ public function test_update_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); filter_heading_editable::update($filter->get('id'), 'New name'); } /** * Test update method via component callback * * @covers ::core_reportbuilder_inplace_editable */ public function test_update_callback(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $params = ['filterheading', $filter->get('id'), 'New name']; $editable = component_callback('core_reportbuilder', 'inplace_editable', $params); $this->assertInstanceOf(filter_heading_editable::class, $editable); // Reload persistent, assert update. $this->assertEquals('New name', $filter->read()->get('heading')); } } PK a<�\�د} } , tests/output/schedule_name_editable_test.phpnu �[��� <?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\output; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; /** * Unit tests for the schedule name editable class * * @package core_reportbuilder * @covers \core_reportbuilder\output\schedule_name_editable * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class schedule_name_editable_test extends advanced_testcase { /** * Test update method */ public function test_update(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $editable = schedule_name_editable::update($schedule->get('id'), 'New name'); $result = $editable->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('New name', $result['value']); // Reload persistent, assert update. $this->assertEquals('New name', $schedule->read()->get('name')); } /** * Test update method for a user without permission to edit reports */ public function test_update_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); schedule_name_editable::update($schedule->get('id'), 'New name'); } /** * Test update method via component callback * * @covers ::core_reportbuilder_inplace_editable */ public function test_update_callback(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $params = ['schedulename', $schedule->get('id'), 'New name']; $editable = component_callback('core_reportbuilder', 'inplace_editable', $params); $this->assertInstanceOf(schedule_name_editable::class, $editable); // Reload persistent, assert update. $this->assertEquals('New name', $schedule->read()->get('name')); } } PK a<�\��˼� � - tests/output/column_heading_editable_test.phpnu �[��� <?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\output; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; /** * Unit tests for the column heading editable class * * @package core_reportbuilder * @covers \core_reportbuilder\output\column_heading_editable * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class column_heading_editable_test extends advanced_testcase { /** * Test update method */ public function test_update(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $editable = column_heading_editable::update($column->get('id'), 'New name'); $result = $editable->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('New name', $result['value']); // Reload persistent, assert update. $this->assertEquals('New name', $column->read()->get('heading')); } /** * Test update method for a user without permission to edit reports */ public function test_update_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); column_heading_editable::update($column->get('id'), 'New name'); } /** * Test update method via component callback * * @covers ::core_reportbuilder_inplace_editable */ public function test_update_callback(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $params = ['columnheading', $column->get('id'), 'New name']; $editable = component_callback('core_reportbuilder', 'inplace_editable', $params); $this->assertInstanceOf(column_heading_editable::class, $editable); // Reload persistent, assert update. $this->assertEquals('New name', $column->read()->get('heading')); } } PK a<�\6�N / tests/output/audience_heading_editable_test.phpnu �[��� <?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\output; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\exception\report_access_exception; use core_user\reportbuilder\datasource\users; /** * Unit tests for the audience heading editable class * * @package core_reportbuilder * @covers \core_reportbuilder\output\audience_heading_editable * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class audience_heading_editable_test extends advanced_testcase { /** * Test update method */ public function test_update(): void { global $PAGE; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $persistent = $audience->get_persistent(); $editable = audience_heading_editable::update($persistent->get('id'), 'New name'); $result = $editable->export_for_template($PAGE->get_renderer('core')); $this->assertEquals('New name', $result['value']); // Reload persistent, assert update. $this->assertEquals('New name', $persistent->read()->get('heading')); } /** * Test update method for a user without permission to edit reports */ public function test_update_access_exception(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); audience_heading_editable::update($audience->get_persistent()->get('id'), 'New name'); } /** * Test update method via component callback * * @covers ::core_reportbuilder_inplace_editable */ public function test_update_callback(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $persistent = $audience->get_persistent(); $params = ['audienceheading', $persistent->get('id'), 'New name']; $editable = component_callback('core_reportbuilder', 'inplace_editable', $params); $this->assertInstanceOf(audience_heading_editable::class, $editable); // Reload persistent, assert update. $this->assertEquals('New name', $persistent->read()->get('heading')); } } PK a<�\���15 15 tests/privacy/provider_test.phpnu �[��� <?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\privacy; use context_system; use core_privacy\local\metadata\collection; use core_privacy\local\metadata\types\database_table; use core_privacy\local\metadata\types\user_preference; use core_privacy\local\request\userlist; use core_privacy\local\request\writer; use core_privacy\tests\provider_testcase; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\helpers\user_filter_manager; use core_reportbuilder\local\models\audience; use core_reportbuilder\local\models\column; use core_reportbuilder\local\models\filter; use core_reportbuilder\local\models\report; use core_reportbuilder\local\models\schedule; use core_user\reportbuilder\datasource\users; /** * Unit tests for privacy provider * * @package core_reportbuilder * @covers \core_reportbuilder\privacy\provider * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class provider_test extends provider_testcase { /** * Test provider metadata */ public function test_get_metadata(): void { $collection = new collection('core_reportbuilder'); $metadata = provider::get_metadata($collection)->get_collection(); $this->assertCount(6, $metadata); $this->assertInstanceOf(database_table::class, $metadata[0]); $this->assertEquals(report::TABLE, $metadata[0]->get_name()); $this->assertInstanceOf(database_table::class, $metadata[1]); $this->assertEquals(column::TABLE, $metadata[1]->get_name()); $this->assertInstanceOf(database_table::class, $metadata[2]); $this->assertEquals(filter::TABLE, $metadata[2]->get_name()); $this->assertInstanceOf(database_table::class, $metadata[3]); $this->assertEquals(audience::TABLE, $metadata[3]->get_name()); $this->assertInstanceOf(database_table::class, $metadata[4]); $this->assertEquals(schedule::TABLE, $metadata[4]->get_name()); $this->assertInstanceOf(user_preference::class, $metadata[5]); } /** * Test getting contexts for user who created a report */ public function test_get_contexts_for_userid_report(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $generator->create_report(['name' => 'Users', 'source' => users::class]); $contextlist = $this->get_contexts_for_userid((int) $user->id, 'core_reportbuilder'); $this->assertCount(1, $contextlist); $this->assertInstanceOf(context_system::class, $contextlist->current()); } /** * Test getting contexts for user who created an audience for a report by another user */ public function test_get_contexts_for_userid_audience(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class]); // Switch user, create a report audience. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $contextlist = $this->get_contexts_for_userid((int) $user->id, 'core_reportbuilder'); $this->assertCount(1, $contextlist); $this->assertInstanceOf(context_system::class, $contextlist->current()); } /** * Test getting contexts for user who created a schedule for a report by another user */ public function test_get_contexts_for_userid_schedule(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class]); // Switch user, create a report schedule. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $contextlist = $this->get_contexts_for_userid((int) $user->id, 'core_reportbuilder'); $this->assertCount(1, $contextlist); $this->assertInstanceOf(context_system::class, $contextlist->current()); } /** * Test getting users in given context */ public function test_get_users_in_context(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Switch user, create a report. $reportuser = $this->getDataGenerator()->create_user(); $this->setUser($reportuser); $report = $generator->create_report(['name' => 'Users', 'source' => users::class]); // Switch user, create a report audience. $audienceuser = $this->getDataGenerator()->create_user(); $this->setUser($audienceuser); $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); // Switch user, create a report schedule. $scheduleuser = $this->getDataGenerator()->create_user(); $this->setUser($scheduleuser); $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $userlist = new userlist(context_system::instance(), 'core_reportbuilder'); provider::get_users_in_context($userlist); $this->assertEqualsCanonicalizing([ $reportuser->id, $audienceuser->id, $scheduleuser->id, ], $userlist->get_userids()); } /** * Test export of user data */ public function test_export_user_data(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create some report elements for the user. $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => [], 'heading' => 'Beans']); $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'audiences' => json_encode([$audience->get_persistent()->get('id')]), 'name' => 'My schedule', ]); $context = context_system::instance(); $this->export_context_data_for_user((int) $user->id, $context, 'core_reportbuilder'); /** @var \core_privacy\tests\request\content_writer $writer */ $writer = writer::with_context($context); $this->assertTrue($writer->has_any_data()); $subcontext = provider::get_export_subcontext($report); // Exported report data. $reportdata = $writer->get_data($subcontext); $this->assertEquals($report->get_formatted_name(), $reportdata->name); $this->assertEquals(users::get_name(), $reportdata->source); $this->assertEquals($user->id, $reportdata->usercreated); $this->assertEquals($user->id, $reportdata->usermodified); $this->assertNotEmpty($reportdata->timecreated); $this->assertNotEmpty($reportdata->timemodified); // Exported audience data. $audiencedata = $writer->get_related_data($subcontext, 'audiences')->data; $this->assertCount(1, $audiencedata); $audiencedata = reset($audiencedata); $audiencepersistent = $audience->get_persistent(); $audienceclassname = $audiencepersistent->get('classname'); $this->assertEquals($audienceclassname::instance()->get_name(), $audiencedata->classname); $this->assertEquals($audiencepersistent->get('configdata'), $audiencedata->configdata); $this->assertEquals($audiencepersistent->get_formatted_heading(), $audiencedata->heading); $this->assertEquals($user->id, $audiencedata->usercreated); $this->assertEquals($user->id, $audiencedata->usermodified); $this->assertNotEmpty($audiencedata->timecreated); $this->assertNotEmpty($audiencedata->timemodified); // Exported schedule data. $scheduledata = $writer->get_related_data($subcontext, 'schedules')->data; $this->assertCount(1, $scheduledata); $scheduledata = reset($scheduledata); $this->assertEquals($schedule->get_formatted_name(), $scheduledata->name); $this->assertEquals('Yes', $scheduledata->enabled); $this->assertEquals('Comma separated values (.csv)', $scheduledata->format); $this->assertNotEmpty($scheduledata->timescheduled); $this->assertEquals('None', $scheduledata->recurrence); $this->assertEquals('Schedule creator', $scheduledata->userviewas); $this->assertEquals(json_encode([$audiencepersistent->get('id')]), $scheduledata->audiences); $this->assertEquals($schedule->get('subject'), $scheduledata->subject); $this->assertEquals(format_text($schedule->get('message'), $schedule->get('messageformat')), $scheduledata->message); $this->assertEquals('Send message with empty report', $scheduledata->reportempty); $this->assertEquals($user->id, $scheduledata->usercreated); $this->assertEquals($user->id, $scheduledata->usermodified); $this->assertNotEmpty($scheduledata->timecreated); $this->assertNotEmpty($scheduledata->timemodified); } /** * Test export of user data where there is nothing to export */ public function test_export_user_data_empty(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $context = context_system::instance(); $this->export_context_data_for_user((int) $user->id, $context, 'core_reportbuilder'); $this->assertFalse(writer::with_context($context)->has_any_data()); } /** * Test to check export_user_preferences. */ public function test_export_user_preferences(): void { $this->resetAfterTest(); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $this->setUser($user1); // Create report and set some filters for the user. $report1 = manager::create_report_persistent((object) [ 'type' => 1, 'source' => 'class', ]); $filtervalues1 = [ 'task_log:name_operator' => 0, 'task_log:name_value' => 'My task logs', ]; user_filter_manager::set($report1->get('id'), $filtervalues1); // Add a filter for user2. $filtervalues1user2 = [ 'task_log:name_operator' => 0, 'task_log:name_value' => 'My task logs user2', ]; user_filter_manager::set($report1->get('id'), $filtervalues1user2, (int)$user2->id); // Create a second report and set some filters for the user. $report2 = manager::create_report_persistent((object) [ 'type' => 1, 'source' => 'class', ]); $filtervalues2 = [ 'config_change:setting_operator' => 0, 'config_change:setting_value' => str_repeat('A', 3000), ]; user_filter_manager::set($report2->get('id'), $filtervalues2); // Switch to admin user (so we can validate preferences of our test user are still exported). $this->setAdminUser(); // Export user preferences. provider::export_user_preferences((int)$user1->id); $writer = writer::with_context(context_system::instance()); $prefs = $writer->get_user_preferences('core_reportbuilder'); // Check that user preferences only contain the 2 preferences from user1. $this->assertCount(2, (array)$prefs); // Check that exported user preferences for report1 are correct. $report1key = 'reportbuilder-report-' . $report1->get('id'); $this->assertEquals(json_encode($filtervalues1, JSON_PRETTY_PRINT), $prefs->$report1key->value); // Check that exported user preferences for report2 are correct. $report2key = 'reportbuilder-report-' . $report2->get('id'); $this->assertEquals(json_encode($filtervalues2, JSON_PRETTY_PRINT), $prefs->$report2key->value); } } PK a<�\3�Pd2 d2 tests/datasource_test.phpnu �[��� <?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/>. /** * Unit tests for base datasource * * @package core_reportbuilder * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); namespace core_reportbuilder; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\local\entities\base; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\report\{column, filter}; use lang_string; use ReflectionClass; defined('MOODLE_INTERNAL') || die(); /** * Unit tests for base datasource * * @package core_reportbuilder * @coversDefaultClass \core_reportbuilder\datasource * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class datasource_test extends advanced_testcase { /** * Data provider for {@see test_add_columns_from_entity} * * @return array[] */ public static function add_columns_from_entity_provider(): array { return [ 'All columns' => [ [], [], 4, ], 'Include columns (first, extra1, extra2)' => [ ['first', 'extra*'], [], 3, ], 'Exclude columns (first, extra1, extra2)' => [ [], ['first', 'extra*'], 1, ], ]; } /** * Test adding columns from entity * * @param string[] $include * @param string[] $exclude * @param int $expectedcount * * @covers ::add_columns_from_entity * * @dataProvider add_columns_from_entity_provider */ public function test_add_columns_from_entity( array $include, array $exclude, int $expectedcount, ): void { $instance = $this->get_datasource_test_source(); $method = (new ReflectionClass($instance))->getMethod('add_columns_from_entity'); $method->invoke($instance, 'datasource_test_entity', $include, $exclude); // Get all our entity columns. $columns = array_filter( $instance->get_columns(), fn(string $columnname) => strpos($columnname, 'datasource_test_entity:') === 0, ARRAY_FILTER_USE_KEY, ); $this->assertCount($expectedcount, $columns); } /** * Data provider for {@see test_add_filters_from_entity} * * @return array[] */ public static function add_filters_from_entity_provider(): array { return [ 'All filters' => [ [], [], 4, ], 'Include filters (first, extra1, extra2)' => [ ['first', 'extra*'], [], 3, ], 'Exclude filters (first, extra1, extra2)' => [ [], ['first', 'extra*'], 1, ], ]; } /** * Test adding filters from entity * * @param string[] $include * @param string[] $exclude * @param int $expectedcount * * @covers ::add_filters_from_entity * * @dataProvider add_filters_from_entity_provider */ public function test_add_filters_from_entity( array $include, array $exclude, int $expectedcount, ): void { $instance = $this->get_datasource_test_source(); $method = (new ReflectionClass($instance))->getMethod('add_filters_from_entity'); $method->invoke($instance, 'datasource_test_entity', $include, $exclude); // Get all our entity filters. $filters = array_filter( $instance->get_filters(), fn(string $filtername) => strpos($filtername, 'datasource_test_entity:') === 0, ARRAY_FILTER_USE_KEY, ); $this->assertCount($expectedcount, $filters); } /** * Data provider for {@see test_add_conditions_from_entity} * * @return array[] */ public static function add_conditions_from_entity_provider(): array { return [ 'All conditions' => [ [], [], 4, ], 'Include conditions (first, extra1, extra2)' => [ ['first', 'extra*'], [], 3, ], 'Exclude conditions (first, extra1, extra2)' => [ [], ['first', 'extra*'], 1, ], ]; } /** * Test adding conditions from entity * * @param string[] $include * @param string[] $exclude * @param int $expectedcount * * @covers ::add_conditions_from_entity * * @dataProvider add_conditions_from_entity_provider */ public function test_add_conditions_from_entity( array $include, array $exclude, int $expectedcount, ): void { $instance = $this->get_datasource_test_source(); $method = (new ReflectionClass($instance))->getMethod('add_conditions_from_entity'); $method->invoke($instance, 'datasource_test_entity', $include, $exclude); // Get all our entity conditions. $conditions = array_filter( $instance->get_conditions(), fn(string $conditionname) => strpos($conditionname, 'datasource_test_entity:') === 0, ARRAY_FILTER_USE_KEY, ); $this->assertCount($expectedcount, $conditions); } /** * Test adding all from entity * * @covers ::add_all_from_entity */ public function test_add_all_from_entity(): void { $instance = $this->get_datasource_test_source(); $method = (new ReflectionClass($instance))->getMethod('add_all_from_entity'); $method->invoke($instance, 'datasource_test_entity', ['first'], ['second'], ['extra1']); // Assert the column we added (plus one we didn't). $this->assertInstanceOf(column::class, $instance->get_column('datasource_test_entity:first')); $this->assertNull($instance->get_column('datasource_test_entity:second')); // Assert the filter we added (plus one we didn't). $this->assertInstanceOf(filter::class, $instance->get_filter('datasource_test_entity:second')); $this->assertNull($instance->get_filter('datasource_test_entity:first')); // Assert the condition we added (plus one we didn't). $this->assertInstanceOf(filter::class, $instance->get_condition('datasource_test_entity:extra1')); $this->assertNull($instance->get_condition('datasource_test_entity:extra2')); } /** * Data provider for {@see get_datasource_test_source} * * @return array[] */ public static function add_all_from_entities_provider(): array { return [ 'All' => [ [], 9, 8, 8, ], 'Entity' => [ ['datasource_test_entity'], 5, 4, 4, ], ]; } /** * Test adding from all entities * * @param string[] $entitynames * @param int $expectedcountcolumns * @param int $expectedcountfilters * @param int $expectedcountconditions * * @covers ::add_all_from_entities * * @dataProvider add_all_from_entities_provider */ public function test_add_all_from_entities( array $entitynames, int $expectedcountcolumns, int $expectedcountfilters, int $expectedcountconditions, ): void { $instance = $this->get_datasource_test_source(); $method = (new ReflectionClass($instance))->getMethod('add_all_from_entities'); $method->invoke($instance, $entitynames); $this->assertCount($expectedcountcolumns, $instance->get_columns()); $this->assertCount($expectedcountfilters, $instance->get_filters()); $this->assertCount($expectedcountconditions, $instance->get_conditions()); } /** * Test getting active conditions * * @covers ::get_active_conditions */ public function test_get_active_conditions(): void { $instance = $this->get_datasource_test_source(); $method = (new ReflectionClass($instance))->getMethod('add_conditions_from_entity'); $method->invoke($instance, 'datasource_test_entity'); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $reportid = $instance->get_report_persistent()->get('id'); $generator->create_condition(['reportid' => $reportid, 'uniqueidentifier' => 'datasource_test_entity:first']); $generator->create_condition(['reportid' => $reportid, 'uniqueidentifier' => 'datasource_test_entity:second']); // Set the second condition as unavailable. $instance->get_condition('datasource_test_entity:second')->set_is_available(false); $this->assertEquals([ 'datasource_test_entity:first', ], array_keys($instance->get_active_conditions(true))); // Ensure report elements are reloaded. $instance::report_elements_modified($reportid); $this->assertEquals([ 'datasource_test_entity:first', 'datasource_test_entity:second', ], array_keys($instance->get_active_conditions(false))); } /** * Create and return our test datasource instance * * @return datasource_test_source */ protected function get_datasource_test_source(): datasource_test_source { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Test', 'source' => datasource_test_source::class, 'default' => 0]); /** @var datasource_test_source $instance */ $instance = manager::get_report_from_persistent($report); return $instance; } } /** * Simple implementation of the base datasource */ class datasource_test_source extends datasource { protected function initialise(): void { $this->set_main_table('user', 'u'); // Because we must have at least one column in the report. $this->annotate_entity('dummy', new lang_string('yes')); $this->add_column(new column('test', null, 'dummy')); // These are the entities from which we'll add additional report elements. $this->add_entity(new datasource_test_entity()); $this->add_entity((new datasource_test_entity())->set_entity_name('datasource_test_entity_second')); } public static function get_name(): string { return self::class; } public function get_default_columns(): array { return []; } public function get_default_filters(): array { return []; } public function get_default_conditions(): array { return []; } } /** * Simple implementation of the base entity */ class datasource_test_entity extends base { protected function get_default_tables(): array { return ['course']; } protected function get_default_entity_title(): lang_string { return new lang_string('course'); } /** * We're going to add multiple columns/filters/conditions, each named as following: * * [first, second, extra1, extra2] * * @return base */ public function initialise(): base { foreach (['first', 'second', 'extra1', 'extra2'] as $field) { $name = new lang_string('customfieldcolumn', 'core_reportbuilder', $field); $this->add_column(new column($field, $name, $this->get_entity_name())); $this->add_filter(new filter(text::class, $field, $name, $this->get_entity_name())); $this->add_condition(new filter(text::class, $field, $name, $this->get_entity_name())); } return $this; } } PK a<�\���r r tests/generator_test.phpnu �[��� <?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; use advanced_testcase; use core_reportbuilder_generator; use core_reportbuilder\local\models\{audience, column, filter, report, schedule}; use core_tag_tag; use core_user\reportbuilder\datasource\users; /** * Unit tests for the test data generator * * Note that assertions of created data content is performed in other testcases of the relevant classes, in the majority of cases * here we just want to assert that the thing we created actually exists * * @package core_reportbuilder * @covers \core_reportbuilder_generator * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class generator_test extends advanced_testcase { /** * Test creating a report */ public function test_create_report(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'tags' => ['cat', 'dog']]); $this->assertTrue(report::record_exists($report->get('id'))); $this->assertEqualsCanonicalizing(['cat', 'dog'], core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $report->get('id'))); } /** * Test creating a column */ public function test_create_column(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $this->assertTrue(column::record_exists($column->get('id'))); } /** * Test creating a column, specifying additional properties */ public function test_create_column_additional_properties(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => 0]); $column = $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'heading' => 'My pants', 'sortenabled' => 1, ]); $this->assertEquals('My pants', $column->get('heading')); $this->assertTrue($column->get('sortenabled')); } /** * Test creating a filter */ public function test_create_filter(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $this->assertTrue(filter::record_exists($filter->get('id'))); } /** * Test creating a filter, specifying additional properties */ public function test_create_filter_additional_properties(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => 0]); $filter = $generator->create_filter([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'heading' => 'My pants', ]); $this->assertEquals('My pants', $filter->get('heading')); } /** * Test creating a condition */ public function test_create_condition(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $condition = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname']); $this->assertTrue(filter::record_exists($condition->get('id'))); } /** * Test creating a condition, specifying additional properties */ public function test_create_condition_additional_properties(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => 0]); $condition = $generator->create_condition([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'heading' => 'My pants', ]); $this->assertEquals('My pants', $condition->get('heading')); } /** * Test creating an audience */ public function test_create_audience(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $this->assertTrue(audience::record_exists($audience->get_persistent()->get('id'))); } /** * Test creating a schedule */ public function test_create_schedule(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $this->assertTrue(schedule::record_exists($schedule->get('id'))); } } PK a<�\�'�[ [ tests/manager_test.phpnu �[��� <?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; use core\context\system; use core_reportbuilder_generator; use core_reportbuilder\local\models\report; use core_reportbuilder\local\report\base; use core_reportbuilder\exception\{source_invalid_exception, source_unavailable_exception}; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; use stdClass; /** * Unit tests for the report manager class * * @package core_reportbuilder * @covers \core_reportbuilder\manager * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class manager_test extends core_reportbuilder_testcase { /** * Test creating a report instance from persistent */ public function test_get_report_from_persistent(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $report = manager::create_report_persistent((object) [ 'type' => base::TYPE_SYSTEM_REPORT, 'source' => system_report_available::class, ]); $systemreport = manager::get_report_from_persistent($report); $this->assertInstanceOf(system_report::class, $systemreport); } /** * Test creating a report instance from persistent differs per-user, using a report source whose own initialization is * dependent on the current user (the users report source, loading available user profile fields) * * Note: internally the {@see get_custom_report_content} test helper calls {@see manager::get_report_from_persistent} */ public function test_get_report_from_persistent_per_user(): void { $this->resetAfterTest(); $this->setAdminUser(); // Custom profile field, visible only to the admin. $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'text', 'name' => 'Text field', 'datatype' => 'text', 'visible' => 0]); $user = $this->getDataGenerator()->create_user(['username' => 'usertwo', 'profile_field_text' => 'Hello']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Hidden profile field', 'source' => users::class, 'default' => 0]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:username', 'sortenabled' => 1]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_text']); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['admin', ''], ['usertwo', 'Hello'], ], array_map('array_values', $content)); // Now switch to second, non-admin, user. $this->setUser($user); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['admin'], ['usertwo'], ], array_map('array_values', $content)); } /** * Test creating a report instance from persistent with an invalid source */ public function test_get_report_from_persistent_invalid(): void { $this->resetAfterTest(); $report = manager::create_report_persistent((object) [ 'type' => base::TYPE_SYSTEM_REPORT, 'source' => stdClass::class, ]); $this->expectException(source_invalid_exception::class); manager::get_report_from_persistent($report); } /** * Test creating a report instance from persistent with an unavailable source */ public function test_get_report_from_persistent_unavailable(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_unavailable.php"); $this->resetAfterTest(); $report = manager::create_report_persistent((object) [ 'type' => base::TYPE_SYSTEM_REPORT, 'source' => system_report_unavailable::class, ]); $this->expectException(source_unavailable_exception::class); manager::get_report_from_persistent($report); } /** * Test report source exists */ public function test_report_source_exists(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->assertTrue(manager::report_source_exists(system_report_available::class)); $this->assertFalse(manager::report_source_exists(stdClass::class)); } /** * Test report source available */ public function test_report_source_available(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->assertTrue(manager::report_source_available(system_report_available::class)); require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_unavailable.php"); $this->assertFalse(manager::report_source_available(system_report_unavailable::class)); } /** * Test creating a report persistent model */ public function test_create_report_persistent(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $report = manager::create_report_persistent((object) [ 'type' => base::TYPE_SYSTEM_REPORT, 'source' => \core_reportbuilder\system_report_available::class, ]); $this->assertInstanceOf(report::class, $report); $this->assertEquals(base::TYPE_SYSTEM_REPORT, $report->get('type')); $this->assertEquals(system_report_available::class, $report->get('source')); $this->assertInstanceOf(system::class, $report->get_context()); } /** * Data provider for {@see test_report_limit_reached} * * @return array */ public static function report_limit_reached_provider(): array { return [ [0, 1, false], [1, 1, true], [2, 1, false], [1, 2, true], ]; } /** * Test test_report_limit_reached method to check site custom reports limit * * @param int $customreportslimit * @param int $existingreports * @param bool $expected * @dataProvider report_limit_reached_provider */ public function test_report_limit_reached(int $customreportslimit, int $existingreports, bool $expected): void { global $CFG; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); for ($i = 1; $i <= $existingreports; $i++) { $generator->create_report(['name' => 'Limited report '.$i, 'source' => users::class]); } // Set current custom report limit, and check whether the limit has been reached. $CFG->customreportslimit = $customreportslimit; $this->assertEquals($expected, manager::report_limit_reached()); } } PK a<�\zR� � � tests/system_report_test.phpnu �[��� <?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; use advanced_testcase; use context_system; use core_reportbuilder\local\report\action; /** * Unit tests for the system report class * * @package core_reportbuilder * @covers \core_reportbuilder\system_report * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class system_report_test extends advanced_testcase { /** * Test for actions */ public function test_actions(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance(), '', '', 0, ['withactions' => true]); $actions = $systemreport->get_actions(); $this->assertCount(1, $actions); $action = reset($actions); $this->assertInstanceOf(action::class, $action); $systemreport->add_action($action); $actions = $systemreport->get_actions(); $this->assertCount(2, $actions); $this->assertTrue($systemreport->has_actions()); } /** * Test for parameters */ public function test_parameters(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance(), '', '', 0, ['withactions' => true]); $this->assertEquals(['withactions' => true], $systemreport->get_parameters()); $systemreport->set_parameters(['withfilters' => true, 'secondparameter' => false]); $this->assertEquals(['withfilters' => true, 'secondparameter' => false], $systemreport->get_parameters()); $this->assertFalse((bool)$systemreport->get_parameter('secondparameter', true, PARAM_BOOL)); // Get a param that does not exist. $this->assertEquals('3', $systemreport->get_parameter('thirdparameter', '3', PARAM_INT)); } /** * Test for column sorting */ public function test_initial_sort_column(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->set_initial_sort_column('user:username', SORT_DESC); $column = $systemreport->get_column('user:username'); $this->assertEquals($column, $systemreport->get_initial_sort_column()); $this->assertEquals(SORT_DESC, $systemreport->get_initial_sort_direction()); } } PK a<�\I� � tests/generator/lib.phpnu �[��� <?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); use core\{clock, di}; use core_reportbuilder\manager; use core_reportbuilder\local\helpers\report as helper; use core_reportbuilder\local\helpers\schedule as schedule_helper; use core_reportbuilder\local\models\column; use core_reportbuilder\local\models\filter; use core_reportbuilder\local\models\report; use core_reportbuilder\local\models\schedule; use core_reportbuilder\local\audiences\base as audience_base; /** * Report builder test generator * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class core_reportbuilder_generator extends component_generator_base { /** * Create report * * @param array|stdClass $record * @return report * @throws coding_exception */ public function create_report($record): report { $record = (array) $record; if (!array_key_exists('name', $record)) { throw new coding_exception('Record must contain \'name\' property'); } if (!array_key_exists('source', $record)) { throw new coding_exception('Record must contain \'source\' property'); } // Report tags. $tags = $record['tags'] ?? ''; if (!is_array($tags)) { $record['tags'] = preg_split('/\s*,\s*/', $tags, -1, PREG_SPLIT_NO_EMPTY); } // Include default setup unless specifically disabled in passed record. $default = (bool) ($record['default'] ?? true); // If setting up default report, purge caches to ensure any default attributes are always loaded in tests. $report = helper::create_report((object) $record, $default); if ($default) { manager::reset_caches(); } return $report; } /** * Create report column * * @param array|stdClass $record * @return column * @throws coding_exception */ public function create_column($record): column { $record = (array) $record; if (!array_key_exists('reportid', $record)) { throw new coding_exception('Record must contain \'reportid\' property'); } if (!array_key_exists('uniqueidentifier', $record)) { throw new coding_exception('Record must contain \'uniqueidentifier\' property'); } $column = helper::add_report_column($record['reportid'], $record['uniqueidentifier']); // Update additional record properties. unset($record['reportid'], $record['uniqueidentifier']); if ($properties = column::properties_filter((object) $record)) { $column->set_many($properties)->update(); } return $column; } /** * Create report filter * * @param array|stdClass $record * @return filter * @throws coding_exception */ public function create_filter($record): filter { $record = (array) $record; if (!array_key_exists('reportid', $record)) { throw new coding_exception('Record must contain \'reportid\' property'); } if (!array_key_exists('uniqueidentifier', $record)) { throw new coding_exception('Record must contain \'uniqueidentifier\' property'); } $filter = helper::add_report_filter($record['reportid'], $record['uniqueidentifier']); // Update additional record properties. unset($record['reportid'], $record['uniqueidentifier']); if ($properties = filter::properties_filter((object) $record)) { $filter->set_many($properties)->update(); } return $filter; } /** * Create report condition * * @param array|stdClass $record * @return filter * @throws coding_exception */ public function create_condition($record): filter { $record = (array) $record; if (!array_key_exists('reportid', $record)) { throw new coding_exception('Record must contain \'reportid\' property'); } if (!array_key_exists('uniqueidentifier', $record)) { throw new coding_exception('Record must contain \'uniqueidentifier\' property'); } $condition = helper::add_report_condition($record['reportid'], $record['uniqueidentifier']); // Update additional record properties. unset($record['reportid'], $record['uniqueidentifier']); if ($properties = filter::properties_filter((object) $record)) { $condition->set_many($properties)->update(); } return $condition; } /** * Create report audience * * @param array|stdClass $record * @return audience_base * @throws coding_exception */ public function create_audience($record): audience_base { $record = (array) $record; // Required properties. if (!array_key_exists('reportid', $record)) { throw new coding_exception('Record must contain \'reportid\' property'); } if (!array_key_exists('configdata', $record)) { throw new coding_exception('Record must contain \'configdata\' property'); } // Default to all users if not specified, for convenience. /** @var audience_base $classname */ $classname = $record['classname'] ?? \core_reportbuilder\reportbuilder\audience\allusers::class; return ($classname)::create($record['reportid'], $record['configdata']); } /** * Create report schedule * * @param array|stdClass $record * @return schedule * @throws coding_exception */ public function create_schedule($record): schedule { $record = (array) $record; // Required properties. if (!array_key_exists('reportid', $record)) { throw new coding_exception('Record must contain \'reportid\' property'); } if (!array_key_exists('name', $record)) { throw new coding_exception('Record must contain \'name\' property'); } // Optional properties. if (!array_key_exists('format', $record)) { $record['format'] = 'csv'; } if (!array_key_exists('subject', $record)) { $record['subject'] = $record['name'] . ' subject'; } if (!array_key_exists('message', $record)) { $record['message'] = $record['name'] . ' message'; } if (!array_key_exists('timescheduled', $record)) { $record['timescheduled'] = usergetmidnight(di::get(clock::class)->time() + DAYSECS); } return schedule_helper::create_schedule((object) $record); } } PK a<�\%U>� � 6 tests/generator/behat_core_reportbuilder_generator.phpnu �[��� <?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); use core_reportbuilder\local\models\report; /** * Behat data generator for Report builder * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class behat_core_reportbuilder_generator extends behat_generator_base { /** * Get a list of the entities that can be created for this component * * @return array[] */ protected function get_creatable_entities(): array { return [ 'Reports' => [ 'singular' => 'Report', 'datagenerator' => 'report', 'required' => [ 'name', 'source', ], ], 'Columns' => [ 'singular' => 'Column', 'datagenerator' => 'column', 'required' => [ 'report', 'uniqueidentifier', ], 'switchids' => [ 'report' => 'reportid', ], ], 'Conditions' => [ 'singular' => 'Condition', 'datagenerator' => 'condition', 'required' => [ 'report', 'uniqueidentifier', ], 'switchids' => [ 'report' => 'reportid', ], ], 'Filters' => [ 'singular' => 'Filter', 'datagenerator' => 'filter', 'required' => [ 'report', 'uniqueidentifier', ], 'switchids' => [ 'report' => 'reportid', ], ], 'Audiences' => [ 'singular' => 'Audience', 'datagenerator' => 'audience', 'required' => [ 'report', 'configdata', ], 'switchids' => [ 'report' => 'reportid', ], ], 'Schedules' => [ 'singular' => 'Schedule', 'datagenerator' => 'schedule', 'required' => [ 'report', 'name', ], 'switchids' => [ 'report' => 'reportid', ], ], ]; } /** * Look up report ID from given name * * @param string $name * @return int */ protected function get_report_id(string $name): int { global $DB; return (int) $DB->get_field(report::TABLE, 'id', ['name' => $name], MUST_EXIST); } /** * Pre-process audience entity, generate correct config structure * * @param array $audience * @return array */ protected function preprocess_audience(array $audience): array { $audience['configdata'] = (array) json_decode($audience['configdata']); return $audience; } } PK a<�\�a�<A <A tests/permission_test.phpnu �[��� <?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; use advanced_testcase; use context_system; use core_reportbuilder\exception\report_access_exception; use core_reportbuilder_generator; use Throwable; use core_user\reportbuilder\datasource\users; use core_reportbuilder\reportbuilder\audience\manual; /** * Unit tests for the report permission class * * @package core_reportbuilder * @covers \core_reportbuilder\permission * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class permission_test extends advanced_testcase { /** * Test whether user can view reports list */ public function test_require_can_view_reports_list(): void { global $DB; $this->resetAfterTest(); // User with default permission. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); try { permission::require_can_view_reports_list(); } catch (Throwable $exception) { $this->fail($exception->getMessage()); } // User without permission. $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); unassign_capability('moodle/reportbuilder:view', $userrole, context_system::instance()); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); permission::require_can_view_reports_list(); } /** * Data provider for {@see test_require_can_view_reports_list_with_capability} * * @return array[] */ public static function require_can_view_reports_list_with_capability_provider(): array { return [ ['moodle/reportbuilder:edit'], ['moodle/reportbuilder:editall'], ['moodle/reportbuilder:viewall'], ]; } /** * Test that viewing reports list observes capability to do so * * @param string $capability * * @dataProvider require_can_view_reports_list_with_capability_provider */ public function test_require_can_view_reports_list_with_capability(string $capability): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); // Remove default capability, allow additional. unassign_capability('moodle/reportbuilder:view', $userrole, context_system::instance()); assign_capability($capability, CAP_ALLOW, $userrole, context_system::instance()); try { permission::require_can_view_reports_list(); } catch (Throwable $exception) { $this->fail($exception->getMessage()); } } /** * Test whether user can view reports list when custom reports are disabled */ public function test_require_can_view_reports_list_disabled(): void { $this->resetAfterTest(); $this->setAdminUser(); set_config('enablecustomreports', 0); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); permission::require_can_view_reports_list(); } /** * Test whether user can view specific report */ public function test_require_can_view_report(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // User with permission. $this->setAdminUser(); try { permission::require_can_view_report($report); } catch (Throwable $exception) { $this->fail($exception->getMessage()); } // User without permission. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); permission::require_can_view_report($report); } /** * Data provider for {@see test_require_can_view_report_with_capability} * * @return array[] */ public static function require_can_view_report_with_capability_provider(): array { return [ ['moodle/reportbuilder:editall'], ['moodle/reportbuilder:viewall'], ]; } /** * Test whether user can view specific report when they have capability to view all reports * * @param string $capability * * @dataProvider require_can_view_report_with_capability_provider */ public function test_require_can_view_report_with_capability(string $capability): void { global $DB; $this->resetAfterTest(); // Admin creates a report, no audience. $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Admin report', 'source' => users::class]); // Switch to new user, assign capability. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); assign_capability($capability, CAP_ALLOW, $userrole, context_system::instance()); try { permission::require_can_view_report($report); } catch (Throwable $exception) { $this->fail($exception->getMessage()); } } /** * Test whether user can view specific report when it belongs to an audience */ public function test_require_can_view_report_with_audience(): void { global $DB; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // User without permission. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $generator->create_audience([ 'reportid' => $report->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user->id]], ]); // User has view capability and belongs to an audience. permission::require_can_view_report($report); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); unassign_capability('moodle/reportbuilder:view', $userrole, context_system::instance()); // User does not have view capability and belongs to an audience. $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); permission::require_can_view_report($report); } /** * Test whether user can view report when custom reports are disabled */ public function test_require_can_view_report_disabled(): void { $this->resetAfterTest(); $this->setAdminUser(); set_config('enablecustomreports', 0); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot view this report'); permission::require_can_view_report($report); } /** * Test that user cannot edit system reports */ public function test_require_can_edit_report_system_report(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $this->setAdminUser(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); permission::require_can_edit_report($systemreport->get_report_persistent()); } /** * Test that user cannot edit any reports without capabilities */ public function test_require_can_edit_report_none(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'User', 'source' => users::class]); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); permission::require_can_edit_report($report); } /** * Test that user can edit their own reports */ public function test_require_can_edit_report_own(): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); assign_capability('moodle/reportbuilder:edit', CAP_ALLOW, $userrole, context_system::instance()); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Confirm user can edit their own report. $reportuser = $generator->create_report(['name' => 'User', 'source' => users::class]); permission::require_can_edit_report($reportuser); // Create a report by another user, confirm current user cannot edit it. $reportadmin = $generator->create_report(['name' => 'Admin', 'source' => users::class, 'usercreated' => get_admin()->id]); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); permission::require_can_edit_report($reportadmin); } /** * Test that user can edit any reports */ public function test_require_can_edit_report_all(): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); assign_capability('moodle/reportbuilder:editall', CAP_ALLOW, $userrole, context_system::instance()); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Confirm user can edit their own report. $reportuser = $generator->create_report(['name' => 'User', 'source' => users::class]); permission::require_can_edit_report($reportuser); // Create a report by another user, confirm current user can edit it. $reportadmin = $generator->create_report(['name' => 'Admin', 'source' => users::class, 'usercreated' => get_admin()->id]); permission::require_can_edit_report($reportadmin); } /** * Test whether user can edit report when custom reports are disabled */ public function test_require_can_edit_report_disabled(): void { $this->resetAfterTest(); $this->setAdminUser(); set_config('enablecustomreports', 0); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot edit this report'); permission::require_can_edit_report($report); } /** * Test that user can create a new report */ public function test_require_can_create_report(): void { $this->resetAfterTest(); // User has edit capability. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); assign_capability('moodle/reportbuilder:edit', CAP_ALLOW, $roleid, context_system::instance()); role_assign($roleid, $user->id, context_system::instance()->id); try { permission::require_can_create_report((int)$user->id); } catch (Throwable $exception) { $this->fail($exception->getMessage()); } // User has editall capability. $user2 = $this->getDataGenerator()->create_user(); $this->setUser($user2); $roleid2 = create_role('Dummy role 2', 'dummyrole2', 'dummy role 2 description'); assign_capability('moodle/reportbuilder:editall', CAP_ALLOW, $roleid2, context_system::instance()); role_assign($roleid2, $user2->id, context_system::instance()->id); try { permission::require_can_create_report((int)$user2->id); } catch (Throwable $exception) { $this->fail($exception->getMessage()); } // User has no capability. $user3 = $this->getDataGenerator()->create_user(); $this->setUser($user3); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot create a new report'); permission::require_can_create_report((int)$user3->id); } /** * Test whether user can create report when custom reports are disabled */ public function test_require_can_create_report_disabled(): void { $this->resetAfterTest(); $this->setAdminUser(); set_config('enablecustomreports', 0); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(report_access_exception::class); $this->expectExceptionMessage('You cannot create a new report'); permission::require_can_create_report(); } /** * Data provider for {@see test_can_create_report_limit_reached} * * @return array */ public function can_create_report_limit_reached_provider(): array { return [ [0, 1, true], [1, 1, false], [2, 1, true], [1, 2, false], ]; } /** * Test whether user can create report when limit report are reache * @param int $customreportslimit * @param int $existingreports * @param bool $expected * @dataProvider can_create_report_limit_reached_provider */ public function test_can_create_report_limit_reached(int $customreportslimit, int $existingreports, bool $expected): void { global $CFG; $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); for ($i = 1; $i <= $existingreports; $i++) { $generator->create_report(['name' => 'Report limited '.$i, 'source' => users::class]); } // Set current custom report limit, and check whether user can create reports. $CFG->customreportslimit = $customreportslimit; $this->assertEquals($expected, permission::can_create_report()); } } PK a<�\*��c c , tests/reportbuilder/audience/admins_test.phpnu �[��� <?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\reportbuilder\audience; use advanced_testcase; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; /** * Unit tests for the administrators audience type * * @package core_reportbuilder * @covers \core_reportbuilder\reportbuilder\audience\admins * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class admins_test extends advanced_testcase { /** * Test whether user can add this audience */ public function test_user_can_add(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = admins::create($report->get('id'), []); $this->assertFalse($audience->user_can_add()); // Switch to privileged user. $this->setAdminUser(); $this->assertTrue($audience->user_can_add()); } /** * Test whether user can edit this audience */ public function test_user_can_edit(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = admins::create($report->get('id'), []); $this->assertFalse($audience->user_can_edit()); // Switch to privileged user. $this->setAdminUser(); $this->assertTrue($audience->user_can_edit()); } /** * Test retrieving audience SQL for matching users */ public function test_get_sql(): void { global $CFG, $DB; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Create three users, set only the initial two as admins. $userone = $this->getDataGenerator()->create_user(); $usertwo = $this->getDataGenerator()->create_user(); $userthree = $this->getDataGenerator()->create_user(); $CFG->siteadmins = "{$userone->id},{$usertwo->id}"; $audience = admins::create($report->get('id'), []); [$join, $select, $params] = $audience->get_sql('u'); $users = $DB->get_fieldset_sql("SELECT u.id FROM {user} u {$join} WHERE {$select}", $params); $this->assertEqualsCanonicalizing([$userone->id, $usertwo->id], $users); } /** * Test showing audience description */ public function test_get_description(): void { global $CFG; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Create three users, set only the initial two as admins. $userone = $this->getDataGenerator()->create_user(); $usertwo = $this->getDataGenerator()->create_user(); $userthree = $this->getDataGenerator()->create_user(); $CFG->siteadmins = "{$userone->id},{$usertwo->id}"; $audience = admins::create($report->get('id'), []); $this->assertEquals(fullname($userone) . ', ' . fullname($usertwo), $audience->get_description()); } } PK a<�\Z��̝ � , tests/reportbuilder/audience/manual_test.phpnu �[��� <?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\reportbuilder\audience; use advanced_testcase; use context_system; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); /** * Unit tests for manual report audience type * * @package core_reportbuilder * @covers \core_reportbuilder\reportbuilder\audience\manual * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class manual_test extends advanced_testcase { /** * Test that this audience type description is generated correctly */ public function test_get_description(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $user1 = $this->getDataGenerator()->create_user(['firstname' => 'User', 'lastname' => 'A']); $user2 = $this->getDataGenerator()->create_user(['firstname' => 'User', 'lastname' => 'B']); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $canviewfullnames = has_capability('moodle/site:viewfullnames', context_system::instance()); $audience = manual::create($report->get('id'), ['users' => [$user1->id, $user2->id]]); $this->assertEquals(implode(', ', [fullname($user1, $canviewfullnames), fullname($user2, $canviewfullnames)]), $audience->get_description()); } /** * Test if user can add this audience type to the report */ public function test_user_can_add(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = manual::create($report->get('id'), ['users' => [$user1->id, $user2->id]]); // Admin user. self::setAdminUser(); $this->assertTrue($audience->user_can_add()); // Non-priveleged user. $user = self::getDataGenerator()->create_user(); self::setUser($user); $this->assertFalse($audience->user_can_add()); // Grant priveleges to user. $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); assign_capability('moodle/user:viewalldetails', CAP_ALLOW, $roleid, context_system::instance()->id); role_assign($roleid, $user->id, context_system::instance()->id); $this->assertTrue($audience->user_can_add()); } /** * Test if user can edit this audience type */ public function test_user_can_edit(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = manual::create($report->get('id'), ['users' => [$user1->id, $user2->id]]); // Admin user. self::setAdminUser(); $this->assertTrue($audience->user_can_edit()); // Non-priveleged user. $user = self::getDataGenerator()->create_user(); self::setUser($user); $this->assertFalse($audience->user_can_edit()); // Grant priveleges to user. $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); assign_capability('moodle/user:viewalldetails', CAP_ALLOW, $roleid, context_system::instance()->id); role_assign($roleid, $user->id, context_system::instance()->id); $this->assertTrue($audience->user_can_edit()); } /** * Test that sql generated is correct */ public function test_get_sql(): void { global $DB; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $user3 = $this->getDataGenerator()->create_user(); $audience = manual::create($report->get('id'), ['users' => [$user1->id, $user3->id]]); [$join, $where, $params] = $audience->get_sql('u'); $query = 'SELECT u.* FROM {user} u ' . $join . ' WHERE ' . $where; $records = $DB->get_records_sql($query, $params); $this->assertEqualsCanonicalizing([$user1->id, $user3->id], array_column($records, 'id')); } } PK a<�\�`��� � 0 tests/reportbuilder/audience/systemrole_test.phpnu �[��� <?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\reportbuilder\audience; use advanced_testcase; use context_system; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; defined('MOODLE_INTERNAL') || die(); /** * Unit tests for system role report audience type * * @package core_reportbuilder * @covers \core_reportbuilder\reportbuilder\audience\systemrole * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class systemrole_test extends advanced_testcase { /** * Test that this audience type description is generated correctly */ public function test_get_description(): void { global $DB; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); self::setAdminUser(); $role = $DB->get_record('role', ['shortname' => 'manager']); $rolename = role_get_name($role, null, ROLENAME_ALIAS); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = systemrole::create($report->get('id'), ['roles' => [$role->id]]); $this->assertEquals($rolename, $audience->get_description()); } /** * Test if user can add this audience type to the report */ public function test_user_can_add(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); self::setAdminUser(); $roles = get_assignable_roles(context_system::instance(), ROLENAME_ALIAS); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = systemrole::create($report->get('id'), ['roles' => array_keys($roles)]); // Admin user. self::setAdminUser(); $this->assertTrue($audience->user_can_add()); // Non-priveleged user. $user = self::getDataGenerator()->create_user(); self::setUser($user); $this->assertFalse($audience->user_can_add()); } /** * Test if user can edit this audience type */ public function test_user_can_edit(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); self::setAdminUser(); $roles = get_assignable_roles(context_system::instance(), ROLENAME_ALIAS); $this->assertNotEmpty($roles); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = systemrole::create($report->get('id'), ['roles' => array_keys($roles)]); // Admin user. self::setAdminUser(); $this->assertTrue($audience->user_can_edit()); // Non-priveleged user. $user = self::getDataGenerator()->create_user(); self::setUser($user); $this->assertFalse($audience->user_can_edit()); } /** * Test that sql generated is correct */ public function test_get_sql(): void { global $DB; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $user3 = $this->getDataGenerator()->create_user(); self::setAdminUser(); $roles = get_assignable_roles(context_system::instance(), ROLENAME_ALIAS); $this->assertNotEmpty($roles); // Assign new role to user1 and user3. $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); role_assign($roleid, $user1->id, context_system::instance()->id); role_assign($roleid, $user3->id, context_system::instance()->id); $audience = systemrole::create($report->get('id'), ['roles' => [$roleid]]); [$join, $where, $params] = $audience->get_sql('u'); $query = 'SELECT u.* FROM {user} u ' . $join . ' WHERE ' . $where; $records = $DB->get_records_sql($query, $params); $this->assertEqualsCanonicalizing([$user1->id, $user3->id], array_column($records, 'id')); } } PK a<�\`�V V . tests/reportbuilder/audience/allusers_test.phpnu �[��� <?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\reportbuilder\audience; use advanced_testcase; use context_system; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; /** * Unit tests for all users report audience type * * @package core_reportbuilder * @covers \core_reportbuilder\reportbuilder\audience\allusers * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class allusers_test extends advanced_testcase { /** * Test that this audience type description is generated correctly */ public function test_get_description(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = allusers::create($report->get('id'), []); $this->assertEquals(get_string('allsiteusers', 'core_reportbuilder'), $audience->get_description()); } /** * Test if user can add this audience type to the report */ public function test_user_can_add(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = allusers::create($report->get('id'), []); // Admin user. self::setAdminUser(); $this->assertTrue($audience->user_can_add()); // Non-priveleged user. $user = self::getDataGenerator()->create_user(); self::setUser($user); $this->assertFalse($audience->user_can_add()); // Grant priveleges to user. $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); assign_capability('moodle/user:viewalldetails', CAP_ALLOW, $roleid, context_system::instance()->id); role_assign($roleid, $user->id, context_system::instance()->id); $this->assertTrue($audience->user_can_add()); } /** * Test if user can edit this audience type */ public function test_user_can_edit(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $audience = allusers::create($report->get('id'), []); // Admin user. self::setAdminUser(); $this->assertTrue($audience->user_can_edit()); // Non-priveleged user. $user = self::getDataGenerator()->create_user(); self::setUser($user); $this->assertFalse($audience->user_can_edit()); // Grant priveleges to user. $roleid = create_role('Dummy role', 'dummyrole', 'dummy role description'); assign_capability('moodle/user:viewalldetails', CAP_ALLOW, $roleid, context_system::instance()->id); role_assign($roleid, $user->id, context_system::instance()->id); $this->assertTrue($audience->user_can_edit()); } /** * Test that sql generated is correct */ public function test_get_sql(): void { global $DB; $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $user3 = $this->getDataGenerator()->create_user(); $this->getDataGenerator()->create_user(['suspended' => 1]); $this->getDataGenerator()->create_user(['deleted' => 1]); $audience = allusers::create($report->get('id'), []); [$join, $where, $params] = $audience->get_sql('u'); $query = 'SELECT u.* FROM {user} u ' . $join . ' WHERE ' . $where; $records = $DB->get_records_sql($query, $params); $this->assertEqualsCanonicalizing([get_admin()->id, $user1->id, $user2->id, $user3->id], array_column($records, 'id')); } } PK a<�\�~�Ͳ. �. ! tests/task/send_schedule_test.phpnu �[��� <?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\task; use advanced_testcase; use core_collator; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\filters\user; use core_reportbuilder\local\models\schedule; use core_reportbuilder\local\filters\text; use core_reportbuilder\reportbuilder\audience\manual; use core_user; use core_user\reportbuilder\datasource\users; /** * Unit tests for ad-hoc task for sending report schedule * * @package core_reportbuilder * @covers \core_reportbuilder\task\send_schedule * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class send_schedule_test extends advanced_testcase { /** * Data provider for {@see test_execute_viewas_user} * * @return array[] */ public static function execute_report_viewas_user_provider(): array { return [ 'View report as schedule creator' => [schedule::REPORT_VIEWAS_CREATOR, null, 'admin', 'admin'], 'View report as schedule recipient' => [schedule::REPORT_VIEWAS_RECIPIENT, null, 'userone', 'usertwo'], 'View report as specific user' => [null, 'userone', 'userone', 'userone'], ]; } /** * Test executing task for a schedule with differing "View as user" configuration * * @param int|null $viewasuser * @param string|null $viewasusername * @param string $useronesees * @param string $usertwosees * * @dataProvider execute_report_viewas_user_provider */ public function test_execute_report_viewas_user( ?int $viewasuser, ?string $viewasusername, string $useronesees, string $usertwosees ): void { $this->preventResetByRollback(); $this->resetAfterTest(); $this->setAdminUser(); $userone = $this->getDataGenerator()->create_user([ 'username' => 'userone', 'email' => 'user1@example.com', 'firstname' => 'Zoe', 'lastname' => 'Zebra', ]); $usertwo = $this->getDataGenerator()->create_user([ 'username' => 'usertwo', 'email' => 'user2@example.com', 'firstname' => 'Henrietta', 'lastname' => 'Hamster', ]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create a report, with a single column and condition that the current user only sees themselves. $report = $generator->create_report(['name' => 'Myself', 'source' => users::class, 'default' => false]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:username']); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:userselect']); manager::get_report_from_persistent($report) ->set_condition_values(['user:userselect_operator' => user::USER_CURRENT]); // Add audience/schedule for our two test users. $audience = $generator->create_audience([ 'reportid' => $report->get('id'), 'classname' => manual::class, 'configdata' => [ 'users' => [$userone->id, $usertwo->id], ], ]); // If "View as user" isn't specified, it should be the ID of the given "View as username". if ($viewasuser === null) { $viewasuser = core_user::get_user_by_username($viewasusername, '*', null, MUST_EXIST)->id; } $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'userviewas' => $viewasuser, 'audiences' => json_encode([$audience->get_persistent()->get('id')]), ]); // Send the schedule, catch emails in sink (noting the users are sorted alphabetically). $sink = $this->redirectEmails(); $this->expectOutputRegex("/^Sending schedule: My schedule\n" . " Sending to: " . fullname($usertwo) . "\n" . " Sending to: " . fullname($userone) . "\n" . "Sending schedule complete\n/" ); $sendschedule = new send_schedule(); $sendschedule->set_custom_data(['reportid' => $report->get('id'), 'scheduleid' => $schedule->get('id')]); $sendschedule->execute(); $messages = $sink->get_messages(); $this->assertCount(2, $messages); $sink->close(); // Ensure caught messages are consistently ordered by recipient email prior to assertions. core_collator::asort_objects_by_property($messages, 'to'); $messages = array_values($messages); $messageoneattachment = self::extract_message_attachment($messages[0]->body); $this->assertEquals($userone->email, $messages[0]->to); $this->assertStringEndsWith("Username\n{$useronesees}\n", $messageoneattachment); $messagetwoattachment = self::extract_message_attachment($messages[1]->body); $this->assertEquals($usertwo->email, $messages[1]->to); $this->assertStringEndsWith("Username\n{$usertwosees}\n", $messagetwoattachment); } /** * Test executing task where the schedule "View as user" is an inactive account */ public function test_execute_report_viewas_user_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'userviewas' => 42, 'audiences' => json_encode([$audience->get_persistent()->get('id')]), ]); $this->expectOutputRegex("/^Sending schedule: My schedule\nInvalid schedule view as user: Invalid user/"); $sendschedule = new send_schedule(); $sendschedule->set_custom_data(['reportid' => $report->get('id'), 'scheduleid' => $schedule->get('id')]); $sendschedule->execute(); } /** * Test executing task for a schedule that is configured to not send empty reports */ public function test_execute_report_empty(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create a report that won't return any data. $report = $generator->create_report(['name' => 'Myself', 'source' => users::class, 'default' => false]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:username']); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:username']); manager::get_report_from_persistent($report)->set_condition_values([ 'user:username_operator' => text::IS_EQUAL_TO, 'user:username_value' => 'baconlettucetomato', ]); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'audiences' => json_encode([$audience->get_persistent()->get('id')]), 'reportempty' => schedule::REPORT_EMPTY_DONT_SEND, ]); $this->expectOutputString("Sending schedule: My schedule\n" . " Empty report, skipping\n" . "Sending schedule complete\n"); $sendschedule = new send_schedule(); $sendschedule->set_custom_data(['reportid' => $report->get('id'), 'scheduleid' => $schedule->get('id')]); $sendschedule->execute(); } /** * Test executing task for a schedule that contains no recipients */ public function test_execute_schedule_no_recipients(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $this->expectOutputString("Sending schedule: My schedule\n" . "Sending schedule complete\n"); $sendschedule = new send_schedule(); $sendschedule->set_custom_data(['reportid' => $report->get('id'), 'scheduleid' => $schedule->get('id')]); $sendschedule->execute(); } /** * Test executing task where the schedule creator is an inactive account */ public function test_execute_schedule_creator_invalid(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule', 'usercreated' => 42]); $this->expectOutputRegex("/^Sending schedule: My schedule\nInvalid schedule creator: Invalid user/"); $sendschedule = new send_schedule(); $sendschedule->set_custom_data(['reportid' => $report->get('id'), 'scheduleid' => $schedule->get('id')]); $sendschedule->execute(); } /** * Test executing task given invalid schedule data */ public function test_execute_schedule_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectOutputString("Invalid schedule\n"); $sendschedule = new send_schedule(); $sendschedule->set_custom_data(['reportid' => $report->get('id'), 'scheduleid' => 42]); $sendschedule->execute(); } /** * Given a multi-part message in MIME format, return the base64 encoded attachment contained within * * @param string $messagebody * @return string */ private static function extract_message_attachment(string $messagebody): string { $mimepart = preg_split('/Content-Disposition: attachment; filename="My schedule.csv"\s+/m', $messagebody); // Extract the base64 encoded content after the "Content-Disposition" header. preg_match_all('/^([A-Z0-9\/\+=]+)\s/im', $mimepart[1], $matches); return base64_decode(implode($matches[0])); } } PK a<�\�t��� � $ tests/system_report_factory_test.phpnu �[��� <?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; use advanced_testcase; use context_system; use stdClass; use core_reportbuilder\exception\{source_invalid_exception, source_unavailable_exception}; /** * Unit tests for the system report factory class * * @package core_reportbuilder * @covers \core_reportbuilder\system_report_factory * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class system_report_factory_test extends advanced_testcase { /** * Test creating a valid/available system report */ public function test_create(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $this->assertInstanceOf(system_report::class, $systemreport); } /** * Test that creating a system report returns the same persistent if it already exists */ public function test_create_previously_exists(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); $this->resetAfterTest(); $systemreportone = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreporttwo = system_report_factory::create(system_report_available::class, context_system::instance()); // Assert we have the same persistent for each. $this->assertEquals($systemreportone->get_report_persistent()->get('id'), $systemreporttwo->get_report_persistent()->get('id')); } /** * Test creating an system report with an invalid source */ public function test_create_invalid(): void { $this->expectException(source_invalid_exception::class); system_report_factory::create(stdClass::class, context_system::instance()); } /** * Test creating an unavailable system report */ public function test_create_unavailable(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_unavailable.php"); $this->resetAfterTest(); $this->expectException(source_unavailable_exception::class); system_report_factory::create(system_report_unavailable::class, context_system::instance()); } } PK a<�\^F.� tests/helpers.phpnu �[��� <?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); /** * Helper base class for reportbuilder unit tests * * @package core_reportbuilder * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class_alias(\core_reportbuilder\tests\core_reportbuilder_testcase::class, \core_reportbuilder_testcase::class); PK a<�\�h��) �) " tests/local/entities/base_test.phpnu �[��� <?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/>. /** * Unit tests for base entity * * @package core_reportbuilder * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); namespace core_reportbuilder\local\entities; use advanced_testcase; use coding_exception; use lang_string; use core_reportbuilder\local\filters\text; use core_reportbuilder\local\report\column; use core_reportbuilder\local\report\filter; defined('MOODLE_INTERNAL') || die(); /** * Unit tests for base entity * * @package core_reportbuilder * @covers \core_reportbuilder\local\entities\base * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class base_test extends advanced_testcase { /** * Test entity table alias */ public function test_get_table_alias(): void { $entity = new base_test_entity(); $mytablealias = $entity->get_table_alias('mytable'); $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $mytablealias); $myothertablealias = $entity->get_table_alias('myothertable'); $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $myothertablealias); // They must differ. $this->assertNotEquals($mytablealias, $myothertablealias); // Re-request both, ensure they are identical to what we previously received. $this->assertEquals($mytablealias, $entity->get_table_alias('mytable')); $this->assertEquals($myothertablealias, $entity->get_table_alias('myothertable')); } /** * Test for invalid get table alias */ public function test_get_table_alias_invalid(): void { $entity = new base_test_entity(); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Coding error detected, it must be fixed by a programmer: ' . 'Invalid table name (nonexistingalias)'); $entity->get_table_alias('nonexistingalias'); } /** * Test getting all table aliases */ public function test_get_table_aliases(): void { $entity = new base_test_entity(); [ 'mytable' => $mytablealias, 'myothertable' => $myothertablealias, ] = $entity->get_table_aliases(); $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $mytablealias); $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $myothertablealias); // They must differ. $this->assertNotEquals($mytablealias, $myothertablealias); } /** * Test setting table alias */ public function test_set_table_alias(): void { $entity = new base_test_entity(); $entity->set_table_alias('mytable', 'newalias'); $this->assertEquals('newalias', $entity->get_table_alias('mytable')); } /** * Test invalid entity set table alias */ public function test_set_table_alias_invalid(): void { $entity = new base_test_entity(); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Coding error detected, it must be fixed by a programmer: Invalid table name (nonexistent)'); $entity->set_table_alias('nonexistent', 'newalias'); } /** * Test setting multiple table aliases */ public function test_set_table_aliases(): void { $entity = new base_test_entity(); $entity->set_table_aliases([ 'mytable' => 'newalias', 'myothertable' => 'newalias2', ]); $this->assertEquals([ 'mytable' => 'newalias', 'myothertable' => 'newalias2', ], $entity->get_table_aliases()); } /** * Test setting multiple table aliases, containing an invalid table */ public function test_set_table_aliases_invalid(): void { $entity = new base_test_entity(); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Coding error detected, it must be fixed by a programmer: Invalid table name (nonexistent)'); $entity->set_table_aliases([ 'mytable' => 'newalias', 'nonexistent' => 'newalias2', ]); } /** * Test setting table join alias */ public function test_set_table_join_alias(): void { $entity = new base_test_entity(); $entity->set_table_join_alias('mytable', 'newalias'); $this->assertTrue($entity->has_table_join_alias('mytable')); $this->assertEquals('newalias', $entity->get_table_alias('mytable')); } /** * Test that entity doesn't have table join alias by default * * {@see test_set_table_join_alias} for assertion where it does */ public function test_has_table_join_alias(): void { $entity = new base_test_entity(); $this->assertFalse($entity->has_table_join_alias('mytable')); } /** * Test entity name */ public function test_set_entity_name(): void { $entity = new base_test_entity(); $this->assertEquals('base_test_entity', $entity->get_entity_name()); $entity->set_entity_name('newentityname'); $this->assertEquals('newentityname', $entity->get_entity_name()); } /** * Test entity title */ public function test_set_entity_title(): void { $entity = new base_test_entity(); $this->assertEquals(new lang_string('yes'), $entity->get_entity_title()); $newtitle = new lang_string('fullname'); $entity->set_entity_title($newtitle); $this->assertEquals($newtitle, $entity->get_entity_title()); } /** * Test getting column */ public function test_get_column(): void { $entity = (new base_test_entity())->initialise(); $column = $entity->get_column('test'); $this->assertEquals('base_test_entity:test', $column->get_unique_identifier()); } /** * Test for invalid get column */ public function test_get_column_invalid(): void { $entity = (new base_test_entity())->initialise(); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Coding error detected, it must be fixed by a programmer: ' . 'Invalid column name (nonexistingcolumn)'); $entity->get_column('nonexistingcolumn'); } /** * Test getting columns */ public function test_get_columns(): void { $entity = (new base_test_entity())->initialise(); $columns = $entity->get_columns(); $this->assertCount(1, $columns); $this->assertContainsOnlyInstancesOf(column::class, $columns); } /** * Test getting filter */ public function test_get_filter(): void { $entity = (new base_test_entity())->initialise(); $filter = $entity->get_filter('test'); $this->assertEquals('base_test_entity:test', $filter->get_unique_identifier()); } /** * Test for invalid get filter */ public function test_get_filter_invalid(): void { $entity = (new base_test_entity())->initialise(); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Coding error detected, it must be fixed by a programmer: ' . 'Invalid filter name (nonexistingfilter)'); $entity->get_filter('nonexistingfilter'); } /** * Test getting filters */ public function test_get_filters(): void { $entity = (new base_test_entity())->initialise(); $filters = $entity->get_filters(); $this->assertCount(1, $filters); $this->assertContainsOnlyInstancesOf(filter::class, $filters); } /** * Test getting condition */ public function test_get_condition(): void { $entity = (new base_test_entity())->initialise(); $condition = $entity->get_condition('test'); $this->assertEquals('base_test_entity:test', $condition->get_unique_identifier()); } /** * Test for invalid get condition */ public function test_get_condition_invalid(): void { $entity = (new base_test_entity())->initialise(); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Coding error detected, it must be fixed by a programmer: ' . 'Invalid condition name (nonexistingcondition)'); $entity->get_condition('nonexistingcondition'); } /** * Test getting conditions */ public function test_get_conditions(): void { $entity = (new base_test_entity())->initialise(); $conditions = $entity->get_conditions(); $this->assertCount(1, $conditions); $this->assertContainsOnlyInstancesOf(filter::class, $conditions); } } /** * Simple implementation of the base entity */ class base_test_entity extends base { /** * Table aliases * * @return array */ protected function get_default_tables(): array { return [ 'mytable', 'myothertable', ]; } /** * Entity title * * @return lang_string */ protected function get_default_entity_title(): lang_string { return new lang_string('yes'); } /** * Initialise entity * * @return base */ public function initialise(): base { $column = (new column( 'test', new lang_string('no'), $this->get_entity_name() )) ->add_field('no'); $filter = (new filter( text::class, 'test', new lang_string('no'), $this->get_entity_name(), )) ->set_field_sql('no'); return $this ->add_column($column) ->add_filter($filter) ->add_condition($filter); } } PK a<�\���& " tests/local/entities/user_test.phpnu �[��� <?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\local\entities; use advanced_testcase; use core\context\system; /** * Unit tests for user entity * * @package core_reportbuilder * @covers \core_reportbuilder\local\entities\user * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class user_test extends advanced_testcase { /** * Test getting user identity column */ public function test_get_identity_column(): void { $this->resetAfterTest(); $this->getDataGenerator()->create_custom_profile_field(['datatype' => 'text', 'name' => 'Hi', 'shortname' => 'hi']); $user = new user(); $user->initialise(); $columnusername = $user->get_identity_column('username'); $this->assertEquals('user:username', $columnusername->get_unique_identifier()); $columnprofilefield = $user->get_identity_column('profile_field_hi'); $this->assertEquals('user:profilefield_hi', $columnprofilefield->get_unique_identifier()); } /** * Test getting all user identity columns */ public function test_get_identity_columns(): void { $this->resetAfterTest(); $this->setAdminUser(); $this->getDataGenerator()->create_custom_profile_field(['datatype' => 'text', 'name' => 'Hi', 'shortname' => 'hi']); set_config('showuseridentity', 'username,profilefield_hi'); $context = system::instance(); $user = new user(); $user->initialise(); // All columns. $this->assertEqualsCanonicalizing([ 'user:username', 'user:profilefield_hi', ], array_map( fn($column) => $column->get_unique_identifier(), $user->get_identity_columns($context), )); // Exclude username. $columns = $user->get_identity_columns($context, ['username']); $this->assertCount(1, $columns); $this->assertEquals('user:profilefield_hi', reset($columns)->get_unique_identifier()); } /** * Test getting user identity filter */ public function test_get_identity_filter(): void { $this->resetAfterTest(); $this->getDataGenerator()->create_custom_profile_field(['datatype' => 'text', 'name' => 'Hi', 'shortname' => 'hi']); $user = new user(); $user->initialise(); $filterusername = $user->get_identity_filter('username'); $this->assertEquals('user:username', $filterusername->get_unique_identifier()); $filterprofilefield = $user->get_identity_filter('profile_field_hi'); $this->assertEquals('user:profilefield_hi', $filterprofilefield->get_unique_identifier()); } /** * Test getting all user identity filters */ public function test_get_identity_filters(): void { $this->resetAfterTest(); $this->setAdminUser(); $this->getDataGenerator()->create_custom_profile_field(['datatype' => 'text', 'name' => 'Hi', 'shortname' => 'hi']); set_config('showuseridentity', 'username,profilefield_hi'); $context = system::instance(); $user = new user(); $user->initialise(); // All filters. $this->assertEqualsCanonicalizing([ 'user:username', 'user:profilefield_hi', ], array_map( fn($filter) => $filter->get_unique_identifier(), $user->get_identity_columns($context), )); // Exclude username. $filters = $user->get_identity_filters($context, ['username']); $this->assertCount(1, $filters); $this->assertEquals('user:profilefield_hi', reset($filters)->get_unique_identifier()); } /** * Data provider for {@see test_get_name_fields_select} * * @return array */ public static function get_name_fields_select_provider(): array { return [ ['firstname', ['firstname']], ['firstname lastname', ['firstname', 'lastname']], ['firstname middlename lastname', ['firstname', 'middlename', 'lastname']], ['alternatename lastname firstname', ['alternatename', 'lastname', 'firstname']], ]; } /** * Tests the helper method for selecting all of a users' name fields * * @param string $fullnamedisplay * @param string[] $expecteduserfields * * @dataProvider get_name_fields_select_provider */ public function test_get_name_fields_select(string $fullnamedisplay, array $expecteduserfields): void { global $DB; $this->resetAfterTest(true); set_config('alternativefullnameformat', $fullnamedisplay); // As a user without permission to view all fields we always get the standard ones. $fields = user::get_name_fields_select('u'); $user = $DB->get_record_sql("SELECT {$fields} FROM {user} u WHERE username = :username", ['username' => 'admin']); $this->assertEquals(['firstname', 'lastname'], array_keys((array) $user)); // As the admin we get all name fields from alternativefullnameformat. $this->setAdminUser(); $fields = user::get_name_fields_select('u'); $user = $DB->get_record_sql("SELECT {$fields} FROM {user} u WHERE username = :username", ['username' => 'admin']); $this->assertEquals($expecteduserfields, array_keys((array) $user)); } } PK a<�\I6�3* 3* tests/local/report/base_test.phpnu �[��� <?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\local\report; use advanced_testcase; use coding_exception; use context_system; use core_reportbuilder\local\helpers\database; use core_reportbuilder\system_report_available; use core_reportbuilder\system_report_factory; use lang_string; use ReflectionClass; /** * Unit tests for report base class * * @package core_reportbuilder * @covers \core_reportbuilder\local\report\base * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class base_test extends advanced_testcase { /** * Load required class */ public static function setUpBeforeClass(): void { global $CFG; require_once("{$CFG->dirroot}/reportbuilder/tests/fixtures/system_report_available.php"); parent::setUpBeforeClass(); } /** * Test for add_base_condition_simple */ public function test_add_base_condition_simple(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->add_base_condition_simple('username', 'admin'); [$where, $params] = $systemreport->get_base_condition(); $this->assertStringMatchesFormat('username = :%a', $where); $this->assertEqualsCanonicalizing(['admin'], $params); } /** * Test for add_base_condition_simple null */ public function test_add_base_condition_simple_null(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->add_base_condition_simple('username', null); [$where, $params] = $systemreport->get_base_condition(); $this->assertEquals('username IS NULL', $where); $this->assertEmpty($params); } /** * Test for adding SQL base condition to a report */ public function test_add_base_condition_sql(): void { $this->resetAfterTest(); $parameter = database::generate_param_name(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->add_base_condition_sql("username = :{$parameter}", [$parameter => 'admin']); [$where, $params] = $systemreport->get_base_condition(); $this->assertEquals("username = :{$parameter}", $where); $this->assertEquals([$parameter => 'admin'], $params); } /** * Test for adding multiple SQL base condition to a report */ public function test_add_base_condition_sql_multiple(): void { $this->resetAfterTest(); [$paramusername, $paramemail] = database::generate_param_names(2); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->add_base_condition_sql("username = :{$paramusername}", [$paramusername => 'admin']); $systemreport->add_base_condition_sql("email = :{$paramemail}", [$paramemail => 'admin@example.com']); [$where, $params] = $systemreport->get_base_condition(); $this->assertEquals("username = :{$paramusername} AND email = :{$paramemail}", $where); $this->assertEquals([$paramusername => 'admin', $paramemail => 'admin@example.com'], $params); } /** * Test for adding empty SQL base condition to a report */ public function test_add_base_condition_sql_empty_clause(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->add_base_condition_sql('username IS NOT NULL'); $systemreport->add_base_condition_sql(''); [$where, $params] = $systemreport->get_base_condition(); $this->assertEquals("username IS NOT NULL", $where); $this->assertEmpty($params); } /** * Test for adding SQL base condition to a report with invalid parameter */ public function test_add_base_condition_sql_invalid_parameter(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Invalid parameter names'); $systemreport->add_base_condition_sql("username = :param", ['param' => 'admin']); } /** * Test getting report base conditions, where none have been set */ public function test_get_base_condition_default(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); [$where, $params] = $systemreport->get_base_condition(); $this->assertEmpty($where); $this->assertEmpty($params); } /** * Test for get_filter_instances */ public function test_get_filter_instances(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance(), '', '', 0, ['withfilters' => true]); $filters = $systemreport->get_filter_instances(); $this->assertCount(1, $filters); $this->assertInstanceOf(\core_reportbuilder\local\filters\text::class, reset($filters)); } /** * Test for set_downloadable */ public function test_set_downloadable(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $systemreport->set_downloadable(true, 'testfilename'); $this->assertTrue($systemreport->is_downloadable()); $this->assertEquals('testfilename', $systemreport->get_downloadfilename()); $systemreport->set_downloadable(false, 'anothertestfilename'); $this->assertFalse($systemreport->is_downloadable()); $this->assertEquals('anothertestfilename', $systemreport->get_downloadfilename()); } /** * Test for get_context */ public function test_get_context(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $this->assertEquals(context_system::instance(), $systemreport->get_context()); $course = $this->getDataGenerator()->create_course(); $contextcourse = \context_course::instance($course->id); $systemreport2 = system_report_factory::create(system_report_available::class, $contextcourse); $this->assertEquals($contextcourse, $systemreport2->get_context()); } /** * Test entity annotation */ public function test_annotate_entity(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $method = (new ReflectionClass($systemreport))->getMethod('annotate_entity'); $method->invoke($systemreport, 'test', new lang_string('yes')); $this->assertEquals(new lang_string('yes'), $systemreport->get_entity_title('test')); } /** * Test entity annotation for invalid entity name */ public function test_annotate_entity_invalid(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $method = (new ReflectionClass($systemreport))->getMethod('annotate_entity'); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Entity name must be comprised of alphanumeric character, underscore or dash'); $method->invoke($systemreport, '', new lang_string('yes')); } /** * Test entity annotation for duplicated entity name */ public function test_annotate_entity_duplicate(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $method = (new ReflectionClass($systemreport))->getMethod('annotate_entity'); $method->invoke($systemreport, 'test', new lang_string('yes')); // Adding a second time with the same name should trigger exception. $this->expectException(coding_exception::class); $this->expectExceptionMessage('Duplicate entity name (test)'); $method->invoke($systemreport, 'test', new lang_string('no')); } /** * Test for get_column */ public function test_get_column(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $column = $systemreport->get_column('user:username'); $this->assertInstanceOf(column::class, $column); $column = $systemreport->get_column('user:nonexistingcolumn'); $this->assertNull($column); } /** * Test for get_filter */ public function test_get_filter(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance(), '', '', 0, ['withfilters' => true]); $filter = $systemreport->get_filter('user:username'); $this->assertInstanceOf(filter::class, $filter); $filter = $systemreport->get_filter('user:nonexistingfilter'); $this->assertNull($filter); } /** * Test for get_report_persistent */ public function test_get_report_persistent(): void { $this->resetAfterTest(); $systemreport = system_report_factory::create(system_report_available::class, context_system::instance()); $persistent = $systemreport->get_report_persistent(); $this->assertEquals(system_report_available::class, $persistent->get('source')); } } PK a<�\G��F " tests/local/report/filter_test.phpnu �[��� <?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\local\report; use advanced_testcase; use lang_string; use moodle_exception; use core_reportbuilder\local\filters\text; /** * Unit tests for a report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\report\filter * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class filter_test extends advanced_testcase { /** * Test getting filter class */ public function test_get_filter_class(): void { $filter = $this->create_filter('username'); $this->assertEquals(text::class, $filter->get_filter_class()); } /** * Test specifying invalid filter class */ public function test_invalid_filter_class(): void { $this->expectException(moodle_exception::class); $this->expectExceptionMessage('Invalid filter (sillyclass)'); new filter('sillyclass', 'username', new lang_string('username'), 'filter_testcase'); } /** * Test getting name */ public function test_get_name(): void { $filter = $this->create_filter('username'); $this->assertEquals('username', $filter->get_name()); } /** * Test getting header */ public function test_get_header(): void { $filter = $this->create_filter('username'); $this->assertEquals('Username', $filter->get_header()); } /** * Test setting header */ public function test_set_header(): void { $filter = $this->create_filter('username') ->set_header(new lang_string('firstname')); $this->assertEquals('First name', $filter->get_header()); } /** * Test getting entity name */ public function test_get_entity_name(): void { $filter = $this->create_filter('username'); $this->assertEquals('filter_testcase', $filter->get_entity_name()); } /** * Test getting unique identifier */ public function test_get_unique_identifier(): void { $filter = $this->create_filter('username'); $this->assertEquals('filter_testcase:username', $filter->get_unique_identifier()); } /** * Test getting field SQL */ public function test_get_field_sql(): void { $filter = $this->create_filter('username', 'u.username'); $this->assertEquals('u.username', $filter->get_field_sql()); } /** * Test getting field params */ public function test_get_field_params(): void { $filter = $this->create_filter('username', 'u.username = :foo', ['foo' => 'bar']); $this->assertEquals(['foo' => 'bar'], $filter->get_field_params()); } /** * Test getting field SQL and params, while providing index for uniqueness */ public function test_get_field_sql_and_params(): void { $filter = $this->create_filter('username', 'u.username = :username AND u.idnumber = :idnumber', ['username' => 'test', 'idnumber' => 'bar']); [$sql, $params] = $filter->get_field_sql_and_params(1); $this->assertEquals('u.username = :username_1 AND u.idnumber = :idnumber_1', $sql); $this->assertEquals(['username_1' => 'test', 'idnumber_1' => 'bar'], $params); } /** * Test is available */ public function test_is_available(): void { $filter = $this->create_filter('username', 'u.username'); $this->assertTrue($filter->get_is_available()); $filter->set_is_available(true); $this->assertTrue($filter->get_is_available()); } /** * Test setting filter options */ public function test_set_options(): void { $filter = $this->create_filter('username', 'u.username') ->set_options([1, 2, 3]); $this->assertEquals([1, 2, 3], $filter->get_options()); } /** * Test setting filter options via callback */ public function test_set_options_callback(): void { $filter = $this->create_filter('username', 'u.username') ->set_options_callback(static function() { return 10 * 5; }); $this->assertEquals(50, $filter->get_options()); } /** * Test restricting filter operators */ public function test_limited_operators(): void { $filter = $this->create_filter('username', 'u.username') ->set_limited_operators([ text::IS_EQUAL_TO, text::IS_NOT_EQUAL_TO, ]); $limitedoperators = $filter->restrict_limited_operators([ text::CONTAINS => 'Contains', text::DOES_NOT_CONTAIN => 'Does not contain', text::IS_EQUAL_TO => 'Is equal to', text::IS_NOT_EQUAL_TO => 'Is not equal to', ]); $this->assertEquals([ text::IS_EQUAL_TO => 'Is equal to', text::IS_NOT_EQUAL_TO => 'Is not equal to', ], $limitedoperators); } /** * Test not restricting filter operators */ public function test_unlimited_operators(): void { $filter = $this->create_filter('username', 'u.username'); $operators = [ text::CONTAINS => 'Contains', text::DOES_NOT_CONTAIN => 'Does not contain', ]; // If no operator limit has been set for the filter, then all available operators should be present. $this->assertEquals($operators, $filter->restrict_limited_operators($operators)); } /** * Helper method to create a filter instance * * @param string $name * @param string $fieldsql * @param array $fieldparams * @return filter */ private function create_filter(string $name, string $fieldsql = '', array $fieldparams = []): filter { return new filter(text::class, $name, new lang_string($name), 'filter_testcase', $fieldsql, $fieldparams); } } PK a<�\g�]�B �B " tests/local/report/column_test.phpnu �[��� <?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\local\report; use advanced_testcase; use coding_exception; use lang_string; use stdClass; use core_reportbuilder\local\helpers\database; /** * Unit tests for a report column * * @package core_reportbuilder * @covers \core_reportbuilder\local\report\column * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class column_test extends advanced_testcase { /** * Test column name getter/setter */ public function test_name(): void { $column = $this->create_column('test'); $this->assertEquals('test', $column->get_name()); $this->assertEquals('another', $column ->set_name('another') ->get_name() ); } /** * Test column title getter/setter */ public function test_title(): void { $column = $this->create_column('test', new lang_string('show')); $this->assertEquals('Show', $column->get_title()); $this->assertFalse($column->has_custom_title()); $this->assertEquals('Hide', $column ->set_title(new lang_string('hide')) ->get_title() ); $this->assertTrue($column->has_custom_title()); // Column titles can also be empty. $this->assertEmpty($column ->set_title(null) ->get_title()); } /** * Test entity name getter */ public function test_get_entity_name(): void { $column = $this->create_column('test', null, 'entityname'); $this->assertEquals('entityname', $column->get_entity_name()); } /** * Test getting unique identifier */ public function test_get_unique_identifier(): void { $column = $this->create_column('test', null, 'entityname'); $this->assertEquals('entityname:test', $column->get_unique_identifier()); } /** * Test column type getter/setter */ public function test_type(): void { $column = $this->create_column('test'); $this->assertEquals(column::TYPE_INTEGER, $column ->set_type(column::TYPE_INTEGER) ->get_type()); } /** * Test column default type */ public function test_type_default(): void { $column = $this->create_column('test'); $this->assertEquals(column::TYPE_TEXT, $column->get_type()); } /** * Test column type with invalid value */ public function test_type_invalid(): void { $column = $this->create_column('test'); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Invalid column type'); $column->set_type(-1); } /** * Data provider for {@see test_add_field} * * @return array */ public static function add_field_provider(): array { return [ ['foo', '', ['foo AS c1_foo']], ['foo', 'bar', ['foo AS c1_bar']], ['t.foo', '', ['t.foo AS c1_foo']], ['t.foo', 'bar', ['t.foo AS c1_bar']], ]; } /** * Test adding single field, and retrieving it * * @param string $sql * @param string $alias * @param array $expectedselect * * @dataProvider add_field_provider */ public function test_add_field(string $sql, string $alias, array $expectedselect): void { $column = $this->create_column('test') ->set_index(1) ->add_field($sql, $alias); $this->assertEquals($expectedselect, $column->get_fields()); } /** * Test adding params to field, and retrieving them */ public function test_add_field_with_params(): void { [$param0, $param1] = database::generate_param_names(2); $column = $this->create_column('test') ->set_index(1) ->add_field(":{$param0}", 'foo', [$param0 => 'foo']) ->add_field(":{$param1}", 'bar', [$param1 => 'bar']); // Select will look like the following: "p<index>_rbparam<counter>", where index is the column index and counter is // a static value of the report helper class. $fields = $column->get_fields(); $this->assertCount(2, $fields); preg_match('/:(?<paramname>p1_rbparam[\d]+) AS c1_foo/', $fields[0], $matches); $this->assertArrayHasKey('paramname', $matches); $fieldparam0 = $matches['paramname']; preg_match('/:(?<paramname>p1_rbparam[\d]+) AS c1_bar/', $fields[1], $matches); $this->assertArrayHasKey('paramname', $matches); $fieldparam1 = $matches['paramname']; // Ensure column parameters have been renamed appropriately. $this->assertEquals([ $fieldparam0 => 'foo', $fieldparam1 => 'bar', ], $column->get_params()); } /** * Test adding field with alias as part of SQL throws an exception */ public function test_add_field_alias_in_sql(): void { $column = $this->create_column('test') ->set_index(1); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Column alias must be passed as a separate argument'); $column->add_field('foo AS bar'); } /** * Test adding field with complex SQL without an alias throws an exception */ public function test_add_field_complex_without_alias(): void { global $DB; $column = $this->create_column('test') ->set_index(1); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Complex columns must have an alias'); $column->add_field($DB->sql_concat('foo', 'bar')); } /** * Data provider for {@see test_add_fields} * * @return array */ public static function add_fields_provider(): array { return [ ['t.foo', ['t.foo AS c1_foo']], ['t.foo bar', ['t.foo AS c1_bar']], ['t.foo AS bar', ['t.foo AS c1_bar']], ['t.foo1, t.foo2 bar, t.foo3 AS baz', ['t.foo1 AS c1_foo1', 't.foo2 AS c1_bar', 't.foo3 AS c1_baz']], ]; } /** * Test adding fields to a column, and retrieving them * * @param string $sql * @param array $expectedselect * * @dataProvider add_fields_provider */ public function test_add_fields(string $sql, array $expectedselect): void { $column = $this->create_column('test') ->set_index(1) ->add_fields($sql); $this->assertEquals($expectedselect, $column->get_fields()); } /** * Test column alias */ public function test_column_alias(): void { $column = $this->create_column('test') ->set_index(1) ->add_fields('t.foo, t.bar'); $this->assertEquals('c1_foo', $column->get_column_alias()); } /** * Test column alias with a field containing an alias */ public function test_column_alias_with_field_alias(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('COALESCE(t.foo, t.bar)', 'lionel'); $this->assertEquals('c1_lionel', $column->get_column_alias()); } /** * Test alias of column without any fields throws exception */ public function test_column_alias_no_fields(): void { $column = $this->create_column('test'); $this->expectException(coding_exception::class); $this->expectExceptionMessage('Column ' . $column->get_unique_identifier() . ' contains no fields'); $column->add_field($column->get_column_alias()); } /** * Test setting column group by SQL */ public function test_set_groupby_sql(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('COALESCE(t.foo, t.bar)', 'lionel') ->set_groupby_sql('t.id'); $this->assertEquals(['t.id'], $column->get_groupby_sql()); } /** * Test getting default column group by SQL */ public function test_get_groupby_sql(): void { global $DB; $column = $this->create_column('test') ->set_index(1) ->add_fields('t.foo, t.bar'); // The behaviour of this method differs due to DB limitations. $usealias = in_array($DB->get_dbfamily(), ['mysql', 'postgres']); if ($usealias) { $expected = ['c1_foo', 'c1_bar']; } else { $expected = ['t.foo', 't.bar']; } $this->assertEquals($expected, $column->get_groupby_sql()); } /** * Data provider for {@see test_get_default_value} and {@see test_format_value} * * @return array[] */ public static function column_type_provider(): array { return [ [column::TYPE_INTEGER, 42], [column::TYPE_TEXT, 'Hello'], [column::TYPE_TIMESTAMP, HOURSECS], [column::TYPE_BOOLEAN, 1, true], [column::TYPE_FLOAT, 1.23], [column::TYPE_LONGTEXT, 'Amigos'], ]; } /** * Test default value is returned from selected values, with correct type * * @param int $columntype * @param mixed $value * @param mixed|null $expected Expected value, or null to indicate it should be identical to value * * @dataProvider column_type_provider */ public function test_get_default_value(int $columntype, $value, $expected = null): void { $defaultvalue = column::get_default_value([ 'value' => $value, 'foo' => 'bar', ], $columntype); $this->assertSame($expected ?? $value, $defaultvalue); } /** * Test that column value is returned correctly, with correct type * * @param int $columntype * @param mixed $value * @param mixed|null $expected Expected value, or null to indicate it should be identical to value * * @dataProvider column_type_provider */ public function test_format_value(int $columntype, $value, $expected = null): void { $column = $this->create_column('test') ->set_index(1) ->set_type($columntype) ->add_field('t.foo'); $this->assertSame($expected ?? $value, $column->format_value([ 'c1_foo' => $value, ])); } /** * Test that column value with callback is returned */ public function test_format_value_callback(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('t.foo') ->set_type(column::TYPE_INTEGER) ->add_callback(static function(int $value, stdClass $values) { return $value * 2; }); $this->assertEquals(84, $column->format_value([ 'c1_bar' => 10, 'c1_foo' => 42, ])); } /** * Test that column value with callback (using all fields) is returned */ public function test_format_value_callback_fields(): void { $column = $this->create_column('test') ->set_index(1) ->add_fields('t.foo, t.baz') ->set_type(column::TYPE_INTEGER) ->add_callback(static function(int $value, stdClass $values) { return $values->foo + $values->baz; }); $this->assertEquals(60, $column->format_value([ 'c1_bar' => 10, 'c1_foo' => 42, 'c1_baz' => 18, ])); } /** * Test that column value with callback (using arguments) is returned */ public function test_format_value_callback_arguments(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('t.foo') ->set_type(column::TYPE_INTEGER) ->add_callback(static function(int $value, stdClass $values, int $argument) { return $value - $argument; }, 10); $this->assertEquals(32, $column->format_value([ 'c1_bar' => 10, 'c1_foo' => 42, ])); } /** * Test that column value with callback (where aggregation is not set) is returned */ public function test_format_value_callback_aggregation(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('t.foo') ->set_type(column::TYPE_INTEGER) ->add_callback(static function(int $value, stdClass $values, $argument, ?string $aggregation): string { // Simple callback to return the given value, and append type of aggregation parameter. return "{$value} " . gettype($aggregation); }); $this->assertEquals("42 NULL", $column->format_value(['c1_foo' => 42])); } /** * Test adding multiple callbacks to a column */ public function test_add_multiple_callback(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('t.foo') ->set_type(column::TYPE_TEXT) ->add_callback(static function(string $value): string { return strrev($value); }) ->add_callback(static function(string $value): string { return strtoupper($value); }); $this->assertEquals('LIONEL', $column->format_value([ 'c1_foo' => 'lenoil', ])); } /** * Test that setting column callback overwrites previous callbacks */ public function test_set_callback(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('t.foo') ->set_type(column::TYPE_TEXT) ->add_callback(static function(string $value): string { return strrev($value); }) ->set_callback(static function(string $value): string { return strtoupper($value); }); $this->assertEquals('LENOIL', $column->format_value([ 'c1_foo' => 'lenoil', ])); } /** * Test is sortable */ public function test_is_sortable(): void { $column = $this->create_column('test'); $this->assertFalse($column->get_is_sortable()); $column->set_is_sortable(true); $this->assertTrue($column->get_is_sortable()); } /** * Test retrieving sort fields */ public function test_get_sortfields(): void { $column = $this->create_column('test') ->set_index(1) ->add_fields('t.foo, t.bar, t.baz') ->set_is_sortable(true, ['t.baz', 't.bar']); $this->assertEquals(['c1_baz', 'c1_bar'], $column->get_sort_fields()); } /** * Test retrieving sort fields when an aliased field is set as sortable */ public function test_get_sortfields_with_field_alias(): void { $column = $this->create_column('test') ->set_index(1) ->add_field('t.foo') ->add_field('COALESCE(t.foo, t.bar)', 'lionel') ->set_is_sortable(true, ['lionel']); $this->assertEquals(['c1_lionel'], $column->get_sort_fields()); } /** * Test retrieving sort fields when an unknown field is set as sortable */ public function test_get_sortfields_unknown_field(): void { $column = $this->create_column('test') ->set_index(1) ->add_fields('t.foo') ->set_is_sortable(true, ['t.baz']); $this->assertEquals(['t.baz'], $column->get_sort_fields()); } /** * Test is available */ public function test_is_available(): void { $column = $this->create_column('test'); $this->assertTrue($column->get_is_available()); $column->set_is_available(true); $this->assertTrue($column->get_is_available()); } /** * Helper method to create a column instance * * @param string $name * @param lang_string|null $title * @param string $entityname * @return column */ private function create_column(string $name, ?lang_string $title = null, string $entityname = 'column_testcase'): column { return new column($name, $title, $entityname); } } PK a<�\��$� � " tests/local/report/action_test.phpnu �[��� <?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\local\report; use advanced_testcase; use lang_string; use moodle_url; use pix_icon; use stdClass; /** * Unit tests for a report action * * @package core_reportbuilder * @covers \core_reportbuilder\local\report\action * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class action_test extends advanced_testcase { /** * Test adding a callback that returns true */ public function test_add_callback_true(): void { $action = $this->create_action() ->add_callback(static function(stdClass $row): bool { return true; }); $this->assertNotNull($action->get_action_link(new stdClass())); } /** * Test adding a callback that returns false */ public function test_add_callback_false(): void { $action = $this->create_action() ->add_callback(static function(stdClass $row): bool { return false; }); $this->assertNull($action->get_action_link(new stdClass())); } /** * Data provider for {@see test_action_title} * * @return array[] */ public static function action_title_provider(): array { $title = new lang_string('yes'); return [ 'Specified via constructor' => ['', [], $title], 'Specified via pix icon' => [(string) $title], 'Specified via attributes' => ['', ['title' => $title]], 'Specified via attributes placeholder' => ['', ['title' => ':title'], null, ['title' => $title]], ]; } /** * Test action title is correct * * @param string $pixiconalt * @param array $attributes * @param lang_string|null $title * @param array $row * * @dataProvider action_title_provider */ public function test_action_title( string $pixiconalt, array $attributes = [], ?lang_string $title = null, array $row = [] ): void { $action = new action( new moodle_url('#'), new pix_icon('t/edit', $pixiconalt), $attributes, false, $title ); // Assert correct title appears inside action link, after the icon. $actionlink = $action->get_action_link((object) $row); $this->assertEquals('Yes', $actionlink->text); } /** * Test that action link URL parameters have placeholders replaced */ public function test_get_action_link_url_parameters(): void { $action = $this->create_action(['id' => ':id', 'action' => 'edit']); $actionlink = $action->get_action_link((object) ['id' => 42]); // This is the action URL we expect. $expectedactionurl = (new moodle_url('/', ['id' => 42, 'action' => 'edit']))->out(false); $this->assertEquals($expectedactionurl, $actionlink->url->out(false)); } /** * Test that action link attributes have placeholders replaced */ public function test_get_action_link_attributes(): void { $action = $this->create_action([], ['data-id' => ':id', 'data-action' => 'edit']); $actionlink = $action->get_action_link((object) ['id' => 42]); // We expect each of these attributes to exist. $expectedattributes = [ 'data-id' => 42, 'data-action' => 'edit', ]; foreach ($expectedattributes as $key => $value) { $this->assertEquals($value, $actionlink->attributes[$key]); } } /** * Helper method to create an action instance * * @param array $urlparams * @param array $attributes * @return action */ private function create_action(array $urlparams = [], array $attributes = []): action { return new action( new moodle_url('/', $urlparams), new pix_icon('t/edit', get_string('edit')), $attributes ); } } PK a<�\0h-� � " tests/local/models/report_test.phpnu �[��� <?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\local\models; use advanced_testcase; use core_reportbuilder\event\report_created; use core_reportbuilder\event\report_deleted; use core_reportbuilder\event\report_updated; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; /** * Unit tests for the report model * * @package core_reportbuilder * @covers \core_reportbuilder\local\models\report * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class report_test extends advanced_testcase { /** * Tests for report_created event * * @return report * * @covers \core_reportbuilder\event\report_created */ public function test_report_created_event(): report { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Catch the events. $sink = $this->redirectEvents(); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(report_created::class, $event); $this->assertEquals(report::TABLE, $event->objecttable); $this->assertEquals($report->get('id'), $event->objectid); $this->assertEquals($report->get('name'), $event->other['name']); $this->assertEquals($report->get('source'), $event->other['source']); $this->assertEquals($report->get_context()->id, $event->contextid); return $report; } /** * Tests for report_updated event * * @param report $report * @return report * * @depends test_report_created_event * @covers \core_reportbuilder\event\report_updated */ public function test_report_updated_event(report $report): report { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Re-create the persistent. $report = new report($DB->insert_record(report::TABLE, $report->to_record())); // Catch the events. $sink = $this->redirectEvents(); $report->set('name', 'New report name')->update(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(report_updated::class, $event); $this->assertEquals(report::TABLE, $event->objecttable); $this->assertEquals($report->get('id'), $event->objectid); $this->assertEquals('New report name', $event->other['name']); $this->assertEquals($report->get('source'), $event->other['source']); $this->assertEquals($report->get_context()->id, $event->contextid); return $report; } /** * Tests for report_deleted event * * @param report $report * * @depends test_report_updated_event * @covers \core_reportbuilder\event\report_deleted */ public function test_report_deleted_event(report $report): void { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Re-create the persistent (remembering report ID which is removed from persistent upon deletion). $reportid = $DB->insert_record(report::TABLE, $report->to_record()); $report = new report($reportid); // Catch the events. $sink = $this->redirectEvents(); $report->delete(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(report_deleted::class, $event); $this->assertEquals(report::TABLE, $event->objecttable); $this->assertEquals($reportid, $event->objectid); $this->assertEquals($report->get('name'), $event->other['name']); $this->assertEquals($report->get('source'), $event->other['source']); $this->assertEquals($report->get_context()->id, $event->contextid); } } PK a<�\�F��O O $ tests/local/models/audience_test.phpnu �[��� <?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\local\models; use advanced_testcase; use core\persistent; use core_reportbuilder\event\audience_created; use core_reportbuilder\event\audience_deleted; use core_reportbuilder\event\audience_updated; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; /** * Unit tests for the audience model * * @package core_reportbuilder * @covers \core_reportbuilder\local\models\audience * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class audience_test extends advanced_testcase { /** * Tests for audience_created event * * @return persistent[] * * @covers \core_reportbuilder\event\audience_created */ public function test_audience_created_event(): array { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Catch the events. $sink = $this->redirectEvents(); $audience = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]) ->get_persistent(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(audience_created::class, $event); $this->assertEquals(audience::TABLE, $event->objecttable); $this->assertEquals($audience->get('id'), $event->objectid); $this->assertEquals($report->get('id'), $event->other['reportid']); $this->assertEquals($report->get_context()->id, $event->contextid); return [$report, $audience]; } /** * Tests for audience_updated event * * @param persistent[] $persistents * @return persistent[] * * @depends test_audience_created_event * @covers \core_reportbuilder\event\audience_updated */ public function test_audience_updated_event(array $persistents): array { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Re-create the persistents. [$report, $audience] = $persistents; $report = new report($DB->insert_record(report::TABLE, $report->to_record())); $audience = new audience($DB->insert_record(audience::TABLE, $audience->to_record())); // Catch the events. $sink = $this->redirectEvents(); $audience->set('heading', 'Hello')->update(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(audience_updated::class, $event); $this->assertEquals(audience::TABLE, $event->objecttable); $this->assertEquals($audience->get('id'), $event->objectid); $this->assertEquals($report->get('id'), $event->other['reportid']); $this->assertEquals($report->get_context()->id, $event->contextid); return [$report, $audience]; } /** * Tests for audience_deleted event * * @param persistent[] $persistents * * @depends test_audience_updated_event * @covers \core_reportbuilder\event\audience_deleted */ public function test_audience_deleted_event(array $persistents): void { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Re-create the persistents (remembering audience ID which is removed from persistent upon deletion). [$report, $audience] = $persistents; $report = new report($DB->insert_record(report::TABLE, $report->to_record())); $audienceid = $DB->insert_record(audience::TABLE, $audience->to_record()); $audience = new audience($audienceid); // Catch the events. $sink = $this->redirectEvents(); $audience->delete(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(audience_deleted::class, $event); $this->assertEquals(audience::TABLE, $event->objecttable); $this->assertEquals($audienceid, $event->objectid); $this->assertEquals($report->get('id'), $event->other['reportid']); $this->assertEquals($report->get_context()->id, $event->contextid); } } PK a<�\tٕ< < $ tests/local/models/schedule_test.phpnu �[��� <?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\local\models; use advanced_testcase; use core\persistent; use core_reportbuilder\event\schedule_created; use core_reportbuilder\event\schedule_deleted; use core_reportbuilder\event\schedule_updated; use core_reportbuilder_generator; use core_user\reportbuilder\datasource\users; /** * Unit tests for the schedule model * * @package core_reportbuilder * @covers \core_reportbuilder\local\models\schedule * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class schedule_test extends advanced_testcase { /** * Tests for schedule_created event * * @return persistent[] * * @covers \core_reportbuilder\event\schedule_created */ public function test_schedule_created_event(): array { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Catch the events. $sink = $this->redirectEvents(); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(schedule_created::class, $event); $this->assertEquals(schedule::TABLE, $event->objecttable); $this->assertEquals($schedule->get('id'), $event->objectid); $this->assertEquals($report->get('id'), $event->other['reportid']); $this->assertEquals($report->get_context()->id, $event->contextid); return [$report, $schedule]; } /** * Tests for schedule_updated event * * @param persistent[] $persistents * @return persistent[] * * @depends test_schedule_created_event * @covers \core_reportbuilder\event\schedule_updated */ public function test_schedule_updated_event(array $persistents): array { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Re-create the persistents. [$report, $schedule] = $persistents; $report = new report($DB->insert_record(report::TABLE, $report->to_record())); $schedule = new schedule($DB->insert_record(schedule::TABLE, $schedule->to_record())); // Catch the events. $sink = $this->redirectEvents(); $schedule->set('name', 'My new schedule')->update(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(schedule_updated::class, $event); $this->assertEquals(schedule::TABLE, $event->objecttable); $this->assertEquals($schedule->get('id'), $event->objectid); $this->assertEquals($report->get('id'), $event->other['reportid']); $this->assertEquals($report->get_context()->id, $event->contextid); return [$report, $schedule]; } /** * Tests for schedule_deleted event * * @param persistent[] $persistents * * @depends test_schedule_updated_event * @covers \core_reportbuilder\event\schedule_deleted */ public function test_schedule_deleted_event(array $persistents): void { global $DB; $this->resetAfterTest(); $this->setAdminUser(); // Re-create the persistents (remembering schedule ID which is removed from persistent upon deletion). [$report, $schedule] = $persistents; $report = new report($DB->insert_record(report::TABLE, $report->to_record())); $scheduleid = $DB->insert_record(schedule::TABLE, $schedule->to_record()); $schedule = new schedule($scheduleid); // Catch the events. $sink = $this->redirectEvents(); $schedule->delete(); $events = $sink->get_events(); $sink->close(); // Validate the event. $this->assertCount(1, $events); $event = reset($events); $this->assertInstanceOf(schedule_deleted::class, $event); $this->assertEquals(schedule::TABLE, $event->objecttable); $this->assertEquals($scheduleid, $event->objectid); $this->assertEquals($report->get('id'), $event->other['reportid']); $this->assertEquals($report->get_context()->id, $event->contextid); } } PK a<�\�>� $ tests/local/aggregation/min_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; /** * Unit tests for min aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\min * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class min_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Admin', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user suspended. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => min::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 'Yes'], ['Admin', 'No'], ], array_map('array_values', $content)); } } PK a<�\�y�4� � , tests/local/aggregation/groupconcat_test.phpnu �[��� <?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\local\aggregation; use core_badges_generator; use core_badges\reportbuilder\datasource\badges; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; use stdClass; /** * Unit tests for group concatenation aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\groupconcat * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class groupconcat_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Apple']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user lastname. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'aggregation' => groupconcat::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_ASC, ]); // Assert lastname column was aggregated, and itself also sorted predictably. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 'Apple, Banana, Banana'], ['Admin', 'User'], ], array_map('array_values', $content)); } /** * Test aggregation when applied to column with multiple fields */ public function test_column_aggregation_multiple_fields(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(['firstname' => 'Adam', 'lastname' => 'Apple']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullnamewithlink', 'aggregation' => groupconcat::get_class_name(), ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertCount(1, $content); // Ensure users are sorted predictably (Adam -> Admin). [$userone, $usertwo] = explode(', ', reset($content[0])); $this->assertStringContainsString(fullname($user, true), $userone); $this->assertStringContainsString(fullname(get_admin(), true), $usertwo); } /** * Test aggregation when applied to column with callback */ public function test_column_aggregation_with_callback(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 0]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // First column, sorted. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:confirmed', 'aggregation' => groupconcat::get_class_name(), ]); // Add callback to format the column. $instance = manager::get_report_from_persistent($report); $instance->get_column('user:confirmed') ->add_callback(static function(string $value, stdClass $row, $arguments, ?string $aggregation): string { // Simple callback to return the given value, and append aggregation type. return "{$value} ({$aggregation})"; }); // Assert confirmed column was aggregated, and sorted predictably with callback applied. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_confirmed' => 'Yes (groupconcat)', ], [ 'c0_firstname' => 'Bob', 'c1_confirmed' => 'No (groupconcat), Yes (groupconcat), Yes (groupconcat)', ], ], $content); } /** * Test aggregation when applied to column with callback that expects/handles null values */ public function test_datasource_aggregate_column_callback_with_null(): void { $this->resetAfterTest(); $this->setAdminUser(); $userone = $this->getDataGenerator()->create_user(['description' => 'First user']); $usertwo = $this->getDataGenerator()->create_user(['description' => 'Second user']); /** @var core_badges_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_badges'); // Create course badge, issue to both users. $badgeone = $generator->create_badge(['name' => 'First badge']); $badgeone->issue($userone->id, true); $badgeone->issue($usertwo->id, true); // Create second badge, without issuing to anyone. $badgetwo = $generator->create_badge(['name' => 'Second badge']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Badges', 'source' => badges::class, 'default' => 0]); // First column, sorted. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'badge:name', 'sortenabled' => 1]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:description', 'aggregation' => groupconcat::get_class_name(), ]); // Assert description column was aggregated, with callbacks accounting for null values. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_name' => $badgeone->name, 'c1_description' => "{$userone->description}, {$usertwo->description}", ], [ 'c0_name' => $badgetwo->name, 'c1_description' => '', ], ], $content); } } PK a<�\ӗl . tests/local/aggregation/countdistinct_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; /** * Unit tests for count distinct aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\countdistinct * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class countdistinct_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Apple']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user lastname. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'aggregation' => countdistinct::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 2], ['Admin', 1], ], array_map('array_values', $content)); } /** * Test aggregation when applied to column with multiple fields */ public function test_column_aggregation_multiple_fields(): void { $this->resetAfterTest(); // Create a user with the same firstname as existing admin. $this->getDataGenerator()->create_user(['firstname' => 'Admin', 'lastname' => 'Test']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname', 'aggregation' => countdistinct::get_class_name(), ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertCount(1, $content); // There are two distinct fullnames ("Admin User" & "Admin Test"). $countdistinct = reset($content[0]); $this->assertEquals(2, $countdistinct); } } PK a<�\�)�� 4 tests/local/aggregation/groupconcatdistinct_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\report\column; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; use stdClass; /** * Unit tests for group concatenation distinct aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\groupconcatdistinct * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class groupconcatdistinct_test extends core_reportbuilder_testcase { /** * Test setup, we need to skip these tests on non-supported databases */ public function setUp(): void { global $DB; parent::setUp(); if (!groupconcatdistinct::compatible(column::TYPE_TEXT)) { $this->markTestSkipped('Distinct group concatenation not supported in ' . $DB->get_dbfamily()); } } /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Apple']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user lastname. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'aggregation' => groupconcatdistinct::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_ASC, ]); // Assert lastname column was aggregated, and itself also sorted predictably. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 'Apple, Banana'], ['Admin', 'User'], ], array_map('array_values', $content)); } /** * Test aggregation when applied to column with multiple fields */ public function test_column_aggregation_multiple_fields(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(['firstname' => 'Adam', 'lastname' => 'Apple']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullnamewithlink', 'aggregation' => groupconcatdistinct::get_class_name(), ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertCount(1, $content); // Ensure users are sorted predictably (Adam -> Admin). [$userone, $usertwo] = explode(', ', reset($content[0])); $this->assertStringContainsString(fullname($user, true), $userone); $this->assertStringContainsString(fullname(get_admin(), true), $usertwo); } /** * Test aggregation when applied to column with callback */ public function test_column_aggregation_with_callback(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 0]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'confirmed' => 1]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // First column, sorted. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); // This is the column we'll aggregate. $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:confirmed', 'aggregation' => groupconcatdistinct::get_class_name(), ]); // Add callback to format the column. $instance = manager::get_report_from_persistent($report); $instance->get_column('user:confirmed') ->add_callback(static function(string $value, stdClass $row, $arguments, ?string $aggregation): string { // Simple callback to return the given value, and append aggregation type. return "{$value} ({$aggregation})"; }); // Assert confirmed column was aggregated, and sorted predictably with callback applied. $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_confirmed' => 'Yes (groupconcatdistinct)', ], [ 'c0_firstname' => 'Bob', 'c1_confirmed' => 'No (groupconcatdistinct), Yes (groupconcatdistinct)', ], ], $content); } } PK a<�\��I�� � $ tests/local/aggregation/sum_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\report\column; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; use stdClass; /** * Unit tests for sum aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\sum * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class sum_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user suspended. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => sum::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 2], ['Admin', 0], ], array_map('array_values', $content)); } /** * Test aggregation when applied to column with callback */ public function test_column_aggregation_with_callback(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // First column, sorted. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); // This is the column we'll aggregate. $generator->create_column( ['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => sum::get_class_name()] ); // Set callback to format the column (hack column definition to ensure callbacks are executed). $instance = manager::get_report_from_persistent($report); $instance->get_column('user:suspended') ->set_type(column::TYPE_INTEGER) ->set_callback(static function(int $value, stdClass $row, $arguments, ?string $aggregation): string { // Simple callback to return the given value, and append aggregation type. return "{$value} ({$aggregation})"; }); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_suspended' => '0 (sum)', ], [ 'c0_firstname' => 'Bob', 'c1_suspended' => '2 (sum)', ], ], $content); } } PK a<�\r "�� � $ tests/local/aggregation/avg_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\manager; use core_reportbuilder\local\report\column; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; use stdClass; /** * Unit tests for avg aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\avg * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class avg_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 0]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user suspended. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => avg::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', '0.5'], ['Admin', '0.0'], ], array_map('array_values', $content)); } /** * Test aggregation when applied to column with callback */ public function test_column_aggregation_with_callback(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 0]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // First column, sorted. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); // This is the column we'll aggregate. $generator->create_column( ['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => avg::get_class_name()] ); // Set callback to format the column (hack column definition to ensure callbacks are executed). $instance = manager::get_report_from_persistent($report); $instance->get_column('user:suspended') ->set_type(column::TYPE_FLOAT) ->set_callback(static function(float $value, stdClass $row, $arguments, ?string $aggregation): string { // Simple callback to return the given value, and append aggregation type. return number_format($value, 1) . " ({$aggregation})"; }); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'c0_firstname' => 'Admin', 'c1_suspended' => '0.0 (avg)', ], [ 'c0_firstname' => 'Bob', 'c1_suspended' => '0.5 (avg)', ], ], $content); } } PK a<�\��]t t & tests/local/aggregation/count_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; /** * Unit tests for count aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\count * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class count_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Apple']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Banana']); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user lastname. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:lastname', 'aggregation' => count::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 3], ['Admin', 1], ], array_map('array_values', $content)); } } PK a<�\�;�: ( tests/local/aggregation/percent_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; /** * Unit tests for sum aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\percent * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class percent_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 0]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user suspended. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => percent::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', '50.0%'], ['Admin', '0.0%'], ], array_map('array_values', $content)); } } PK a<�\%�� $ tests/local/aggregation/max_test.phpnu �[��� <?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\local\aggregation; use core_reportbuilder_generator; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; /** * Unit tests for max aggregation * * @package core_reportbuilder * @covers \core_reportbuilder\local\aggregation\base * @covers \core_reportbuilder\local\aggregation\max * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class max_test extends core_reportbuilder_testcase { /** * Test aggregation when applied to column */ public function test_column_aggregation(): void { $this->resetAfterTest(); // Test subjects. $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 1]); $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'suspended' => 0]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Report columns, aggregated/sorted by user suspended. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname']); $generator->create_column([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:suspended', 'aggregation' => max::get_class_name(), 'sortenabled' => 1, 'sortdirection' => SORT_DESC, ]); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ ['Bob', 'Yes'], ['Admin', 'No'], ], array_map('array_values', $content)); } } PK a<�\XF�6y 6y # tests/local/helpers/report_test.phpnu �[��� <?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\local\helpers; use advanced_testcase; use core_reportbuilder_generator; use invalid_parameter_exception; use core_reportbuilder\datasource; use core_reportbuilder\local\models\column; use core_reportbuilder\local\models\filter; use core_tag_tag; use core_user\reportbuilder\datasource\users; /** * Unit tests for the report helper class * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\report * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class report_test extends advanced_testcase { /** * Test creation report */ public function test_create_report(): void { $this->resetAfterTest(); $this->setAdminUser(); $report = report::create_report((object) [ 'name' => 'My report with tags', 'source' => users::class, 'tags' => ['cat', 'dog'], ]); $this->assertEquals('My report with tags', $report->get('name')); $this->assertEquals(datasource::TYPE_CUSTOM_REPORT, $report->get('type')); $this->assertEqualsCanonicalizing(['cat', 'dog'], core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $report->get('id'))); $report = report::create_report((object) [ 'name' => 'My report without tags', 'source' => users::class, ]); $this->assertEquals('My report without tags', $report->get('name')); $this->assertEquals(datasource::TYPE_CUSTOM_REPORT, $report->get('type')); $this->assertEmpty(core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $report->get('id'))); } /** * Test updating report */ public function test_update_report(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'uniquerows' => 0]); $reportupdated = report::update_report((object) [ 'id' => $report->get('id'), 'name' => 'My renamed report without add tags', 'uniquerows' => 1, ]); $this->assertEquals('My renamed report without add tags', $reportupdated->get('name')); $this->assertTrue($reportupdated->get('uniquerows')); $this->assertEmpty(core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $reportupdated->get('id'))); $reportupdated = report::update_report((object) [ 'id' => $report->get('id'), 'name' => 'My renamed report adding tags', 'uniquerows' => 1, 'tags' => ['cat', 'dog'], ]); $this->assertEquals('My renamed report adding tags', $reportupdated->get('name')); $this->assertTrue($reportupdated->get('uniquerows')); $this->assertEqualsCanonicalizing(['cat', 'dog'], core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $reportupdated->get('id'))); } /** * Test deleting report */ public function test_delete_report(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create Report1 and add some elements. $report1 = $generator->create_report(['name' => 'My report 1', 'source' => users::class, 'default' => false, 'tags' => ['cat', 'dog']]); $column1 = $generator->create_column(['reportid' => $report1->get('id'), 'uniqueidentifier' => 'user:email']); $filter1 = $generator->create_filter(['reportid' => $report1->get('id'), 'uniqueidentifier' => 'user:email']); $condition1 = $generator->create_condition(['reportid' => $report1->get('id'), 'uniqueidentifier' => 'user:email']); // Create Report2 and add some elements. $report2 = $generator->create_report(['name' => 'My report 2', 'source' => users::class, 'default' => false]); $column2 = $generator->create_column(['reportid' => $report2->get('id'), 'uniqueidentifier' => 'user:email']); $filter2 = $generator->create_filter(['reportid' => $report2->get('id'), 'uniqueidentifier' => 'user:email']); $condition2 = $generator->create_condition(['reportid' => $report2->get('id'), 'uniqueidentifier' => 'user:email']); // Delete Report1. $result = report::delete_report($report1->get('id')); $this->assertTrue($result); // Make sure Report1, and all it's elements are deleted. $this->assertFalse($report1::record_exists($report1->get('id'))); $this->assertFalse($column1::record_exists($column1->get('id'))); $this->assertFalse($filter1::record_exists($filter1->get('id'))); $this->assertFalse($condition1::record_exists($condition1->get('id'))); $this->assertEmpty(core_tag_tag::get_item_tags_array('core_reportbuilder', 'reportbuilder_report', $report1->get('id'))); // Make sure Report2, and all it's elements still exist. $this->assertTrue($report2::record_exists($report2->get('id'))); $this->assertTrue($column2::record_exists($column2->get('id'))); $this->assertTrue($filter2::record_exists($filter2->get('id'))); $this->assertTrue($condition2::record_exists($condition2->get('id'))); } /** * Testing adding report column */ public function test_add_report_column(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add first column. $columnfullname = report::add_report_column($report->get('id'), 'user:fullname'); $this->assertTrue(column::record_exists($columnfullname->get('id'))); $this->assertEquals($report->get('id'), $columnfullname->get('reportid')); $this->assertEquals('user:fullname', $columnfullname->get('uniqueidentifier')); $this->assertEquals(1, $columnfullname->get('columnorder')); $this->assertEquals(1, $columnfullname->get('sortorder')); // Add second column. $columnemail = report::add_report_column($report->get('id'), 'user:email'); $this->assertTrue(column::record_exists($columnemail->get('id'))); $this->assertEquals($report->get('id'), $columnemail->get('reportid')); $this->assertEquals('user:email', $columnemail->get('uniqueidentifier')); $this->assertEquals(2, $columnemail->get('columnorder')); $this->assertEquals(2, $columnemail->get('sortorder')); } /** * Test adding invalid report column */ public function test_add_report_column_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid column'); report::add_report_column($report->get('id'), 'user:invalid'); } /** * Testing deleting report column */ public function test_delete_report_column(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add two columns. $columnfullname = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Delete the first column. $result = report::delete_report_column($report->get('id'), $columnfullname->get('id')); $this->assertTrue($result); // Assert report columns. $columns = column::get_records(['reportid' => $report->get('id')]); $this->assertCount(1, $columns); $column = reset($columns); $this->assertEquals('user:email', $column->get('uniqueidentifier')); $this->assertEquals(1, $column->get('columnorder')); } /** * Testing deleting invalid report column */ public function test_delete_report_column_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid column'); report::delete_report_column($report->get('id'), 42); } /** * Testing re-ordering report column */ public function test_reorder_report_column(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Add four columns. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $columncity = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city column to second position. $result = report::reorder_report_column($report->get('id'), $columncity->get('id'), 2); $this->assertTrue($result); // Assert report columns order. $columns = column::get_records(['reportid' => $report->get('id')], 'columnorder'); $columnidentifiers = array_map(static function(column $column): string { return $column->get('uniqueidentifier'); }, $columns); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $columnidentifiers); } /** * Testing re-ordering invalid report column */ public function test_reorder_report_column_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid column'); report::reorder_report_column($report->get('id'), 42, 1); } /** * Testing re-ordering report column sorting */ public function test_reorder_report_column_sorting(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add four columns. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $columncity = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city column to second position. $result = report::reorder_report_column_sorting($report->get('id'), $columncity->get('id'), 2); $this->assertTrue($result); // Assert report columns order. $columns = column::get_records(['reportid' => $report->get('id')], 'sortorder'); $columnidentifiers = array_map(static function(column $column): string { return $column->get('uniqueidentifier'); }, $columns); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $columnidentifiers); } /** * Testing re-ordering invalid report column sorting */ public function test_reorder_report_column_sorting_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid column'); report::reorder_report_column_sorting($report->get('id'), 42, 1); } /** * Test toggling of report column sorting */ public function test_toggle_report_column_sorting(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Toggle sort descending. $result = report::toggle_report_column_sorting($report->get('id'), $column->get('id'), true, SORT_DESC); $this->assertTrue($result); // Confirm column was updated. $columnupdated = new column($column->get('id')); $this->assertTrue($columnupdated->get('sortenabled')); $this->assertEquals(SORT_DESC, $columnupdated->get('sortdirection')); } /** * Test toggling of report column sorting with invalid column */ public function test_toggle_report_column_sorting_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid column'); report::toggle_report_column_sorting($report->get('id'), 42, false); } /** * Test adding report condition */ public function test_add_report_condition(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add first condition. $conditionfullname = report::add_report_condition($report->get('id'), 'user:fullname'); $this->assertTrue(filter::record_exists_select('id = :id AND iscondition = 1', ['id' => $conditionfullname->get('id')])); $this->assertEquals($report->get('id'), $conditionfullname->get('reportid')); $this->assertEquals('user:fullname', $conditionfullname->get('uniqueidentifier')); $this->assertEquals(1, $conditionfullname->get('filterorder')); // Add second condition. $conditionemail = report::add_report_condition($report->get('id'), 'user:email'); $this->assertTrue(filter::record_exists_select('id = :id AND iscondition = 1', ['id' => $conditionemail->get('id')])); $this->assertEquals($report->get('id'), $conditionemail->get('reportid')); $this->assertEquals('user:email', $conditionemail->get('uniqueidentifier')); $this->assertEquals(2, $conditionemail->get('filterorder')); } /** * Test adding invalid report condition */ public function test_add_report_condition_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid condition'); report::add_report_condition($report->get('id'), 'user:invalid'); } /** * Test adding duplicate report condition */ public function test_add_report_condition_duplicate(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // First one is fine. report::add_report_condition($report->get('id'), 'user:email'); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Duplicate condition'); report::add_report_condition($report->get('id'), 'user:email'); } /** * Test deleting report condition */ public function test_delete_report_condition(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add two conditions. $conditionfullname = $generator->create_condition([ 'reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname', ]); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Delete the first condition. $result = report::delete_report_condition($report->get('id'), $conditionfullname->get('id')); $this->assertTrue($result); // Assert report conditions. $conditions = filter::get_condition_records($report->get('id')); $this->assertCount(1, $conditions); $condition = reset($conditions); $this->assertEquals('user:email', $condition->get('uniqueidentifier')); $this->assertEquals(1, $condition->get('filterorder')); } /** * Test deleting invalid report condition */ public function test_delete_report_condition_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid condition'); report::delete_report_condition($report->get('id'), 42); } /** * Test re-ordering report condition */ public function test_reorder_report_condition(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add four conditions. $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $conditioncity = $generator->create_condition(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city condition to second position. $result = report::reorder_report_condition($report->get('id'), $conditioncity->get('id'), 2); $this->assertTrue($result); // Assert report conditions order. $conditions = filter::get_condition_records($report->get('id'), 'filterorder'); $conditionidentifiers = array_map(static function(filter $condition): string { return $condition->get('uniqueidentifier'); }, $conditions); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $conditionidentifiers); } /** * Test re-ordering invalid report condition */ public function test_reorder_report_condition_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid condition'); report::reorder_report_condition($report->get('id'), 42, 1); } /** * Test adding report filter */ public function test_add_report_filter(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add first filter. $filterfullname = report::add_report_filter($report->get('id'), 'user:fullname'); $this->assertTrue(filter::record_exists_select('id = :id AND iscondition = 0', ['id' => $filterfullname->get('id')])); $this->assertEquals($report->get('id'), $filterfullname->get('reportid')); $this->assertEquals('user:fullname', $filterfullname->get('uniqueidentifier')); $this->assertEquals(1, $filterfullname->get('filterorder')); // Add second filter. $filteremail = report::add_report_filter($report->get('id'), 'user:email'); $this->assertTrue(filter::record_exists_select('id = :id AND iscondition = 0', ['id' => $filteremail->get('id')])); $this->assertEquals($report->get('id'), $filteremail->get('reportid')); $this->assertEquals('user:email', $filteremail->get('uniqueidentifier')); $this->assertEquals(2, $filteremail->get('filterorder')); } /** * Test adding invalid report filter */ public function test_add_report_filter_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid filter'); report::add_report_filter($report->get('id'), 'user:invalid'); } /** * Test adding duplicate report filter */ public function test_add_report_filter_duplicate(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // First one is fine. report::add_report_filter($report->get('id'), 'user:email'); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Duplicate filter'); report::add_report_filter($report->get('id'), 'user:email'); } /** * Test deleting report filter */ public function test_delete_report_filter(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add two filters. $filterfullname = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); // Delete the first filter. $result = report::delete_report_filter($report->get('id'), $filterfullname->get('id')); $this->assertTrue($result); // Assert report filters. $filters = filter::get_filter_records($report->get('id')); $this->assertCount(1, $filters); $filter = reset($filters); $this->assertEquals('user:email', $filter->get('uniqueidentifier')); $this->assertEquals(1, $filter->get('filterorder')); } /** * Test deleting invalid report filter */ public function test_delete_report_filter_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid filter'); report::delete_report_filter($report->get('id'), 42); } /** * Test re-ordering report filter */ public function test_reorder_report_filter(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); // Add four filters. $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']); $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']); $filtercity = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']); // Move the city filter to second position. $result = report::reorder_report_filter($report->get('id'), $filtercity->get('id'), 2); $this->assertTrue($result); // Assert report filters order. $filters = filter::get_filter_records($report->get('id'), 'filterorder'); $filteridentifiers = array_map(static function(filter $filter): string { return $filter->get('uniqueidentifier'); }, $filters); $this->assertEquals([ 'user:fullname', 'user:city', 'user:email', 'user:country', ], $filteridentifiers); } /** * Test re-ordering invalid report filter */ public function test_reorder_report_filter_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid filter'); report::reorder_report_filter($report->get('id'), 42, 1); } } PK a<�\_f� # tests/local/helpers/format_test.phpnu �[��� <?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\local\helpers; use advanced_testcase; use stdClass; /** * Unit tests for the format helper * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\format * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class format_test extends advanced_testcase { /** * Test userdate method */ public function test_userdate(): void { $now = time(); $userdate = format::userdate($now, new stdClass()); $this->assertEquals(userdate($now), $userdate); } /** * Data provider for {@see test_format_time} * * @return array[] */ public static function format_time_provider(): array { return [ [null, 0, ''], [0, 0, '0 secs'], [2.456, 1, '2.5 secs'], [3.2, null, '3 secs'], ]; } /** * Test format time * * @param float|null $value * @param int|null $precision * @param string $expected * * @dataProvider format_time_provider */ public function test_format_time(?float $value, ?int $precision, string $expected): void { $this->assertEquals($expected, format::format_time($value, (object) [], $precision)); } /** * Data provider for {@see test_boolean_as_text} * * @return array[] */ public static function boolean_as_text_provider(): array { return [ [false, get_string('no')], [true, get_string('yes')], ]; } /** * Test boolean as text * * @param bool $value * @param string $expected * * @dataProvider boolean_as_text_provider */ public function test_boolean_as_text(bool $value, string $expected): void { $this->assertEquals($expected, format::boolean_as_text($value)); } /** * Test percentage formatting of a float */ public function test_percent(): void { $this->assertEquals('33.3%', format::percent(1 / 3 * 100)); } } PK a<�\j� �� � % tests/local/helpers/database_test.phpnu �[��� <?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\local\helpers; use advanced_testcase; use coding_exception; use core_user; /** * Unit tests for the database helper class * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\database * @copyright 2020 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class database_test extends advanced_testcase { /** * Test generating alias */ public function test_generate_alias(): void { $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', database::generate_alias()); // Specify a suffix. $this->assertMatchesRegularExpression('/^rbalias(\d+)_$/', database::generate_alias('_')); } /** * Test generating multiple aliases */ public function test_generate_aliases(): void { $aliases = database::generate_aliases(3); $this->assertCount(3, $aliases); [$aliasone, $aliastwo, $aliasthree] = $aliases; $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $aliasone); $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $aliastwo); $this->assertMatchesRegularExpression('/^rbalias(\d+)$/', $aliasthree); // Ensure they are different. $this->assertNotEquals($aliasone, $aliastwo); $this->assertNotEquals($aliasone, $aliasthree); $this->assertNotEquals($aliastwo, $aliasthree); // Specify a suffix. [$aliasfour, $aliasfive] = database::generate_aliases(2, '_'); $this->assertNotEquals($aliasfour, $aliasfive); $this->assertMatchesRegularExpression('/^rbalias(\d+)_$/', $aliasfour); $this->assertMatchesRegularExpression('/^rbalias(\d+)_$/', $aliasfive); } /** * Test generating parameter name */ public function test_generate_param_name(): void { $this->assertMatchesRegularExpression('/^rbparam(\d+)$/', database::generate_param_name()); // Specify a suffix. $this->assertMatchesRegularExpression('/^rbparam(\d+)_$/', database::generate_param_name('_')); } /** * Test generating multiple parameter names */ public function test_generate_param_names(): void { $params = database::generate_param_names(3); $this->assertCount(3, $params); [$paramone, $paramtwo, $paramthree] = $params; $this->assertMatchesRegularExpression('/^rbparam(\d+)$/', $paramone); $this->assertMatchesRegularExpression('/^rbparam(\d+)$/', $paramtwo); $this->assertMatchesRegularExpression('/^rbparam(\d+)$/', $paramthree); // Ensure they are different. $this->assertNotEquals($paramone, $paramtwo); $this->assertNotEquals($paramone, $paramthree); $this->assertNotEquals($paramtwo, $paramthree); // Specify a suffix. [$paramfour, $paramfive] = database::generate_param_names(2, '_'); $this->assertNotEquals($paramfour, $paramfive); $this->assertMatchesRegularExpression('/^rbparam(\d+)_$/', $paramfour); $this->assertMatchesRegularExpression('/^rbparam(\d+)_$/', $paramfive); } /** * Test parameter validation */ public function test_validate_params(): void { [$paramone, $paramtwo] = database::generate_param_names(2); $params = [ $paramone => 1, $paramtwo => 2, ]; $this->assertTrue(database::validate_params($params)); } /** * Test parameter validation for invalid parameters */ public function test_validate_params_invalid(): void { $params = [ database::generate_param_name() => 1, 'invalidfoo' => 2, 'invalidbar' => 4, ]; $this->expectException(coding_exception::class); $this->expectExceptionMessage('Invalid parameter names (invalidfoo, invalidbar)'); database::validate_params($params); } /** * Generate aliases and parameters and confirm they can be used within a query */ public function test_generated_data_in_query(): void { global $DB; // Unique aliases. [ $usertablealias, $userfieldalias, ] = database::generate_aliases(2); // Unique parameters. [ $paramuserid, $paramuserdeleted, ] = database::generate_param_names(2); // Simple query to retrieve the admin user. $sql = "SELECT {$usertablealias}.id AS {$userfieldalias} FROM {user} {$usertablealias} WHERE {$usertablealias}.id = :{$paramuserid} AND {$usertablealias}.deleted = :{$paramuserdeleted}"; $admin = core_user::get_user_by_username('admin'); $params = [ $paramuserid => $admin->id, $paramuserdeleted => 0, ]; $record = $DB->get_record_sql($sql, $params); $this->assertEquals($admin->id, $record->{$userfieldalias}); } /** * Test replacement of parameter names within SQL statements */ public function test_sql_replace_parameter_names(): void { global $DB; // Predefine parameter names, to ensure they don't overwrite each other. [$param0, $param1, $param10] = ['rbparam0', 'rbparam1', 'rbparam10']; $sql = "SELECT :{$param0} AS field0, :{$param1} AS field1, :{$param10} AS field10" . $DB->sql_null_from_clause(); $sql = database::sql_replace_parameter_names( $sql, [$param0, $param1, $param10], fn(string $param) => "prefix_{$param}", ); $record = $DB->get_record_sql($sql, [ "prefix_{$param0}" => 'Zero', "prefix_{$param1}" => 'One', "prefix_{$param10}" => 'Ten', ]); $this->assertEquals((object) [ 'field0' => 'Zero', 'field1' => 'One', 'field10' => 'Ten', ], $record); } /** * Test replacement of parameter names within query, returning both modified query and parameters */ public function test_sql_replace_parameters(): void { global $DB; // Predefine parameter names, to ensure they don't overwrite each other. [$param0, $param1, $param10] = ['rbparam0', 'rbparam1', 'rbparam10']; $sql = "SELECT :{$param0} AS field0, :{$param1} AS field1, :{$param10} AS field10" . $DB->sql_null_from_clause(); [$sql, $params] = database::sql_replace_parameters( $sql, [$param0 => 'Zero', $param1 => 'One', $param10 => 'Ten'], fn(string $param) => "prefix_{$param}", ); $record = $DB->get_record_sql($sql, $params); $this->assertEquals((object) [ 'field0' => 'Zero', 'field1' => 'One', 'field10' => 'Ten', ], $record); } } PK a<�\#���B �B % tests/local/helpers/audience_test.phpnu �[��� <?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\local\helpers; use advanced_testcase; use context_system; use core_reportbuilder_generator; use core_reportbuilder\reportbuilder\audience\manual; use core_reportbuilder\local\models\audience as audience_model; use core_user\reportbuilder\datasource\users; use invalid_parameter_exception; /** * Unit tests for audience helper * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\audience * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class audience_test extends advanced_testcase { /** * Test reports list is empty for a normal user without any audience records configured */ public function test_reports_list_no_access(): void { $this->resetAfterTest(); $reports = audience::user_reports_list(); $this->assertEmpty($reports); } /** * Test get_base_records() */ public function test_get_base_records(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Report with no audiences. $report = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $baserecords = audience::get_base_records($report->get('id')); $this->assertEmpty($baserecords); // Create a couple of manual audience types. $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $audience1 = $generator->create_audience([ 'reportid' => $report->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user1->id, $user2->id]], ]); $user3 = $this->getDataGenerator()->create_user(); $audience2 = $generator->create_audience([ 'reportid' => $report->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user3->id]], ]); $baserecords = audience::get_base_records($report->get('id')); $this->assertCount(2, $baserecords); $this->assertContainsOnlyInstancesOf(manual::class, $baserecords); // Set invalid classname of first audience, should be excluded in subsequent request. $audience1->get_persistent()->set('classname', '\invalid')->save(); $baserecords = audience::get_base_records($report->get('id')); $this->assertCount(1, $baserecords); $baserecord = reset($baserecords); $this->assertInstanceOf(manual::class, $baserecord); $this->assertEquals($audience2->get_persistent()->get('id'), $baserecord->get_persistent()->get('id')); } /** * Test get_allowed_reports() */ public function test_get_allowed_reports(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); self::setUser($user1); // No reports. $reports = audience::get_allowed_reports(); $this->assertEmpty($reports); $report1 = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $report2 = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $report3 = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); // Reports with no audiences set. $reports = audience::get_allowed_reports(); $this->assertEmpty($reports); $generator->create_audience([ 'reportid' => $report1->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user1->id, $user2->id]], ]); $generator->create_audience([ 'reportid' => $report2->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user2->id]], ]); $generator->create_audience([ 'reportid' => $report3->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user1->id]], ]); // Purge cache, to ensure allowed reports are re-calculated. audience::purge_caches(); $reports = audience::get_allowed_reports(); $this->assertEqualsCanonicalizing([$report1->get('id'), $report3->get('id')], $reports); // User2 can access report1 and report2. $reports = audience::get_allowed_reports((int) $user2->id); $this->assertEqualsCanonicalizing([$report1->get('id'), $report2->get('id')], $reports); // Purge cache, to ensure allowed reports are re-calculated. audience::purge_caches(); // Now delete one of our users, ensure they no longer have any allowed reports. delete_user($user2); $reports = audience::get_allowed_reports((int) $user2->id); $this->assertEmpty($reports); } /** * Test user_reports_list() */ public function test_user_reports_list(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $user1 = $this->getDataGenerator()->create_user(); $user2 = $this->getDataGenerator()->create_user(); $user3 = $this->getDataGenerator()->create_user(); self::setUser($user1); $reports = audience::user_reports_list(); $this->assertEmpty($reports); $report1 = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $report2 = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $report3 = $generator->create_report([ 'name' => 'My report', 'source' => users::class, 'default' => false, ]); $generator->create_audience([ 'reportid' => $report1->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user1->id, $user2->id]], ]); $generator->create_audience([ 'reportid' => $report2->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user2->id]], ]); $generator->create_audience([ 'reportid' => $report3->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$user1->id]], ]); // Purge cache, to ensure allowed reports are re-calculated. audience::purge_caches(); // User1 can access report1 and report3. $reports = audience::user_reports_list(); $this->assertEqualsCanonicalizing([$report1->get('id'), $report3->get('id')], $reports); // User2 can access report1 and report2. $reports = audience::user_reports_list((int) $user2->id); $this->assertEqualsCanonicalizing([$report1->get('id'), $report2->get('id')], $reports); // User3 can not access any report. $reports = audience::user_reports_list((int) $user3->id); $this->assertEmpty($reports); } /** * Test retrieving full list of reports that user can access */ public function test_user_reports_list_access_sql(): void { global $DB; $this->resetAfterTest(); $userone = $this->getDataGenerator()->create_user(); $usertwo = $this->getDataGenerator()->create_user(); $userthree = $this->getDataGenerator()->create_user(); $userfour = $this->getDataGenerator()->create_user(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Manager role gives users one and two capability to create own reports. $managerrole = $DB->get_field('role', 'id', ['shortname' => 'manager']); role_assign($managerrole, $userone->id, context_system::instance()); role_assign($managerrole, $usertwo->id, context_system::instance()); // Admin creates a report, no audience. $this->setAdminUser(); $useradminreport = $generator->create_report(['name' => 'Admin report', 'source' => users::class]); // User one creates a report, adds users two and three to audience. $this->setUser($userone); $useronereport = $generator->create_report(['name' => 'User one report', 'source' => users::class]); $generator->create_audience(['reportid' => $useronereport->get('id'), 'classname' => manual::class, 'configdata' => [ 'users' => [$usertwo->id, $userthree->id], ]]); // User two creates a report, no audience. $this->setUser($usertwo); $usertworeport = $generator->create_report(['name' => 'User two report', 'source' => users::class]); // User one sees only the report they created. [$where, $params] = audience::user_reports_list_access_sql('r', (int) $userone->id); $reports = $DB->get_fieldset_sql("SELECT r.id FROM {reportbuilder_report} r WHERE {$where}", $params); $this->assertEquals([$useronereport->get('id')], $reports); // User two see the report they created and the one they are in the audience of. [$where, $params] = audience::user_reports_list_access_sql('r', (int) $usertwo->id); $reports = $DB->get_fieldset_sql("SELECT r.id FROM {reportbuilder_report} r WHERE {$where}", $params); $this->assertEqualsCanonicalizing([$useronereport->get('id'), $usertworeport->get('id')], $reports); // User three sees the report they are in the audience of. [$where, $params] = audience::user_reports_list_access_sql('r', (int) $userthree->id); $reports = $DB->get_fieldset_sql("SELECT r.id FROM {reportbuilder_report} r WHERE {$where}", $params); $this->assertEquals([$useronereport->get('id')], $reports); // User four sees no reports. [$where, $params] = audience::user_reports_list_access_sql('r', (int) $userfour->id); $reports = $DB->get_fieldset_sql("SELECT r.id FROM {reportbuilder_report} r WHERE {$where}", $params); $this->assertEmpty($reports); } /** * Data provider for {@see test_user_reports_list_access_sql_with_capability} * * @return array[] */ public static function user_reports_list_access_sql_with_capability_provider(): array { return [ ['moodle/reportbuilder:editall'], ['moodle/reportbuilder:viewall'], ]; } /** * Test retrieving list of reports that user can access observes capability to view all reports * * @param string $capability * * @dataProvider user_reports_list_access_sql_with_capability_provider */ public function test_user_reports_list_access_sql_with_capability(string $capability): void { global $DB; $this->resetAfterTest(); // Admin creates a report, no audience. $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Admin report', 'source' => users::class]); // Switch to new user, assign capability. $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $userrole = $DB->get_field('role', 'id', ['shortname' => 'user']); assign_capability($capability, CAP_ALLOW, $userrole, context_system::instance()); [$where, $params] = audience::user_reports_list_access_sql('r'); $reports = $DB->get_fieldset_sql("SELECT r.id FROM {reportbuilder_report} r WHERE {$where}", $params); $this->assertEquals([$report->get('id')], $reports); } /** * Test getting list of audiences in use within schedules for a report */ public function test_get_audiences_for_report_schedules(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $audienceone = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $audiencetwo = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $audiencethree = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); // The first schedule contains audience one and two. $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'Schedule one', 'audiences' => json_encode([$audienceone->get_persistent()->get('id'), $audiencetwo->get_persistent()->get('id')]) ]); // Second schedule contains only audience one. $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'Schedule two', 'audiences' => json_encode([$audienceone->get_persistent()->get('id')]) ]); // The first two audiences should be returned, the third omitted. $audiences = audience::get_audiences_for_report_schedules($report->get('id')); $this->assertEqualsCanonicalizing([ $audienceone->get_persistent()->get('id'), $audiencetwo->get_persistent()->get('id'), ], $audiences); } /** * Testing deleting report audience */ public function test_delete_report_audience(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]); $audienceone = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $audiencetwo = $generator->create_audience(['reportid' => $report->get('id'), 'configdata' => []]); $audiences = audience_model::get_records(['reportid' => $report->get('id')]); $this->assertCount(2, $audiences); // Delete the first audience. $result = audience::delete_report_audience($report->get('id'), $audienceone->get_persistent()->get('id')); $this->assertTrue($result); // We should be left with only the second audience. $audiences = audience_model::get_records(['reportid' => $report->get('id')]); $this->assertCount(1, $audiences); $this->assertEquals($audiencetwo->get_persistent()->get('id'), reset($audiences)->get('id')); } /** * Testing deleting invalid report audience */ public function test_delete_report_audience_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $reportone = $generator->create_report(['name' => 'Report one', 'source' => users::class, 'default' => false]); $audienceone = $generator->create_audience(['reportid' => $reportone->get('id'), 'configdata' => []]); $reporttwo = $generator->create_report(['name' => 'Report two', 'source' => users::class, 'default' => false]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid audience'); audience::delete_report_audience($reporttwo->get('id'), $audienceone->get_persistent()->get('id')); } } PK a<�\ �9�J J * tests/local/helpers/custom_fields_test.phpnu �[��� <?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\local\helpers; use core_customfield_generator; use core_reportbuilder_generator; use core_reportbuilder\local\entities\course; use core_reportbuilder\local\filters\{boolean_select, date, number, select, text}; use core_reportbuilder\local\report\{column, filter}; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_course\reportbuilder\datasource\{categories, courses}; /** * Unit tests for custom fields helper * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\custom_fields * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class custom_fields_test extends core_reportbuilder_testcase { /** * Generate custom fields, one of each type * * @return custom_fields */ private function generate_customfields(): custom_fields { /** @var core_customfield_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_customfield'); $category = $generator->create_category([ 'component' => 'core_course', 'area' => 'course', 'itemid' => 0, 'contextid' => \context_system::instance()->id ]); $generator->create_field( ['categoryid' => $category->get('id'), 'type' => 'text', 'name' => 'Text', 'shortname' => 'text', 'configdata' => ['defaultvalue' => 'default']]); $generator->create_field( ['categoryid' => $category->get('id'), 'type' => 'textarea', 'name' => 'Textarea', 'shortname' => 'textarea', 'configdata' => ['defaultvalue' => 'Default']]); // This field is available only to course teachers. $generator->create_field( ['categoryid' => $category->get('id'), 'type' => 'checkbox', 'name' => 'Checkbox', 'shortname' => 'checkbox', 'configdata' => ['checkbydefault' => 1, 'visibility' => 1]]); $generator->create_field( ['categoryid' => $category->get('id'), 'type' => 'date', 'name' => 'Date', 'shortname' => 'date']); $generator->create_field( ['categoryid' => $category->get('id'), 'type' => 'select', 'name' => 'Select', 'shortname' => 'select', 'configdata' => ['options' => "Cat\nDog", 'defaultvalue' => 'Cat']]); $generator->create_field( ['categoryid' => $category->get('id'), 'type' => 'number', 'name' => 'Number', 'shortname' => 'number', 'configdata' => ['defaultvalue' => 1]]); $courseentity = new course(); $coursealias = $courseentity->get_table_alias('course'); // Create an instance of the customfields helper. return new custom_fields("{$coursealias}.id", $courseentity->get_entity_name(), 'core_course', 'course'); } /** * Test for get_columns */ public function test_get_columns(): void { $this->resetAfterTest(); $this->setAdminUser(); $customfields = $this->generate_customfields(); $columns = $customfields->get_columns(); $this->assertCount(6, $columns); $this->assertContainsOnlyInstancesOf(column::class, $columns); // Column titles. $this->assertEquals([ 'Text', 'Textarea', 'Checkbox', 'Date', 'Select', 'Number', ], array_map( fn(column $column) => $column->get_title(), $columns, )); // Column types. $this->assertEquals([ column::TYPE_TEXT, column::TYPE_LONGTEXT, column::TYPE_BOOLEAN, column::TYPE_TIMESTAMP, column::TYPE_TEXT, column::TYPE_FLOAT, ], array_map( fn(column $column) => $column->get_type(), $columns, )); // Column sortable. $this->assertEquals([ true, false, true, true, true, true, ], array_map( fn(column $column) => $column->get_is_sortable(), $columns, )); // Column available. $this->assertEquals([ true, true, true, true, true, true, ], array_map( fn(column $column) => $column->get_is_available(), $columns, )); // Column available, for non-privileged user. $this->setUser(null); $this->assertEquals([ true, true, false, true, true, true, ], array_map( fn(column $column) => $column->get_is_available(), $customfields->get_columns(), )); } /** * Test that joins added to the custom fields helper are present in its columns/filters */ public function test_add_join(): void { $this->resetAfterTest(); $customfields = $this->generate_customfields(); // We always join on the customfield data table. $columnjoins = $customfields->get_columns()[0]->get_joins(); $this->assertCount(1, $columnjoins); $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $columnjoins[0]); $filterjoins = $customfields->get_filters()[0]->get_joins(); $this->assertCount(1, $filterjoins); $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $filterjoins[0]); // Add additional join. $customfields->add_join('JOIN {test} t ON t.id = id'); $columnjoins = $customfields->get_columns()[0]->get_joins(); $this->assertCount(2, $columnjoins); $this->assertEquals('JOIN {test} t ON t.id = id', $columnjoins[0]); $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $columnjoins[1]); $filterjoins = $customfields->get_filters()[0]->get_joins(); $this->assertCount(2, $filterjoins); $this->assertEquals('JOIN {test} t ON t.id = id', $filterjoins[0]); $this->assertStringStartsWith('LEFT JOIN {customfield_data}', $filterjoins[1]); } /** * Test for get_filters */ public function test_get_filters(): void { $this->resetAfterTest(); $this->setAdminUser(); $customfields = $this->generate_customfields(); $filters = $customfields->get_filters(); $this->assertCount(6, $filters); $this->assertContainsOnlyInstancesOf(filter::class, $filters); // Filter headers. $this->assertEquals([ 'Text', 'Textarea', 'Checkbox', 'Date', 'Select', 'Number', ], array_map( fn(filter $filter) => $filter->get_header(), $filters, )); // Filter types. $this->assertEquals([ text::class, text::class, boolean_select::class, date::class, select::class, number::class, ], array_map( fn(filter $filter) => $filter->get_filter_class(), $filters, )); // Filter available. $this->assertEquals([ true, true, true, true, true, true, ], array_map( fn(filter $filter) => $filter->get_is_available(), $filters, )); // Filter available, for non-privileged user. $this->setUser(null); $this->assertEquals([ true, true, false, true, true, true, ], array_map( fn(filter $filter) => $filter->get_is_available(), $customfields->get_filters(), )); } /** * Test that adding custom field columns to a report returns expected values */ public function test_custom_report_content(): void { $this->resetAfterTest(); $this->setAdminUser(); $category = $this->getDataGenerator()->create_category(['name' => 'Zebras']); $courseone = $this->getDataGenerator()->create_course(['category' => $category->id, 'fullname' => 'C1']); // Second course will populate each custom field. $this->generate_customfields(); $coursetwo = $this->getDataGenerator()->create_course(['category' => $category->id, 'fullname' => 'C2', 'customfields' => [ ['shortname' => 'text', 'value' => 'Hello'], ['shortname' => 'textarea_editor', 'value' => ['text' => 'Goodbye', 'format' => FORMAT_MOODLE]], ['shortname' => 'checkbox', 'value' => 0], ['shortname' => 'date', 'value' => 1669852800], ['shortname' => 'select', 'value' => 2], ['shortname' => 'number', 'value' => 42], ]]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Categories', 'source' => categories::class, 'default' => 0]); // Add custom field columns to the report. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course_category:name', 'sortenabled' => 1]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:fullname', 'sortenabled' => 1]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_text']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_textarea']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_checkbox']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_date']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_select']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:customfield_number']); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'Category 1', '', '', '', '', '', '', '', ], [ $category->name, $courseone->fullname, 'default', format_text('Default'), 'Yes', '', 'Cat', 1, ], [ $category->name, $coursetwo->fullname, 'Hello', format_text('Goodbye'), 'No', userdate(1669852800), 'Dog', 42, ], ], array_map('array_values', $content)); } /** * Data provider for {@see test_custom_report_filter} * * @return array[] */ public static function custom_report_filter_provider(): array { return [ 'Filter by text custom field' => ['course:customfield_text', [ 'course:customfield_text_operator' => text::IS_EQUAL_TO, 'course:customfield_text_value' => 'Hello', ], 'C2'], 'Filter by text custom field (default)' => ['course:customfield_text', [ 'course:customfield_text_operator' => text::IS_EQUAL_TO, 'course:customfield_text_value' => 'default', ], 'C1'], 'Filter by text custom field (no match)' => ['course:customfield_text', [ 'course:customfield_text_operator' => text::IS_EQUAL_TO, 'course:customfield_text_value' => 'Goodbye', ]], 'Filter by textarea custom field' => ['course:customfield_textarea', [ 'course:customfield_textarea_operator' => text::IS_EQUAL_TO, 'course:customfield_textarea_value' => 'Goodbye', ], 'C2'], 'Filter by textarea custom field (default)' => ['course:customfield_textarea', [ 'course:customfield_textarea_operator' => text::IS_EQUAL_TO, 'course:customfield_textarea_value' => 'Default', ], 'C1'], 'Filter by textarea custom field (no match)' => ['course:customfield_textarea', [ 'course:customfield_textarea_operator' => text::IS_EQUAL_TO, 'course:customfield_textarea_value' => 'Hello', ]], 'Filter by checkbox custom field' => ['course:customfield_checkbox', [ 'course:customfield_checkbox_operator' => boolean_select::NOT_CHECKED, ], 'C2'], 'Filter by checkbox custom field (default)' => ['course:customfield_checkbox', [ 'course:customfield_checkbox_operator' => boolean_select::CHECKED, ], 'C1'], 'Filter by date custom field' => ['course:customfield_date', [ 'course:customfield_date_operator' => date::DATE_RANGE, 'course:customfield_date_from' => 1622502000, ], 'C2'], 'Filter by date custom field (no match)' => ['course:customfield_date', [ 'course:customfield_date_operator' => date::DATE_RANGE, 'course:customfield_date_from' => 1672531200, ]], 'Filter by select custom field' => ['course:customfield_select', [ 'course:customfield_select_operator' => select::EQUAL_TO, 'course:customfield_select_value' => 2, ], 'C2'], 'Filter by select custom field (default)' => ['course:customfield_select', [ 'course:customfield_select_operator' => select::EQUAL_TO, 'course:customfield_select_value' => 1, ], 'C1'], 'Filter by select custom field (no match)' => ['course:customfield_select', [ 'course:customfield_select_operator' => select::EQUAL_TO, 'course:customfield_select_value' => 3, ]], 'Filter by number custom field' => ['course:customfield_number', [ 'course:customfield_number_operator' => number::EQUAL_TO, 'course:customfield_number_value1' => 42, ], 'C2'], 'Filter by number custom field (default)' => ['course:customfield_number', [ 'course:customfield_number_operator' => number::EQUAL_TO, 'course:customfield_number_value1' => 1, ], 'C1'], 'Filter by number custom field (no match)' => ['course:customfield_number', [ 'course:customfield_number_operator' => number::EQUAL_TO, 'course:customfield_number_value1' => 3, ]], ]; } /** * Test filtering report by custom fields * * @param string $filtername * @param array $filtervalues * @param string|null $expectmatch * * @dataProvider custom_report_filter_provider */ public function test_custom_report_filter(string $filtername, array $filtervalues, ?string $expectmatch = null): void { $this->resetAfterTest(); $this->setAdminUser(); $this->getDataGenerator()->create_course(['fullname' => 'C1']); // Second course will populate each custom field. $this->generate_customfields(); $this->getDataGenerator()->create_course(['fullname' => 'C2', 'customfields' => [ ['shortname' => 'text', 'value' => 'Hello'], ['shortname' => 'textarea_editor', 'value' => ['text' => 'Goodbye', 'format' => FORMAT_MOODLE]], ['shortname' => 'checkbox', 'value' => 0], ['shortname' => 'date', 'value' => 1669852800], ['shortname' => 'select', 'value' => 2], ['shortname' => 'number', 'value' => 42], ]]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create report containing single column, and given filter. $report = $generator->create_report(['name' => 'Users', 'source' => courses::class, 'default' => 0]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'course:fullname']); // Add filter, set it's values. $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => $filtername]); $content = $this->get_custom_report_content($report->get('id'), 0, $filtervalues); if ($expectmatch !== null) { $this->assertCount(1, $content); $this->assertEquals($expectmatch, reset($content[0])); } else { $this->assertEmpty($content); } } /** * Stress test course datasource using custom fields * * In order to execute this test PHPUNIT_LONGTEST should be defined as true in phpunit.xml or directly in config.php */ public function test_stress_datasource(): void { if (!PHPUNIT_LONGTEST) { $this->markTestSkipped('PHPUNIT_LONGTEST is not defined'); } $this->resetAfterTest(); $this->generate_customfields(); $this->getDataGenerator()->create_course(['customfields' => [ ['shortname' => 'text', 'value' => 'Hello'], ['shortname' => 'textarea_editor', 'value' => ['text' => 'Goodbye', 'format' => FORMAT_MOODLE]], ['shortname' => 'checkbox', 'value' => true], ['shortname' => 'date', 'value' => 1669852800], ['shortname' => 'select', 'value' => 2], ]]); $this->datasource_stress_test_columns(courses::class); $this->datasource_stress_test_columns_aggregation(courses::class); $this->datasource_stress_test_conditions(courses::class, 'course:idnumber'); } } PK a<�\*1 4? ? 0 tests/local/helpers/user_filter_manager_test.phpnu �[��� <?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\local\helpers; use advanced_testcase; /** * Unit tests for the user filter helper * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\user_filter_manager * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class user_filter_manager_test extends advanced_testcase { /** * Helper method to return all user preferences for filters - based on the current storage backend using the same * * @return array */ private function get_filter_preferences(): array { return array_filter(get_user_preferences(), static function(string $key): bool { return strpos($key, 'reportbuilder-report-') === 0; }, ARRAY_FILTER_USE_KEY); } /** * Data provider for {@see test_get} * * @return array */ public static function get_provider(): array { return [ 'Small value' => ['foo'], 'Large value' => [str_repeat('A', 4000)], 'Empty value' => [''], ]; } /** * Test getting filter values * * @param string $value * * @dataProvider get_provider */ public function test_get(string $value): void { $this->resetAfterTest(); $values = [ 'entity:filter_name' => $value, ]; user_filter_manager::set(5, $values); // Make sure we get the same value back. $this->assertEquals($values, user_filter_manager::get(5)); } /** * Test getting filter values that once spanned multiple chunks */ public function test_get_large_to_small(): void { $this->resetAfterTest(); // Set a large initial filter value. user_filter_manager::set(5, [ 'longvalue' => str_repeat('ABCD', 1000), ]); // Sanity check, there should be 4 (because 4000 characters plus some JSON encoding requires that many chunks). $preferences = $this->get_filter_preferences(); $this->assertCount(4, $preferences); $values = [ 'longvalue' => 'ABCD', ]; user_filter_manager::set(5, $values); // Make sure we get the same value back. $this->assertEquals($values, user_filter_manager::get(5)); // Everything should now fit in a single filter preference. $preferences = $this->get_filter_preferences(); $this->assertCount(1, $preferences); } /** * Test getting filter values that haven't been set */ public function test_get_empty(): void { $this->assertEquals([], user_filter_manager::get(5)); } /** * Data provider for {@see test_reset_all} * * @return array */ public static function reset_all_provider(): array { return [ 'Small value' => ['foo'], 'Large value' => [str_repeat('A', 4000)], 'Empty value' => [''], ]; } /** * Test resetting all filter values * * @param string $value * * @dataProvider reset_all_provider */ public function test_reset_all(string $value): void { $this->resetAfterTest(); user_filter_manager::set(5, [ 'entity:filter_name' => $value ]); $reset = user_filter_manager::reset_all(5); $this->assertTrue($reset); // We should get an empty array back. $this->assertEquals([], user_filter_manager::get(5)); // All filter preferences should be removed. $this->assertEmpty($this->get_filter_preferences()); } /** * Test resetting single filter values */ public function test_reset_single(): void { $this->resetAfterTest(); user_filter_manager::set(5, [ 'entity:filter_name' => 'foo', 'entity:filter_value' => 'bar', 'entity:other_name' => 'baz', 'entity:other_value' => 'bax', ]); $reset = user_filter_manager::reset_single(5, 'entity:other'); $this->assertTrue($reset); $this->assertEquals([ 'entity:filter_name' => 'foo', 'entity:filter_value' => 'bar', ], user_filter_manager::get(5)); } /** * Test merging filter values */ public function test_merge(): void { $this->resetAfterTest(); $values = [ 'entity:filter_name' => 'foo', 'entity:filter_value' => 'bar', 'entity:filter2_name' => 'tree', 'entity:filter2_value' => 'house', ]; // Make sure we get the same value back. user_filter_manager::set(5, $values); $this->assertEqualsCanonicalizing($values, user_filter_manager::get(5)); user_filter_manager::merge(5, [ 'entity:filter_name' => 'twotimesfoo', 'entity:filter_value' => 'twotimesbar', ]); // Make sure that both values have been changed and the other values have not been modified. $expected = [ 'entity:filter_name' => 'twotimesfoo', 'entity:filter_value' => 'twotimesbar', 'entity:filter2_name' => 'tree', 'entity:filter2_value' => 'house', ]; $this->assertEqualsCanonicalizing($expected, user_filter_manager::get(5)); } /** * Test to get all filters from a given user */ public function test_get_all_for_user(): void { $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); $filtervalues1 = [ 'entity:filter_name' => 'foo', 'entity:filter_value' => 'bar', 'entity:other_name' => 'baz', 'entity:other_value' => 'bax', ]; user_filter_manager::set(5, $filtervalues1); $filtervalues2 = [ 'entity:filter_name' => 'blue', 'entity:filter_value' => 'red', ]; user_filter_manager::set(9, $filtervalues2); $this->setAdminUser(); $values = user_filter_manager::get_all_for_user((int)$user->id); $this->assertEqualsCanonicalizing([$filtervalues1, $filtervalues2], [reset($values), end($values)]); // Check for a user with no filters. $user2 = $this->getDataGenerator()->create_user(); $values = user_filter_manager::get_all_for_user((int)$user2->id); $this->assertEmpty($values); } } PK a<�\g��"�F �F % tests/local/helpers/schedule_test.phpnu �[��� <?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\local\helpers; use advanced_testcase; use invalid_parameter_exception; use core\clock; use core_cohort\reportbuilder\audience\cohortmember; use core_reportbuilder_generator; use core_reportbuilder\local\models\schedule as model; use core_reportbuilder\reportbuilder\audience\manual; use core_user\reportbuilder\datasource\users; /** * Unit tests for the schedule helper class * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\schedule * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class schedule_test extends advanced_testcase { /** @var clock $clock */ private readonly clock $clock; /** * Mock the clock */ protected function setUp(): void { parent::setUp(); $this->clock = $this->mock_clock_with_frozen(1622847600); } /** * Test create schedule */ public function test_create_schedule(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Create schedule for tomorrow. $timescheduled = $this->clock->time() + DAYSECS; $schedule = schedule::create_schedule((object) [ 'name' => 'My schedule', 'reportid' => $report->get('id'), 'format' => 'csv', 'subject' => 'Hello', 'message' => 'Hola', 'timescheduled' => $timescheduled, ]); $this->assertEquals('My schedule', $schedule->get('name')); $this->assertEquals($report->get('id'), $schedule->get('reportid')); $this->assertEquals('csv', $schedule->get('format')); $this->assertEquals('Hello', $schedule->get('subject')); $this->assertEquals('Hola', $schedule->get('message')); $this->assertEquals($timescheduled, $schedule->get('timescheduled')); $this->assertEquals($timescheduled, $schedule->get('timenextsend')); } /** * Test update schedule */ public function test_update_schedule(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); // Update some record properties. $record = $schedule->to_record(); $record->name = 'My updated schedule'; $record->timescheduled += (12 * HOURSECS); $schedule = schedule::update_schedule($record); $this->assertEquals($record->name, $schedule->get('name')); $this->assertEquals($record->timescheduled, $schedule->get('timescheduled')); $this->assertEquals($record->timescheduled, $schedule->get('timenextsend')); } /** * Test update invalid schedule */ public function test_update_schedule_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid schedule'); schedule::update_schedule((object) ['id' => 42, 'reportid' => $report->get('id')]); } /** * Test toggle schedule */ public function test_toggle_schedule(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); // Disable the schedule. schedule::toggle_schedule($report->get('id'), $schedule->get('id'), false); $schedule = $schedule->read(); $this->assertFalse($schedule->get('enabled')); // Enable the schedule. schedule::toggle_schedule($report->get('id'), $schedule->get('id'), true); $schedule = $schedule->read(); $this->assertTrue($schedule->get('enabled')); } /** * Test toggle invalid schedule */ public function test_toggle_schedule_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid schedule'); schedule::toggle_schedule($report->get('id'), 42, true); } /** * Test delete schedule */ public function test_delete_schedule(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); $scheduleid = $schedule->get('id'); schedule::delete_schedule($report->get('id'), $scheduleid); $this->assertFalse($schedule::record_exists($scheduleid)); } /** * Test delete invalid schedule */ public function test_delete_schedule_invalid(): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $this->expectException(invalid_parameter_exception::class); $this->expectExceptionMessage('Invalid schedule'); schedule::delete_schedule($report->get('id'), 42); } /** * Test getting schedule report users (those in matching audience) */ public function test_get_schedule_report_users(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Create cohort, with some members. $cohort = $this->getDataGenerator()->create_cohort(); $cohortuserone = $this->getDataGenerator()->create_user(['firstname' => 'Zoe', 'lastname' => 'Zebra']); cohort_add_member($cohort->id, $cohortuserone->id); $cohortusertwo = $this->getDataGenerator()->create_user(['firstname' => 'Henrietta', 'lastname' => 'Hamster']); cohort_add_member($cohort->id, $cohortusertwo->id); // Create a third user, to be added manually. $manualuserone = $this->getDataGenerator()->create_user(['firstname' => 'Bob', 'lastname' => 'Badger']); $audiencecohort = $generator->create_audience([ 'reportid' => $report->get('id'), 'classname' => cohortmember::class, 'configdata' => ['cohorts' => [$cohort->id]], ]); $audiencemanual = $generator->create_audience([ 'reportid' => $report->get('id'), 'classname' => manual::class, 'configdata' => ['users' => [$manualuserone->id]], ]); // Now create our schedule. $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'audiences' => json_encode([ $audiencecohort->get_persistent()->get('id'), $audiencemanual->get_persistent()->get('id'), ]), ]); $users = schedule::get_schedule_report_users($schedule); $this->assertEquals([ 'Bob', 'Henrietta', 'Zoe', ], array_column($users, 'firstname')); // Now delete one of our users, ensure they are no longer returned. delete_user($manualuserone); $users = schedule::get_schedule_report_users($schedule); $this->assertEquals([ 'Henrietta', 'Zoe', ], array_column($users, 'firstname')); } /** * Test getting schedule report row count */ public function test_get_schedule_report_count(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule']); // There is only one row in the report (the only user on the site). $count = schedule::get_schedule_report_count($schedule); $this->assertEquals(1, $count); } /** * Data provider for {@see test_get_schedule_report_file} * * @return string[] */ public static function get_schedule_report_file_format(): array { return [ ['csv'], ['excel'], ['html'], ['json'], ['ods'], ['pdf'], ]; } /** * Test getting schedule report exported file, in each supported format * * @param string $format * * @dataProvider get_schedule_report_file_format */ public function test_get_schedule_report_file(string $format): void { $this->resetAfterTest(); $this->setAdminUser(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule(['reportid' => $report->get('id'), 'name' => 'My schedule', 'format' => $format]); // There is only one row in the report (the only user on the site). $file = schedule::get_schedule_report_file($schedule); $this->assertGreaterThan(64, $file->get_filesize()); } /** * Data provider for {@see test_should_send_schedule} * * @return array[] */ public static function should_send_schedule_provider(): array { return [ 'Time scheduled in the past' => [ model::RECURRENCE_NONE, '-1 hour', null, null, true, ], 'Time scheduled in the past, already sent prior to schedule' => [ model::RECURRENCE_NONE, '-1 hour', '-2 hour', null, true, ], 'Time scheduled in the past, already sent on schedule' => [ model::RECURRENCE_NONE, '-1 hour', '-1 hour', null, false, ], 'Time scheduled in the future' => [ model::RECURRENCE_NONE, '+1 hour', null, null, false, ], 'Time scheduled in the future, already sent prior to schedule' => [ model::RECURRENCE_NONE, '+1 hour', '-1 hour', null, false, ], 'Next send in the past' => [ model::RECURRENCE_DAILY, '-1 hour', null, '-1 hour', true, ], 'Next send in the future' => [ model::RECURRENCE_DAILY, '-1 hour', null, '+1 hour', false, ], ]; } /** * Test for whether a schedule should be sent * * @param int $recurrence * @param string $timescheduled Relative time suitable for passing to {@see strtotime} * @param string|null $timelastsent Relative time suitable for passing to {@see strtotime}, or null to ignore * @param string|null $timenextsend Relative time suitable for passing to {@see strtotime}, or null to ignore * @param bool $expected * * @dataProvider should_send_schedule_provider */ public function test_should_send_schedule( int $recurrence, string $timescheduled, ?string $timelastsent, ?string $timenextsend, bool $expected, ): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Use relative time period if present, otherwise default to zero (never sent). $scheduletimelastsent = 0; if ($timelastsent !== null) { $scheduletimelastsent = strtotime($timelastsent, $this->clock->time()); } $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'recurrence' => $recurrence, 'timescheduled' => strtotime($timescheduled, $this->clock->time()), 'timelastsent' => $scheduletimelastsent, ]); // If "Time next send" is specified, then override calculated value. if ($timenextsend !== null) { $schedule->set('timenextsend', strtotime($timenextsend, $this->clock->time())); } $this->assertEquals($expected, schedule::should_send_schedule($schedule)); } /** * Test for whether a schedule should be sent that has been disabled */ public function test_should_send_schedule_disabled(): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); $schedule = $generator->create_schedule([ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'enabled' => 0, ]); $this->assertFalse(schedule::should_send_schedule($schedule)); } /** * Data provider for {@see test_calculate_next_send_time} * * @return array[] */ public static function calculate_next_send_time_provider(): array { // Times are based on the current clock time (Fri Jun 04 2021 23:00:00 UTC). return [ 'No recurrence' => [ model::RECURRENCE_NONE, '2021-06-03 12:00', '2021-06-03 12:00', ], 'Recurrence, time scheduled in future' => [ model::RECURRENCE_DAILY, '2021-06-05 12:00', '2021-06-05 12:00', ], 'Daily recurrence' => [ model::RECURRENCE_DAILY, '2021-06-02 12:00', '2021-06-05 12:00', ], 'Weekday recurrence' => [ model::RECURRENCE_WEEKDAYS, '2021-06-02 12:00', '2021-06-07 12:00', ], 'Weekly recurrence' => [ model::RECURRENCE_WEEKLY, '2021-05-18 12:00', '2021-06-08 12:00', ], 'Monthy recurrence' => [ model::RECURRENCE_MONTHLY, '2021-03-19 12:00', '2021-06-19 12:00', ], 'Annual recurrence' => [ model::RECURRENCE_ANNUALLY, '2019-05-01 12:00', '2022-05-01 12:00', ], ]; } /** * Test for calculating next schedule send time * * @param int $recurrence * @param string $timescheduled Absolute time suitable for passing to {@see strtotime} * @param string $expected Absolute time suitable for passing to {@see strtotime} * * @dataProvider calculate_next_send_time_provider */ public function test_calculate_next_send_time(int $recurrence, string $timescheduled, string $expected): void { $this->resetAfterTest(); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'My report', 'source' => users::class]); // Create model manually, as the generator automatically calculates next send itself. $schedule = new model(0, (object) [ 'reportid' => $report->get('id'), 'name' => 'My schedule', 'recurrence' => $recurrence, 'timescheduled' => strtotime("{$timescheduled} UTC"), ]); $scheduleexpected = strtotime("{$expected} UTC"); $this->assertEquals($scheduleexpected, schedule::calculate_next_send_time($schedule)); } } PK a<�\e�_y y ' tests/local/helpers/join_trait_test.phpnu �[��� <?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/>. /** * Unit tests for the join trait * * @package core_reportbuilder * @copyright 2024 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ declare(strict_types=1); namespace core_reportbuilder\local\helpers; use advanced_testcase; defined('MOODLE_INTERNAL') || die(); /** * Unit tests for the join trait * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\join_trait * @copyright 2024 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class join_trait_test extends advanced_testcase { /** * Test adding single join */ public function test_add_join(): void { $trait = new join_trait_mock(); $trait->add_join('JOIN {test} t ON t.id = a.id'); $this->assertEquals(['JOIN {test} t ON t.id = a.id'], $trait->get_joins()); } /** * Test adding single join multiple times */ public function test_add_join_multiple(): void { $trait = new join_trait_mock(); // Add multiple joins, two of which are duplicates. $trait->add_join('JOIN {test} t1 ON t1.id = a.id') ->add_join('JOIN {test} t2 ON t2.id = b.id') ->add_join('JOIN {test} t1 ON t1.id = a.id'); // The duplicated join is normalised away. $this->assertEquals([ 'JOIN {test} t1 ON t1.id = a.id', 'JOIN {test} t2 ON t2.id = b.id', ], $trait->get_joins()); } /** * Test adding multiple joins */ public function test_add_joins(): void { $trait = new join_trait_mock(); // Add multiple joins, two of which are duplicates. $trait->add_joins([ 'JOIN {test} t1 ON t1.id = a.id', 'JOIN {test} t2 ON t2.id = b.id', 'JOIN {test} t1 ON t1.id = a.id', ]); // The duplicated join is normalised away. $this->assertEquals([ 'JOIN {test} t1 ON t1.id = a.id', 'JOIN {test} t2 ON t2.id = b.id', ], $trait->get_joins()); } } /** * Simple implementation of a class using the trait */ final class join_trait_mock { use join_trait; } PK a<�\�'��<J <J 0 tests/local/helpers/user_profile_fields_test.phpnu �[��� <?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\local\helpers; use core_reportbuilder_generator; use core_reportbuilder\local\entities\user; use core_reportbuilder\local\filters\{boolean_select, date, select, text}; use core_reportbuilder\local\report\{column, filter}; use core_reportbuilder\tests\core_reportbuilder_testcase; use core_user\reportbuilder\datasource\users; /** * Unit tests for user profile fields helper * * @package core_reportbuilder * @covers \core_reportbuilder\local\helpers\user_profile_fields * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class user_profile_fields_test extends core_reportbuilder_testcase { /** * Generate custom profile fields, one of each type * * @return user_profile_fields */ private function generate_userprofilefields(): user_profile_fields { $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'checkbox', 'name' => 'Checkbox field', 'datatype' => 'checkbox', 'defaultdata' => 1]); // This field is available only to admins. $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'datetime', 'name' => 'Date field', 'datatype' => 'datetime', 'param2' => 2022, 'param3' => 0, 'defaultdata' => 0, 'visible' => PROFILE_VISIBLE_NONE]); $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'menu', 'name' => 'Menu field', 'datatype' => 'menu', 'param1' => "Cat\nDog", 'defaultdata' => 'Cat']); $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'Social', 'name' => 'msn', 'datatype' => 'social', 'param1' => 'msn']); $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'text', 'name' => 'Text field', 'datatype' => 'text', 'defaultdata' => 'default']); $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'textarea', 'name' => 'Textarea field', 'datatype' => 'textarea', 'defaultdata' => 'Default']); $userentity = new user(); $useralias = $userentity->get_table_alias('user'); // Create an instance of the userprofilefield helper. return new user_profile_fields("{$useralias}.id", $userentity->get_entity_name()); } /** * Test for get_columns */ public function test_get_columns(): void { $this->resetAfterTest(); $this->setAdminUser(); // Get pre-existing user profile fields. $userentity = new user(); $initialcolumns = (new user_profile_fields( $userentity->get_table_alias('user') . '.id', $userentity->get_entity_name(), ))->get_columns(); // Create a field which will duplicate one of the subsequently generated fields (case-insensitive shortname). $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'CHECKBOX', 'name' => 'Duplicate checkbox field', 'datatype' => 'checkbox', ]); // Add new custom profile fields. $userprofilefields = $this->generate_userprofilefields(); // Ensure pre-existing fields are ignored in subsequent assertions. $columns = array_slice($userprofilefields->get_columns(), count($initialcolumns)); $this->assertCount(6, $columns); $this->assertContainsOnlyInstancesOf(column::class, $columns); // Column titles. $this->assertEquals([ 'Checkbox field', 'Date field', 'Menu field', 'MSN ID', 'Text field', 'Textarea field', ], array_map( fn(column $column): string => $column->get_title(), $columns, )); // Column types. $this->assertEquals([ column::TYPE_BOOLEAN, column::TYPE_TIMESTAMP, column::TYPE_TEXT, column::TYPE_TEXT, column::TYPE_TEXT, column::TYPE_LONGTEXT, ], array_map( fn(column $column): int => $column->get_type(), $columns, )); // Column sortable. $this->assertEquals([ true, true, true, true, true, false, ], array_map( fn(column $column): bool => $column->get_is_sortable(), $columns, )); // Column available. $this->assertEquals([ true, true, true, true, true, true, ], array_map( fn(column $column): bool => $column->get_is_available(), $columns, )); // Column available, for non-privileged user. $this->setUser(null); $this->assertEquals([ true, false, true, true, true, true, ], array_map( fn(column $column): bool => $column->get_is_available(), array_slice($userprofilefields->get_columns(), count($initialcolumns)), )); } /** * Test that joins added to the profile fields helper are present in its columns/filters */ public function test_add_join(): void { $this->resetAfterTest(); $userprofilefields = $this->generate_userprofilefields(); // We always join on the user info data table. $columnjoins = $userprofilefields->get_columns()[0]->get_joins(); $this->assertCount(1, $columnjoins); $this->assertStringStartsWith('LEFT JOIN {user_info_data}', $columnjoins[0]); $filterjoins = $userprofilefields->get_filters()[0]->get_joins(); $this->assertCount(1, $filterjoins); $this->assertStringStartsWith('LEFT JOIN {user_info_data}', $filterjoins[0]); // Add additional join. $userprofilefields->add_join('JOIN {test} t ON t.id = id'); $columnjoins = $userprofilefields->get_columns()[0]->get_joins(); $this->assertCount(2, $columnjoins); $this->assertEquals('JOIN {test} t ON t.id = id', $columnjoins[0]); $this->assertStringStartsWith('LEFT JOIN {user_info_data}', $columnjoins[1]); $filterjoins = $userprofilefields->get_filters()[0]->get_joins(); $this->assertCount(2, $filterjoins); $this->assertEquals('JOIN {test} t ON t.id = id', $filterjoins[0]); $this->assertStringStartsWith('LEFT JOIN {user_info_data}', $filterjoins[1]); } /** * Test for get_filters */ public function test_get_filters(): void { $this->resetAfterTest(); $this->setAdminUser(); // Get pre-existing user profile fields. $userentity = new user(); $initialfilters = (new user_profile_fields( $userentity->get_table_alias('user') . '.id', $userentity->get_entity_name(), ))->get_filters(); // Create a field which will duplicate one of the subsequently generated fields (case-insensitive shortname). $this->getDataGenerator()->create_custom_profile_field([ 'shortname' => 'CHECKBOX', 'name' => 'Duplicate checkbox field', 'datatype' => 'checkbox', ]); // Add new custom profile fields. $userprofilefields = $this->generate_userprofilefields(); // Ensure pre-existing fields are ignored in subsequent assertions. $filters = array_slice($userprofilefields->get_filters(), count($initialfilters)); $this->assertCount(6, $filters); $this->assertContainsOnlyInstancesOf(filter::class, $filters); // Filter headers. $this->assertEquals([ 'Checkbox field', 'Date field', 'Menu field', 'MSN ID', 'Text field', 'Textarea field', ], array_map( fn(filter $filter): string => $filter->get_header(), $filters, )); // Filter types. $this->assertEquals([ boolean_select::class, date::class, select::class, text::class, text::class, text::class, ], array_map( fn(filter $filter) => $filter->get_filter_class(), $filters, )); // Filter available. $this->assertEquals([ true, true, true, true, true, true, ], array_map( fn(filter $filter): bool => $filter->get_is_available(), $filters, )); // Filter available, for non-privileged user. $this->setUser(null); $this->assertEquals([ true, false, true, true, true, true, ], array_map( fn(filter $filter): bool => $filter->get_is_available(), array_slice($userprofilefields->get_filters(), count($initialfilters)), )); } /** * Test that adding user profile field columns to a report returns expected values */ public function test_custom_report_content(): void { $this->resetAfterTest(); $this->setAdminUser(); // Create test subject with user profile fields content. $this->generate_userprofilefields(); $this->getDataGenerator()->create_user([ 'firstname' => 'Zebedee', 'profile_field_checkbox' => 0, 'profile_field_datetime' => '2021-12-09', 'profile_field_menu' => 'Dog', 'profile_field_Social' => 12345, 'profile_field_text' => 'Hello', 'profile_field_textarea' => 'Goodbye', ]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); // Add user profile field columns to the report. $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:firstname', 'sortenabled' => 1]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_checkbox']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_datetime']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_menu']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_social']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_text']); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:profilefield_textarea']); $content = $this->get_custom_report_content($report->get('id')); $this->assertEquals([ [ 'Admin', 'Yes', 'Not set', 'Cat', '', 'default', format_text('Default', options: ['overflowdiv' => true]), ], [ 'Zebedee', 'No', '9 December 2021', 'Dog', '12345', 'Hello', format_text('Goodbye', options: ['overflowdiv' => true]), ], ], array_map('array_values', $content)); } /** * Data provider for {@see test_custom_report_filter} * * @return array[] */ public static function custom_report_filter_provider(): array { return [ 'Filter by checkbox profile field' => ['user:profilefield_checkbox', [ 'user:profilefield_checkbox_operator' => boolean_select::NOT_CHECKED, ], 'testuser'], 'Filter by checkbox profile field (default)' => ['user:profilefield_checkbox', [ 'user:profilefield_checkbox_operator' => boolean_select::CHECKED, ], 'admin'], 'Filter by datetime profile field' => ['user:profilefield_datetime', [ 'user:profilefield_datetime_operator' => date::DATE_RANGE, 'user:profilefield_datetime_from' => 1622502000, ], 'testuser'], 'Filter by datetime profile field (no match)' => ['user:profilefield_datetime', [ 'user:profilefield_datetime_operator' => date::DATE_RANGE, 'user:profilefield_datetime_from' => 1672531200, ]], 'Filter by menu profile field' => ['user:profilefield_menu', [ 'user:profilefield_menu_operator' => select::EQUAL_TO, 'user:profilefield_menu_value' => 'Dog', ], 'testuser'], 'Filter by menu profile field (default)' => ['user:profilefield_menu', [ 'user:profilefield_menu_operator' => select::EQUAL_TO, 'user:profilefield_menu_value' => 'Cat', ], 'admin'], 'Filter by menu profile field (no match)' => ['user:profilefield_menu', [ 'user:profilefield_menu_operator' => select::EQUAL_TO, 'user:profilefield_menu_value' => 'Fish', ]], 'Filter by social profile field' => ['user:profilefield_social', [ 'user:profilefield_social_operator' => text::IS_EQUAL_TO, 'user:profilefield_social_value' => '12345', ], 'testuser'], 'Filter by social profile field (no match)' => ['user:profilefield_social', [ 'user:profilefield_social_operator' => text::IS_EQUAL_TO, 'user:profilefield_social_value' => '54321', ]], 'Filter by text profile field' => ['user:profilefield_text', [ 'user:profilefield_text_operator' => text::IS_EQUAL_TO, 'user:profilefield_text_value' => 'Hello', ], 'testuser'], 'Filter by text profile field (default)' => ['user:profilefield_text', [ 'user:profilefield_text_operator' => text::IS_EQUAL_TO, 'user:profilefield_text_value' => 'default', ], 'admin'], 'Filter by text profile field (no match)' => ['user:profilefield_text', [ 'user:profilefield_text_operator' => text::IS_EQUAL_TO, 'user:profilefield_text_value' => 'hola', ]], 'Filter by textarea profile field' => ['user:profilefield_textarea', [ 'user:profilefield_textarea_operator' => text::IS_EQUAL_TO, 'user:profilefield_textarea_value' => 'Goodbye', ], 'testuser'], 'Filter by textarea profile field (default)' => ['user:profilefield_textarea', [ 'user:profilefield_textarea_operator' => text::IS_EQUAL_TO, 'user:profilefield_textarea_value' => 'Default', ], 'admin'], 'Filter by textarea profile field (no match)' => ['user:profilefield_textarea', [ 'user:profilefield_textarea_operator' => text::IS_EMPTY, 'user:profilefield_textarea_value' => 'Adios', ]], ]; } /** * Test filtering report by custom profile fields * * @param string $filtername * @param array $filtervalues * @param string|null $expectmatch * * @dataProvider custom_report_filter_provider */ public function test_custom_report_filter(string $filtername, array $filtervalues, ?string $expectmatch = null): void { $this->resetAfterTest(); $this->setAdminUser(); // Create test subject with user profile fields content. $this->generate_userprofilefields(); $this->getDataGenerator()->create_user([ 'username' => 'testuser', 'profile_field_checkbox' => 0, 'profile_field_datetime' => '2021-12-09', 'profile_field_menu' => 'Dog', 'profile_field_Social' => '12345', 'profile_field_text' => 'Hello', 'profile_field_textarea' => 'Goodbye', ]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); // Create report containing single column, and given filter. $report = $generator->create_report(['name' => 'Users', 'source' => users::class, 'default' => 0]); $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:username']); // Add filter, set it's values. $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => $filtername]); $content = $this->get_custom_report_content($report->get('id'), 0, $filtervalues); if ($expectmatch !== null) { $this->assertCount(1, $content); $this->assertEquals($expectmatch, reset($content[0])); } else { $this->assertEmpty($content); } } /** * Stress test user datasource using profile fields * * In order to execute this test PHPUNIT_LONGTEST should be defined as true in phpunit.xml or directly in config.php */ public function test_stress_datasource(): void { if (!PHPUNIT_LONGTEST) { $this->markTestSkipped('PHPUNIT_LONGTEST is not defined'); } $this->resetAfterTest(); $this->generate_userprofilefields(); $this->getDataGenerator()->create_user([ 'profile_field_checkbox' => true, 'profile_field_datetime' => '2021-12-09', 'profile_field_menu' => 'Dog', 'profile_field_Social' => '12345', 'profile_field_text' => 'Hello', 'profile_field_textarea' => 'Goodbye', ]); $this->datasource_stress_test_columns(users::class); $this->datasource_stress_test_columns_aggregation(users::class); $this->datasource_stress_test_conditions(users::class, 'user:idnumber'); } } PK a<�\� � % tests/local/filters/category_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\helpers\database; use core_reportbuilder\local\report\filter; /** * Unit tests for course category report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\category * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class category_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array */ public static function get_sql_filter_provider(): array { return [ // Equal to. ['One', category::EQUAL_TO, false, ['One']], ['One', category::EQUAL_TO, true, ['One', 'Two', 'Three']], ['Two', category::EQUAL_TO, true, ['Two', 'Three']], ['Three', category::EQUAL_TO, true, ['Three']], // Not equal to. ['One', category::NOT_EQUAL_TO, false, ['Category 1', 'Two', 'Three', 'Four', 'Five', 'Six']], ['One', category::NOT_EQUAL_TO, true, ['Category 1', 'Four', 'Five', 'Six']], ['Two', category::NOT_EQUAL_TO, true, ['Category 1', 'One', 'Four', 'Five', 'Six']], ['Three', category::NOT_EQUAL_TO, true, ['Category 1', 'One', 'Two', 'Four', 'Five', 'Six']], // Default/empty state. [null, category::EQUAL_TO, false, ['Category 1', 'One', 'Two', 'Three', 'Four', 'Five', 'Six']], ]; } /** * Test getting filter SQL * * @param string|null $categoryname * @param int $operator * @param bool $subcategories * @param string[] $expectedcategories * * @dataProvider get_sql_filter_provider */ public function test_get_sql_filter( ?string $categoryname, int $operator, bool $subcategories, array $expectedcategories, ): void { global $DB; $this->resetAfterTest(); // Create category tree "One -> Two -> Three". $category1 = $this->getDataGenerator()->create_category(['name' => 'One']); $category2 = $this->getDataGenerator()->create_category(['name' => 'Two', 'parent' => $category1->id]); $category3 = $this->getDataGenerator()->create_category(['name' => 'Three', 'parent' => $category2->id]); // Second category tree "Four -> Five -> Six". $category4 = $this->getDataGenerator()->create_category(['name' => 'Four']); $category5 = $this->getDataGenerator()->create_category(['name' => 'Five', 'parent' => $category4->id]); $category6 = $this->getDataGenerator()->create_category(['name' => 'Six', 'parent' => $category5->id]); if ($categoryname !== null) { $categoryid = $DB->get_field('course_categories', 'id', ['name' => $categoryname], MUST_EXIST); } else { $categoryid = null; } $filter = new filter( category::class, 'test', new lang_string('yes'), 'testentity', 'id' ); // Create instance of our filter, passing given operator. [$select, $params] = category::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $categoryid, $filter->get_unique_identifier() . '_subcategories' => $subcategories, ]); $categories = $DB->get_fieldset_select('course_categories', 'name', $select, $params); $this->assertEqualsCanonicalizing($expectedcategories, $categories); } /** * Test getting filter SQL with parameters */ public function test_get_sql_filter_parameters(): void { global $DB; $this->resetAfterTest(); $category1 = $this->getDataGenerator()->create_category(['name' => 'One']); $category2 = $this->getDataGenerator()->create_category(['name' => 'Two', 'parent' => $category1->id]); $category3 = $this->getDataGenerator()->create_category(['name' => 'Three']); // Rather convoluted filter SQL, but enough to demonstrate usage of a parameter that gets used twice in the query. $paramzero = database::generate_param_name(); $filter = new filter( category::class, 'test', new lang_string('yes'), 'testentity', "id + :{$paramzero}", [$paramzero => 0] ); // When including sub-categories, the filter SQL is included twice (for the category itself, plus to find descendents). [$select, $params] = category::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_value' => $category1->id, $filter->get_unique_identifier() . '_subcategories' => true, ]); $categories = $DB->get_fieldset_select('course_categories', 'id', $select, $params); $this->assertEqualsCanonicalizing([$category1->id, $category2->id], $categories); } } PK a<�\@�akR6 R6 ! tests/local/filters/date_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use core\clock; use core\lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for date report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\date * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class date_test extends advanced_testcase { /** @var clock $clock */ private readonly clock $clock; /** * Mock the clock */ protected function setUp(): void { parent::setUp(); $this->clock = $this->mock_clock_with_frozen(1622502000); } /** * Data provider for {@see test_get_sql_filter_simple} * * @return array */ public static function get_sql_filter_simple_provider(): array { return [ [date::DATE_ANY, true], [date::DATE_NOT_EMPTY, true], [date::DATE_EMPTY, false], ]; } /** * Test getting filter SQL * * @param int $operator * @param bool $expectuser * * @dataProvider get_sql_filter_simple_provider */ public function test_get_sql_filter_simple(int $operator, bool $expectuser): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user([ 'timecreated' => 12345, ]); $filter = new filter( date::class, 'test', new lang_string('yes'), 'testentity', 'timecreated' ); // Create instance of our filter, passing given operator. [$select, $params] = date::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, ]); $usernames = $DB->get_fieldset_select('user', 'username', $select, $params); if ($expectuser) { $this->assertContains($user->username, $usernames); } else { $this->assertNotContains($user->username, $usernames); } } /** * Test getting filter SQL while specifying a date range */ public function test_get_sql_filter_date_range(): void { global $DB; $this->resetAfterTest(); $userone = $this->getDataGenerator()->create_user(['timecreated' => 50]); $usertwo = $this->getDataGenerator()->create_user(['timecreated' => 100]); $filter = new filter( date::class, 'test', new lang_string('yes'), 'testentity', 'timecreated' ); // Create instance of our date range filter. [$select, $params] = date::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => date::DATE_RANGE, $filter->get_unique_identifier() . '_from' => 80, $filter->get_unique_identifier() . '_to' => 120, ]); // The only matching user should be our first test user. $usernames = $DB->get_fieldset_select('user', 'username', $select, $params); $this->assertEquals([$usertwo->username], $usernames); } /** * Data provider for {@see test_get_sql_filter_current_week} * * @return array */ public static function get_sql_filter_current_week_provider(): array { return array_map(static function(int $day): array { return [$day]; }, range(0, 6)); } /** * Test getting filter SQL for the current week. Note that relative dates are hard to test, here we are asserting that * the current time is always within the current week regardless of calendar configuration/preferences * * @param int $startweekday * * @dataProvider get_sql_filter_current_week_provider */ public function test_get_sql_filter_current_week(int $startweekday): void { global $DB; $this->resetAfterTest(); set_config('calendar_startwday', $startweekday); $usertimecreated = $this->clock->time(); $user = $this->getDataGenerator()->create_user(['timecreated' => $usertimecreated]); $filter = new filter( date::class, 'test', new lang_string('yes'), 'testentity', 'timecreated' ); [$select, $params] = date::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => date::DATE_CURRENT, $filter->get_unique_identifier() . '_unit' => date::DATE_UNIT_WEEK, ]); $matchingusers = $DB->get_fieldset_select('user', 'username', $select, $params); $this->assertContains($user->username, $matchingusers); } /** * Data provider for {@see test_get_sql_filter_current_week_no_match} * * @return array */ public static function get_sql_filter_current_week_no_match_provider(): array { $data = []; // For each day, create provider data for -/+ 7 days. foreach (range(0, 6) as $day) { $data = array_merge($data, [ [$day, '-7 day'], [$day, '+7 day'], ]); } return $data; } /** * Test getting filter SQL for the current week excludes dates that don't match (outside week time range) * * @param int $startweekday * @param string $timecreated Relative time suitable for passing to {@see strtotime} * * @dataProvider get_sql_filter_current_week_no_match_provider */ public function test_get_sql_filter_current_week_no_match(int $startweekday, string $timecreated): void { global $DB; $this->resetAfterTest(); set_config('calendar_startwday', $startweekday); $usertimecreated = strtotime($timecreated, $this->clock->time()); $user = $this->getDataGenerator()->create_user(['timecreated' => $usertimecreated]); $filter = new filter( date::class, 'test', new lang_string('yes'), 'testentity', 'timecreated' ); [$select, $params] = date::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => date::DATE_CURRENT, $filter->get_unique_identifier() . '_unit' => date::DATE_UNIT_WEEK, ]); $matchingusers = $DB->get_fieldset_select('user', 'username', $select, $params); $this->assertNotContains($user->username, $matchingusers); } /** * Data provider for {@see test_get_sql_filter_relative} * * @return array */ public static function get_sql_filter_relative_provider(): array { return [ 'Before minute' => [date::DATE_BEFORE, 1, date::DATE_UNIT_MINUTE, '-90 second'], 'Before hour' => [date::DATE_BEFORE, 1, date::DATE_UNIT_HOUR, '-90 minute'], 'Before day' => [date::DATE_BEFORE, 1, date::DATE_UNIT_DAY, '-25 hour'], 'Before week' => [date::DATE_BEFORE, 1, date::DATE_UNIT_WEEK, '-10 day'], 'Before month' => [date::DATE_BEFORE, 1, date::DATE_UNIT_MONTH, '-7 week'], 'Before year' => [date::DATE_BEFORE, 1, date::DATE_UNIT_YEAR, '-15 month'], 'Before two minutes' => [date::DATE_BEFORE, 2, date::DATE_UNIT_MINUTE, '-150 second'], 'Before two hours' => [date::DATE_BEFORE, 2, date::DATE_UNIT_HOUR, '-150 minute'], 'Before two days' => [date::DATE_BEFORE, 2, date::DATE_UNIT_DAY, '-50 hour'], 'Before two weeks' => [date::DATE_BEFORE, 2, date::DATE_UNIT_WEEK, '-20 day'], 'Before two months' => [date::DATE_BEFORE, 2, date::DATE_UNIT_MONTH, '-15 week'], 'Before two years' => [date::DATE_BEFORE, 2, date::DATE_UNIT_YEAR, '-30 month'], 'After minute' => [date::DATE_AFTER, 1, date::DATE_UNIT_MINUTE, '+90 second'], 'After hour' => [date::DATE_AFTER, 1, date::DATE_UNIT_HOUR, '+90 minute'], 'After day' => [date::DATE_AFTER, 1, date::DATE_UNIT_DAY, '+25 hour'], 'After week' => [date::DATE_AFTER, 1, date::DATE_UNIT_WEEK, '+10 day'], 'After month' => [date::DATE_AFTER, 1, date::DATE_UNIT_MONTH, '+7 week'], 'After year' => [date::DATE_AFTER, 1, date::DATE_UNIT_YEAR, '+15 month'], 'After two minutes' => [date::DATE_AFTER, 2, date::DATE_UNIT_MINUTE, '+150 second'], 'After two hours' => [date::DATE_AFTER, 2, date::DATE_UNIT_HOUR, '+150 minute'], 'After two days' => [date::DATE_AFTER, 2, date::DATE_UNIT_DAY, '+50 hour'], 'After two weeks' => [date::DATE_AFTER, 2, date::DATE_UNIT_WEEK, '+20 day'], 'After two months' => [date::DATE_AFTER, 2, date::DATE_UNIT_MONTH, '+15 week'], 'After two years' => [date::DATE_AFTER, 2, date::DATE_UNIT_YEAR, '+30 month'], 'Last minute' => [date::DATE_LAST, 1, date::DATE_UNIT_MINUTE, '-30 second'], 'Last hour' => [date::DATE_LAST, 1, date::DATE_UNIT_HOUR, '-30 minute'], 'Last day' => [date::DATE_LAST, 1, date::DATE_UNIT_DAY, '-6 hour'], 'Last week' => [date::DATE_LAST, 1, date::DATE_UNIT_WEEK, '-3 day'], 'Last month' => [date::DATE_LAST, 1, date::DATE_UNIT_MONTH, '-3 week'], 'Last year' => [date::DATE_LAST, 1, date::DATE_UNIT_YEAR, '-6 month'], 'Last two minutes' => [date::DATE_LAST, 2, date::DATE_UNIT_MINUTE, '-90 second'], 'Last two hours' => [date::DATE_LAST, 2, date::DATE_UNIT_HOUR, '-90 minute'], 'Last two days' => [date::DATE_LAST, 2, date::DATE_UNIT_DAY, '-25 hour'], 'Last two weeks' => [date::DATE_LAST, 2, date::DATE_UNIT_WEEK, '-10 day'], 'Last two months' => [date::DATE_LAST, 2, date::DATE_UNIT_MONTH, '-7 week'], 'Last two years' => [date::DATE_LAST, 2, date::DATE_UNIT_YEAR, '-15 month'], // Current week is tested separately. 'Current minute' => [date::DATE_CURRENT, null, date::DATE_UNIT_MINUTE], 'Current hour' => [date::DATE_CURRENT, null, date::DATE_UNIT_HOUR], 'Current day' => [date::DATE_CURRENT, null, date::DATE_UNIT_DAY], 'Current month' => [date::DATE_CURRENT, null, date::DATE_UNIT_MONTH], 'Current year' => [date::DATE_CURRENT, null, date::DATE_UNIT_YEAR], 'Next minute' => [date::DATE_NEXT, 1, date::DATE_UNIT_MINUTE, '+30 second'], 'Next hour' => [date::DATE_NEXT, 1, date::DATE_UNIT_HOUR, '+30 minute'], 'Next day' => [date::DATE_NEXT, 1, date::DATE_UNIT_DAY, '+6 hour'], 'Next week' => [date::DATE_NEXT, 1, date::DATE_UNIT_WEEK, '+3 day'], 'Next month' => [date::DATE_NEXT, 1, date::DATE_UNIT_MONTH, '+3 week'], 'Next year' => [date::DATE_NEXT, 1, date::DATE_UNIT_YEAR, '+6 month'], 'Next two minutes' => [date::DATE_NEXT, 2, date::DATE_UNIT_MINUTE, '+90 second'], 'Next two hours' => [date::DATE_NEXT, 2, date::DATE_UNIT_HOUR, '+90 minute'], 'Next two days' => [date::DATE_NEXT, 2, date::DATE_UNIT_DAY, '+25 hour'], 'Next two weeks' => [date::DATE_NEXT, 2, date::DATE_UNIT_WEEK, '+10 day'], 'Next two months' => [date::DATE_NEXT, 2, date::DATE_UNIT_MONTH, '+7 week'], 'Next two years' => [date::DATE_NEXT, 2, date::DATE_UNIT_YEAR, '+15 month'], 'In the past' => [date::DATE_PAST, null, null, '-1 minute'], 'In the future' => [date::DATE_FUTURE, null, null, '+1 minute'], ]; } /** * Unit tests for filtering relative dates * * @param int $operator * @param int|null $unitvalue * @param int|null $unit * @param string|null $timecreated Relative time suitable for passing to {@see strtotime} (or null for current time) * * @dataProvider get_sql_filter_relative_provider */ public function test_get_sql_filter_relative(int $operator, ?int $unitvalue, ?int $unit, ?string $timecreated = null): void { global $DB; $this->resetAfterTest(); // Use relative time period if present, otherwise default to current clock time. $usertimecreated = $this->clock->time(); if ($timecreated !== null) { $usertimecreated = strtotime($timecreated, $usertimecreated); } $user = $this->getDataGenerator()->create_user(['timecreated' => $usertimecreated]); $filter = new filter( date::class, 'test', new lang_string('yes'), 'testentity', 'timecreated' ); [$select, $params] = date::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $unitvalue, $filter->get_unique_identifier() . '_unit' => $unit, ]); $matchingusers = $DB->get_fieldset_select('user', 'username', $select, $params); $this->assertContains($user->username, $matchingusers); } } PK a<�\ߩx�� � ! tests/local/filters/tags_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder_generator; use core_reportbuilder\local\report\filter; use core_user\reportbuilder\datasource\users; /** * Unit tests for tags report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\tags * @copyright 2022 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class tags_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array[] */ public static function get_sql_filter_provider(): array { return [ 'Any value' => [tags::ANY_VALUE, null, ['course01', 'course01', 'course02', 'course03']], 'Not empty' => [tags::NOT_EMPTY, null, ['course01', 'course01', 'course02']], 'Empty' => [tags::EMPTY, null, ['course03']], 'Equal to unselected' => [tags::EQUAL_TO, null, ['course01', 'course01', 'course02', 'course03']], 'Equal to selected tag' => [tags::EQUAL_TO, 'cat', ['course01']], 'Not equal to unselected' => [tags::NOT_EQUAL_TO, null, ['course01', 'course01', 'course02', 'course03']], 'Not equal to selected tag' => [tags::NOT_EQUAL_TO, 'fish', ['course01', 'course01', 'course03']], ]; } /** * Test getting filter SQL * * @param int $operator * @param string|null $tagname * @param array $expectedcoursenames * * @dataProvider get_sql_filter_provider */ public function test_get_sql_filter(int $operator, ?string $tagname, array $expectedcoursenames): void { global $DB; $this->resetAfterTest(); $this->getDataGenerator()->create_course(['fullname' => 'course01', 'tags' => ['cat', 'dog']]); $this->getDataGenerator()->create_course(['fullname' => 'course02', 'tags' => ['fish']]); $this->getDataGenerator()->create_course(['fullname' => 'course03']); $filter = (new filter( tags::class, 'tags', new lang_string('tags'), 'testentity', 't.id' )); // Create instance of our filter, passing ID of the tag if specified. if ($tagname !== null) { $tagid = $DB->get_field('tag', 'id', ['name' => $tagname], MUST_EXIST); $value = [$tagid]; } else { $value = null; } [$select, $params] = tags::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $value, ]); $sql = 'SELECT c.fullname FROM {course} c LEFT JOIN {tag_instance} ti ON ti.itemid = c.id LEFT JOIN {tag} t ON t.id = ti.tagid WHERE c.id != ' . SITEID; if ($select) { $sql .= " AND {$select}"; } $courses = $DB->get_fieldset_sql($sql, $params); $this->assertEqualsCanonicalizing($expectedcoursenames, $courses); } /** * Data provider for {@see test_get_sql_filter_component} * * @return array[] */ public static function get_sql_filter_component_provider(): array { return [ 'Any value' => [tags::ANY_VALUE, null, ['report01', 'report02']], 'Not empty' => [tags::NOT_EMPTY, null, ['report01']], 'Empty' => [tags::EMPTY, null, ['report02']], 'Equal to unselected' => [tags::EQUAL_TO, null, ['report01', 'report02']], 'Equal to selected tag' => [tags::EQUAL_TO, 'fish', ['report01']], 'Equal to selected tag (different component)' => [tags::EQUAL_TO, 'cat', []], 'Not equal to unselected' => [tags::NOT_EQUAL_TO, null, ['report01', 'report02']], 'Not equal to selected tag' => [tags::NOT_EQUAL_TO, 'fish', ['report02']], 'Not Equal to selected tag (different component)' => [tags::NOT_EQUAL_TO, 'cat', ['report01', 'report02']], ]; } /** * Test getting filter SQL * * @param int $operator * @param string|null $tagname * @param array $expectedreportnames * * @dataProvider get_sql_filter_component_provider */ public function test_get_sql_filter_component(int $operator, ?string $tagname, array $expectedreportnames): void { global $DB; $this->resetAfterTest(); // Create a course with tags, we shouldn't ever get this data back when specifying another component. $this->getDataGenerator()->create_course(['tags' => ['cat', 'dog']]); /** @var core_reportbuilder_generator $generator */ $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder'); $generator->create_report(['name' => 'report01', 'source' => users::class, 'tags' => ['fish']]); $generator->create_report(['name' => 'report02', 'source' => users::class]); $filter = (new filter( tags::class, 'tags', new lang_string('tags'), 'testentity', 'r.id' ))->set_options([ 'component' => 'core_reportbuilder', 'itemtype' => 'reportbuilder_report', ]); // Create instance of our filter, passing ID of the tag if specified. if ($tagname !== null) { $tagid = $DB->get_field('tag', 'id', ['name' => $tagname], MUST_EXIST); $value = [$tagid]; } else { $value = null; } [$select, $params] = tags::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $value, ]); $sql = 'SELECT r.name FROM {reportbuilder_report} r'; if ($select) { $sql .= " WHERE {$select}"; } $reports = $DB->get_fieldset_sql($sql, $params); $this->assertEqualsCanonicalizing($expectedreportnames, $reports); } } PK a<�\�#�# # # tests/local/filters/number_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for number report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\number * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class number_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter_simple} * * @return array[] */ public static function get_sql_filter_simple_provider(): array { return [ [number::ANY_VALUE, null, null, true], [number::IS_NOT_EMPTY, null, null, true], [number::IS_EMPTY, null, null, false], [number::LESS_THAN, 122.5, null, false], [number::LESS_THAN, 123, null, false], [number::LESS_THAN, 123.5, null, true], [number::GREATER_THAN, 122.5, null, true], [number::GREATER_THAN, 123, null, false], [number::GREATER_THAN, 123.5, null, false], [number::EQUAL_TO, 122, null, false], [number::EQUAL_TO, 123, null, true], [number::EQUAL_TO, 124, null, false], [number::EQUAL_OR_LESS_THAN, 122, null, false], [number::EQUAL_OR_LESS_THAN, 123, null, true], [number::EQUAL_OR_LESS_THAN, 124, null, true], [number::EQUAL_OR_GREATER_THAN, 122, null, true], [number::EQUAL_OR_GREATER_THAN, 123, null, true], [number::EQUAL_OR_GREATER_THAN, 124, null, false], [number::RANGE, 121, 122, false], [number::RANGE, 122, 124, true], [number::RANGE, 122, 123, true], [number::RANGE, 122.5, 123.5, true], [number::RANGE, 123, 124, true], [number::RANGE, 124, 125, false], ]; } /** * Test getting filter SQL * * @param int $operator * @param float|null $value1 * @param float|null $value2 * @param bool $expectmatch * * @dataProvider get_sql_filter_simple_provider */ public function test_get_sql_filter_simple(int $operator, ?float $value1, ?float $value2, bool $expectmatch): void { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course([ 'timecreated' => 123, ]); $filter = new filter( number::class, 'test', new lang_string('course'), 'testentity', 'timecreated' ); // Create instance of our filter, passing given operator. [$select, $params] = number::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_value1' => $value1, $filter->get_unique_identifier() . '_value2' => $value2, $filter->get_unique_identifier() . '_operator' => $operator, ]); $fullnames = $DB->get_fieldset_select('course', 'fullname', $select, $params); if ($expectmatch) { $this->assertContains($course->fullname, $fullnames); } else { $this->assertNotContains($course->fullname, $fullnames); } } /** * Data provider for {@see test_get_sql_filter_invalid} * * @return array[] */ public static function get_sql_filter_invalid_provider(): array { return [ [number::LESS_THAN], [number::GREATER_THAN], [number::EQUAL_TO], [number::EQUAL_OR_LESS_THAN], [number::EQUAL_OR_GREATER_THAN], [number::RANGE], ]; } /** * Test getting filter SQL for operators that require values * * @param int $operator * * @dataProvider get_sql_filter_invalid_provider */ public function test_get_sql_filter_invalid(int $operator): void { $filter = new filter( number::class, 'test', new lang_string('course'), 'testentity', 'timecreated' ); [$select, $params] = number::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, ]); $this->assertEquals('', $select); $this->assertEquals([], $params); } } PK a<�\͖� % tests/local/filters/duration_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for duration report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\duration * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class duration_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array */ public static function get_sql_filter_provider(): array { return [ 'Any duration' => [duration::DURATION_ANY, true], // Maximum operator. 'Maximum seconds non-match' => [duration::DURATION_MAXIMUM, false, HOURSECS, 1], 'Maximum seconds match' => [duration::DURATION_MAXIMUM, true, HOURSECS * 3, 1], 'Maximum minutes non-match' => [duration::DURATION_MAXIMUM, false, 60, MINSECS], 'Maximum minutes match' => [duration::DURATION_MAXIMUM, true, 150, MINSECS], 'Maximum hours non-match (float)' => [duration::DURATION_MAXIMUM, false, 0.777, HOURSECS], 'Maximum hours non-match' => [duration::DURATION_MAXIMUM, false, 1, HOURSECS], 'Maximum hours match (float)' => [duration::DURATION_MAXIMUM, true, 2.333, HOURSECS], 'Maximum hours match' => [duration::DURATION_MAXIMUM, true, 3, HOURSECS], // Minimum operator. 'Minimum seconds match' => [duration::DURATION_MINIMUM, true, HOURSECS, 1], 'Minimum seconds non-match' => [duration::DURATION_MINIMUM, false, HOURSECS * 3, 1], 'Minimum minutes match' => [duration::DURATION_MINIMUM, true, 60, MINSECS], 'Minimum minutes non-match' => [duration::DURATION_MINIMUM, false, 150, MINSECS], 'Minimum hours match (float)' => [duration::DURATION_MINIMUM, true, 0.777, HOURSECS], 'Minimum hours match' => [duration::DURATION_MINIMUM, true, 1, HOURSECS], 'Minimum hours non-match (float)' => [duration::DURATION_MINIMUM, false, 2.333, HOURSECS], 'Minimum hours non-match' => [duration::DURATION_MINIMUM, false, 3, HOURSECS], ]; } /** * Test getting filter SQL * * @param int $operator * @param bool $expectuser * @param float $value * @param int $unit * * @dataProvider get_sql_filter_provider */ public function test_get_sql_filter(int $operator, bool $expectuser, float $value = 0, int $unit = MINSECS): void { global $DB; $this->resetAfterTest(); // We are going to enrol our student from now, with a duration of two hours (timeend is two hours later). $timestart = time(); $timeend = $timestart + (HOURSECS * 2); $course = $this->getDataGenerator()->create_course(); $user = $this->getDataGenerator()->create_and_enrol($course, 'student', null, 'manual', $timestart, $timeend); $filter = new filter( duration::class, 'test', new lang_string('yes'), 'testentity', 'timeend - timestart' ); // Create instance of our filter, passing given values. [$select, $params] = duration::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $value, $filter->get_unique_identifier() . '_unit' => $unit, ]); $useridfield = $DB->get_field_select('user_enrolments', 'userid', $select, $params); if ($expectuser) { $this->assertEquals($useridfield, $user->id); } else { $this->assertFalse($useridfield); } } } PK a<�\���� � + tests/local/filters/boolean_select_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for boolean report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\boolean_select * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class boolean_select_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter_simple} * * @return array */ public static function get_sql_filter_simple_provider(): array { return [ [boolean_select::ANY_VALUE, true], [boolean_select::CHECKED, true], [boolean_select::NOT_CHECKED, false], ]; } /** * Test getting filter SQL * * @param int $operator * @param bool $expectuser * * @dataProvider get_sql_filter_simple_provider */ public function test_get_sql_filter_simple(int $operator, bool $expectuser): void { global $DB; $this->resetAfterTest(); $user = $this->getDataGenerator()->create_user([ 'suspended' => 1, ]); $filter = new filter( boolean_select::class, 'test', new lang_string('yes'), 'testentity', 'suspended' ); // Create instance of our filter, passing given operator. [$select, $params] = boolean_select::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, ]); $usernames = $DB->get_fieldset_select('user', 'username', $select, $params); if ($expectuser) { $this->assertContains($user->username, $usernames); } else { $this->assertNotContains($user->username, $usernames); } } } PK a<�\����� � # tests/local/filters/select_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for select report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\select * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class select_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter_simple} * * @return array */ public static function get_sql_filter_simple_provider(): array { return [ [select::ANY_VALUE, null, true], [select::EQUAL_TO, 'starwars', true], [select::EQUAL_TO, 'mandalorian', false], [select::NOT_EQUAL_TO, 'starwars', false], [select::NOT_EQUAL_TO, 'mandalorian', true], ]; } /** * Test getting filter SQL * * @param int $operator * @param string|null $value * @param bool $expectmatch * * @dataProvider get_sql_filter_simple_provider */ public function test_get_sql_filter_simple(int $operator, ?string $value, bool $expectmatch): void { global $DB; $this->resetAfterTest(); $course1 = $this->getDataGenerator()->create_course([ 'fullname' => "May the course be with you", 'shortname' => 'starwars', ]); $course2 = $this->getDataGenerator()->create_course([ 'fullname' => "This is the course", 'shortname' => 'mandalorian', ]); $filter = (new filter( select::class, 'test', new lang_string('course'), 'testentity', 'shortname' ))->set_options([ $course1->shortname => $course1->fullname, $course2->shortname => $course2->fullname, ]); // Create instance of our filter, passing given operator. [$select, $params] = select::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $value, ]); $fullnames = $DB->get_fieldset_select('course', 'fullname', $select, $params); if ($expectmatch) { $this->assertContains($course1->fullname, $fullnames); } else { $this->assertNotContains($course1->fullname, $fullnames); } } } PK a<�\�<'�� � , tests/local/filters/course_selector_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use core_reportbuilder\local\report\filter; /** * Unit tests for course selector filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\course_selector * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class course_selector_test extends advanced_testcase { /** * Test getting filter SQL */ public function test_get_sql_filter(): void { global $DB; $this->resetAfterTest(); $course1 = $this->getDataGenerator()->create_course([ 'fullname' => "Time travel", ]); $course2 = $this->getDataGenerator()->create_course([ 'fullname' => "Quantum computing", ]); $course3 = $this->getDataGenerator()->create_course([ 'fullname' => "Space travel", ]); $filter = new filter( course_selector::class, 'test', new \lang_string('course'), 'testentity', 'id' ); // Create instance of our filter, passing given courses ids. [$select, $params] = text::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_values' => [$course1->id, $course3->id], ]); $fullnames = $DB->get_fieldset_select('course', 'fullname', $select, $params); $this->assertEqualsCanonicalizing(['Time travel', 'Space travel'], $fullnames); // Test without passing any course id. [$select, $params] = text::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_values' => [], ]); $fullnames = $DB->get_fieldset_select('course', 'fullname', $select, $params); $this->assertEqualsCanonicalizing(['Time travel', 'Quantum computing', 'Space travel', 'PHPUnit test site'], $fullnames); } } PK a<�\ �3� � ) tests/local/filters/autocomplete_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use core_reportbuilder\local\report\filter; /** * Unit tests for course selector filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\autocomplete * @copyright 2022 Nathan Nguyen <nathannguyen@catalyst-au.net> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class autocomplete_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array */ public static function get_sql_filter_provider(): array { return [ [[], ["Course 1 full name", "Course 2 full name", "Course 3 full name", "PHPUnit test site"]], [["course1", "course3"], ["Course 1 full name", "Course 3 full name"]], [["course1"], ["Course 1 full name"]], ]; } /** * Test getting filter SQL * * @param array $shortnames list of course short name * @param array $expected list of course full name * * @dataProvider get_sql_filter_provider */ public function test_get_sql_filter(array $shortnames, array $expected): void { global $DB; $this->resetAfterTest(); // Create courses as values for autocompletion. $course1 = $this->getDataGenerator()->create_course([ 'fullname' => "Course 1 full name", 'shortname' => 'course1', ]); $course2 = $this->getDataGenerator()->create_course([ 'fullname' => "Course 2 full name", 'shortname' => 'course2', ]); $course3 = $this->getDataGenerator()->create_course([ 'fullname' => "Course 3 full name", 'shortname' => 'course3', ]); $filter = (new filter( autocomplete::class, 'test', new \lang_string('course'), 'testentity', 'shortname' ))->set_options([ $course1->shortname => $course1->fullname, $course2->shortname => $course2->fullname, $course3->shortname => $course3->fullname, ]); [$select, $params] = text::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_values' => $shortnames, ]); $fullnames = $DB->get_fieldset_select('course', 'fullname', $select, $params); $this->assertEqualsCanonicalizing($expected, $fullnames); } } PK a<�\��z� � ! tests/local/filters/text_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for text report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\text * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class text_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter_simple} * * @return array */ public static function get_sql_filter_simple_provider(): array { return [ [text::ANY_VALUE, null, true], [text::CONTAINS, 'looking', true], [text::CONTAINS, 'sky', false], [text::DOES_NOT_CONTAIN, 'sky', true], [text::DOES_NOT_CONTAIN, 'looking', false], [text::IS_EQUAL_TO, "Hello, is it me you're looking for?", true], [text::IS_EQUAL_TO, 'I can see it in your eyes', false], [text::IS_NOT_EQUAL_TO, "Hello, is it me you're looking for?", false], [text::IS_NOT_EQUAL_TO, 'I can see it in your eyes', true], [text::STARTS_WITH, 'Hello', true], [text::STARTS_WITH, 'sunlight', false], [text::ENDS_WITH, 'looking for?', true], [text::ENDS_WITH, 'your heart', false], // Ensure whitespace is trimmed. [text::CONTAINS, ' looking for ', true], [text::IS_EQUAL_TO, ' Hello, is it me you\'re looking for? ', true], [text::STARTS_WITH, ' Hello, is it me ', true], [text::ENDS_WITH, ' you\'re looking for? ', true], ]; } /** * Test getting filter SQL * * @param int $operator * @param string|null $value * @param bool $expectmatch * * @dataProvider get_sql_filter_simple_provider */ public function test_get_sql_filter_simple(int $operator, ?string $value, bool $expectmatch): void { global $DB; $this->resetAfterTest(); $course = $this->getDataGenerator()->create_course([ 'fullname' => "Hello, is it me you're looking for?", ]); $filter = new filter( text::class, 'test', new lang_string('course'), 'testentity', 'fullname' ); // Create instance of our filter, passing given operator. [$select, $params] = text::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value' => $value, ]); $fullnames = $DB->get_fieldset_select('course', 'fullname', $select, $params); if ($expectmatch) { $this->assertContains($course->fullname, $fullnames); } else { $this->assertNotContains($course->fullname, $fullnames); } } /** * Data provider for {@see test_get_sql_filter_empty} * * @return array */ public static function get_sql_filter_empty_provider(): array { return [ [text::IS_EMPTY, null, true], [text::IS_EMPTY, '', true], [text::IS_EMPTY, 'hola', false], [text::IS_NOT_EMPTY, null, false], [text::IS_NOT_EMPTY, '', false], [text::IS_NOT_EMPTY, 'hola', true], ]; } /** * Test getting filter SQL using the {@see text::IS_EMPTY} and {@see text::IS_NOT_EMPTY} operators * * @param int $operator * @param string|null $profilefieldvalue * @param bool $expectmatch * * @dataProvider get_sql_filter_empty_provider */ public function test_get_sql_filter_empty(int $operator, ?string $profilefieldvalue, bool $expectmatch): void { global $DB; $this->resetAfterTest(); // We are using the user.moodlenetprofile field because it is nullable. $user = $this->getDataGenerator()->create_user([ 'moodlenetprofile' => $profilefieldvalue, ]); $filter = new filter( text::class, 'test', new lang_string('user'), 'testentity', 'moodlenetprofile' ); // Create instance of our filter, passing given operator. [$select, $params] = text::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, ]); $usernames = $DB->get_fieldset_select('user', 'username', $select, $params); if ($expectmatch) { $this->assertContains($user->username, $usernames); } else { $this->assertNotContains($user->username, $usernames); } } } PK a<�\8x I� � # tests/local/filters/cohort_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for cohort report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\cohort * @copyright 2024 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class cohort_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array[] */ public static function get_sql_filter_provider(): array { return [ 'Empty' => [ [], ['C1', 'C2', 'C3'], ], 'Non-existing' => [ [-1], [], ], 'Single cohort' => [ ['C1'], ['C1'], ], 'Multiple cohorts' => [ ['C1', 'C2'], ['C1', 'C2'], ], ]; } /** * Test getting filter SQL * * @param int[]|string[] $values * @param string[] $expectcohorts * * @dataProvider get_sql_filter_provider */ public function test_get_sql_filter(array $values, array $expectcohorts): void { global $DB; $this->resetAfterTest(); $this->getDataGenerator()->create_cohort(['name' => 'C1']); $this->getDataGenerator()->create_cohort(['name' => 'C2']); $this->getDataGenerator()->create_cohort(['name' => 'C3']); // Create cohort lookup for convenience, transform values that refer to cohorts by name, to their ID. $cohortmap = $DB->get_records_menu(table: 'cohort', fields: 'name, id'); $values = array_map(static function(int|string $value) use ($cohortmap): int { if (is_numeric($value)) { return $value; } return (int) $cohortmap[$value]; }, $values); $filter = new filter( cohort::class, 'test', new lang_string('yes'), 'testentity', 'id' ); // Create instance of our filter, passing given values. [$select, $params] = cohort::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_values' => $values, ]); $cohorts = $DB->get_fieldset_select('cohort', 'name', $select, $params); $this->assertEqualsCanonicalizing($expectcohorts, $cohorts); } } PK a<�\&�8�i i % tests/local/filters/filesize_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use core\context\user; use core_reportbuilder\local\report\filter; use lang_string; /** * Unit tests for filesize report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\filesize * @copyright 2023 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class filesize_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array */ public static function get_sql_filter_provider(): array { return [ [filesize::ANY_VALUE, true], [filesize::LESS_THAN, false, 10, filesize::SIZE_UNIT_BYTE], [filesize::LESS_THAN, false, 10, filesize::SIZE_UNIT_KILOBYTE], [filesize::LESS_THAN, false, 1.7, filesize::SIZE_UNIT_MEGABYTE], [filesize::LESS_THAN, true, 2.3, filesize::SIZE_UNIT_MEGABYTE], [filesize::LESS_THAN, true, 10, filesize::SIZE_UNIT_GIGABYTE], [filesize::GREATER_THAN, true, 10, filesize::SIZE_UNIT_BYTE], [filesize::GREATER_THAN, true, 10, filesize::SIZE_UNIT_KILOBYTE], [filesize::GREATER_THAN, true, 1.7, filesize::SIZE_UNIT_MEGABYTE], [filesize::GREATER_THAN, false, 2.3, filesize::SIZE_UNIT_MEGABYTE], [filesize::GREATER_THAN, false, 10, filesize::SIZE_UNIT_GIGABYTE], ]; } /** * Test getting filter SQL * * @param int $operator * @param bool $expected * @param float $value * @param int $unit * * @dataProvider get_sql_filter_provider */ public function test_get_sql_filter( int $operator, bool $expected, float $value = 1, int $unit = filesize::SIZE_UNIT_BYTE, ): void { global $DB, $USER; $this->resetAfterTest(); $this->setAdminUser(); // Create a sample 2MB file. $file = get_file_storage()->create_file_from_string([ 'contextid' => user::instance($USER->id)->id, 'userid' => $USER->id, 'component' => 'user', 'filearea' => 'draft', 'itemid' => file_get_unused_draft_itemid(), 'filepath' => '/', 'filename' => 'Hello.txt', ], str_repeat('A', 2 * filesize::SIZE_UNIT_MEGABYTE)); $filter = new filter( filesize::class, 'test', new lang_string('yes'), 'testentity', 'filesize' ); // Create instance of our filter, passing given values. [$select, $params] = filesize::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, $filter->get_unique_identifier() . '_value1' => $value, $filter->get_unique_identifier() . '_unit' => $unit, ]); $fileids = $DB->get_fieldset_select('files', 'id', $select, $params); if ($expected) { $this->assertContains((string) $file->get_id(), $fileids); } else { $this->assertNotContains((string) $file->get_id(), $fileids); } } } PK a<�\J�* * ! tests/local/filters/user_test.phpnu �[��� <?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\local\filters; use advanced_testcase; use lang_string; use core_reportbuilder\local\report\filter; /** * Unit tests for user report filter * * @package core_reportbuilder * @covers \core_reportbuilder\local\filters\base * @covers \core_reportbuilder\local\filters\user * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ final class user_test extends advanced_testcase { /** * Data provider for {@see test_get_sql_filter} * * @return array */ public static function get_sql_filter_simple(): array { return [ [user::USER_ANY, ['admin', 'guest', 'user01', 'user02']], [user::USER_CURRENT, ['user01']], ]; } /** * Test getting filter SQL * * @param int $operator * @param string[] $expectedusernames * * @dataProvider get_sql_filter_simple */ public function test_get_sql_filter(int $operator, array $expectedusernames): void { global $DB; $this->resetAfterTest(); $user01 = $this->getDataGenerator()->create_user(['username' => 'user01']); $user02 = $this->getDataGenerator()->create_user(['username' => 'user02']); $this->setUser($user01); $filter = new filter( user::class, 'test', new lang_string('yes'), 'testentity', 'id' ); // Create instance of our filter, passing given operator. [$select, $params] = user::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => $operator, ]); $usernames = $DB->get_fieldset_select('user', 'username', $select, $params); $this->assertEqualsCanonicalizing($expectedusernames, $usernames); } /** * Test getting filter SQL using specific user selection operator/value */ public function test_get_sql_filter_select_user(): void { global $DB; $this->resetAfterTest(); $user01 = $this->getDataGenerator()->create_user(['username' => 'user01']); $user02 = $this->getDataGenerator()->create_user(['username' => 'user02']); $filter = new filter( user::class, 'test', new lang_string('yes'), 'testentity', 'id' ); // Create instance of our filter, passing given operator/value matching second user. [$select, $params] = user::create($filter)->get_sql_filter([ $filter->get_unique_identifier() . '_operator' => user::USER_SELECT, $filter->get_unique_identifier() . '_value' => [$user02->id], ]); $usernames = $DB->get_fieldset_select('user', 'username', $select, $params); $this->assertEquals([$user02->username], $usernames); } } PK a<�\���& & amd/src/reports_list.jsnu �[��� // 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/>. /** * Report builder reports list management * * @module core_reportbuilder/reports_list * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import {dispatchEvent} from 'core/event_dispatcher'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {prefetchStrings} from 'core/prefetch'; import {getString} from 'core/str'; import {add as addToast} from 'core/toast'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {deleteReport} from 'core_reportbuilder/local/repository/reports'; import {createReportModal} from 'core_reportbuilder/local/repository/modals'; /** * Initialise module */ export const init = () => { prefetchStrings('core_reportbuilder', [ 'deletereport', 'deletereportconfirm', 'editreportdetails', 'newreport', 'reportdeleted', 'reportupdated', ]); prefetchStrings('core', [ 'delete', ]); document.addEventListener('click', event => { const reportCreate = event.target.closest(reportSelectors.actions.reportCreate); if (reportCreate) { event.preventDefault(); // Redirect user to editing interface for the report after submission. const reportModal = createReportModal(event.target, getString('newreport', 'core_reportbuilder')); reportModal.addEventListener(reportModal.events.FORM_SUBMITTED, event => { window.location.href = event.detail; }); reportModal.show(); } const reportEdit = event.target.closest(reportSelectors.actions.reportEdit); if (reportEdit) { event.preventDefault(); // Reload current report page after submission. // Use triggerElement to return focus to the action menu toggle. const triggerElement = reportEdit.closest('.dropdown').querySelector('.dropdown-toggle'); const reportModal = createReportModal(triggerElement, getString('editreportdetails', 'core_reportbuilder'), reportEdit.dataset.reportId); reportModal.addEventListener(reportModal.events.FORM_SUBMITTED, () => { const reportElement = event.target.closest(reportSelectors.regions.report); getString('reportupdated', 'core_reportbuilder') .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement); return; }) .catch(Notification.exception); }); reportModal.show(); } const reportDelete = event.target.closest(reportSelectors.actions.reportDelete); if (reportDelete) { event.preventDefault(); // Use triggerElement to return focus to the action menu toggle. const triggerElement = reportDelete.closest('.dropdown').querySelector('.dropdown-toggle'); Notification.saveCancelPromise( getString('deletereport', 'core_reportbuilder'), getString('deletereportconfirm', 'core_reportbuilder', reportDelete.dataset.reportName), getString('delete', 'core'), {triggerElement} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/reports:delete'); const reportElement = event.target.closest(reportSelectors.regions.report); return deleteReport(reportDelete.dataset.reportId) .then(() => addToast(getString('reportdeleted', 'core_reportbuilder'))) .then(() => { dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); }).catch(() => { return; }); } }); }; PK a<�\�g4�� � amd/src/editor.jsnu �[��� // 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/>. /** * Report builder editor * * @module core_reportbuilder/editor * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import $ from 'jquery'; import 'core/inplace_editable'; import {addIconToContainer} from 'core/loadingicon'; import Notification from 'core/notification'; import Pending from 'core/pending'; import Templates from 'core/templates'; import {getString} from 'core/str'; import {add as addToast} from 'core/toast'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {init as columnsEditorInit} from 'core_reportbuilder/local/editor/columns'; import {init as conditionsEditorInit} from 'core_reportbuilder/local/editor/conditions'; import {init as filtersEditorInit} from 'core_reportbuilder/local/editor/filters'; import {init as sortingEditorInit} from 'core_reportbuilder/local/editor/sorting'; import {init as cardviewEditorInit} from 'core_reportbuilder/local/editor/card_view'; import {getReport} from 'core_reportbuilder/local/repository/reports'; import {createReportModal} from 'core_reportbuilder/local/repository/modals'; let initialized = false; /** * Initialise editor and all it's modules */ export const init = () => { columnsEditorInit(initialized); conditionsEditorInit(initialized); filtersEditorInit(initialized); sortingEditorInit(initialized); cardviewEditorInit(initialized); // Ensure we only add our listeners once (can be called multiple times by mustache template). if (initialized) { return; } // Add event handlers to generic report editor elements. document.addEventListener('click', event => { // Toggle between edit and preview mode. const toggleEditViewMode = event.target.closest(reportSelectors.actions.toggleEditPreview); if (toggleEditViewMode) { event.preventDefault(); const reportElement = event.target.closest(reportSelectors.regions.report); const pendingPromise = new Pending('core_reportbuilder/reports:get'); const toggledEditMode = toggleEditViewMode.dataset.editMode !== "1"; addIconToContainer(toggleEditViewMode) .then(() => getReport(reportElement.dataset.reportId, toggledEditMode)) .then(response => Promise.all([ $.parseHTML(response.javascript, null, true).map(node => node.innerHTML).join("\n"), Templates.renderForPromise('core_reportbuilder/local/dynamictabs/editor', response), ])) .then(([responseJs, {html, js}]) => Templates.replaceNode(reportElement, html, js + responseJs)) .then(() => pendingPromise.resolve()) .catch(Notification.exception); } // Edit report details modal. const reportEdit = event.target.closest(reportSelectors.actions.reportEdit); if (reportEdit) { event.preventDefault(); const reportModal = createReportModal(event.target, getString('editreportdetails', 'core_reportbuilder'), reportEdit.dataset.reportId); reportModal.addEventListener(reportModal.events.FORM_SUBMITTED, () => { getString('reportupdated', 'core_reportbuilder') .then(addToast) .then(() => { return window.location.reload(); }) .catch(Notification.exception); }); reportModal.show(); } }); initialized = true; }; PK a<�\�� (E' E' amd/src/audience.jsnu �[��� // 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/>. /** * Report builder audiences * * @module core_reportbuilder/audience * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import 'core/inplace_editable'; import Templates from 'core/templates'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {prefetchStrings} from 'core/prefetch'; import {getString} from 'core/str'; import DynamicForm from 'core_form/dynamicform'; import {add as addToast} from 'core/toast'; import {deleteAudience} from 'core_reportbuilder/local/repository/audiences'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {loadFragment} from 'core/fragment'; import {markFormAsDirty} from 'core_form/changechecker'; let reportId = 0; let contextId = 0; /** * Add audience card * * @param {String} className * @param {String} title */ const addAudienceCard = (className, title) => { const pendingPromise = new Pending('core_reportbuilder/audience:add'); const audiencesContainer = document.querySelector(reportSelectors.regions.audiencesContainer); const audienceCardLength = audiencesContainer.querySelectorAll(reportSelectors.regions.audienceCard).length; const params = { classname: className, reportid: reportId, showormessage: (audienceCardLength > 0), title: title, }; // Load audience card fragment, render and then initialise the form within. loadFragment('core_reportbuilder', 'audience_form', contextId, params) .then((html, js) => { const audienceCard = Templates.appendNodeContents(audiencesContainer, html, js)[0]; const audienceEmptyMessage = audiencesContainer.querySelector(reportSelectors.regions.audienceEmptyMessage); const audienceForm = initAudienceCardForm(audienceCard); // Mark as dirty new audience form created to prevent users leaving the page without saving it. markFormAsDirty(audienceForm.getFormNode()); audienceEmptyMessage.classList.add('hidden'); return getString('audienceadded', 'core_reportbuilder', title); }) .then(addToast) .then(() => pendingPromise.resolve()) .catch(Notification.exception); }; /** * Edit audience card * * @param {Element} audienceCard */ const editAudienceCard = audienceCard => { const pendingPromise = new Pending('core_reportbuilder/audience:edit'); // Load audience form with data for editing, then toggle visible controls in the card. const audienceForm = initAudienceCardForm(audienceCard); audienceForm.load({id: audienceCard.dataset.audienceId}) .then(() => { const audienceFormContainer = audienceCard.querySelector(reportSelectors.regions.audienceFormContainer); const audienceDescription = audienceCard.querySelector(reportSelectors.regions.audienceDescription); const audienceEdit = audienceCard.querySelector(reportSelectors.actions.audienceEdit); audienceFormContainer.classList.remove('hidden'); audienceDescription.classList.add('hidden'); audienceEdit.disabled = true; return pendingPromise.resolve(); }) .catch(Notification.exception); }; /** * Initialise dynamic form within given audience card * * @param {Element} audienceCard * @return {DynamicForm} */ const initAudienceCardForm = audienceCard => { const audienceFormContainer = audienceCard.querySelector(reportSelectors.regions.audienceFormContainer); const audienceForm = new DynamicForm(audienceFormContainer, '\\core_reportbuilder\\form\\audience'); // After submitting the form, update the card instance and description properties. audienceForm.addEventListener(audienceForm.events.FORM_SUBMITTED, data => { const audienceHeading = audienceCard.querySelector(reportSelectors.regions.audienceHeading); const audienceDescription = audienceCard.querySelector(reportSelectors.regions.audienceDescription); audienceCard.dataset.audienceId = data.detail.instanceid; audienceHeading.innerHTML = data.detail.heading; audienceDescription.innerHTML = data.detail.description; closeAudienceCardForm(audienceCard); return getString('audiencesaved', 'core_reportbuilder') .then(addToast); }); // If cancelling the form, close the card or remove it if it was never created. audienceForm.addEventListener(audienceForm.events.FORM_CANCELLED, () => { if (audienceCard.dataset.audienceId > 0) { closeAudienceCardForm(audienceCard); } else { removeAudienceCard(audienceCard); } }); return audienceForm; }; /** * Delete audience card * * @param {Element} audienceDelete */ const deleteAudienceCard = audienceDelete => { const audienceCard = audienceDelete.closest(reportSelectors.regions.audienceCard); const {audienceId, audienceTitle, audienceEditWarning = false} = audienceCard.dataset; // The edit warning indicates the audience is in use in a report schedule. const audienceDeleteConfirmation = audienceEditWarning ? 'audienceusedbyschedule' : 'deleteaudienceconfirm'; Notification.saveCancelPromise( getString('deleteaudience', 'core_reportbuilder', audienceTitle), getString(audienceDeleteConfirmation, 'core_reportbuilder', audienceTitle), getString('delete', 'core'), {triggerElement: audienceDelete} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/audience:delete'); return deleteAudience(reportId, audienceId) .then(() => addToast(getString('audiencedeleted', 'core_reportbuilder', audienceTitle))) .then(() => { removeAudienceCard(audienceCard); return pendingPromise.resolve(); }) .catch(Notification.exception); }).catch(() => { return; }); }; /** * Close audience card form * * @param {Element} audienceCard */ const closeAudienceCardForm = audienceCard => { // Remove the [data-region="audience-form-container"] (with all the event listeners attached to it), and create it again. const audienceFormContainer = audienceCard.querySelector(reportSelectors.regions.audienceFormContainer); const NewAudienceFormContainer = audienceFormContainer.cloneNode(false); audienceCard.querySelector(reportSelectors.regions.audienceForm).replaceChild(NewAudienceFormContainer, audienceFormContainer); // Show the description container and enable the action buttons. audienceCard.querySelector(reportSelectors.regions.audienceDescription).classList.remove('hidden'); audienceCard.querySelector(reportSelectors.actions.audienceEdit).disabled = false; audienceCard.querySelector(reportSelectors.actions.audienceDelete).disabled = false; }; /** * Remove audience card * * @param {Element} audienceCard */ const removeAudienceCard = audienceCard => { audienceCard.remove(); const audiencesContainer = document.querySelector(reportSelectors.regions.audiencesContainer); const audienceCards = audiencesContainer.querySelectorAll(reportSelectors.regions.audienceCard); // Show message if there are no cards remaining, ensure first card's separator is not present. if (audienceCards.length === 0) { const audienceEmptyMessage = document.querySelector(reportSelectors.regions.audienceEmptyMessage); audienceEmptyMessage.classList.remove('hidden'); } else { const audienceFirstCardSeparator = audienceCards[0].querySelector('.audience-separator'); audienceFirstCardSeparator?.remove(); } }; let initialized = false; /** * Initialise audiences tab. * * @param {Number} id * @param {Number} contextid */ export const init = (id, contextid) => { prefetchStrings('core_reportbuilder', [ 'audienceadded', 'audiencedeleted', 'audiencesaved', 'audienceusedbyschedule', 'deleteaudience', 'deleteaudienceconfirm', ]); prefetchStrings('core', [ 'delete', ]); reportId = id; contextId = contextid; if (initialized) { // We already added the event listeners (can be called multiple times by mustache template). return; } document.addEventListener('click', event => { // Add instance. const audienceAdd = event.target.closest(reportSelectors.actions.audienceAdd); if (audienceAdd) { event.preventDefault(); addAudienceCard(audienceAdd.dataset.uniqueIdentifier, audienceAdd.dataset.name); } // Edit instance. const audienceEdit = event.target.closest(reportSelectors.actions.audienceEdit); if (audienceEdit) { const audienceEditCard = audienceEdit.closest(reportSelectors.regions.audienceCard); event.preventDefault(); editAudienceCard(audienceEditCard); } // Delete instance. const audienceDelete = event.target.closest(reportSelectors.actions.audienceDelete); if (audienceDelete) { event.preventDefault(); deleteAudienceCard(audienceDelete); } }); initialized = true; }; PK a<�\cqW� � amd/src/sidebar.jsnu �[��� // 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/>. /** * Report builder sidebar component * * @module core_reportbuilder/sidebar * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Pending from 'core/pending'; import {debounce} from 'core/utils'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; const DEBOUNCE_TIMER = 250; const CLASSES = { EXPANDED: 'show', COLLAPSED: 'collapsed', HIDE: 'd-none', }; /** * Initialise module * * @param {Event} event * @param {Element} sidebarMenu */ const sidebarCardFilter = (event, sidebarMenu) => { const pendingPromise = new Pending('core_reportbuilder/sidebar:cardFilter'); const sidebarCards = sidebarMenu.querySelectorAll(reportSelectors.regions.sidebarCard); const sidebarItems = sidebarMenu.querySelectorAll(reportSelectors.regions.sidebarItem); const searchTerm = event.target.value.toLowerCase(); // Toggle items according to match against search term. sidebarItems.forEach(item => { const itemContent = item.textContent.toLowerCase(); item.classList.toggle(CLASSES.HIDE, !itemContent.includes(searchTerm)); }); // Toggle cards according to whether they have any visible items. sidebarCards.forEach(card => { const visibleItems = card.querySelectorAll(`${reportSelectors.regions.sidebarItem}:not(.${CLASSES.HIDE})`); card.classList.toggle(CLASSES.HIDE, !visibleItems.length); expandCard(card); }); pendingPromise.resolve(); }; /** * Show a collapsed card. * This function simulates the behaviour of JQuery show method on a collapsible element. * * @param {Element} card */ const expandCard = (card) => { let cardButton = card.querySelector('[data-toggle="collapse"]'); if (cardButton.classList.contains(CLASSES.COLLAPSED)) { cardButton.classList.remove(CLASSES.COLLAPSED); cardButton.setAttribute('aria-expanded', "true"); let cardContent = card.querySelector(cardButton.dataset.target); cardContent.classList.add(CLASSES.EXPANDED); } }; /** * Initialise module * * @param {string} selectorId */ export const init = (selectorId) => { const sidebarMenu = document.querySelector(selectorId + reportSelectors.regions.sidebarMenu); const sidebarSearch = sidebarMenu.querySelector(reportSelectors.actions.sidebarSearch); // Debounce the event listener to allow the user to finish typing. const sidebarSearchDebounce = debounce(sidebarCardFilter, DEBOUNCE_TIMER); sidebarSearch.addEventListener('keyup', event => { const pendingPromise = new Pending('core_reportbuilder/sidebar:keyup'); sidebarSearchDebounce(event, sidebarMenu); setTimeout(() => { pendingPromise.resolve(); }, DEBOUNCE_TIMER); }); }; PK a<�\��q� � amd/src/filters.jsnu �[��� // 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/>. /** * Report builder filter management * * @module core_reportbuilder/filters * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import {dispatchEvent} from 'core/event_dispatcher'; import {loadFragment} from 'core/fragment'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {getString} from 'core/str'; import Templates from 'core/templates'; import {add as addToast} from 'core/toast'; import DynamicForm from 'core_form/dynamicform'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {resetFilters} from 'core_reportbuilder/local/repository/filters'; /** * Update filter button text to indicate applied filter count * * @param {Element} reportElement * @param {Number} filterCount */ const setFilterButtonCount = async(reportElement, filterCount) => { const filterButtonLabel = reportElement.querySelector(reportSelectors.regions.filterButtonLabel); if (filterCount > 0) { filterButtonLabel.textContent = await getString('filtersappliedx', 'core_reportbuilder', filterCount); } else { filterButtonLabel.textContent = await getString('filters', 'moodle'); } }; /** * Initialise module for given report * * @method * @param {String} reportElementId * @param {Number} contextId */ export const init = (reportElementId, contextId) => { const reportElement = document.getElementById(reportElementId); const filterFormContainer = reportElement.querySelector(reportSelectors.regions.filtersForm); // Ensure we only add our listeners once (can be called multiple times by mustache template). if (filterFormContainer.dataset.initialized) { return; } filterFormContainer.dataset.initialized = true; const filterForm = new DynamicForm(filterFormContainer, '\\core_reportbuilder\\form\\filter'); // Submit report filters. filterForm.addEventListener(filterForm.events.FORM_SUBMITTED, event => { event.preventDefault(); // After the form has been submitted, we should trigger report table reload. dispatchEvent(reportEvents.tableReload, {}, reportElement); setFilterButtonCount(reportElement, event.detail); getString('filtersapplied', 'core_reportbuilder') .then(addToast) .catch(Notification.exception); }); // Reset report filters. filterForm.addEventListener(filterForm.events.NOSUBMIT_BUTTON_PRESSED, event => { event.preventDefault(); const pendingPromise = new Pending('core_reportbuilder/filters:reset'); const {reportId, reportParameters} = reportElement.dataset; resetFilters(reportId, reportParameters) .then(() => getString('filtersreset', 'core_reportbuilder')) .then(addToast) .then(() => loadFragment('core_reportbuilder', 'filters_form', contextId, { reportid: reportId, parameters: reportParameters, })) .then((html, js) => { Templates.replaceNodeContents(filterFormContainer, html, js); dispatchEvent(reportEvents.tableReload, {}, reportElement); setFilterButtonCount(reportElement, 0); return pendingPromise.resolve(); }) .catch(Notification.exception); }); // Modify "region-main" overflow for big filter forms. document.querySelector('#region-main').style.overflowX = "visible"; }; PK a<�\�w_f� � amd/src/schedules.jsnu �[��� // 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/>. /** * Report builder audiences * * @module core_reportbuilder/schedules * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import {dispatchEvent} from 'core/event_dispatcher'; import 'core/inplace_editable'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {prefetchStrings} from 'core/prefetch'; import {getString} from 'core/str'; import {add as addToast} from 'core/toast'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {createScheduleModal} from 'core_reportbuilder/local/repository/modals'; import {deleteSchedule, sendSchedule, toggleSchedule} from 'core_reportbuilder/local/repository/schedules'; let initialized = false; /** * Initialise schedules tab * * @param {Number} reportId */ export const init = reportId => { prefetchStrings('core_reportbuilder', [ 'deleteschedule', 'deletescheduleconfirm', 'disableschedule', 'editscheduledetails', 'enableschedule', 'newschedule', 'schedulecreated', 'scheduledeleted', 'schedulesent', 'scheduleupdated', 'sendschedule', 'sendscheduleconfirm', ]); prefetchStrings('core', [ 'confirm', 'delete', ]); if (initialized) { // We already added the event listeners (can be called multiple times by mustache template). return; } document.addEventListener('click', event => { // Create schedule. const scheduleCreate = event.target.closest(reportSelectors.actions.scheduleCreate); if (scheduleCreate) { event.preventDefault(); const scheduleModal = createScheduleModal(event.target, getString('newschedule', 'core_reportbuilder'), reportId); scheduleModal.addEventListener(scheduleModal.events.FORM_SUBMITTED, () => { getString('schedulecreated', 'core_reportbuilder') .then(addToast) .then(() => { const reportElement = document.querySelector(reportSelectors.regions.report); dispatchEvent(reportEvents.tableReload, {}, reportElement); return; }) .catch(Notification.exception); }); scheduleModal.show(); } // Toggle schedule. const scheduleToggle = event.target.closest(reportSelectors.actions.scheduleToggle); if (scheduleToggle) { const pendingPromise = new Pending('core_reportbuilder/schedules:toggle'); const scheduleStateToggle = +!Number(scheduleToggle.dataset.state); toggleSchedule(reportId, scheduleToggle.dataset.id, scheduleStateToggle) .then(() => { const tableRow = scheduleToggle.closest('tr'); tableRow.classList.toggle('text-muted'); scheduleToggle.dataset.state = scheduleStateToggle; const stringKey = scheduleStateToggle ? 'disableschedule' : 'enableschedule'; return getString(stringKey, 'core_reportbuilder'); }) .then(toggleLabel => { const labelContainer = scheduleToggle.parentElement.querySelector(`label[for="${scheduleToggle.id}"] > span`); labelContainer.innerHTML = toggleLabel; return pendingPromise.resolve(); }) .catch(Notification.exception); } // Edit schedule. const scheduleEdit = event.target.closest(reportSelectors.actions.scheduleEdit); if (scheduleEdit) { event.preventDefault(); // Use triggerElement to return focus to the action menu toggle. const triggerElement = scheduleEdit.closest('.dropdown').querySelector('.dropdown-toggle'); const scheduleModal = createScheduleModal(triggerElement, getString('editscheduledetails', 'core_reportbuilder'), reportId, scheduleEdit.dataset.scheduleId); scheduleModal.addEventListener(scheduleModal.events.FORM_SUBMITTED, () => { getString('scheduleupdated', 'core_reportbuilder') .then(addToast) .then(() => { const reportElement = scheduleEdit.closest(reportSelectors.regions.report); dispatchEvent(reportEvents.tableReload, {}, reportElement); return; }) .catch(Notification.exception); }); scheduleModal.show(); } // Send schedule. const scheduleSend = event.target.closest(reportSelectors.actions.scheduleSend); if (scheduleSend) { event.preventDefault(); // Use triggerElement to return focus to the action menu toggle. const triggerElement = scheduleSend.closest('.dropdown').querySelector('.dropdown-toggle'); Notification.saveCancelPromise( getString('sendschedule', 'core_reportbuilder'), getString('sendscheduleconfirm', 'core_reportbuilder', scheduleSend.dataset.scheduleName), getString('confirm', 'core'), {triggerElement} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/schedules:send'); return sendSchedule(reportId, scheduleSend.dataset.scheduleId) .then(addToast(getString('schedulesent', 'core_reportbuilder'))) .then(() => pendingPromise.resolve()) .catch(Notification.exception); }).catch(() => { return; }); } // Delete schedule. const scheduleDelete = event.target.closest(reportSelectors.actions.scheduleDelete); if (scheduleDelete) { event.preventDefault(); // Use triggerElement to return focus to the action menu toggle. const triggerElement = scheduleDelete.closest('.dropdown').querySelector('.dropdown-toggle'); Notification.saveCancelPromise( getString('deleteschedule', 'core_reportbuilder'), getString('deletescheduleconfirm', 'core_reportbuilder', scheduleDelete.dataset.scheduleName), getString('delete', 'core'), {triggerElement} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/schedules:delete'); return deleteSchedule(reportId, scheduleDelete.dataset.scheduleId) .then(addToast(getString('scheduledeleted', 'core_reportbuilder'))) .then(() => { const reportElement = scheduleDelete.closest(reportSelectors.regions.report); dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); }).catch(() => { return; }); } }); initialized = true; }; PK a<�\��O�� � # amd/src/local/repository/sorting.jsnu �[��� // 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/>. /** * Module to handle column sorting AJAX requests * * @module core_reportbuilder/local/repository/sorting * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Retrieve column sorting * * @param {Number} reportId * @return {Promise} */ export const getColumnSorting = reportId => { const request = { methodname: 'core_reportbuilder_columns_sort_get', args: {reportid: reportId} }; return Ajax.call([request])[0]; }; /** * Re-order sort column position * * @param {Number} reportId * @param {Number} columnId * @param {Number} position * @return {Promise} */ export const reorderColumnSorting = (reportId, columnId, position) => { const request = { methodname: 'core_reportbuilder_columns_sort_reorder', args: {reportid: reportId, columnid: columnId, position: position} }; return Ajax.call([request])[0]; }; /** * Enables/disabled sorting on column * * @param {Number} reportId * @param {Number} columnId * @param {Boolean} enabled * @param {Number} direction * @return {Promise} */ export const toggleColumnSorting = (reportId, columnId, enabled, direction) => { const request = { methodname: 'core_reportbuilder_columns_sort_toggle', args: {reportid: reportId, columnid: columnId, enabled: enabled, direction: direction} }; return Ajax.call([request])[0]; }; PK a<�\�xs�8 8 % amd/src/local/repository/audiences.jsnu �[��� // 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/>. /** * Module to handle audiences AJAX requests * * @module core_reportbuilder/local/repository/audiences * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Remove audience from given report * * @param {Number} reportId * @param {Number} instanceId * @return {Promise} */ export const deleteAudience = (reportId, instanceId) => { const request = { methodname: 'core_reportbuilder_audiences_delete', args: {reportid: reportId, instanceid: instanceId} }; return Ajax.call([request])[0]; }; PK a<�\��PZ& & " amd/src/local/repository/modals.jsnu �[��� // 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/>. /** * Module to handle modal form requests * * @module core_reportbuilder/local/repository/modals * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import ModalForm from 'core_form/modalform'; import {getString} from 'core/str'; /** * Return modal instance * * @param {EventTarget} triggerElement * @param {Promise} modalTitle * @param {String} formClass * @param {Object} formArgs * @return {ModalForm} */ const createModalForm = (triggerElement, modalTitle, formClass, formArgs) => { return new ModalForm({ modalConfig: { title: modalTitle, }, formClass: formClass, args: formArgs, saveButtonText: getString('save', 'moodle'), returnFocus: triggerElement, }); }; /** * Return report modal instance * * @param {EventTarget} triggerElement * @param {Promise} modalTitle * @param {Number} reportId * @return {ModalForm} */ export const createReportModal = (triggerElement, modalTitle, reportId = 0) => { return createModalForm(triggerElement, modalTitle, 'core_reportbuilder\\form\\report', { id: reportId, }); }; /** * Return schedule modal instance * * @param {EventTarget} triggerElement * @param {Promise} modalTitle * @param {Number} reportId * @param {Number} scheduleId * @return {ModalForm} */ export const createScheduleModal = (triggerElement, modalTitle, reportId, scheduleId = 0) => { return createModalForm(triggerElement, modalTitle, 'core_reportbuilder\\form\\schedule', { reportid: reportId, id: scheduleId, }); }; PK a<�\��:�� � # amd/src/local/repository/filters.jsnu �[��� // 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/>. /** * Module to handle filter AJAX requests * * @module core_reportbuilder/local/repository/filters * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Reset all filters for given report * * @method * @param {Number} reportId * @param {String} reportParameters * @return {Promise} */ export const resetFilters = (reportId, reportParameters) => { const request = { methodname: 'core_reportbuilder_filters_reset', args: {reportid: reportId, parameters: reportParameters} }; return Ajax.call([request])[0]; }; /** * Set filter values for given report * * @method * @param {Number} reportId * @param {String} reportParameters * @param {String} filterValues * @return {Promise} */ export const setFilters = (reportId, reportParameters, filterValues) => { const request = { methodname: 'core_reportbuilder_set_filters', args: {reportid: reportId, parameters: reportParameters, values: filterValues} }; return Ajax.call([request])[0]; }; /** * Add a filter to the given report * * @param {Number} reportId * @param {String} uniqueIdentifier * @return {Promise} */ export const addFilter = (reportId, uniqueIdentifier) => { const request = { methodname: 'core_reportbuilder_filters_add', args: {reportid: reportId, uniqueidentifier: uniqueIdentifier} }; return Ajax.call([request])[0]; }; /** * Remove filter from given report * * @param {Number} reportId * @param {Number} filterId * @return {Promise} */ export const deleteFilter = (reportId, filterId) => { const request = { methodname: 'core_reportbuilder_filters_delete', args: {reportid: reportId, filterid: filterId} }; return Ajax.call([request])[0]; }; /** * Reorder a filter in a given report * * @param {Number} reportId * @param {Number} filterId * @param {Number} position * @return {Promise} */ export const reorderFilter = (reportId, filterId, position) => { const request = { methodname: 'core_reportbuilder_filters_reorder', args: {reportid: reportId, filterid: filterId, position: position} }; return Ajax.call([request])[0]; }; PK a<�\j�TW W % amd/src/local/repository/schedules.jsnu �[��� // 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/>. /** * Module to handle schedule AJAX requests * * @module core_reportbuilder/local/repository/schedules * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Delete schedule * * @method * @param {Number} reportId * @param {Number} scheduleId * @return {Promise} */ export const deleteSchedule = (reportId, scheduleId) => { const request = { methodname: 'core_reportbuilder_schedules_delete', args: {reportid: reportId, scheduleid: scheduleId} }; return Ajax.call([request])[0]; }; /** * Send schedule * * @method * @param {Number} reportId * @param {Number} scheduleId * @return {Promise} */ export const sendSchedule = (reportId, scheduleId) => { const request = { methodname: 'core_reportbuilder_schedules_send', args: {reportid: reportId, scheduleid: scheduleId} }; return Ajax.call([request])[0]; }; /** * Toggle schedule enabled * * @method * @param {Number} reportId * @param {Number} scheduleId * @param {Boolean} scheduleEnabled * @return {Promise} */ export const toggleSchedule = (reportId, scheduleId, scheduleEnabled) => { const request = { methodname: 'core_reportbuilder_schedules_toggle', args: {reportid: reportId, scheduleid: scheduleId, enabled: scheduleEnabled} }; return Ajax.call([request])[0]; }; PK a<�\D��fn n # amd/src/local/repository/reports.jsnu �[��� // 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/>. /** * Module to handle report AJAX requests * * @module core_reportbuilder/local/repository/reports * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Delete given report * * @param {Number} reportId * @return {Promise} */ export const deleteReport = reportId => { const request = { methodname: 'core_reportbuilder_reports_delete', args: {reportid: reportId} }; return Ajax.call([request])[0]; }; /** * Get report content * * @param {Number} reportId * @param {Boolean} editMode * @param {Number} [pageSize=0] * @return {Promise} */ export const getReport = (reportId, editMode, pageSize = 0) => { const request = { methodname: 'core_reportbuilder_reports_get', args: {reportid: reportId, editmode: editMode, pagesize: pageSize} }; return Ajax.call([request])[0]; }; PK a<�\��5�� � & amd/src/local/repository/conditions.jsnu �[��� // 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/>. /** * Module to handle condition AJAX requests * * @module core_reportbuilder/local/repository/conditions * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Reset all conditions for given report * * @param {Number} reportId * @return {Promise} */ export const resetConditions = reportId => { const request = { methodname: 'core_reportbuilder_conditions_reset', args: {reportid: reportId} }; return Ajax.call([request])[0]; }; /** * Add condition to given report * * @param {Number} reportId * @param {String} uniqueIdentifier * @return {Promise} */ export const addCondition = (reportId, uniqueIdentifier) => { const request = { methodname: 'core_reportbuilder_conditions_add', args: {reportid: reportId, uniqueidentifier: uniqueIdentifier} }; return Ajax.call([request])[0]; }; /** * Remove condition from given report * * @param {Number} reportId * @param {Number} conditionId * @return {Promise} */ export const deleteCondition = (reportId, conditionId) => { const request = { methodname: 'core_reportbuilder_conditions_delete', args: {reportid: reportId, conditionid: conditionId} }; return Ajax.call([request])[0]; }; /** * Reorder a condition in a given report * * @param {Number} reportId * @param {Number} conditionId * @param {Number} position * @return {Promise} */ export const reorderCondition = (reportId, conditionId, position) => { const request = { methodname: 'core_reportbuilder_conditions_reorder', args: {reportid: reportId, conditionid: conditionId, position: position} }; return Ajax.call([request])[0]; }; PK a<�\G�N�> > # amd/src/local/repository/columns.jsnu �[��� // 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/>. /** * Module to handle column AJAX requests * * @module core_reportbuilder/local/repository/columns * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Ajax from 'core/ajax'; /** * Add column to given report * * @param {Number} reportId * @param {String} uniqueIdentifier * @return {Promise} */ export const addColumn = (reportId, uniqueIdentifier) => { const request = { methodname: 'core_reportbuilder_columns_add', args: {reportid: reportId, uniqueidentifier: uniqueIdentifier} }; return Ajax.call([request])[0]; }; /** * Remove column from given report * * @param {Number} reportId * @param {Number} columnId * @return {Promise} */ export const deleteColumn = (reportId, columnId) => { const request = { methodname: 'core_reportbuilder_columns_delete', args: {reportid: reportId, columnid: columnId} }; return Ajax.call([request])[0]; }; /** * Re-order column within a report * * @param {Number} reportId * @param {Number} columnId * @param {Number} position * @return {Promise} */ export const reorderColumn = (reportId, columnId, position) => { const request = { methodname: 'core_reportbuilder_columns_reorder', args: {reportid: reportId, columnid: columnId, position: position} }; return Ajax.call([request])[0]; }; PK a<�\�5�TJ J amd/src/local/events.jsnu �[��� // 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/>. /** * Report builder events * * @module core_reportbuilder/local/events * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * Events for the Report builder subsystem * * @constant * @property {String} tableReload See {@link event:tableReload} */ export default { /** * Trigger table reloading * * @event tableReload * @type {CustomEvent} * @property {object} detail * @property {Boolean} detail.preservePagination Whether current pagination should be preserved (default false) * @property {String} detail.preserveTriggerElement Element selector that should be focused after table reload (default null) * * @example <caption>Triggering table reload</caption> * import {dispatchEvent} from 'core/event_dispatcher'; * import * as reportEvents from 'core_reportbuilder/local/events'; * * dispatchEvent(reportEvents.tableReload, {}, document.querySelector(...)); */ tableReload: 'core_reportbuilder_table_reload', publish: { reportColumnsUpdated: 'core_reportbuilder_report_columns_updated', }, }; PK a<�\}�� amd/src/local/selectors.jsnu �[��� // 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/>. /** * Report builder selectors * * @module core_reportbuilder/local/selectors * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ /** * Selectors for the Report builder subsystem * * @property {Object} regions * @property {String} regions.systemReport System report page region * @property {String} regions.filterButtonLabel Filters form toggle region * @property {String} regions.filtersForm Filters form page region */ const SELECTORS = { regions: { report: '[data-region="core_reportbuilder/report"]', reportTable: '[data-region="reportbuilder-table"]', columnHeader: '[data-region="column-header"]', filterButtonLabel: '[data-region="filter-button-label"]', filtersForm: '[data-region="filters-form"]', sidebarMenu: '[data-region="sidebar-menu"]', sidebarCard: '[data-region="sidebar-card"]', sidebarItem: '[data-region="sidebar-item"]', settingsConditions: '[data-region="settings-conditions"]', activeConditions: '[data-region="active-conditions"]', activeCondition: '[data-region="active-condition"]', settingsFilters: '[data-region="settings-filters"]', activeFilters: '[data-region="active-filters"]', activeFilter: '[data-region="active-filter"]', settingsSorting: '[data-region="settings-sorting"]', audiencesContainer: '[data-region="audiences"]', audienceFormContainer: '[data-region="audience-form-container"]', audienceCard: '[data-region="audience-card"]', audienceHeading: '[data-region="audience-heading"]', audienceForm: '[data-region="audience-form"]', audienceEmptyMessage: '[data-region=no-instances-message]', audienceDescription: '[data-region=audience-description]', audienceNotSavedLabel: '[data-region=audience-not-saved]', settingsCardView: '[data-region="settings-cardview"]', }, actions: { reportActionPopup: '[data-action="report-action-popup"]', reportCreate: '[data-action="report-create"]', reportEdit: '[data-action="report-edit"]', reportDelete: '[data-action="report-delete"]', reportAddColumn: '[data-action="report-add-column"]', reportRemoveColumn: '[data-action="report-remove-column"]', reportAddCondition: '[data-action="report-add-condition"]', reportRemoveCondition: '[data-action="report-remove-condition"]', reportAddFilter: '[data-action="report-add-filter"]', reportRemoveFilter: '[data-action="report-remove-filter"]', reportToggleColumnSort: '[data-action="report-toggle-column-sorting"]', reportToggleColumnSortDirection: '[data-action="report-toggle-sort-direction"]', sidebarSearch: '[data-action="sidebar-search"]', toggleEditPreview: '[data-action="toggle-edit-preview"]', audienceAdd: '[data-action="add-audience"]', audienceEdit: '[data-action="edit-audience"]', audienceDelete: '[data-action="delete-audience"]', toggleCardView: '[data-action="toggle-card"]', scheduleCreate: '[data-action="schedule-create"]', scheduleToggle: '[data-action="schedule-toggle"]', scheduleEdit: '[data-action="schedule-edit"]', scheduleSend: '[data-action="schedule-send"]', scheduleDelete: '[data-action="schedule-delete"]', }, }; /** * Selector for given report * * @method forReport * @param {Number} reportId * @return {String} */ SELECTORS.forReport = reportId => `${SELECTORS.regions.report}[data-report-id="${reportId}"]`; export default SELECTORS; PK a<�\[]� amd/src/local/editor/sorting.jsnu �[��� // 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/>. /** * Report builder columns sorting editor * * @module core_reportbuilder/local/editor/sorting * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import $ from 'jquery'; import 'core/inplace_editable'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {subscribe} from 'core/pubsub'; import SortableList from 'core/sortable_list'; import {getString} from 'core/str'; import {add as addToast} from 'core/toast'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {reorderColumnSorting, toggleColumnSorting} from 'core_reportbuilder/local/repository/sorting'; import Templates from 'core/templates'; import {dispatchEvent} from 'core/event_dispatcher'; import * as reportEvents from 'core_reportbuilder/local/events'; // These constants match PHP consts SORT_ASC, SORT_DESC. const SORTORDER = { ASCENDING: 4, DESCENDING: 3, }; /** * Reload sorting settings region * * @param {Object} context * @return {Promise} */ const reloadSettingsSortingRegion = context => { const pendingPromise = new Pending('core_reportbuilder/sorting:reload'); const settingsSortingRegion = document.querySelector(reportSelectors.regions.settingsSorting); return Templates.renderForPromise('core_reportbuilder/local/settings/sorting', {sorting: context}) .then(({html, js}) => { Templates.replaceNode(settingsSortingRegion, html, js); return pendingPromise.resolve(); }); }; /** * Updates column sorting * * @param {Element} reportElement * @param {Element} element * @param {Number} sortenabled * @param {Number} sortdirection * @return {Promise} */ const updateSorting = (reportElement, element, sortenabled, sortdirection) => { const reportId = reportElement.dataset.reportId; const listElement = element.closest('li'); const columnId = listElement.dataset.columnSortId; const columnName = listElement.dataset.columnSortName; return toggleColumnSorting(reportId, columnId, sortenabled, sortdirection) .then(reloadSettingsSortingRegion) .then(() => getString('columnsortupdated', 'core_reportbuilder', columnName)) .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {}, reportElement); return null; }); }; /** * Initialise module * * @param {Boolean} initialized Ensure we only add our listeners once */ export const init = (initialized) => { if (initialized) { return; } // Update sorting region each time report columns are updated (added or removed). subscribe(reportEvents.publish.reportColumnsUpdated, data => reloadSettingsSortingRegion(data) .catch(Notification.exception) ); document.addEventListener('click', event => { // Enable/disable sorting on columns. const toggleSorting = event.target.closest(reportSelectors.actions.reportToggleColumnSort); if (toggleSorting) { event.preventDefault(); const pendingPromise = new Pending('core_reportbuilder/sorting:toggle'); const reportElement = toggleSorting.closest(reportSelectors.regions.report); const sortdirection = parseInt(toggleSorting.closest('li').dataset.columnSortDirection); updateSorting(reportElement, toggleSorting, toggleSorting.checked, sortdirection) .then(() => { // Re-focus the toggle sorting element after reloading the region. const toggleSortingElement = document.getElementById(toggleSorting.id); toggleSortingElement?.focus(); return pendingPromise.resolve(); }) .catch(Notification.exception); } // Change column sort direction. const toggleSortDirection = event.target.closest(reportSelectors.actions.reportToggleColumnSortDirection); if (toggleSortDirection) { event.preventDefault(); const pendingPromise = new Pending('core_reportbuilder/sorting:direction'); const reportElement = toggleSortDirection.closest(reportSelectors.regions.report); const listElement = toggleSortDirection.closest('li'); const toggleSorting = listElement.querySelector(reportSelectors.actions.reportToggleColumnSort); let sortdirection = parseInt(listElement.dataset.columnSortDirection); if (sortdirection === SORTORDER.ASCENDING) { sortdirection = SORTORDER.DESCENDING; } else if (sortdirection === SORTORDER.DESCENDING) { sortdirection = SORTORDER.ASCENDING; } updateSorting(reportElement, toggleSortDirection, toggleSorting.checked, sortdirection) .then(() => { // Re-focus the toggle sort direction element after reloading the region. const toggleSortDirectionElement = document.getElementById(toggleSortDirection.id); toggleSortDirectionElement?.focus(); return pendingPromise.resolve(); }) .catch(Notification.exception); } }); // Initialize sortable list to handle column sorting moving (note JQuery dependency, see MDL-72293 for resolution). var columnsSortingSortableList = new SortableList(`${reportSelectors.regions.settingsSorting} ul`, {isHorizontal: false}); columnsSortingSortableList.getElementName = element => Promise.resolve(element.data('columnSortName')); $(document).on(SortableList.EVENTS.DROP, `${reportSelectors.regions.report} li[data-column-sort-id]`, (event, info) => { if (info.positionChanged) { const pendingPromise = new Pending('core_reportbuilder/sorting:reorder'); const reportElement = event.target.closest(reportSelectors.regions.report); const columnId = info.element.data('columnSortId'); const columnPosition = info.element.data('columnSortPosition'); // Select target position, if moving to the end then count number of element siblings. let targetColumnSortPosition = info.targetNextElement.data('columnSortPosition') || info.element.siblings().length + 2; if (targetColumnSortPosition > columnPosition) { targetColumnSortPosition--; } // Re-order column sorting, giving drop event transition time to finish. const reorderPromise = reorderColumnSorting(reportElement.dataset.reportId, columnId, targetColumnSortPosition); Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))]) .then(([data]) => reloadSettingsSortingRegion(data)) .then(() => getString('columnsortupdated', 'core_reportbuilder', info.element.data('columnSortName'))) .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); } }); }; PK a<�\���7 7 amd/src/local/editor/filters.jsnu �[��� // 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/>. /** * Report builder filters editor * * @module core_reportbuilder/local/editor/filters * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import $ from 'jquery'; import AutoComplete from 'core/form-autocomplete'; import 'core/inplace_editable'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {prefetchStrings} from 'core/prefetch'; import SortableList from 'core/sortable_list'; import {getString} from 'core/str'; import Templates from 'core/templates'; import {add as addToast} from 'core/toast'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {addFilter, deleteFilter, reorderFilter} from 'core_reportbuilder/local/repository/filters'; /** * Reload filters settings region * * @param {Element} reportElement * @param {Object} templateContext * @return {Promise} */ const reloadSettingsFiltersRegion = (reportElement, templateContext) => { const pendingPromise = new Pending('core_reportbuilder/filters:reload'); const settingsFiltersRegion = reportElement.querySelector(reportSelectors.regions.settingsFilters); return Templates.renderForPromise('core_reportbuilder/local/settings/filters', {filters: templateContext}) .then(({html, js}) => { Templates.replaceNode(settingsFiltersRegion, html, js); initFiltersForm(); // Re-focus the add filter element after reloading the region. const reportAddFilter = reportElement.querySelector(reportSelectors.actions.reportAddFilter); reportAddFilter?.focus(); return pendingPromise.resolve(); }); }; /** * Initialise filters form, must be called on each init because the form container is re-created when switching editor modes */ const initFiltersForm = () => { const reportElement = document.querySelector(reportSelectors.regions.report); // Enhance filter selector. const reportAddFilter = reportElement.querySelector(reportSelectors.actions.reportAddFilter); AutoComplete.enhanceField(reportAddFilter, false, '', getString('selectafilter', 'core_reportbuilder')) .catch(Notification.exception); }; /** * Initialise module, prefetch all required strings * * @param {Boolean} initialized Ensure we only add our listeners once */ export const init = initialized => { prefetchStrings('core_reportbuilder', [ 'deletefilter', 'deletefilterconfirm', 'filteradded', 'filterdeleted', 'filtermoved', 'selectafilter', ]); prefetchStrings('core', [ 'delete', ]); initFiltersForm(); if (initialized) { return; } // Add filter to report. document.addEventListener('change', event => { const reportAddFilter = event.target.closest(reportSelectors.actions.reportAddFilter); if (reportAddFilter) { event.preventDefault(); // Check if dropdown is closed with no filter selected. if (reportAddFilter.value === "" || reportAddFilter.value === "0") { return; } const reportElement = reportAddFilter.closest(reportSelectors.regions.report); const pendingPromise = new Pending('core_reportbuilder/filters:add'); addFilter(reportElement.dataset.reportId, reportAddFilter.value) .then(data => reloadSettingsFiltersRegion(reportElement, data)) .then(() => getString('filteradded', 'core_reportbuilder', reportAddFilter.options[reportAddFilter.selectedIndex].text)) .then(addToast) .then(() => pendingPromise.resolve()) .catch(Notification.exception); } }); document.addEventListener('click', event => { // Remove filter from report. const reportRemoveFilter = event.target.closest(reportSelectors.actions.reportRemoveFilter); if (reportRemoveFilter) { event.preventDefault(); const reportElement = reportRemoveFilter.closest(reportSelectors.regions.report); const filterContainer = reportRemoveFilter.closest(reportSelectors.regions.activeFilter); const filterName = filterContainer.dataset.filterName; Notification.saveCancelPromise( getString('deletefilter', 'core_reportbuilder', filterName), getString('deletefilterconfirm', 'core_reportbuilder', filterName), getString('delete', 'core'), {triggerElement: reportRemoveFilter} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/filters:remove'); return deleteFilter(reportElement.dataset.reportId, filterContainer.dataset.filterId) .then(data => reloadSettingsFiltersRegion(reportElement, data)) .then(() => addToast(getString('filterdeleted', 'core_reportbuilder', filterName))) .then(() => pendingPromise.resolve()) .catch(Notification.exception); }).catch(() => { return; }); } }); // Initialize sortable list to handle active filters moving (note JQuery dependency, see MDL-72293 for resolution). var activeFiltersSortableList = new SortableList(`${reportSelectors.regions.activeFilters} ul`, {isHorizontal: false}); activeFiltersSortableList.getElementName = element => Promise.resolve(element.data('filterName')); $(document).on(SortableList.EVENTS.DROP, `${reportSelectors.regions.report} li[data-filter-id]`, (event, info) => { if (info.positionChanged) { const pendingPromise = new Pending('core_reportbuilder/filters:reorder'); const reportElement = event.target.closest(reportSelectors.regions.report); const filterId = info.element.data('filterId'); const filterPosition = info.element.data('filterPosition'); // Select target position, if moving to the end then count number of element siblings. let targetFilterPosition = info.targetNextElement.data('filterPosition') || info.element.siblings().length + 2; if (targetFilterPosition > filterPosition) { targetFilterPosition--; } // Re-order filter, giving drop event transition time to finish. const reorderPromise = reorderFilter(reportElement.dataset.reportId, filterId, targetFilterPosition); Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))]) .then(([data]) => reloadSettingsFiltersRegion(reportElement, data)) .then(() => getString('filtermoved', 'core_reportbuilder', info.element.data('filterName'))) .then(addToast) .then(() => pendingPromise.resolve()) .catch(Notification.exception); } }); }; PK a<�\�� $� � ! amd/src/local/editor/card_view.jsnu �[��� // 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/>. /** * Report builder card view editor * * @module core_reportbuilder/local/editor/card_view * @copyright 2021 Mikel Martín <mikel@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import DynamicForm from 'core_form/dynamicform'; import {add as addToast} from 'core/toast'; import {getString} from "core/str"; import {subscribe as subscribe} from 'core/pubsub'; import Notification from 'core/notification'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; let cardViewForm = null; /** * Initialise card view form, must be called on each init because the form container is re-created when switching editor modes */ const initCardViewForm = () => { const cardViewFormContainer = document.querySelector(reportSelectors.regions.settingsCardView); if (!cardViewFormContainer) { return; } cardViewForm = new DynamicForm(cardViewFormContainer, '\\core_reportbuilder\\form\\card_view'); cardViewForm.addEventListener(cardViewForm.events.FORM_SUBMITTED, (event) => { event.preventDefault(); getString('cardviewsettingssaved', 'core_reportbuilder') .then(addToast) .catch(Notification.exception); }); }; /** * Initialise module * * @param {Boolean} initialized Ensure we only add our listeners once */ export const init = (initialized) => { initCardViewForm(); if (initialized) { return; } // Update form each time a column is added or removed to the custom report. subscribe(reportEvents.publish.reportColumnsUpdated, () => { const reportElement = document.querySelector(reportSelectors.regions.report); cardViewForm.load({reportid: reportElement.dataset.reportId}); }); }; PK a<�\�0�h�) �) " amd/src/local/editor/conditions.jsnu �[��� // 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/>. /** * Report builder conditions editor * * @module core_reportbuilder/local/editor/conditions * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import $ from 'jquery'; import {dispatchEvent} from 'core/event_dispatcher'; import AutoComplete from 'core/form-autocomplete'; import 'core/inplace_editable'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {prefetchStrings} from 'core/prefetch'; import SortableList from 'core/sortable_list'; import {getString} from 'core/str'; import Templates from 'core/templates'; import {add as addToast} from 'core/toast'; import DynamicForm from 'core_form/dynamicform'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {addCondition, deleteCondition, reorderCondition, resetConditions} from 'core_reportbuilder/local/repository/conditions'; /** * Reload conditions settings region * * @param {Element} reportElement * @param {Object} templateContext * @return {Promise} */ const reloadSettingsConditionsRegion = (reportElement, templateContext) => { const pendingPromise = new Pending('core_reportbuilder/conditions:reload'); const settingsConditionsRegion = reportElement.querySelector(reportSelectors.regions.settingsConditions); return Templates.renderForPromise('core_reportbuilder/local/settings/conditions', {conditions: templateContext}) .then(({html, js}) => { const conditionsjs = $.parseHTML(templateContext.javascript, null, true).map(node => node.innerHTML).join("\n"); Templates.replaceNode(settingsConditionsRegion, html, js + conditionsjs); initConditionsForm(); // Re-focus the add condition element after reloading the region. const reportAddCondition = reportElement.querySelector(reportSelectors.actions.reportAddCondition); reportAddCondition?.focus(); return pendingPromise.resolve(); }); }; /** * Initialise conditions form, must be called on each init because the form container is re-created when switching editor modes */ const initConditionsForm = () => { const reportElement = document.querySelector(reportSelectors.regions.report); // Enhance condition selector. const reportAddCondition = reportElement.querySelector(reportSelectors.actions.reportAddCondition); AutoComplete.enhanceField(reportAddCondition, false, '', getString('selectacondition', 'core_reportbuilder')) .catch(Notification.exception); // Handle dynamic conditions form. const conditionFormContainer = reportElement.querySelector(reportSelectors.regions.settingsConditions); if (!conditionFormContainer) { return; } const conditionForm = new DynamicForm(conditionFormContainer, '\\core_reportbuilder\\form\\condition'); // Submit report conditions. conditionForm.addEventListener(conditionForm.events.FORM_SUBMITTED, event => { event.preventDefault(); getString('conditionsapplied', 'core_reportbuilder') .then(addToast) .catch(Notification.exception); // After the form has been submitted, we should trigger report table reload. dispatchEvent(reportEvents.tableReload, {}, reportElement); }); // Reset report conditions. conditionForm.addEventListener(conditionForm.events.NOSUBMIT_BUTTON_PRESSED, event => { event.preventDefault(); Notification.saveCancelPromise( getString('resetconditions', 'core_reportbuilder'), getString('resetconditionsconfirm', 'core_reportbuilder'), getString('resetall', 'core_reportbuilder'), {triggerElement: event.detail} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/conditions:reset'); return resetConditions(reportElement.dataset.reportId) .then(data => reloadSettingsConditionsRegion(reportElement, data)) .then(() => addToast(getString('conditionsreset', 'core_reportbuilder'))) .then(() => { dispatchEvent(reportEvents.tableReload, {}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); }).catch(() => { return; }); }); }; /** * Initialise module, prefetch all required strings * * @param {Boolean} initialized Ensure we only add our listeners once */ export const init = initialized => { prefetchStrings('core_reportbuilder', [ 'conditionadded', 'conditiondeleted', 'conditionmoved', 'conditionsapplied', 'conditionsreset', 'deletecondition', 'deleteconditionconfirm', 'resetall', 'resetconditions', 'resetconditionsconfirm', 'selectacondition', ]); prefetchStrings('core', [ 'delete', ]); initConditionsForm(); if (initialized) { return; } // Add condition to report. document.addEventListener('change', event => { const reportAddCondition = event.target.closest(reportSelectors.actions.reportAddCondition); if (reportAddCondition) { event.preventDefault(); // Check if dropdown is closed with no condition selected. if (reportAddCondition.value === "" || reportAddCondition.value === "0") { return; } const reportElement = reportAddCondition.closest(reportSelectors.regions.report); const pendingPromise = new Pending('core_reportbuilder/conditions:add'); addCondition(reportElement.dataset.reportId, reportAddCondition.value) .then(data => reloadSettingsConditionsRegion(reportElement, data)) .then(() => getString('conditionadded', 'core_reportbuilder', reportAddCondition.options[reportAddCondition.selectedIndex].text)) .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); } }); document.addEventListener('click', event => { // Remove condition from report. const reportRemoveCondition = event.target.closest(reportSelectors.actions.reportRemoveCondition); if (reportRemoveCondition) { event.preventDefault(); const reportElement = reportRemoveCondition.closest(reportSelectors.regions.report); const conditionContainer = reportRemoveCondition.closest(reportSelectors.regions.activeCondition); const conditionName = conditionContainer.dataset.conditionName; Notification.saveCancelPromise( getString('deletecondition', 'core_reportbuilder', conditionName), getString('deleteconditionconfirm', 'core_reportbuilder', conditionName), getString('delete', 'core'), {triggerElement: reportRemoveCondition} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/conditions:remove'); return deleteCondition(reportElement.dataset.reportId, conditionContainer.dataset.conditionId) .then(data => reloadSettingsConditionsRegion(reportElement, data)) .then(() => addToast(getString('conditiondeleted', 'core_reportbuilder', conditionName))) .then(() => { dispatchEvent(reportEvents.tableReload, {}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); }).catch(() => { return; }); } }); // Initialize sortable list to handle active conditions moving (note JQuery dependency, see MDL-72293 for resolution). var activeConditionsSortableList = new SortableList(`${reportSelectors.regions.activeConditions}`, {isHorizontal: false}); activeConditionsSortableList.getElementName = element => Promise.resolve(element.data('conditionName')); $(document).on(SortableList.EVENTS.DROP, reportSelectors.regions.activeCondition, (event, info) => { if (info.positionChanged) { const pendingPromise = new Pending('core_reportbuilder/conditions:reorder'); const reportElement = event.target.closest(reportSelectors.regions.report); const conditionId = info.element.data('conditionId'); const conditionPosition = info.element.data('conditionPosition'); // Select target position, if moving to the end then count number of element siblings. let targetConditionPosition = info.targetNextElement.data('conditionPosition') || info.element.siblings().length + 2; if (targetConditionPosition > conditionPosition) { targetConditionPosition--; } // Re-order condition, giving drop event transition time to finish. const reorderPromise = reorderCondition(reportElement.dataset.reportId, conditionId, targetConditionPosition); Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))]) .then(([data]) => reloadSettingsConditionsRegion(reportElement, data)) .then(() => getString('conditionmoved', 'core_reportbuilder', info.element.data('conditionName'))) .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); } }); }; PK a<�\����" �" amd/src/local/editor/columns.jsnu �[��� // 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/>. /** * Report builder columns editor * * @module core_reportbuilder/local/editor/columns * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ "use strict"; import $ from 'jquery'; import {dispatchEvent} from 'core/event_dispatcher'; import 'core/inplace_editable'; import {eventTypes as inplaceEditableEvents} from 'core/local/inplace_editable/events'; import Notification from 'core/notification'; import Pending from 'core/pending'; import {prefetchStrings} from 'core/prefetch'; import {publish} from 'core/pubsub'; import SortableList from 'core/sortable_list'; import {getString} from 'core/str'; import {add as addToast} from 'core/toast'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {addColumn, deleteColumn, reorderColumn} from 'core_reportbuilder/local/repository/columns'; import {getColumnSorting} from 'core_reportbuilder/local/repository/sorting'; /** * Initialise module, prefetch all required strings * * @param {Boolean} initialized Ensure we only add our listeners once */ export const init = initialized => { prefetchStrings('core_reportbuilder', [ 'columnadded', 'columnaggregated', 'columndeleted', 'columnmoved', 'deletecolumn', 'deletecolumnconfirm', ]); prefetchStrings('core', [ 'delete', ]); if (initialized) { return; } document.addEventListener('click', event => { // Add column to report. const reportAddColumn = event.target.closest(reportSelectors.actions.reportAddColumn); if (reportAddColumn) { event.preventDefault(); const pendingPromise = new Pending('core_reportbuilder/columns:add'); const reportElement = reportAddColumn.closest(reportSelectors.regions.report); addColumn(reportElement.dataset.reportId, reportAddColumn.dataset.uniqueIdentifier) .then(data => publish(reportEvents.publish.reportColumnsUpdated, data)) .then(() => getString('columnadded', 'core_reportbuilder', reportAddColumn.dataset.name)) .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); } // Remove column from report. const reportRemoveColumn = event.target.closest(reportSelectors.actions.reportRemoveColumn); if (reportRemoveColumn) { event.preventDefault(); const reportElement = reportRemoveColumn.closest(reportSelectors.regions.report); const columnHeader = reportRemoveColumn.closest(reportSelectors.regions.columnHeader); const columnName = columnHeader.dataset.columnName; Notification.saveCancelPromise( getString('deletecolumn', 'core_reportbuilder', columnName), getString('deletecolumnconfirm', 'core_reportbuilder', columnName), getString('delete', 'core'), {triggerElement: reportRemoveColumn} ).then(() => { const pendingPromise = new Pending('core_reportbuilder/columns:remove'); return deleteColumn(reportElement.dataset.reportId, columnHeader.dataset.columnId) .then(data => publish(reportEvents.publish.reportColumnsUpdated, data)) .then(() => addToast(getString('columndeleted', 'core_reportbuilder', columnName))) .then(() => { dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); }).catch(() => { return; }); } }); // Initialize sortable list to handle column moving (note JQuery dependency, see MDL-72293 for resolution). var columnSortableList = new SortableList(`${reportSelectors.regions.reportTable} thead tr`, {isHorizontal: true}); columnSortableList.getElementName = element => Promise.resolve(element.data('columnName')); $(document).on(SortableList.EVENTS.DRAG, `${reportSelectors.regions.report} th[data-column-id]`, (event, info) => { const reportElement = event.target.closest(reportSelectors.regions.report); const columnPosition = info.element.data('columnPosition'); const targetColumnPosition = info.targetNextElement.data('columnPosition'); $(reportElement).find('tbody tr').each(function() { const cell = $(this).children(`td.c${columnPosition - 1}`)[0]; if (targetColumnPosition) { var beforeCell = $(this).children(`td.c${targetColumnPosition - 1}`)[0]; this.insertBefore(cell, beforeCell); } else { this.appendChild(cell); } }); }); $(document).on(SortableList.EVENTS.DROP, `${reportSelectors.regions.report} th[data-column-id]`, (event, info) => { if (info.positionChanged) { const pendingPromise = new Pending('core_reportbuilder/columns:reorder'); const reportElement = event.target.closest(reportSelectors.regions.report); const columnId = info.element.data('columnId'); const columnName = info.element.data('columnName'); const columnPosition = info.element.data('columnPosition'); // Select target position, if moving to the end then count number of element siblings. let targetColumnPosition = info.targetNextElement.data('columnPosition') || info.element.siblings().length + 2; if (targetColumnPosition > columnPosition) { targetColumnPosition--; } // Re-order column, giving drop event transition time to finish. const reorderPromise = reorderColumn(reportElement.dataset.reportId, columnId, targetColumnPosition); Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))]) .then(() => getString('columnmoved', 'core_reportbuilder', columnName)) .then(addToast) .then(() => { dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement); return pendingPromise.resolve(); }) .catch(Notification.exception); } }); // Initialize inplace editable listeners for column aggregation. document.addEventListener(inplaceEditableEvents.elementUpdated, event => { const columnAggregation = event.target.closest('[data-itemtype="columnaggregation"]'); if (columnAggregation) { const pendingPromise = new Pending('core_reportbuilder/columns:aggregate'); const reportElement = columnAggregation.closest(reportSelectors.regions.report); const columnHeader = columnAggregation.closest(reportSelectors.regions.columnHeader); getString('columnaggregated', 'core_reportbuilder', columnHeader.dataset.columnName) .then(addToast) .then(() => { // Pass preserveTriggerElement parameter so columnAggregationLink will be focused after the report reload. const columnAggregationLink = `[data-itemtype="columnaggregation"][data-itemid="` + `${columnAggregation.dataset.itemid}"] > a`; // Now reload the table, and notify listeners that columns have been updated. dispatchEvent(reportEvents.tableReload, {preserveTriggerElement: columnAggregationLink}, reportElement); return getColumnSorting(reportElement.dataset.reportId); }) .then(data => publish(reportEvents.publish.reportColumnsUpdated, data)) .then(() => pendingPromise.resolve()) .catch(Notification.exception); } }); }; PK a<�\`�6 � � amd/src/report.jsnu �[��� // 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/>. /** * Report builder report management * * @module core_reportbuilder/report * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ import Notification from 'core/notification'; import * as reportEvents from 'core_reportbuilder/local/events'; import * as reportSelectors from 'core_reportbuilder/local/selectors'; import {setPageNumber, refreshTableContent} from 'core_table/dynamic'; import * as tableSelectors from 'core_table/local/dynamic/selectors'; const CLASSES = { COLLAPSED: 'collapsed', EXPANDED: 'show', ICONUP: 'fa-angle-up', ICONDOWN: 'fa-angle-down' }; let initialized = false; /** * Initialise module for given report * * @method */ export const init = () => { if (initialized) { // We already added the event listeners (can be called multiple times by mustache template). return; } // Listen for the table reload event. document.addEventListener(reportEvents.tableReload, async(event) => { const reportElement = event.target.closest(reportSelectors.regions.report); if (reportElement === null) { return; } const tableRoot = reportElement.querySelector(tableSelectors.main.region); const pageNumber = event.detail?.preservePagination ? null : 1; await setPageNumber(tableRoot, pageNumber, false) .then(refreshTableContent) .then(() => { // TODO: Refactor this after MDL-73130 lands. const preserveTriggerElement = event.detail?.preserveTriggerElement; if (preserveTriggerElement) { reportElement.querySelector(preserveTriggerElement)?.focus(); } return; }) .catch(Notification.exception); }); // Listen for trigger popup events. document.addEventListener('click', event => { const reportActionPopup = event.target.closest(reportSelectors.actions.reportActionPopup); if (reportActionPopup === null) { return; } event.preventDefault(); const popupAction = JSON.parse(reportActionPopup.dataset.popupAction); window.openpopup(event, popupAction.jsfunctionargs); }); // Listen for card view toggle events. document.addEventListener('click', (event) => { const toggleCard = event.target.closest(reportSelectors.actions.toggleCardView); if (toggleCard) { const tableCard = toggleCard.closest('tr'); const toggleIcon = toggleCard.querySelector('i'); event.preventDefault(); if (toggleCard.classList.contains(CLASSES.COLLAPSED)) { tableCard.classList.add(CLASSES.EXPANDED); toggleIcon.classList.replace(CLASSES.ICONDOWN, CLASSES.ICONUP); toggleCard.classList.remove(CLASSES.COLLAPSED); toggleCard.setAttribute('aria-expanded', "true"); } else { tableCard.classList.remove(CLASSES.EXPANDED); toggleIcon.classList.replace(CLASSES.ICONUP, CLASSES.ICONDOWN); toggleCard.classList.add(CLASSES.COLLAPSED); toggleCard.removeAttribute('aria-expanded'); } } }); initialized = true; }; PK a<�\���l l amd/build/schedules.min.jsnu �[��� define("core_reportbuilder/schedules",["exports","core/event_dispatcher","core/inplace_editable","core/notification","core/pending","core/prefetch","core/str","core/toast","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/modals","core_reportbuilder/local/repository/schedules"],(function(_exports,_event_dispatcher,_inplace_editable,_notification,_pending,_prefetch,_str,_toast,reportEvents,reportSelectors,_modals,_schedules){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);let initialized=!1;_exports.init=reportId=>{(0,_prefetch.prefetchStrings)("core_reportbuilder",["deleteschedule","deletescheduleconfirm","disableschedule","editscheduledetails","enableschedule","newschedule","schedulecreated","scheduledeleted","schedulesent","scheduleupdated","sendschedule","sendscheduleconfirm"]),(0,_prefetch.prefetchStrings)("core",["confirm","delete"]),initialized||(document.addEventListener("click",(event=>{if(event.target.closest(reportSelectors.actions.scheduleCreate)){event.preventDefault();const scheduleModal=(0,_modals.createScheduleModal)(event.target,(0,_str.getString)("newschedule","core_reportbuilder"),reportId);scheduleModal.addEventListener(scheduleModal.events.FORM_SUBMITTED,(()=>{(0,_str.getString)("schedulecreated","core_reportbuilder").then(_toast.add).then((()=>{const reportElement=document.querySelector(reportSelectors.regions.report);(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement)})).catch(_notification.default.exception)})),scheduleModal.show()}const scheduleToggle=event.target.closest(reportSelectors.actions.scheduleToggle);if(scheduleToggle){const pendingPromise=new _pending.default("core_reportbuilder/schedules:toggle"),scheduleStateToggle=+!Number(scheduleToggle.dataset.state);(0,_schedules.toggleSchedule)(reportId,scheduleToggle.dataset.id,scheduleStateToggle).then((()=>{scheduleToggle.closest("tr").classList.toggle("text-muted"),scheduleToggle.dataset.state=scheduleStateToggle;const stringKey=scheduleStateToggle?"disableschedule":"enableschedule";return(0,_str.getString)(stringKey,"core_reportbuilder")})).then((toggleLabel=>(scheduleToggle.parentElement.querySelector('label[for="'.concat(scheduleToggle.id,'"] > span')).innerHTML=toggleLabel,pendingPromise.resolve()))).catch(_notification.default.exception)}const scheduleEdit=event.target.closest(reportSelectors.actions.scheduleEdit);if(scheduleEdit){event.preventDefault();const triggerElement=scheduleEdit.closest(".dropdown").querySelector(".dropdown-toggle"),scheduleModal=(0,_modals.createScheduleModal)(triggerElement,(0,_str.getString)("editscheduledetails","core_reportbuilder"),reportId,scheduleEdit.dataset.scheduleId);scheduleModal.addEventListener(scheduleModal.events.FORM_SUBMITTED,(()=>{(0,_str.getString)("scheduleupdated","core_reportbuilder").then(_toast.add).then((()=>{const reportElement=scheduleEdit.closest(reportSelectors.regions.report);(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement)})).catch(_notification.default.exception)})),scheduleModal.show()}const scheduleSend=event.target.closest(reportSelectors.actions.scheduleSend);if(scheduleSend){event.preventDefault();const triggerElement=scheduleSend.closest(".dropdown").querySelector(".dropdown-toggle");_notification.default.saveCancelPromise((0,_str.getString)("sendschedule","core_reportbuilder"),(0,_str.getString)("sendscheduleconfirm","core_reportbuilder",scheduleSend.dataset.scheduleName),(0,_str.getString)("confirm","core"),{triggerElement:triggerElement}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/schedules:send");return(0,_schedules.sendSchedule)(reportId,scheduleSend.dataset.scheduleId).then((0,_toast.add)((0,_str.getString)("schedulesent","core_reportbuilder"))).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)})).catch((()=>{}))}const scheduleDelete=event.target.closest(reportSelectors.actions.scheduleDelete);if(scheduleDelete){event.preventDefault();const triggerElement=scheduleDelete.closest(".dropdown").querySelector(".dropdown-toggle");_notification.default.saveCancelPromise((0,_str.getString)("deleteschedule","core_reportbuilder"),(0,_str.getString)("deletescheduleconfirm","core_reportbuilder",scheduleDelete.dataset.scheduleName),(0,_str.getString)("delete","core"),{triggerElement:triggerElement}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/schedules:delete");return(0,_schedules.deleteSchedule)(reportId,scheduleDelete.dataset.scheduleId).then((0,_toast.add)((0,_str.getString)("scheduledeleted","core_reportbuilder"))).then((()=>{const reportElement=scheduleDelete.closest(reportSelectors.regions.report);return(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement),pendingPromise.resolve()})).catch(_notification.default.exception)})).catch((()=>{}))}})),initialized=!0)}})); //# sourceMappingURL=schedules.min.js.mapPK a<�\QP� � amd/build/filters.min.jsnu �[��� define("core_reportbuilder/filters",["exports","core/event_dispatcher","core/fragment","core/notification","core/pending","core/str","core/templates","core/toast","core_form/dynamicform","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/filters"],(function(_exports,_event_dispatcher,_fragment,_notification,_pending,_str,_templates,_toast,_dynamicform,reportEvents,reportSelectors,_filters){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}} /** * Report builder filter management * * @module core_reportbuilder/filters * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_templates=_interopRequireDefault(_templates),_dynamicform=_interopRequireDefault(_dynamicform),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);const setFilterButtonCount=async(reportElement,filterCount)=>{const filterButtonLabel=reportElement.querySelector(reportSelectors.regions.filterButtonLabel);filterButtonLabel.textContent=filterCount>0?await(0,_str.getString)("filtersappliedx","core_reportbuilder",filterCount):await(0,_str.getString)("filters","moodle")};_exports.init=(reportElementId,contextId)=>{const reportElement=document.getElementById(reportElementId),filterFormContainer=reportElement.querySelector(reportSelectors.regions.filtersForm);if(filterFormContainer.dataset.initialized)return;filterFormContainer.dataset.initialized=!0;const filterForm=new _dynamicform.default(filterFormContainer,"\\core_reportbuilder\\form\\filter");filterForm.addEventListener(filterForm.events.FORM_SUBMITTED,(event=>{event.preventDefault(),(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),setFilterButtonCount(reportElement,event.detail),(0,_str.getString)("filtersapplied","core_reportbuilder").then(_toast.add).catch(_notification.default.exception)})),filterForm.addEventListener(filterForm.events.NOSUBMIT_BUTTON_PRESSED,(event=>{event.preventDefault();const pendingPromise=new _pending.default("core_reportbuilder/filters:reset"),{reportId:reportId,reportParameters:reportParameters}=reportElement.dataset;(0,_filters.resetFilters)(reportId,reportParameters).then((()=>(0,_str.getString)("filtersreset","core_reportbuilder"))).then(_toast.add).then((()=>(0,_fragment.loadFragment)("core_reportbuilder","filters_form",contextId,{reportid:reportId,parameters:reportParameters}))).then(((html,js)=>(_templates.default.replaceNodeContents(filterFormContainer,html,js),(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),setFilterButtonCount(reportElement,0),pendingPromise.resolve()))).catch(_notification.default.exception)})),document.querySelector("#region-main").style.overflowX="visible"}})); //# sourceMappingURL=filters.min.js.mapPK a<�\r�z� � amd/build/filters.min.js.mapnu �[��� {"version":3,"file":"filters.min.js","sources":["../src/filters.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder filter management\n *\n * @module core_reportbuilder/filters\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport {dispatchEvent} from 'core/event_dispatcher';\nimport {loadFragment} from 'core/fragment';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {getString} from 'core/str';\nimport Templates from 'core/templates';\nimport {add as addToast} from 'core/toast';\nimport DynamicForm from 'core_form/dynamicform';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {resetFilters} from 'core_reportbuilder/local/repository/filters';\n\n/**\n * Update filter button text to indicate applied filter count\n *\n * @param {Element} reportElement\n * @param {Number} filterCount\n */\nconst setFilterButtonCount = async(reportElement, filterCount) => {\n const filterButtonLabel = reportElement.querySelector(reportSelectors.regions.filterButtonLabel);\n\n if (filterCount > 0) {\n filterButtonLabel.textContent = await getString('filtersappliedx', 'core_reportbuilder', filterCount);\n } else {\n filterButtonLabel.textContent = await getString('filters', 'moodle');\n }\n};\n\n/**\n * Initialise module for given report\n *\n * @method\n * @param {String} reportElementId\n * @param {Number} contextId\n */\nexport const init = (reportElementId, contextId) => {\n const reportElement = document.getElementById(reportElementId);\n const filterFormContainer = reportElement.querySelector(reportSelectors.regions.filtersForm);\n\n // Ensure we only add our listeners once (can be called multiple times by mustache template).\n if (filterFormContainer.dataset.initialized) {\n return;\n }\n filterFormContainer.dataset.initialized = true;\n\n const filterForm = new DynamicForm(filterFormContainer, '\\\\core_reportbuilder\\\\form\\\\filter');\n\n // Submit report filters.\n filterForm.addEventListener(filterForm.events.FORM_SUBMITTED, event => {\n event.preventDefault();\n\n // After the form has been submitted, we should trigger report table reload.\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n setFilterButtonCount(reportElement, event.detail);\n\n getString('filtersapplied', 'core_reportbuilder')\n .then(addToast)\n .catch(Notification.exception);\n });\n\n // Reset report filters.\n filterForm.addEventListener(filterForm.events.NOSUBMIT_BUTTON_PRESSED, event => {\n event.preventDefault();\n\n const pendingPromise = new Pending('core_reportbuilder/filters:reset');\n\n const {reportId, reportParameters} = reportElement.dataset;\n resetFilters(reportId, reportParameters)\n .then(() => getString('filtersreset', 'core_reportbuilder'))\n .then(addToast)\n .then(() => loadFragment('core_reportbuilder', 'filters_form', contextId, {\n reportid: reportId,\n parameters: reportParameters,\n }))\n .then((html, js) => {\n Templates.replaceNodeContents(filterFormContainer, html, js);\n\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n setFilterButtonCount(reportElement, 0);\n\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n });\n\n // Modify \"region-main\" overflow for big filter forms.\n document.querySelector('#region-main').style.overflowX = \"visible\";\n};\n"],"names":["setFilterButtonCount","async","reportElement","filterCount","filterButtonLabel","querySelector","reportSelectors","regions","textContent","reportElementId","contextId","document","getElementById","filterFormContainer","filtersForm","dataset","initialized","filterForm","DynamicForm","addEventListener","events","FORM_SUBMITTED","event","preventDefault","reportEvents","tableReload","detail","then","addToast","catch","Notification","exception","NOSUBMIT_BUTTON_PRESSED","pendingPromise","Pending","reportId","reportParameters","reportid","parameters","html","js","replaceNodeContents","resolve","style","overflowX"],"mappings":";;;;;;;kYAyCMA,qBAAuBC,MAAMC,cAAeC,qBACxCC,kBAAoBF,cAAcG,cAAcC,gBAAgBC,QAAQH,mBAG1EA,kBAAkBI,YADlBL,YAAc,QACwB,kBAAU,kBAAmB,qBAAsBA,mBAEnD,kBAAU,UAAW,yBAW/C,CAACM,gBAAiBC,mBAC5BR,cAAgBS,SAASC,eAAeH,iBACxCI,oBAAsBX,cAAcG,cAAcC,gBAAgBC,QAAQO,gBAG5ED,oBAAoBE,QAAQC,mBAGhCH,oBAAoBE,QAAQC,aAAc,QAEpCC,WAAa,IAAIC,qBAAYL,oBAAqB,sCAGxDI,WAAWE,iBAAiBF,WAAWG,OAAOC,gBAAgBC,QAC1DA,MAAMC,qDAGQC,aAAaC,YAAa,GAAIvB,eAC5CF,qBAAqBE,cAAeoB,MAAMI,2BAEhC,iBAAkB,sBACvBC,KAAKC,YACLC,MAAMC,sBAAaC,cAI5Bd,WAAWE,iBAAiBF,WAAWG,OAAOY,yBAAyBV,QACnEA,MAAMC,uBAEAU,eAAiB,IAAIC,iBAAQ,qCAE7BC,SAACA,SAADC,iBAAWA,kBAAoBlC,cAAca,kCACtCoB,SAAUC,kBAClBT,MAAK,KAAM,kBAAU,eAAgB,wBACrCA,KAAKC,YACLD,MAAK,KAAM,0BAAa,qBAAsB,eAAgBjB,UAAW,CACtE2B,SAAUF,SACVG,WAAYF,qBAEfT,MAAK,CAACY,KAAMC,yBACCC,oBAAoB5B,oBAAqB0B,KAAMC,wCAE3ChB,aAAaC,YAAa,GAAIvB,eAC5CF,qBAAqBE,cAAe,GAE7B+B,eAAeS,aAEzBb,MAAMC,sBAAaC,cAI5BpB,SAASN,cAAc,gBAAgBsC,MAAMC,UAAY"}PK a<�\>O�l l amd/build/editor.min.js.mapnu �[��� {"version":3,"file":"editor.min.js","sources":["../src/editor.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder editor\n *\n * @module core_reportbuilder/editor\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport $ from 'jquery';\nimport 'core/inplace_editable';\nimport {addIconToContainer} from 'core/loadingicon';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport Templates from 'core/templates';\nimport {getString} from 'core/str';\nimport {add as addToast} from 'core/toast';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {init as columnsEditorInit} from 'core_reportbuilder/local/editor/columns';\nimport {init as conditionsEditorInit} from 'core_reportbuilder/local/editor/conditions';\nimport {init as filtersEditorInit} from 'core_reportbuilder/local/editor/filters';\nimport {init as sortingEditorInit} from 'core_reportbuilder/local/editor/sorting';\nimport {init as cardviewEditorInit} from 'core_reportbuilder/local/editor/card_view';\nimport {getReport} from 'core_reportbuilder/local/repository/reports';\nimport {createReportModal} from 'core_reportbuilder/local/repository/modals';\n\nlet initialized = false;\n\n/**\n * Initialise editor and all it's modules\n */\nexport const init = () => {\n columnsEditorInit(initialized);\n conditionsEditorInit(initialized);\n filtersEditorInit(initialized);\n sortingEditorInit(initialized);\n cardviewEditorInit(initialized);\n\n // Ensure we only add our listeners once (can be called multiple times by mustache template).\n if (initialized) {\n return;\n }\n\n // Add event handlers to generic report editor elements.\n document.addEventListener('click', event => {\n\n // Toggle between edit and preview mode.\n const toggleEditViewMode = event.target.closest(reportSelectors.actions.toggleEditPreview);\n if (toggleEditViewMode) {\n event.preventDefault();\n\n const reportElement = event.target.closest(reportSelectors.regions.report);\n const pendingPromise = new Pending('core_reportbuilder/reports:get');\n const toggledEditMode = toggleEditViewMode.dataset.editMode !== \"1\";\n\n addIconToContainer(toggleEditViewMode)\n .then(() => getReport(reportElement.dataset.reportId, toggledEditMode))\n .then(response => Promise.all([\n $.parseHTML(response.javascript, null, true).map(node => node.innerHTML).join(\"\\n\"),\n Templates.renderForPromise('core_reportbuilder/local/dynamictabs/editor', response),\n ]))\n .then(([responseJs, {html, js}]) => Templates.replaceNode(reportElement, html, js + responseJs))\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n }\n\n // Edit report details modal.\n const reportEdit = event.target.closest(reportSelectors.actions.reportEdit);\n if (reportEdit) {\n event.preventDefault();\n\n const reportModal = createReportModal(event.target, getString('editreportdetails', 'core_reportbuilder'),\n reportEdit.dataset.reportId);\n reportModal.addEventListener(reportModal.events.FORM_SUBMITTED, () => {\n getString('reportupdated', 'core_reportbuilder')\n .then(addToast)\n .then(() => {\n return window.location.reload();\n })\n .catch(Notification.exception);\n });\n reportModal.show();\n }\n });\n\n initialized = true;\n};\n"],"names":["initialized","document","addEventListener","event","toggleEditViewMode","target","closest","reportSelectors","actions","toggleEditPreview","preventDefault","reportElement","regions","report","pendingPromise","Pending","toggledEditMode","dataset","editMode","then","reportId","response","Promise","all","$","parseHTML","javascript","map","node","innerHTML","join","Templates","renderForPromise","_ref","responseJs","html","js","replaceNode","resolve","catch","Notification","exception","reportEdit","reportModal","events","FORM_SUBMITTED","addToast","window","location","reload","show"],"mappings":"09DA0CIA,aAAc,gBAKE,uBACEA,kCACGA,+BACHA,+BACAA,iCACCA,aAGfA,cAKJC,SAASC,iBAAiB,SAASC,cAGzBC,mBAAqBD,MAAME,OAAOC,QAAQC,gBAAgBC,QAAQC,sBACpEL,mBAAoB,CACpBD,MAAMO,uBAEAC,cAAgBR,MAAME,OAAOC,QAAQC,gBAAgBK,QAAQC,QAC7DC,eAAiB,IAAIC,iBAAQ,kCAC7BC,gBAA0D,MAAxCZ,mBAAmBa,QAAQC,6CAEhCd,oBACde,MAAK,KAAM,sBAAUR,cAAcM,QAAQG,SAAUJ,mBACrDG,MAAKE,UAAYC,QAAQC,IAAI,CAC1BC,gBAAEC,UAAUJ,SAASK,WAAY,MAAM,GAAMC,KAAIC,MAAQA,KAAKC,YAAWC,KAAK,MAC9EC,mBAAUC,iBAAiB,8CAA+CX,cAE7EF,MAAKc,WAAEC,YAAYC,KAACA,KAADC,GAAOA,iBAASL,mBAAUM,YAAY1B,cAAewB,KAAMC,GAAKF,eACnFf,MAAK,IAAML,eAAewB,YAC1BC,MAAMC,sBAAaC,iBAItBC,WAAavC,MAAME,OAAOC,QAAQC,gBAAgBC,QAAQkC,eAC5DA,WAAY,CACZvC,MAAMO,uBAEAiC,aAAc,6BAAkBxC,MAAME,QAAQ,kBAAU,oBAAqB,sBAC/EqC,WAAWzB,QAAQG,UACvBuB,YAAYzC,iBAAiByC,YAAYC,OAAOC,gBAAgB,wBAClD,gBAAiB,sBACtB1B,KAAK2B,YACL3B,MAAK,IACK4B,OAAOC,SAASC,WAE1BV,MAAMC,sBAAaC,cAE5BE,YAAYO,WAIpBlD,aAAc"}PK a<�\%�� amd/build/sidebar.min.js.mapnu �[��� {"version":3,"file":"sidebar.min.js","sources":["../src/sidebar.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder sidebar component\n *\n * @module core_reportbuilder/sidebar\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Pending from 'core/pending';\nimport {debounce} from 'core/utils';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\n\nconst DEBOUNCE_TIMER = 250;\n\nconst CLASSES = {\n EXPANDED: 'show',\n COLLAPSED: 'collapsed',\n HIDE: 'd-none',\n};\n\n/**\n * Initialise module\n *\n * @param {Event} event\n * @param {Element} sidebarMenu\n */\nconst sidebarCardFilter = (event, sidebarMenu) => {\n const pendingPromise = new Pending('core_reportbuilder/sidebar:cardFilter');\n\n const sidebarCards = sidebarMenu.querySelectorAll(reportSelectors.regions.sidebarCard);\n const sidebarItems = sidebarMenu.querySelectorAll(reportSelectors.regions.sidebarItem);\n const searchTerm = event.target.value.toLowerCase();\n\n // Toggle items according to match against search term.\n sidebarItems.forEach(item => {\n const itemContent = item.textContent.toLowerCase();\n item.classList.toggle(CLASSES.HIDE, !itemContent.includes(searchTerm));\n });\n\n // Toggle cards according to whether they have any visible items.\n sidebarCards.forEach(card => {\n const visibleItems = card.querySelectorAll(`${reportSelectors.regions.sidebarItem}:not(.${CLASSES.HIDE})`);\n card.classList.toggle(CLASSES.HIDE, !visibleItems.length);\n\n expandCard(card);\n });\n\n pendingPromise.resolve();\n};\n\n/**\n * Show a collapsed card.\n * This function simulates the behaviour of JQuery show method on a collapsible element.\n *\n * @param {Element} card\n */\nconst expandCard = (card) => {\n let cardButton = card.querySelector('[data-toggle=\"collapse\"]');\n if (cardButton.classList.contains(CLASSES.COLLAPSED)) {\n cardButton.classList.remove(CLASSES.COLLAPSED);\n cardButton.setAttribute('aria-expanded', \"true\");\n let cardContent = card.querySelector(cardButton.dataset.target);\n cardContent.classList.add(CLASSES.EXPANDED);\n }\n};\n\n/**\n * Initialise module\n *\n * @param {string} selectorId\n */\nexport const init = (selectorId) => {\n const sidebarMenu = document.querySelector(selectorId + reportSelectors.regions.sidebarMenu);\n const sidebarSearch = sidebarMenu.querySelector(reportSelectors.actions.sidebarSearch);\n\n // Debounce the event listener to allow the user to finish typing.\n const sidebarSearchDebounce = debounce(sidebarCardFilter, DEBOUNCE_TIMER);\n sidebarSearch.addEventListener('keyup', event => {\n const pendingPromise = new Pending('core_reportbuilder/sidebar:keyup');\n\n sidebarSearchDebounce(event, sidebarMenu);\n setTimeout(() => {\n pendingPromise.resolve();\n }, DEBOUNCE_TIMER);\n });\n};\n"],"names":["CLASSES","sidebarCardFilter","event","sidebarMenu","pendingPromise","Pending","sidebarCards","querySelectorAll","reportSelectors","regions","sidebarCard","sidebarItems","sidebarItem","searchTerm","target","value","toLowerCase","forEach","item","itemContent","textContent","classList","toggle","includes","card","visibleItems","length","expandCard","resolve","cardButton","querySelector","contains","remove","setAttribute","dataset","add","selectorId","document","sidebarSearch","actions","sidebarSearchDebounce","addEventListener","setTimeout"],"mappings":";;;;;;;mlCA6BMA,iBACQ,OADRA,kBAES,YAFTA,aAGI,SASJC,kBAAoB,CAACC,MAAOC,qBACxBC,eAAiB,IAAIC,iBAAQ,yCAE7BC,aAAeH,YAAYI,iBAAiBC,gBAAgBC,QAAQC,aACpEC,aAAeR,YAAYI,iBAAiBC,gBAAgBC,QAAQG,aACpEC,WAAaX,MAAMY,OAAOC,MAAMC,cAGtCL,aAAaM,SAAQC,aACXC,YAAcD,KAAKE,YAAYJ,cACrCE,KAAKG,UAAUC,OAAOtB,cAAemB,YAAYI,SAASV,gBAI9DP,aAAaW,SAAQO,aACXC,aAAeD,KAAKjB,2BAAoBC,gBAAgBC,QAAQG,6BAAoBZ,mBAC1FwB,KAAKH,UAAUC,OAAOtB,cAAeyB,aAAaC,QAElDC,WAAWH,SAGfpB,eAAewB,WASbD,WAAcH,WACZK,WAAaL,KAAKM,cAAc,+BAChCD,WAAWR,UAAUU,SAAS/B,mBAAoB,CAClD6B,WAAWR,UAAUW,OAAOhC,mBAC5B6B,WAAWI,aAAa,gBAAiB,QACvBT,KAAKM,cAAcD,WAAWK,QAAQpB,QAC5CO,UAAUc,IAAInC,kCASboC,mBACXjC,YAAckC,SAASP,cAAcM,WAAa5B,gBAAgBC,QAAQN,aAC1EmC,cAAgBnC,YAAY2B,cAActB,gBAAgB+B,QAAQD,eAGlEE,uBAAwB,mBAASvC,kBAhEpB,KAiEnBqC,cAAcG,iBAAiB,SAASvC,cAC9BE,eAAiB,IAAIC,iBAAQ,oCAEnCmC,sBAAsBtC,MAAOC,aAC7BuC,YAAW,KACPtC,eAAewB,YAtEJ"}PK a<�\}���E E amd/build/sidebar.min.jsnu �[��� define("core_reportbuilder/sidebar",["exports","core/pending","core/utils","core_reportbuilder/local/selectors"],(function(_exports,_pending,_utils,reportSelectors){var obj; /** * Report builder sidebar component * * @module core_reportbuilder/sidebar * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_pending=(obj=_pending)&&obj.__esModule?obj:{default:obj},reportSelectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(reportSelectors);const CLASSES_EXPANDED="show",CLASSES_COLLAPSED="collapsed",CLASSES_HIDE="d-none",sidebarCardFilter=(event,sidebarMenu)=>{const pendingPromise=new _pending.default("core_reportbuilder/sidebar:cardFilter"),sidebarCards=sidebarMenu.querySelectorAll(reportSelectors.regions.sidebarCard),sidebarItems=sidebarMenu.querySelectorAll(reportSelectors.regions.sidebarItem),searchTerm=event.target.value.toLowerCase();sidebarItems.forEach((item=>{const itemContent=item.textContent.toLowerCase();item.classList.toggle(CLASSES_HIDE,!itemContent.includes(searchTerm))})),sidebarCards.forEach((card=>{const visibleItems=card.querySelectorAll("".concat(reportSelectors.regions.sidebarItem,":not(.").concat(CLASSES_HIDE,")"));card.classList.toggle(CLASSES_HIDE,!visibleItems.length),expandCard(card)})),pendingPromise.resolve()},expandCard=card=>{let cardButton=card.querySelector('[data-toggle="collapse"]');if(cardButton.classList.contains(CLASSES_COLLAPSED)){cardButton.classList.remove(CLASSES_COLLAPSED),cardButton.setAttribute("aria-expanded","true"),card.querySelector(cardButton.dataset.target).classList.add(CLASSES_EXPANDED)}};_exports.init=selectorId=>{const sidebarMenu=document.querySelector(selectorId+reportSelectors.regions.sidebarMenu),sidebarSearch=sidebarMenu.querySelector(reportSelectors.actions.sidebarSearch),sidebarSearchDebounce=(0,_utils.debounce)(sidebarCardFilter,250);sidebarSearch.addEventListener("keyup",(event=>{const pendingPromise=new _pending.default("core_reportbuilder/sidebar:keyup");sidebarSearchDebounce(event,sidebarMenu),setTimeout((()=>{pendingPromise.resolve()}),250)}))}})); //# sourceMappingURL=sidebar.min.js.mapPK a<�\U�Z�C+ C+ amd/build/schedules.min.js.mapnu �[��� {"version":3,"file":"schedules.min.js","sources":["../src/schedules.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder audiences\n *\n * @module core_reportbuilder/schedules\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport {dispatchEvent} from 'core/event_dispatcher';\nimport 'core/inplace_editable';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {prefetchStrings} from 'core/prefetch';\nimport {getString} from 'core/str';\nimport {add as addToast} from 'core/toast';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {createScheduleModal} from 'core_reportbuilder/local/repository/modals';\nimport {deleteSchedule, sendSchedule, toggleSchedule} from 'core_reportbuilder/local/repository/schedules';\n\nlet initialized = false;\n\n/**\n * Initialise schedules tab\n *\n * @param {Number} reportId\n */\nexport const init = reportId => {\n prefetchStrings('core_reportbuilder', [\n 'deleteschedule',\n 'deletescheduleconfirm',\n 'disableschedule',\n 'editscheduledetails',\n 'enableschedule',\n 'newschedule',\n 'schedulecreated',\n 'scheduledeleted',\n 'schedulesent',\n 'scheduleupdated',\n 'sendschedule',\n 'sendscheduleconfirm',\n ]);\n\n prefetchStrings('core', [\n 'confirm',\n 'delete',\n ]);\n\n if (initialized) {\n // We already added the event listeners (can be called multiple times by mustache template).\n return;\n }\n\n document.addEventListener('click', event => {\n\n // Create schedule.\n const scheduleCreate = event.target.closest(reportSelectors.actions.scheduleCreate);\n if (scheduleCreate) {\n event.preventDefault();\n\n const scheduleModal = createScheduleModal(event.target, getString('newschedule', 'core_reportbuilder'), reportId);\n scheduleModal.addEventListener(scheduleModal.events.FORM_SUBMITTED, () => {\n getString('schedulecreated', 'core_reportbuilder')\n .then(addToast)\n .then(() => {\n const reportElement = document.querySelector(reportSelectors.regions.report);\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return;\n })\n .catch(Notification.exception);\n });\n\n scheduleModal.show();\n }\n\n // Toggle schedule.\n const scheduleToggle = event.target.closest(reportSelectors.actions.scheduleToggle);\n if (scheduleToggle) {\n const pendingPromise = new Pending('core_reportbuilder/schedules:toggle');\n const scheduleStateToggle = +!Number(scheduleToggle.dataset.state);\n\n toggleSchedule(reportId, scheduleToggle.dataset.id, scheduleStateToggle)\n .then(() => {\n const tableRow = scheduleToggle.closest('tr');\n tableRow.classList.toggle('text-muted');\n\n scheduleToggle.dataset.state = scheduleStateToggle;\n\n const stringKey = scheduleStateToggle ? 'disableschedule' : 'enableschedule';\n return getString(stringKey, 'core_reportbuilder');\n })\n .then(toggleLabel => {\n const labelContainer = scheduleToggle.parentElement.querySelector(`label[for=\"${scheduleToggle.id}\"] > span`);\n labelContainer.innerHTML = toggleLabel;\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n\n // Edit schedule.\n const scheduleEdit = event.target.closest(reportSelectors.actions.scheduleEdit);\n if (scheduleEdit) {\n event.preventDefault();\n\n // Use triggerElement to return focus to the action menu toggle.\n const triggerElement = scheduleEdit.closest('.dropdown').querySelector('.dropdown-toggle');\n const scheduleModal = createScheduleModal(triggerElement, getString('editscheduledetails', 'core_reportbuilder'),\n reportId, scheduleEdit.dataset.scheduleId);\n scheduleModal.addEventListener(scheduleModal.events.FORM_SUBMITTED, () => {\n getString('scheduleupdated', 'core_reportbuilder')\n .then(addToast)\n .then(() => {\n const reportElement = scheduleEdit.closest(reportSelectors.regions.report);\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return;\n })\n .catch(Notification.exception);\n });\n\n scheduleModal.show();\n }\n\n // Send schedule.\n const scheduleSend = event.target.closest(reportSelectors.actions.scheduleSend);\n if (scheduleSend) {\n event.preventDefault();\n\n // Use triggerElement to return focus to the action menu toggle.\n const triggerElement = scheduleSend.closest('.dropdown').querySelector('.dropdown-toggle');\n Notification.saveCancelPromise(\n getString('sendschedule', 'core_reportbuilder'),\n getString('sendscheduleconfirm', 'core_reportbuilder', scheduleSend.dataset.scheduleName),\n getString('confirm', 'core'),\n {triggerElement}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/schedules:send');\n\n return sendSchedule(reportId, scheduleSend.dataset.scheduleId)\n .then(addToast(getString('schedulesent', 'core_reportbuilder')))\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n }\n\n // Delete schedule.\n const scheduleDelete = event.target.closest(reportSelectors.actions.scheduleDelete);\n if (scheduleDelete) {\n event.preventDefault();\n\n // Use triggerElement to return focus to the action menu toggle.\n const triggerElement = scheduleDelete.closest('.dropdown').querySelector('.dropdown-toggle');\n Notification.saveCancelPromise(\n getString('deleteschedule', 'core_reportbuilder'),\n getString('deletescheduleconfirm', 'core_reportbuilder', scheduleDelete.dataset.scheduleName),\n getString('delete', 'core'),\n {triggerElement}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/schedules:delete');\n\n return deleteSchedule(reportId, scheduleDelete.dataset.scheduleId)\n .then(addToast(getString('scheduledeleted', 'core_reportbuilder')))\n .then(() => {\n const reportElement = scheduleDelete.closest(reportSelectors.regions.report);\n dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n }\n });\n\n initialized = true;\n};\n"],"names":["initialized","reportId","document","addEventListener","event","target","closest","reportSelectors","actions","scheduleCreate","preventDefault","scheduleModal","events","FORM_SUBMITTED","then","addToast","reportElement","querySelector","regions","report","reportEvents","tableReload","catch","Notification","exception","show","scheduleToggle","pendingPromise","Pending","scheduleStateToggle","Number","dataset","state","id","classList","toggle","stringKey","toggleLabel","parentElement","innerHTML","resolve","scheduleEdit","triggerElement","scheduleId","scheduleSend","saveCancelPromise","scheduleName","scheduleDelete","preservePagination"],"mappings":"0wDAqCIA,aAAc,gBAOEC,yCACA,qBAAsB,CAClC,iBACA,wBACA,kBACA,sBACA,iBACA,cACA,kBACA,kBACA,eACA,kBACA,eACA,sDAGY,OAAQ,CACpB,UACA,WAGAD,cAKJE,SAASC,iBAAiB,SAASC,WAGRA,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQC,gBAChD,CAChBL,MAAMM,uBAEAC,eAAgB,+BAAoBP,MAAMC,QAAQ,kBAAU,cAAe,sBAAuBJ,UACxGU,cAAcR,iBAAiBQ,cAAcC,OAAOC,gBAAgB,wBACtD,kBAAmB,sBACxBC,KAAKC,YACLD,MAAK,WACIE,cAAgBd,SAASe,cAAcV,gBAAgBW,QAAQC,4CACvDC,aAAaC,YAAa,GAAIL,kBAG/CM,MAAMC,sBAAaC,cAG5Bb,cAAcc,aAIZC,eAAiBtB,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQkB,mBAChEA,eAAgB,OACVC,eAAiB,IAAIC,iBAAQ,uCAC7BC,sBAAwBC,OAAOJ,eAAeK,QAAQC,qCAE7C/B,SAAUyB,eAAeK,QAAQE,GAAIJ,qBAC/Cf,MAAK,KACeY,eAAepB,QAAQ,MAC/B4B,UAAUC,OAAO,cAE1BT,eAAeK,QAAQC,MAAQH,0BAEzBO,UAAYP,oBAAsB,kBAAoB,wBACrD,kBAAUO,UAAW,yBAE/BtB,MAAKuB,cACqBX,eAAeY,cAAcrB,mCAA4BS,eAAeO,iBAChFM,UAAYF,YACpBV,eAAea,aAEzBlB,MAAMC,sBAAaC,iBAItBiB,aAAerC,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQiC,iBAC9DA,aAAc,CACdrC,MAAMM,uBAGAgC,eAAiBD,aAAanC,QAAQ,aAAaW,cAAc,oBACjEN,eAAgB,+BAAoB+B,gBAAgB,kBAAU,sBAAuB,sBACvFzC,SAAUwC,aAAaV,QAAQY,YACnChC,cAAcR,iBAAiBQ,cAAcC,OAAOC,gBAAgB,wBACtD,kBAAmB,sBACxBC,KAAKC,YACLD,MAAK,WACIE,cAAgByB,aAAanC,QAAQC,gBAAgBW,QAAQC,4CACrDC,aAAaC,YAAa,GAAIL,kBAG/CM,MAAMC,sBAAaC,cAG5Bb,cAAcc,aAIZmB,aAAexC,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQoC,iBAC9DA,aAAc,CACdxC,MAAMM,uBAGAgC,eAAiBE,aAAatC,QAAQ,aAAaW,cAAc,0CAC1D4B,mBACT,kBAAU,eAAgB,uBAC1B,kBAAU,sBAAuB,qBAAsBD,aAAab,QAAQe,eAC5E,kBAAU,UAAW,QACrB,CAACJ,eAAAA,iBACH5B,MAAK,WACGa,eAAiB,IAAIC,iBAAQ,4CAE5B,2BAAa3B,SAAU2C,aAAab,QAAQY,YAC9C7B,MAAK,eAAS,kBAAU,eAAgB,wBACxCA,MAAK,IAAMa,eAAea,YAC1BlB,MAAMC,sBAAaC,cACzBF,OAAM,eAMPyB,eAAiB3C,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQuC,mBAChEA,eAAgB,CAChB3C,MAAMM,uBAGAgC,eAAiBK,eAAezC,QAAQ,aAAaW,cAAc,0CAC5D4B,mBACT,kBAAU,iBAAkB,uBAC5B,kBAAU,wBAAyB,qBAAsBE,eAAehB,QAAQe,eAChF,kBAAU,SAAU,QACpB,CAACJ,eAAAA,iBACH5B,MAAK,WACGa,eAAiB,IAAIC,iBAAQ,8CAE5B,6BAAe3B,SAAU8C,eAAehB,QAAQY,YAClD7B,MAAK,eAAS,kBAAU,kBAAmB,wBAC3CA,MAAK,WACIE,cAAgB+B,eAAezC,QAAQC,gBAAgBW,QAAQC,kDACvDC,aAAaC,YAAa,CAAC2B,oBAAoB,GAAOhC,eAC7DW,eAAea,aAEzBlB,MAAMC,sBAAaC,cACzBF,OAAM,aAMjBtB,aAAc"}PK a<�\nK� � amd/build/audience.min.jsnu �[��� define("core_reportbuilder/audience",["exports","core/inplace_editable","core/templates","core/notification","core/pending","core/prefetch","core/str","core_form/dynamicform","core/toast","core_reportbuilder/local/repository/audiences","core_reportbuilder/local/selectors","core/fragment","core_form/changechecker"],(function(_exports,_inplace_editable,_templates,_notification,_pending,_prefetch,_str,_dynamicform,_toast,_audiences,reportSelectors,_fragment,_changechecker){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_templates=_interopRequireDefault(_templates),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_dynamicform=_interopRequireDefault(_dynamicform),reportSelectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(reportSelectors);let reportId=0,contextId=0;const initAudienceCardForm=audienceCard=>{const audienceFormContainer=audienceCard.querySelector(reportSelectors.regions.audienceFormContainer),audienceForm=new _dynamicform.default(audienceFormContainer,"\\core_reportbuilder\\form\\audience");return audienceForm.addEventListener(audienceForm.events.FORM_SUBMITTED,(data=>{const audienceHeading=audienceCard.querySelector(reportSelectors.regions.audienceHeading),audienceDescription=audienceCard.querySelector(reportSelectors.regions.audienceDescription);return audienceCard.dataset.audienceId=data.detail.instanceid,audienceHeading.innerHTML=data.detail.heading,audienceDescription.innerHTML=data.detail.description,closeAudienceCardForm(audienceCard),(0,_str.getString)("audiencesaved","core_reportbuilder").then(_toast.add)})),audienceForm.addEventListener(audienceForm.events.FORM_CANCELLED,(()=>{audienceCard.dataset.audienceId>0?closeAudienceCardForm(audienceCard):removeAudienceCard(audienceCard)})),audienceForm},closeAudienceCardForm=audienceCard=>{const audienceFormContainer=audienceCard.querySelector(reportSelectors.regions.audienceFormContainer),NewAudienceFormContainer=audienceFormContainer.cloneNode(!1);audienceCard.querySelector(reportSelectors.regions.audienceForm).replaceChild(NewAudienceFormContainer,audienceFormContainer),audienceCard.querySelector(reportSelectors.regions.audienceDescription).classList.remove("hidden"),audienceCard.querySelector(reportSelectors.actions.audienceEdit).disabled=!1,audienceCard.querySelector(reportSelectors.actions.audienceDelete).disabled=!1},removeAudienceCard=audienceCard=>{audienceCard.remove();const audienceCards=document.querySelector(reportSelectors.regions.audiencesContainer).querySelectorAll(reportSelectors.regions.audienceCard);if(0===audienceCards.length){document.querySelector(reportSelectors.regions.audienceEmptyMessage).classList.remove("hidden")}else{const audienceFirstCardSeparator=audienceCards[0].querySelector(".audience-separator");null==audienceFirstCardSeparator||audienceFirstCardSeparator.remove()}};let initialized=!1;_exports.init=(id,contextid)=>{(0,_prefetch.prefetchStrings)("core_reportbuilder",["audienceadded","audiencedeleted","audiencesaved","audienceusedbyschedule","deleteaudience","deleteaudienceconfirm"]),(0,_prefetch.prefetchStrings)("core",["delete"]),reportId=id,contextId=contextid,initialized||(document.addEventListener("click",(event=>{const audienceAdd=event.target.closest(reportSelectors.actions.audienceAdd);audienceAdd&&(event.preventDefault(),((className,title)=>{const pendingPromise=new _pending.default("core_reportbuilder/audience:add"),audiencesContainer=document.querySelector(reportSelectors.regions.audiencesContainer),audienceCardLength=audiencesContainer.querySelectorAll(reportSelectors.regions.audienceCard).length,params={classname:className,reportid:reportId,showormessage:audienceCardLength>0,title:title};(0,_fragment.loadFragment)("core_reportbuilder","audience_form",contextId,params).then(((html,js)=>{const audienceCard=_templates.default.appendNodeContents(audiencesContainer,html,js)[0],audienceEmptyMessage=audiencesContainer.querySelector(reportSelectors.regions.audienceEmptyMessage),audienceForm=initAudienceCardForm(audienceCard);return(0,_changechecker.markFormAsDirty)(audienceForm.getFormNode()),audienceEmptyMessage.classList.add("hidden"),(0,_str.getString)("audienceadded","core_reportbuilder",title)})).then(_toast.add).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)})(audienceAdd.dataset.uniqueIdentifier,audienceAdd.dataset.name));const audienceEdit=event.target.closest(reportSelectors.actions.audienceEdit);if(audienceEdit){const audienceEditCard=audienceEdit.closest(reportSelectors.regions.audienceCard);event.preventDefault(),(audienceCard=>{const pendingPromise=new _pending.default("core_reportbuilder/audience:edit");initAudienceCardForm(audienceCard).load({id:audienceCard.dataset.audienceId}).then((()=>{const audienceFormContainer=audienceCard.querySelector(reportSelectors.regions.audienceFormContainer),audienceDescription=audienceCard.querySelector(reportSelectors.regions.audienceDescription),audienceEdit=audienceCard.querySelector(reportSelectors.actions.audienceEdit);return audienceFormContainer.classList.remove("hidden"),audienceDescription.classList.add("hidden"),audienceEdit.disabled=!0,pendingPromise.resolve()})).catch(_notification.default.exception)})(audienceEditCard)}const audienceDelete=event.target.closest(reportSelectors.actions.audienceDelete);audienceDelete&&(event.preventDefault(),(audienceDelete=>{const audienceCard=audienceDelete.closest(reportSelectors.regions.audienceCard),{audienceId:audienceId,audienceTitle:audienceTitle,audienceEditWarning:audienceEditWarning=!1}=audienceCard.dataset,audienceDeleteConfirmation=audienceEditWarning?"audienceusedbyschedule":"deleteaudienceconfirm";_notification.default.saveCancelPromise((0,_str.getString)("deleteaudience","core_reportbuilder",audienceTitle),(0,_str.getString)(audienceDeleteConfirmation,"core_reportbuilder",audienceTitle),(0,_str.getString)("delete","core"),{triggerElement:audienceDelete}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/audience:delete");return(0,_audiences.deleteAudience)(reportId,audienceId).then((()=>(0,_toast.add)((0,_str.getString)("audiencedeleted","core_reportbuilder",audienceTitle)))).then((()=>(removeAudienceCard(audienceCard),pendingPromise.resolve()))).catch(_notification.default.exception)})).catch((()=>{}))})(audienceDelete))})),initialized=!0)}})); //# sourceMappingURL=audience.min.js.mapPK a<�\�KiO O ! amd/build/reports_list.min.js.mapnu �[��� {"version":3,"file":"reports_list.min.js","sources":["../src/reports_list.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder reports list management\n *\n * @module core_reportbuilder/reports_list\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport {dispatchEvent} from 'core/event_dispatcher';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {prefetchStrings} from 'core/prefetch';\nimport {getString} from 'core/str';\nimport {add as addToast} from 'core/toast';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {deleteReport} from 'core_reportbuilder/local/repository/reports';\nimport {createReportModal} from 'core_reportbuilder/local/repository/modals';\n\n/**\n * Initialise module\n */\nexport const init = () => {\n prefetchStrings('core_reportbuilder', [\n 'deletereport',\n 'deletereportconfirm',\n 'editreportdetails',\n 'newreport',\n 'reportdeleted',\n 'reportupdated',\n ]);\n\n prefetchStrings('core', [\n 'delete',\n ]);\n\n document.addEventListener('click', event => {\n const reportCreate = event.target.closest(reportSelectors.actions.reportCreate);\n if (reportCreate) {\n event.preventDefault();\n\n // Redirect user to editing interface for the report after submission.\n const reportModal = createReportModal(event.target, getString('newreport', 'core_reportbuilder'));\n reportModal.addEventListener(reportModal.events.FORM_SUBMITTED, event => {\n window.location.href = event.detail;\n });\n\n reportModal.show();\n }\n\n const reportEdit = event.target.closest(reportSelectors.actions.reportEdit);\n if (reportEdit) {\n event.preventDefault();\n\n // Reload current report page after submission.\n // Use triggerElement to return focus to the action menu toggle.\n const triggerElement = reportEdit.closest('.dropdown').querySelector('.dropdown-toggle');\n const reportModal = createReportModal(triggerElement, getString('editreportdetails', 'core_reportbuilder'),\n reportEdit.dataset.reportId);\n reportModal.addEventListener(reportModal.events.FORM_SUBMITTED, () => {\n const reportElement = event.target.closest(reportSelectors.regions.report);\n\n getString('reportupdated', 'core_reportbuilder')\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement);\n return;\n })\n .catch(Notification.exception);\n });\n\n reportModal.show();\n }\n\n const reportDelete = event.target.closest(reportSelectors.actions.reportDelete);\n if (reportDelete) {\n event.preventDefault();\n\n // Use triggerElement to return focus to the action menu toggle.\n const triggerElement = reportDelete.closest('.dropdown').querySelector('.dropdown-toggle');\n Notification.saveCancelPromise(\n getString('deletereport', 'core_reportbuilder'),\n getString('deletereportconfirm', 'core_reportbuilder', reportDelete.dataset.reportName),\n getString('delete', 'core'),\n {triggerElement}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/reports:delete');\n const reportElement = event.target.closest(reportSelectors.regions.report);\n\n return deleteReport(reportDelete.dataset.reportId)\n .then(() => addToast(getString('reportdeleted', 'core_reportbuilder')))\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n }\n });\n};\n"],"names":["document","addEventListener","event","target","closest","reportSelectors","actions","reportCreate","preventDefault","reportModal","events","FORM_SUBMITTED","window","location","href","detail","show","reportEdit","triggerElement","querySelector","dataset","reportId","reportElement","regions","report","then","addToast","reportEvents","tableReload","preservePagination","catch","Notification","exception","reportDelete","saveCancelPromise","reportName","pendingPromise","Pending","resolve"],"mappings":"yuDAuCoB,mCACA,qBAAsB,CAClC,eACA,sBACA,oBACA,YACA,gBACA,gDAGY,OAAQ,CACpB,WAGJA,SAASC,iBAAiB,SAASC,WACVA,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQC,cAChD,CACdL,MAAMM,uBAGAC,aAAc,6BAAkBP,MAAMC,QAAQ,kBAAU,YAAa,uBAC3EM,YAAYR,iBAAiBQ,YAAYC,OAAOC,gBAAgBT,QAC5DU,OAAOC,SAASC,KAAOZ,MAAMa,UAGjCN,YAAYO,aAGVC,WAAaf,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQW,eAC5DA,WAAY,CACZf,MAAMM,uBAIAU,eAAiBD,WAAWb,QAAQ,aAAae,cAAc,oBAC/DV,aAAc,6BAAkBS,gBAAgB,kBAAU,oBAAqB,sBACjFD,WAAWG,QAAQC,UACvBZ,YAAYR,iBAAiBQ,YAAYC,OAAOC,gBAAgB,WACtDW,cAAgBpB,MAAMC,OAAOC,QAAQC,gBAAgBkB,QAAQC,2BAEzD,gBAAiB,sBACtBC,KAAKC,YACLD,MAAK,yCACYE,aAAaC,YAAa,CAACC,oBAAoB,GAAOP,kBAGvEQ,MAAMC,sBAAaC,cAG5BvB,YAAYO,aAGViB,aAAe/B,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQ2B,iBAC9DA,aAAc,CACd/B,MAAMM,uBAGAU,eAAiBe,aAAa7B,QAAQ,aAAae,cAAc,0CAC1De,mBACT,kBAAU,eAAgB,uBAC1B,kBAAU,sBAAuB,qBAAsBD,aAAab,QAAQe,aAC5E,kBAAU,SAAU,QACpB,CAACjB,eAAAA,iBACHO,MAAK,WACGW,eAAiB,IAAIC,iBAAQ,qCAC7Bf,cAAgBpB,MAAMC,OAAOC,QAAQC,gBAAgBkB,QAAQC,eAE5D,yBAAaS,aAAab,QAAQC,UACpCI,MAAK,KAAM,eAAS,kBAAU,gBAAiB,yBAC/CA,MAAK,yCACYE,aAAaC,YAAa,CAACC,oBAAoB,GAAOP,eAC7Dc,eAAeE,aAEzBR,MAAMC,sBAAaC,cACzBF,OAAM"}PK a<�\�^�� � amd/build/editor.min.jsnu �[��� define("core_reportbuilder/editor",["exports","jquery","core/inplace_editable","core/loadingicon","core/notification","core/pending","core/templates","core/str","core/toast","core_reportbuilder/local/selectors","core_reportbuilder/local/editor/columns","core_reportbuilder/local/editor/conditions","core_reportbuilder/local/editor/filters","core_reportbuilder/local/editor/sorting","core_reportbuilder/local/editor/card_view","core_reportbuilder/local/repository/reports","core_reportbuilder/local/repository/modals"],(function(_exports,_jquery,_inplace_editable,_loadingicon,_notification,_pending,_templates,_str,_toast,reportSelectors,_columns,_conditions,_filters,_sorting,_card_view,_reports,_modals){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=_interopRequireDefault(_jquery),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_templates=_interopRequireDefault(_templates),reportSelectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(reportSelectors);let initialized=!1;_exports.init=()=>{(0,_columns.init)(initialized),(0,_conditions.init)(initialized),(0,_filters.init)(initialized),(0,_sorting.init)(initialized),(0,_card_view.init)(initialized),initialized||(document.addEventListener("click",(event=>{const toggleEditViewMode=event.target.closest(reportSelectors.actions.toggleEditPreview);if(toggleEditViewMode){event.preventDefault();const reportElement=event.target.closest(reportSelectors.regions.report),pendingPromise=new _pending.default("core_reportbuilder/reports:get"),toggledEditMode="1"!==toggleEditViewMode.dataset.editMode;(0,_loadingicon.addIconToContainer)(toggleEditViewMode).then((()=>(0,_reports.getReport)(reportElement.dataset.reportId,toggledEditMode))).then((response=>Promise.all([_jquery.default.parseHTML(response.javascript,null,!0).map((node=>node.innerHTML)).join("\n"),_templates.default.renderForPromise("core_reportbuilder/local/dynamictabs/editor",response)]))).then((_ref=>{let[responseJs,{html:html,js:js}]=_ref;return _templates.default.replaceNode(reportElement,html,js+responseJs)})).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)}const reportEdit=event.target.closest(reportSelectors.actions.reportEdit);if(reportEdit){event.preventDefault();const reportModal=(0,_modals.createReportModal)(event.target,(0,_str.getString)("editreportdetails","core_reportbuilder"),reportEdit.dataset.reportId);reportModal.addEventListener(reportModal.events.FORM_SUBMITTED,(()=>{(0,_str.getString)("reportupdated","core_reportbuilder").then(_toast.add).then((()=>window.location.reload())).catch(_notification.default.exception)})),reportModal.show()}})),initialized=!0)}})); //# sourceMappingURL=editor.min.js.mapPK a<�\�%p� amd/build/reports_list.min.jsnu �[��� define("core_reportbuilder/reports_list",["exports","core/event_dispatcher","core/notification","core/pending","core/prefetch","core/str","core/toast","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/reports","core_reportbuilder/local/repository/modals"],(function(_exports,_event_dispatcher,_notification,_pending,_prefetch,_str,_toast,reportEvents,reportSelectors,_reports,_modals){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);_exports.init=()=>{(0,_prefetch.prefetchStrings)("core_reportbuilder",["deletereport","deletereportconfirm","editreportdetails","newreport","reportdeleted","reportupdated"]),(0,_prefetch.prefetchStrings)("core",["delete"]),document.addEventListener("click",(event=>{if(event.target.closest(reportSelectors.actions.reportCreate)){event.preventDefault();const reportModal=(0,_modals.createReportModal)(event.target,(0,_str.getString)("newreport","core_reportbuilder"));reportModal.addEventListener(reportModal.events.FORM_SUBMITTED,(event=>{window.location.href=event.detail})),reportModal.show()}const reportEdit=event.target.closest(reportSelectors.actions.reportEdit);if(reportEdit){event.preventDefault();const triggerElement=reportEdit.closest(".dropdown").querySelector(".dropdown-toggle"),reportModal=(0,_modals.createReportModal)(triggerElement,(0,_str.getString)("editreportdetails","core_reportbuilder"),reportEdit.dataset.reportId);reportModal.addEventListener(reportModal.events.FORM_SUBMITTED,(()=>{const reportElement=event.target.closest(reportSelectors.regions.report);(0,_str.getString)("reportupdated","core_reportbuilder").then(_toast.add).then((()=>{(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement)})).catch(_notification.default.exception)})),reportModal.show()}const reportDelete=event.target.closest(reportSelectors.actions.reportDelete);if(reportDelete){event.preventDefault();const triggerElement=reportDelete.closest(".dropdown").querySelector(".dropdown-toggle");_notification.default.saveCancelPromise((0,_str.getString)("deletereport","core_reportbuilder"),(0,_str.getString)("deletereportconfirm","core_reportbuilder",reportDelete.dataset.reportName),(0,_str.getString)("delete","core"),{triggerElement:triggerElement}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/reports:delete"),reportElement=event.target.closest(reportSelectors.regions.report);return(0,_reports.deleteReport)(reportDelete.dataset.reportId).then((()=>(0,_toast.add)((0,_str.getString)("reportdeleted","core_reportbuilder")))).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)})).catch((()=>{}))}}))}})); //# sourceMappingURL=reports_list.min.js.mapPK a<�\P��. . amd/build/report.min.jsnu �[��� define("core_reportbuilder/report",["exports","core/notification","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core_table/dynamic","core_table/local/dynamic/selectors"],(function(_exports,_notification,reportEvents,reportSelectors,_dynamic,tableSelectors){var obj; /** * Report builder report management * * @module core_reportbuilder/report * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_notification=(obj=_notification)&&obj.__esModule?obj:{default:obj},reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors),tableSelectors=_interopRequireWildcard(tableSelectors);const CLASSES_COLLAPSED="collapsed",CLASSES_EXPANDED="show",CLASSES_ICONUP="fa-angle-up",CLASSES_ICONDOWN="fa-angle-down";let initialized=!1;_exports.init=()=>{initialized||(document.addEventListener(reportEvents.tableReload,(async event=>{var _event$detail;const reportElement=event.target.closest(reportSelectors.regions.report);if(null===reportElement)return;const tableRoot=reportElement.querySelector(tableSelectors.main.region),pageNumber=null!==(_event$detail=event.detail)&&void 0!==_event$detail&&_event$detail.preservePagination?null:1;await(0,_dynamic.setPageNumber)(tableRoot,pageNumber,!1).then(_dynamic.refreshTableContent).then((()=>{var _event$detail2;const preserveTriggerElement=null===(_event$detail2=event.detail)||void 0===_event$detail2?void 0:_event$detail2.preserveTriggerElement;var _reportElement$queryS;preserveTriggerElement&&(null===(_reportElement$queryS=reportElement.querySelector(preserveTriggerElement))||void 0===_reportElement$queryS||_reportElement$queryS.focus())})).catch(_notification.default.exception)})),document.addEventListener("click",(event=>{const reportActionPopup=event.target.closest(reportSelectors.actions.reportActionPopup);if(null===reportActionPopup)return;event.preventDefault();const popupAction=JSON.parse(reportActionPopup.dataset.popupAction);window.openpopup(event,popupAction.jsfunctionargs)})),document.addEventListener("click",(event=>{const toggleCard=event.target.closest(reportSelectors.actions.toggleCardView);if(toggleCard){const tableCard=toggleCard.closest("tr"),toggleIcon=toggleCard.querySelector("i");event.preventDefault(),toggleCard.classList.contains(CLASSES_COLLAPSED)?(tableCard.classList.add(CLASSES_EXPANDED),toggleIcon.classList.replace(CLASSES_ICONDOWN,CLASSES_ICONUP),toggleCard.classList.remove(CLASSES_COLLAPSED),toggleCard.setAttribute("aria-expanded","true")):(tableCard.classList.remove(CLASSES_EXPANDED),toggleIcon.classList.replace(CLASSES_ICONUP,CLASSES_ICONDOWN),toggleCard.classList.add(CLASSES_COLLAPSED),toggleCard.removeAttribute("aria-expanded"))}})),initialized=!0)}})); //# sourceMappingURL=report.min.js.mapPK a<�\,w뗓8 �8 amd/build/audience.min.js.mapnu �[��� {"version":3,"file":"audience.min.js","sources":["../src/audience.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder audiences\n *\n * @module core_reportbuilder/audience\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport 'core/inplace_editable';\nimport Templates from 'core/templates';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {prefetchStrings} from 'core/prefetch';\nimport {getString} from 'core/str';\nimport DynamicForm from 'core_form/dynamicform';\nimport {add as addToast} from 'core/toast';\nimport {deleteAudience} from 'core_reportbuilder/local/repository/audiences';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {loadFragment} from 'core/fragment';\nimport {markFormAsDirty} from 'core_form/changechecker';\n\nlet reportId = 0;\nlet contextId = 0;\n\n/**\n * Add audience card\n *\n * @param {String} className\n * @param {String} title\n */\nconst addAudienceCard = (className, title) => {\n const pendingPromise = new Pending('core_reportbuilder/audience:add');\n\n const audiencesContainer = document.querySelector(reportSelectors.regions.audiencesContainer);\n const audienceCardLength = audiencesContainer.querySelectorAll(reportSelectors.regions.audienceCard).length;\n\n const params = {\n classname: className,\n reportid: reportId,\n showormessage: (audienceCardLength > 0),\n title: title,\n };\n\n // Load audience card fragment, render and then initialise the form within.\n loadFragment('core_reportbuilder', 'audience_form', contextId, params)\n .then((html, js) => {\n const audienceCard = Templates.appendNodeContents(audiencesContainer, html, js)[0];\n const audienceEmptyMessage = audiencesContainer.querySelector(reportSelectors.regions.audienceEmptyMessage);\n\n const audienceForm = initAudienceCardForm(audienceCard);\n // Mark as dirty new audience form created to prevent users leaving the page without saving it.\n markFormAsDirty(audienceForm.getFormNode());\n audienceEmptyMessage.classList.add('hidden');\n\n return getString('audienceadded', 'core_reportbuilder', title);\n })\n .then(addToast)\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n};\n\n/**\n * Edit audience card\n *\n * @param {Element} audienceCard\n */\nconst editAudienceCard = audienceCard => {\n const pendingPromise = new Pending('core_reportbuilder/audience:edit');\n\n // Load audience form with data for editing, then toggle visible controls in the card.\n const audienceForm = initAudienceCardForm(audienceCard);\n audienceForm.load({id: audienceCard.dataset.audienceId})\n .then(() => {\n const audienceFormContainer = audienceCard.querySelector(reportSelectors.regions.audienceFormContainer);\n const audienceDescription = audienceCard.querySelector(reportSelectors.regions.audienceDescription);\n const audienceEdit = audienceCard.querySelector(reportSelectors.actions.audienceEdit);\n\n audienceFormContainer.classList.remove('hidden');\n audienceDescription.classList.add('hidden');\n audienceEdit.disabled = true;\n\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n};\n\n/**\n * Initialise dynamic form within given audience card\n *\n * @param {Element} audienceCard\n * @return {DynamicForm}\n */\nconst initAudienceCardForm = audienceCard => {\n const audienceFormContainer = audienceCard.querySelector(reportSelectors.regions.audienceFormContainer);\n const audienceForm = new DynamicForm(audienceFormContainer, '\\\\core_reportbuilder\\\\form\\\\audience');\n\n // After submitting the form, update the card instance and description properties.\n audienceForm.addEventListener(audienceForm.events.FORM_SUBMITTED, data => {\n const audienceHeading = audienceCard.querySelector(reportSelectors.regions.audienceHeading);\n const audienceDescription = audienceCard.querySelector(reportSelectors.regions.audienceDescription);\n\n audienceCard.dataset.audienceId = data.detail.instanceid;\n\n audienceHeading.innerHTML = data.detail.heading;\n audienceDescription.innerHTML = data.detail.description;\n\n closeAudienceCardForm(audienceCard);\n\n return getString('audiencesaved', 'core_reportbuilder')\n .then(addToast);\n });\n\n // If cancelling the form, close the card or remove it if it was never created.\n audienceForm.addEventListener(audienceForm.events.FORM_CANCELLED, () => {\n if (audienceCard.dataset.audienceId > 0) {\n closeAudienceCardForm(audienceCard);\n } else {\n removeAudienceCard(audienceCard);\n }\n });\n\n return audienceForm;\n};\n\n/**\n * Delete audience card\n *\n * @param {Element} audienceDelete\n */\nconst deleteAudienceCard = audienceDelete => {\n const audienceCard = audienceDelete.closest(reportSelectors.regions.audienceCard);\n const {audienceId, audienceTitle, audienceEditWarning = false} = audienceCard.dataset;\n\n // The edit warning indicates the audience is in use in a report schedule.\n const audienceDeleteConfirmation = audienceEditWarning ? 'audienceusedbyschedule' : 'deleteaudienceconfirm';\n\n Notification.saveCancelPromise(\n getString('deleteaudience', 'core_reportbuilder', audienceTitle),\n getString(audienceDeleteConfirmation, 'core_reportbuilder', audienceTitle),\n getString('delete', 'core'),\n {triggerElement: audienceDelete}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/audience:delete');\n\n return deleteAudience(reportId, audienceId)\n .then(() => addToast(getString('audiencedeleted', 'core_reportbuilder', audienceTitle)))\n .then(() => {\n removeAudienceCard(audienceCard);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n};\n\n/**\n * Close audience card form\n *\n * @param {Element} audienceCard\n */\nconst closeAudienceCardForm = audienceCard => {\n // Remove the [data-region=\"audience-form-container\"] (with all the event listeners attached to it), and create it again.\n const audienceFormContainer = audienceCard.querySelector(reportSelectors.regions.audienceFormContainer);\n const NewAudienceFormContainer = audienceFormContainer.cloneNode(false);\n audienceCard.querySelector(reportSelectors.regions.audienceForm).replaceChild(NewAudienceFormContainer, audienceFormContainer);\n // Show the description container and enable the action buttons.\n audienceCard.querySelector(reportSelectors.regions.audienceDescription).classList.remove('hidden');\n audienceCard.querySelector(reportSelectors.actions.audienceEdit).disabled = false;\n audienceCard.querySelector(reportSelectors.actions.audienceDelete).disabled = false;\n};\n\n/**\n * Remove audience card\n *\n * @param {Element} audienceCard\n */\nconst removeAudienceCard = audienceCard => {\n audienceCard.remove();\n\n const audiencesContainer = document.querySelector(reportSelectors.regions.audiencesContainer);\n const audienceCards = audiencesContainer.querySelectorAll(reportSelectors.regions.audienceCard);\n\n // Show message if there are no cards remaining, ensure first card's separator is not present.\n if (audienceCards.length === 0) {\n const audienceEmptyMessage = document.querySelector(reportSelectors.regions.audienceEmptyMessage);\n audienceEmptyMessage.classList.remove('hidden');\n } else {\n const audienceFirstCardSeparator = audienceCards[0].querySelector('.audience-separator');\n audienceFirstCardSeparator?.remove();\n }\n};\n\nlet initialized = false;\n\n/**\n * Initialise audiences tab.\n *\n * @param {Number} id\n * @param {Number} contextid\n */\nexport const init = (id, contextid) => {\n prefetchStrings('core_reportbuilder', [\n 'audienceadded',\n 'audiencedeleted',\n 'audiencesaved',\n 'audienceusedbyschedule',\n 'deleteaudience',\n 'deleteaudienceconfirm',\n ]);\n\n prefetchStrings('core', [\n 'delete',\n ]);\n\n reportId = id;\n contextId = contextid;\n\n if (initialized) {\n // We already added the event listeners (can be called multiple times by mustache template).\n return;\n }\n\n document.addEventListener('click', event => {\n\n // Add instance.\n const audienceAdd = event.target.closest(reportSelectors.actions.audienceAdd);\n if (audienceAdd) {\n event.preventDefault();\n addAudienceCard(audienceAdd.dataset.uniqueIdentifier, audienceAdd.dataset.name);\n }\n\n // Edit instance.\n const audienceEdit = event.target.closest(reportSelectors.actions.audienceEdit);\n if (audienceEdit) {\n const audienceEditCard = audienceEdit.closest(reportSelectors.regions.audienceCard);\n\n event.preventDefault();\n editAudienceCard(audienceEditCard);\n }\n\n // Delete instance.\n const audienceDelete = event.target.closest(reportSelectors.actions.audienceDelete);\n if (audienceDelete) {\n event.preventDefault();\n deleteAudienceCard(audienceDelete);\n }\n });\n\n initialized = true;\n};\n"],"names":["reportId","contextId","initAudienceCardForm","audienceCard","audienceFormContainer","querySelector","reportSelectors","regions","audienceForm","DynamicForm","addEventListener","events","FORM_SUBMITTED","data","audienceHeading","audienceDescription","dataset","audienceId","detail","instanceid","innerHTML","heading","description","closeAudienceCardForm","then","addToast","FORM_CANCELLED","removeAudienceCard","NewAudienceFormContainer","cloneNode","replaceChild","classList","remove","actions","audienceEdit","disabled","audienceDelete","audienceCards","document","audiencesContainer","querySelectorAll","length","audienceEmptyMessage","audienceFirstCardSeparator","initialized","id","contextid","event","audienceAdd","target","closest","preventDefault","className","title","pendingPromise","Pending","audienceCardLength","params","classname","reportid","showormessage","html","js","Templates","appendNodeContents","getFormNode","add","resolve","catch","Notification","exception","addAudienceCard","uniqueIdentifier","name","audienceEditCard","load","editAudienceCard","audienceTitle","audienceEditWarning","audienceDeleteConfirmation","saveCancelPromise","triggerElement","deleteAudienceCard"],"mappings":"6vDAsCIA,SAAW,EACXC,UAAY,QAsEVC,qBAAuBC,qBACnBC,sBAAwBD,aAAaE,cAAcC,gBAAgBC,QAAQH,uBAC3EI,aAAe,IAAIC,qBAAYL,sBAAuB,+CAG5DI,aAAaE,iBAAiBF,aAAaG,OAAOC,gBAAgBC,aACxDC,gBAAkBX,aAAaE,cAAcC,gBAAgBC,QAAQO,iBACrEC,oBAAsBZ,aAAaE,cAAcC,gBAAgBC,QAAQQ,4BAE/EZ,aAAaa,QAAQC,WAAaJ,KAAKK,OAAOC,WAE9CL,gBAAgBM,UAAYP,KAAKK,OAAOG,QACxCN,oBAAoBK,UAAYP,KAAKK,OAAOI,YAE5CC,sBAAsBpB,eAEf,kBAAU,gBAAiB,sBAC7BqB,KAAKC,eAIdjB,aAAaE,iBAAiBF,aAAaG,OAAOe,gBAAgB,KAC1DvB,aAAaa,QAAQC,WAAa,EAClCM,sBAAsBpB,cAEtBwB,mBAAmBxB,iBAIpBK,cAwCLe,sBAAwBpB,qBAEpBC,sBAAwBD,aAAaE,cAAcC,gBAAgBC,QAAQH,uBAC3EwB,yBAA2BxB,sBAAsByB,WAAU,GACjE1B,aAAaE,cAAcC,gBAAgBC,QAAQC,cAAcsB,aAAaF,yBAA0BxB,uBAExGD,aAAaE,cAAcC,gBAAgBC,QAAQQ,qBAAqBgB,UAAUC,OAAO,UACzF7B,aAAaE,cAAcC,gBAAgB2B,QAAQC,cAAcC,UAAW,EAC5EhC,aAAaE,cAAcC,gBAAgB2B,QAAQG,gBAAgBD,UAAW,GAQ5ER,mBAAqBxB,eACvBA,aAAa6B,eAGPK,cADqBC,SAASjC,cAAcC,gBAAgBC,QAAQgC,oBACjCC,iBAAiBlC,gBAAgBC,QAAQJ,iBAGrD,IAAzBkC,cAAcI,OAAc,CACCH,SAASjC,cAAcC,gBAAgBC,QAAQmC,sBACvDX,UAAUC,OAAO,cACnC,OACGW,2BAA6BN,cAAc,GAAGhC,cAAc,uBAClEsC,MAAAA,4BAAAA,2BAA4BX,eAIhCY,aAAc,gBAQE,CAACC,GAAIC,2CACL,qBAAsB,CAClC,gBACA,kBACA,gBACA,yBACA,iBACA,wDAGY,OAAQ,CACpB,WAGJ9C,SAAW6C,GACX5C,UAAY6C,UAERF,cAKJN,SAAS5B,iBAAiB,SAASqC,cAGzBC,YAAcD,MAAME,OAAOC,QAAQ5C,gBAAgB2B,QAAQe,aAC7DA,cACAD,MAAMI,iBAtMM,EAACC,UAAWC,eAC1BC,eAAiB,IAAIC,iBAAQ,mCAE7BhB,mBAAqBD,SAASjC,cAAcC,gBAAgBC,QAAQgC,oBACpEiB,mBAAqBjB,mBAAmBC,iBAAiBlC,gBAAgBC,QAAQJ,cAAcsC,OAE/FgB,OAAS,CACXC,UAAWN,UACXO,SAAU3D,SACV4D,cAAgBJ,mBAAqB,EACrCH,MAAOA,kCAIE,qBAAsB,gBAAiBpD,UAAWwD,QAC1DjC,MAAK,CAACqC,KAAMC,YACH3D,aAAe4D,mBAAUC,mBAAmBzB,mBAAoBsB,KAAMC,IAAI,GAC1EpB,qBAAuBH,mBAAmBlC,cAAcC,gBAAgBC,QAAQmC,sBAEhFlC,aAAeN,qBAAqBC,uDAE1BK,aAAayD,eAC7BvB,qBAAqBX,UAAUmC,IAAI,WAE5B,kBAAU,gBAAiB,qBAAsBb,UAE3D7B,KAAKC,YACLD,MAAK,IAAM8B,eAAea,YAC1BC,MAAMC,sBAAaC,YA2KhBC,CAAgBvB,YAAYhC,QAAQwD,iBAAkBxB,YAAYhC,QAAQyD,aAIxEvC,aAAea,MAAME,OAAOC,QAAQ5C,gBAAgB2B,QAAQC,iBAC9DA,aAAc,OACRwC,iBAAmBxC,aAAagB,QAAQ5C,gBAAgBC,QAAQJ,cAEtE4C,MAAMI,iBA3KOhD,CAAAA,qBACfmD,eAAiB,IAAIC,iBAAQ,oCAGdrD,qBAAqBC,cAC7BwE,KAAK,CAAC9B,GAAI1C,aAAaa,QAAQC,aACvCO,MAAK,WACIpB,sBAAwBD,aAAaE,cAAcC,gBAAgBC,QAAQH,uBAC3EW,oBAAsBZ,aAAaE,cAAcC,gBAAgBC,QAAQQ,qBACzEmB,aAAe/B,aAAaE,cAAcC,gBAAgB2B,QAAQC,qBAExE9B,sBAAsB2B,UAAUC,OAAO,UACvCjB,oBAAoBgB,UAAUmC,IAAI,UAClChC,aAAaC,UAAW,EAEjBmB,eAAea,aAEzBC,MAAMC,sBAAaC,YA2JhBM,CAAiBF,wBAIftC,eAAiBW,MAAME,OAAOC,QAAQ5C,gBAAgB2B,QAAQG,gBAChEA,iBACAW,MAAMI,iBAnHSf,CAAAA,uBACjBjC,aAAeiC,eAAec,QAAQ5C,gBAAgBC,QAAQJ,eAC9Dc,WAACA,WAAD4D,cAAaA,cAAbC,oBAA4BA,qBAAsB,GAAS3E,aAAaa,QAGxE+D,2BAA6BD,oBAAsB,yBAA2B,8CAEvEE,mBACT,kBAAU,iBAAkB,qBAAsBH,gBAClD,kBAAUE,2BAA4B,qBAAsBF,gBAC5D,kBAAU,SAAU,QACpB,CAACI,eAAgB7C,iBACnBZ,MAAK,WACG8B,eAAiB,IAAIC,iBAAQ,6CAE5B,6BAAevD,SAAUiB,YAC3BO,MAAK,KAAM,eAAS,kBAAU,kBAAmB,qBAAsBqD,kBACvErD,MAAK,KACFG,mBAAmBxB,cACZmD,eAAea,aAEzBC,MAAMC,sBAAaC,cACzBF,OAAM,UA8FDc,CAAmB9C,oBAI3BQ,aAAc"}PK a<�\�8d� amd/build/report.min.js.mapnu �[��� {"version":3,"file":"report.min.js","sources":["../src/report.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder report management\n *\n * @module core_reportbuilder/report\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Notification from 'core/notification';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {setPageNumber, refreshTableContent} from 'core_table/dynamic';\nimport * as tableSelectors from 'core_table/local/dynamic/selectors';\n\nconst CLASSES = {\n COLLAPSED: 'collapsed',\n EXPANDED: 'show',\n ICONUP: 'fa-angle-up',\n ICONDOWN: 'fa-angle-down'\n};\n\nlet initialized = false;\n\n/**\n * Initialise module for given report\n *\n * @method\n */\nexport const init = () => {\n\n if (initialized) {\n // We already added the event listeners (can be called multiple times by mustache template).\n return;\n }\n\n // Listen for the table reload event.\n document.addEventListener(reportEvents.tableReload, async(event) => {\n const reportElement = event.target.closest(reportSelectors.regions.report);\n if (reportElement === null) {\n return;\n }\n\n const tableRoot = reportElement.querySelector(tableSelectors.main.region);\n const pageNumber = event.detail?.preservePagination ? null : 1;\n\n await setPageNumber(tableRoot, pageNumber, false)\n .then(refreshTableContent)\n .then(() => {\n // TODO: Refactor this after MDL-73130 lands.\n const preserveTriggerElement = event.detail?.preserveTriggerElement;\n if (preserveTriggerElement) {\n reportElement.querySelector(preserveTriggerElement)?.focus();\n }\n return;\n })\n .catch(Notification.exception);\n });\n\n // Listen for trigger popup events.\n document.addEventListener('click', event => {\n const reportActionPopup = event.target.closest(reportSelectors.actions.reportActionPopup);\n if (reportActionPopup === null) {\n return;\n }\n event.preventDefault();\n const popupAction = JSON.parse(reportActionPopup.dataset.popupAction);\n window.openpopup(event, popupAction.jsfunctionargs);\n });\n\n // Listen for card view toggle events.\n document.addEventListener('click', (event) => {\n const toggleCard = event.target.closest(reportSelectors.actions.toggleCardView);\n if (toggleCard) {\n const tableCard = toggleCard.closest('tr');\n const toggleIcon = toggleCard.querySelector('i');\n event.preventDefault();\n if (toggleCard.classList.contains(CLASSES.COLLAPSED)) {\n tableCard.classList.add(CLASSES.EXPANDED);\n toggleIcon.classList.replace(CLASSES.ICONDOWN, CLASSES.ICONUP);\n toggleCard.classList.remove(CLASSES.COLLAPSED);\n toggleCard.setAttribute('aria-expanded', \"true\");\n } else {\n tableCard.classList.remove(CLASSES.EXPANDED);\n toggleIcon.classList.replace(CLASSES.ICONUP, CLASSES.ICONDOWN);\n toggleCard.classList.add(CLASSES.COLLAPSED);\n toggleCard.removeAttribute('aria-expanded');\n }\n }\n });\n\n initialized = true;\n};\n"],"names":["CLASSES","initialized","document","addEventListener","reportEvents","tableReload","async","reportElement","event","target","closest","reportSelectors","regions","report","tableRoot","querySelector","tableSelectors","main","region","pageNumber","detail","preservePagination","then","refreshTableContent","preserveTriggerElement","_event$detail2","focus","catch","Notification","exception","reportActionPopup","actions","preventDefault","popupAction","JSON","parse","dataset","window","openpopup","jsfunctionargs","toggleCard","toggleCardView","tableCard","toggleIcon","classList","contains","add","replace","remove","setAttribute","removeAttribute"],"mappings":";;;;;;;svCA6BMA,kBACS,YADTA,iBAEQ,OAFRA,eAGM,cAHNA,iBAIQ,oBAGVC,aAAc,gBAOE,KAEZA,cAMJC,SAASC,iBAAiBC,aAAaC,aAAaC,MAAAA,gCAC1CC,cAAgBC,MAAMC,OAAOC,QAAQC,gBAAgBC,QAAQC,WAC7C,OAAlBN,2BAIEO,UAAYP,cAAcQ,cAAcC,eAAeC,KAAKC,QAC5DC,iCAAaX,MAAMY,+CAAQC,mBAAqB,KAAO,QAEvD,0BAAcP,UAAWK,YAAY,GACtCG,KAAKC,8BACLD,MAAK,8BAEIE,8CAAyBhB,MAAMY,wCAANK,eAAcD,iDACzCA,uDACAjB,cAAcQ,cAAcS,gFAAyBE,YAI5DC,MAAMC,sBAAaC,cAI5B3B,SAASC,iBAAiB,SAASK,cACzBsB,kBAAoBtB,MAAMC,OAAOC,QAAQC,gBAAgBoB,QAAQD,sBAC7C,OAAtBA,yBAGJtB,MAAMwB,uBACAC,YAAcC,KAAKC,MAAML,kBAAkBM,QAAQH,aACzDI,OAAOC,UAAU9B,MAAOyB,YAAYM,mBAIxCrC,SAASC,iBAAiB,SAAUK,cAC1BgC,WAAahC,MAAMC,OAAOC,QAAQC,gBAAgBoB,QAAQU,mBAC5DD,WAAY,OACNE,UAAYF,WAAW9B,QAAQ,MAC/BiC,WAAaH,WAAWzB,cAAc,KAC5CP,MAAMwB,iBACFQ,WAAWI,UAAUC,SAAS7C,oBAC9B0C,UAAUE,UAAUE,IAAI9C,kBACxB2C,WAAWC,UAAUG,QAAQ/C,iBAAkBA,gBAC/CwC,WAAWI,UAAUI,OAAOhD,mBAC5BwC,WAAWS,aAAa,gBAAiB,UAEzCP,UAAUE,UAAUI,OAAOhD,kBAC3B2C,WAAWC,UAAUG,QAAQ/C,eAAgBA,kBAC7CwC,WAAWI,UAAUE,IAAI9C,mBACzBwC,WAAWU,gBAAgB,sBAKvCjD,aAAc"}PK a<�\O`�)� � + amd/build/local/repository/schedules.min.jsnu �[��� define("core_reportbuilder/local/repository/schedules",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle schedule AJAX requests * * @module core_reportbuilder/local/repository/schedules * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.toggleSchedule=_exports.sendSchedule=_exports.deleteSchedule=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.deleteSchedule=(reportId,scheduleId)=>{const request={methodname:"core_reportbuilder_schedules_delete",args:{reportid:reportId,scheduleid:scheduleId}};return _ajax.default.call([request])[0]};_exports.sendSchedule=(reportId,scheduleId)=>{const request={methodname:"core_reportbuilder_schedules_send",args:{reportid:reportId,scheduleid:scheduleId}};return _ajax.default.call([request])[0]};_exports.toggleSchedule=(reportId,scheduleId,scheduleEnabled)=>{const request={methodname:"core_reportbuilder_schedules_toggle",args:{reportid:reportId,scheduleid:scheduleId,enabled:scheduleEnabled}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=schedules.min.js.mapPK a<�\6��a� � ) amd/build/local/repository/sorting.min.jsnu �[��� define("core_reportbuilder/local/repository/sorting",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle column sorting AJAX requests * * @module core_reportbuilder/local/repository/sorting * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.toggleColumnSorting=_exports.reorderColumnSorting=_exports.getColumnSorting=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.getColumnSorting=reportId=>{const request={methodname:"core_reportbuilder_columns_sort_get",args:{reportid:reportId}};return _ajax.default.call([request])[0]};_exports.reorderColumnSorting=(reportId,columnId,position)=>{const request={methodname:"core_reportbuilder_columns_sort_reorder",args:{reportid:reportId,columnid:columnId,position:position}};return _ajax.default.call([request])[0]};_exports.toggleColumnSorting=(reportId,columnId,enabled,direction)=>{const request={methodname:"core_reportbuilder_columns_sort_toggle",args:{reportid:reportId,columnid:columnId,enabled:enabled,direction:direction}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=sorting.min.js.mapPK a<�\f苜} } - amd/build/local/repository/reports.min.js.mapnu �[��� {"version":3,"file":"reports.min.js","sources":["../../../src/local/repository/reports.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle report AJAX requests\n *\n * @module core_reportbuilder/local/repository/reports\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Delete given report\n *\n * @param {Number} reportId\n * @return {Promise}\n */\nexport const deleteReport = reportId => {\n const request = {\n methodname: 'core_reportbuilder_reports_delete',\n args: {reportid: reportId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Get report content\n *\n * @param {Number} reportId\n * @param {Boolean} editMode\n * @param {Number} [pageSize=0]\n * @return {Promise}\n */\nexport const getReport = (reportId, editMode, pageSize = 0) => {\n const request = {\n methodname: 'core_reportbuilder_reports_get',\n args: {reportid: reportId, editmode: editMode, pagesize: pageSize}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","request","methodname","args","reportid","Ajax","call","editMode","pageSize","editmode","pagesize"],"mappings":";;;;;;;uLA+B4BA,iBAClBC,QAAU,CACZC,WAAY,oCACZC,KAAM,CAACC,SAAUJ,kBAGdK,cAAKC,KAAK,CAACL,UAAU,uBAWP,SAACD,SAAUO,cAAUC,gEAAW,QAC/CP,QAAU,CACZC,WAAY,iCACZC,KAAM,CAACC,SAAUJ,SAAUS,SAAUF,SAAUG,SAAUF,kBAGtDH,cAAKC,KAAK,CAACL,UAAU"}PK a<�\y � � � , amd/build/local/repository/modals.min.js.mapnu �[��� {"version":3,"file":"modals.min.js","sources":["../../../src/local/repository/modals.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle modal form requests\n *\n * @module core_reportbuilder/local/repository/modals\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport ModalForm from 'core_form/modalform';\nimport {getString} from 'core/str';\n\n/**\n * Return modal instance\n *\n * @param {EventTarget} triggerElement\n * @param {Promise} modalTitle\n * @param {String} formClass\n * @param {Object} formArgs\n * @return {ModalForm}\n */\nconst createModalForm = (triggerElement, modalTitle, formClass, formArgs) => {\n return new ModalForm({\n modalConfig: {\n title: modalTitle,\n },\n formClass: formClass,\n args: formArgs,\n saveButtonText: getString('save', 'moodle'),\n returnFocus: triggerElement,\n });\n};\n\n/**\n * Return report modal instance\n *\n * @param {EventTarget} triggerElement\n * @param {Promise} modalTitle\n * @param {Number} reportId\n * @return {ModalForm}\n */\nexport const createReportModal = (triggerElement, modalTitle, reportId = 0) => {\n return createModalForm(triggerElement, modalTitle, 'core_reportbuilder\\\\form\\\\report', {\n id: reportId,\n });\n};\n\n/**\n * Return schedule modal instance\n *\n * @param {EventTarget} triggerElement\n * @param {Promise} modalTitle\n * @param {Number} reportId\n * @param {Number} scheduleId\n * @return {ModalForm}\n */\nexport const createScheduleModal = (triggerElement, modalTitle, reportId, scheduleId = 0) => {\n return createModalForm(triggerElement, modalTitle, 'core_reportbuilder\\\\form\\\\schedule', {\n reportid: reportId,\n id: scheduleId,\n });\n};\n"],"names":["createModalForm","triggerElement","modalTitle","formClass","formArgs","ModalForm","modalConfig","title","args","saveButtonText","returnFocus","reportId","id","scheduleId","reportid"],"mappings":";;;;;;;gMAmCMA,gBAAkB,CAACC,eAAgBC,WAAYC,UAAWC,WACrD,IAAIC,mBAAU,CACjBC,YAAa,CACTC,MAAOL,YAEXC,UAAWA,UACXK,KAAMJ,SACNK,gBAAgB,kBAAU,OAAQ,UAClCC,YAAaT,4CAYY,SAACA,eAAgBC,gBAAYS,gEAAW,SAC9DX,gBAAgBC,eAAgBC,WAAY,mCAAoC,CACnFU,GAAID,yCAauB,SAACV,eAAgBC,WAAYS,cAAUE,kEAAa,SAC5Eb,gBAAgBC,eAAgBC,WAAY,qCAAsC,CACrFY,SAAUH,SACVC,GAAIC"}PK a<�\U��� � ) amd/build/local/repository/reports.min.jsnu �[��� define("core_reportbuilder/local/repository/reports",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle report AJAX requests * * @module core_reportbuilder/local/repository/reports * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.getReport=_exports.deleteReport=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.deleteReport=reportId=>{const request={methodname:"core_reportbuilder_reports_delete",args:{reportid:reportId}};return _ajax.default.call([request])[0]};_exports.getReport=function(reportId,editMode){let pageSize=arguments.length>2&&void 0!==arguments[2]?arguments[2]:0;const request={methodname:"core_reportbuilder_reports_get",args:{reportid:reportId,editmode:editMode,pagesize:pageSize}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=reports.min.js.mapPK a<�\D�� � ) amd/build/local/repository/filters.min.jsnu �[��� define("core_reportbuilder/local/repository/filters",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle filter AJAX requests * * @module core_reportbuilder/local/repository/filters * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.setFilters=_exports.resetFilters=_exports.reorderFilter=_exports.deleteFilter=_exports.addFilter=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.resetFilters=(reportId,reportParameters)=>{const request={methodname:"core_reportbuilder_filters_reset",args:{reportid:reportId,parameters:reportParameters}};return _ajax.default.call([request])[0]};_exports.setFilters=(reportId,reportParameters,filterValues)=>{const request={methodname:"core_reportbuilder_set_filters",args:{reportid:reportId,parameters:reportParameters,values:filterValues}};return _ajax.default.call([request])[0]};_exports.addFilter=(reportId,uniqueIdentifier)=>{const request={methodname:"core_reportbuilder_filters_add",args:{reportid:reportId,uniqueidentifier:uniqueIdentifier}};return _ajax.default.call([request])[0]};_exports.deleteFilter=(reportId,filterId)=>{const request={methodname:"core_reportbuilder_filters_delete",args:{reportid:reportId,filterid:filterId}};return _ajax.default.call([request])[0]};_exports.reorderFilter=(reportId,filterId,position)=>{const request={methodname:"core_reportbuilder_filters_reorder",args:{reportid:reportId,filterid:filterId,position:position}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=filters.min.js.mapPK a<�\���J� � ) amd/build/local/repository/columns.min.jsnu �[��� define("core_reportbuilder/local/repository/columns",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle column AJAX requests * * @module core_reportbuilder/local/repository/columns * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.reorderColumn=_exports.deleteColumn=_exports.addColumn=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.addColumn=(reportId,uniqueIdentifier)=>{const request={methodname:"core_reportbuilder_columns_add",args:{reportid:reportId,uniqueidentifier:uniqueIdentifier}};return _ajax.default.call([request])[0]};_exports.deleteColumn=(reportId,columnId)=>{const request={methodname:"core_reportbuilder_columns_delete",args:{reportid:reportId,columnid:columnId}};return _ajax.default.call([request])[0]};_exports.reorderColumn=(reportId,columnId,position)=>{const request={methodname:"core_reportbuilder_columns_reorder",args:{reportid:reportId,columnid:columnId,position:position}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=columns.min.js.mapPK a<�\'Wv5� � - amd/build/local/repository/filters.min.js.mapnu �[��� {"version":3,"file":"filters.min.js","sources":["../../../src/local/repository/filters.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle filter AJAX requests\n *\n * @module core_reportbuilder/local/repository/filters\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Reset all filters for given report\n *\n * @method\n * @param {Number} reportId\n * @param {String} reportParameters\n * @return {Promise}\n */\nexport const resetFilters = (reportId, reportParameters) => {\n const request = {\n methodname: 'core_reportbuilder_filters_reset',\n args: {reportid: reportId, parameters: reportParameters}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Set filter values for given report\n *\n * @method\n * @param {Number} reportId\n * @param {String} reportParameters\n * @param {String} filterValues\n * @return {Promise}\n */\nexport const setFilters = (reportId, reportParameters, filterValues) => {\n const request = {\n methodname: 'core_reportbuilder_set_filters',\n args: {reportid: reportId, parameters: reportParameters, values: filterValues}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Add a filter to the given report\n *\n * @param {Number} reportId\n * @param {String} uniqueIdentifier\n * @return {Promise}\n */\nexport const addFilter = (reportId, uniqueIdentifier) => {\n const request = {\n methodname: 'core_reportbuilder_filters_add',\n args: {reportid: reportId, uniqueidentifier: uniqueIdentifier}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Remove filter from given report\n *\n * @param {Number} reportId\n * @param {Number} filterId\n * @return {Promise}\n */\nexport const deleteFilter = (reportId, filterId) => {\n const request = {\n methodname: 'core_reportbuilder_filters_delete',\n args: {reportid: reportId, filterid: filterId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Reorder a filter in a given report\n *\n * @param {Number} reportId\n * @param {Number} filterId\n * @param {Number} position\n * @return {Promise}\n */\nexport const reorderFilter = (reportId, filterId, position) => {\n const request = {\n methodname: 'core_reportbuilder_filters_reorder',\n args: {reportid: reportId, filterid: filterId, position: position}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","reportParameters","request","methodname","args","reportid","parameters","Ajax","call","filterValues","values","uniqueIdentifier","uniqueidentifier","filterId","filterid","position"],"mappings":";;;;;;;wPAiC4B,CAACA,SAAUC,0BAC7BC,QAAU,CACZC,WAAY,mCACZC,KAAM,CAACC,SAAUL,SAAUM,WAAYL,0BAGpCM,cAAKC,KAAK,CAACN,UAAU,wBAYN,CAACF,SAAUC,iBAAkBQ,sBAC7CP,QAAU,CACZC,WAAY,iCACZC,KAAM,CAACC,SAAUL,SAAUM,WAAYL,iBAAkBS,OAAQD,sBAG9DF,cAAKC,KAAK,CAACN,UAAU,uBAUP,CAACF,SAAUW,0BAC1BT,QAAU,CACZC,WAAY,iCACZC,KAAM,CAACC,SAAUL,SAAUY,iBAAkBD,0BAG1CJ,cAAKC,KAAK,CAACN,UAAU,0BAUJ,CAACF,SAAUa,kBAC7BX,QAAU,CACZC,WAAY,oCACZC,KAAM,CAACC,SAAUL,SAAUc,SAAUD,kBAGlCN,cAAKC,KAAK,CAACN,UAAU,2BAWH,CAACF,SAAUa,SAAUE,kBACxCb,QAAU,CACZC,WAAY,qCACZC,KAAM,CAACC,SAAUL,SAAUc,SAAUD,SAAUE,SAAUA,kBAGtDR,cAAKC,KAAK,CAACN,UAAU"}PK a<�\�&[5 / amd/build/local/repository/schedules.min.js.mapnu �[��� {"version":3,"file":"schedules.min.js","sources":["../../../src/local/repository/schedules.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle schedule AJAX requests\n *\n * @module core_reportbuilder/local/repository/schedules\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Delete schedule\n *\n * @method\n * @param {Number} reportId\n * @param {Number} scheduleId\n * @return {Promise}\n */\nexport const deleteSchedule = (reportId, scheduleId) => {\n const request = {\n methodname: 'core_reportbuilder_schedules_delete',\n args: {reportid: reportId, scheduleid: scheduleId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Send schedule\n *\n * @method\n * @param {Number} reportId\n * @param {Number} scheduleId\n * @return {Promise}\n */\nexport const sendSchedule = (reportId, scheduleId) => {\n const request = {\n methodname: 'core_reportbuilder_schedules_send',\n args: {reportid: reportId, scheduleid: scheduleId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Toggle schedule enabled\n *\n * @method\n * @param {Number} reportId\n * @param {Number} scheduleId\n * @param {Boolean} scheduleEnabled\n * @return {Promise}\n */\nexport const toggleSchedule = (reportId, scheduleId, scheduleEnabled) => {\n const request = {\n methodname: 'core_reportbuilder_schedules_toggle',\n args: {reportid: reportId, scheduleid: scheduleId, enabled: scheduleEnabled}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","scheduleId","request","methodname","args","reportid","scheduleid","Ajax","call","scheduleEnabled","enabled"],"mappings":";;;;;;;sNAiC8B,CAACA,SAAUC,oBAC/BC,QAAU,CACZC,WAAY,sCACZC,KAAM,CAACC,SAAUL,SAAUM,WAAYL,oBAGpCM,cAAKC,KAAK,CAACN,UAAU,0BAWJ,CAACF,SAAUC,oBAC7BC,QAAU,CACZC,WAAY,oCACZC,KAAM,CAACC,SAAUL,SAAUM,WAAYL,oBAGpCM,cAAKC,KAAK,CAACN,UAAU,4BAYF,CAACF,SAAUC,WAAYQ,yBAC3CP,QAAU,CACZC,WAAY,sCACZC,KAAM,CAACC,SAAUL,SAAUM,WAAYL,WAAYS,QAASD,yBAGzDF,cAAKC,KAAK,CAACN,UAAU"}PK a<�\�ۡ�N N ( amd/build/local/repository/modals.min.jsnu �[��� define("core_reportbuilder/local/repository/modals",["exports","core_form/modalform","core/str"],(function(_exports,_modalform,_str){var obj; /** * Module to handle modal form requests * * @module core_reportbuilder/local/repository/modals * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.createScheduleModal=_exports.createReportModal=void 0,_modalform=(obj=_modalform)&&obj.__esModule?obj:{default:obj};const createModalForm=(triggerElement,modalTitle,formClass,formArgs)=>new _modalform.default({modalConfig:{title:modalTitle},formClass:formClass,args:formArgs,saveButtonText:(0,_str.getString)("save","moodle"),returnFocus:triggerElement});_exports.createReportModal=function(triggerElement,modalTitle){let reportId=arguments.length>2&&void 0!==arguments[2]?arguments[2]:0;return createModalForm(triggerElement,modalTitle,"core_reportbuilder\\form\\report",{id:reportId})};_exports.createScheduleModal=function(triggerElement,modalTitle,reportId){let scheduleId=arguments.length>3&&void 0!==arguments[3]?arguments[3]:0;return createModalForm(triggerElement,modalTitle,"core_reportbuilder\\form\\schedule",{reportid:reportId,id:scheduleId})}})); //# sourceMappingURL=modals.min.js.mapPK a<�\�-�� � , amd/build/local/repository/conditions.min.jsnu �[��� define("core_reportbuilder/local/repository/conditions",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle condition AJAX requests * * @module core_reportbuilder/local/repository/conditions * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.resetConditions=_exports.reorderCondition=_exports.deleteCondition=_exports.addCondition=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.resetConditions=reportId=>{const request={methodname:"core_reportbuilder_conditions_reset",args:{reportid:reportId}};return _ajax.default.call([request])[0]};_exports.addCondition=(reportId,uniqueIdentifier)=>{const request={methodname:"core_reportbuilder_conditions_add",args:{reportid:reportId,uniqueidentifier:uniqueIdentifier}};return _ajax.default.call([request])[0]};_exports.deleteCondition=(reportId,conditionId)=>{const request={methodname:"core_reportbuilder_conditions_delete",args:{reportid:reportId,conditionid:conditionId}};return _ajax.default.call([request])[0]};_exports.reorderCondition=(reportId,conditionId,position)=>{const request={methodname:"core_reportbuilder_conditions_reorder",args:{reportid:reportId,conditionid:conditionId,position:position}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=conditions.min.js.mapPK a<�\A�� � 0 amd/build/local/repository/conditions.min.js.mapnu �[��� {"version":3,"file":"conditions.min.js","sources":["../../../src/local/repository/conditions.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle condition AJAX requests\n *\n * @module core_reportbuilder/local/repository/conditions\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Reset all conditions for given report\n *\n * @param {Number} reportId\n * @return {Promise}\n */\nexport const resetConditions = reportId => {\n const request = {\n methodname: 'core_reportbuilder_conditions_reset',\n args: {reportid: reportId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Add condition to given report\n *\n * @param {Number} reportId\n * @param {String} uniqueIdentifier\n * @return {Promise}\n */\nexport const addCondition = (reportId, uniqueIdentifier) => {\n const request = {\n methodname: 'core_reportbuilder_conditions_add',\n args: {reportid: reportId, uniqueidentifier: uniqueIdentifier}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Remove condition from given report\n *\n * @param {Number} reportId\n * @param {Number} conditionId\n * @return {Promise}\n */\nexport const deleteCondition = (reportId, conditionId) => {\n const request = {\n methodname: 'core_reportbuilder_conditions_delete',\n args: {reportid: reportId, conditionid: conditionId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Reorder a condition in a given report\n *\n * @param {Number} reportId\n * @param {Number} conditionId\n * @param {Number} position\n * @return {Promise}\n */\nexport const reorderCondition = (reportId, conditionId, position) => {\n const request = {\n methodname: 'core_reportbuilder_conditions_reorder',\n args: {reportid: reportId, conditionid: conditionId, position: position}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","request","methodname","args","reportid","Ajax","call","uniqueIdentifier","uniqueidentifier","conditionId","conditionid","position"],"mappings":";;;;;;;mPA+B+BA,iBACrBC,QAAU,CACZC,WAAY,sCACZC,KAAM,CAACC,SAAUJ,kBAGdK,cAAKC,KAAK,CAACL,UAAU,0BAUJ,CAACD,SAAUO,0BAC7BN,QAAU,CACZC,WAAY,oCACZC,KAAM,CAACC,SAAUJ,SAAUQ,iBAAkBD,0BAG1CF,cAAKC,KAAK,CAACL,UAAU,6BAUD,CAACD,SAAUS,qBAChCR,QAAU,CACZC,WAAY,uCACZC,KAAM,CAACC,SAAUJ,SAAUU,YAAaD,qBAGrCJ,cAAKC,KAAK,CAACL,UAAU,8BAWA,CAACD,SAAUS,YAAaE,kBAC9CV,QAAU,CACZC,WAAY,wCACZC,KAAM,CAACC,SAAUJ,SAAUU,YAAaD,YAAaE,SAAUA,kBAG5DN,cAAKC,KAAK,CAACL,UAAU"}PK a<�\��p�� � + amd/build/local/repository/audiences.min.jsnu �[��� define("core_reportbuilder/local/repository/audiences",["exports","core/ajax"],(function(_exports,_ajax){var obj; /** * Module to handle audiences AJAX requests * * @module core_reportbuilder/local/repository/audiences * @copyright 2021 David Matamoros <davidmc@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.deleteAudience=void 0,_ajax=(obj=_ajax)&&obj.__esModule?obj:{default:obj};_exports.deleteAudience=(reportId,instanceId)=>{const request={methodname:"core_reportbuilder_audiences_delete",args:{reportid:reportId,instanceid:instanceId}};return _ajax.default.call([request])[0]}})); //# sourceMappingURL=audiences.min.js.mapPK a<�\4��Ѿ � / amd/build/local/repository/audiences.min.js.mapnu �[��� {"version":3,"file":"audiences.min.js","sources":["../../../src/local/repository/audiences.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle audiences AJAX requests\n *\n * @module core_reportbuilder/local/repository/audiences\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Remove audience from given report\n *\n * @param {Number} reportId\n * @param {Number} instanceId\n * @return {Promise}\n */\nexport const deleteAudience = (reportId, instanceId) => {\n const request = {\n methodname: 'core_reportbuilder_audiences_delete',\n args: {reportid: reportId, instanceid: instanceId}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","instanceId","request","methodname","args","reportid","instanceid","Ajax","call"],"mappings":";;;;;;;wKAgC8B,CAACA,SAAUC,oBAC/BC,QAAU,CACZC,WAAY,sCACZC,KAAM,CAACC,SAAUL,SAAUM,WAAYL,oBAGpCM,cAAKC,KAAK,CAACN,UAAU"}PK a<�\ 7̍> > - amd/build/local/repository/sorting.min.js.mapnu �[��� {"version":3,"file":"sorting.min.js","sources":["../../../src/local/repository/sorting.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle column sorting AJAX requests\n *\n * @module core_reportbuilder/local/repository/sorting\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Retrieve column sorting\n *\n * @param {Number} reportId\n * @return {Promise}\n */\nexport const getColumnSorting = reportId => {\n const request = {\n methodname: 'core_reportbuilder_columns_sort_get',\n args: {reportid: reportId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Re-order sort column position\n *\n * @param {Number} reportId\n * @param {Number} columnId\n * @param {Number} position\n * @return {Promise}\n */\nexport const reorderColumnSorting = (reportId, columnId, position) => {\n const request = {\n methodname: 'core_reportbuilder_columns_sort_reorder',\n args: {reportid: reportId, columnid: columnId, position: position}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Enables/disabled sorting on column\n *\n * @param {Number} reportId\n * @param {Number} columnId\n * @param {Boolean} enabled\n * @param {Number} direction\n * @return {Promise}\n */\nexport const toggleColumnSorting = (reportId, columnId, enabled, direction) => {\n const request = {\n methodname: 'core_reportbuilder_columns_sort_toggle',\n args: {reportid: reportId, columnid: columnId, enabled: enabled, direction: direction}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","request","methodname","args","reportid","Ajax","call","columnId","position","columnid","enabled","direction"],"mappings":";;;;;;;uOA+BgCA,iBACtBC,QAAU,CACZC,WAAY,sCACZC,KAAM,CAACC,SAAUJ,kBAGdK,cAAKC,KAAK,CAACL,UAAU,kCAWI,CAACD,SAAUO,SAAUC,kBAC/CP,QAAU,CACZC,WAAY,0CACZC,KAAM,CAACC,SAAUJ,SAAUS,SAAUF,SAAUC,SAAUA,kBAGtDH,cAAKC,KAAK,CAACL,UAAU,iCAYG,CAACD,SAAUO,SAAUG,QAASC,mBACvDV,QAAU,CACZC,WAAY,yCACZC,KAAM,CAACC,SAAUJ,SAAUS,SAAUF,SAAUG,QAASA,QAASC,UAAWA,mBAGzEN,cAAKC,KAAK,CAACL,UAAU"}PK a<�\��f0� � - amd/build/local/repository/columns.min.js.mapnu �[��� {"version":3,"file":"columns.min.js","sources":["../../../src/local/repository/columns.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Module to handle column AJAX requests\n *\n * @module core_reportbuilder/local/repository/columns\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\nimport Ajax from 'core/ajax';\n\n/**\n * Add column to given report\n *\n * @param {Number} reportId\n * @param {String} uniqueIdentifier\n * @return {Promise}\n */\nexport const addColumn = (reportId, uniqueIdentifier) => {\n const request = {\n methodname: 'core_reportbuilder_columns_add',\n args: {reportid: reportId, uniqueidentifier: uniqueIdentifier}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Remove column from given report\n *\n * @param {Number} reportId\n * @param {Number} columnId\n * @return {Promise}\n */\nexport const deleteColumn = (reportId, columnId) => {\n const request = {\n methodname: 'core_reportbuilder_columns_delete',\n args: {reportid: reportId, columnid: columnId}\n };\n\n return Ajax.call([request])[0];\n};\n\n/**\n * Re-order column within a report\n *\n * @param {Number} reportId\n * @param {Number} columnId\n * @param {Number} position\n * @return {Promise}\n */\nexport const reorderColumn = (reportId, columnId, position) => {\n const request = {\n methodname: 'core_reportbuilder_columns_reorder',\n args: {reportid: reportId, columnid: columnId, position: position}\n };\n\n return Ajax.call([request])[0];\n};\n"],"names":["reportId","uniqueIdentifier","request","methodname","args","reportid","uniqueidentifier","Ajax","call","columnId","columnid","position"],"mappings":";;;;;;;2MAgCyB,CAACA,SAAUC,0BAC1BC,QAAU,CACZC,WAAY,iCACZC,KAAM,CAACC,SAAUL,SAAUM,iBAAkBL,0BAG1CM,cAAKC,KAAK,CAACN,UAAU,0BAUJ,CAACF,SAAUS,kBAC7BP,QAAU,CACZC,WAAY,oCACZC,KAAM,CAACC,SAAUL,SAAUU,SAAUD,kBAGlCF,cAAKC,KAAK,CAACN,UAAU,2BAWH,CAACF,SAAUS,SAAUE,kBACxCT,QAAU,CACZC,WAAY,qCACZC,KAAM,CAACC,SAAUL,SAAUU,SAAUD,SAAUE,SAAUA,kBAGtDJ,cAAKC,KAAK,CAACN,UAAU"}PK a<�\�|KZ� � $ amd/build/local/selectors.min.js.mapnu �[��� {"version":3,"file":"selectors.min.js","sources":["../../src/local/selectors.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder selectors\n *\n * @module core_reportbuilder/local/selectors\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n/**\n * Selectors for the Report builder subsystem\n *\n * @property {Object} regions\n * @property {String} regions.systemReport System report page region\n * @property {String} regions.filterButtonLabel Filters form toggle region\n * @property {String} regions.filtersForm Filters form page region\n */\nconst SELECTORS = {\n regions: {\n report: '[data-region=\"core_reportbuilder/report\"]',\n reportTable: '[data-region=\"reportbuilder-table\"]',\n columnHeader: '[data-region=\"column-header\"]',\n filterButtonLabel: '[data-region=\"filter-button-label\"]',\n filtersForm: '[data-region=\"filters-form\"]',\n sidebarMenu: '[data-region=\"sidebar-menu\"]',\n sidebarCard: '[data-region=\"sidebar-card\"]',\n sidebarItem: '[data-region=\"sidebar-item\"]',\n settingsConditions: '[data-region=\"settings-conditions\"]',\n activeConditions: '[data-region=\"active-conditions\"]',\n activeCondition: '[data-region=\"active-condition\"]',\n settingsFilters: '[data-region=\"settings-filters\"]',\n activeFilters: '[data-region=\"active-filters\"]',\n activeFilter: '[data-region=\"active-filter\"]',\n settingsSorting: '[data-region=\"settings-sorting\"]',\n audiencesContainer: '[data-region=\"audiences\"]',\n audienceFormContainer: '[data-region=\"audience-form-container\"]',\n audienceCard: '[data-region=\"audience-card\"]',\n audienceHeading: '[data-region=\"audience-heading\"]',\n audienceForm: '[data-region=\"audience-form\"]',\n audienceEmptyMessage: '[data-region=no-instances-message]',\n audienceDescription: '[data-region=audience-description]',\n audienceNotSavedLabel: '[data-region=audience-not-saved]',\n settingsCardView: '[data-region=\"settings-cardview\"]',\n },\n actions: {\n reportActionPopup: '[data-action=\"report-action-popup\"]',\n reportCreate: '[data-action=\"report-create\"]',\n reportEdit: '[data-action=\"report-edit\"]',\n reportDelete: '[data-action=\"report-delete\"]',\n reportAddColumn: '[data-action=\"report-add-column\"]',\n reportRemoveColumn: '[data-action=\"report-remove-column\"]',\n reportAddCondition: '[data-action=\"report-add-condition\"]',\n reportRemoveCondition: '[data-action=\"report-remove-condition\"]',\n reportAddFilter: '[data-action=\"report-add-filter\"]',\n reportRemoveFilter: '[data-action=\"report-remove-filter\"]',\n reportToggleColumnSort: '[data-action=\"report-toggle-column-sorting\"]',\n reportToggleColumnSortDirection: '[data-action=\"report-toggle-sort-direction\"]',\n sidebarSearch: '[data-action=\"sidebar-search\"]',\n toggleEditPreview: '[data-action=\"toggle-edit-preview\"]',\n audienceAdd: '[data-action=\"add-audience\"]',\n audienceEdit: '[data-action=\"edit-audience\"]',\n audienceDelete: '[data-action=\"delete-audience\"]',\n toggleCardView: '[data-action=\"toggle-card\"]',\n scheduleCreate: '[data-action=\"schedule-create\"]',\n scheduleToggle: '[data-action=\"schedule-toggle\"]',\n scheduleEdit: '[data-action=\"schedule-edit\"]',\n scheduleSend: '[data-action=\"schedule-send\"]',\n scheduleDelete: '[data-action=\"schedule-delete\"]',\n },\n};\n\n/**\n * Selector for given report\n *\n * @method forReport\n * @param {Number} reportId\n * @return {String}\n */\nSELECTORS.forReport = reportId => `${SELECTORS.regions.report}[data-report-id=\"${reportId}\"]`;\n\nexport default SELECTORS;\n"],"names":["SELECTORS","regions","report","reportTable","columnHeader","filterButtonLabel","filtersForm","sidebarMenu","sidebarCard","sidebarItem","settingsConditions","activeConditions","activeCondition","settingsFilters","activeFilters","activeFilter","settingsSorting","audiencesContainer","audienceFormContainer","audienceCard","audienceHeading","audienceForm","audienceEmptyMessage","audienceDescription","audienceNotSavedLabel","settingsCardView","actions","reportActionPopup","reportCreate","reportEdit","reportDelete","reportAddColumn","reportRemoveColumn","reportAddCondition","reportRemoveCondition","reportAddFilter","reportRemoveFilter","reportToggleColumnSort","reportToggleColumnSortDirection","sidebarSearch","toggleEditPreview","audienceAdd","audienceEdit","audienceDelete","toggleCardView","scheduleCreate","scheduleToggle","scheduleEdit","scheduleSend","scheduleDelete","reportId"],"mappings":";;;;;;;;MA+BMA,UAAY,CACdC,QAAS,CACLC,OAAQ,4CACRC,YAAa,sCACbC,aAAc,gCACdC,kBAAmB,sCACnBC,YAAa,+BACbC,YAAa,+BACbC,YAAa,+BACbC,YAAa,+BACbC,mBAAoB,sCACpBC,iBAAkB,oCAClBC,gBAAiB,mCACjBC,gBAAiB,mCACjBC,cAAe,iCACfC,aAAc,gCACdC,gBAAiB,mCACjBC,mBAAoB,4BACpBC,sBAAuB,0CACvBC,aAAc,gCACdC,gBAAiB,mCACjBC,aAAc,gCACdC,qBAAsB,qCACtBC,oBAAqB,qCACrBC,sBAAuB,mCACvBC,iBAAkB,qCAEtBC,QAAS,CACLC,kBAAmB,sCACnBC,aAAc,gCACdC,WAAY,8BACZC,aAAc,gCACdC,gBAAiB,oCACjBC,mBAAoB,uCACpBC,mBAAoB,uCACpBC,sBAAuB,0CACvBC,gBAAiB,oCACjBC,mBAAoB,uCACpBC,uBAAwB,+CACxBC,gCAAiC,+CACjCC,cAAe,iCACfC,kBAAmB,sCACnBC,YAAa,+BACbC,aAAc,gCACdC,eAAgB,kCAChBC,eAAgB,8BAChBC,eAAgB,kCAChBC,eAAgB,kCAChBC,aAAc,gCACdC,aAAc,gCACdC,eAAgB,mCAWxBjD,UAAsBkD,oBAAelD,UAAUC,QAAQC,mCAA0BgD,6BAElElD"}PK a<�\d�RF� � amd/build/local/selectors.min.jsnu �[��� define("core_reportbuilder/local/selectors",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0; /** * Report builder selectors * * @module core_reportbuilder/local/selectors * @copyright 2021 Paul Holden <paulh@moodle.com> * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ const SELECTORS={regions:{report:'[data-region="core_reportbuilder/report"]',reportTable:'[data-region="reportbuilder-table"]',columnHeader:'[data-region="column-header"]',filterButtonLabel:'[data-region="filter-button-label"]',filtersForm:'[data-region="filters-form"]',sidebarMenu:'[data-region="sidebar-menu"]',sidebarCard:'[data-region="sidebar-card"]',sidebarItem:'[data-region="sidebar-item"]',settingsConditions:'[data-region="settings-conditions"]',activeConditions:'[data-region="active-conditions"]',activeCondition:'[data-region="active-condition"]',settingsFilters:'[data-region="settings-filters"]',activeFilters:'[data-region="active-filters"]',activeFilter:'[data-region="active-filter"]',settingsSorting:'[data-region="settings-sorting"]',audiencesContainer:'[data-region="audiences"]',audienceFormContainer:'[data-region="audience-form-container"]',audienceCard:'[data-region="audience-card"]',audienceHeading:'[data-region="audience-heading"]',audienceForm:'[data-region="audience-form"]',audienceEmptyMessage:"[data-region=no-instances-message]",audienceDescription:"[data-region=audience-description]",audienceNotSavedLabel:"[data-region=audience-not-saved]",settingsCardView:'[data-region="settings-cardview"]'},actions:{reportActionPopup:'[data-action="report-action-popup"]',reportCreate:'[data-action="report-create"]',reportEdit:'[data-action="report-edit"]',reportDelete:'[data-action="report-delete"]',reportAddColumn:'[data-action="report-add-column"]',reportRemoveColumn:'[data-action="report-remove-column"]',reportAddCondition:'[data-action="report-add-condition"]',reportRemoveCondition:'[data-action="report-remove-condition"]',reportAddFilter:'[data-action="report-add-filter"]',reportRemoveFilter:'[data-action="report-remove-filter"]',reportToggleColumnSort:'[data-action="report-toggle-column-sorting"]',reportToggleColumnSortDirection:'[data-action="report-toggle-sort-direction"]',sidebarSearch:'[data-action="sidebar-search"]',toggleEditPreview:'[data-action="toggle-edit-preview"]',audienceAdd:'[data-action="add-audience"]',audienceEdit:'[data-action="edit-audience"]',audienceDelete:'[data-action="delete-audience"]',toggleCardView:'[data-action="toggle-card"]',scheduleCreate:'[data-action="schedule-create"]',scheduleToggle:'[data-action="schedule-toggle"]',scheduleEdit:'[data-action="schedule-edit"]',scheduleSend:'[data-action="schedule-send"]',scheduleDelete:'[data-action="schedule-delete"]'},forReport:reportId=>"".concat(SELECTORS.regions.report,'[data-report-id="').concat(reportId,'"]')};var _default=SELECTORS;return _exports.default=_default,_exports.default})); //# sourceMappingURL=selectors.min.js.mapPK a<�\?���P P ! amd/build/local/events.min.js.mapnu �[��� {"version":3,"file":"events.min.js","sources":["../../src/local/events.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder events\n *\n * @module core_reportbuilder/local/events\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n/**\n * Events for the Report builder subsystem\n *\n * @constant\n * @property {String} tableReload See {@link event:tableReload}\n */\nexport default {\n /**\n * Trigger table reloading\n *\n * @event tableReload\n * @type {CustomEvent}\n * @property {object} detail\n * @property {Boolean} detail.preservePagination Whether current pagination should be preserved (default false)\n * @property {String} detail.preserveTriggerElement Element selector that should be focused after table reload (default null)\n *\n * @example <caption>Triggering table reload</caption>\n * import {dispatchEvent} from 'core/event_dispatcher';\n * import * as reportEvents from 'core_reportbuilder/local/events';\n *\n * dispatchEvent(reportEvents.tableReload, {}, document.querySelector(...));\n */\n tableReload: 'core_reportbuilder_table_reload',\n publish: {\n reportColumnsUpdated: 'core_reportbuilder_report_columns_updated',\n },\n};\n"],"names":["tableReload","publish","reportColumnsUpdated"],"mappings":"iLA6Be,CAgBXA,YAAa,kCACbC,QAAS,CACLC,qBAAsB"}PK a<�\�97th h amd/build/local/events.min.jsnu �[��� define("core_reportbuilder/local/events",["exports"],(function(_exports){Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.default=void 0;return _exports.default={tableReload:"core_reportbuilder_table_reload",publish:{reportColumnsUpdated:"core_reportbuilder_report_columns_updated"}},_exports.default})); //# sourceMappingURL=events.min.js.mapPK a<�\�ZBps s % amd/build/local/editor/sorting.min.jsnu �[��� define("core_reportbuilder/local/editor/sorting",["exports","jquery","core/inplace_editable","core/notification","core/pending","core/pubsub","core/sortable_list","core/str","core/toast","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/sorting","core/templates","core/event_dispatcher","core_reportbuilder/local/events"],(function(_exports,_jquery,_inplace_editable,_notification,_pending,_pubsub,_sortable_list,_str,_toast,reportSelectors,_sorting,_templates,_event_dispatcher,reportEvents){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=_interopRequireDefault(_jquery),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_sortable_list=_interopRequireDefault(_sortable_list),reportSelectors=_interopRequireWildcard(reportSelectors),_templates=_interopRequireDefault(_templates),reportEvents=_interopRequireWildcard(reportEvents);const SORTORDER_ASCENDING=4,SORTORDER_DESCENDING=3,reloadSettingsSortingRegion=context=>{const pendingPromise=new _pending.default("core_reportbuilder/sorting:reload"),settingsSortingRegion=document.querySelector(reportSelectors.regions.settingsSorting);return _templates.default.renderForPromise("core_reportbuilder/local/settings/sorting",{sorting:context}).then((_ref=>{let{html:html,js:js}=_ref;return _templates.default.replaceNode(settingsSortingRegion,html,js),pendingPromise.resolve()}))},updateSorting=(reportElement,element,sortenabled,sortdirection)=>{const reportId=reportElement.dataset.reportId,listElement=element.closest("li"),columnId=listElement.dataset.columnSortId,columnName=listElement.dataset.columnSortName;return(0,_sorting.toggleColumnSorting)(reportId,columnId,sortenabled,sortdirection).then(reloadSettingsSortingRegion).then((()=>(0,_str.getString)("columnsortupdated","core_reportbuilder",columnName))).then(_toast.add).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),null)))};_exports.init=initialized=>{initialized||((0,_pubsub.subscribe)(reportEvents.publish.reportColumnsUpdated,(data=>reloadSettingsSortingRegion(data).catch(_notification.default.exception))),document.addEventListener("click",(event=>{const toggleSorting=event.target.closest(reportSelectors.actions.reportToggleColumnSort);if(toggleSorting){event.preventDefault();const pendingPromise=new _pending.default("core_reportbuilder/sorting:toggle"),reportElement=toggleSorting.closest(reportSelectors.regions.report),sortdirection=parseInt(toggleSorting.closest("li").dataset.columnSortDirection);updateSorting(reportElement,toggleSorting,toggleSorting.checked,sortdirection).then((()=>{const toggleSortingElement=document.getElementById(toggleSorting.id);return null==toggleSortingElement||toggleSortingElement.focus(),pendingPromise.resolve()})).catch(_notification.default.exception)}const toggleSortDirection=event.target.closest(reportSelectors.actions.reportToggleColumnSortDirection);if(toggleSortDirection){event.preventDefault();const pendingPromise=new _pending.default("core_reportbuilder/sorting:direction"),reportElement=toggleSortDirection.closest(reportSelectors.regions.report),listElement=toggleSortDirection.closest("li"),toggleSorting=listElement.querySelector(reportSelectors.actions.reportToggleColumnSort);let sortdirection=parseInt(listElement.dataset.columnSortDirection);sortdirection===SORTORDER_ASCENDING?sortdirection=SORTORDER_DESCENDING:sortdirection===SORTORDER_DESCENDING&&(sortdirection=SORTORDER_ASCENDING),updateSorting(reportElement,toggleSortDirection,toggleSorting.checked,sortdirection).then((()=>{const toggleSortDirectionElement=document.getElementById(toggleSortDirection.id);return null==toggleSortDirectionElement||toggleSortDirectionElement.focus(),pendingPromise.resolve()})).catch(_notification.default.exception)}})),new _sortable_list.default("".concat(reportSelectors.regions.settingsSorting," ul"),{isHorizontal:!1}).getElementName=element=>Promise.resolve(element.data("columnSortName")),(0,_jquery.default)(document).on(_sortable_list.default.EVENTS.DROP,"".concat(reportSelectors.regions.report," li[data-column-sort-id]"),((event,info)=>{if(info.positionChanged){const pendingPromise=new _pending.default("core_reportbuilder/sorting:reorder"),reportElement=event.target.closest(reportSelectors.regions.report),columnId=info.element.data("columnSortId"),columnPosition=info.element.data("columnSortPosition");let targetColumnSortPosition=info.targetNextElement.data("columnSortPosition")||info.element.siblings().length+2;targetColumnSortPosition>columnPosition&&targetColumnSortPosition--;const reorderPromise=(0,_sorting.reorderColumnSorting)(reportElement.dataset.reportId,columnId,targetColumnSortPosition);Promise.all([reorderPromise,new Promise((resolve=>setTimeout(resolve,1e3)))]).then((_ref2=>{let[data]=_ref2;return reloadSettingsSortingRegion(data)})).then((()=>(0,_str.getString)("columnsortupdated","core_reportbuilder",info.element.data("columnSortName")))).then(_toast.add).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)}})))}})); //# sourceMappingURL=sorting.min.js.mapPK b<�\�z�7 7 % amd/build/local/editor/filters.min.jsnu �[��� define("core_reportbuilder/local/editor/filters",["exports","jquery","core/form-autocomplete","core/inplace_editable","core/notification","core/pending","core/prefetch","core/sortable_list","core/str","core/templates","core/toast","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/filters"],(function(_exports,_jquery,_formAutocomplete,_inplace_editable,_notification,_pending,_prefetch,_sortable_list,_str,_templates,_toast,reportSelectors,_filters){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=_interopRequireDefault(_jquery),_formAutocomplete=_interopRequireDefault(_formAutocomplete),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_sortable_list=_interopRequireDefault(_sortable_list),_templates=_interopRequireDefault(_templates),reportSelectors=function(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}newObj.default=obj,cache&&cache.set(obj,newObj);return newObj}(reportSelectors);const reloadSettingsFiltersRegion=(reportElement,templateContext)=>{const pendingPromise=new _pending.default("core_reportbuilder/filters:reload"),settingsFiltersRegion=reportElement.querySelector(reportSelectors.regions.settingsFilters);return _templates.default.renderForPromise("core_reportbuilder/local/settings/filters",{filters:templateContext}).then((_ref=>{let{html:html,js:js}=_ref;_templates.default.replaceNode(settingsFiltersRegion,html,js),initFiltersForm();const reportAddFilter=reportElement.querySelector(reportSelectors.actions.reportAddFilter);return null==reportAddFilter||reportAddFilter.focus(),pendingPromise.resolve()}))},initFiltersForm=()=>{const reportAddFilter=document.querySelector(reportSelectors.regions.report).querySelector(reportSelectors.actions.reportAddFilter);_formAutocomplete.default.enhanceField(reportAddFilter,!1,"",(0,_str.getString)("selectafilter","core_reportbuilder")).catch(_notification.default.exception)};_exports.init=initialized=>{((0,_prefetch.prefetchStrings)("core_reportbuilder",["deletefilter","deletefilterconfirm","filteradded","filterdeleted","filtermoved","selectafilter"]),(0,_prefetch.prefetchStrings)("core",["delete"]),initFiltersForm(),initialized)||(document.addEventListener("change",(event=>{const reportAddFilter=event.target.closest(reportSelectors.actions.reportAddFilter);if(reportAddFilter){if(event.preventDefault(),""===reportAddFilter.value||"0"===reportAddFilter.value)return;const reportElement=reportAddFilter.closest(reportSelectors.regions.report),pendingPromise=new _pending.default("core_reportbuilder/filters:add");(0,_filters.addFilter)(reportElement.dataset.reportId,reportAddFilter.value).then((data=>reloadSettingsFiltersRegion(reportElement,data))).then((()=>(0,_str.getString)("filteradded","core_reportbuilder",reportAddFilter.options[reportAddFilter.selectedIndex].text))).then(_toast.add).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)}})),document.addEventListener("click",(event=>{const reportRemoveFilter=event.target.closest(reportSelectors.actions.reportRemoveFilter);if(reportRemoveFilter){event.preventDefault();const reportElement=reportRemoveFilter.closest(reportSelectors.regions.report),filterContainer=reportRemoveFilter.closest(reportSelectors.regions.activeFilter),filterName=filterContainer.dataset.filterName;_notification.default.saveCancelPromise((0,_str.getString)("deletefilter","core_reportbuilder",filterName),(0,_str.getString)("deletefilterconfirm","core_reportbuilder",filterName),(0,_str.getString)("delete","core"),{triggerElement:reportRemoveFilter}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/filters:remove");return(0,_filters.deleteFilter)(reportElement.dataset.reportId,filterContainer.dataset.filterId).then((data=>reloadSettingsFiltersRegion(reportElement,data))).then((()=>(0,_toast.add)((0,_str.getString)("filterdeleted","core_reportbuilder",filterName)))).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)})).catch((()=>{}))}})),new _sortable_list.default("".concat(reportSelectors.regions.activeFilters," ul"),{isHorizontal:!1}).getElementName=element=>Promise.resolve(element.data("filterName")),(0,_jquery.default)(document).on(_sortable_list.default.EVENTS.DROP,"".concat(reportSelectors.regions.report," li[data-filter-id]"),((event,info)=>{if(info.positionChanged){const pendingPromise=new _pending.default("core_reportbuilder/filters:reorder"),reportElement=event.target.closest(reportSelectors.regions.report),filterId=info.element.data("filterId"),filterPosition=info.element.data("filterPosition");let targetFilterPosition=info.targetNextElement.data("filterPosition")||info.element.siblings().length+2;targetFilterPosition>filterPosition&&targetFilterPosition--;const reorderPromise=(0,_filters.reorderFilter)(reportElement.dataset.reportId,filterId,targetFilterPosition);Promise.all([reorderPromise,new Promise((resolve=>setTimeout(resolve,1e3)))]).then((_ref2=>{let[data]=_ref2;return reloadSettingsFiltersRegion(reportElement,data)})).then((()=>(0,_str.getString)("filtermoved","core_reportbuilder",info.element.data("filterName")))).then(_toast.add).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)}})))}})); //# sourceMappingURL=filters.min.js.mapPK b<�\ o� % amd/build/local/editor/columns.min.jsnu �[��� define("core_reportbuilder/local/editor/columns",["exports","jquery","core/event_dispatcher","core/inplace_editable","core/local/inplace_editable/events","core/notification","core/pending","core/prefetch","core/pubsub","core/sortable_list","core/str","core/toast","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/columns","core_reportbuilder/local/repository/sorting"],(function(_exports,_jquery,_event_dispatcher,_inplace_editable,_events,_notification,_pending,_prefetch,_pubsub,_sortable_list,_str,_toast,reportEvents,reportSelectors,_columns,_sorting){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=_interopRequireDefault(_jquery),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_sortable_list=_interopRequireDefault(_sortable_list),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);_exports.init=initialized=>{((0,_prefetch.prefetchStrings)("core_reportbuilder",["columnadded","columnaggregated","columndeleted","columnmoved","deletecolumn","deletecolumnconfirm"]),(0,_prefetch.prefetchStrings)("core",["delete"]),initialized)||(document.addEventListener("click",(event=>{const reportAddColumn=event.target.closest(reportSelectors.actions.reportAddColumn);if(reportAddColumn){event.preventDefault();const pendingPromise=new _pending.default("core_reportbuilder/columns:add"),reportElement=reportAddColumn.closest(reportSelectors.regions.report);(0,_columns.addColumn)(reportElement.dataset.reportId,reportAddColumn.dataset.uniqueIdentifier).then((data=>(0,_pubsub.publish)(reportEvents.publish.reportColumnsUpdated,data))).then((()=>(0,_str.getString)("columnadded","core_reportbuilder",reportAddColumn.dataset.name))).then(_toast.add).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)}const reportRemoveColumn=event.target.closest(reportSelectors.actions.reportRemoveColumn);if(reportRemoveColumn){event.preventDefault();const reportElement=reportRemoveColumn.closest(reportSelectors.regions.report),columnHeader=reportRemoveColumn.closest(reportSelectors.regions.columnHeader),columnName=columnHeader.dataset.columnName;_notification.default.saveCancelPromise((0,_str.getString)("deletecolumn","core_reportbuilder",columnName),(0,_str.getString)("deletecolumnconfirm","core_reportbuilder",columnName),(0,_str.getString)("delete","core"),{triggerElement:reportRemoveColumn}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/columns:remove");return(0,_columns.deleteColumn)(reportElement.dataset.reportId,columnHeader.dataset.columnId).then((data=>(0,_pubsub.publish)(reportEvents.publish.reportColumnsUpdated,data))).then((()=>(0,_toast.add)((0,_str.getString)("columndeleted","core_reportbuilder",columnName)))).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)})).catch((()=>{}))}})),new _sortable_list.default("".concat(reportSelectors.regions.reportTable," thead tr"),{isHorizontal:!0}).getElementName=element=>Promise.resolve(element.data("columnName")),(0,_jquery.default)(document).on(_sortable_list.default.EVENTS.DRAG,"".concat(reportSelectors.regions.report," th[data-column-id]"),((event,info)=>{const reportElement=event.target.closest(reportSelectors.regions.report),columnPosition=info.element.data("columnPosition"),targetColumnPosition=info.targetNextElement.data("columnPosition");(0,_jquery.default)(reportElement).find("tbody tr").each((function(){const cell=(0,_jquery.default)(this).children("td.c".concat(columnPosition-1))[0];if(targetColumnPosition){var beforeCell=(0,_jquery.default)(this).children("td.c".concat(targetColumnPosition-1))[0];this.insertBefore(cell,beforeCell)}else this.appendChild(cell)}))})),(0,_jquery.default)(document).on(_sortable_list.default.EVENTS.DROP,"".concat(reportSelectors.regions.report," th[data-column-id]"),((event,info)=>{if(info.positionChanged){const pendingPromise=new _pending.default("core_reportbuilder/columns:reorder"),reportElement=event.target.closest(reportSelectors.regions.report),columnId=info.element.data("columnId"),columnName=info.element.data("columnName"),columnPosition=info.element.data("columnPosition");let targetColumnPosition=info.targetNextElement.data("columnPosition")||info.element.siblings().length+2;targetColumnPosition>columnPosition&&targetColumnPosition--;const reorderPromise=(0,_columns.reorderColumn)(reportElement.dataset.reportId,columnId,targetColumnPosition);Promise.all([reorderPromise,new Promise((resolve=>setTimeout(resolve,1e3)))]).then((()=>(0,_str.getString)("columnmoved","core_reportbuilder",columnName))).then(_toast.add).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preservePagination:!0},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)}})),document.addEventListener(_events.eventTypes.elementUpdated,(event=>{const columnAggregation=event.target.closest('[data-itemtype="columnaggregation"]');if(columnAggregation){const pendingPromise=new _pending.default("core_reportbuilder/columns:aggregate"),reportElement=columnAggregation.closest(reportSelectors.regions.report),columnHeader=columnAggregation.closest(reportSelectors.regions.columnHeader);(0,_str.getString)("columnaggregated","core_reportbuilder",columnHeader.dataset.columnName).then(_toast.add).then((()=>{const columnAggregationLink='[data-itemtype="columnaggregation"][data-itemid="'+"".concat(columnAggregation.dataset.itemid,'"] > a');return(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{preserveTriggerElement:columnAggregationLink},reportElement),(0,_sorting.getColumnSorting)(reportElement.dataset.reportId)})).then((data=>(0,_pubsub.publish)(reportEvents.publish.reportColumnsUpdated,data))).then((()=>pendingPromise.resolve())).catch(_notification.default.exception)}})))}})); //# sourceMappingURL=columns.min.js.mapPK b<�\01�d�+ �+ ) amd/build/local/editor/filters.min.js.mapnu �[��� {"version":3,"file":"filters.min.js","sources":["../../../src/local/editor/filters.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder filters editor\n *\n * @module core_reportbuilder/local/editor/filters\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport $ from 'jquery';\nimport AutoComplete from 'core/form-autocomplete';\nimport 'core/inplace_editable';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {prefetchStrings} from 'core/prefetch';\nimport SortableList from 'core/sortable_list';\nimport {getString} from 'core/str';\nimport Templates from 'core/templates';\nimport {add as addToast} from 'core/toast';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {addFilter, deleteFilter, reorderFilter} from 'core_reportbuilder/local/repository/filters';\n\n/**\n * Reload filters settings region\n *\n * @param {Element} reportElement\n * @param {Object} templateContext\n * @return {Promise}\n */\nconst reloadSettingsFiltersRegion = (reportElement, templateContext) => {\n const pendingPromise = new Pending('core_reportbuilder/filters:reload');\n const settingsFiltersRegion = reportElement.querySelector(reportSelectors.regions.settingsFilters);\n\n return Templates.renderForPromise('core_reportbuilder/local/settings/filters', {filters: templateContext})\n .then(({html, js}) => {\n Templates.replaceNode(settingsFiltersRegion, html, js);\n\n initFiltersForm();\n\n // Re-focus the add filter element after reloading the region.\n const reportAddFilter = reportElement.querySelector(reportSelectors.actions.reportAddFilter);\n reportAddFilter?.focus();\n\n return pendingPromise.resolve();\n });\n};\n\n/**\n * Initialise filters form, must be called on each init because the form container is re-created when switching editor modes\n */\nconst initFiltersForm = () => {\n const reportElement = document.querySelector(reportSelectors.regions.report);\n\n // Enhance filter selector.\n const reportAddFilter = reportElement.querySelector(reportSelectors.actions.reportAddFilter);\n AutoComplete.enhanceField(reportAddFilter, false, '', getString('selectafilter', 'core_reportbuilder'))\n .catch(Notification.exception);\n};\n\n/**\n * Initialise module, prefetch all required strings\n *\n * @param {Boolean} initialized Ensure we only add our listeners once\n */\nexport const init = initialized => {\n prefetchStrings('core_reportbuilder', [\n 'deletefilter',\n 'deletefilterconfirm',\n 'filteradded',\n 'filterdeleted',\n 'filtermoved',\n 'selectafilter',\n ]);\n\n prefetchStrings('core', [\n 'delete',\n ]);\n\n initFiltersForm();\n if (initialized) {\n return;\n }\n\n // Add filter to report.\n document.addEventListener('change', event => {\n const reportAddFilter = event.target.closest(reportSelectors.actions.reportAddFilter);\n if (reportAddFilter) {\n event.preventDefault();\n\n // Check if dropdown is closed with no filter selected.\n if (reportAddFilter.value === \"\" || reportAddFilter.value === \"0\") {\n return;\n }\n\n const reportElement = reportAddFilter.closest(reportSelectors.regions.report);\n const pendingPromise = new Pending('core_reportbuilder/filters:add');\n\n addFilter(reportElement.dataset.reportId, reportAddFilter.value)\n .then(data => reloadSettingsFiltersRegion(reportElement, data))\n .then(() => getString('filteradded', 'core_reportbuilder',\n reportAddFilter.options[reportAddFilter.selectedIndex].text))\n .then(addToast)\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n }\n });\n\n document.addEventListener('click', event => {\n\n // Remove filter from report.\n const reportRemoveFilter = event.target.closest(reportSelectors.actions.reportRemoveFilter);\n if (reportRemoveFilter) {\n event.preventDefault();\n\n const reportElement = reportRemoveFilter.closest(reportSelectors.regions.report);\n const filterContainer = reportRemoveFilter.closest(reportSelectors.regions.activeFilter);\n const filterName = filterContainer.dataset.filterName;\n\n Notification.saveCancelPromise(\n getString('deletefilter', 'core_reportbuilder', filterName),\n getString('deletefilterconfirm', 'core_reportbuilder', filterName),\n getString('delete', 'core'),\n {triggerElement: reportRemoveFilter}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/filters:remove');\n\n return deleteFilter(reportElement.dataset.reportId, filterContainer.dataset.filterId)\n .then(data => reloadSettingsFiltersRegion(reportElement, data))\n .then(() => addToast(getString('filterdeleted', 'core_reportbuilder', filterName)))\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n }\n });\n\n // Initialize sortable list to handle active filters moving (note JQuery dependency, see MDL-72293 for resolution).\n var activeFiltersSortableList = new SortableList(`${reportSelectors.regions.activeFilters} ul`, {isHorizontal: false});\n activeFiltersSortableList.getElementName = element => Promise.resolve(element.data('filterName'));\n\n $(document).on(SortableList.EVENTS.DROP, `${reportSelectors.regions.report} li[data-filter-id]`, (event, info) => {\n if (info.positionChanged) {\n const pendingPromise = new Pending('core_reportbuilder/filters:reorder');\n const reportElement = event.target.closest(reportSelectors.regions.report);\n const filterId = info.element.data('filterId');\n const filterPosition = info.element.data('filterPosition');\n\n // Select target position, if moving to the end then count number of element siblings.\n let targetFilterPosition = info.targetNextElement.data('filterPosition') || info.element.siblings().length + 2;\n if (targetFilterPosition > filterPosition) {\n targetFilterPosition--;\n }\n\n // Re-order filter, giving drop event transition time to finish.\n const reorderPromise = reorderFilter(reportElement.dataset.reportId, filterId, targetFilterPosition);\n Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))])\n .then(([data]) => reloadSettingsFiltersRegion(reportElement, data))\n .then(() => getString('filtermoved', 'core_reportbuilder', info.element.data('filterName')))\n .then(addToast)\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n }\n });\n};\n"],"names":["reloadSettingsFiltersRegion","reportElement","templateContext","pendingPromise","Pending","settingsFiltersRegion","querySelector","reportSelectors","regions","settingsFilters","Templates","renderForPromise","filters","then","_ref","html","js","replaceNode","initFiltersForm","reportAddFilter","actions","focus","resolve","document","report","enhanceField","catch","Notification","exception","initialized","addEventListener","event","target","closest","preventDefault","value","dataset","reportId","data","options","selectedIndex","text","addToast","reportRemoveFilter","filterContainer","activeFilter","filterName","saveCancelPromise","triggerElement","filterId","SortableList","activeFilters","isHorizontal","getElementName","element","Promise","on","EVENTS","DROP","info","positionChanged","filterPosition","targetFilterPosition","targetNextElement","siblings","length","reorderPromise","all","setTimeout","_ref2"],"mappings":"u2DA6CMA,4BAA8B,CAACC,cAAeC,yBAC1CC,eAAiB,IAAIC,iBAAQ,qCAC7BC,sBAAwBJ,cAAcK,cAAcC,gBAAgBC,QAAQC,wBAE3EC,mBAAUC,iBAAiB,4CAA6C,CAACC,QAASV,kBACpFW,MAAKC,WAACC,KAACA,KAADC,GAAOA,4BACAC,YAAYZ,sBAAuBU,KAAMC,IAEnDE,wBAGMC,gBAAkBlB,cAAcK,cAAcC,gBAAgBa,QAAQD,wBAC5EA,MAAAA,iBAAAA,gBAAiBE,QAEVlB,eAAemB,cAO5BJ,gBAAkB,WAIdC,gBAHgBI,SAASjB,cAAcC,gBAAgBC,QAAQgB,QAG/BlB,cAAcC,gBAAgBa,QAAQD,2CAC/DM,aAAaN,iBAAiB,EAAO,IAAI,kBAAU,gBAAiB,uBAC5EO,MAAMC,sBAAaC,0BAQRC,6CACA,qBAAsB,CAClC,eACA,sBACA,cACA,gBACA,cACA,gDAGY,OAAQ,CACpB,WAGJX,kBACIW,eAKJN,SAASO,iBAAiB,UAAUC,cAC1BZ,gBAAkBY,MAAMC,OAAOC,QAAQ1B,gBAAgBa,QAAQD,oBACjEA,gBAAiB,IACjBY,MAAMG,iBAGwB,KAA1Bf,gBAAgBgB,OAA0C,MAA1BhB,gBAAgBgB,mBAI9ClC,cAAgBkB,gBAAgBc,QAAQ1B,gBAAgBC,QAAQgB,QAChErB,eAAiB,IAAIC,iBAAQ,yDAEzBH,cAAcmC,QAAQC,SAAUlB,gBAAgBgB,OACrDtB,MAAKyB,MAAQtC,4BAA4BC,cAAeqC,QACxDzB,MAAK,KAAM,kBAAU,cAAe,qBACjCM,gBAAgBoB,QAAQpB,gBAAgBqB,eAAeC,QAC1D5B,KAAK6B,YACL7B,MAAK,IAAMV,eAAemB,YAC1BI,MAAMC,sBAAaC,eAIhCL,SAASO,iBAAiB,SAASC,cAGzBY,mBAAqBZ,MAAMC,OAAOC,QAAQ1B,gBAAgBa,QAAQuB,uBACpEA,mBAAoB,CACpBZ,MAAMG,uBAEAjC,cAAgB0C,mBAAmBV,QAAQ1B,gBAAgBC,QAAQgB,QACnEoB,gBAAkBD,mBAAmBV,QAAQ1B,gBAAgBC,QAAQqC,cACrEC,WAAaF,gBAAgBR,QAAQU,iCAE9BC,mBACT,kBAAU,eAAgB,qBAAsBD,aAChD,kBAAU,sBAAuB,qBAAsBA,aACvD,kBAAU,SAAU,QACpB,CAACE,eAAgBL,qBACnB9B,MAAK,WACGV,eAAiB,IAAIC,iBAAQ,4CAE5B,yBAAaH,cAAcmC,QAAQC,SAAUO,gBAAgBR,QAAQa,UACvEpC,MAAKyB,MAAQtC,4BAA4BC,cAAeqC,QACxDzB,MAAK,KAAM,eAAS,kBAAU,gBAAiB,qBAAsBiC,eACrEjC,MAAK,IAAMV,eAAemB,YAC1BI,MAAMC,sBAAaC,cACzBF,OAAM,aAOe,IAAIwB,iCAAgB3C,gBAAgBC,QAAQ2C,qBAAoB,CAACC,cAAc,IACrFC,eAAiBC,SAAWC,QAAQjC,QAAQgC,QAAQhB,KAAK,mCAEjFf,UAAUiC,GAAGN,uBAAaO,OAAOC,eAASnD,gBAAgBC,QAAQgB,+BAA6B,CAACO,MAAO4B,WACjGA,KAAKC,gBAAiB,OAChBzD,eAAiB,IAAIC,iBAAQ,sCAC7BH,cAAgB8B,MAAMC,OAAOC,QAAQ1B,gBAAgBC,QAAQgB,QAC7DyB,SAAWU,KAAKL,QAAQhB,KAAK,YAC7BuB,eAAiBF,KAAKL,QAAQhB,KAAK,sBAGrCwB,qBAAuBH,KAAKI,kBAAkBzB,KAAK,mBAAqBqB,KAAKL,QAAQU,WAAWC,OAAS,EACzGH,qBAAuBD,gBACvBC,6BAIEI,gBAAiB,0BAAcjE,cAAcmC,QAAQC,SAAUY,SAAUa,sBAC/EP,QAAQY,IAAI,CAACD,eAAgB,IAAIX,SAAQjC,SAAW8C,WAAW9C,QAAS,SACnET,MAAKwD,YAAE/B,mBAAUtC,4BAA4BC,cAAeqC,SAC5DzB,MAAK,KAAM,kBAAU,cAAe,qBAAsB8C,KAAKL,QAAQhB,KAAK,iBAC5EzB,KAAK6B,YACL7B,MAAK,IAAMV,eAAemB,YAC1BI,MAAMC,sBAAaC"}PK b<�\ ��a a ' amd/build/local/editor/card_view.min.jsnu �[��� define("core_reportbuilder/local/editor/card_view",["exports","core_form/dynamicform","core/toast","core/str","core/pubsub","core/notification","core_reportbuilder/local/events","core_reportbuilder/local/selectors"],(function(_exports,_dynamicform,_toast,_str,_pubsub,_notification,reportEvents,reportSelectors){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_dynamicform=_interopRequireDefault(_dynamicform),_notification=_interopRequireDefault(_notification),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);let cardViewForm=null;_exports.init=initialized=>{(()=>{const cardViewFormContainer=document.querySelector(reportSelectors.regions.settingsCardView);cardViewFormContainer&&(cardViewForm=new _dynamicform.default(cardViewFormContainer,"\\core_reportbuilder\\form\\card_view"),cardViewForm.addEventListener(cardViewForm.events.FORM_SUBMITTED,(event=>{event.preventDefault(),(0,_str.getString)("cardviewsettingssaved","core_reportbuilder").then(_toast.add).catch(_notification.default.exception)})))})(),initialized||(0,_pubsub.subscribe)(reportEvents.publish.reportColumnsUpdated,(()=>{const reportElement=document.querySelector(reportSelectors.regions.report);cardViewForm.load({reportid:reportElement.dataset.reportId})}))}})); //# sourceMappingURL=card_view.min.js.mapPK b<�\�* ��! �! ( amd/build/local/editor/conditions.min.jsnu �[��� define("core_reportbuilder/local/editor/conditions",["exports","jquery","core/event_dispatcher","core/form-autocomplete","core/inplace_editable","core/notification","core/pending","core/prefetch","core/sortable_list","core/str","core/templates","core/toast","core_form/dynamicform","core_reportbuilder/local/events","core_reportbuilder/local/selectors","core_reportbuilder/local/repository/conditions"],(function(_exports,_jquery,_event_dispatcher,_formAutocomplete,_inplace_editable,_notification,_pending,_prefetch,_sortable_list,_str,_templates,_toast,_dynamicform,reportEvents,reportSelectors,_conditions){function _getRequireWildcardCache(nodeInterop){if("function"!=typeof WeakMap)return null;var cacheBabelInterop=new WeakMap,cacheNodeInterop=new WeakMap;return(_getRequireWildcardCache=function(nodeInterop){return nodeInterop?cacheNodeInterop:cacheBabelInterop})(nodeInterop)}function _interopRequireWildcard(obj,nodeInterop){if(!nodeInterop&&obj&&obj.__esModule)return obj;if(null===obj||"object"!=typeof obj&&"function"!=typeof obj)return{default:obj};var cache=_getRequireWildcardCache(nodeInterop);if(cache&&cache.has(obj))return cache.get(obj);var newObj={},hasPropertyDescriptor=Object.defineProperty&&Object.getOwnPropertyDescriptor;for(var key in obj)if("default"!==key&&Object.prototype.hasOwnProperty.call(obj,key)){var desc=hasPropertyDescriptor?Object.getOwnPropertyDescriptor(obj,key):null;desc&&(desc.get||desc.set)?Object.defineProperty(newObj,key,desc):newObj[key]=obj[key]}return newObj.default=obj,cache&&cache.set(obj,newObj),newObj}function _interopRequireDefault(obj){return obj&&obj.__esModule?obj:{default:obj}}Object.defineProperty(_exports,"__esModule",{value:!0}),_exports.init=void 0,_jquery=_interopRequireDefault(_jquery),_formAutocomplete=_interopRequireDefault(_formAutocomplete),_notification=_interopRequireDefault(_notification),_pending=_interopRequireDefault(_pending),_sortable_list=_interopRequireDefault(_sortable_list),_templates=_interopRequireDefault(_templates),_dynamicform=_interopRequireDefault(_dynamicform),reportEvents=_interopRequireWildcard(reportEvents),reportSelectors=_interopRequireWildcard(reportSelectors);const reloadSettingsConditionsRegion=(reportElement,templateContext)=>{const pendingPromise=new _pending.default("core_reportbuilder/conditions:reload"),settingsConditionsRegion=reportElement.querySelector(reportSelectors.regions.settingsConditions);return _templates.default.renderForPromise("core_reportbuilder/local/settings/conditions",{conditions:templateContext}).then((_ref=>{let{html:html,js:js}=_ref;const conditionsjs=_jquery.default.parseHTML(templateContext.javascript,null,!0).map((node=>node.innerHTML)).join("\n");_templates.default.replaceNode(settingsConditionsRegion,html,js+conditionsjs),initConditionsForm();const reportAddCondition=reportElement.querySelector(reportSelectors.actions.reportAddCondition);return null==reportAddCondition||reportAddCondition.focus(),pendingPromise.resolve()}))},initConditionsForm=()=>{const reportElement=document.querySelector(reportSelectors.regions.report),reportAddCondition=reportElement.querySelector(reportSelectors.actions.reportAddCondition);_formAutocomplete.default.enhanceField(reportAddCondition,!1,"",(0,_str.getString)("selectacondition","core_reportbuilder")).catch(_notification.default.exception);const conditionFormContainer=reportElement.querySelector(reportSelectors.regions.settingsConditions);if(!conditionFormContainer)return;const conditionForm=new _dynamicform.default(conditionFormContainer,"\\core_reportbuilder\\form\\condition");conditionForm.addEventListener(conditionForm.events.FORM_SUBMITTED,(event=>{event.preventDefault(),(0,_str.getString)("conditionsapplied","core_reportbuilder").then(_toast.add).catch(_notification.default.exception),(0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement)})),conditionForm.addEventListener(conditionForm.events.NOSUBMIT_BUTTON_PRESSED,(event=>{event.preventDefault(),_notification.default.saveCancelPromise((0,_str.getString)("resetconditions","core_reportbuilder"),(0,_str.getString)("resetconditionsconfirm","core_reportbuilder"),(0,_str.getString)("resetall","core_reportbuilder"),{triggerElement:event.detail}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/conditions:reset");return(0,_conditions.resetConditions)(reportElement.dataset.reportId).then((data=>reloadSettingsConditionsRegion(reportElement,data))).then((()=>(0,_toast.add)((0,_str.getString)("conditionsreset","core_reportbuilder")))).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)})).catch((()=>{}))}))};_exports.init=initialized=>{((0,_prefetch.prefetchStrings)("core_reportbuilder",["conditionadded","conditiondeleted","conditionmoved","conditionsapplied","conditionsreset","deletecondition","deleteconditionconfirm","resetall","resetconditions","resetconditionsconfirm","selectacondition"]),(0,_prefetch.prefetchStrings)("core",["delete"]),initConditionsForm(),initialized)||(document.addEventListener("change",(event=>{const reportAddCondition=event.target.closest(reportSelectors.actions.reportAddCondition);if(reportAddCondition){if(event.preventDefault(),""===reportAddCondition.value||"0"===reportAddCondition.value)return;const reportElement=reportAddCondition.closest(reportSelectors.regions.report),pendingPromise=new _pending.default("core_reportbuilder/conditions:add");(0,_conditions.addCondition)(reportElement.dataset.reportId,reportAddCondition.value).then((data=>reloadSettingsConditionsRegion(reportElement,data))).then((()=>(0,_str.getString)("conditionadded","core_reportbuilder",reportAddCondition.options[reportAddCondition.selectedIndex].text))).then(_toast.add).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)}})),document.addEventListener("click",(event=>{const reportRemoveCondition=event.target.closest(reportSelectors.actions.reportRemoveCondition);if(reportRemoveCondition){event.preventDefault();const reportElement=reportRemoveCondition.closest(reportSelectors.regions.report),conditionContainer=reportRemoveCondition.closest(reportSelectors.regions.activeCondition),conditionName=conditionContainer.dataset.conditionName;_notification.default.saveCancelPromise((0,_str.getString)("deletecondition","core_reportbuilder",conditionName),(0,_str.getString)("deleteconditionconfirm","core_reportbuilder",conditionName),(0,_str.getString)("delete","core"),{triggerElement:reportRemoveCondition}).then((()=>{const pendingPromise=new _pending.default("core_reportbuilder/conditions:remove");return(0,_conditions.deleteCondition)(reportElement.dataset.reportId,conditionContainer.dataset.conditionId).then((data=>reloadSettingsConditionsRegion(reportElement,data))).then((()=>(0,_toast.add)((0,_str.getString)("conditiondeleted","core_reportbuilder",conditionName)))).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)})).catch((()=>{}))}})),new _sortable_list.default("".concat(reportSelectors.regions.activeConditions),{isHorizontal:!1}).getElementName=element=>Promise.resolve(element.data("conditionName")),(0,_jquery.default)(document).on(_sortable_list.default.EVENTS.DROP,reportSelectors.regions.activeCondition,((event,info)=>{if(info.positionChanged){const pendingPromise=new _pending.default("core_reportbuilder/conditions:reorder"),reportElement=event.target.closest(reportSelectors.regions.report),conditionId=info.element.data("conditionId"),conditionPosition=info.element.data("conditionPosition");let targetConditionPosition=info.targetNextElement.data("conditionPosition")||info.element.siblings().length+2;targetConditionPosition>conditionPosition&&targetConditionPosition--;const reorderPromise=(0,_conditions.reorderCondition)(reportElement.dataset.reportId,conditionId,targetConditionPosition);Promise.all([reorderPromise,new Promise((resolve=>setTimeout(resolve,1e3)))]).then((_ref2=>{let[data]=_ref2;return reloadSettingsConditionsRegion(reportElement,data)})).then((()=>(0,_str.getString)("conditionmoved","core_reportbuilder",info.element.data("conditionName")))).then(_toast.add).then((()=>((0,_event_dispatcher.dispatchEvent)(reportEvents.tableReload,{},reportElement),pendingPromise.resolve()))).catch(_notification.default.exception)}})))}})); //# sourceMappingURL=conditions.min.js.mapPK b<�\��fܝ � + amd/build/local/editor/card_view.min.js.mapnu �[��� {"version":3,"file":"card_view.min.js","sources":["../../../src/local/editor/card_view.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder card view editor\n *\n * @module core_reportbuilder/local/editor/card_view\n * @copyright 2021 Mikel Martín <mikel@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport DynamicForm from 'core_form/dynamicform';\nimport {add as addToast} from 'core/toast';\nimport {getString} from \"core/str\";\nimport {subscribe as subscribe} from 'core/pubsub';\nimport Notification from 'core/notification';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\n\nlet cardViewForm = null;\n\n/**\n * Initialise card view form, must be called on each init because the form container is re-created when switching editor modes\n */\nconst initCardViewForm = () => {\n const cardViewFormContainer = document.querySelector(reportSelectors.regions.settingsCardView);\n if (!cardViewFormContainer) {\n return;\n }\n cardViewForm = new DynamicForm(cardViewFormContainer, '\\\\core_reportbuilder\\\\form\\\\card_view');\n\n cardViewForm.addEventListener(cardViewForm.events.FORM_SUBMITTED, (event) => {\n event.preventDefault();\n\n getString('cardviewsettingssaved', 'core_reportbuilder')\n .then(addToast)\n .catch(Notification.exception);\n });\n};\n\n/**\n * Initialise module\n *\n * @param {Boolean} initialized Ensure we only add our listeners once\n */\nexport const init = (initialized) => {\n initCardViewForm();\n if (initialized) {\n return;\n }\n\n // Update form each time a column is added or removed to the custom report.\n subscribe(reportEvents.publish.reportColumnsUpdated, () => {\n const reportElement = document.querySelector(reportSelectors.regions.report);\n cardViewForm.load({reportid: reportElement.dataset.reportId});\n });\n};\n"],"names":["cardViewForm","initialized","cardViewFormContainer","document","querySelector","reportSelectors","regions","settingsCardView","DynamicForm","addEventListener","events","FORM_SUBMITTED","event","preventDefault","then","addToast","catch","Notification","exception","initCardViewForm","reportEvents","publish","reportColumnsUpdated","reportElement","report","load","reportid","dataset","reportId"],"mappings":"omDAiCIA,aAAe,mBA0BEC,cArBI,YACfC,sBAAwBC,SAASC,cAAcC,gBAAgBC,QAAQC,kBACxEL,wBAGLF,aAAe,IAAIQ,qBAAYN,sBAAuB,yCAEtDF,aAAaS,iBAAiBT,aAAaU,OAAOC,gBAAiBC,QAC/DA,MAAMC,oCAEI,wBAAyB,sBAC9BC,KAAKC,YACLC,MAAMC,sBAAaC,gBAU5BC,GACIlB,mCAKMmB,aAAaC,QAAQC,sBAAsB,WAC3CC,cAAgBpB,SAASC,cAAcC,gBAAgBC,QAAQkB,QACrExB,aAAayB,KAAK,CAACC,SAAUH,cAAcI,QAAQC"}PK b<�\ ��q�; �; , amd/build/local/editor/conditions.min.js.mapnu �[��� {"version":3,"file":"conditions.min.js","sources":["../../../src/local/editor/conditions.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder conditions editor\n *\n * @module core_reportbuilder/local/editor/conditions\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport $ from 'jquery';\nimport {dispatchEvent} from 'core/event_dispatcher';\nimport AutoComplete from 'core/form-autocomplete';\nimport 'core/inplace_editable';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {prefetchStrings} from 'core/prefetch';\nimport SortableList from 'core/sortable_list';\nimport {getString} from 'core/str';\nimport Templates from 'core/templates';\nimport {add as addToast} from 'core/toast';\nimport DynamicForm from 'core_form/dynamicform';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {addCondition, deleteCondition, reorderCondition, resetConditions} from 'core_reportbuilder/local/repository/conditions';\n\n/**\n * Reload conditions settings region\n *\n * @param {Element} reportElement\n * @param {Object} templateContext\n * @return {Promise}\n */\nconst reloadSettingsConditionsRegion = (reportElement, templateContext) => {\n const pendingPromise = new Pending('core_reportbuilder/conditions:reload');\n const settingsConditionsRegion = reportElement.querySelector(reportSelectors.regions.settingsConditions);\n\n return Templates.renderForPromise('core_reportbuilder/local/settings/conditions', {conditions: templateContext})\n .then(({html, js}) => {\n const conditionsjs = $.parseHTML(templateContext.javascript, null, true).map(node => node.innerHTML).join(\"\\n\");\n Templates.replaceNode(settingsConditionsRegion, html, js + conditionsjs);\n\n initConditionsForm();\n\n // Re-focus the add condition element after reloading the region.\n const reportAddCondition = reportElement.querySelector(reportSelectors.actions.reportAddCondition);\n reportAddCondition?.focus();\n\n return pendingPromise.resolve();\n });\n};\n\n/**\n * Initialise conditions form, must be called on each init because the form container is re-created when switching editor modes\n */\nconst initConditionsForm = () => {\n const reportElement = document.querySelector(reportSelectors.regions.report);\n\n // Enhance condition selector.\n const reportAddCondition = reportElement.querySelector(reportSelectors.actions.reportAddCondition);\n AutoComplete.enhanceField(reportAddCondition, false, '', getString('selectacondition', 'core_reportbuilder'))\n .catch(Notification.exception);\n\n // Handle dynamic conditions form.\n const conditionFormContainer = reportElement.querySelector(reportSelectors.regions.settingsConditions);\n if (!conditionFormContainer) {\n return;\n }\n const conditionForm = new DynamicForm(conditionFormContainer, '\\\\core_reportbuilder\\\\form\\\\condition');\n\n // Submit report conditions.\n conditionForm.addEventListener(conditionForm.events.FORM_SUBMITTED, event => {\n event.preventDefault();\n\n getString('conditionsapplied', 'core_reportbuilder')\n .then(addToast)\n .catch(Notification.exception);\n\n // After the form has been submitted, we should trigger report table reload.\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n });\n\n // Reset report conditions.\n conditionForm.addEventListener(conditionForm.events.NOSUBMIT_BUTTON_PRESSED, event => {\n event.preventDefault();\n\n Notification.saveCancelPromise(\n getString('resetconditions', 'core_reportbuilder'),\n getString('resetconditionsconfirm', 'core_reportbuilder'),\n getString('resetall', 'core_reportbuilder'),\n {triggerElement: event.detail}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/conditions:reset');\n\n return resetConditions(reportElement.dataset.reportId)\n .then(data => reloadSettingsConditionsRegion(reportElement, data))\n .then(() => addToast(getString('conditionsreset', 'core_reportbuilder')))\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n });\n};\n\n/**\n * Initialise module, prefetch all required strings\n *\n * @param {Boolean} initialized Ensure we only add our listeners once\n */\nexport const init = initialized => {\n prefetchStrings('core_reportbuilder', [\n 'conditionadded',\n 'conditiondeleted',\n 'conditionmoved',\n 'conditionsapplied',\n 'conditionsreset',\n 'deletecondition',\n 'deleteconditionconfirm',\n 'resetall',\n 'resetconditions',\n 'resetconditionsconfirm',\n 'selectacondition',\n ]);\n\n prefetchStrings('core', [\n 'delete',\n ]);\n\n initConditionsForm();\n if (initialized) {\n return;\n }\n\n // Add condition to report.\n document.addEventListener('change', event => {\n const reportAddCondition = event.target.closest(reportSelectors.actions.reportAddCondition);\n if (reportAddCondition) {\n event.preventDefault();\n\n // Check if dropdown is closed with no condition selected.\n if (reportAddCondition.value === \"\" || reportAddCondition.value === \"0\") {\n return;\n }\n\n const reportElement = reportAddCondition.closest(reportSelectors.regions.report);\n const pendingPromise = new Pending('core_reportbuilder/conditions:add');\n\n addCondition(reportElement.dataset.reportId, reportAddCondition.value)\n .then(data => reloadSettingsConditionsRegion(reportElement, data))\n .then(() => getString('conditionadded', 'core_reportbuilder',\n reportAddCondition.options[reportAddCondition.selectedIndex].text))\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n });\n\n document.addEventListener('click', event => {\n\n // Remove condition from report.\n const reportRemoveCondition = event.target.closest(reportSelectors.actions.reportRemoveCondition);\n if (reportRemoveCondition) {\n event.preventDefault();\n\n const reportElement = reportRemoveCondition.closest(reportSelectors.regions.report);\n const conditionContainer = reportRemoveCondition.closest(reportSelectors.regions.activeCondition);\n const conditionName = conditionContainer.dataset.conditionName;\n\n Notification.saveCancelPromise(\n getString('deletecondition', 'core_reportbuilder', conditionName),\n getString('deleteconditionconfirm', 'core_reportbuilder', conditionName),\n getString('delete', 'core'),\n {triggerElement: reportRemoveCondition}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/conditions:remove');\n\n return deleteCondition(reportElement.dataset.reportId, conditionContainer.dataset.conditionId)\n .then(data => reloadSettingsConditionsRegion(reportElement, data))\n .then(() => addToast(getString('conditiondeleted', 'core_reportbuilder', conditionName)))\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n }\n });\n\n // Initialize sortable list to handle active conditions moving (note JQuery dependency, see MDL-72293 for resolution).\n var activeConditionsSortableList = new SortableList(`${reportSelectors.regions.activeConditions}`,\n {isHorizontal: false});\n activeConditionsSortableList.getElementName = element => Promise.resolve(element.data('conditionName'));\n\n $(document).on(SortableList.EVENTS.DROP, reportSelectors.regions.activeCondition, (event, info) => {\n if (info.positionChanged) {\n const pendingPromise = new Pending('core_reportbuilder/conditions:reorder');\n const reportElement = event.target.closest(reportSelectors.regions.report);\n const conditionId = info.element.data('conditionId');\n const conditionPosition = info.element.data('conditionPosition');\n\n // Select target position, if moving to the end then count number of element siblings.\n let targetConditionPosition = info.targetNextElement.data('conditionPosition') || info.element.siblings().length + 2;\n if (targetConditionPosition > conditionPosition) {\n targetConditionPosition--;\n }\n\n // Re-order condition, giving drop event transition time to finish.\n const reorderPromise = reorderCondition(reportElement.dataset.reportId, conditionId, targetConditionPosition);\n Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))])\n .then(([data]) => reloadSettingsConditionsRegion(reportElement, data))\n .then(() => getString('conditionmoved', 'core_reportbuilder', info.element.data('conditionName')))\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n });\n};\n"],"names":["reloadSettingsConditionsRegion","reportElement","templateContext","pendingPromise","Pending","settingsConditionsRegion","querySelector","reportSelectors","regions","settingsConditions","Templates","renderForPromise","conditions","then","_ref","html","js","conditionsjs","$","parseHTML","javascript","map","node","innerHTML","join","replaceNode","initConditionsForm","reportAddCondition","actions","focus","resolve","document","report","enhanceField","catch","Notification","exception","conditionFormContainer","conditionForm","DynamicForm","addEventListener","events","FORM_SUBMITTED","event","preventDefault","addToast","reportEvents","tableReload","NOSUBMIT_BUTTON_PRESSED","saveCancelPromise","triggerElement","detail","dataset","reportId","data","initialized","target","closest","value","options","selectedIndex","text","reportRemoveCondition","conditionContainer","activeCondition","conditionName","conditionId","SortableList","activeConditions","isHorizontal","getElementName","element","Promise","on","EVENTS","DROP","info","positionChanged","conditionPosition","targetConditionPosition","targetNextElement","siblings","length","reorderPromise","all","setTimeout","_ref2"],"mappings":"koEAgDMA,+BAAiC,CAACC,cAAeC,yBAC7CC,eAAiB,IAAIC,iBAAQ,wCAC7BC,yBAA2BJ,cAAcK,cAAcC,gBAAgBC,QAAQC,2BAE9EC,mBAAUC,iBAAiB,+CAAgD,CAACC,WAAYV,kBAC1FW,MAAKC,WAACC,KAACA,KAADC,GAAOA,eACJC,aAAeC,gBAAEC,UAAUjB,gBAAgBkB,WAAY,MAAM,GAAMC,KAAIC,MAAQA,KAAKC,YAAWC,KAAK,yBAChGC,YAAYpB,yBAA0BU,KAAMC,GAAKC,cAE3DS,2BAGMC,mBAAqB1B,cAAcK,cAAcC,gBAAgBqB,QAAQD,2BAC/EA,MAAAA,oBAAAA,mBAAoBE,QAEb1B,eAAe2B,cAO5BJ,mBAAqB,WACjBzB,cAAgB8B,SAASzB,cAAcC,gBAAgBC,QAAQwB,QAG/DL,mBAAqB1B,cAAcK,cAAcC,gBAAgBqB,QAAQD,8CAClEM,aAAaN,oBAAoB,EAAO,IAAI,kBAAU,mBAAoB,uBAClFO,MAAMC,sBAAaC,iBAGlBC,uBAAyBpC,cAAcK,cAAcC,gBAAgBC,QAAQC,wBAC9E4B,oCAGCC,cAAgB,IAAIC,qBAAYF,uBAAwB,yCAG9DC,cAAcE,iBAAiBF,cAAcG,OAAOC,gBAAgBC,QAChEA,MAAMC,oCAEI,oBAAqB,sBAC1B/B,KAAKgC,YACLX,MAAMC,sBAAaC,+CAGVU,aAAaC,YAAa,GAAI9C,kBAIhDqC,cAAcE,iBAAiBF,cAAcG,OAAOO,yBAAyBL,QACzEA,MAAMC,uCAEOK,mBACT,kBAAU,kBAAmB,uBAC7B,kBAAU,yBAA0B,uBACpC,kBAAU,WAAY,sBACtB,CAACC,eAAgBP,MAAMQ,SACzBtC,MAAK,WACGV,eAAiB,IAAIC,iBAAQ,8CAE5B,+BAAgBH,cAAcmD,QAAQC,UACxCxC,MAAKyC,MAAQtD,+BAA+BC,cAAeqD,QAC3DzC,MAAK,KAAM,eAAS,kBAAU,kBAAmB,yBACjDA,MAAK,yCACYiC,aAAaC,YAAa,GAAI9C,eACrCE,eAAe2B,aAEzBI,MAAMC,sBAAaC,cACzBF,OAAM,2BAWGqB,6CACA,qBAAsB,CAClC,iBACA,mBACA,iBACA,oBACA,kBACA,kBACA,yBACA,WACA,kBACA,yBACA,mDAGY,OAAQ,CACpB,WAGJ7B,qBACI6B,eAKJxB,SAASS,iBAAiB,UAAUG,cAC1BhB,mBAAqBgB,MAAMa,OAAOC,QAAQlD,gBAAgBqB,QAAQD,uBACpEA,mBAAoB,IACpBgB,MAAMC,iBAG2B,KAA7BjB,mBAAmB+B,OAA6C,MAA7B/B,mBAAmB+B,mBAIpDzD,cAAgB0B,mBAAmB8B,QAAQlD,gBAAgBC,QAAQwB,QACnE7B,eAAiB,IAAIC,iBAAQ,kEAEtBH,cAAcmD,QAAQC,SAAU1B,mBAAmB+B,OAC3D7C,MAAKyC,MAAQtD,+BAA+BC,cAAeqD,QAC3DzC,MAAK,KAAM,kBAAU,iBAAkB,qBACpCc,mBAAmBgC,QAAQhC,mBAAmBiC,eAAeC,QAChEhD,KAAKgC,YACLhC,MAAK,yCACYiC,aAAaC,YAAa,GAAI9C,eACrCE,eAAe2B,aAEzBI,MAAMC,sBAAaC,eAIhCL,SAASS,iBAAiB,SAASG,cAGzBmB,sBAAwBnB,MAAMa,OAAOC,QAAQlD,gBAAgBqB,QAAQkC,0BACvEA,sBAAuB,CACvBnB,MAAMC,uBAEA3C,cAAgB6D,sBAAsBL,QAAQlD,gBAAgBC,QAAQwB,QACtE+B,mBAAqBD,sBAAsBL,QAAQlD,gBAAgBC,QAAQwD,iBAC3EC,cAAgBF,mBAAmBX,QAAQa,oCAEpChB,mBACT,kBAAU,kBAAmB,qBAAsBgB,gBACnD,kBAAU,yBAA0B,qBAAsBA,gBAC1D,kBAAU,SAAU,QACpB,CAACf,eAAgBY,wBACnBjD,MAAK,WACGV,eAAiB,IAAIC,iBAAQ,+CAE5B,+BAAgBH,cAAcmD,QAAQC,SAAUU,mBAAmBX,QAAQc,aAC7ErD,MAAKyC,MAAQtD,+BAA+BC,cAAeqD,QAC3DzC,MAAK,KAAM,eAAS,kBAAU,mBAAoB,qBAAsBoD,kBACxEpD,MAAK,yCACYiC,aAAaC,YAAa,GAAI9C,eACrCE,eAAe2B,aAEzBI,MAAMC,sBAAaC,cACzBF,OAAM,aAOkB,IAAIiC,iCAAgB5D,gBAAgBC,QAAQ4D,kBAC3E,CAACC,cAAc,IACUC,eAAiBC,SAAWC,QAAQ1C,QAAQyC,QAAQjB,KAAK,sCAEpFvB,UAAU0C,GAAGN,uBAAaO,OAAOC,KAAMpE,gBAAgBC,QAAQwD,iBAAiB,CAACrB,MAAOiC,WAClFA,KAAKC,gBAAiB,OAChB1E,eAAiB,IAAIC,iBAAQ,yCAC7BH,cAAgB0C,MAAMa,OAAOC,QAAQlD,gBAAgBC,QAAQwB,QAC7DkC,YAAcU,KAAKL,QAAQjB,KAAK,eAChCwB,kBAAoBF,KAAKL,QAAQjB,KAAK,yBAGxCyB,wBAA0BH,KAAKI,kBAAkB1B,KAAK,sBAAwBsB,KAAKL,QAAQU,WAAWC,OAAS,EAC/GH,wBAA0BD,mBAC1BC,gCAIEI,gBAAiB,gCAAiBlF,cAAcmD,QAAQC,SAAUa,YAAaa,yBACrFP,QAAQY,IAAI,CAACD,eAAgB,IAAIX,SAAQ1C,SAAWuD,WAAWvD,QAAS,SACnEjB,MAAKyE,YAAEhC,mBAAUtD,+BAA+BC,cAAeqD,SAC/DzC,MAAK,KAAM,kBAAU,iBAAkB,qBAAsB+D,KAAKL,QAAQjB,KAAK,oBAC/EzC,KAAKgC,YACLhC,MAAK,yCACYiC,aAAaC,YAAa,GAAI9C,eACrCE,eAAe2B,aAEzBI,MAAMC,sBAAaC"}PK b<�\.ҹ�"- "- ) amd/build/local/editor/sorting.min.js.mapnu �[��� {"version":3,"file":"sorting.min.js","sources":["../../../src/local/editor/sorting.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder columns sorting editor\n *\n * @module core_reportbuilder/local/editor/sorting\n * @copyright 2021 David Matamoros <davidmc@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport $ from 'jquery';\nimport 'core/inplace_editable';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {subscribe} from 'core/pubsub';\nimport SortableList from 'core/sortable_list';\nimport {getString} from 'core/str';\nimport {add as addToast} from 'core/toast';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {reorderColumnSorting, toggleColumnSorting} from 'core_reportbuilder/local/repository/sorting';\nimport Templates from 'core/templates';\nimport {dispatchEvent} from 'core/event_dispatcher';\nimport * as reportEvents from 'core_reportbuilder/local/events';\n\n// These constants match PHP consts SORT_ASC, SORT_DESC.\nconst SORTORDER = {\n ASCENDING: 4,\n DESCENDING: 3,\n};\n\n/**\n * Reload sorting settings region\n *\n * @param {Object} context\n * @return {Promise}\n */\nconst reloadSettingsSortingRegion = context => {\n const pendingPromise = new Pending('core_reportbuilder/sorting:reload');\n const settingsSortingRegion = document.querySelector(reportSelectors.regions.settingsSorting);\n\n return Templates.renderForPromise('core_reportbuilder/local/settings/sorting', {sorting: context})\n .then(({html, js}) => {\n Templates.replaceNode(settingsSortingRegion, html, js);\n return pendingPromise.resolve();\n });\n};\n\n/**\n * Updates column sorting\n *\n * @param {Element} reportElement\n * @param {Element} element\n * @param {Number} sortenabled\n * @param {Number} sortdirection\n * @return {Promise}\n */\nconst updateSorting = (reportElement, element, sortenabled, sortdirection) => {\n const reportId = reportElement.dataset.reportId;\n const listElement = element.closest('li');\n const columnId = listElement.dataset.columnSortId;\n const columnName = listElement.dataset.columnSortName;\n\n return toggleColumnSorting(reportId, columnId, sortenabled, sortdirection)\n .then(reloadSettingsSortingRegion)\n .then(() => getString('columnsortupdated', 'core_reportbuilder', columnName))\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return null;\n });\n};\n\n/**\n * Initialise module\n *\n * @param {Boolean} initialized Ensure we only add our listeners once\n */\nexport const init = (initialized) => {\n if (initialized) {\n return;\n }\n\n // Update sorting region each time report columns are updated (added or removed).\n subscribe(reportEvents.publish.reportColumnsUpdated, data => reloadSettingsSortingRegion(data)\n .catch(Notification.exception)\n );\n\n document.addEventListener('click', event => {\n\n // Enable/disable sorting on columns.\n const toggleSorting = event.target.closest(reportSelectors.actions.reportToggleColumnSort);\n if (toggleSorting) {\n event.preventDefault();\n\n const pendingPromise = new Pending('core_reportbuilder/sorting:toggle');\n const reportElement = toggleSorting.closest(reportSelectors.regions.report);\n const sortdirection = parseInt(toggleSorting.closest('li').dataset.columnSortDirection);\n\n updateSorting(reportElement, toggleSorting, toggleSorting.checked, sortdirection)\n .then(() => {\n // Re-focus the toggle sorting element after reloading the region.\n const toggleSortingElement = document.getElementById(toggleSorting.id);\n toggleSortingElement?.focus();\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n\n // Change column sort direction.\n const toggleSortDirection = event.target.closest(reportSelectors.actions.reportToggleColumnSortDirection);\n if (toggleSortDirection) {\n event.preventDefault();\n\n const pendingPromise = new Pending('core_reportbuilder/sorting:direction');\n const reportElement = toggleSortDirection.closest(reportSelectors.regions.report);\n const listElement = toggleSortDirection.closest('li');\n const toggleSorting = listElement.querySelector(reportSelectors.actions.reportToggleColumnSort);\n\n let sortdirection = parseInt(listElement.dataset.columnSortDirection);\n if (sortdirection === SORTORDER.ASCENDING) {\n sortdirection = SORTORDER.DESCENDING;\n } else if (sortdirection === SORTORDER.DESCENDING) {\n sortdirection = SORTORDER.ASCENDING;\n }\n\n updateSorting(reportElement, toggleSortDirection, toggleSorting.checked, sortdirection)\n .then(() => {\n // Re-focus the toggle sort direction element after reloading the region.\n const toggleSortDirectionElement = document.getElementById(toggleSortDirection.id);\n toggleSortDirectionElement?.focus();\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n });\n\n // Initialize sortable list to handle column sorting moving (note JQuery dependency, see MDL-72293 for resolution).\n var columnsSortingSortableList = new SortableList(`${reportSelectors.regions.settingsSorting} ul`, {isHorizontal: false});\n columnsSortingSortableList.getElementName = element => Promise.resolve(element.data('columnSortName'));\n\n $(document).on(SortableList.EVENTS.DROP, `${reportSelectors.regions.report} li[data-column-sort-id]`, (event, info) => {\n if (info.positionChanged) {\n const pendingPromise = new Pending('core_reportbuilder/sorting:reorder');\n const reportElement = event.target.closest(reportSelectors.regions.report);\n const columnId = info.element.data('columnSortId');\n const columnPosition = info.element.data('columnSortPosition');\n\n // Select target position, if moving to the end then count number of element siblings.\n let targetColumnSortPosition = info.targetNextElement.data('columnSortPosition') || info.element.siblings().length + 2;\n if (targetColumnSortPosition > columnPosition) {\n targetColumnSortPosition--;\n }\n\n // Re-order column sorting, giving drop event transition time to finish.\n const reorderPromise = reorderColumnSorting(reportElement.dataset.reportId, columnId, targetColumnSortPosition);\n Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))])\n .then(([data]) => reloadSettingsSortingRegion(data))\n .then(() => getString('columnsortupdated', 'core_reportbuilder', info.element.data('columnSortName')))\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n });\n};\n"],"names":["SORTORDER","reloadSettingsSortingRegion","context","pendingPromise","Pending","settingsSortingRegion","document","querySelector","reportSelectors","regions","settingsSorting","Templates","renderForPromise","sorting","then","_ref","html","js","replaceNode","resolve","updateSorting","reportElement","element","sortenabled","sortdirection","reportId","dataset","listElement","closest","columnId","columnSortId","columnName","columnSortName","addToast","reportEvents","tableReload","initialized","publish","reportColumnsUpdated","data","catch","Notification","exception","addEventListener","event","toggleSorting","target","actions","reportToggleColumnSort","preventDefault","report","parseInt","columnSortDirection","checked","toggleSortingElement","getElementById","id","focus","toggleSortDirection","reportToggleColumnSortDirection","toggleSortDirectionElement","SortableList","isHorizontal","getElementName","Promise","on","EVENTS","DROP","info","positionChanged","columnPosition","targetColumnSortPosition","targetNextElement","siblings","length","reorderPromise","all","setTimeout","_ref2"],"mappings":"u7DAwCMA,oBACS,EADTA,qBAEU,EASVC,4BAA8BC,gBAC1BC,eAAiB,IAAIC,iBAAQ,qCAC7BC,sBAAwBC,SAASC,cAAcC,gBAAgBC,QAAQC,wBAEtEC,mBAAUC,iBAAiB,4CAA6C,CAACC,QAASX,UACpFY,MAAKC,WAACC,KAACA,KAADC,GAAOA,mCACAC,YAAYb,sBAAuBW,KAAMC,IAC5Cd,eAAegB,cAa5BC,cAAgB,CAACC,cAAeC,QAASC,YAAaC,uBAClDC,SAAWJ,cAAcK,QAAQD,SACjCE,YAAcL,QAAQM,QAAQ,MAC9BC,SAAWF,YAAYD,QAAQI,aAC/BC,WAAaJ,YAAYD,QAAQM,sBAEhC,gCAAoBP,SAAUI,SAAUN,YAAaC,eACvDV,KAAKb,6BACLa,MAAK,KAAM,kBAAU,oBAAqB,qBAAsBiB,cAChEjB,KAAKmB,YACLnB,MAAK,yCACYoB,aAAaC,YAAa,GAAId,eACrC,uBASEe,cACbA,oCAKMF,aAAaG,QAAQC,sBAAsBC,MAAQtC,4BAA4BsC,MACpFC,MAAMC,sBAAaC,aAGxBpC,SAASqC,iBAAiB,SAASC,cAGzBC,cAAgBD,MAAME,OAAOlB,QAAQpB,gBAAgBuC,QAAQC,2BAC/DH,cAAe,CACfD,MAAMK,uBAEA9C,eAAiB,IAAIC,iBAAQ,qCAC7BiB,cAAgBwB,cAAcjB,QAAQpB,gBAAgBC,QAAQyC,QAC9D1B,cAAgB2B,SAASN,cAAcjB,QAAQ,MAAMF,QAAQ0B,qBAEnEhC,cAAcC,cAAewB,cAAeA,cAAcQ,QAAS7B,eAC9DV,MAAK,WAEIwC,qBAAuBhD,SAASiD,eAAeV,cAAcW,WACnEF,MAAAA,sBAAAA,qBAAsBG,QACftD,eAAegB,aAEzBqB,MAAMC,sBAAaC,iBAItBgB,oBAAsBd,MAAME,OAAOlB,QAAQpB,gBAAgBuC,QAAQY,oCACrED,oBAAqB,CACrBd,MAAMK,uBAEA9C,eAAiB,IAAIC,iBAAQ,wCAC7BiB,cAAgBqC,oBAAoB9B,QAAQpB,gBAAgBC,QAAQyC,QACpEvB,YAAc+B,oBAAoB9B,QAAQ,MAC1CiB,cAAgBlB,YAAYpB,cAAcC,gBAAgBuC,QAAQC,4BAEpExB,cAAgB2B,SAASxB,YAAYD,QAAQ0B,qBAC7C5B,gBAAkBxB,oBAClBwB,cAAgBxB,qBACTwB,gBAAkBxB,uBACzBwB,cAAgBxB,qBAGpBoB,cAAcC,cAAeqC,oBAAqBb,cAAcQ,QAAS7B,eACpEV,MAAK,WAEI8C,2BAA6BtD,SAASiD,eAAeG,oBAAoBF,WAC/EI,MAAAA,4BAAAA,2BAA4BH,QACrBtD,eAAegB,aAEzBqB,MAAMC,sBAAaC,eAKC,IAAImB,iCAAgBrD,gBAAgBC,QAAQC,uBAAsB,CAACoD,cAAc,IACvFC,eAAiBzC,SAAW0C,QAAQ7C,QAAQG,QAAQiB,KAAK,uCAElFjC,UAAU2D,GAAGJ,uBAAaK,OAAOC,eAAS3D,gBAAgBC,QAAQyC,oCAAkC,CAACN,MAAOwB,WACtGA,KAAKC,gBAAiB,OAChBlE,eAAiB,IAAIC,iBAAQ,sCAC7BiB,cAAgBuB,MAAME,OAAOlB,QAAQpB,gBAAgBC,QAAQyC,QAC7DrB,SAAWuC,KAAK9C,QAAQiB,KAAK,gBAC7B+B,eAAiBF,KAAK9C,QAAQiB,KAAK,0BAGrCgC,yBAA2BH,KAAKI,kBAAkBjC,KAAK,uBAAyB6B,KAAK9C,QAAQmD,WAAWC,OAAS,EACjHH,yBAA2BD,gBAC3BC,iCAIEI,gBAAiB,iCAAqBtD,cAAcK,QAAQD,SAAUI,SAAU0C,0BACtFP,QAAQY,IAAI,CAACD,eAAgB,IAAIX,SAAQ7C,SAAW0D,WAAW1D,QAAS,SACnEL,MAAKgE,YAAEvC,mBAAUtC,4BAA4BsC,SAC7CzB,MAAK,KAAM,kBAAU,oBAAqB,qBAAsBsD,KAAK9C,QAAQiB,KAAK,qBAClFzB,KAAKmB,YACLnB,MAAK,yCACYoB,aAAaC,YAAa,GAAId,eACrClB,eAAegB,aAEzBqB,MAAMC,sBAAaC"}PK b<�\i>�@�1 �1 ) amd/build/local/editor/columns.min.js.mapnu �[��� {"version":3,"file":"columns.min.js","sources":["../../../src/local/editor/columns.js"],"sourcesContent":["// This file is part of Moodle - http://moodle.org/\n//\n// Moodle is free software: you can redistribute it and/or modify\n// it under the terms of the GNU General Public License as published by\n// the Free Software Foundation, either version 3 of the License, or\n// (at your option) any later version.\n//\n// Moodle is distributed in the hope that it will be useful,\n// but WITHOUT ANY WARRANTY; without even the implied warranty of\n// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n// GNU General Public License for more details.\n//\n// You should have received a copy of the GNU General Public License\n// along with Moodle. If not, see <http://www.gnu.org/licenses/>.\n\n/**\n * Report builder columns editor\n *\n * @module core_reportbuilder/local/editor/columns\n * @copyright 2021 Paul Holden <paulh@moodle.com>\n * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later\n */\n\n\"use strict\";\n\nimport $ from 'jquery';\nimport {dispatchEvent} from 'core/event_dispatcher';\nimport 'core/inplace_editable';\nimport {eventTypes as inplaceEditableEvents} from 'core/local/inplace_editable/events';\nimport Notification from 'core/notification';\nimport Pending from 'core/pending';\nimport {prefetchStrings} from 'core/prefetch';\nimport {publish} from 'core/pubsub';\nimport SortableList from 'core/sortable_list';\nimport {getString} from 'core/str';\nimport {add as addToast} from 'core/toast';\nimport * as reportEvents from 'core_reportbuilder/local/events';\nimport * as reportSelectors from 'core_reportbuilder/local/selectors';\nimport {addColumn, deleteColumn, reorderColumn} from 'core_reportbuilder/local/repository/columns';\nimport {getColumnSorting} from 'core_reportbuilder/local/repository/sorting';\n\n/**\n * Initialise module, prefetch all required strings\n *\n * @param {Boolean} initialized Ensure we only add our listeners once\n */\nexport const init = initialized => {\n prefetchStrings('core_reportbuilder', [\n 'columnadded',\n 'columnaggregated',\n 'columndeleted',\n 'columnmoved',\n 'deletecolumn',\n 'deletecolumnconfirm',\n ]);\n\n prefetchStrings('core', [\n 'delete',\n ]);\n\n if (initialized) {\n return;\n }\n\n document.addEventListener('click', event => {\n\n // Add column to report.\n const reportAddColumn = event.target.closest(reportSelectors.actions.reportAddColumn);\n if (reportAddColumn) {\n event.preventDefault();\n\n const pendingPromise = new Pending('core_reportbuilder/columns:add');\n const reportElement = reportAddColumn.closest(reportSelectors.regions.report);\n\n addColumn(reportElement.dataset.reportId, reportAddColumn.dataset.uniqueIdentifier)\n .then(data => publish(reportEvents.publish.reportColumnsUpdated, data))\n .then(() => getString('columnadded', 'core_reportbuilder', reportAddColumn.dataset.name))\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n\n // Remove column from report.\n const reportRemoveColumn = event.target.closest(reportSelectors.actions.reportRemoveColumn);\n if (reportRemoveColumn) {\n event.preventDefault();\n\n const reportElement = reportRemoveColumn.closest(reportSelectors.regions.report);\n const columnHeader = reportRemoveColumn.closest(reportSelectors.regions.columnHeader);\n const columnName = columnHeader.dataset.columnName;\n\n Notification.saveCancelPromise(\n getString('deletecolumn', 'core_reportbuilder', columnName),\n getString('deletecolumnconfirm', 'core_reportbuilder', columnName),\n getString('delete', 'core'),\n {triggerElement: reportRemoveColumn}\n ).then(() => {\n const pendingPromise = new Pending('core_reportbuilder/columns:remove');\n\n return deleteColumn(reportElement.dataset.reportId, columnHeader.dataset.columnId)\n .then(data => publish(reportEvents.publish.reportColumnsUpdated, data))\n .then(() => addToast(getString('columndeleted', 'core_reportbuilder', columnName)))\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }).catch(() => {\n return;\n });\n }\n });\n\n // Initialize sortable list to handle column moving (note JQuery dependency, see MDL-72293 for resolution).\n var columnSortableList = new SortableList(`${reportSelectors.regions.reportTable} thead tr`, {isHorizontal: true});\n columnSortableList.getElementName = element => Promise.resolve(element.data('columnName'));\n\n $(document).on(SortableList.EVENTS.DRAG, `${reportSelectors.regions.report} th[data-column-id]`, (event, info) => {\n const reportElement = event.target.closest(reportSelectors.regions.report);\n const columnPosition = info.element.data('columnPosition');\n const targetColumnPosition = info.targetNextElement.data('columnPosition');\n\n $(reportElement).find('tbody tr').each(function() {\n const cell = $(this).children(`td.c${columnPosition - 1}`)[0];\n if (targetColumnPosition) {\n var beforeCell = $(this).children(`td.c${targetColumnPosition - 1}`)[0];\n this.insertBefore(cell, beforeCell);\n } else {\n this.appendChild(cell);\n }\n });\n });\n\n $(document).on(SortableList.EVENTS.DROP, `${reportSelectors.regions.report} th[data-column-id]`, (event, info) => {\n if (info.positionChanged) {\n const pendingPromise = new Pending('core_reportbuilder/columns:reorder');\n const reportElement = event.target.closest(reportSelectors.regions.report);\n const columnId = info.element.data('columnId');\n const columnName = info.element.data('columnName');\n const columnPosition = info.element.data('columnPosition');\n\n // Select target position, if moving to the end then count number of element siblings.\n let targetColumnPosition = info.targetNextElement.data('columnPosition') || info.element.siblings().length + 2;\n if (targetColumnPosition > columnPosition) {\n targetColumnPosition--;\n }\n\n // Re-order column, giving drop event transition time to finish.\n const reorderPromise = reorderColumn(reportElement.dataset.reportId, columnId, targetColumnPosition);\n Promise.all([reorderPromise, new Promise(resolve => setTimeout(resolve, 1000))])\n .then(() => getString('columnmoved', 'core_reportbuilder', columnName))\n .then(addToast)\n .then(() => {\n dispatchEvent(reportEvents.tableReload, {preservePagination: true}, reportElement);\n return pendingPromise.resolve();\n })\n .catch(Notification.exception);\n }\n });\n\n // Initialize inplace editable listeners for column aggregation.\n document.addEventListener(inplaceEditableEvents.elementUpdated, event => {\n\n const columnAggregation = event.target.closest('[data-itemtype=\"columnaggregation\"]');\n if (columnAggregation) {\n const pendingPromise = new Pending('core_reportbuilder/columns:aggregate');\n const reportElement = columnAggregation.closest(reportSelectors.regions.report);\n const columnHeader = columnAggregation.closest(reportSelectors.regions.columnHeader);\n\n getString('columnaggregated', 'core_reportbuilder', columnHeader.dataset.columnName)\n .then(addToast)\n .then(() => {\n // Pass preserveTriggerElement parameter so columnAggregationLink will be focused after the report reload.\n const columnAggregationLink = `[data-itemtype=\"columnaggregation\"][data-itemid=\"`\n + `${columnAggregation.dataset.itemid}\"] > a`;\n\n // Now reload the table, and notify listeners that columns have been updated.\n dispatchEvent(reportEvents.tableReload, {preserveTriggerElement: columnAggregationLink}, reportElement);\n return getColumnSorting(reportElement.dataset.reportId);\n })\n .then(data => publish(reportEvents.publish.reportColumnsUpdated, data))\n .then(() => pendingPromise.resolve())\n .catch(Notification.exception);\n }\n });\n};\n"],"names":["initialized","document","addEventListener","event","reportAddColumn","target","closest","reportSelectors","actions","preventDefault","pendingPromise","Pending","reportElement","regions","report","dataset","reportId","uniqueIdentifier","then","data","reportEvents","publish","reportColumnsUpdated","name","addToast","tableReload","preservePagination","resolve","catch","Notification","exception","reportRemoveColumn","columnHeader","columnName","saveCancelPromise","triggerElement","columnId","SortableList","reportTable","isHorizontal","getElementName","element","Promise","on","EVENTS","DRAG","info","columnPosition","targetColumnPosition","targetNextElement","find","each","cell","this","children","beforeCell","insertBefore","appendChild","DROP","positionChanged","siblings","length","reorderPromise","all","setTimeout","inplaceEditableEvents","elementUpdated","columnAggregation","columnAggregationLink","itemid","preserveTriggerElement"],"mappings":"m/DA8CoBA,6CACA,qBAAsB,CAClC,cACA,mBACA,gBACA,cACA,eACA,sDAGY,OAAQ,CACpB,WAGAA,eAIJC,SAASC,iBAAiB,SAASC,cAGzBC,gBAAkBD,MAAME,OAAOC,QAAQC,gBAAgBC,QAAQJ,oBACjEA,gBAAiB,CACjBD,MAAMM,uBAEAC,eAAiB,IAAIC,iBAAQ,kCAC7BC,cAAgBR,gBAAgBE,QAAQC,gBAAgBM,QAAQC,+BAE5DF,cAAcG,QAAQC,SAAUZ,gBAAgBW,QAAQE,kBAC7DC,MAAKC,OAAQ,mBAAQC,aAAaC,QAAQC,qBAAsBH,QAChED,MAAK,KAAM,kBAAU,cAAe,qBAAsBd,gBAAgBW,QAAQQ,QAClFL,KAAKM,YACLN,MAAK,yCACYE,aAAaK,YAAa,CAACC,oBAAoB,GAAOd,eAC7DF,eAAeiB,aAEzBC,MAAMC,sBAAaC,iBAItBC,mBAAqB5B,MAAME,OAAOC,QAAQC,gBAAgBC,QAAQuB,uBACpEA,mBAAoB,CACpB5B,MAAMM,uBAEAG,cAAgBmB,mBAAmBzB,QAAQC,gBAAgBM,QAAQC,QACnEkB,aAAeD,mBAAmBzB,QAAQC,gBAAgBM,QAAQmB,cAClEC,WAAaD,aAAajB,QAAQkB,iCAE3BC,mBACT,kBAAU,eAAgB,qBAAsBD,aAChD,kBAAU,sBAAuB,qBAAsBA,aACvD,kBAAU,SAAU,QACpB,CAACE,eAAgBJ,qBACnBb,MAAK,WACGR,eAAiB,IAAIC,iBAAQ,4CAE5B,yBAAaC,cAAcG,QAAQC,SAAUgB,aAAajB,QAAQqB,UACpElB,MAAKC,OAAQ,mBAAQC,aAAaC,QAAQC,qBAAsBH,QAChED,MAAK,KAAM,eAAS,kBAAU,gBAAiB,qBAAsBe,eACrEf,MAAK,yCACYE,aAAaK,YAAa,CAACC,oBAAoB,GAAOd,eAC7DF,eAAeiB,aAEzBC,MAAMC,sBAAaC,cACzBF,OAAM,aAOQ,IAAIS,iCAAgB9B,gBAAgBM,QAAQyB,yBAAwB,CAACC,cAAc,IACzFC,eAAiBC,SAAWC,QAAQf,QAAQc,QAAQtB,KAAK,mCAE1ElB,UAAU0C,GAAGN,uBAAaO,OAAOC,eAAStC,gBAAgBM,QAAQC,+BAA6B,CAACX,MAAO2C,cAC/FlC,cAAgBT,MAAME,OAAOC,QAAQC,gBAAgBM,QAAQC,QAC7DiC,eAAiBD,KAAKL,QAAQtB,KAAK,kBACnC6B,qBAAuBF,KAAKG,kBAAkB9B,KAAK,sCAEvDP,eAAesC,KAAK,YAAYC,MAAK,iBAC7BC,MAAO,mBAAEC,MAAMC,uBAAgBP,eAAiB,IAAK,MACvDC,qBAAsB,KAClBO,YAAa,mBAAEF,MAAMC,uBAAgBN,qBAAuB,IAAK,QAChEQ,aAAaJ,KAAMG,sBAEnBE,YAAYL,gCAK3BnD,UAAU0C,GAAGN,uBAAaO,OAAOc,eAASnD,gBAAgBM,QAAQC,+BAA6B,CAACX,MAAO2C,WACjGA,KAAKa,gBAAiB,OAChBjD,eAAiB,IAAIC,iBAAQ,sCAC7BC,cAAgBT,MAAME,OAAOC,QAAQC,gBAAgBM,QAAQC,QAC7DsB,SAAWU,KAAKL,QAAQtB,KAAK,YAC7Bc,WAAaa,KAAKL,QAAQtB,KAAK,cAC/B4B,eAAiBD,KAAKL,QAAQtB,KAAK,sBAGrC6B,qBAAuBF,KAAKG,kBAAkB9B,KAAK,mBAAqB2B,KAAKL,QAAQmB,WAAWC,OAAS,EACzGb,qBAAuBD,gBACvBC,6BAIEc,gBAAiB,0BAAclD,cAAcG,QAAQC,SAAUoB,SAAUY,sBAC/EN,QAAQqB,IAAI,CAACD,eAAgB,IAAIpB,SAAQf,SAAWqC,WAAWrC,QAAS,SACnET,MAAK,KAAM,kBAAU,cAAe,qBAAsBe,cAC1Df,KAAKM,YACLN,MAAK,yCACYE,aAAaK,YAAa,CAACC,oBAAoB,GAAOd,eAC7DF,eAAeiB,aAEzBC,MAAMC,sBAAaC,eAKhC7B,SAASC,iBAAiB+D,mBAAsBC,gBAAgB/D,cAEtDgE,kBAAoBhE,MAAME,OAAOC,QAAQ,0CAC3C6D,kBAAmB,OACbzD,eAAiB,IAAIC,iBAAQ,wCAC7BC,cAAgBuD,kBAAkB7D,QAAQC,gBAAgBM,QAAQC,QAClEkB,aAAemC,kBAAkB7D,QAAQC,gBAAgBM,QAAQmB,iCAE7D,mBAAoB,qBAAsBA,aAAajB,QAAQkB,YACpEf,KAAKM,YACLN,MAAK,WAEIkD,sBAAwB,8DACrBD,kBAAkBpD,QAAQsD,2DAGrBjD,aAAaK,YAAa,CAAC6C,uBAAwBF,uBAAwBxD,gBAClF,6BAAiBA,cAAcG,QAAQC,aAEjDE,MAAKC,OAAQ,mBAAQC,aAAaC,QAAQC,qBAAsBH,QAChED,MAAK,IAAMR,eAAeiB,YAC1BC,MAAMC,sBAAaC"}PK b<�\�'�o) o) upgrade.txtnu �[��� === 4.5 Onwards === This file has been replaced by UPGRADING.md. See MDL-81125 for further information. === This file describes API changes in /reportbuilder/* Information provided here is intended especially for developers. === 4.4 === * New methods `get_identity_[columns|filters]` in user entity, for retrieving all user identity field report elements * Entity table aliases are now auto-generated, hence usage of the `get_default_table_aliases` method is now deprecated. Instead, entities should implement the `get_default_tables` method to define the tables they use * New method `get_table_aliases` in base entity class, for retrieving all table aliases in a single call * The database helper `generate_alias[es]` and `generate_param_name[s]` methods now accept an optional `$suffix` argument for appending additional string to the generated value * The `get_name` method has been moved to the base report class and can now be implemented for both custom and system reports, it will be used as the caption when rendering tables (which can also be targeted in Behat scenarios) * The default value for the filename when calling `set_downloadable` is now taken from calling `get_name` on the current report * The base datasource `add_all_from_entity` method accepts additional parameters to limit which columns, filters and conditions are added. The `add_[columns|filters|conditions]_from_entity` class methods also now support wildcard matching in both `$include` and `$exclude` parameters * Custom reports now implement the tag API, with options for specifying in the `report::[create|update]_report` helper methods as well as in the `create_report` test generator method * The `tags` filter has been improved to also allow for filtering by component/itemtype core_tag definition - this is more suited for system reports * New report filter types: - `cohort` for reports containing cohort data - `courserole` for reports showing course enrolments - `filesize` for reports containing filesize data === 4.3 === * New external methods for retrieving system report data: - `core_reportbuilder_can_view_system_report` - `core_reportbuilder_retrieve_system_report` * New `get_tag_joins_for_entity` helper in base entity class, for returning SQL joins necessary for retrieving tags * New methods `[set|has]_table_join_alias` in the base entity class, to allow entities to reduce joins on the same table * New `set_is_deprecated` method in base `local\report\[column|filter]` classes to deprecate report entity columns and filters * The following report entity columns have been deprecated, with replacements as follows: - `comment:context` => `context:name` - `comment:contexturl` => `context:link` - `enrolment:method` => `enrol:name` (plus enrolment formatter `enrolment_name` method) - 'enrolment:role` => `role:name` - `file:context` => `context:name` - `file:contexturl` => `context:link` - `instance:context` (tag) => `context:name` - `instance:contexturl` (tag) => `context:link` * The following report entity filters/conditions have been deprecated, with replacements as follows: - `enrolment:method` => `enrol:plugin` * The `local/audience/form` template outer region has renamed some of it's `data-` attributes (relevant for any themes that have overridden this template): - `data-instanceid` => `data-audience-id` - `data-title` => `data-audience-title` * The `add_base_condition_sql` method of the base report class will now ignore empty where clauses * If a non-default column is specified in a datasource `get_default_column_sorting` method, a coding exception will be thrown * Trying to add/annotate duplicate entity names to a report will now throw a coding exception * The `get_default_entity_name` method of the base entity class is now private, and shouldn't be overridden in extending classes * The report helper methods `add_report_[condition|filter]` now throw an exception when trying to add duplicate conditions or filters to a report * Two new methods: - `get_default_no_results_notice` and - `set_default_no_results_notice` have been added to core_reportbuilder\local\report\base, allowing report implementations to control what lang string is used in the notice when the report has no results. Reports can either set a preferred lang string, or pass null if the notice isn't required in that particular report. === 4.2 === * New method `set_checkbox_toggleall` in system report class to allow reports to easily create checkbox toggle columns * Column callbacks are now passed a fourth argument to indicate the aggregation type currently being applied, which allows for columns to define how the aggregated data is displayed * New methods `[add|get]_attributes` added to report base class, for including custom attributes in report container HTML * New database helper method `sql_replace_parameter_names` to help ensure uniqueness of parameters within an expression (where that expression can be used multiple times as part of a larger query) * The local report filter class has a new `get_field_sql_and_params` method which should be used by filter types that re-use the filter field SQL within their generated expression, to ensure SQL containing parameters works correctly * The following attributes can be added to custom reports in order to control card view display (via the `add_attributes` method): - `data-force-card` to force cards view - `data-force-table` to force table view * New optional parameter `pagesize` in external method `core_reportbuilder_reports_get` to set the displayed rows per page. * Javascript reports repository module method `getReport` updated to accept new pagesize parameter. * The schedule helper `create_schedule` method accepts a `$timenow` parameter to use for comparisons against current date during tests * The `datasource_stress_test_columns` test helper now enables sorting on those columns that support it * The `create_[column|filter|condition]` test generator methods now allow for setting all persistent properties * The `get_category` method of the base audience class has been deprecated, callers should instead use `get_component_displayname` === 4.1 === * New method `add_action_divider()` in base system report class, to allow adding a divider to the action menu. * New external method `core_reportbuilder_set_filters` for setting report filter values (plus `setFilters` AJAX repository export for calling from Javascript modules) * New method `set_filter_form_default` in base system report class, to override whether the default filters form should be shown for a report * The external `core_reportbuilder_filters_reset` method now accepts an optional `parameters` argument, required by some system reports * New external methods for retrieving custom report data: - `core_reportbuilder_list_reports` - `core_reportbuilder_retrieve_report` - `core_reportbuilder_view_report` * For consistency, the following entity classes have moved namespace (usage of previous namespace will generate debugging): - `core_admin\{ => reportbuilder}\local\entities\task_log` - `core_cohort\{ => reportbuilder}\local\entities\cohort` - `core_cohort\{ => reportbuilder}\local\entities\cohort_member` - `core_course\{ => reportbuilder}\local\entities\course_category` - `report_configlog\{ => reportbuilder}\local\entities\config_change` * 'set_default_per_page' and 'get_default_per_page' methods have been added to \local\report\base class to manage the default displayed rows per page. * Added two new methods in the datasource class: - add_all_from_entity() to add all columns/filters/conditions from the given entity to the report at once - add_all_from_entities() to add all columns/filters/conditions from all the entities added to the report at once * New database helper methods for generating multiple unique values: `generate_aliases` and `generate_param_names` * The base aggregation `format_value` method has a `$columntype` argument in order to preserve type during aggregation. When defining column callbacks, strict typing will now be preserved in your callback methods when the column is being aggregated * The method `get_joins()` in the base entity class is now public, allowing for easier joins within reports * New method `set_table_aliases` in base entity class, for overriding multiple table aliases in a single call * The following local helper methods have been deprecated, their implementation moved to exporters: - `audience::get_all_audiences_menu_types` -> `custom_report_audience_cards_exporter` - `report::get_available_columns` -> `custom_report_column_cards_exporter` * The `custom_report_exporter` class now defines its editor element properties as optional, rather than each of those exporters defining their own properties as optional. In turn, this means the structure of the following external methods will always be present and consistent: - `core_reportbuilder_columns_*` - `core_reportbuilder_conditions_*` - `core_reportbuilder_filters_*` * The `custom_report_*` exporters now accept only classes that extend datasource as part of their related data properties * The following permission methods now accept an optional `$context` parameter (default system context): - `[require_]can_view_reports_list` - `[require_]can_create_report` * New method `get_default_condition_values()` in base datasource class, to be overridden by sources that wish to define default values for conditions upon report creation. * New methods `get_identity_[column|filter]` in user entity, for retrieving user identity field report elements * New method `user_reports_list_access_sql` in audience helper for retrieving list of all reports for given user * New report filter types: - `category` for reports containing course categories - `tags` for reports containing entities with support for core_tag API - `autocomplete` for reports that contain pre-defined values for selection. * New method `get_sample_values()` added to base filter class, to be overridden in all filter types to support stress testing * New test helpers for automated stress testing of report sources: - `datasource_stress_test_columns` - `datasource_stress_test_columns_aggregation` - `datasource_stress_test_conditions` * The test helper method `get_custom_report_content()` now accepts a list of filter values and applies them to the report * New method `get_default_column_sorting` in base datasource class, to be overridden by sources that wish to define default columns sort order upon report creation. PK a<�\���w� � lib.phpnu �[��� PK a<�\���Ť � 3 classes/permission.phpnu �[��� PK a<�\�!�LB B : . classes/external/custom_report_audience_cards_exporter.phpnu �[��� PK a<�\8�4�� � + �: classes/external/systemreports/retrieve.phpnu �[��� PK a<�\��~�� � + N classes/external/systemreports/can_view.phpnu �[��� PK a<�\� q� � % S^ classes/external/audiences/delete.phpnu �[��� PK a<�\e8�x� � 0 Ti classes/external/system_report_data_exporter.phpnu �[��� PK a<�\V�t~ ~ 8 Px classes/external/custom_report_column_cards_exporter.phpnu �[��� PK a<�\�M��� � % 6� classes/external/reports/retrieve.phpnu �[��� PK a<�\qO(�� � ! P� classes/external/reports/view.phpnu �[��� PK a<�\���E E w� classes/external/reports/get.phpnu �[��� PK a<�\S���a a $ � classes/external/reports/listing.phpnu �[��� PK a<�\F�o # �� classes/external/reports/delete.phpnu �[��� PK a<�\ �� � % *� classes/external/schedules/toggle.phpnu �[��� PK a<�\TR� % X� classes/external/schedules/delete.phpnu �[��� PK a<�\MU��� � # �� classes/external/schedules/send.phpnu �[��� PK a<�\�'�� � �� classes/external/columns/add.phpnu �[��� PK a<�\_g�IZ Z % �� classes/external/columns/sort/get.phpnu �[��� PK a<�\kx-C C ( �� classes/external/columns/sort/toggle.phpnu �[��� PK a<�\^y�b b ) 7 classes/external/columns/sort/reorder.phpnu �[��� PK a<�\�T�t t # � classes/external/columns/delete.phpnu �[��� PK a<�\v`G� � $ �! classes/external/columns/reorder.phpnu �[��� PK a<�\3;[� � # �, classes/external/conditions/add.phpnu �[��� PK a<�\ ɮy y % : classes/external/conditions/reset.phpnu �[��� PK a<�\�FTu� � & �E classes/external/conditions/delete.phpnu �[��� PK a<�\��4g g ' �R classes/external/conditions/reorder.phpnu �[��� PK a<�\��\Q Q + y` classes/external/custom_report_exporter.phpnu �[��� PK a<�\8w�<X X 6 %� classes/external/custom_report_conditions_exporter.phpnu �[��� PK a<�\ O�� � 3 � classes/external/custom_report_filters_exporter.phpnu �[��� PK a<�\����= = 6 (� classes/external/custom_report_menu_cards_exporter.phpnu �[��� PK a<�\��gʰ � ˶ classes/external/filters/add.phpnu �[��� PK a<�\Hp�� " �� classes/external/filters/reset.phpnu �[��� PK a<�\h�j�� � =� classes/external/filters/set.phpnu �[��� PK a<�\���\ \ # w� classes/external/filters/delete.phpnu �[��� PK a<�\�\��0 0 $ &� classes/external/filters/reorder.phpnu �[��� PK a<�\/~�jC C 3 �� classes/external/custom_report_details_exporter.phpnu �[��� PK a<�\߃�� � + P� classes/external/system_report_exporter.phpnu �[��� PK a<�\�"� � 5 j classes/external/custom_report_card_view_exporter.phpnu �[��� PK a<�\r��.� � 0 � classes/external/custom_report_data_exporter.phpnu �[��� PK a<�\g�oLb b ; �+ classes/external/custom_report_columns_sorting_exporter.phpnu �[��� PK a<�\UzG+ G+ �@ classes/system_report.phpnu �[��� PK a<�\�6{� � ) l classes/output/schedule_name_editable.phpnu �[��� PK a<�\ꋧ�� � nv classes/output/system_report.phpnu �[��� PK a<�\�,�u� � j classes/output/renderer.phpnu �[��� PK a<�\)���4 4 * U� classes/output/column_heading_editable.phpnu �[��� PK a<�\�}]�; ; , � classes/output/audience_heading_editable.phpnu �[��� PK a<�\.d�v. . ' z� classes/output/report_name_editable.phpnu �[��� PK a<�\�}b�� � �� classes/output/custom_report.phpnu �[��� PK a<�\\ qE . C� classes/output/column_aggregation_editable.phpnu �[��� PK a<�\�G�O= = * �� classes/output/filter_heading_editable.phpnu �[��� PK a<�\�M�'l l ( C� classes/output/dynamictabs/schedules.phpnu �[��� PK a<�\�]0� � ' � classes/output/dynamictabs/audience.phpnu �[��� PK a<�\4 �aa a % *� classes/output/dynamictabs/access.phpnu �[��� PK a<�\c���h h % � classes/output/dynamictabs/editor.phpnu �[��� PK a<�\+-�8> 8> � classes/privacy/provider.phpnu �[��� PK a<�\�� " !C classes/event/audience_updated.phpnu �[��� PK a<�\R� " �P classes/event/audience_deleted.phpnu �[��� PK a<�\�\ � " �] classes/event/schedule_deleted.phpnu �[��� PK a<�\�X�?? ? Pk classes/event/report_created.phpnu �[��� PK a<�\�g�Y Y �w classes/event/report_deleted.phpnu �[��� PK a<�\E%; ; �� classes/event/report_viewed.phpnu �[��� PK a<�\�o " � classes/event/schedule_updated.phpnu �[��� PK a<�\e�� � " v� classes/event/audience_created.phpnu �[��� PK a<�\�{�/? ? �� classes/event/report_updated.phpnu �[��� PK a<�\zl��� � " <� classes/event/schedule_created.phpnu �[��� PK a<�\ L� � ! s� classes/system_report_factory.phpnu �[��� PK a<�\9wMi� � �� classes/manager.phpnu �[��� PK a<�\%��8W8 W8 �� classes/datasource.phpnu �[��� PK a<�\�Y�� � ) �! classes/reportbuilder/audience/admins.phpnu �[��� PK a<�\��]�` ` + �, classes/reportbuilder/audience/allusers.phpnu �[��� PK a<�\~y!>� � ) b8 classes/reportbuilder/audience/manual.phpnu �[��� PK a<�\�x�� � - �G classes/reportbuilder/audience/systemrole.phpnu �[��� PK a<�\�g�� � . Z classes/exception/source_invalid_exception.phpnu �[��� PK a<�\:�� � - ]_ classes/exception/report_access_exception.phpnu �[��� PK a<�\�X� � 2 �d classes/exception/source_unavailable_exception.phpnu �[��� PK a<�\ �� j classes/task/send_schedule.phpnu �[��� PK a<�\|15� � Z� classes/task/send_schedules.phpnu �[��� PK a<�\f�j�� � / R� classes/table/custom_report_table_filterset.phpnu �[��� PK a<�\��6�p= p= % y� classes/table/custom_report_table.phpnu �[��� PK a<�\�X�*�( �( # >� classes/table/base_report_table.phpnu �[��� PK a<�\�.)� � / {� classes/table/system_report_table_filterset.phpnu �[��� PK a<�\%�a/3 3 % e� classes/table/system_report_table.phpnu �[��� PK a<�\�#� � * �0 classes/table/custom_report_table_view.phpnu �[��� PK a<�\�%��3 3 4 ; classes/table/custom_report_table_view_filterset.phpnu �[��� PK a<�\[D�Z Z �@ classes/form/card_view.phpnu �[��� PK a<�\� �~�% �% AR classes/form/schedule.phpnu �[��� PK a<�\��: : Kx classes/form/report.phpnu �[��� PK a<�\W�7� � ̏ classes/form/audience.phpnu �[��� PK a<�\�2�4i i �� classes/form/filter.phpnu �[��� PK a<�\�ਚ � ]� classes/form/condition.phpnu �[��� PK a<�\�U�u�. �. A� classes/local/entities/base.phpnu �[��� PK a<�\�_��5V 5V ^ classes/local/entities/user.phpnu �[��� PK a<�\%�5 c> c> ! �Y classes/local/entities/course.phpnu �[��� PK a<�\����p �p �� classes/local/report/base.phpnu �[��� PK a<�\��� � � classes/local/report/action.phpnu �[��� PK a<�\�P�j( j( � classes/local/report/filter.phpnu �[��� PK a<�\�h�:�\ �\ �G classes/local/report/column.phpnu �[��� PK a<�\��� 2 e� classes/local/systemreports/report_access_list.phpnu �[��� PK a<�\��UGP, P, 0 ٲ classes/local/systemreports/report_schedules.phpnu �[��� PK a<�\��U��. �. , �� classes/local/systemreports/reports_list.phpnu �[��� PK a<�\��0�$ �$ � classes/local/audiences/base.phpnu �[��� PK a<�\0� 7 7 ! �3 classes/local/models/schedule.phpnu �[��� PK a<�\���� � NN classes/local/models/report.phpnu �[��� PK a<�\���� � ! �c classes/local/models/audience.phpnu �[��� PK a<�\�7T� � ws classes/local/models/filter.phpnu �[��� PK a<�\R�j�� � q� classes/local/models/column.phpnu �[��� PK a<�\Y��"� � ! x� classes/local/aggregation/sum.phpnu �[��� PK a<�\8�/. . " �� classes/local/aggregation/base.phpnu �[��� PK a<�\%��.� � + #� classes/local/aggregation/countdistinct.phpnu �[��� PK a<�\���� � ! \� classes/local/aggregation/max.phpnu �[��� PK a<�\��8-? ? % ?� classes/local/aggregation/percent.phpnu �[��� PK a<�\� � � ! �� classes/local/aggregation/min.phpnu �[��� PK a<�\���ch h ! �� classes/local/aggregation/avg.phpnu �[��� PK a<�\�]� # o� classes/local/aggregation/count.phpnu �[��� PK a<�\s@�b� � 1 �� classes/local/aggregation/groupconcatdistinct.phpnu �[��� PK a<�\��� ) ,� classes/local/aggregation/groupconcat.phpnu �[��� PK a<�\.9�q� � - � classes/local/helpers/user_filter_manager.phpnu �[��� PK a<�\>i��0 �0 ' �+ classes/local/helpers/custom_fields.phpnu �[��� PK a<�\�s��& �& - �\ classes/local/helpers/user_profile_fields.phpnu �[��� PK a<�\�P2�7 �7 " � classes/local/helpers/schedule.phpnu �[��� PK a<�\ �5� � $ U� classes/local/helpers/join_trait.phpnu �[��� PK a<�\��FP�< �< �� classes/local/helpers/report.phpnu �[��� PK a<�\���ye( e( " � classes/local/helpers/audience.phpnu �[��� PK a<�\Go;9 9 " r) classes/local/helpers/database.phpnu �[��� PK a<�\^�{l} } �C classes/local/helpers/format.phpnu �[��� PK a<�\�e� % �N classes/local/helpers/aggregation.phpnu �[��� PK a<�\�(�b &[ classes/local/filters/base.phpnu �[��� PK a<�\5�!4� � �l classes/local/filters/number.phpnu �[��� PK a<�\�?A�@ �@ ʌ classes/local/filters/date.phpnu �[��� PK a<�\2���R R � classes/local/filters/cohort.phpnu �[��� PK a<�\��� " �� classes/local/filters/category.phpnu �[��� PK a<�\}��:! :! � classes/local/filters/tags.phpnu �[��� PK a<�\r� " � classes/local/filters/duration.phpnu �[��� PK a<�\U�tlS S & �! classes/local/filters/autocomplete.phpnu �[��� PK a<�\�7` ` �, classes/local/filters/user.phpnu �[��� PK a<�\=uƃ) ) H? classes/local/filters/text.phpnu �[��� PK a<�\~]��� � ( �\ classes/local/filters/boolean_select.phpnu �[��� PK a<�\<u!0 0 �j classes/local/filters/select.phpnu �[��� PK a<�\����� � " r classes/local/filters/filesize.phpnu �[��� PK a<�\�O�E E ) ]� classes/local/filters/course_selector.phpnu �[��� PK a<�\�9� � �� edit.phpnu �[��� PK a<�\@��� � � download.phpnu �[��� PK a<�\�;v�� � � UPGRADING.mdnu �[��� PK a<�\2W� � index.phpnu �[��� PK a<�\�� �� � R� view.phpnu �[��� PK a<�\��;<| | H� templates/toggle_card.mustachenu �[��� PK a<�\a��A� � � templates/report.mustachenu �[��� PK a<�\ �Ed� � �� templates/editor_navbar.mustachenu �[��� PK a<�\Tz� � & 0� templates/local/audience/form.mustachenu �[��� PK a<�\�0̔D D % � templates/local/report/debug.mustachenu �[��� PK a<�\��� , � templates/local/settings/conditions.mustachenu �[��� PK a<�\�nĿ � ) templates/local/settings/filters.mustachenu �[��� PK a<�\��>� ) & templates/local/settings/sorting.mustachenu �[��� PK a<�\Z8�KY Y / �, templates/local/settings/empty_message.mustachenu �[��� PK a<�\ �-'� � + A1 templates/local/settings/card_view.mustachenu �[��� PK a<�\�b�97 7 & �5 templates/local/settings/area.mustachenu �[��� PK a<�\�X��� � * #H templates/local/sidebar-menu/card.mustachenu �[��� PK a<�\C�V / CN templates/local/sidebar-menu/card_item.mustachenu �[��� PK a<�\VM��; ; * �U templates/local/sidebar-menu/area.mustachenu �[��� PK a<�\|��k, , * K_ templates/local/conditions/header.mustachenu �[��� PK a<�\� Up p * �f templates/local/conditions/footer.mustachenu �[��� PK a<�\g��r r ' �j templates/local/filters/header.mustachenu �[��� PK a<�\5nk]m m ' do templates/local/filters/footer.mustachenu �[��� PK a<�\U�S�U U % (s templates/local/filters/area.mustachenu �[��� PK a<�\ߵ� � + �{ templates/local/dynamictabs/access.mustachenu �[��� PK a<�\��r r - "� templates/local/dynamictabs/audience.mustachenu �[��� PK a<�\��� . � templates/local/dynamictabs/schedules.mustachenu �[��� PK a<�\���k k + Q� templates/local/dynamictabs/editor.mustachenu �[��� PK a<�\�P }� � $ � templates/table_header_cell.mustachenu �[��� PK a<�\m��MZ! Z! + � tests/behat/columnaggregationeditor.featurenu �[��� PK a<�\�ڟ�} } # �� tests/behat/behat_reportbuilder.phpnu �[��� PK a<�\���h�N �N ! q� tests/behat/customreports.featurenu �[��� PK a<�\ ���- �- �1 tests/behat/filtereditor.featurenu �[��� PK a<�\��U �_ tests/behat/columneditor.featurenu �[��� PK a<�\l7ZI I r tests/behat/audience.featurenu �[��� PK a<�\��S S q� tests/behat/cardview.featurenu �[��� PK a<�\�BTF F � tests/behat/schedules.featurenu �[��� PK a<�\_��S� � # �� tests/behat/conditioneditor.featurenu �[��� PK a<�\|R�X� � ' � tests/behat/columnsortingeditor.featurenu �[��� PK a<�\ � p�# �# - � tests/classes/core_reportbuilder_testcase.phpnu �[��� PK a<�\���� � > �B tests/external/custom_report_columns_sorting_exporter_test.phpnu �[��� PK a<�\�p�C C 8 �Z tests/external/custom_report_card_view_exporter_test.phpnu �[��� PK a<�\)��י � 6 �c tests/external/custom_report_details_exporter_test.phpnu �[��� PK a<�\bbwy� � . �n tests/external/systemreports/retrieve_test.phpnu �[��� PK a<�\!��� � . �~ tests/external/systemreports/can_view_test.phpnu �[��� PK a<�\ �� � ( ш tests/external/audiences/delete_test.phpnu �[��� PK a<�\�MWx x . � tests/external/custom_report_exporter_test.phpnu �[��� PK a<�\�cS� ' ۱ tests/external/reports/listing_test.phpnu �[��� PK a<�\Tj �� � & 3� tests/external/reports/delete_test.phpnu �[��� PK a<�\�tی ( @� tests/external/reports/retrieve_test.phpnu �[��� PK a<�\�<�#+ + # �� tests/external/reports/get_test.phpnu �[��� PK a<�\�6n31 1 $ � tests/external/reports/view_test.phpnu �[��� PK a<�\%�)&& & ( � tests/external/schedules/delete_test.phpnu �[��� PK a<�\N5��� � ( tests/external/schedules/toggle_test.phpnu �[��� PK a<�\Oz"`6 6 & 8% tests/external/schedules/send_test.phpnu �[��� PK a<�\ ��� � = �2 tests/external/custom_report_audience_cards_exporter_test.phpnu �[��� PK a<�\Y4g� � & �D tests/external/columns/delete_test.phpnu �[��� PK a<�\��� # U tests/external/columns/add_test.phpnu �[��� PK a<�\��~� � ' ic tests/external/columns/reorder_test.phpnu �[��� PK a<�\���; ; ( js tests/external/columns/sort/get_test.phpnu �[��� PK a<�\6Ut�m m , �� tests/external/columns/sort/reorder_test.phpnu �[��� PK a<�\���M# # + ƒ tests/external/columns/sort/toggle_test.phpnu �[��� PK a<�\$܄̕ � ) D� tests/external/conditions/delete_test.phpnu �[��� PK a<�\S$�� ( 2� tests/external/conditions/reset_test.phpnu �[��� PK a<�\ۡ~�� � & �� tests/external/conditions/add_test.phpnu �[��� PK a<�\,dN N * �� tests/external/conditions/reorder_test.phpnu �[��� PK a<�\��p� � 6 <� tests/external/custom_report_filters_exporter_test.phpnu �[��� PK a<�\e�7] 9 r� tests/external/custom_report_conditions_exporter_test.phpnu �[��� PK a<�\�L��� � 3 � tests/external/custom_report_data_exporter_test.phpnu �[��� PK a<�\��z z & tests/external/filters/delete_test.phpnu �[��� PK a<�\�!B� % �' tests/external/filters/reset_test.phpnu �[��� PK a<�\`�^ � � # >4 tests/external/filters/add_test.phpnu �[��� PK a<�\qxĺ� � ' lB tests/external/filters/reorder_test.phpnu �[��� PK a<�\�Gֱ* * # �S tests/external/filters/set_test.phpnu �[��� PK a<�\Ͷ� 3 1` tests/external/system_report_data_exporter_test.phpnu �[��� PK a<�\� y�� � . �l tests/external/system_report_exporter_test.phpnu �[��� PK a<�\3PL� � ; �y tests/external/custom_report_column_cards_exporter_test.phpnu �[��� PK a<�\v���� � � tests/lib_test.phpnu �[��� PK a<�\�=�� , �� tests/fixtures/system_report_unavailable.phpnu �[��� PK a<�\nr*N� � * p� tests/fixtures/system_report_available.phpnu �[��� PK a<�\��g / o� tests/fixtures/testable_system_report_table.phpnu �[��� PK a<�\J<7 * ܱ tests/output/report_name_editable_test.phpnu �[��� PK a<�\� �ų � 1 N� tests/output/column_aggregation_editable_test.phpnu �[��� PK a<�\��Qמ � - b� tests/output/filter_heading_editable_test.phpnu �[��� PK a<�\�د} } , ]� tests/output/schedule_name_editable_test.phpnu �[��� PK a<�\��˼� � - 6� tests/output/column_heading_editable_test.phpnu �[��� PK a<�\6�N / 1 tests/output/audience_heading_editable_test.phpnu �[��� PK a<�\���15 15 � tests/privacy/provider_test.phpnu �[��� PK a<�\3�Pd2 d2 F tests/datasource_test.phpnu �[��� PK a<�\���r r �x tests/generator_test.phpnu �[��� PK a<�\�'�[ [ �� tests/manager_test.phpnu �[��� PK a<�\zR� � � #� tests/system_report_test.phpnu �[��� PK a<�\I� � k� tests/generator/lib.phpnu �[��� PK a<�\%U>� � 6 �� tests/generator/behat_core_reportbuilder_generator.phpnu �[��� PK a<�\�a�<A <A � tests/permission_test.phpnu �[��� PK a<�\*��c c , �1 tests/reportbuilder/audience/admins_test.phpnu �[��� PK a<�\Z��̝ � , KC tests/reportbuilder/audience/manual_test.phpnu �[��� PK a<�\�`��� � 0 D[ tests/reportbuilder/audience/systemrole_test.phpnu �[��� PK a<�\`�V V . eq tests/reportbuilder/audience/allusers_test.phpnu �[��� PK a<�\�~�Ͳ. �. ! � tests/task/send_schedule_test.phpnu �[��� PK a<�\�t��� � $ � tests/system_report_factory_test.phpnu �[��� PK a<�\^F.� �� tests/helpers.phpnu �[��� PK a<�\�h��) �) " R� tests/local/entities/base_test.phpnu �[��� PK a<�\���& " C� tests/local/entities/user_test.phpnu �[��� PK a<�\I6�3* 3* � tests/local/report/base_test.phpnu �[��� PK a<�\G��F " 4 tests/local/report/filter_test.phpnu �[��� PK a<�\g�]�B �B " kN tests/local/report/column_test.phpnu �[��� PK a<�\��$� � " r� tests/local/report/action_test.phpnu �[��� PK a<�\0h-� � " [� tests/local/models/report_test.phpnu �[��� PK a<�\�F��O O $ �� tests/local/models/audience_test.phpnu �[��� PK a<�\tٕ< < $ N� tests/local/models/schedule_test.phpnu �[��� PK a<�\�>� $ �� tests/local/aggregation/min_test.phpnu �[��� PK a<�\�y�4� � , >� tests/local/aggregation/groupconcat_test.phpnu �[��� PK a<�\ӗl . i tests/local/aggregation/countdistinct_test.phpnu �[��� PK a<�\�)�� 4 � tests/local/aggregation/groupconcatdistinct_test.phpnu �[��� PK a<�\��I�� � $ G9 tests/local/aggregation/sum_test.phpnu �[��� PK a<�\r "�� � $ �K tests/local/aggregation/avg_test.phpnu �[��� PK a<�\��]t t & �] tests/local/aggregation/count_test.phpnu �[��� PK a<�\�;�: ( sh tests/local/aggregation/percent_test.phpnu �[��� PK a<�\%�� $ �r tests/local/aggregation/max_test.phpnu �[��� PK a<�\XF�6y 6y # C} tests/local/helpers/report_test.phpnu �[��� PK a<�\_f� # � tests/local/helpers/format_test.phpnu �[��� PK a<�\j� �� � % 0 tests/local/helpers/database_test.phpnu �[��� PK a<�\#���B �B % U tests/local/helpers/audience_test.phpnu �[��� PK a<�\ �9�J J * �c tests/local/helpers/custom_fields_test.phpnu �[��� PK a<�\*1 4? ? 0 � tests/local/helpers/user_filter_manager_test.phpnu �[��� PK a<�\g��"�F �F % �� tests/local/helpers/schedule_test.phpnu �[��� PK a<�\e�_y y ' � tests/local/helpers/join_trait_test.phpnu �[��� PK a<�\�'��<J <J 0 � tests/local/helpers/user_profile_fields_test.phpnu �[��� PK a<�\� � % <h tests/local/filters/category_test.phpnu �[��� PK a<�\@�akR6 R6 ! W tests/local/filters/date_test.phpnu �[��� PK a<�\ߩx�� � ! �� tests/local/filters/tags_test.phpnu �[��� PK a<�\�#�# # # =� tests/local/filters/number_test.phpnu �[��� PK a<�\͖� % �� tests/local/filters/duration_test.phpnu �[��� PK a<�\���� � + � tests/local/filters/boolean_select_test.phpnu �[��� PK a<�\����� � # � tests/local/filters/select_test.phpnu �[��� PK a<�\�<'�� � , " tests/local/filters/course_selector_test.phpnu �[��� PK a<�\ �3� � ) = tests/local/filters/autocomplete_test.phpnu �[��� PK a<�\��z� � ! P) tests/local/filters/text_test.phpnu �[��� PK a<�\8x I� � # W? tests/local/filters/cohort_test.phpnu �[��� PK a<�\&�8�i i % \L tests/local/filters/filesize_test.phpnu �[��� PK a<�\J�* * ! \ tests/local/filters/user_test.phpnu �[��� PK a<�\���& & �j amd/src/reports_list.jsnu �[��� PK a<�\�g4�� � ~ amd/src/editor.jsnu �[��� PK a<�\�� (E' E' #� amd/src/audience.jsnu �[��� PK a<�\cqW� � �� amd/src/sidebar.jsnu �[��� PK a<�\��q� � �� amd/src/filters.jsnu �[��� PK a<�\�w_f� � �� amd/src/schedules.jsnu �[��� PK a<�\��O�� � # �� amd/src/local/repository/sorting.jsnu �[��� PK a<�\�xs�8 8 % x� amd/src/local/repository/audiences.jsnu �[��� PK a<�\��PZ& & " amd/src/local/repository/modals.jsnu �[��� PK a<�\��:�� � # } amd/src/local/repository/filters.jsnu �[��� PK a<�\j�TW W % s amd/src/local/repository/schedules.jsnu �[��� PK a<�\D��fn n # " amd/src/local/repository/reports.jsnu �[��� PK a<�\��5�� � & �( amd/src/local/repository/conditions.jsnu �[��� PK a<�\G�N�> > # �2 amd/src/local/repository/columns.jsnu �[��� PK a<�\�5�TJ J w; amd/src/local/events.jsnu �[��� PK a<�\}�� C amd/src/local/selectors.jsnu �[��� PK a<�\[]� gT amd/src/local/editor/sorting.jsnu �[��� PK a<�\���7 7 �s amd/src/local/editor/filters.jsnu �[��� PK a<�\�� $� � ! V� amd/src/local/editor/card_view.jsnu �[��� PK a<�\�0�h�) �) " �� amd/src/local/editor/conditions.jsnu �[��� PK a<�\����" �" �� amd/src/local/editor/columns.jsnu �[��� PK a<�\`�6 � � �� amd/src/report.jsnu �[��� PK a<�\���l l � amd/build/schedules.min.jsnu �[��� PK a<�\QP� � � amd/build/filters.min.jsnu �[��� PK a<�\r�z� � �" amd/build/filters.min.js.mapnu �[��� PK a<�\>O�l l �: amd/build/editor.min.js.mapnu �[��� PK a<�\%�� SR amd/build/sidebar.min.js.mapnu �[��� PK a<�\}���E E �f amd/build/sidebar.min.jsnu �[��� PK a<�\U�Z�C+ C+ As amd/build/schedules.min.js.mapnu �[��� PK a<�\nK� � Ҟ amd/build/audience.min.jsnu �[��� PK a<�\�KiO O ! � amd/build/reports_list.min.js.mapnu �[��� PK a<�\�^�� � �� amd/build/editor.min.jsnu �[��� PK a<�\�%p� z� amd/build/reports_list.min.jsnu �[��� PK a<�\P��. . � amd/build/report.min.jsnu �[��� PK a<�\,w뗓8 �8 J amd/build/audience.min.js.mapnu �[��� PK a<�\�8d� *> amd/build/report.min.js.mapnu �[��� PK a<�\O`�)� � + �U amd/build/local/repository/schedules.min.jsnu �[��� PK a<�\6��a� � ) �Z amd/build/local/repository/sorting.min.jsnu �[��� PK a<�\f苜} } - ` amd/build/local/repository/reports.min.js.mapnu �[��� PK a<�\y � � � , �h amd/build/local/repository/modals.min.js.mapnu �[��� PK a<�\U��� � ) 9u amd/build/local/repository/reports.min.jsnu �[��� PK a<�\D�� � ) {y amd/build/local/repository/filters.min.jsnu �[��� PK a<�\���J� � ) n� amd/build/local/repository/columns.min.jsnu �[��� PK a<�\'Wv5� � - z� amd/build/local/repository/filters.min.js.mapnu �[��� PK a<�\�&[5 / � amd/build/local/repository/schedules.min.js.mapnu �[��� PK a<�\�ۡ�N N ( � amd/build/local/repository/modals.min.jsnu �[��� PK a<�\�-�� � , �� amd/build/local/repository/conditions.min.jsnu �[��� PK a<�\A�� � 0 �� amd/build/local/repository/conditions.min.js.mapnu �[��� PK a<�\��p�� � + ι amd/build/local/repository/audiences.min.jsnu �[��� PK a<�\4��Ѿ � / � amd/build/local/repository/audiences.min.js.mapnu �[��� PK a<�\ 7̍> > - =� amd/build/local/repository/sorting.min.js.mapnu �[��� PK a<�\��f0� � - �� amd/build/local/repository/columns.min.js.mapnu �[��� PK a<�\�|KZ� � $ /� amd/build/local/selectors.min.js.mapnu �[��� PK a<�\d�RF� � *� amd/build/local/selectors.min.jsnu �[��� PK a<�\?���P P ! _ amd/build/local/events.min.js.mapnu �[��� PK a<�\�97th h amd/build/local/events.min.jsnu �[��� PK a<�\�ZBps s % � amd/build/local/editor/sorting.min.jsnu �[��� PK b<�\�z�7 7 % }# amd/build/local/editor/filters.min.jsnu �[��� PK b<�\ o� % < amd/build/local/editor/columns.min.jsnu �[��� PK b<�\01�d�+ �+ ) }X amd/build/local/editor/filters.min.js.mapnu �[��� PK b<�\ ��a a ' r� amd/build/local/editor/card_view.min.jsnu �[��� PK b<�\�* ��! �! ( *� amd/build/local/editor/conditions.min.jsnu �[��� PK b<�\��fܝ � + � amd/build/local/editor/card_view.min.js.mapnu �[��� PK b<�\ ��q�; �; , � amd/build/local/editor/conditions.min.js.mapnu �[��� PK b<�\.ҹ�"- "- ) � amd/build/local/editor/sorting.min.js.mapnu �[��� PK b<�\i>�@�1 �1 ) �' amd/build/local/editor/columns.min.js.mapnu �[��� PK b<�\�'�o) o) �Y upgrade.txtnu �[��� PK ]]?� ��
| ver. 1.4 |
Github
|
.
| PHP 8.3.30 | Generation time: 0.11 |
proxy
|
phpinfo
|
Settings