moodle/reportbuilder/classes/external/custom_report_exporter.php

<?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_reportbuilder\local\helpers\report as report_helper;

/**
 * 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 bool $showeditbutton When showing the report on view.php the Edit button has to be hidden */
    protected $showeditbutton;

    /** @var string */
    protected $download;

    /**
     * report_exporter constructor.
     *
     * @param persistent $persistent
     * @param array $related
     * @param bool $editmode
     * @param bool $showeditbutton
     * @param string $download
     */
    public function __construct(persistent $persistent, array $related = [], bool $editmode = true,
            bool $showeditbutton = true, string $download = '') {

        parent::__construct($persistent, $related);
        $this->editmode = $editmode;
        $this->showeditbutton = $showeditbutton;
        $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 [
        ];
    }

    /**
     * Return a list of additional properties used only for display
     *
     * @return array
     */
    protected static function define_other_properties(): array {
        return [
            'table' => ['type' => PARAM_RAW],
            'sidebarmenucards' => ['type' => custom_report_menu_cards_exporter::read_properties_definition()],
            'conditions' => ['type' => custom_report_conditions_exporter::read_properties_definition()],
            'filters' => ['type' => custom_report_filters_exporter::read_properties_definition()],
            'sorting' => ['type' => custom_report_columns_sorting_exporter::read_properties_definition()],
            'filtersapplied' => ['type' => PARAM_INT],
            'filtersform' => [
                'type' => PARAM_RAW,
                'optional' => true,
            ],
            'editmode' => ['type' => PARAM_INT],
            'showeditbutton' => ['type' => PARAM_BOOL],
            '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 {
        $filtersform = '';
        $menucards = [];

        if ($this->editmode) {
            $table = custom_report_table::create($this->persistent->get('id'));
            $table->set_filterset(new custom_report_table_filterset());
        } else {
            $table = custom_report_table_view::create($this->persistent->get('id'), $this->download);
            $table->set_filterset(new custom_report_table_view_filterset());

            // Generate filters form if report contains any filters.
            $source = $this->persistent->get('source');
            /** @var datasource $datasource */
            $datasource = new $source($this->persistent);

            if (!empty($datasource->get_active_filters())) {
                $filtersform = $this->generate_filters_form()->render();
            }
        }

        $report = manager::get_report_from_persistent($this->persistent);

        $conditionsexporter = new custom_report_conditions_exporter(null, ['report' => $report]);
        $filtersexporter = new custom_report_filters_exporter(null, ['report' => $report]);
        $sortingexporter = new custom_report_columns_sorting_exporter(null, ['report' => $report]);
        if ($this->editmode) {
            $menucardexporter = new custom_report_menu_cards_exporter(null, [
                'menucards' => report_helper::get_available_columns($report->get_report_persistent())
            ]);
            $menucards = (array) $menucardexporter->export($output);
        }

        return [
            'table' => $output->render($table),
            'sidebarmenucards' => $menucards,
            'conditions' => (array) $conditionsexporter->export($output),
            'filters' => (array) $filtersexporter->export($output),
            'sorting' => (array) $sortingexporter->export($output),
            'filtersapplied' => $report->get_applied_filter_count(),
            'filtersform' => $filtersform,
            'editmode' => (int)$this->editmode,
            'showeditbutton' => $this->showeditbutton,
            'javascript' => '',
        ];
    }

    /**
     * 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;
    }
}