Search moodle.org's
Developer Documentation

See Release Notes

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

Differences Between: [Versions 400 and 402]

   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\output;
  20  
  21  use renderable;
  22  use renderer_base;
  23  use stdClass;
  24  use templatable;
  25  use core_reportbuilder\system_report as system_report_base;
  26  use core_reportbuilder\external\system_report_exporter;
  27  use core_reportbuilder\local\models\report;
  28  
  29  /**
  30   * System report output class
  31   *
  32   * @package     core_reportbuilder
  33   * @copyright   2020 Paul Holden <paulh@moodle.com>
  34   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class system_report implements renderable, templatable {
  37  
  38      /** @var report $report */
  39      protected $report;
  40  
  41      /** @var system_report_base $source */
  42      protected $source;
  43  
  44      /** @var array $parameters */
  45      protected $parameters;
  46  
  47      /**
  48       * Class constructor
  49       *
  50       * @param report $report
  51       * @param system_report_base $source
  52       * @param array $parameters
  53       */
  54      public function __construct(report $report, system_report_base $source, array $parameters) {
  55          $this->report = $report;
  56          $this->source = $source;
  57          $this->parameters = $parameters;
  58      }
  59  
  60      /**
  61       * Export report data suitable for a template
  62       *
  63       * @param renderer_base $output
  64       * @return stdClass
  65       */
  66      public function export_for_template(renderer_base $output): stdClass {
  67          $exporter = new system_report_exporter($this->report, [
  68              'source' => $this->source,
  69              'parameters' => json_encode($this->parameters),
  70          ]);
  71  
  72          return $exporter->export($output);
  73      }
  74  }