[Summary view]

   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 core_tag_tag;
  20  use mod_data\manager;
  21  use templatable;
  22  use renderable;
  23  
  24  /**
  25   * Renderable class for the default templates in the database activity.
  26   *
  27   * @package    mod_data
  28   * @copyright  2022 Sara Arjona <sara@moodle.com>
  29   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  30   */
  31  class defaulttemplate implements templatable, renderable {
  32  
  33      /** @var array $fields The array containing the existing fields. */
  34      private $fields;
  35  
  36      /** @var string $templatename The template name (addtemplate, listtemplate...). */
  37      private $templatename;
  38  
  39      /** @var bool $isform Whether a form should be displayed instead of data. */
  40      private $isform;
  41  
  42      /**
  43       * The class constructor.
  44       *
  45       * @param array $fields The array containing the existing fields.
  46       * @param string $templatename The template name (addtemplate, listtemplate...).
  47       * @param bool $isform Whether a form should be displayed instead of data.
  48       */
  49      public function __construct(array $fields, string $templatename, bool $isform) {
  50          $this->fields = $fields;
  51          $this->templatename = $templatename;
  52          $this->isform = $isform;
  53      }
  54  
  55      /**
  56       * Obtains the mustache template name for this database template.
  57       *
  58       * @return string the file mustache path for this template.
  59       */
  60      public function get_templatename(): string {
  61          return 'mod_data/defaulttemplate_' . $this->templatename;
  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 The data to display.
  69       */
  70      public function export_for_template(\renderer_base $output): array {
  71          $result = [];
  72          $exportedfields = [];
  73          foreach ($this->fields as $field) {
  74              $fieldname = $field->field->name;
  75              if ($this->isform) {
  76                  $fieldcontent = $field->display_add_field();
  77              } else {
  78                  $fieldcontent = '[[' . $fieldname . ']]';
  79              }
  80              $exportedfields[] = [
  81                  'fieldname' => $fieldname,
  82                  'fieldcontent' => $fieldcontent,
  83              ];
  84          }
  85  
  86          if (!empty($exportedfields)) {
  87              $result['fields'] = $exportedfields;
  88          }
  89  
  90          if (core_tag_tag::is_enabled(manager::PLUGINNAME, 'data_records')) {
  91              // Add tags information only if they are enabled.
  92              if ($this->isform) {
  93                  $tags = data_generate_tag_form();
  94              } else {
  95                  $tags = '##tags##';
  96              }
  97              $result['tags'] = $tags;
  98          }
  99  
 100          return $result;
 101      }
 102  }