[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   * Activity Chooser footer data class.
  19   *
  20   * @package    core
  21   * @subpackage course
  22   * @copyright  2020 Mathew May <mathew.solutions>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core_course\local\entity;
  27  
  28  /**
  29   * A class to represent the Activity Chooser footer data.
  30   *
  31   * @package    core
  32   * @subpackage course
  33   * @copyright  2020 Mathew May <mathew.solutions>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  35   */
  36  class activity_chooser_footer {
  37  
  38      /** @var string $footerjspath The path to the plugin JS file to dynamically import later. */
  39      protected $footerjspath;
  40  
  41      /** @var string $footertemplate The rendered template for the footer. */
  42      protected $footertemplate;
  43  
  44      /** @var string $carouseltemplate The rendered template for the footer. */
  45      protected $carouseltemplate;
  46  
  47      /**
  48       * Constructor method.
  49       *
  50       * @param string $footerjspath JS file to dynamically import later.
  51       * @param string $footertemplate Footer template that has been rendered.
  52       * @param string|null $carouseltemplate Carousel template that may have been rendered.
  53       */
  54      public function __construct(string $footerjspath, string $footertemplate, ?string $carouseltemplate = '') {
  55          $this->footerjspath = $footerjspath;
  56          $this->footertemplate = $footertemplate;
  57          $this->carouseltemplate = $carouseltemplate;
  58      }
  59  
  60      /**
  61       *  Get the footer JS file path for this plugin.
  62       *
  63       * @return string The JS file to call functions from.
  64       */
  65      public function get_footer_js_file(): string {
  66          return $this->footerjspath;
  67      }
  68  
  69      /**
  70       * Get the footer rendered template for this plugin.
  71       *
  72       * @return string The template that has been rendered for the chooser footer.
  73       */
  74      public function get_footer_template(): string {
  75          return $this->footertemplate;
  76      }
  77  
  78      /**
  79       * Get the carousel rendered template for this plugin.
  80       *
  81       * @return string The template that has been rendered for the chooser carousel.
  82       */
  83      public function get_carousel_template(): string {
  84          return $this->carouseltemplate;
  85      }
  86  }