mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 14:27:22 +01:00
Code Issues Projects Releases Wiki Activity
moodle/lib/outputlib.php

3412 lines
131 KiB
PHP
Raw Normal View History

themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
<?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/>.
/**
* Functions for generating the HTML that Moodle should output.
*
* Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
* for an overview.
*
* @package moodlecore
* @copyright 2009 Tim Hunt
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
/**
* A renderer factory is just responsible for creating an appropriate renderer
* for any given part of Moodle.
*
* Which renderer factory to use is chose by the current theme, and an instance
* if created automatically when the theme is set up.
*
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* A renderer factory must also have a constructor that takes a theme_config object.
* (See {@link renderer_factory_base::__construct} for an example.)
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
interface renderer_factory {
/**
* Return the renderer for a particular part of Moodle.
*
Improve comment. Thanks David Mudrak.
2009-07-18 11:59:17 +00:00
* The renderer interfaces are defined by classes called moodle_{plugin}_renderer
* where {plugin} is the name of the component. The renderers for core Moodle are
* defined in lib/renderer.php. For plugins, they will be defined in a file
* called renderer.php inside the plugin.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
Improve comment. Thanks David Mudrak.
2009-07-18 11:59:17 +00:00
* Renderers will normally want to subclass the moodle_renderer_base class.
* (However, if you really know what you are doing, you don't have to do that.)
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* There is no separate interface definition for renderers. The default
Improve comment. Thanks David Mudrak.
2009-07-18 11:59:17 +00:00
* moodle_{plugin}_renderer implementation also serves to define the API for
* other implementations of the interface, whether or not they subclass it.
* For example, {@link custom_corners_core_renderer} does subclass
* {@link moodle_core_renderer}. On the other hand, if you are using
* {@link template_renderer_factory} then you always get back an instance
* of the {@link template_renderer} class, whatever type of renderer you ask
* for. This uses the fact that PHP is a dynamic language.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* A particular plugin can define multiple renderers if it wishes, using the
Improve comment. Thanks David Mudrak.
2009-07-18 11:59:17 +00:00
* $subtype parameter. For example moodle_mod_workshop_renderer,
* moodle_mod_workshop_allocation_manual_renderer etc.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
* @param moodle_page $page the page the renderer is outputting content for.
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
* @return object an object implementing the requested renderer interface.
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
public function get_renderer($component, $page, $subtype=null);
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* An icon finder is responsible for working out the correct URL for an icon.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* A icon finder must also have a constructor that takes a theme object.
* (See {@link standard_icon_finder::__construct} for an example.)
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Note that we are planning to change the Moodle icon naming convention before
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* the Moodle 2.0 release. Therefore, this API will probably change.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
interface icon_finder {
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Return the URL for an icon identified as in pre-Moodle 2.0 code.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* Suppose you have old code like $url = "$CFG->pixpath/i/course.gif";
* then old_icon_url('i/course'); will return the equivalent URL that is correct now.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the URL for that icon.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function old_icon_url($iconname);
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Return the URL for an icon identified as in pre-Moodle 2.0 code.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Suppose you have old code like $url = "$CFG->modpixpath/$mod/icon.gif";
* then mod_icon_url('icon', $mod); will return the equivalent URL that is correct now.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @param string $module the module the icon belongs to.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the URL for that icon.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function mod_icon_url($iconname, $module);
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
/**
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* This class represents the configuration variables of a Moodle theme.
*
* All the variables with access: public below (with a few exceptions that are marked)
* are the properties you can set in your theme's config.php file.
*
* There are also some methods and protected variables that are part of the inner
* workings of Moodle's themes system. If you are just editing a theme's config.php
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* file, you can just ignore those, and the following information for developers.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* Normally, to create an instance of this class, you should use the
* {@link theme_config::load()} factory method to load a themes config.php file.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* However, normally you don't need to bother, because moodle_page (that is, $PAGE)
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* will create one for you, accessible as $PAGE->theme.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
class theme_config {
/**
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* @var string the name of this theme. Set automatically when this theme is
* loaded. Please do not try to set this in your theme's config.php file.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*/
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
public $name;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var string the folder where this themes files are stored. This is set
* automatically when the theme is loaded to $CFG->themedir . '/' . $this->name.
* Please do not try to set this in your theme's config.php file.
*/
public $dir;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var array The names of all the stylesheets from this theme that you would
* like included, in order. Give the names of the files without .css.
*/
public $sheets = array('styles_layout', 'styles_fonts', 'styles_color');
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* You can base your theme on another theme by linking to the other theme as
* a parent. This lets you use the CSS from the other theme
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* (see {@link $parentsheets}), or layout templates (see {@link $layouts}).
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* That makes it easy to create a new theme that is similar to another one
* but with a few changes. In this theme's CSS you only need to override
* those rules you want to change.
*/
public $parent = null;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var boolean|array Whether and which stylesheets from the parent theme
* to use in this theme. (Ignored if parent is null)
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Possible values are:
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* false - no parent theme CSS.
* true - include all the normal parent theme CSS. Currently this means
* array('styles_layout', 'styles_fonts', 'styles_color').
* array - include just the listed stylesheets. Give the files names
* without the .css, as in the above example.
*/
public $parentsheets = false;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var boolean|array Whether and which stylesheets from the standard theme
* to use in this theme.
*
* The advantages of using the standard stylesheets in your theme is that
* they give you a good basic layout, and when the Moodle core code is
* updated with new features, the standard theme CSS will be updated to match
* the changes in the code. Therefore, your theme is less likely to break
* when you upgrade Moodle.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Possible values are:
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* false - no standard theme CSS.
* true - include all the main standard theme CSS. Currently this means
* array('styles_layout', 'styles_fonts', 'styles_color').
* array - include just the listed stylesheets. Give the files names
* without the .css, as in the above example.
*/
public $standardsheets = true;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var array use the CSS fragments from these types of plugins.
*
* All the plugins of the given types will be searched for a file called
* styles.php and, if found, these will be included with the CSS for this theme.
*
* This allows modules to provide some basic CSS so they work out of the box.
* You are strongly advised to leave this enabled, otherwise you will have to
* provide styling in your theme for every installed block, activity, course
* format, ... in your Moodle site.
*
* This setting is an array of plugin types, as in the {@link get_plugin_types()}
* function. The default value has been chosen to be the same as Moodle 1.9.
* This is not necessarily the best choice.
*
* The plugin CSS is included first, before any theme CSS. To be precise,
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* if $standardsheets is true, the plugin CSS is included with the
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* standard theme's CSS, otherwise if $parentsheets is true, the plugin CSS
* will be included with the parent theme's CSS, otherwise the plugin CSS
* will be include with this theme's CSS.
*/
public $pluginsheets = array('mod', 'block', 'format', 'gradereport');
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var boolean When this is true then Moodle will try to include a file
* meta.php from this theme into the <head></head> part of the page.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $metainclude = false;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var boolean When this is true, and when this theme has a parent, then
* Moodle will try to include a file meta.php from the parent theme into the
* <head></head> part of the page.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $parentmetainclude = false;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* @var boolean When this is true then Moodle will try to include the file
* meta.php from the standard theme into the <head></head> part of the page.
*/
public $standardmetainclude = true;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* If true, then this theme must have a "pix" subdirectory that contains
* copies of all files from the moodle/pix directory, plus a "pix/mod"
* directory containing all the icons for all the activity modules.
*
* @var boolean
*/
public $custompix = false;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Which template to use for each general type of page.
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* This is an array of arrays. The keys of the outer array are the different
* types of page. Pages in Moodle are categorised into one of a short list of
* types like 'normal', 'home', 'popup', 'form', .... The most reliable way
* to get a complete list is to look at
* {@link http://cvs.moodle.org/moodle/theme/standard/config.php?view=markup the standard theme config.php file}.
* That file also has a good example of how to set this setting.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* If Moodle encounters a general type of page that is not listed in your theme,
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* then it will use the first layout. Therefore, should probably put 'normal'
* first in this array.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* For each page type, the value in the outer array is an array that describes
* how you want that type of page to look. For example
* <pre>
* $THEME->layouts = array(
* // Most pages. Put this first, so if we encounter an unknown page type, this is used.
* 'normal' => array(
* 'layout' => 'parent:layout.php',
* 'regions' => array('side-pre', 'side-post'),
* 'defaultregion' => 'side-post'
* ),
* // The site home page.
* 'home' => array(
* 'layout' => 'layout-home.php',
* 'regions' => array('side-pre', 'side-post'),
* 'defaultregion' => 'side-post'
* ),
* // ...
* );
* </pre>
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* 'layout' is the layout template to use for this type of page. You can
* specify this in one of three ways:
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* <ol>
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* <li><b>filename</b> for example 'layout-home.php' as above. Use that file from this theme.</li>
* <li><b>parent:filename</b> for example 'parent:layout.php' as above. Use the
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* specified file from the parent theme. (Obviously, you can only do this
* if this theme has a parent!)</li>
* <li><b>standard:filename</b> for example 'standard:layout-popup.php'. Use
* the specified file from the standard theme.</li>
* </ol>
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* To promote consistency, you are encouraged to call your layout files
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* layout.php or layout-something.php.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* 'regions' This lists the regions on the page where blocks may appear. For
* each region you list here, your layout file must include a call to
* <pre>
* echo $OUTPUT->blocks_for_region($regionname);
* </pre>
* or equivalent so that the blocks are actually visible.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* 'defaultregion' If the list of regions is non-empty, then you must pick
* one of the one of them as 'default'. This has two meanings. First, this is
* where new blocks are added. Second, if there are any blocks associated with
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* the page, but in non-existent regions, they appear here. (Imaging, for example,
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* that someone added blocks using a different theme that used different region
* names, and then switched to this theme.)
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
* @var array
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public $layouts = array();
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* With this you can control the colours of the big MP3 player
* that is used for MP3 resources.
*
* @var string
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $resource_mp3player_colors = 'bgColour=000000&btnColour=ffffff&btnBorderColour=cccccc&iconColour=000000&iconOverColour=00cc00&trackColour=cccccc&handleColour=ffffff&loaderColour=ffffff&font=Arial&fontColour=3333FF&buffer=10&waitForPlay=no&autoPlay=yes';
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* With this you can control the colours of the small MP3 player
* that is used elsewhere
*.
* @var string
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $filter_mediaplugin_colors = 'bgColour=000000&btnColour=ffffff&btnBorderColour=cccccc&iconColour=000000&iconOverColour=00cc00&trackColour=cccccc&handleColour=ffffff&loaderColour=ffffff&waitForPlay=yes';
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
*$THEME->rarrow = '&#x25BA;' //OR '&rarr;';
*$THEME->larrow = '&#x25C4;' //OR '&larr;';
*$CFG->block_search_button = link_arrow_right(get_string('search'), $url='', $accesshide=true);
*
* Accessibility: Right and left arrow-like characters are
* used in the breadcrumb trail, course navigation menu
* (previous/next activity), calendar, and search forum block.
*
* If the theme does not set characters, appropriate defaults
* are set by (lib/weblib.php:check_theme_arrows). The suggestions
* above are 'silent' in a screen-reader like JAWS. Please DO NOT
* use &lt; &gt; &raquo; - these are confusing for blind users.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Name of the renderer factory class to use.
*
* This is an advanced feature. Moodle output is generated by 'renderers',
* you can customise the HTML that is output by writing custom renderers,
* and then you need to specify 'renderer factory' so that Moodle can find
* your renderers.
*
* There are some renderer factories supplied with Moodle. Please follow these
* links to see what they do.
* <ul>
* <li>{@link standard_renderer_factory} - the default.</li>
* <li>{@link theme_overridden_renderer_factory} - use this if you want to write
* your own custom renderers in a renderers.php file in this theme (or the parent theme).</li>
* <li>{@link template_renderer_factory} - highly experimental! Do not use (yet).</li>
* </ul>
*
* @var string name of a class implementing the {@link renderer_factory} interface.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $rendererfactory = 'standard_renderer_factory';
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Name of the icon finder class to use.
*
* This is an advanced feature. controls how Moodle converts from the icon
* names used in the code to URLs to embed in the HTML. You should not ever
* need to change this.
*
* @var string name of a class implementing the {@link icon_finder} interface.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $iconfinder = 'pix_icon_finder';
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
/**
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* Function to do custom CSS processing.
*
* This is an advanced feature. If you want to do custom processing on the
* CSS before it is output (for example, to replace certain variable names
* with particular values) you can give the name of a function here.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* There are two functions available that you may wish to use (defined in lib/outputlib.php):
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* <ul>
* <li>{@link output_css_replacing_constants}</li>
* <li>{@link output_css_for_css_edit}</li>
* </ul>
*
* If you wish to write your own function, look at those two as examples,
* and it should be clear what you have to do.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* @var string the name of a function.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public $customcssoutputfunction = null;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* You can use this to control the cutoff point for strings
* in the navmenus (list of activities in popup menu etc)
* Default is 50 characters wide.
*/
public $navmenuwidth = 50;
/**
* By setting this to true, then you will have access to a
* new variable in your header.html and footer.html called
* $navmenulist ... this contains a simple XHTML menu of
* all activities in the current course, mostly useful for
* creating popup navigation menus and so on.
*/
public $makenavmenulist = false;
/**
* @var renderer_factory Instance of the renderer_factory implementation
* we are using. Implementation detail.
*/
protected $rf = null;
/**
* @var renderer_factory Instance of the icon_finder implementation we are
* using. Implementation detail.
*/
protected $if = null;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Load the config.php file for a particular theme, and return an instance
* of this class. (That is, this is a factory method.)
*
* @param string $themename the name of the theme.
* @return theme_config an instance of this class.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public static function load($themename) {
global $CFG;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// We have to use the variable name $THEME (upper case) because that
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// is what is used in theme config.php files.
// Set some other standard properties of the theme.
$THEME = new theme_config;
$THEME->name = $themename;
$THEME->dir = $CFG->themedir . '/' . $themename;
// Load up the theme config
$configfile = $THEME->dir . '/config.php';
if (!is_readable($configfile)) {
throw new coding_exception('Cannot use theme ' . $themename .
'. The file ' . $configfile . ' does not exist or is not readable.');
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
include($configfile);
$THEME->update_legacy_information();
return $THEME;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Get the renderer for a part of Moodle for this theme.
* @param string $module the name of part of moodle. E.g. 'core', 'quiz', 'qtype_multichoice'.
* @param moodle_page $page the page we are rendering
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return moodle_renderer_base the requested renderer.
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
public function get_renderer($module, $page, $subtype=null) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (is_null($this->rf)) {
if (CLI_SCRIPT) {
$classname = 'cli_renderer_factory';
} else {
$classname = $this->rendererfactory;
}
$this->rf = new $classname($this);
}
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
return $this->rf->get_renderer($module, $page, $subtype);
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Get the renderer for a part of Moodle for this theme.
* @return moodle_renderer_base the requested renderer.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function get_icon_finder() {
if (is_null($this->if)) {
$classname = $this->iconfinder;
$this->if = new $classname($this);
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $this->if;
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Return the URL for an icon identified as in pre-Moodle 2.0 code.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* Suppose you have old code like $url = "$CFG->pixpath/i/course.gif";
* then old_icon_url('i/course'); will return the equivalent URL that is correct now.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the URL for that icon.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function old_icon_url($iconname) {
MDL-19690 - first 53 $CFG->pixpath to $OUTPUT->old_icon_url
2009-07-02 10:06:39 +00:00
return $this->get_icon_finder()->old_icon_url($iconname);
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Return the URL for an icon identified as in pre-Moodle 2.0 code.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* Suppose you have old code like $url = "$CFG->modpixpath/$mod/icon.gif";
* then mod_icon_url('icon', $mod); will return the equivalent URL that is correct now.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @param string $module the module the icon belongs to.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the URL for that icon.
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function mod_icon_url($iconname, $module) {
MDL-19690 - first 53 $CFG->pixpath to $OUTPUT->old_icon_url
2009-07-02 10:06:39 +00:00
return $this->get_icon_finder()->mod_icon_url($iconname, $module);
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Get the list of stylesheet URLs that need to go in the header for this theme.
* @return array of URLs.
*/
public function get_stylesheet_urls() {
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
global $CFG;
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// We need to tell the CSS that is being included (for example the standard
// theme CSS) which theme it is being included for. Prepare the necessary param.
$param = '?for=' . $this->name;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Stylesheets, in order (standard, parent, this - some of which may be the same).
$stylesheets = array();
if ($this->name != 'standard' && $this->standardsheets) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
$stylesheets[] = $CFG->httpsthemewww . '/standard/styles.php' . $param;
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
if (!empty($this->parent)) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
$stylesheets[] = $CFG->httpsthemewww . '/' . $this->parent . '/styles.php' . $param;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
$stylesheets[] = $CFG->httpsthemewww . '/' . $this->name . '/styles.php' . $param;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// Additional styles for right-to-left languages, if applicable.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (right_to_left()) {
$stylesheets[] = $CFG->httpsthemewww . '/standard/rtl.css';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!empty($this->parent) && file_exists($CFG->themedir . '/' . $this->parent . '/rtl.css')) {
$stylesheets[] = $CFG->httpsthemewww . '/' . $this->parent . '/rtl.css';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (file_exists($this->dir . '/rtl.css')) {
$stylesheets[] = $CFG->httpsthemewww . '/' . $this->name . '/rtl.css';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output MDL-19077 Implemented periodic refresh to meta refresh by delay Also created layout-popup.php for standardwhite theme to provide a simpler template
2009-06-30 07:57:41 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// If the theme wants pluginsheets, get them included in the first (most
// general) stylesheet we are including. That is, process them with the
// standard CSS if we are using that, else with the parent CSS, else with
// our own CSS.
if (!empty($this->pluginsheets)) {
$stylesheets[0] .= '&amp;pluginsheets=1';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $stylesheets;
}
output MDL-19077 Implemented periodic refresh to meta refresh by delay Also created layout-popup.php for standardwhite theme to provide a simpler template
2009-06-30 07:57:41 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* Get the meta tags from one theme to got in the <head> of the HTML.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $themename the name of the theme to get meta tags from.
* @param string $page that page whose <head> is being output.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* @return string HTML code.
*/
protected function get_theme_meta_tags($themename, $page) {
global $CFG;
// At least one theme's meta.php expects to have $PAGE visible.
$PAGE = $page;
$filename = $CFG->themedir . '/' . $themename . '/meta.php';
if (file_exists($filename)) {
ob_start();
include_once($filename);
Fixing a notice for Tim
2009-07-07 07:43:36 +00:00
$metatags = ob_get_contents();
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
ob_end_clean();
}
return $metatags;
}
/**
* Get all the meta tags (from this theme, standard, parent) that this theme
* wants in the <head> of the HTML.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $page that page whose <head> is being output.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* @return string HTML code.
*/
public function get_meta_tags($page) {
$metatags = '';
if ($this->standardmetainclude) {
$metatags .= $this->get_theme_meta_tags('standard', $page);
}
if ($this->parent && $this->parentmetainclude) {
$metatags .= $this->get_theme_meta_tags($this->parent, $page);
}
if ($this->metainclude) {
$metatags .= $this->get_theme_meta_tags($this->name, $page);
}
return $metatags;
}
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
/**
* Get the information from {@link $layouts} for this type of page.
* @param string $generaltype the general type of the page.
* @return array the appropriate part of {@link $layouts}.
*/
protected function layout_info_for_page($generaltype) {
if (array_key_exists($generaltype, $this->layouts)) {
return $this->layouts[$generaltype];
} else {
return reset($this->layouts);
}
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Given the settings of this theme, and the page generaltype, return the
* full path of the page layout template to use.
*
* Used by {@link moodle_core_renderer::header()}. If an appropriate new-style
* template cannot be found, returns false to signal that the old-style
* header.html and footer.html files should be used.
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @param string $generaltype the general type of the page.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* @return string Full path to the template to use, or false if a new-style
* template cannot be found.
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public function template_for_page($generaltype) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
global $CFG;
// Legacy fallback.
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if (empty($this->layouts)) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
return false;
}
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$layoutinfo = $this->layout_info_for_page($generaltype);
$templatefile = $layoutinfo['layout'];
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// Parse the name that was found.
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if (strpos($templatefile, 'standard:') === 0) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
$templatepath = $CFG->themedir . '/standard/' . substr($templatefile, 9);
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
} else if (strpos($templatefile, 'parent:') === 0) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
if (empty($this->parent)) {
throw new coding_exception('This theme (' . $this->name .
') does not have a parent. You cannot specify a layout template like ' .
$templatefile);
}
$templatepath = $CFG->themedir . '/' . $this->parent . '/' . substr($templatefile, 7);
} else {
$templatepath = $this->dir . '/' . $templatefile;
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// Check the template exists.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
if (!is_readable($templatepath)) {
throw new coding_exception('The template ' . $templatefile . ' (' . $templatepath .
') for page type ' . $generaltype . ' cannot be found in this theme (' .
$this->name . ')');
}
return $templatepath;
}
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
/**
* Inform a block_manager about the block regions this theme wants on this
* type of page.
* @param string $generaltype the general type of the page.
* @param block_manager $blockmanager the block_manger to set up.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
*/
public function setup_blocks($generaltype, $blockmanager) {
// Legacy fallback.
if (empty($this->layouts)) {
if (!in_array($generaltype, array('form', 'popup', 'maintenance'))) {
$blockmanager->add_regions(array(BLOCK_POS_LEFT, BLOCK_POS_RIGHT));
$blockmanager->set_default_region(BLOCK_POS_RIGHT);
}
return;
}
$layoutinfo = $this->layout_info_for_page($generaltype);
if (!empty($layoutinfo['regions'])) {
$blockmanager->add_regions($layoutinfo['regions']);
$blockmanager->set_default_region($layoutinfo['defaultregion']);
}
}
blocks editing ui: MDL-19398 Can how precisely control block positioning using the edit icon This mostly works now, but ... * The UI needs further work. In particular we need a non-advanced mode. * This only works for blocks that use a new edit_form.php to replace config_instance.html. * .. and so far I have only implemented edit_form.php for the HTML block so far. * Needs to be enabled (with no block-specific config) for blocks without instance config, so you can control their positioning.
2009-07-16 10:50:19 +00:00
/**
* Get the list of all block regions known to this theme in all templates.
* @return array internal region name => human readable name.
*/
public function get_all_block_regions() {
// Legacy fallback.
if (empty($this->layouts)) {
return array(
'side-pre' => get_string('region-side-pre', 'theme_standard'),
'side-post' => get_string('region-side-post', 'theme_standard'),
);
}
$regions = array();
foreach ($this->layouts as $layoutinfo) {
$ownertheme = $this->name;
if (strpos($layoutinfo['layout'], 'standard:') === 0) {
$ownertheme = 'standard';
} else if (strpos($layoutinfo['layout'], 'parent:') === 0) {
$ownertheme = $this->parent;
}
foreach ($layoutinfo['regions'] as $region) {
$regions[$region] = get_string('region-' . $region, 'theme_' . $ownertheme);
}
}
return $regions;
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Helper method used by {@link update_legacy_information()}. Update one entry
* in the $this->pluginsheets array, based on the legacy $property propery.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $plugintype e.g. 'mod'.
* @param string $property e.g. 'modsheets'.
* @return void
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*/
protected function update_legacy_plugin_sheets($plugintype, $property) {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
// In Moodle 1.9, modsheets etc. were ignored if standardsheets was false.
if (!empty($this->standardsheets) && property_exists($this, $property)) {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
debugging('$THEME->' . $property . ' is deprecated. Please use the new $THEME->pluginsheets instead.', DEBUG_DEVELOPER);
if (!empty($this->$property) && !in_array($plugintype, $this->pluginsheets)) {
$this->pluginsheets[] = $plugintype;
} else if (empty($this->$property) && in_array($plugintype, $this->pluginsheets)) {
unset($this->pluginsheets[array_search($plugintype, $this->pluginsheets)]);
}
}
}
/**
* This method looks a the settings that have been loaded, to see whether
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* any legacy things are being used, and outputs warning and tries to update
* things to use equivalent newer settings.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*/
protected function update_legacy_information() {
global $CFG;
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
$this->update_legacy_plugin_sheets('mod', 'modsheets');
$this->update_legacy_plugin_sheets('block', 'blocksheets');
$this->update_legacy_plugin_sheets('format', 'formatsheets');
$this->update_legacy_plugin_sheets('gradereport', 'gradereportsheets');
if (!empty($this->langsheets)) {
debugging('$THEME->langsheets is no longer supported. No languages were ' .
'using it for anything, and it did not seem to serve any purpose.', DEBUG_DEVELOPER);
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!empty($this->customcorners)) {
// $THEME->customcorners is deprecated but we provide support for it via the
// custom_corners_renderer_factory class in lib/deprecatedlib.php
debugging('$THEME->customcorners is deprecated. Please use the new $THEME->rendererfactory ' .
'to control HTML generation. Please use $this->rendererfactory = \'custom_corners_renderer_factory\'; ' .
'in your config.php file instead.', DEBUG_DEVELOPER);
$this->rendererfactory = 'custom_corners_renderer_factory';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!empty($this->cssconstants)) {
debugging('$THEME->cssconstants is deprecated. Please use ' .
'$THEME->customcssoutputfunction = \'output_css_replacing_constants\'; ' .
'in your config.php file instead.', DEBUG_DEVELOPER);
$this->customcssoutputfunction = 'output_css_replacing_constants';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!empty($this->CSSEdit)) {
debugging('$THEME->CSSEdit is deprecated. Please use ' .
'$THEME->customcssoutputfunction = \'output_css_for_css_edit\'; ' .
'in your config.php file instead.', DEBUG_DEVELOPER);
$this->customcssoutputfunction = 'output_css_for_css_edit';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
if (!empty($CFG->smartpix)) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$this->iconfinder = 'smartpix_icon_finder';
} else if ($this->custompix) {
$this->iconfinder = 'theme_icon_finder';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Set the variable $CFG->pixpath and $CFG->modpixpath to be the right
MDL-19690 - the last lot of $CFG->pixpath to $OUTPUT->old_icon_url Including MDL-19693 RIP $CFG->pixpath
2009-07-03 07:55:30 +00:00
* ones for this theme. These should no longer be used, but legacy code
* might still rely on them.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*/
MDL-19690 - the last lot of $CFG->pixpath to $OUTPUT->old_icon_url Including MDL-19693 RIP $CFG->pixpath
2009-07-03 07:55:30 +00:00
public function setup_legacy_pix_paths() {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
global $CFG;
if (!empty($CFG->smartpix)) {
if ($CFG->slasharguments) {
// Use this method if possible for better caching
$extra = '';
} else {
$extra = '?file=';
}
$CFG->pixpath = $CFG->httpswwwroot . '/pix/smartpix.php' . $extra . '/' . $this->name;
$CFG->modpixpath = $CFG->httpswwwroot . '/pix/smartpix.php' . $extra . '/' . $this->name . '/mod';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
} else if (empty($THEME->custompix)) {
$CFG->pixpath = $CFG->httpswwwroot . '/pix';
$CFG->modpixpath = $CFG->httpswwwroot . '/mod';
} else {
$CFG->pixpath = $CFG->httpsthemewww . '/' . $this->name . '/pix';
$CFG->modpixpath = $CFG->httpsthemewww . '/' . $this->name . '/pix/mod';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This icon finder implements the old scheme that was used when themes that had
* $THEME->custompix = false.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class pix_icon_finder implements icon_finder {
/**
* Constructor
* @param theme_config $theme the theme we are finding icons for (which is irrelevant).
*/
public function __construct($theme) {
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
* Implement interface method.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @return string the URL for that icon.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function old_icon_url($iconname) {
global $CFG;
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
if (file_exists($CFG->dirroot . '/pix/' . $iconname . '.png')) {
return $CFG->httpswwwroot . '/pix/' . $iconname . '.png';
} else {
return $CFG->httpswwwroot . '/pix/' . $iconname . '.gif';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
* Implement interface method.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @param string $module the module the icon belongs to.
* @return string the URL for that icon.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function mod_icon_url($iconname, $module) {
global $CFG;
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
if (file_exists($CFG->dirroot . '/mod/' . $module . '/' . $iconname . '.png')) {
return $CFG->httpswwwroot . '/mod/' . $module . '/' . $iconname . '.png';
} else {
return $CFG->httpswwwroot . '/mod/' . $module . '/' . $iconname . '.gif';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This icon finder implements the old scheme that was used for themes that had
* $THEME->custompix = true.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class theme_icon_finder implements icon_finder {
protected $themename;
/**
* Constructor
* @param theme_config $theme the theme we are finding icons for.
*/
public function __construct($theme) {
$this->themename = $theme->name;
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
* Implement interface method.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @return string the URL for that icon.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function old_icon_url($iconname) {
global $CFG;
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
if (file_exists($CFG->themedir . '/' . $this->themename . '/pix/' . $iconname . '.png')) {
return $CFG->httpsthemewww . '/' . $this->themename . '/pix/' . $iconname . '.png';
} else {
return $CFG->httpsthemewww . '/' . $this->themename . '/pix/' . $iconname . '.gif';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
* Implement interface method.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @param string $module the module the icon belongs to.
* @return string the URL for that icon.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function mod_icon_url($iconname, $module) {
global $CFG;
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
if (file_exists($CFG->themedir . '/' . $this->themename . '/pix/mod/' . $module . '/' . $iconname . '.png')) {
return $CFG->httpsthemewww . '/' . $this->themename . '/pix/mod/' . $module . '/' . $iconname . '.png';
} else {
return $CFG->httpsthemewww . '/' . $this->themename . '/pix/mod/' . $module . '/' . $iconname . '.gif';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
/**
* This icon finder implements the algorithm in pix/smartpix.php.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class smartpix_icon_finder extends pix_icon_finder {
protected $places = array();
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
outputlib pagelib MDL-19236 Cleaned up PHPdocs on a couple of functions
2009-07-01 03:47:52 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Constructor
* @param theme_config $theme the theme we are finding icons for.
outputlib pagelib MDL-19236 Cleaned up PHPdocs on a couple of functions
2009-07-01 03:47:52 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function __construct($theme) {
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
global $CFG;
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$this->places[$CFG->themedir . '/' . $theme->name . '/pix/'] =
$CFG->httpsthemewww . '/' . $theme->name . '/pix/';
if (!empty($theme->parent)) {
$this->places[$CFG->themedir . '/' . $theme->parent . '/pix/'] =
$CFG->httpsthemewww . '/' . $theme->parent . '/pix/';
}
}
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
* Implement interface method.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @return string the URL for that icon.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function old_icon_url($iconname) {
foreach ($this->places as $dirroot => $urlroot) {
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
if (file_exists($dirroot . $iconname . '.png')) {
return $dirroot . $iconname . '.png';
} else if (file_exists($dirroot . $iconname . '.gif')) {
return $dirroot . $iconname . '.gif';
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
}
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return parent::old_icon_url($iconname);
}
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
* Implement interface method.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @param string $module the module the icon belongs to.
* @return string the URL for that icon.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function mod_icon_url($iconname, $module) {
foreach ($this->places as $dirroot => $urlroot) {
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
if (file_exists($dirroot . 'mod/' . $iconname . '.png')) {
return $dirroot . 'mod/' . $iconname . '.png';
} else if (file_exists($dirroot . 'mod/' . $iconname . '.gif')) {
return $dirroot . 'mod/' . $iconname . '.gif';
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
}
output: MDL-19690 allow for .png or .gif in $OUTPUT->mod/old_icon_url
2009-07-02 09:28:19 +00:00
return parent::old_icon_url($iconname, $module);
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
lib MDL-19077 Created output redirect method and implemented against weblib redirect method This resolves the meta bug that was used when redirecting with a delay Thanks Tim for the help with this one
2009-06-29 07:19:05 +00:00
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This is a base class to help you implement the renderer_factory interface.
*
* It keeps a cache of renderers that have been constructed, so you only need
* to construct each one once in you subclass.
*
* It also has a method to get the name of, and include the renderer.php with
* the definition of, the standard renderer class for a given module.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
abstract class renderer_factory_base implements renderer_factory {
/** @var theme_config the theme we belong to. */
protected $theme;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Constructor.
* @param theme_config $theme the theme we belong to.
*/
public function __construct($theme) {
$this->theme = $theme;
}
/**
* For a given module name, return the name of the standard renderer class
* that defines the renderer interface for that module.
*
* Also, if it exists, include the renderer.php file for that module, so
* the class definition of the default renderer has been loaded.
*
* @param string $component name such as 'core', 'mod_forum' or 'qtype_multichoice'.
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the name of the standard renderer class for that module.
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
protected function standard_renderer_class_for_module($component, $subtype=null) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($component != 'core') {
$pluginrenderer = get_component_directory($component) . '/renderer.php';
if (file_exists($pluginrenderer)) {
include_once($pluginrenderer);
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
if (is_null($subtype)) {
$class = 'moodle_' . $component . '_renderer';
} else {
$class = 'moodle_' . $component . '_' . $subtype . '_renderer';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!class_exists($class)) {
throw new coding_exception('Request for an unknown renderer class ' . $class);
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $class;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This is the default renderer factory for Moodle. It simply returns an instance
* of the appropriate standard renderer class.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class standard_renderer_factory extends renderer_factory_base {
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Implement the subclass method
* @param string $module name such as 'core', 'mod_forum' or 'qtype_multichoice'.
* @param moodle_page $page the page the renderer is outputting content for.
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
* @return object an object implementing the requested renderer interface.
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
public function get_renderer($module, $page, $subtype=null) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($module == 'core') {
return new moodle_core_renderer($page);
} else {
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
$class = $this->standard_renderer_class_for_module($module, $subtype);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return new $class($page, $this->get_renderer('core', $page));
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This is a slight variation on the standard_renderer_factory used by CLI scripts.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class cli_renderer_factory extends standard_renderer_factory {
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Implement the subclass method
* @param string $module name such as 'core', 'mod_forum' or 'qtype_multichoice'.
* @param moodle_page $page the page the renderer is outputting content for.
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
* @return object an object implementing the requested renderer interface.
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
public function get_renderer($module, $page, $subtype=null) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($module == 'core') {
return new cli_core_renderer($page);
} else {
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
parent::get_renderer($module, $page, $subtype);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This is renderer factory allows themes to override the standard renderers using
* php code.
*
* It will load any code from theme/mytheme/renderers.php and
* theme/parenttheme/renderers.php, if then exist. Then whenever you ask for
* a renderer for 'component', it will create a mytheme_component_renderer or a
* parenttheme_component_renderer, instead of a moodle_component_renderer,
* if either of those classes exist.
*
* This generates the slightly different HTML that the custom_corners theme expects.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class theme_overridden_renderer_factory extends standard_renderer_factory {
protected $prefixes = array();
/**
* Constructor.
* @param object $theme the theme we are rendering for.
*/
public function __construct($theme) {
global $CFG;
parent::__construct($theme);
// Initialise $this->prefixes.
$renderersfile = $theme->dir . '/renderers.php';
if (is_readable($renderersfile)) {
include_once($renderersfile);
$this->prefixes[] = $theme->name . '_';
}
if (!empty($theme->parent)) {
$renderersfile = $CFG->themedir .'/'. $theme->parent . '/renderers.php';
if (is_readable($renderersfile)) {
include_once($renderersfile);
$this->prefixes[] = $theme->parent . '_';
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Implement the subclass method
* @param string $module name such as 'core', 'mod_forum' or 'qtype_multichoice'.
* @param moodle_page $page the page the renderer is outputting content for.
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
* @return object an object implementing the requested renderer interface.
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
public function get_renderer($module, $page, $subtype=null) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
foreach ($this->prefixes as $prefix) {
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
if (is_null($subtype)) {
$classname = $prefix . $module . '_renderer';
} else {
$classname = $prefix . $module . '_' . $subtype . '_renderer';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (class_exists($classname)) {
if ($module == 'core') {
return new $classname($page);
} else {
return new $classname($page, $this->get_renderer('core', $page));
}
}
}
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
return parent::get_renderer($module, $page, $subtype);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This is renderer factory that allows you to create templated themes.
*
* This should be considered an experimental proof of concept. In particular,
* the performance is probably not very good. Do not try to use in on a busy site
* without doing careful load testing first!
*
* This renderer factory returns instances of {@link template_renderer} class
* which which implement the corresponding renderer interface in terms of
* templates. To use this your theme must have a templates folder inside it.
* Then suppose the method moodle_core_renderer::greeting($name = 'world');
* exists. Then, a call to $OUTPUT->greeting() will cause the template
* /theme/yourtheme/templates/core/greeting.php to be rendered, with the variable
* $name available. The greeting.php template might contain
*
* <pre>
* <h1>Hello <?php echo $name ?>!</h1>
* </pre>
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class template_renderer_factory extends renderer_factory_base {
/**
* An array of paths of where to search for templates. Normally this theme,
* the parent theme then the standardtemplate theme. (If some of these do
* not exist, or are the same as each other, then the list will be shorter.
*/
protected $searchpaths = array();
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Constructor.
* @param object $theme the theme we are rendering for.
*/
public function __construct($theme) {
global $CFG;
parent::__construct($theme);
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Initialise $this->searchpaths.
if ($theme->name != 'standardtemplate') {
$templatesdir = $theme->dir . '/templates';
if (is_dir($templatesdir)) {
$this->searchpaths[] = $templatesdir;
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!empty($theme->parent)) {
$templatesdir = $CFG->themedir .'/'. $theme->parent . '/templates';
if (is_dir($templatesdir)) {
$this->searchpaths[] = $templatesdir;
}
}
$this->searchpaths[] = $CFG->themedir .'/standardtemplate/templates';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Implement the subclass method
* @param string $module name such as 'core', 'mod_forum' or 'qtype_multichoice'.
* @param moodle_page $page the page the renderer is outputting content for.
* @param string $subtype optional subtype such as 'news' resulting to 'mod_forum_news'
* @return object an object implementing the requested renderer interface.
*/
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
public function get_renderer($module, $page, $subtype=null) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Refine the list of search paths for this module.
$searchpaths = array();
foreach ($this->searchpaths as $rootpath) {
$path = $rootpath . '/' . $module;
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if (!is_null($subtype)) {
$path .= '/' . $subtype;
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (is_dir($path)) {
$searchpaths[] = $path;
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Create a template_renderer that copies the API of the standard renderer.
MDL-19731 get_renderer() accepts optional subtype The initial patch has been reviewed at the issue page. This commit also fixes template_renderer_factory::get_renderer() and sets up folders for subtypes there.
2009-07-08 09:37:06 +00:00
$copiedclass = $this->standard_renderer_class_for_module($module, $subtype);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return new template_renderer($copiedclass, $searchpaths, $page);
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Simple base class for Moodle renderers.
*
* Tracks the xhtml_container_stack to use, which is passed in in the constructor.
*
* Also has methods to facilitate generating HTML output.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class moodle_renderer_base {
/** @var xhtml_container_stack the xhtml_container_stack to use. */
protected $opencontainers;
/** @var moodle_page the page we are rendering for. */
protected $page;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Constructor
* @param moodle_page $page the page we are doing output for.
*/
public function __construct($page) {
$this->opencontainers = $page->opencontainers;
$this->page = $page;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Have we started output yet?
* @return boolean true if the header has been printed.
*/
public function has_started() {
return $this->page->state >= moodle_page::STATE_IN_BODY;
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a tag with attributes and contents
* @param string $tagname The name of tag ('a', 'img', 'span' etc.)
* @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
* @param string $contents What goes between the opening and closing tags
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function output_tag($tagname, $attributes, $contents) {
return $this->output_start_tag($tagname, $attributes) . $contents .
$this->output_end_tag($tagname);
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs an opening tag with attributes
* @param string $tagname The name of tag ('a', 'img', 'span' etc.)
* @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function output_start_tag($tagname, $attributes) {
return '<' . $tagname . $this->output_attributes($attributes) . '>';
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a closing tag
* @param string $tagname The name of tag ('a', 'img', 'span' etc.)
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function output_end_tag($tagname) {
return '</' . $tagname . '>';
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs an empty tag with attributes
* @param string $tagname The name of tag ('input', 'img', 'br' etc.)
* @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function output_empty_tag($tagname, $attributes) {
return '<' . $tagname . $this->output_attributes($attributes) . ' />';
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a HTML attribute and value
* @param string $name The name of the attribute ('src', 'href', 'class' etc.)
* @param string $value The value of the attribute
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function output_attribute($name, $value) {
$value = trim($value);
if ($value || is_numeric($value)) { // We want 0 to be output.
return ' ' . $name . '="' . $value . '"';
}
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a list of HTML attributes and values
* @param array $attributes The tag attributes (array('src' => $url, 'class' => 'class1') etc.)
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function output_attributes($attributes) {
if (empty($attributes)) {
$attributes = array();
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
$output = '';
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
foreach ($attributes as $name => $value) {
$output .= $this->output_attribute($name, $value);
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output;
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Given an array or space-separated list of classes, prepares and returns the HTML class attribute value
* @param mixed $classes Space-separated string or array of classes
* @return string HTML class attribute value
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public static function prepare_classes($classes) {
if (is_array($classes)) {
return implode(' ', array_unique($classes));
}
return $classes;
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Return the URL for an icon identified as in pre-Moodle 2.0 code.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* Suppose you have old code like $url = "$CFG->pixpath/i/course.gif";
* then old_icon_url('i/course'); will return the equivalent URL that is correct now.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the URL for that icon.
*/
public function old_icon_url($iconname) {
return $this->page->theme->old_icon_url($iconname);
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Return the URL for an icon identified as in pre-Moodle 2.0 code.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*
* Suppose you have old code like $url = "$CFG->modpixpath/$mod/icon.gif";
* then mod_icon_url('icon', $mod); will return the equivalent URL that is correct now.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $iconname the name of the icon.
* @param string $module the module the icon belongs to.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the URL for that icon.
*/
public function mod_icon_url($iconname, $module) {
return $this->page->theme->mod_icon_url($iconname, $module);
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This is the templated renderer which copies the API of another class, replacing
* all methods calls with instantiation of a template.
*
* When the method method_name is called, this class will search for a template
* called method_name.php in the folders in $searchpaths, taking the first one
* that it finds. Then it will set up variables for each of the arguments of that
* method, and render the template. This is implemented in the {@link __call()}
* PHP magic method.
*
* Methods like print_box_start and print_box_end are handles specially, and
* implemented in terms of the print_box.php method.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class template_renderer extends moodle_renderer_base {
/** @var ReflectionClass information about the class whose API we are copying. */
protected $copiedclass;
/** @var array of places to search for templates. */
protected $searchpaths;
protected $rendererfactory;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Magic word used when breaking apart container templates to implement
* _start and _end methods.
*/
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
const CONTENTSTOKEN = '-@#-Contents-go-here-#@-';
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Constructor
* @param string $copiedclass the name of a class whose API we should be copying.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param array $searchpaths a list of folders to search for templates in.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @param moodle_page $page the page we are doing output for.
*/
public function __construct($copiedclass, $searchpaths, $page) {
parent::__construct($page);
$this->copiedclass = new ReflectionClass($copiedclass);
$this->searchpaths = $searchpaths;
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* PHP magic method implementation. Do not use this method directly.
* @param string $method The method to call
* @param array $arguments The arguments to pass to the method
* @return mixed The return value of the called method
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function __call($method, $arguments) {
if (substr($method, -6) == '_start') {
return $this->process_start(substr($method, 0, -6), $arguments);
} else if (substr($method, -4) == '_end') {
return $this->process_end(substr($method, 0, -4), $arguments);
} else {
return $this->process_template($method, $arguments);
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Render the template for a given method of the renderer class we are copying,
* using the arguments passed.
* @param string $method the method that was called.
* @param array $arguments the arguments that were passed to it.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
* @return string the HTML to be output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function process_template($method, $arguments) {
if (!$this->copiedclass->hasMethod($method) ||
!$this->copiedclass->getMethod($method)->isPublic()) {
throw new coding_exception('Unknown method ' . $method);
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Find the template file for this method.
$template = $this->find_template($method);
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Use the reflection API to find out what variable names the arguments
// should be stored in, and fill in any missing ones with the defaults.
$namedarguments = array();
$expectedparams = $this->copiedclass->getMethod($method)->getParameters();
foreach ($expectedparams as $param) {
$paramname = $param->getName();
if (!empty($arguments)) {
$namedarguments[$paramname] = array_shift($arguments);
} else if ($param->isDefaultValueAvailable()) {
$namedarguments[$paramname] = $param->getDefaultValue();
} else {
throw new coding_exception('Missing required argument ' . $paramname);
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
}
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Actually render the template.
return $this->render_template($template, $namedarguments);
}
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Actually do the work of rendering the template.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $_template the full path to the template file.
* @param array $_namedarguments an array variable name => value, the variables
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* that should be available to the template.
* @return string the HTML to be output.
*/
protected function render_template($_template, $_namedarguments) {
// Note, we intentionally break the coding guidelines with regards to
// local variable names used in this function, so that they do not clash
// with the names of any variables being passed to the template.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
global $CFG, $SITE, $THEME, $USER;
// The next lines are a bit tricky. The point is, here we are in a method
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// of a renderer class, and this object may, or may not, be the same as
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// the global $OUTPUT object. When rendering the template, we want to use
// this object. However, people writing Moodle code expect the current
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// renderer to be called $OUTPUT, not $this, so define a variable called
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
$OUTPUT = $this;
$PAGE = $this->page;
$COURSE = $this->page->course;
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// And the parameters from the function call.
extract($_namedarguments);
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Include the template, capturing the output.
ob_start();
include($_template);
$_result = ob_get_contents();
ob_end_clean();
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $_result;
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Searches the folders in {@link $searchpaths} to try to find a template for
* this method name. Throws an exception if one cannot be found.
* @param string $method the method name.
* @return string the full path of the template to use.
*/
protected function find_template($method) {
foreach ($this->searchpaths as $path) {
$filename = $path . '/' . $method . '.php';
if (file_exists($filename)) {
return $filename;
}
}
throw new coding_exception('Cannot find template for ' . $this->copiedclass->getName() . '::' . $method);
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Handle methods like print_box_start by using the print_box template,
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* splitting the result, pushing the end onto the stack, then returning the start.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @param string $method the method that was called, with _start stripped off.
* @param array $arguments the arguments that were passed to it.
* @return string the HTML to be output.
*/
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
protected function process_start($method, $arguments) {
array_unshift($arguments, self::CONTENTSTOKEN);
$html = $this->process_template($method, $arguments);
list($start, $end) = explode(self::CONTENTSTOKEN, $html, 2);
$this->opencontainers->push($method, $end);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $start;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Handle methods like print_box_end, we just need to pop the end HTML from
* the stack.
* @param string $method the method that was called, with _end stripped off.
* @param array $arguments not used. Assumed to be irrelevant.
* @return string the HTML to be output.
*/
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
protected function process_end($method, $arguments) {
return $this->opencontainers->pop($method);
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* @return array the list of paths where this class searches for templates.
*/
public function get_search_paths() {
return $this->searchpaths;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the name of the class whose API we are copying.
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function get_copied_class() {
return $this->copiedclass->getName();
}
}
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* This class keeps track of which HTML tags are currently open.
*
* This makes it much easier to always generate well formed XHTML output, even
* if execution terminates abruptly. Any time you output some opening HTML
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* without the matching closing HTML, you should push the necessary close tags
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* onto the stack.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class xhtml_container_stack {
/** @var array stores the list of open containers. */
protected $opencontainers = array();
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
/**
* @var array in developer debug mode, stores a stack trace of all opens and
* closes, so we can output helpful error messages when there is a mismatch.
*/
protected $log = array();
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Push the close HTML for a recently opened container onto the stack.
* @param string $type The type of container. This is checked when {@link pop()}
* is called and must match, otherwise a developer debug warning is output.
* @param string $closehtml The HTML required to close the container.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*/
public function push($type, $closehtml) {
$container = new stdClass;
$container->type = $type;
$container->closehtml = $closehtml;
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
if (debugging('', DEBUG_DEVELOPER)) {
$this->log('Open', $type);
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
array_push($this->opencontainers, $container);
}
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Pop the HTML for the next closing container from the stack. The $type
* must match the type passed when the container was opened, otherwise a
* warning will be output.
* @param string $type The type of container.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return string the HTML required to close the container.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*/
public function pop($type) {
if (empty($this->opencontainers)) {
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
debugging('<p>There are no more open containers. This suggests there is a nesting problem.</p>' .
$this->output_log(), DEBUG_DEVELOPER);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$container = array_pop($this->opencontainers);
if ($container->type != $type) {
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
debugging('<p>The type of container to be closed (' . $container->type .
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
') does not match the type of the next open container (' . $type .
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
'). This suggests there is a nesting problem.</p>' .
$this->output_log(), DEBUG_DEVELOPER);
}
if (debugging('', DEBUG_DEVELOPER)) {
$this->log('Close', $type);
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $container->closehtml;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Close all but the last open container. This is useful in places like error
* handling, where you want to close all the open containers (apart from <body>)
* before outputting the error message.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param bool $shouldbenone assert that the stack should be empty now - causes a
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
* developer debug warning if it isn't.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return string the HTML required to close any open containers inside <body>.
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
public function pop_all_but_last($shouldbenone = false) {
if ($shouldbenone && count($this->opencontainers) != 1) {
debugging('<p>Some HTML tags were opened in the body of the page but not closed.</p>' .
$this->output_log(), DEBUG_DEVELOPER);
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = '';
while (count($this->opencontainers) > 1) {
$container = array_pop($this->opencontainers);
$output .= $container->closehtml;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output;
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* You can call this function if you want to throw away an instance of this
* class without properly emptying the stack (for example, in a unit test).
* Calling this method stops the destruct method from outputting a developer
* debug warning. After calling this method, the instance can no longer be used.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function discard() {
$this->opencontainers = null;
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Emergency fallback. If we get to the end of processing and not all
* containers have been closed, output the rest with a developer debug warning.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
*/
public function __destruct() {
if (empty($this->opencontainers)) {
return;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
debugging('<p>Some containers were left open. This suggests there is a nesting problem.</p>' .
$this->output_log(), DEBUG_DEVELOPER);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
echo $this->pop_all_but_last();
$container = array_pop($this->opencontainers);
echo $container->closehtml;
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Adds an entry to the log.
* @param string $action The name of the action
* @param string $type The type of action
* @return void
*/
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
protected function log($action, $type) {
$this->log[] = '<li>' . $action . ' ' . $type . ' at:' .
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
format_backtrace(debug_backtrace()) . '</li>';
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs the log's contents as a HTML list.
* @return string HTML list of the log
*/
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
protected function output_log() {
return '<ul>' . implode("\n", $this->log) . '</ul>';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* The standard implementation of the moodle_core_renderer interface.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class moodle_core_renderer extends moodle_renderer_base {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/** @var string used in {@link header()}. */
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
const PERFORMANCE_INFO_TOKEN = '%%PERFORMANCEINFO%%';
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/** @var string used in {@link header()}. */
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
const END_HTML_TOKEN = '%%ENDHTML%%';
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/** @var string used in {@link header()}. */
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/** @var string used to pass information from {@link doctype()} to {@link standard_head_html()}. */
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected $contenttype;
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/** @var string used by {@link redirect_message()} method to communicate with {@link header()}. */
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected $metarefreshtag = '';
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Get the DOCTYPE declaration that should be used with this page. Designed to
* be called in theme layout.php files.
* @return string the DOCTYPE declaration (and any XML prologue) that should be used.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function doctype() {
global $CFG;
$doctype = '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">' . "\n";
$this->contenttype = 'text/html; charset=utf-8';
if (empty($CFG->xmlstrictheaders)) {
return $doctype;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// We want to serve the page with an XML content type, to force well-formedness errors to be reported.
$prolog = '<?xml version="1.0" encoding="utf-8"?>' . "\n";
if (isset($_SERVER['HTTP_ACCEPT']) && strpos($_SERVER['HTTP_ACCEPT'], 'application/xhtml+xml') !== false) {
// Firefox and other browsers that can cope natively with XHTML.
$this->contenttype = 'application/xhtml+xml; charset=utf-8';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
} else if (preg_match('/MSIE.*Windows NT/', $_SERVER['HTTP_USER_AGENT'])) {
// IE can't cope with application/xhtml+xml, but it will cope if we send application/xml with an XSL stylesheet.
$this->contenttype = 'application/xml; charset=utf-8';
$prolog .= '<?xml-stylesheet type="text/xsl" href="' . $CFG->httpswwwroot . '/lib/xhtml.xsl"?>' . "\n";
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
} else {
$prolog = '';
}
return $prolog . $doctype;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* The attributes that should be added to the <html> tag. Designed to
* be called in theme layout.php files.
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function htmlattributes() {
return get_html_lang(true) . ' xmlns="http://www.w3.org/1999/xhtml"';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* The standard tags (meta tags, links to stylesheets and JavaScript, etc.)
* that should be included in the <head> tag. Designed to be called in theme
* layout.php files.
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function standard_head_html() {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
global $CFG;
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = '';
$output .= '<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />' . "\n";
$output .= '<meta name="keywords" content="moodle, ' . $this->page->title . '" />' . "\n";
if (!$this->page->cacheable) {
$output .= '<meta http-equiv="pragma" content="no-cache" />' . "\n";
$output .= '<meta http-equiv="expires" content="0" />' . "\n";
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// This is only set by the {@link redirect()} method
$output .= $this->metarefreshtag;
// Check if a periodic refresh delay has been set and make sure we arn't
// already meta refreshing
if ($this->metarefreshtag=='' && $this->page->periodicrefreshdelay!==null) {
javascript MDL-16673 Removed all removeable uses of CFG->javascript In doing this I was able to eliminate the need for javascript.php files, now removed. I will also be filing several subtasks to clean up the linked to JS files in OUTPUT as well as all instance of the old style of focusing.
2009-07-07 09:09:16 +00:00
$output .= '<meta http-equiv="refresh" content="'.$this->page->periodicrefreshdelay.';url='.$this->page->url->out().'" />';
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
javascript MDL-16673 Removed all removeable uses of CFG->javascript In doing this I was able to eliminate the need for javascript.php files, now removed. I will also be filing several subtasks to clean up the linked to JS files in OUTPUT as well as all instance of the old style of focusing.
2009-07-07 09:09:16 +00:00
$this->page->requires->js('lib/javascript-static.js')->in_head();
$this->page->requires->js('lib/javascript-mod.php')->in_head();
$this->page->requires->js('lib/overlib/overlib.js')->in_head();
$this->page->requires->js('lib/overlib/overlib_cssstyle.js')->in_head();
$this->page->requires->js('lib/cookies.js')->in_head();
$this->page->requires->js_function_call('setTimeout', Array('fix_column_widths()', 20));
$focus = $this->page->focuscontrol;
if (!empty($focus)) {
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
if (preg_match("#forms\['([a-zA-Z0-9]+)'\].elements\['([a-zA-Z0-9]+)'\]#", $focus, $matches)) {
outputlib MDL-19740 Fixed up outputlib focus handling to deal with the three different ways of requesting focus.
2009-07-08 09:01:20 +00:00
// This is a horrifically bad way to handle focus but it is passed in
// through messy formslib::moodleform
$this->page->requires->js_function_call('old_onload_focus', Array($matches[1], $matches[2]));
} else if (strpos($focus, '.')!==false) {
javascript MDL-16673 Removed all removeable uses of CFG->javascript In doing this I was able to eliminate the need for javascript.php files, now removed. I will also be filing several subtasks to clean up the linked to JS files in OUTPUT as well as all instance of the old style of focusing.
2009-07-07 09:09:16 +00:00
// Old style of focus, bad way to do it
outputlib MDL-19740 Fixed up outputlib focus handling to deal with the three different ways of requesting focus.
2009-07-08 09:01:20 +00:00
debugging('This code is using the old style focus event, Please update this code to focus on an element id or the moodleform focus method.', DEBUG_DEVELOPER);
$this->page->requires->js_function_call('old_onload_focus', explode('.', $focus, 2));
javascript MDL-16673 Removed all removeable uses of CFG->javascript In doing this I was able to eliminate the need for javascript.php files, now removed. I will also be filing several subtasks to clean up the linked to JS files in OUTPUT as well as all instance of the old style of focusing.
2009-07-07 09:09:16 +00:00
} else {
// Focus element with given id
$this->page->requires->js_function_call('focuscontrol', Array($focus));
}
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// Add the meta tags from the themes if any were requested.
$output .= $this->page->theme->get_meta_tags($this->page);
// Get any HTML from the page_requirements_manager.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output .= $this->page->requires->get_head_code();
// List alternate versions.
foreach ($this->page->alternateversions as $type => $alt) {
$output .= $this->output_empty_tag('link', array('rel' => 'alternate',
'type' => $type, 'title' => $alt->title, 'href' => $alt->url));
}
return $output;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* The standard tags (typically skip links) that should be output just inside
* the start of the <body> tag. Designed to be called in theme layout.php files.
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function standard_top_of_body_html() {
return $this->page->requires->get_top_of_body_code();
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* The standard tags (typically performance information and validation links,
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* if we are in developer debug mode) that should be output in the footer area
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* of the page. Designed to be called in theme layout.php files.
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function standard_footer_html() {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// This function is normally called from a layout.php file in {@link header()}
// but some of the content won't be known until later, so we return a placeholder
// for now. This will be replaced with the real content in {@link footer()}.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = self::PERFORMANCE_INFO_TOKEN;
MDL-19010: In developer debug mode, print information about this page in the footer.
2009-07-20 06:18:16 +00:00
if (debugging('', DEBUG_DEVELOPER)) {
$output .= '<div class="performanceinfo">This page is: ' . $this->page->debug_summary() . '</div>';
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (debugging()) {
$output .= '<div class="validators"><ul>
<li><a href="http://validator.w3.org/check?verbose=1&amp;ss=1&amp;uri=' . urlencode(qualified_me()) . '">Validate HTML</a></li>
<li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=-1&amp;url1=' . urlencode(qualified_me()) . '">Section 508 Check</a></li>
<li><a href="http://www.contentquality.com/mynewtester/cynthia.exe?rptmode=0&amp;warnp2n3e=1&amp;url1=' . urlencode(qualified_me()) . '">WCAG 1 (2,3) Check</a></li>
</ul></div>';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* The standard tags (typically script tags that are not needed earlier) that
* should be output after everything else, . Designed to be called in theme layout.php files.
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function standard_end_of_body_html() {
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
// This function is normally called from a layout.php file in {@link header()}
// but some of the content won't be known until later, so we return a placeholder
// for now. This will be replaced with the real content in {@link footer()}.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
echo self::END_HTML_TOKEN;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Return the standard string that says whether you are logged in (and switched
* roles/logged in as another user).
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function login_info() {
global $USER;
return user_login_string($this->page->course, $USER);
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Return the 'back' link that normally appears in the footer.
* @return string HTML fragment.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function home_link() {
global $CFG, $SITE;
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($this->page->pagetype == 'site-index') {
// Special case for site home page - please do not remove
return '<div class="sitelink">' .
'<a title="Moodle ' . $CFG->release . '" href="http://moodle.org/">' .
'<img style="width:100px;height:30px" src="' . $CFG->httpswwwroot . '/pix/moodlelogo.gif" alt="moodlelogo" /></a></div>';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
} else if (!empty($CFG->target_release) && $CFG->target_release != $CFG->release) {
// Special case for during install/upgrade.
return '<div class="sitelink">'.
'<a title="Moodle ' . $CFG->target_release . '" href="http://docs.moodle.org/en/Administrator_documentation" onclick="this.target=\'_blank\'">' .
'<img style="width:100px;height:30px" src="' . $CFG->httpswwwroot . '/pix/moodlelogo.gif" alt="moodlelogo" /></a></div>';
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
} else if ($this->page->course->id == $SITE->id || strpos($this->page->pagetype, 'course-view') === 0) {
return '<div class="homelink"><a href="' . $CFG->wwwroot . '/">' .
get_string('home') . '</a></div>';
} else {
return '<div class="homelink"><a href="' . $CFG->wwwroot . '/course/view.php?id=' . $this->page->course->id . '">' .
format_string($this->page->course->shortname) . '</a></div>';
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
}
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Redirects the user by any means possible given the current state
*
* This function should not be called directly, it should always be called using
* the redirect function in lib/weblib.php
*
* The redirect function should really only be called before page output has started
* however it will allow itself to be called during the state STATE_IN_BODY
*
* @param string $encodedurl The URL to send to encoded if required
* @param string $message The message to display to the user if any
* @param int $delay The delay before redirecting a user, if $message has been
* set this is a requirement and defaults to 3, set to 0 no delay
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
* @param boolean $debugdisableredirect this redirect has been disabled for
* debugging purposes. Display a message that explains, and don't
* trigger the redirect.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string The HTML to display to the user before dying, may contain
* meta refresh, javascript refresh, and may have set header redirects
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*/
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
public function redirect_message($encodedurl, $message, $delay, $debugdisableredirect) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
global $CFG;
$url = str_replace('&amp;', '&', $encodedurl);
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
switch ($this->page->state) {
case moodle_page::STATE_BEFORE_HEADER :
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// No output yet it is safe to delivery the full arsenal of redirect methods
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
if (!$debugdisableredirect) {
// Don't use exactly the same time here, it can cause problems when both redirects fire at the same time.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$this->metarefreshtag = '<meta http-equiv="refresh" content="'. $delay .'; url='. $encodedurl .'" />'."\n";
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
$this->page->requires->js_function_call('document.location.replace', array($url))->after_delay($delay + 3);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
$output = $this->header();
break;
case moodle_page::STATE_PRINTING_HEADER :
// We should hopefully never get here
throw new coding_exception('You cannot redirect while printing the page header');
break;
case moodle_page::STATE_IN_BODY :
// We really shouldn't be here but we can deal with this
debugging("You should really redirect before you start page output");
output MDL-19077 typo bug on $debugdisableredirect
2009-07-10 07:08:12 +00:00
if (!$debugdisableredirect) {
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
$this->page->requires->js_function_call('document.location.replace', array($url))->after_delay($delay);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
$output = $this->opencontainers->pop_all_but_last();
break;
case moodle_page::STATE_DONE :
// Too late to be calling redirect now
throw new coding_exception('You cannot redirect after the entire page has been generated');
break;
}
MDL-19696 & MDL-16706 refactor sam's redirect changes, so they can work during initial install.
2009-07-03 09:03:29 +00:00
$output .= $this->notification($message, 'redirectmessage');
$output .= '<a href="'. $encodedurl .'">'. get_string('continue') .'</a>';
if ($debugdisableredirect) {
$output .= '<p><strong>Error output, so disabling automatic redirect.</strong></p>';
}
$output .= $this->footer();
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
/**
* Start output by sending the HTTP headers, and printing the HTML <head>
* and the start of the <body>.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* To control what is printed, you should set properties on $PAGE. If you
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* are familiar with the old {@link print_header()} function from Moodle 1.9
* you will find that there are properties on $PAGE that correspond to most
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* of the old parameters to could be passed to print_header.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Not that, in due course, the remaining $navigation, $menu parameters here
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* will be replaced by more properties of $PAGE, but that is still to do.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $navigation legacy, like the old parameter to print_header. Will be
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* removed when there is a $PAGE->... replacement.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $menu legacy, like the old parameter to print_header. Will be
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* removed when there is a $PAGE->... replacement.
* @return string HTML that you must output this, preferably immediately.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function header($navigation = '', $menu='') {
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// TODO remove $navigation and $menu arguments - replace with $PAGE->navigation
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
global $USER, $CFG;
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$this->page->set_state(moodle_page::STATE_PRINTING_HEADER);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Find the appropriate page template, based on $this->page->generaltype.
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$templatefile = $this->page->theme->template_for_page($this->page->generaltype);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($templatefile) {
// Render the template.
$template = $this->render_page_template($templatefile, $menu, $navigation);
} else {
// New style template not found, fall back to using header.html and footer.html.
$template = $this->handle_legacy_theme($navigation, $menu);
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Slice the template output into header and footer.
$cutpos = strpos($template, self::MAIN_CONTENT_TOKEN);
if ($cutpos === false) {
throw new coding_exception('Layout template ' . $templatefile .
' does not contain the string "' . self::MAIN_CONTENT_TOKEN . '".');
}
$header = substr($template, 0, $cutpos);
$footer = substr($template, $cutpos + strlen(self::MAIN_CONTENT_TOKEN));
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes: MDL-19077 fix bugs in cli_renderer. Use correct doctype with legacy header.html.
2009-07-13 06:10:03 +00:00
if (empty($this->contenttype)) {
debugging('The layout template did not call $OUTPUT->doctype()');
$this->doctype();
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
send_headers($this->contenttype, $this->page->cacheable);
$this->opencontainers->push('header/footer', $footer);
$this->page->set_state(moodle_page::STATE_IN_BODY);
return $header . $this->skip_link_target();
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Renders and outputs the page template.
* @param string $templatefile The name of the template's file
* @param array $menu The menu that will be used in the included file
* @param array $navigation The navigation that will be used in the included file
* @return string HTML code
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function render_page_template($templatefile, $menu, $navigation) {
global $CFG, $SITE, $THEME, $USER;
// The next lines are a bit tricky. The point is, here we are in a method
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// of a renderer class, and this object may, or may not, be the same as
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// the global $OUTPUT object. When rendering the template, we want to use
// this object. However, people writing Moodle code expect the current
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
// renderer to be called $OUTPUT, not $this, so define a variable called
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// $OUTPUT pointing at $this. The same comment applies to $PAGE and $COURSE.
$OUTPUT = $this;
$PAGE = $this->page;
$COURSE = $this->page->course;
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
ob_start();
include($templatefile);
$template = ob_get_contents();
ob_end_clean();
return $template;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Renders and outputs a legacy template.
* @param array $navigation The navigation that will be used in the included file
* @param array $menu The menu that will be used in the included file
* @return string HTML code
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
protected function handle_legacy_theme($navigation, $menu) {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
global $CFG, $SITE, $USER;
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Set a pretend global from the properties of this class.
// See the comment in render_page_template for a fuller explanation.
$COURSE = $this->page->course;
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$THEME = $this->page->theme;
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Set up local variables that header.html expects.
$direction = $this->htmlattributes();
$title = $this->page->title;
$heading = $this->page->heading;
$focus = $this->page->focuscontrol;
$button = $this->page->button;
$pageid = $this->page->pagetype;
$pageclass = $this->page->bodyclasses;
$bodytags = ' class="' . $pageclass . '" id="' . $pageid . '"';
$home = $this->page->generaltype == 'home';
$meta = $this->standard_head_html();
// The next line is a nasty hack. having set $meta to standard_head_html, we have already
// got the contents of include($CFG->javascript). However, legacy themes are going to
// include($CFG->javascript) again. We want to make sure that when they do, nothing is output.
$CFG->javascript = $CFG->libdir . '/emptyfile.php';
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Set up local variables that footer.html expects.
$homelink = $this->home_link();
$loggedinas = $this->login_info();
$course = $this->page->course;
$performanceinfo = self::PERFORMANCE_INFO_TOKEN;
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!$menu && $navigation) {
$menu = $loggedinas;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if (!empty($this->page->theme->layouttable)) {
$lt = $this->page->theme->layouttable;
} else {
$lt = array('left', 'middle', 'right');
}
if (!empty($this->page->theme->block_l_max_width)) {
$preferredwidthleft = $this->page->theme->block_l_max_width;
} else {
$preferredwidthleft = 210;
}
if (!empty($this->page->theme->block_r_max_width)) {
$preferredwidthright = $this->page->theme->block_r_max_width;
} else {
$preferredwidthright = 210;
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
ob_start();
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
include($this->page->theme->dir . '/header.html');
echo '<table id="layout-table"><tr>';
foreach ($lt as $column) {
Fix my silly mistake. Thanks for noticing Eloy.
2009-07-22 14:26:47 +00:00
if ($column == 'left' && $this->page->blocks->region_has_content(BLOCK_POS_LEFT, $this)) {
blocks editing ui: MDL-19398 showing and hiding blocks now works.
2009-07-15 07:41:25 +00:00
echo '<td id="left-column" class="block-region" style="width: ' . $preferredwidthright . 'px; vertical-align: top;">';
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
echo $this->container_start();
echo $this->blocks_for_region(BLOCK_POS_LEFT);
echo $this->container_end();
echo '</td>';
} else if ($column == 'middle') {
echo '<td id="middle-column" style="vertical-align: top;">';
echo $this->container_start();
echo $this->skip_link_target();
echo self::MAIN_CONTENT_TOKEN;
echo $this->container_end();
echo '</td>';
Fix my silly mistake. Thanks for noticing Eloy.
2009-07-22 14:26:47 +00:00
} else if ($column == 'right' && $this->page->blocks->region_has_content(BLOCK_POS_RIGHT, $this)) {
blocks editing ui: MDL-19398 showing and hiding blocks now works.
2009-07-15 07:41:25 +00:00
echo '<td id="right-column" class="block-region" style="width: ' . $preferredwidthright . 'px; vertical-align: top;">';
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
echo $this->container_start();
echo $this->blocks_for_region(BLOCK_POS_RIGHT);
echo $this->container_end();
echo '</td>';
}
}
echo '</tr></table>';
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$menu = str_replace('navmenu', 'navmenufooter', $menu);
include($THEME->dir . '/footer.html');
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = ob_get_contents();
ob_end_clean();
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes: MDL-19077 better handling of top of body code for legacy themes.
2009-07-17 06:51:25 +00:00
// Put in the start of body code. Bit of a hack, put it in before the first
// <div or <table.
$divpos = strpos($output, '<div');
$tablepos = strpos($output, '<table');
if ($divpos === false || ($tablepos !== false && $tablepos < $divpos)) {
$pos = $tablepos;
} else {
$pos = $divpos;
}
$output = substr($output, 0, $divpos) . $this->standard_top_of_body_html() .
substr($output, $divpos);
// Put in the end token before the end of body.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = str_replace('</body>', self::END_HTML_TOKEN . '</body>', $output);
themes: MDL-19077 better handling of top of body code for legacy themes.
2009-07-17 06:51:25 +00:00
themes: MDL-19077 fix bugs in cli_renderer. Use correct doctype with legacy header.html.
2009-07-13 06:10:03 +00:00
// Make sure we use the correct doctype.
$output = preg_replace('/(<!DOCTYPE.+?>)/s', $this->doctype(), $output);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output;
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs the page's footer
* @return string HTML fragment
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function footer() {
outputlib: MDL-19077 better reporting when open/close containers don't match.
2009-07-04 13:36:05 +00:00
$output = $this->opencontainers->pop_all_but_last(true);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$footer = $this->opencontainers->pop('header/footer');
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// Provide some performance info if required
$performanceinfo = '';
if (defined('MDL_PERF') || (!empty($CFG->perfdebug) and $CFG->perfdebug > 7)) {
$perf = get_performance_info();
if (defined('MDL_PERFTOLOG') && !function_exists('register_shutdown_function')) {
error_log("PERF: " . $perf['txt']);
}
if (defined('MDL_PERFTOFOOT') || debugging() || $CFG->perfdebug > 7) {
$performanceinfo = $perf['html'];
}
}
$footer = str_replace(self::PERFORMANCE_INFO_TOKEN, $performanceinfo, $footer);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$footer = str_replace(self::END_HTML_TOKEN, $this->page->requires->get_end_code(), $footer);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$this->page->set_state(moodle_page::STATE_DONE);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output . $footer;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
/**
* Output the row of editing icons for a block, as defined by the controls array.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param array $controls an array like {@link block_contents::$controls}.
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @return HTML fragment.
*/
public function block_controls($controls) {
if (empty($controls)) {
return '';
}
$controlshtml = array();
foreach ($controls as $control) {
$controlshtml[] = $this->output_tag('a', array('class' => 'icon',
'title' => $control['caption'], 'href' => $control['url']),
blocks editing ui: MDL-19398 move generating the block edit icons to blocklib.php Since that is where the resulting actions are processed.
2009-07-14 10:57:06 +00:00
$this->output_empty_tag('img', array('src' => $this->old_icon_url($control['icon']),
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
'alt' => $control['caption'])));
}
return $this->output_tag('div', array('class' => 'commands'), implode('', $controlshtml));
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Prints a nice side block with an optional header.
*
* The content is described
* by a {@link block_contents} object.
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @param block_contents $bc HTML for the content
themes: MDL-19077 pass the region name ot the block output function. Might be useful if a theme wants to render blocks differently in regions like 'top' or 'bottom'.
2009-07-22 07:13:43 +00:00
* @param string $region the region the block is appearing in.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the HTML to be output.
*/
themes: MDL-19077 pass the region name ot the block output function. Might be useful if a theme wants to render blocks differently in regions like 'top' or 'bottom'.
2009-07-22 07:13:43 +00:00
function block($bc, $region) {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$bc = clone($bc); // Avoid messing up the object passed in.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$bc->prepare();
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$skiptitle = strip_tags($bc->title);
if (empty($skiptitle)) {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = '';
$skipdest = '';
} else {
$output = $this->output_tag('a', array('href' => '#sb-' . $bc->skipid, 'class' => 'skip-block'),
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
get_string('skipa', 'access', $skiptitle));
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$skipdest = $this->output_tag('span', array('id' => 'sb-' . $bc->skipid, 'class' => 'skip-block-to'), '');
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$bc->attributes['id'] = $bc->id;
$bc->attributes['class'] = $bc->get_classes_string();
$output .= $this->output_start_tag('div', $bc->attributes);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$controlshtml = $this->block_controls($bc->controls);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$title = '';
if ($bc->title) {
$title = $this->output_tag('h2', null, $bc->title);
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if ($title || $controlshtml) {
$output .= $this->output_tag('div', array('class' => 'header'),
$this->output_tag('div', array('class' => 'title'),
$title . $controlshtml));
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$output .= $this->output_start_tag('div', array('class' => 'content'));
$output .= $bc->content;
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($bc->footer) {
$output .= $this->output_tag('div', array('class' => 'footer'), $bc->footer);
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output .= $this->output_end_tag('div');
$output .= $this->output_end_tag('div');
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if ($bc->annotation) {
$output .= $this->output_tag('div', array('class' => 'blockannotation'), $bc->annotation);
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output .= $skipdest;
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$this->init_block_hider_js($bc);
return $output;
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Calls the JS require function to hide a block.
* @param block_contents $bc A block_contents object
* @return void
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
protected function init_block_hider_js($bc) {
if ($bc->collapsible != block_contents::NOT_HIDEABLE) {
$userpref = 'block' . $bc->blockinstanceid . 'hidden';
user_preference_allow_ajax_update($userpref, PARAM_BOOL);
$this->page->requires->yui_lib('dom');
$this->page->requires->yui_lib('event');
$plaintitle = strip_tags($bc->title);
$this->page->requires->js_function_call('new block_hider', array($bc->id, $userpref,
get_string('hideblocka', 'access', $plaintitle), get_string('showblocka', 'access', $plaintitle),
$this->old_icon_url('t/switch_minus'), $this->old_icon_url('t/switch_plus')));
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
}
/**
* Render the contents of a block_list.
* @param array $icons the icon for each item.
* @param array $items the content of each item.
* @return string HTML
*/
public function list_block_contents($icons, $items) {
$row = 0;
$lis = array();
foreach ($items as $key => $string) {
$item = $this->output_start_tag('li', array('class' => 'r' . $row));
if ($icons) {
$item .= $this->output_tag('div', array('class' => 'icon column c0'), $icons[$key]);
}
$item .= $this->output_tag('div', array('class' => 'column c1'), $string);
$item .= $this->output_end_tag('li');
$lis[] = $item;
$row = 1 - $row; // Flip even/odd.
}
return $this->output_tag('ul', array('class' => 'list'), implode("\n", $lis));
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
/**
* Output all the blocks in a particular region.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $region the name of a region on this page.
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @return string the HTML to be output.
*/
public function blocks_for_region($region) {
$blockcontents = $this->page->blocks->get_content_for_region($region, $this);
$output = '';
foreach ($blockcontents as $bc) {
themes: MDL-19077 pass the region name ot the block output function. Might be useful if a theme wants to render blocks differently in regions like 'top' or 'bottom'.
2009-07-22 07:13:43 +00:00
$output .= $this->block($bc, $region);
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $output;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function link_to_popup_window() {
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function button_to_popup_window() {
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function close_window_button($buttontext = null, $reloadopener = false) {
if (empty($buttontext)) {
$buttontext = get_string('closewindow');
}
// TODO
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function close_window($delay = 0, $reloadopener = false) {
// TODO
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
/**
* Output a <select> menu.
*
* You can either call this function with a single moodle_select_menu argument
* or, with a list of parameters, in which case those parameters are sent to
* the moodle_select_menu constructor.
*
* @param moodle_select_menu $selectmenu a moodle_select_menu that describes
* the select menu you want output.
* @return string the HTML for the <select>
*/
public function select_menu($selectmenu) {
$selectmenu = clone($selectmenu);
$selectmenu->prepare();
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($selectmenu->nothinglabel) {
$selectmenu->options = array($selectmenu->nothingvalue => $selectmenu->nothinglabel) +
$selectmenu->options;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (empty($selectmenu->id)) {
$selectmenu->id = 'menu' . str_replace(array('[', ']'), '', $selectmenu->name);
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$attributes = array(
'name' => $selectmenu->name,
'id' => $selectmenu->id,
'class' => $selectmenu->get_classes_string(),
'onchange' => $selectmenu->script,
);
if ($selectmenu->disabled) {
$attributes['disabled'] = 'disabled';
}
if ($selectmenu->tabindex) {
$attributes['tabindex'] = $tabindex;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($selectmenu->listbox) {
if (is_integer($selectmenu->listbox)) {
$size = $selectmenu->listbox;
} else {
$size = min($selectmenu->maxautosize, count($selectmenu->options));
}
$attributes['size'] = $size;
if ($selectmenu->multiple) {
$attributes['multiple'] = 'multiple';
}
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$html = $this->output_start_tag('select', $attributes) . "\n";
foreach ($selectmenu->options as $value => $label) {
$attributes = array('value' => $value);
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
if ((string) $value == (string) $selectmenu->selectedvalue ||
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
(is_array($selectmenu->selectedvalue) && in_array($value, $selectmenu->selectedvalue))) {
$attributes['selected'] = 'selected';
}
$html .= ' ' . $this->output_tag('option', $attributes, s($label)) . "\n";
}
$html .= $this->output_end_tag('select') . "\n";
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $html;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
// TODO choose_from_menu_nested
// TODO choose_from_radio
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Output an error message. By default wraps the error message in <span class="error">.
* If the error message is blank, nothing is output.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $message the error message.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the HTML to output.
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function error_text($message) {
if (empty($message)) {
return '';
}
return $this->output_tag('span', array('class' => 'error'), $message);
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Do not call this function directly.
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* To terminate the current script with a fatal error, call the {@link print_error}
* function, or throw an exception. Doing either of those things will then call this
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* function to display the error, before terminating the execution.
*
* @param string $message The message to output
* @param string $moreinfourl URL where more info can be found about the error
* @param string $link Link for the Continue button
* @param array $backtrace The execution backtrace
* @param string $debuginfo Debugging information
* @param bool $showerrordebugwarning Whether or not to show a debugging warning
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the HTML to output.
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function fatal_error($message, $moreinfourl, $link, $backtrace,
$debuginfo = null, $showerrordebugwarning = false) {
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output = '';
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if ($this->has_started()) {
$output .= $this->opencontainers->pop_all_but_last();
} else {
// Header not yet printed
@header('HTTP/1.0 404 Not Found');
$this->page->set_title(get_string('error'));
$output .= $this->header();
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$message = '<p class="errormessage">' . $message . '</p>'.
'<p class="errorcode"><a href="' . $moreinfourl . '">' .
get_string('moreinformation') . '</a></p>';
$output .= $this->box($message, 'errorbox');
if (debugging('', DEBUG_DEVELOPER)) {
if ($showerrordebugwarning) {
$output .= $this->notification('error() is a deprecated function. ' .
'Please call print_error() instead of error()', 'notifytiny');
}
if (!empty($debuginfo)) {
$output .= $this->notification($debuginfo, 'notifytiny');
}
if (!empty($backtrace)) {
$output .= $this->notification('Stack trace: ' .
format_backtrace($backtrace), 'notifytiny');
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
if (!empty($link)) {
$output .= $this->continue_button($link);
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
$output .= $this->footer();
// Padding to encourage IE to display our error page, rather than its own.
$output .= str_repeat(' ', 512);
return $output;
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
}
MDL-19077 I just found a way to reduce the coupling between the classes.
2009-07-02 07:06:25 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Output a notification (that is, a status message about something that has
* just happened).
*
* @param string $message the message to print out
* @param string $classes normally 'notifyproblem' or 'notifysuccess'.
* @return string the HTML to output.
MDL-19077 I just found a way to reduce the coupling between the classes.
2009-07-02 07:06:25 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function notification($message, $classes = 'notifyproblem') {
return $this->output_tag('div', array('class' =>
moodle_renderer_base::prepare_classes($classes)), clean_text($message));
MDL-19077 I just found a way to reduce the coupling between the classes.
2009-07-02 07:06:25 +00:00
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Print a continue button that goes to a particular URL.
*
* @param string|moodle_url $link The url the button goes to.
* @return string the HTML to output.
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function continue_button($link) {
if (!is_a($link, 'moodle_url')) {
$link = new moodle_url($link);
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $this->output_tag('div', array('class' => 'continuebutton'),
print_single_button($link->out(true), $link->params(), get_string('continue'), 'get', '', true));
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
}
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* Render a HTML table
*
* @param object $table {@link html_table} instance containing all the information needed
* @return string the HTML to output.
*/
public function table(html_table $table) {
$table->prepare();
$attributes = array(
'id' => $table->id,
'width' => $table->width,
'summary' => $table->summary,
'cellpadding' => $table->cellpadding,
'cellspacing' => $table->cellspacing,
'class' => $table->get_classes_string());
$output = $this->output_start_tag('table', $attributes) . "\n";
$countcols = 0;
if (!empty($table->head)) {
$countcols = count($table->head);
$output .= $this->output_start_tag('thead', array()) . "\n";
$output .= $this->output_start_tag('tr', array()) . "\n";
$keys = array_keys($table->head);
$lastkey = end($keys);
foreach ($table->head as $key => $heading) {
$classes = array('header', 'c' . $key);
if (isset($table->headspan[$key]) && $table->headspan[$key] > 1) {
$colspan = $table->headspan[$key];
$countcols += $table->headspan[$key] - 1;
} else {
$colspan = '';
}
if ($key == $lastkey) {
$classes[] = 'lastcol';
}
if (isset($table->colclasses[$key])) {
$classes[] = $table->colclasses[$key];
}
if ($table->rotateheaders) {
// we need to wrap the heading content
$heading = $this->output_tag('span', '', $heading);
}
$attributes = array(
'style' => $table->align[$key] . $table->size[$key] . 'white-space:nowrap;',
'class' => moodle_renderer_base::prepare_classes($classes),
'scope' => 'col',
'colspan' => $colspan);
$output .= $this->output_tag('th', $attributes, $heading) . "\n";
}
$output .= $this->output_end_tag('tr') . "\n";
$output .= $this->output_end_tag('thead') . "\n";
}
if (!empty($table->data)) {
$oddeven = 1;
$keys = array_keys($table->data);
$lastrowkey = end($keys);
$output .= $this->output_start_tag('tbody', array()) . "\n";
foreach ($table->data as $key => $row) {
$oddeven = $oddeven ? 0 : 1;
if (isset($table->rowclasses[$key])) {
$classes = array_unique(moodle_html_component::clean_classes($table->rowclasses[$key]));
} else {
$classes = array();
}
$classes[] = 'r' . $oddeven;
if ($key == $lastrowkey) {
$classes[] = 'lastrow';
}
$output .= $this->output_start_tag('tr', array('class' => moodle_renderer_base::prepare_classes($classes))) . "\n";
if (($row === 'hr') && ($countcols)) {
$output .= $this->output_tag('td', array('colspan' => $countcols),
$this->output_tag('div', array('class' => 'tabledivider'), '')) . "\n";
} else { /// it's a normal row of data
$keys2 = array_keys($row);
$lastkey = end($keys2);
foreach ($row as $key => $item) {
if (isset($table->colclasses[$key])) {
$classes = array_unique(moodle_html_component::clean_classes($table->colclasses[$key]));
} else {
$classes = array();
}
$classes[] = 'cell';
$classes[] = 'c' . $key;
if ($key == $lastkey) {
$classes[] = 'lastcol';
}
$tdstyle = '';
$tdstyle .= isset($table->align[$key]) ? $table->align[$key] : '';
$tdstyle .= isset($table->size[$key]) ? $table->size[$key] : '';
$tdstyle .= isset($table->wrap[$key]) ? $table->wrap[$key] : '';
$output .= $this->output_tag('td',
array('style' => $tdstyle,
'class' => moodle_renderer_base::prepare_classes($classes)),
$item) . "\n";
}
}
$output .= $this->output_end_tag('tr') . "\n";
}
$output .= $this->output_end_tag('tbody') . "\n";
}
$output .= $this->output_end_tag('table') . "\n";
if ($table->rotateheaders && can_use_rotated_text()) {
$this->page->requires->yui_lib('event');
$this->page->requires->js('course/report/progress/textrotate.js');
}
return $output;
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
/**
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* Output the place a skip link goes to.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $id The target name from the corresponding $PAGE->requires->skip_link_to($target) call.
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
* @return string the HTML to output.
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public function skip_link_target($id = '') {
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $this->output_tag('span', array('id' => $id), '');
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a heading
* @param string $text The text of the heading
* @param int $level The level of importance of the heading
* @param string $classes A space-separated list of CSS classes
* @param string $id An optional ID
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function heading($text, $level, $classes = 'main', $id = '') {
$level = (integer) $level;
if ($level < 1 or $level > 6) {
throw new coding_exception('Heading level must be an integer between 1 and 6.');
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
}
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
return $this->output_tag('h' . $level,
array('id' => $id, 'class' => moodle_renderer_base::prepare_classes($classes)), $text);
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a box.
* @param string $contents The contents of the box
* @param string $classes A space-separated list of CSS classes
* @param string $id An optional ID
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function box($contents, $classes = 'generalbox', $id = '') {
return $this->box_start($classes, $id) . $contents . $this->box_end();
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs the opening section of a box.
* @param string $classes A space-separated list of CSS classes
* @param string $id An optional ID
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function box_start($classes = 'generalbox', $id = '') {
$this->opencontainers->push('box', $this->output_end_tag('div'));
return $this->output_start_tag('div', array('id' => $id,
'class' => 'box ' . moodle_renderer_base::prepare_classes($classes)));
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs the closing section of a box.
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function box_end() {
return $this->opencontainers->pop('box');
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs a container.
* @param string $contents The contents of the box
* @param string $classes A space-separated list of CSS classes
* @param string $id An optional ID
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function container($contents, $classes = '', $id = '') {
return $this->container_start($classes, $id) . $contents . $this->container_end();
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs the opening section of a container.
* @param string $classes A space-separated list of CSS classes
* @param string $id An optional ID
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function container_start($classes = '', $id = '') {
$this->opencontainers->push('container', $this->output_end_tag('div'));
return $this->output_start_tag('div', array('id' => $id,
'class' => moodle_renderer_base::prepare_classes($classes)));
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Outputs the closing section of a container.
* @return string the HTML to output.
*/
output: MDL-19690 icon_finder classes and $OUTPUT->mod/old_icon_url This is ready to replace $CFG->pixpath and $CFG->modpixpath soon.
2009-07-02 08:49:25 +00:00
public function container_end() {
return $this->opencontainers->pop('container');
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
}
}
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
/**
* Base class for classes representing HTML elements, like moodle_select_menu.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* Handles the id and class attributes.
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class moodle_html_component {
/**
* @var string value to use for the id attribute of this HTML tag.
*/
public $id = '';
/**
* @var array class names to add to this HTML element.
*/
public $classes = array();
/**
* Ensure some class names are an array.
* @param mixed $classes either an array of class names or a space-separated
* string containing class names.
* @return array the class names as an array.
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public static function clean_classes($classes) {
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
if (is_array($classes)) {
return $classes;
} else {
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
return explode(' ', trim($classes));
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
}
/**
* Set the class name array.
* @param mixed $classes either an array of class names or a space-separated
* string containing class names.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
public function set_classes($classes) {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$this->classes = self::clean_classes($classes);
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
/**
* Add a class name to the class names array.
* @param string $class the new class name to add.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
public function add_class($class) {
$this->classes[] = $class;
}
/**
* Add a whole lot of class names to the class names array.
* @param mixed $classes either an array of class names or a space-separated
* string containing class names.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
public function add_classes($classes) {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$this->classes += self::clean_classes($classes);
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
/**
* Get the class names as a string.
* @return string the class names as a space-separated string. Ready to be put in the class="" attribute.
*/
public function get_classes_string() {
return implode(' ', $this->classes);
}
/**
* Perform any cleanup or final processing that should be done before an
* instance of this class is output.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
public function prepare() {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
$this->classes = array_unique(self::clean_classes($this->classes));
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* This checks developer do not try to assign a property directly
* if we have a setter for it. Otherwise, the property is set as expected.
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param string $name The name of the variable to set
* @param mixed $value The value to assign to the variable
* @return void
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
*/
public function __set($name, $value) {
if ($name == 'class') {
debugging('this way of setting css class has been deprecated. use set_classes() method instead.');
$this->set_classes($value);
} else {
$this->{$name} = $value;
}
}
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
}
/**
* This class hold all the information required to describe a <select> menu that
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
* will be printed by {@link moodle_core_renderer::select_menu()}. (Or by an overridden
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
* version of that method in a subclass.)
*
* All the fields that are not set by the constructor have sensible defaults, so
* you only need to set the properties where you want non-default behaviour.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class moodle_select_menu extends moodle_html_component {
/**
* @var array the choices to show in the menu. An array $value => $label.
*/
public $options;
/**
* @var string the name of this form control. That is, the name of the GET/POST
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* variable that will be set if this select is submitted as part of a form.
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
*/
public $name;
/**
* @var string the option to select initially. Should match one
* of the $options array keys. Default none.
*/
public $selectedvalue;
/**
* @var string The label for the 'nothing is selected' option.
* Defaults to get_string('choosedots').
* Set this to '' if you do not want a 'nothing is selected' option.
*/
public $nothinglabel = null;
/**
* @var string The value returned by the 'nothing is selected' option. Defaults to 0.
*/
public $nothingvalue = 0;
/**
* @var boolean set this to true if you want the control to appear disabled.
*/
public $disabled = false;
/**
* @var integer if non-zero, sets the tabindex attribute on the <select> element. Default 0.
*/
public $tabindex = 0;
/**
* @var mixed Defaults to false, which means display the select as a dropdown menu.
* If true, display this select as a list box whose size is chosen automatically.
* If an integer, display as list box of that size.
*/
public $listbox = false;
/**
* @var integer if you are using $listbox === true to get an automatically
* sized list box, the size of the list box will be the number of options,
* or this number, whichever is smaller.
*/
public $maxautosize = 10;
/**
* @var boolean if true, allow multiple selection. Only used if $listbox is true.
*/
public $multiple = false;
/**
* @deprecated
* @var string JavaScript to add as an onchange attribute. Do not use this.
* Use the YUI even library instead.
*/
public $script = '';
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* @see moodle_html_component::prepare()
* @return void
*/
themes: MDL-19077 start implementing moodle_core_renderer Only a couple of methods implemented. Please review the API and tell me if you are not happy with the direction I am taking.
2009-06-23 10:41:22 +00:00
public function prepare() {
if (empty($this->id)) {
$this->id = 'menu' . str_replace(array('[', ']'), '', $this->name);
}
if (empty($this->classes)) {
$this->set_classes(array('menu' . str_replace(array('[', ']'), '', $this->name)));
}
$this->add_class('select');
parent::prepare();
}
/**
* This is a shortcut for making a simple select menu. It lets you specify
* the options, name and selected option in one line of code.
* @param array $options used to initialise {@link $options}.
* @param string $name used to initialise {@link $name}.
* @param string $selected used to initialise {@link $selected}.
* @return moodle_select_menu A moodle_select_menu object with the three common fields initialised.
*/
public static function make($options, $name, $selected = '') {
$menu = new moodle_select_menu();
$menu->options = $options;
$menu->name = $name;
$menu->selectedvalue = $selected;
return $menu;
}
/**
* This is a shortcut for making a yes/no select menu.
* @param string $name used to initialise {@link $name}.
* @param string $selected used to initialise {@link $selected}.
* @return moodle_select_menu A menu initialised with yes/no options.
*/
public static function make_yes_no($name, $selected) {
return self::make(array(0 => get_string('no'), 1 => get_string('yes')), $name, $selected);
}
themes: MDL-19077 implement the renderer_factory instrastructure. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F The concept is that all the print_... functions in weblib get replaced by methods on a moodle_core_renderer class. Then, the theme can choose whether to use the standard moodle_core_renderer class, or another implemenatation of its own choosing, to generate different HTML. Also, becuase Moodle is modular, we may need a moodle_mod_forum_renderer and so on. In order for the theme to be able to choose which renderers get created, we introduce the concept of a renderer factory, as in the factory design pattern. The theme will choose which factory should be used, and that then creates the renderer objects based on the module name. This commit includes 4 types of factory: * standard_renderer_factory * custom_corners_renderer_factory * theme_overridden_renderer_factory * template_renderer_factory All this with unit tests and PHP doc comments. Note, this new code is not actually used yet. Still todo: 1. actually define the moodle_core_renderer class, and deprecate a lot of weblib functions. 2. make theme_setup initialise everything, so it is used.
2009-06-18 10:43:13 +00:00
}
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* This class represents how a block appears on a page.
*
* During output, each block instance is asked to return a block_contents object,
* those are then passed to the $OUTPUT->block function for display.
*
* {@link $contents} should probably be generated using a moodle_block_..._renderer.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* Other block-like things that need to appear on the page, for example the
* add new block UI, are also represented as block_contents objects.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class block_contents extends moodle_html_component {
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
/** @var int used to set $skipid. */
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
protected static $idcounter = 1;
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
const NOT_HIDEABLE = 0;
const VISIBLE = 1;
const HIDDEN = 2;
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @param integer $skipid All the blocks (or things that look like blocks)
* printed on a page are given a unique number that can be used to construct
* id="" attributes. This is set automatically be the {@link prepare()} method.
* Do not try to set it manually.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public $skipid;
/**
* @var integer If this is the contents of a real block, this should be set to
* the block_instance.id. Otherwise this should be set to 0.
*/
public $blockinstanceid = 0;
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @var integer if this is a real block instance, and there is a corresponding
* block_position.id for the block on this page, this should be set to that id.
* Otherwise it should be 0.
*/
public $blockpositionid = 0;
/**
* @param array $attributes an array of attribute => value pairs that are put on the
* outer div of this block. {@link $id} and {@link $classes} attributes should be set separately.
*/
public $attributes = array();
/**
* @param string $title The title of this block. If this came from user input,
* it should already have had format_string() processing done on it. This will
* be output inside <h2> tags. Please do not cause invalid XHTML.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*/
public $title = '';
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
* @param string $content HTML for the content
*/
public $content = '';
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
* @param array $list an alternative to $content, it you want a list of things with optional icons.
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public $footer = '';
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* Any small print that should appear under the block to explain to the
* teacher about the block, for example 'This is a sticky block that was
* added in the system context.'
* @var string
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public $annotation = '';
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @var integer one of the constants NOT_HIDEABLE, VISIBLE, HIDDEN. Whether
* the user can toggle whether this block is visible.
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public $collapsible = self::NOT_HIDEABLE;
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
/**
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* A (possibly empty) array of editing controls. Each element of this array
blocks editing ui: MDL-19398 move generating the block edit icons to blocklib.php Since that is where the resulting actions are processed.
2009-07-14 10:57:06 +00:00
* should be an array('url' => $url, 'icon' => $icon, 'caption' => $caption).
* $icon is the icon name. Fed to $OUTPUT->old_icon_url.
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
* @var array
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
*/
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
public $controls = array();
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* @see moodle_html_component::prepare()
* @return void
*/
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
public function prepare() {
$this->skipid = self::$idcounter;
self::$idcounter += 1;
$this->add_class('sideblock');
themes & blocks - MDL-19077 & MDL-19010 blocks are now printed by the theme The code to print blocks in now in theme layout.php files. (Or in moodle_core_renderer::handle_legacy_theme) Code for printing blocks everywhere else has been stripped out. (Total diffstat 1225 insertions, 2019 deletions) The way the HTML for a block instance is generated has been cleaned up a lot. Now, the block_instance generates a block_contents object which gives a structured representation of the block, and then $OUTPUT->block builds all the HTML from that. How theme config.php files specify the layout template and block regions by page general type has been changed to be even more flexible. Further refinement for how the theme and block code gets initialised. Ability for scrits to add 'pretend blocks' to the page. That is, things that look like blocks, but are not normal block_instances. (Like the add a new block UI.) Things that are still broken: * some pages in lesson, quiz and resource. I'm working on it. * lots of developer debug notices pointing out things that need to be updated.
2009-07-09 07:35:03 +00:00
if (empty($this->blockinstanceid) || !strip_tags($this->title)) {
$this->collapsible = self::NOT_HIDEABLE;
}
if ($this->collapsible == self::HIDDEN) {
$this->add_class('hidden');
}
if (!empty($this->controls)) {
$this->add_class('block_with_controls');
}
MDL-19077 - Finish eliminating customcorners-specific code in core. The custom-corners-specific code now in theme/customcornser/renderers.php and lib/deprecatedlib.php. Also, $CFG->pixpath is now causing more problems than ever. If it is giving your problems, please call $OUTPUT->initialise_deprecated_cfg_pixpath() as a temporary fix. As you can imagine, we are thinking about a better long-term fix, which is why that method as a silly, and easy to grep name.
2009-06-29 08:17:31 +00:00
parent::prepare();
}
}
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* Holds all the information required to render a <table> by
* {@see moodle_core_renderer::table()} or by an overridden version of that
* method in a subclass.
*
* Example of usage:
* $t = new html_table();
* ... // set various properties of the object $t as described below
* echo $OUTPUT->table($t);
*
* @copyright 2009 David Mudrak <david.mudrak@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class html_table extends moodle_html_component {
/**
* @var array of headings. The n-th array item is used as a heading of the n-th column.
*
* Example of usage:
* $t->head = array('Student', 'Grade');
*/
public $head;
/**
* @var array can be used to make a heading span multiple columns
*
* Example of usage:
* $t->headspan = array(2,1);
*
* In this example, {@see html_table:$data} is supposed to have three columns. For the first two columns,
* the same heading is used. Therefore, {@see html_table::$head} should consist of two items.
*/
public $headspan;
/**
* @var array of column alignments. The value is used as CSS 'text-align' property. Therefore, possible
* values are 'left', 'right', 'center' and 'justify'. Specify 'right' or 'left' from the perspective
* of a left-to-right (LTR) language. For RTL, the values are flipped automatically.
*
* Examples of usage:
* $t->align = array(null, 'right');
* or
* $t->align[1] = 'right';
*
*/
public $align;
/**
* @var array of column sizes. The value is used as CSS 'size' property.
*
* Examples of usage:
* $t->size = array('50%', '50%');
* or
* $t->size[1] = '120px';
*/
public $size;
/**
* @var array of wrapping information. The only possible value is 'nowrap' that sets the
* CSS property 'white-space' to the value 'nowrap' in the given column.
*
* Example of usage:
* $t->wrap = array(null, 'nowrap');
*/
public $wrap;
/**
* @var array of arrays containing the data. Alternatively, if you have
* $head specified, the string 'hr' (for horizontal ruler) can be used
* instead of an array of cells data resulting in a divider rendered.
*
* Example if usage:
* $row1 = array('Harry Potter', '76 %');
* $row2 = array('Hermione Granger', '100 %');
* $t->data = array($row1, $row2);
*/
public $data;
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @var string width of the table, percentage of the page preferred. Defaults to 80% of the page width.
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
* @deprecated since Moodle 2.0. Styling should be in the CSS.
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
*/
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
public $width = null;
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* @var string alignment the whole table. Can be 'right', 'left' or 'center' (default).
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
* @deprecated since Moodle 2.0. Styling should be in the CSS.
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
*/
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
public $tablealign = null;
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* @var int padding on each cell, in pixels
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
* @deprecated since Moodle 2.0. Styling should be in the CSS.
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
*/
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
public $cellpadding = null;
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* @var int spacing between cells, in pixels
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
* @deprecated since Moodle 2.0. Styling should be in the CSS.
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
*/
html_table: MDL-19755 deprecate the attributes of html_table that lead to in-line styling in the HTML.
2009-07-21 07:04:19 +00:00
public $cellspacing = null;
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
/**
* @var array classes to add to particular rows, space-separated string.
* Classes 'r0' or 'r1' are added automatically for every odd or even row,
* respectively. Class 'lastrow' is added automatically for the last row
* in the table.
*
* Example of usage:
* $t->rowclasses[9] = 'tenth'
*/
public $rowclasses;
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @var array classes to add to every cell in a particular column,
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
* space-separated string. Class 'cell' is added automatically by the renderer.
* Classes 'c0' or 'c1' are added automatically for every odd or even column,
* respectively. Class 'lastcol' is added automatically for all last cells
* in a row.
*
* Example of usage:
* $t->colclasses = array(null, 'grade');
*/
public $colclasses;
/**
* @var string description of the contents for screen readers.
*/
public $summary;
/**
* @var bool true causes the contents of the heading cells to be rotated 90 degrees.
*/
public $rotateheaders = false;
/**
* @see moodle_html_component::prepare()
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @return void
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
*/
public function prepare() {
if (!empty($this->align)) {
foreach ($this->align as $key => $aa) {
if ($aa) {
$this->align[$key] = 'text-align:'. fix_align_rtl($aa) .';'; // Fix for RTL languages
} else {
$this->align[$key] = '';
}
}
}
if (!empty($this->size)) {
foreach ($this->size as $key => $ss) {
if ($ss) {
$this->size[$key] = 'width:'. $ss .';';
} else {
$this->size[$key] = '';
}
}
}
if (!empty($this->wrap)) {
foreach ($this->wrap as $key => $ww) {
if ($ww) {
$this->wrap[$key] = 'white-space:nowrap;';
} else {
$this->wrap[$key] = '';
}
}
}
if (!empty($this->head)) {
foreach ($this->head as $key => $val) {
if (!isset($this->align[$key])) {
$this->align[$key] = '';
}
if (!isset($this->size[$key])) {
$this->size[$key] = '';
}
if (!isset($this->wrap[$key])) {
$this->wrap[$key] = '';
}
}
}
MDL-19755 fixed regression - no class test must be done before adding allign classes ;-)
2009-07-13 20:33:56 +00:00
if (empty($this->classes)) { // must be done before align
$this->set_classes(array('generaltable'));
}
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
if (!empty($this->tablealign)) {
$this->add_class('boxalign' . $this->tablealign);
}
if (!empty($this->rotateheaders)) {
$this->add_class('rotateheaders');
} else {
$this->rotateheaders = false; // Makes life easier later.
}
parent::prepare();
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* @param string $name The name of the variable to set
* @param mixed $value The value to assign to the variable
* @return void
*/
MDL-19755 print_table replaced with $OUTPUT->table rowclass property has been deprecated, rowclasses should be used. Direct assigning of the class has been deprecated, moodle_html_elements::set_classes() should be used instead. In both cases, debugging message is displayed.
2009-07-13 11:10:30 +00:00
public function __set($name, $value) {
if ($name == 'rowclass') {
debugging('rowclass[] has been deprecated for html_table ' .
'and should be replaced with rowclasses[]. please fix the code.');
$this->rowclasses = $value;
} else {
parent::__set($name, $value);
}
}
}
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
/**
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* A renderer that generates output for command-line scripts.
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
*
* The implementation of this renderer is probably incomplete.
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
*/
class cli_core_renderer extends moodle_core_renderer {
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Returns the page header.
* @return string HTML fragment
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
*/
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
public function header() {
output_starting_hook();
return $this->page->heading . "\n";
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Returns a template fragment representing a Heading.
* @param string $text The text of the heading
* @param int $level The level of importance of the heading
* @param string $classes A space-separated list of CSS classes
* @param string $id An optional ID
* @return string A template fragment for a heading
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
*/
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
public function heading($text, $level, $classes = 'main', $id = '') {
$text .= "\n";
switch ($level) {
case 1:
return '=>' . $text;
case 2:
return '-->' . $text;
default:
return $text;
}
}
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Returns a template fragment representing a fatal error.
* @param string $message The message to output
* @param string $moreinfourl URL where more info can be found about the error
* @param string $link Link for the Continue button
* @param array $backtrace The execution backtrace
* @param string $debuginfo Debugging information
* @param bool $showerrordebugwarning Whether or not to show a debugging warning
* @return string A template fragment for a fatal error
*/
themes: MDL-19077 fix bugs in cli_renderer. Use correct doctype with legacy header.html.
2009-07-13 06:10:03 +00:00
public function fatal_error($message, $moreinfourl, $link, $backtrace,
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
$debuginfo = null, $showerrordebugwarning = false) {
$output = "!!! $message !!!\n";
if (debugging('', DEBUG_DEVELOPER)) {
if (!empty($debuginfo)) {
$this->notification($debuginfo, 'notifytiny');
}
if (!empty($backtrace)) {
$this->notification('Stack trace: ' . format_backtrace($backtrace, true), 'notifytiny');
}
}
}
MDL-19077 Fixed whitespace
2009-07-23 02:35:58 +00:00
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
/**
* Returns a template fragment representing a notification.
* @param string $message The message to include
* @param string $classes A space-separated list of CSS classes
* @return string A template fragment for a notification
*/
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
public function notification($message, $classes = 'notifyproblem') {
$message = clean_text($message);
themes: MDL-19077 fix bugs in cli_renderer. Use correct doctype with legacy header.html.
2009-07-13 06:10:03 +00:00
if ($classes === 'notifysuccess') {
themes: MDL-19077 new $OUTPUT->header/footer to replace print_header/footer. Also, part of the change from weblib.php functions to $OUTPUT-> methods. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F This is a big change, and the result is not perfect yet. Expect some debugging output on some pages. The main part of these changes are that $OUTPUT->header now looks for a file in the theme called layout.php, rather than header.html and footer.html. Also you can have special templates for certain pages like layout-home.php. There is fallback code for Moodle 1.9 themes, so they still work. A few of the old arguments to print_header are no longer supported. (You get an exception if you try to use them.) Sam H will be cleaning those up. All the weblib functions that have been replaced with $OUTPUT-> have version in deprecatedlib, so existing code will go on working for the foreseeable future.
2009-06-26 09:06:16 +00:00
return "++ $message ++\n";
}
return "!! $message !!\n";
}
}
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
/**
* Output CSS while replacing constants/variables. See MDL-6798 for details
*
* Information from Urs Hunkler:
*
* This is an adaptation of Shaun Inman's "CSS Server-side Constants" for Moodle.
* http://www.shauninman.com/post/heap/2005/08/09/css_constants
*
* To use, specify $THEME->customcssoutputfunction = 'output_css_replacing_constants';
* in your theme's config.php file.
*
* The constant definitions are written into a separate CSS file named like
* constants.css and loaded first in config.php. You can use constants for any
* CSS properties. The constant definition looks like:
* <code>
* \@server constants {
* fontColor: #3a2830;
* aLink: #116699;
* aVisited: #AA2200;
* aHover: #779911;
* pageBackground: #FFFFFF;
* backgroundColor: #EEEEEE;
* backgroundSideblockHeader: #a8a4e9;
* fontcolorSideblockHeader: #222222;
* color1: #98818b;
* color2: #bd807b;
* color3: #f9d1d7;
* color4: #e8d4d8;
* }
* </code>
*
* The lines in the CSS files using CSS constants look like:
* <code>
* body {
* font-size: 100%;
* background-color: pageBackground;
* color: fontColor;
* font-family: 'Bitstream Vera Serif', georgia, times, serif;
* margin: 0;
* padding: 0;
* }
* div#page {
* margin: 0 10px;
* padding-top: 5px;
* border-top-width: 10px;
* border-top-style: solid;
* border-top-color: color3;
* }
* div.clearer {
* clear: both;
* }
* a:link {
* color: aLink;
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* }
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
* </code>
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param array $files an array of the CSS fields that need to be output.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* @param array $toreplace for convenience. If you are going to output the names
* of the css files, for debugging purposes, then you should output
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* str_replace($toreplace, '', $file); because it looks prettier.
* @return void
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*/
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
function output_css_replacing_constants($files, $toreplace) {
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
// Get all the CSS.
ob_start();
foreach ($files as $file) {
$shortname = str_replace($toreplace, '', $file);
echo '/******* ' . $shortname . " start *******/\n\n";
@include_once($file);
echo '/******* ' . $shortname . " end *******/\n\n";
}
$css = ob_get_contents();
ob_end_clean();
if (preg_match_all("/@server\s+(?:variables|constants)\s*\{\s*([^\}]+)\s*\}\s*/i", $css, $matches)) {
$variables = array();
foreach ($matches[0] as $key => $server) {
$css = str_replace($server, '', $css);
preg_match_all("/([^:\}\s]+)\s*:\s*([^;\}]+);/", $matches[1][$key], $vars);
foreach ($vars[1] as $var => $value) {
$variables[$value] = $vars[2][$var];
}
}
$css = str_replace(array_keys($variables), array_values($variables), $css);
}
echo $css;
}
/**
* This CSS output function will link to CSS files rather than including them
* inline.
*
* The single CSS files can then be edited and saved with interactive
* CSS editors like CSSEdit. Any files that have a .php extension are still included
* inline.
*
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* @param array $files an array of the CSS fields that need to be output.
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
* @param array $toreplace for convenience. If you are going to output the names
* of the css files, for debugging purposes, then you should output
MDL-19077 Fixed PHPdocs, whitespace and all typos I could find, except for a few stub methods which have a TODO tag
2009-07-23 02:33:58 +00:00
* str_replace($toreplace, '', $file); because it looks prettier.
* @return void
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
*/
themes: MDL-19077 - more work on the theme_config class. * Writing lots more PHPdoc comments for all the settings. * Strip the comments from the standard theme config.php (see below) * Move finding the layout template from moodle_core_renderer to the theme_config class * Move loading meta.php files from moodle_core_renderer to the theme_config class * MDL-19719 Remove support for $THEME->langsheets, and lang/.../styles.php * MDL-19719 Put the Vietnamese-specific code into the standard theme * Support for styles.php in all plugin types (at the theme's discretion). (c/f MDL-16438) * More PHP doc comments for moodle_core_renderer methods. About stripping comments from config.php: I'm not sure if this is a good idea, and I may revert this bit. I am hoping that once http://phpdocs.moodle.org/HEAD/moodlecore/theme_config.html has been updated, that will be better than copying and pasting these comments into every theme. I intend to post in the themes forum to canvas opinions.
2009-07-07 05:05:06 +00:00
function output_css_for_css_edit($files, $toreplace) {
themes: MDL-19077 change how the theme is initialised and CSS is served. This is part of http://docs.moodle.org/en/Development:Theme_engines_for_Moodle%3F $THEME is now initialised at the same time as $OUTPUT. Old functions like theme_setup are deprecated in favour of methods on $PAGE. There is a new theme_config class in outputlib.php that deals with loading the theme config.php file. CSS used to be served by themes styles.php files calling a function in weblib.php. Now it works by each theme's styles.php file doing $themename = basename(dirname(__FILE__)); require_once(dirname(__FILE__) . '/../../theme/styles.php'); which is less code to be copied into each theme. (Old-style styles.php files still work thanks to some code in deprecatedlib.php.) Admin UI for choosing a theme cleaned up. A couple of theme-specific hard-coded hacks like $THEME->cssconstants and $THEME->CSSEdit have been replaced by a more generic $THEME->customcssoutputfunction hook. See examples at the end of outputlib.php Also: * Fix setting the theme in the URL, which seems to have been broken since 1.9. * Fix up errors on a few pages caused by the new initialisation order. * MDL-19097 moodle_page::set_course should not set $COURSE unless it is $PAGE. * httpsrequired() from moodlelib.php moved to $PAGE->https_required(). * Move has_started() method to the renderer base class. * Further fixes to display of early errors. * Remove print_header/footer_old from weblib. I did not mean to commit them before.
2009-07-01 05:54:26 +00:00
foreach ($files as $file) {
$shortname = str_replace($toreplace, '', $file);
echo '/* @group ' . $shortname . " */\n\n";
if (strpos($file, '.css') !== false) {
echo '@import url("' . $file . '");'."\n\n";
} else {
@include_once($file);
}
echo "/* @end */\n\n";
}
Fixing a notice for Tim
2009-07-07 07:43:36 +00:00
}
Reference in New Issue Copy Permalink