Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 4.1.x will end 13 November 2023 (12 months).
  • Bug fixes for security issues in 4.1.x will end 10 November 2025 (36 months).
  • PHP version: minimum PHP 7.4.0 Note: minimum PHP version has increased since Moodle 4.0. PHP 8.0.x is supported too.

Differences Between: [Versions 400 and 401]

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