[Summary view]

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  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 \url_select $urlselect The URL selector object. */
  35      private $urlselect;
  36  
  37      /** @var \single_select|null $fieldselect The field selector object or null. */
  38      private $fieldselect;
  39  
  40      /** @var \single_button|null $saveaspresetbutton The save as preset single button object or null. */
  41      private $saveaspresetbutton;
  42  
  43      /** @var \single_button|null $exportpresetbutton The export preset single button object or null. */
  44      private $exportpresetbutton;
  45  
  46      /**
  47       * The class constructor.
  48       *
  49       * @param int $id The database module id
  50       * @param \url_select $urlselect The URL selector object
  51       * @param \single_select|null $fieldselect The field selector object or null
  52       * @param \single_button|null $saveaspresetbutton The save as preset single button object or null
  53       * @param \single_button|null $exportpresetbutton The export preset single button object or null
  54       */
  55      public function __construct(int $id, \url_select $urlselect, ?\single_select $fieldselect = null,
  56              ?\single_button $saveaspresetbutton = null, ?\single_button $exportpresetbutton = null) {
  57          $this->id = $id;
  58          $this->urlselect = $urlselect;
  59          $this->fieldselect = $fieldselect;
  60          $this->saveaspresetbutton = $saveaspresetbutton;
  61          $this->exportpresetbutton = $exportpresetbutton;
  62      }
  63  
  64      /**
  65       * Export the data for the mustache template.
  66       *
  67       * @param \renderer_base $output The renderer to be used to render the action bar elements.
  68       * @return array
  69       */
  70      public function export_for_template(\renderer_base $output): array {
  71  
  72          $data = [
  73              'd' => $this->id,
  74              'urlselect' => $this->urlselect->export_for_template($output),
  75          ];
  76  
  77          if ($this->fieldselect) {
  78              $data['fieldselect'] = $this->fieldselect->export_for_template($output);
  79          }
  80  
  81          $data['saveaspreset'] = $this->saveaspresetbutton;
  82  
  83          if ($this->exportpresetbutton) {
  84              $data['exportpreset'] = $this->exportpresetbutton->export_for_template($output);
  85          }
  86  
  87          return $data;
  88      }
  89  }