[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  /**
  18   * Moodle Component Library
  19   *
  20   * A sample dynamic tab page.
  21   *
  22   * @package    tool_componentlibrary
  23   * @copyright  2021 David Matamoros <davidmc@moodle.com>
  24   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  25   */
  26  
  27  declare(strict_types=1);
  28  
  29  namespace tool_componentlibrary\local\examples\dynamictabs;
  30  
  31  use core\output\dynamic_tabs\base;
  32  use renderer_base;
  33  use stdClass;
  34  
  35  /**
  36   * Example tab class
  37   *
  38   * @package     tool_componentlibrary
  39   * @copyright   2021 David Matamoros <davidmc@moodle.com>
  40   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class tab1 extends base {
  43  
  44      /**
  45       * Export this for use in a mustache template context.
  46       *
  47       * @param renderer_base $output
  48       *
  49       * @return stdClass
  50       */
  51      public function export_for_template(renderer_base $output) {
  52          $content = (object)[];
  53          $content->customtext = 'Tab 1 content example';
  54          return $content;
  55      }
  56  
  57      /**
  58       * The label to be displayed on the tab
  59       *
  60       * @return string
  61       */
  62      public function get_tab_label(): string {
  63          return 'Tab 1';
  64      }
  65  
  66      /**
  67       * Check permission of the current user to access this tab
  68       *
  69       * @return bool
  70       */
  71      public function is_available(): bool {
  72          // Define the correct permissions here.
  73          return true;
  74      }
  75  
  76      /**
  77       * Template to use to display tab contents
  78       *
  79       * @return string
  80       */
  81      public function get_template(): string {
  82          return 'tool_componentlibrary/examples/dynamictabs/tab1';
  83      }
  84  }