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\external;
  20  
  21  use core\external\exporter;
  22  
  23  /**
  24   * Custom report menu cards exporter abstract class
  25   *
  26   * @package     core_reportbuilder
  27   * @copyright   2021 David Matamoros <davidmc@moodle.com>
  28   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  29   */
  30  abstract class custom_report_menu_cards_exporter extends exporter {
  31  
  32      /**
  33       * Return the list of additional properties for read structure and export
  34       *
  35       * @return array[]
  36       */
  37      protected static function define_other_properties(): array {
  38          return [
  39              'menucards' => [
  40                  'type' => [
  41                      'name' => [
  42                          'type' => PARAM_TEXT,
  43                      ],
  44                      'key' => [
  45                          'type' => PARAM_TEXT,
  46                      ],
  47                      'items' => [
  48                          'type' => [
  49                              'name' => [
  50                                  'type' => PARAM_TEXT,
  51                              ],
  52                              'identifier' => [
  53                                  'type' => PARAM_TEXT,
  54                              ],
  55                              'title' => [
  56                                  'type' => PARAM_TEXT,
  57                              ],
  58                              'action' => [
  59                                  'type' => PARAM_TEXT,
  60                              ],
  61                              'disabled' => [
  62                                  'type' => PARAM_BOOL,
  63                                  'optional' => true,
  64                                  'default' => false,
  65                              ],
  66                          ],
  67                          'optional' => true,
  68                          'multiple' => true,
  69                      ],
  70                  ],
  71                  'optional' => true,
  72                  'multiple' => true,
  73              ],
  74          ];
  75      }
  76  }