C:/xampp/htdocs/moodle/lib/outputfactories.php

Go to the documentation of this file.

<?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/>.

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

define('RENDERER_TARGET_GENERAL', 'general');

define('RENDERER_TARGET_CLI', 'cli');

define('RENDERER_TARGET_AJAX', 'ajax');

define('RENDERER_TARGET_TEXTEMAIL', 'textemail');

define('RENDERER_TARGET_HTMLEMAIL', 'htmlemail');

/* note: maybe we could define portfolio export target too */


interface renderer_factory {
    public function get_renderer(moodle_page $page, $component, $subtype=null, $target=null);
}


abstract class renderer_factory_base implements renderer_factory {
    protected $theme;

    public function __construct(theme_config $theme) {
        $this->theme = $theme;
    }

    protected function get_target_suffix($target) {
        if (empty($target)) {
            // automatically guessed defaults
            if (CLI_SCRIPT) {
                $target = RENDERER_TARGET_CLI;
            } else if (AJAX_SCRIPT) {
                $target = RENDERER_TARGET_AJAX;
            }
        }

        switch ($target) {
            case RENDERER_TARGET_CLI: $suffix = '_cli'; break;
            case RENDERER_TARGET_AJAX: $suffix = '_ajax'; break;
            case RENDERER_TARGET_TEXTEMAIL: $suffix = '_textemail'; break;
            case RENDERER_TARGET_HTMLEMAIL: $suffix = '_htmlemail'; break;
            default: $target = RENDERER_TARGET_GENERAL; $suffix = '';
        }

        return array($target, $suffix);
    }

    protected function standard_renderer_classname($component, $subtype = null) {
        global $CFG; // needed in included files

        // standardize component name ala frankenstyle
        list($plugin, $type) = normalize_component($component);
        if ($type === null) {
            $component = $plugin;
        } else {
            $component = $plugin.'_'.$type;
        }

        if ($component !== 'core') {
            // renderers are stored in renderer.php files
            if (!$compdirectory = get_component_directory($component)) {
                throw new coding_exception('Invalid component specified in renderer request');
            }
            $rendererfile = $compdirectory . '/renderer.php';
            if (file_exists($rendererfile)) {
                include_once($rendererfile);
            }

        } else if (!empty($subtype)) {
            $coresubsystems = get_core_subsystems();
            if (!isset($coresubsystems[$subtype])) {
                throw new coding_exception('Invalid core subtype "' . $subtype . '" in renderer request');
            }
            $rendererfile = $CFG->dirroot . '/' . $coresubsystems[$subtype] . '/renderer.php';
            if (file_exists($rendererfile)) {
                include_once($rendererfile);
            }
        }

        if (empty($subtype)) {
            $class = $component . '_renderer';
        } else {
            $class = $component . '_' . $subtype . '_renderer';
        }
        return $class;
    }
}


class standard_renderer_factory extends renderer_factory_base {
    public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
        $classname = $this->standard_renderer_classname($component, $subtype);
        if (!class_exists($classname)) {
            throw new coding_exception('Request for an unknown renderer class ' . $classname);
        }

        list($target, $suffix) = $this->get_target_suffix($target);
        if (class_exists($classname . $suffix)) {
            // use the specialised renderer for given target, default renderer might also decide
            // to implement support for more targets
            $classname = $classname . $suffix;
        }

        return new $classname($page, $target);
    }
}


class theme_overridden_renderer_factory extends renderer_factory_base {

    protected $prefixes = array();

    public function __construct(theme_config $theme) {
        parent::__construct($theme);
        // Initialise $this->prefixes.
        $this->prefixes = $theme->renderer_prefixes();
    }

    public function get_renderer(moodle_page $page, $component, $subtype = null, $target = null) {
        $classname = $this->standard_renderer_classname($component, $subtype);
        if (!class_exists($classname)) {
            // standard renderer must always exist
            throw new coding_exception('Request for an unknown renderer class ' . $classname);
        }

        list($target, $suffix) = $this->get_target_suffix($target);

        // theme lib.php and renderers.php files are loaded automatically
        // when loading the theme configs

        // first try the renderers with correct suffix
        foreach ($this->prefixes as $prefix) {
            if (class_exists($prefix . '_' . $classname . $suffix)) {
                $classname = $prefix . '_' . $classname . $suffix;
                return new $classname($page, $target);
            }
        }
        if (class_exists($classname . $suffix)) {
            // use the specialised renderer for given target, default renderer might also decide
            // to implement support for more targets
            $classname = $classname . $suffix;
            return new $classname($page, $target);
        }

        // then try general renderer
        foreach ($this->prefixes as $prefix) {
            if (class_exists($prefix . '_' . $classname)) {
                $classname = $prefix . '_' . $classname;
                return new $classname($page, $target);
            }
        }

        return new $classname($page, $target);
    }
}