theme_boost_classes_mod-hvp-renderer.php

<?php

defined('MOODLE_INTERNAL') || die;

// Be sure to include the H5P renderer so it can be extended
//require_once($CFG->dirroot . '/mod/hvp/renderer.php');

/**
 * Class theme_boost_mod_hvp_renderer
 *
 * Extends the H5P renderer so that we are able to override the relevant
 * functions declared there
 */
class theme_boost_mod_hvp_renderer extends mod_hvp_renderer {

    /**
     * Add styles when an H5P 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;
        if (
            isset($libraries['H5P.InteractiveVideo']) &&
            $libraries['H5P.InteractiveVideo']['majorVersion'] == '1'
        ) {
            $styles[] = (object) array(
                'path'    => $CFG->httpswwwroot . '/theme/boost/style/hvp_custom.css',
                'version' => '?ver=0.0.1',
            );
        }

        if (
            isset($libraries['H5P.DragText']) &&
            $libraries['H5P.DragText']['majorVersion'] == '1'
        ) {
            $styles[] = (object) array(
                'path'    => $CFG->httpswwwroot . '/theme/boost/style/hvp_custom.css',
                'version' => '?ver=0.0.1',
            );
        }
    }

    /**
     * Add scripts when an H5P is displayed.
     *
     * @param object $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 (
            isset($libraries['H5P.InteractiveVideo']) &&
            $libraries['H5P.InteractiveVideo']['majorVersion'] == '1'
        ) {
            $include_file = ($embedType === 'editor' ? 'customEditor.js' : 'custom.js');
            $scripts[] = (object) array(
                'path'    => $CFG->httpswwwroot . '/theme/boost/js/hvp_' . $include_file,
                'version' => '?ver=0.0.1',
            );
        }
    }

    /**
     * Alter a library's semantics
     *
     * May be used to ad more fields to a library, change a widget, allow more
     * html tags, etc.
     *
     * @param object $semantics Library semantics
     * @param string $name Name of library
     * @param int $majorVersion Major version of library
     * @param int $minorVersion Minor version of library
     */
    public function hvp_alter_semantics(&$semantics, $name, $majorVersion, $minorVersion) {

        // Check if this is the multichoice question type.
        if ($name !== 'H5P.MultiChoice' && $majorVersion == 1) {
            return; // Nope, do not continue.
        }

        foreach ($semantics as $field) {
            // Go through list fields
            while ($field->type === 'list') {
                $field = $field->field;
            }

            // Go through group fields
            if ($field->type === 'group') {
                $this->hvp_alter_semantics($field->fields, $name, $majorVersion, $minorVersion); // Check your function name!
                continue;
            }

            // Check to see if we have the correct type and widget
            if ($field->type === 'text' && isset($field->widget) && $field->widget === 'html') {
                // Found a field. Add support for table tags.
                if (!isset($field->tags)) {
                    $field->tags = array();
                }
                $field->tags = array_merge($field->tags, array(
                    //'bidi',
                    'table',
                    'thead',
                    'tfoot',
                    'tbody',
                    'tr',
                    'th',
                    'td'
                ));
            }
        }
    }

    /**
     * Alter an H5Ps parameters.
     *
     * May be used to alter the content itself or the behaviour of an H5
     *
     * @param object $parameters Parameters of library as json object
     * @param string $name Name of library
     * @param int $majorVersion Major version of library
     * @param int $minorVersion Minor version of library
     */
    public function hvp_alter_filtered_parameters(&$parameters, $name, $majorVersion, $minorVersion) {
        if (
            $name === 'H5P.MultiChoice' &&
            $majorVersion == 1
        ) {
            $parameters->question .= '<p> Generated at ' . time() . '</p>';
        }
    }
}