[Summary view]

Differences Between: [Versions 310 and 402] [Versions 310 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  /**
  18   * Renderer.
  19   *
  20   * @package    core_h5p
  21   * @copyright  2020 Victor Deniz {victor@moodle.com}
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  namespace core_h5p\output;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use plugin_renderer_base;
  30  
  31  /**
  32   * Renderer class.
  33   *
  34   * @package    core_h5p
  35   * @copyright  2020 Victor Deniz {victor@moodle.com}
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class renderer extends plugin_renderer_base {
  39  
  40      /**
  41       * Alter which stylesheets are loaded for H5P.
  42       * This is useful for adding custom styles or replacing existing ones.
  43       *
  44       * @param array|object $scripts List of stylesheets that will be loaded
  45       * @param array $libraries Array of libraries indexed by the library's machineName
  46       * @param string $embedtype Possible values: div, iframe, external, editor
  47       */
  48      public function h5p_alter_styles(&$scripts, array $libraries, string $embedtype) {
  49      }
  50  
  51      /**
  52       * Alter which scripts are loaded for H5P.
  53       * This is useful for adding custom scripts or replacing existing ones.
  54       *
  55       * @param array|object $scripts List of JavaScripts that will be loaded
  56       * @param array $libraries Array of libraries indexed by the library's machineName
  57       * @param string $embedtype Possible values: div, iframe, external, editor
  58       */
  59      public function h5p_alter_scripts(&$scripts, array $libraries, string $embedtype) {
  60      }
  61  
  62      /**
  63       * Alter semantics before they are processed. This is useful for changing
  64       * how the editor looks and how content parameters are filtered.
  65       *
  66       * @param object|object $semantics Semantics as object
  67       * @param string $name Machine name of library
  68       * @param int $majorversion Major version of library
  69       * @param int $minorversion Minor version of library
  70       */
  71      public function h5p_alter_semantics(&$semantics, $name, $majorversion, $minorversion) {
  72      }
  73  
  74      /**
  75       * Alter parameters of H5P content after it has been filtered through semantics.
  76       * This is useful for adapting the content to the current context.
  77       *
  78       * @param array|object $parameters The content parameters for the library
  79       * @param string $name The machine readable name of the library
  80       * @param int $majorversion Major version of the library
  81       * @param int $minorversion Minor version of the library
  82       */
  83      public function h5p_alter_filtered_parameters(&$parameters, string $name, int $majorversion, int $minorversion) {
  84      }
  85  }