PHP theme_config类代码示例

/**
 * Stores CSS in a file at the given path.
 *
 * This function either succeeds or throws an exception.
 *
 * @param theme_config $theme The theme that the CSS belongs to.
 * @param string $csspath The path to store the CSS at.
 * @param array $cssfiles The CSS files to store.
 */
function css_store_css(theme_config $theme, $csspath, array $cssfiles) {
    global $CFG;

    // Check if both the CSS optimiser is enabled and the theme supports it.
    if (!empty($CFG->enablecssoptimiser) && $theme->supportscssoptimisation) {
        // This is an experimental feature introduced in Moodle 2.3
        // The CSS optimiser organises the CSS in order to reduce the overall number
        // of rules and styles being sent to the client. It does this by collating
        // the CSS before it is cached removing excess styles and rules and stripping
        // out any extraneous content such as comments and empty rules.
        $optimiser = new css_optimiser;
        $css = '';
        foreach ($cssfiles as $file) {
            $css .= file_get_contents($file)."\n";
        }
        $css = $theme->post_process($css);
        $css = $optimiser->process($css);

        // If cssoptimisestats is set then stats from the optimisation are collected
        // and output at the beginning of the CSS
        if (!empty($CFG->cssoptimiserstats)) {
            $css = $optimiser->output_stats_css().$css;
        }
    } else {
        // This is the default behaviour.
        // The cssoptimise setting was introduced in Moodle 2.3 and will hopefully
        // in the future be changed from an experimental setting to the default.
        // The css_minify_css will method will use the Minify library remove
        // comments, additional whitespace and other minor measures to reduce the
        // the overall CSS being sent.
        // However it has the distinct disadvantage of having to minify the CSS
        // before running the post process functions. Potentially things may break
        // here if theme designers try to push things with CSS post processing.
        $css = $theme->post_process(css_minify_css($cssfiles));
    }

    clearstatcache();
    if (!file_exists(dirname($csspath))) {
        @mkdir(dirname($csspath), $CFG->directorypermissions, true);
    }

    // Prevent serving of incomplete file from concurrent request,
    // the rename() should be more atomic than fwrite().
    ignore_user_abort(true);
    if ($fp = fopen($csspath.'.tmp', 'xb')) {
        fwrite($fp, $css);
        fclose($fp);
        rename($csspath.'.tmp', $csspath);
        @chmod($csspath, $CFG->filepermissions);
        @unlink($csspath.'.tmp'); // just in case anything fails
    }
    ignore_user_abort(false);
    if (connection_aborted()) {
        die;
    }
}

 /**
  * Retrieve the list of available filter options.
  *
  * @return  array                   An array whose keys are the valid options
  *                                  And whose values are the values to display
  */
 public static function get_filter_options()
 {
     $manager = \core_plugin_manager::instance();
     $themes = $manager->get_installed_plugins('theme');
     $options = [];
     foreach (array_keys($themes) as $themename) {
         try {
             $theme = \theme_config::load($themename);
         } catch (Exception $e) {
             // Bad theme, just skip it for now.
             continue;
         }
         if ($themename !== $theme->name) {
             // Obsoleted or broken theme, just skip for now.
             continue;
         }
         if ($theme->hidefromselector) {
             // The theme doesn't want to be shown in the theme selector and as theme
             // designer mode is switched off we will respect that decision.
             continue;
         }
         $options[$theme->name] = get_string('pluginname', "theme_{$theme->name}");
     }
     return $options;
 }

 /**
  * Helper function for getting a list of valid template directories for a specific component.
  *
  * @param string $component The component to search
  * @param string $themename The current theme name
  * @return string[] List of valid directories for templates for this compoonent. Directories are not checked for existence.
  */
 public static function get_template_directories_for_component($component, $themename = '')
 {
     global $CFG, $PAGE;
     // Default the param.
     if ($themename == '') {
         $themename = $PAGE->theme->name;
     }
     // Clean params for safety.
     $component = clean_param($component, PARAM_COMPONENT);
     $themename = clean_param($themename, PARAM_COMPONENT);
     // Validate the component.
     $dirs = array();
     $compdirectory = core_component::get_component_directory($component);
     if (!$compdirectory) {
         throw new coding_exception("Component was not valid: " . s($component));
     }
     // Find the parent themes.
     $parents = array();
     if ($themename === $PAGE->theme->name) {
         $parents = $PAGE->theme->parents;
     } else {
         $themeconfig = theme_config::load($themename);
         $parents = $themeconfig->parents;
     }
     // First check the theme.
     $dirs[] = $CFG->dirroot . '/theme/' . $themename . '/templates/' . $component . '/';
     // Now check the parent themes.
     // Search each of the parent themes second.
     foreach ($parents as $parent) {
         $dirs[] = $CFG->dirroot . '/theme/' . $parent . '/templates/' . $component . '/';
     }
     $dirs[] = $compdirectory . '/templates/';
     return $dirs;
 }

/**
 * Essentials is a basic child theme of Essential to help you as a theme
 * developer create your own child theme of Essential.
 *
 * @package     theme_essentials
 * @copyright   2015 Gareth J Barnard
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
function theme_essentials_process_css($css, $theme)
{
    /* Change to 'true' if you want to use Essential's settings after removing the '$THEME->parents_exclude_sheets' in config.php.
       Then to get the alternive colours back, renove the overridden method 'custom_menu_themecolours' in the 'theme_essentials_core_renderer'
       class in the 'core_renderer.php' file in the 'classes' folder. */
    $usingessentialsettings = false;
    if ($usingessentialsettings) {
        if (file_exists("{$CFG->dirroot}/theme/essential/lib.php")) {
            require_once "{$CFG->dirroot}/theme/essential/lib.php";
        } else {
            if (!empty($CFG->themedir) and file_exists("{$CFG->themedir}/essential/lib.php")) {
                require_once "{$CFG->themedir}/essential/lib.php";
            }
        }
        // else will just fail when cannot find theme_essential_process_css!
        static $parenttheme;
        if (empty($parenttheme)) {
            $parenttheme = theme_config::load('essential');
        }
        $css = theme_essential_process_css($css, $parenttheme);
    }
    // If you have your own settings, then add them here.
    // Finally return processed CSS
    return $css;
}

function theme_clean_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = array()) {
    if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'logo') {
        $theme = theme_config::load('clean');
        return $theme->setting_file_serve('logo', $args, $forcedownload, $options);
    } else {
        send_file_not_found();
    }
}

 /**
  * Return a list of details about installed templates.
  *
  * @param string $component Filter the list to a single component.
  * @param string $search Search string to optionally filter the list of templates.
  * @param string $themename The name of the current theme.
  * @return array[string] Where each template is in the form "component/templatename".
  */
 public static function list_templates($component = '', $search = '', $themename = '')
 {
     global $CFG, $PAGE;
     if (empty($themename)) {
         $themename = $PAGE->theme->name;
     }
     $themeconfig = \theme_config::load($themename);
     $templatedirs = array();
     $results = array();
     if ($component !== '') {
         // Just look at one component for templates.
         $dirs = mustache_template_finder::get_template_directories_for_component($component, $themename);
         $templatedirs[$component] = $dirs;
     } else {
         // Look at all the templates dirs for core.
         $templatedirs['core'] = mustache_template_finder::get_template_directories_for_component('core', $themename);
         // Look at all the templates dirs for subsystems.
         $subsystems = core_component::get_core_subsystems();
         foreach ($subsystems as $subsystem => $dir) {
             $dir .= '/templates';
             if (is_dir($dir)) {
                 $dirs = mustache_template_finder::get_template_directories_for_component('core_' . $subsystem, $themename);
                 $templatedirs['core_' . $subsystem] = $dirs;
             }
         }
         // Look at all the templates dirs for plugins.
         $plugintypes = core_component::get_plugin_types();
         foreach ($plugintypes as $type => $dir) {
             $plugins = core_component::get_plugin_list_with_file($type, 'templates', false);
             foreach ($plugins as $plugin => $dir) {
                 if ($type == 'theme' && $plugin != $themename && !in_array($plugin, $themeconfig->parents)) {
                     continue;
                 }
                 if (!empty($dir) && is_dir($dir)) {
                     $pluginname = $type . '_' . $plugin;
                     $dirs = mustache_template_finder::get_template_directories_for_component($pluginname, $themename);
                     $templatedirs[$pluginname] = $dirs;
                 }
             }
         }
     }
     foreach ($templatedirs as $templatecomponent => $dirs) {
         foreach ($dirs as $dir) {
             // List it.
             $files = glob($dir . '/*.mustache');
             foreach ($files as $file) {
                 $templatename = basename($file, '.mustache');
                 if ($search == '' || strpos($templatename, $search) !== false) {
                     $results[$templatecomponent . '/' . $templatename] = 1;
                 }
             }
         }
     }
     $results = array_keys($results);
     sort($results);
     return $results;
 }

/**
 * Serves any files associated with the theme settings.
 *
 * @param stdClass $course.
 * @param stdClass $cm.
 * @param context $context.
 * @param string $filearea.
 * @param array $args.
 * @param bool $forcedownload.
 * @param array $options.
 * @return bool.
 */
function theme_essential_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = array())
{
    static $theme;
    if (empty($theme)) {
        $theme = theme_config::load('essential');
    }
    if ($context->contextlevel == CONTEXT_SYSTEM) {
        if ($filearea === 'logo') {
            return $theme->setting_file_serve('logo', $args, $forcedownload, $options);
        } else {
            if ($filearea === 'style') {
                theme_essential_serve_css($args[1]);
            } else {
                if ($filearea === 'headerbackground') {
                    return $theme->setting_file_serve('headerbackground', $args, $forcedownload, $options);
                } else {
                    if ($filearea === 'pagebackground') {
                        return $theme->setting_file_serve('pagebackground', $args, $forcedownload, $options);
                    } else {
                        if ($filearea === 'favicon') {
                            return $theme->setting_file_serve('favicon', $args, $forcedownload, $options);
                        } else {
                            if (preg_match("/^fontfile(eot|otf|svg|ttf|woff|woff2)(heading|body)\$/", $filearea)) {
                                // http://www.regexr.com/.
                                return $theme->setting_file_serve($filearea, $args, $forcedownload, $options);
                            } else {
                                if (preg_match("/^(marketing|slide)[1-9][0-9]*image\$/", $filearea)) {
                                    return $theme->setting_file_serve($filearea, $args, $forcedownload, $options);
                                } else {
                                    if ($filearea === 'iphoneicon') {
                                        return $theme->setting_file_serve('iphoneicon', $args, $forcedownload, $options);
                                    } else {
                                        if ($filearea === 'iphoneretinaicon') {
                                            return $theme->setting_file_serve('iphoneretinaicon', $args, $forcedownload, $options);
                                        } else {
                                            if ($filearea === 'ipadicon') {
                                                return $theme->setting_file_serve('ipadicon', $args, $forcedownload, $options);
                                            } else {
                                                if ($filearea === 'ipadretinaicon') {
                                                    return $theme->setting_file_serve('ipadretinaicon', $args, $forcedownload, $options);
                                                } else {
                                                    send_file_not_found();
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    } else {
        send_file_not_found();
    }
}

 public function __construct(moodle_page $page, $target)
 {
     parent::__construct($page, $target);
     static $theme;
     if (empty($theme)) {
         $theme = theme_config::load('essential');
     }
     $this->enablecategoryicon = !empty($theme->settings->enablecategoryicon) ? $theme->settings->enablecategoryicon : false;
 }

 private static function get_child_theme_config()
 {
     if (!self::$checkedchildtheme) {
         global $PAGE;
         if (in_array('essential', $PAGE->theme->parents)) {
             $themename = $PAGE->theme->name;
             self::$childtheme = \theme_config::load($themename);
             self::$checkedchildtheme = true;
         }
     }
     return self::$childtheme;
 }

/**
 * Serves any files associated with the theme settings.
 *
 * @param stdClass $course
 * @param stdClass $cm
 * @param context $context
 * @param string $filearea
 * @param array $args
 * @param bool $forcedownload
 * @param array $options
 * @return bool
 */
function theme_clean_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = array())
{
    if ($context->contextlevel == CONTEXT_SYSTEM and $filearea === 'logo' || $filearea === 'smalllogo') {
        $theme = theme_config::load('clean');
        // By default, theme files must be cache-able by both browsers and proxies.
        if (!array_key_exists('cacheability', $options)) {
            $options['cacheability'] = 'public';
        }
        return $theme->setting_file_serve($filearea, $args, $forcedownload, $options);
    } else {
        send_file_not_found();
    }
}

/**
 * Stores CSS in a file at the given path.
 *
 * This function either succeeds or throws an exception.
 *
 * @param theme_config $theme The theme that the CSS belongs to.
 * @param string $csspath The path to store the CSS at.
 * @param array $cssfiles The CSS files to store.
 */
function css_store_css(theme_config $theme, $csspath, array $cssfiles)
{
    global $CFG;
    if (!empty($CFG->enablecssoptimiser)) {
        // This is an experimental feature introduced in Moodle 2.3
        // The CSS optimiser organises the CSS in order to reduce the overall number
        // of rules and styles being sent to the client. It does this by collating
        // the CSS before it is cached removing excess styles and rules and stripping
        // out any extraneous content such as comments and empty rules.
        $optimiser = new css_optimiser();
        $css = '';
        foreach ($cssfiles as $file) {
            $css .= file_get_contents($file) . "\n";
        }
        $css = $theme->post_process($css);
        $css = $optimiser->process($css);
        // If cssoptimisestats is set then stats from the optimisation are collected
        // and output at the beginning of the CSS
        if (!empty($CFG->cssoptimiserstats)) {
            $css = $optimiser->output_stats_css() . $css;
        }
    } else {
        // This is the default behaviour.
        // The cssoptimise setting was introduced in Moodle 2.3 and will hopefully
        // in the future be changed from an experimental setting to the default.
        // The css_minify_css will method will use the Minify library remove
        // comments, additional whitespace and other minor measures to reduce the
        // the overall CSS being sent.
        // However it has the distinct disadvantage of having to minify the CSS
        // before running the post process functions. Potentially things may break
        // here if theme designers try to push things with CSS post processing.
        $css = $theme->post_process(css_minify_css($cssfiles));
    }
    check_dir_exists(dirname($csspath));
    $fp = fopen($csspath, 'w');
    fwrite($fp, $css);
    fclose($fp);
}

/**
 * Essentials is a basic child theme of Essential to help you as a theme
 * developer create your own child theme of Essential.
 *
 * @package     theme_essentials
 * @copyright   2015 Gareth J Barnard
 * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
function theme_essentials_process_css($css, $theme)
{
    // Change to 'true' if you want to use Essential's settings after removing the '$THEME->parents_exclude_sheets' in config.php.
    $usingessentialsettings = false;
    if ($usingessentialsettings) {
        require_once dirname(__FILE__) . '/../essential/lib.php';
        static $parenttheme;
        if (empty($parenttheme)) {
            $parenttheme = theme_config::load('essential');
        }
        $css = theme_essential_process_css($css, $parenttheme);
    }
    // If you have your own settings, then add them here.
    // Finally return processed CSS
    return $css;
}

/**
 * Serves any files associated with the theme settings.
 *
 * @param stdClass $course.
 * @param stdClass $cm.
 * @param context $context.
 * @param string $filearea.
 * @param array $args.
 * @param bool $forcedownload.
 * @param array $options.
 * @return bool.
 */
function theme_essentials_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = array())
{
    static $theme;
    if (empty($theme)) {
        $theme = theme_config::load('essentials');
    }
    if ($context->contextlevel == CONTEXT_SYSTEM) {
        if ($filearea === 'logo') {
            return $theme->setting_file_serve('logo', $args, $forcedownload, $options);
        } else {
            send_file_not_found();
        }
    } else {
        send_file_not_found();
    }
}

    /**
     * Returns settings as formatted text
     *
     * @param string $setting
     * @param string $format = false
     * @param string $theme = null
     * @return string
     */
    public function get_setting($setting, $format = false, $theme = null) {
        if (empty($theme)) {
            $theme = theme_config::load('adaptable');
        }

        if (empty($theme->settings->$setting)) {
            return false;
        } else if (!$format) {
            return $theme->settings->$setting;
        } else if ($format === 'format_text') {
            return format_text($theme->settings->$setting, FORMAT_PLAIN);
        } else if ($format === 'format_html') {
            return format_text($theme->settings->$setting, FORMAT_HTML, array('trusted' => true));
        } else {
            return format_string($theme->settings->$setting);
        }
    }

function theme_lambda_pluginfile($course, $cm, $context, $filearea, $args, $forcedownload, array $options = array())
{
    if ($context->contextlevel == CONTEXT_SYSTEM) {
        $theme = theme_config::load('lambda');
        if ($filearea === 'logo') {
            return $theme->setting_file_serve('logo', $args, $forcedownload, $options);
        } else {
            if ($filearea === 'pagebackground') {
                return $theme->setting_file_serve('pagebackground', $args, $forcedownload, $options);
            } else {
                if ($filearea === 'slide1image') {
                    return $theme->setting_file_serve('slide1image', $args, $forcedownload, $options);
                } else {
                    if ($filearea === 'slide2image') {
                        return $theme->setting_file_serve('slide2image', $args, $forcedownload, $options);
                    } else {
                        if ($filearea === 'slide3image') {
                            return $theme->setting_file_serve('slide3image', $args, $forcedownload, $options);
                        } else {
                            if ($filearea === 'slide4image') {
                                return $theme->setting_file_serve('slide4image', $args, $forcedownload, $options);
                            } else {
                                if ($filearea === 'slide5image') {
                                    return $theme->setting_file_serve('slide5image', $args, $forcedownload, $options);
                                } else {
                                    if (substr($filearea, 0, 15) === 'carousel_image_') {
                                        return $theme->setting_file_serve($filearea, $args, $forcedownload, $options);
                                    } else {
                                        send_file_not_found();
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }
    } else {
        send_file_not_found();
    }
}