[Summary view]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\external;
  20  
  21  use renderer_base;
  22  use core\external\exporter;
  23  use core_reportbuilder\system_report;
  24  use core_reportbuilder\table\system_report_table;
  25  
  26  /**
  27   * System report data exporter class
  28   *
  29   * @package     core_reportbuilder
  30   * @copyright   2023 Paul Holden <paulh@moodle.com>
  31   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32   */
  33  class system_report_data_exporter extends exporter {
  34  
  35      /**
  36       * Return a list of objects that are related to the exporter
  37       *
  38       * @return array
  39       */
  40      protected static function define_related(): array {
  41          return [
  42              'report' => system_report::class,
  43              'page' => 'int',
  44              'perpage' => 'int',
  45          ];
  46      }
  47  
  48      /**
  49       * Return the list of additional properties for read structure and export
  50       *
  51       * @return array[]
  52       */
  53      protected static function define_other_properties(): array {
  54          return [
  55              'headers' => [
  56                  'type' => PARAM_RAW,
  57                  'multiple' => true,
  58              ],
  59              'rows' => [
  60                  'type' => [
  61                      'columns' => [
  62                          'type' => PARAM_RAW,
  63                          'null' => NULL_ALLOWED,
  64                          'multiple' => true,
  65                      ],
  66                  ],
  67                  'multiple' => true,
  68              ],
  69              'totalrowcount' => ['type' => PARAM_INT],
  70          ];
  71      }
  72  
  73      /**
  74       * Get the additional values to inject while exporting
  75       *
  76       * @param renderer_base $output
  77       * @return array
  78       */
  79      protected function get_other_values(renderer_base $output): array {
  80          global $DB;
  81  
  82          /** @var system_report $report */
  83          $report = $this->related['report'];
  84  
  85          $table = system_report_table::create($report->get_report_persistent()->get('id'), $report->get_parameters());
  86          $table->guess_base_url();
  87          $table->setup();
  88  
  89          // Internally the current page is zero-based, but this method expects value plus one.
  90          $table->set_page_number($this->related['page'] + 1);
  91          $table->query_db($this->related['perpage'], false);
  92  
  93          // Ensure we only return defined columns, excluding those such as "select all" and "actions".
  94          $columnsbyalias = $report->get_active_columns_by_alias();
  95  
  96          $tableheaders = array_combine(array_flip($table->columns), $table->headers);
  97          $tableheaders = array_intersect_key($tableheaders, $columnsbyalias);
  98  
  99          $tablerows = [];
 100          foreach ($table->rawdata as $record) {
 101              $columns = array_intersect_key($table->format_row($record), $columnsbyalias);
 102              $tablerows[] = [
 103                  'columns' => array_values($columns),
 104              ];
 105          }
 106  
 107          $table->close_recordset();
 108  
 109          return [
 110              'headers' => array_values($tableheaders),
 111              'rows' => $tablerows,
 112              'totalrowcount' => $DB->count_records_sql($table->countsql, $table->countparams),
 113          ];
 114      }
 115  }