Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.0.x will end 8 May 2023 (12 months).
  • Bug fixes for security issues in 4.0.x will end 13 November 2023 (18 months).
  • PHP version: minimum PHP 7.3.0 Note: the minimum PHP version has increased since Moodle 3.10. PHP 7.4.x is also supported.

Differences Between: [Versions 400 and 401] [Versions 400 and 402] [Versions 400 and 403]

   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 core_reportbuilder\external\custom_report_exporter;
  22  use core_reportbuilder\local\models\report;
  23  use renderable;
  24  use renderer_base;
  25  use stdClass;
  26  use templatable;
  27  
  28  /**
  29   * Custom report output class
  30   *
  31   * @package     core_reportbuilder
  32   * @copyright   2021 David Matamoros <davidmc@moodle.com>
  33   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class custom_report implements renderable, templatable {
  36  
  37      /** @var report $reportpersistent */
  38      protected $persistent;
  39  
  40      /** @var bool $editmode */
  41      protected $editmode;
  42  
  43      /** @var string $download */
  44      protected $download;
  45  
  46      /**
  47       * Class constructor
  48       *
  49       * @param report $reportpersistent
  50       * @param bool $editmode
  51       * @param string $download
  52       */
  53      public function __construct(report $reportpersistent, bool $editmode = true, string $download = '') {
  54          $this->persistent = $reportpersistent;
  55          $this->editmode = $editmode;
  56          $this->download = $download;
  57      }
  58  
  59      /**
  60       * Export report data suitable for a template
  61       *
  62       * @param renderer_base $output
  63       * @return stdClass
  64       */
  65      public function export_for_template(renderer_base $output): stdClass {
  66          $exporter = new custom_report_exporter($this->persistent, [], $this->editmode, $this->download);
  67  
  68          return $exporter->export($output);
  69      }
  70  }