[Summary view] [Print] [Text 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   * Mustache helper that will add JS to the end of the page.
  19   *
  20   * @package    core
  21   * @category   output
  22   * @copyright  2015 Damyon Wiese
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  namespace core\output;
  27  
  28  /**
  29   * Store a list of JS calls to insert at the end of the page.
  30   *
  31   * @copyright  2015 Damyon Wiese
  32   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   * @since      2.9
  34   */
  35  class mustache_javascript_helper {
  36  
  37      /** @var page_requirements_manager $requires - Page requirements manager for collecting JS calls. */
  38      private $requires = null;
  39  
  40      /**
  41       * Create new instance of mustache javascript helper.
  42       *
  43       * @param page_requirements_manager $requires Page requirements manager.
  44       */
  45      public function __construct($requires) {
  46          $this->requires = $requires;
  47      }
  48  
  49      /**
  50       * Add the block of text to the page requires so it is appended in the footer. The
  51       * content of the block can contain further mustache tags which will be resolved.
  52       *
  53       * @param string $text The script content of the section.
  54       * @param \Mustache_LambdaHelper $helper Used to render the content of this block.
  55       */
  56      public function help($text, \Mustache_LambdaHelper $helper) {
  57          $this->requires->js_amd_inline($helper->render($text));
  58      }
  59  }