renderers.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Boost Union renderer class. This file is currently only used to extend the mod_h5p and mod_hvp renderers.
 *
 * @package   theme_boost_union
 * @copyright 2022 Nina Herrmann <nina.herrmann@gmx.de>
 * @copyright on behalf of Alexander Bias, lern.link GmbH <alexander.bias@lernlink.de>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

/**
 * Extend the core_h5p renderer.
 *
 * @package   theme_boost_union
 * @copyright 2022 Nina Herrmann <nina.herrmann@gmx.de>
 * @copyright on behalf of Alexander Bias, lern.link GmbH <alexander.bias@lernlink.de>
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class theme_boost_union_core_h5p_renderer extends \core_h5p\output\renderer {

    /**
     * Add CSS styles when H5P content is displayed in core_h5p.
     *
     * @param array $styles Styles that will be applied.
     * @param array $libraries Libraries that wil be shown.
     * @param string $embedtype How the H5P is displayed.
     */
    public function h5p_alter_styles(&$styles, $libraries, $embedtype) {
        global $CFG;

        // Build the H5P CSS file URL.
        $h5pcssurl = new core\url('/theme/boost_union/h5p/styles.php');

        // Add the CSS file path and a version (to support browser caching) to H5P.
        $styles[] = (object) [
                'path' => $h5pcssurl->out(),
                'version' => '?ver='.theme_get_revision(),
        ];

        // If the local_och5pcore plugin is installed, add some more styles.
        if (file_exists($CFG->dirroot.'/local/och5pcore/version.php')) {
            // If H5P interactive videos are installed.
            if (isset($libraries['H5P.InteractiveVideo']) && $libraries['H5P.InteractiveVideo']['majorVersion'] == '1') {
                // Adding H5PEditor css file.
                $h5peditoravurl = new core\url('/local/och5pcore/lib/style/H5PEditor.AV.css');
                $styles[] = (object) [
                    'path' => $h5peditoravurl->out(),
                    'version' => '?ver='.theme_get_revision(),
                ];

                // Adding opencast font css file.
                $ocfontsurl = new core\url('/local/och5pcore/lib/style/oc-fonts.css');
                $styles[] = (object) [
                    'path' => $ocfontsurl->out(),
                    'version' => '?ver='.theme_get_revision(),
                ];
            }
        }
    }

    /**
     * Add scripts when an H5P is displayed.
     *
     * @param array $scripts Scripts that will be applied.
     * @param array $libraries Libraries that will be displayed.
     * @param string $embedtype How the H5P is displayed.
     */
    public function h5p_alter_scripts(&$scripts, $libraries, $embedtype) {
        global $CFG;

        // If the local_och5pcore plugin is installed, add some more scripts.
        if (file_exists($CFG->dirroot.'/local/och5pcore/version.php')) {
            // If H5P interactive videos are installed.
            if (isset($libraries['H5P.InteractiveVideo']) && $libraries['H5P.InteractiveVideo']['majorVersion'] == '1') {
                // Adding LTI related script into scripts array.
                $h5prunltiurl = new core\url('/local/och5pcore/lib/js/H5PRunLTI.js');
                $scripts[] = (object) [
                    'path' => $h5prunltiurl->out(),
                    'version' => '?ver='.theme_get_revision(),
                ];

                // Adding editor script to scripts array.
                $h5peditoravurl = new core\url('/local/och5pcore/lib/js/H5PEditor.AV.js');
                $scripts[] = (object) [
                    'path' => $h5peditoravurl->out(),
                    'version' => '?ver='.theme_get_revision(),
                ];
            }
        }
    }
}

// Only if mod_hvp is installed.
if (file_exists($CFG->dirroot.'/mod/hvp/renderer.php')) {
    // Load the mod_hvp renderer.
    require_once($CFG->dirroot.'/mod/hvp/renderer.php');

    // If the mod_hvp_renderer exists now.
    if (class_exists('mod_hvp_renderer')) {
        /**
         * Add CSS styles when H5P content is displayed in mod_hvp.
         *
         * @package   theme_boost_union
         * @copyright 2022 Nina Herrmann <nina.herrmann@gmx.de>
         * @copyright on behalf of Alexander Bias, lern.link GmbH <alexander.bias@lernlink.de>
         * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
         */
        class theme_boost_union_mod_hvp_renderer extends mod_hvp_renderer {

            /**
             * Add styles when an H5(V)P is displayed.
             *
             * @param array $styles Styles that will be applied.
             * @param array $libraries Libraries that wil be shown.
             * @param string $embedtype How the H5P is displayed.
             */
            public function hvp_alter_styles(&$styles, $libraries, $embedtype) {
                global $CFG;

                // Build the H5P CSS file URL.
                $h5pcssurl = new core\url('/theme/boost_union/h5p/styles.php');

                // Add the CSS file path and a version (to support browser caching) to H5P.
                $styles[] = (object)[
                        'path' => $h5pcssurl->out(),
                        'version' => '?ver='.theme_get_revision(),
                ];

                // If the local_och5p plugin is installed, add some more styles.
                if (file_exists($CFG->dirroot.'/local/och5p/version.php')) {
                    // If H5P interactive videos are installed.
                    if (isset($libraries['H5P.InteractiveVideo']) && $libraries['H5P.InteractiveVideo']['majorVersion'] == '1') {
                        // Adding H5PEditor css file.
                        $h5peditoravurl = new core\url('/local/och5p/lib/style/H5PEditor.AV.css');
                        $styles[] = (object) [
                            'path' => $h5peditoravurl->out(),
                            'version' => '?ver='.theme_get_revision(),
                        ];

                        // Adding opencast font css file.
                        $ocfontsurl = new core\url('/local/och5p/lib/style/oc-fonts.css');
                        $styles[] = (object) [
                            'path' => $ocfontsurl->out(),
                            'version' => '?ver='.theme_get_revision(),
                        ];
                    }
                }
            }

            /**
             * Add scripts when an H5P is displayed.
             *
             * @param array $scripts Scripts that will be applied.
             * @param array $libraries Libraries that will be displayed.
             * @param string $embedtype How the H5P is displayed.
             */
            public function hvp_alter_scripts(&$scripts, $libraries, $embedtype) {
                global $CFG;

                // If the local_och5p plugin is installed, add some more scripts.
                if (file_exists($CFG->dirroot.'/local/och5p/version.php')) {
                    // If H5P interactive videos are installed.
                    if (isset($libraries['H5P.InteractiveVideo']) && $libraries['H5P.InteractiveVideo']['majorVersion'] == '1') {
                        // Adding LTI related script into scripts array.
                        $h5prunltiurl = new core\url('/local/och5p/lib/js/H5PRunLTI.js');
                        $scripts[] = (object) [
                            'path' => $h5prunltiurl->out(),
                            'version' => '?ver='.theme_get_revision(),
                        ];

                        // Adding editor script to scripts array.
                        $h5peditoravurl = new core\url('/local/och5p/lib/js/H5PEditor.AV.js');
                        $scripts[] = (object) [
                            'path' => $h5peditoravurl->out(),
                            'version' => '?ver='.theme_get_revision(),
                        ];
                    }
                }
            }
        }
    }
}