[Summary view]

Differences Between: [Versions 400 and 401] [Versions 401 and 402] [Versions 401 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  namespace mod_data\output;
  18  
  19  use templatable;
  20  use renderable;
  21  
  22  /**
  23   * Renderable class for the action bar elements in the field pages in the database activity.
  24   *
  25   * @package    mod_data
  26   * @copyright  2021 Mihail Geshoski <mihail@moodle.com>
  27   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  28   */
  29  class fields_action_bar implements templatable, renderable {
  30  
  31      /** @var int $id The database module id. */
  32      private $id;
  33  
  34      /** @var \action_menu|null $fieldselect The field selector object or null. */
  35      private $fieldselect;
  36  
  37      /**
  38       * The class constructor.
  39       *
  40       * @param int $id The database module id
  41       * @param null $unused1 This parameter has been deprecated since 4.1 and should not be used anymore.
  42       * @param null $unused2 This parameter has been deprecated since 4.1 and should not be used anymore.
  43       * @param null $unused3 This parameter has been deprecated since 4.1 and should not be used anymore.
  44       * @param null $unused4 This parameter has been deprecated since 4.1 and should not be used anymore.
  45       * @param \action_menu|null $fieldselect The field selector object or null
  46       */
  47      public function __construct(int $id, $unused1 = null, $unused2 = null,
  48              $unused3 = null, $unused4 = null,
  49              ?\action_menu $fieldselect = null) {
  50  
  51          if ($unused1 !== null || $unused2 !== null || $unused3 !== null || $unused4 !== null) {
  52              debugging('Deprecated argument passed to fields_action_bar constructor', DEBUG_DEVELOPER);
  53          }
  54  
  55          $this->id = $id;
  56          $this->fieldselect = $fieldselect;
  57      }
  58  
  59      /**
  60       * Export the data for the mustache template.
  61       *
  62       * @param \renderer_base $output The renderer to be used to render the action bar elements.
  63       * @return array
  64       */
  65      public function export_for_template(\renderer_base $output): array {
  66  
  67          $data = [
  68              'd' => $this->id,
  69              'tertiarytitle' => get_string('managefields', 'mod_data'),
  70          ];
  71  
  72          if ($this->fieldselect) {
  73              $data['fieldselect'] = $this->fieldselect->export_for_template($output);
  74          }
  75  
  76          return $data;
  77      }
  78  }