L-electron-Rare/moodle
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

MDL-30979 output: Adjustments to match recent changes in coding style doc

Browse Source
This commit is contained in:
Sam Hemelryk
2012-02-17 14:53:10 +13:00
parent 48d4fad10c
commit 76be40ccf9
6 changed files with 282 additions and 450 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/outputactions.php
+13 -17
View File
@@ -20,8 +20,8 @@
* Please see http://docs.moodle.org/en/Developement:How_Moodle_outputs_HTML
* for an overview.
*
* @package core
* @subpackage output
* @package core_output
* @category output
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -34,28 +34,26 @@ defined('MOODLE_INTERNAL') || die();
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class component_action {
/**
* The DOM event that will trigger this action when caught
* @var string $event DOM event
* @var string $event The DOM event that will trigger this action when caught
*/
public $event;
/**
* @var string A function name to call when the button is clicked
* The JS function you create must have two arguments:
* 1. The event object
* 2. An object/array of arguments ($jsfunctionargs)
* @var string $jsfunction A function name to call when the button is clicked
*/
public $jsfunction = false;
/**
* An array of arguments to pass to the JS function
* @var array $jsfunctionargs
* @var array An array of arguments to pass to the JS function
*/
public $jsfunctionargs = array();
@@ -86,8 +84,8 @@ class component_action {
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class confirm_action extends component_action {
/**
@@ -113,20 +111,18 @@ class confirm_action extends component_action {
* @copyright 2009 Nicolas Connault
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class popup_action extends component_action {
/**
* The JS function to call for the popup
* @var string
* @var string The JS function to call for the popup
*/
public $jsfunction = 'openpopup';
/**
* An array of parameters that will be passed to the openpopup JS function
* @var array $params
* @var array An array of parameters that will be passed to the openpopup JS function
*/
public $params = array(
'height' => 400,
lib/outputcomponents.php
+174 -290
View File
File diff suppressed because it is too large Load Diff
lib/outputfactories.php
+12 -14
View File
@@ -23,8 +23,8 @@
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package core
* @subpackage output
* @package core_output
* @category output
*/
defined('MOODLE_INTERNAL') || die();
@@ -60,8 +60,8 @@ define('RENDERER_TARGET_HTMLEMAIL', 'htmlemail');
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
interface renderer_factory {
@@ -106,13 +106,12 @@ interface renderer_factory {
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
abstract class renderer_factory_base implements renderer_factory {
/**
* The theme we belong to.
* @var theme_config
* @var theme_config The theme we belong to.
*/
protected $theme;
@@ -211,8 +210,8 @@ abstract class renderer_factory_base implements renderer_factory {
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class standard_renderer_factory extends renderer_factory_base {
@@ -256,14 +255,13 @@ class standard_renderer_factory extends renderer_factory_base {
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class theme_overridden_renderer_factory extends renderer_factory_base {
/**
* An array of renderer prefixes
* @var type
* @var array An array of renderer prefixes
*/
protected $prefixes = array();
lib/outputlib.php
+35 -60
View File
@@ -22,8 +22,8 @@
*
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package core
* @subpackage output
* @package core_output
* @category output
*/
defined('MOODLE_INTERNAL') || die();
@@ -99,81 +99,73 @@ function theme_get_revision() {
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class theme_config {
/**
* Default theme, used when requested theme not found.
* @var string
* @var string Default theme, used when requested theme not found.
*/
const DEFAULT_THEME = 'standard';
/**
* You can base your theme on other themes by linking to the other theme as
* @var array You can base your theme on other themes by linking to the other theme as
* parents. This lets you use the CSS and layouts from the other themes
* (see {@link $layouts}).
* 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.
* @var array
*/
public $parents;
/**
* The names of all the stylesheets from this theme that you would
* @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.
* @var array
*/
public $sheets = array();
/**
* The names of all the stylesheets from parents that should be excluded.
* @var array The names of all the stylesheets from parents that should be excluded.
* true value may be used to specify all parents or all themes from one parent.
* If no value specified value from parent theme used.
* @var array or arrays, true means all, null means use value from parent
*/
public $parents_exclude_sheets = null;
/**
* List of plugin sheets to be excluded.
* @var array List of plugin sheets to be excluded.
* If no value specified value from parent theme used.
* @var array of full plugin names, null means use value from parent
*/
public $plugins_exclude_sheets = null;
/**
* List of style sheets that are included in the text editor bodies.
* @var array List of style sheets that are included in the text editor bodies.
* Sheets from parent themes are used automatically and can not be excluded.
* @var array
*/
public $editor_sheets = array();
/**
* The names of all the javascript files this theme that you would
* @var array The names of all the javascript files this theme that you would
* like included from head, in order. Give the names of the files without .js.
* @var array
*/
public $javascripts = array();
/**
* The names of all the javascript files this theme that you would
* @var array The names of all the javascript files this theme that you would
* like included from footer, in order. Give the names of the files without .js.
* @var array
*/
public $javascripts_footer = array();
/**
* The names of all the javascript files from parents that should be excluded.
* true value may be used to specify all parents or all themes from one parent.
* @var array The names of all the javascript files from parents that should
* be excluded. true value may be used to specify all parents or all themes
* from one parent.
* If no value specified value from parent theme used.
* @var array or arrays, true means all, null means use value from parent
*/
public $parents_exclude_javascripts = null;
/**
* Which file to use for each page layout.
* @var array Which file to use for each page layout.
*
* This is an array of arrays. The keys of the outer array are the different layouts.
* Pages in Moodle are using several different layouts like 'normal', 'course', 'home',
@@ -219,13 +211,12 @@ class theme_config {
* the page, but in non-existent regions, they appear here. (Imaging, for example,
* that someone added blocks using a different theme that used different region
* names, and then switched to this theme.)
*
* @var array
*/
public $layouts = array();
/**
* Name of the renderer factory class to use.
* @var string Name of the renderer factory class to use. Must implement the
* {@link renderer_factory} interface.
*
* This is an advanced feature. Moodle output is generated by 'renderers',
* you can customise the HTML that is output by writing custom renderers,
@@ -239,96 +230,83 @@ class theme_config {
* <li>{@link theme_overridden_renderer_factory} - use this if you want to write
* your own custom renderers in a lib.php file in this theme (or the parent theme).</li>
* </ul>
*
* @var string name of a class implementing the {@link renderer_factory} interface.
*/
public $rendererfactory = 'standard_renderer_factory';
/**
* Function to do custom CSS post-processing.
* @var string Function to do custom CSS post-processing.
*
* This is an advanced feature. If you want to do custom post-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.
* @var string the name of a function.
*/
public $csspostprocess = null;
/**
* Accessibility: Right arrow-like character is
* @var string Accessibility: Right arrow-like character is
* 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 automatically. Please DO NOT
* use &lt; &gt; &raquo; - these are confusing for blind users.
* @var string
*/
public $rarrow = null;
/**
* Accessibility: Right arrow-like character is
* @var string Accessibility: Right arrow-like character is
* 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 automatically. Please DO NOT
* use &lt; &gt; &raquo; - these are confusing for blind users.
* @var string
*/
public $larrow = null;
/**
* Some themes may want to disable ajax course editing.
* @var bool
* @var bool Some themes may want to disable ajax course editing.
*/
public $enablecourseajax = true;
//==Following properties are not configurable from theme config.php==
/**
* The name of this theme. Set automatically when this theme is
* @var string The name of this theme. Set automatically when this theme is
* loaded. This can not be set in theme config.php
* @var string
*/
public $name;
/**
* The folder where this themes files are stored. This is set
* @var string The folder where this themes files are stored. This is set
* automatically. This can not be set in theme config.php
* @var string
*/
public $dir;
/**
* Theme settings stored in config_plugins table.
* @var stdClass Theme settings stored in config_plugins table.
* This can not be set in theme config.php
* @var object
*/
public $setting = null;
/**
* If set to true and the theme enables the dock then blocks will be able
* @var bool If set to true and the theme enables the dock then blocks will be able
* to be moved to the special dock
* @var bool
*/
public $enable_dock = false;
/**
* If set to true then this theme will not be shown in the theme selector unless
* @var bool If set to true then this theme will not be shown in the theme selector unless
* theme designer mode is turned on.
* @var bool
*/
public $hidefromselector = false;
/**
* Instance of the renderer_factory implementation
* @var renderer_factory Instance of the renderer_factory implementation
* we are using. Implementation detail.
* @var renderer_factory
*/
protected $rf = null;
/**
* List of parent config objects.
* @var array list of parent configs
* @var array List of parent config objects.
**/
protected $parent_configs = array();
@@ -1239,28 +1217,25 @@ class theme_config {
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class xhtml_container_stack {
/**
* Stores the list of open containers.
* @var array
* @var array Stores the list of open containers.
*/
protected $opencontainers = array();
/**
* In developer debug mode, stores a stack trace of all opens and
* @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.
* @var array
*/
protected $log = array();
/**
* Store whether we are developer debug mode. We need this in several places
* including in the destructor where we may not have access to $CFG.
* @var boolean
* @var boolean Store whether we are developer debug mode. We need this in
* several places including in the destructor where we may not have access to $CFG.
*/
protected $isdebugging;
lib/outputrenderers.php
+24 -30
View File
@@ -29,8 +29,8 @@
* - plugin_renderer_base: A renderer class that should be extended by all
* plugin renderers.
*
* @package core
* @subpackage output
* @package core_output
* @category output
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
@@ -47,25 +47,22 @@ defined('MOODLE_INTERNAL') || die();
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class renderer_base {
/**
* The xhtml_container_stack to use.
* @var xhtml_container_stack
* @var xhtml_container_stack The xhtml_container_stack to use.
*/
protected $opencontainers;
/**
* The Moodle page the renderer has been created to assist with.
* @var moodle_page
* @var moodle_page The Moodle page the renderer has been created to assist with.
*/
protected $page;
/**
* The requested rendering target.
* @var string
* @var string The requested rendering target.
*/
protected $target;
@@ -184,13 +181,13 @@ class renderer_base {
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @category output
*/
class plugin_renderer_base extends renderer_base {
/**
* A reference to the current general renderer probably {@see core_renderer}
* @var renderer_base
* @var renderer_base A reference to the current general renderer
* probably {@see core_renderer}
*/
protected $output;
@@ -247,45 +244,42 @@ class plugin_renderer_base extends renderer_base {
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class core_renderer extends renderer_base {
/**
* Do NOT use, please use <?php echo $OUTPUT->main_content() ?>
* in layout files instead.
* @var string used in {@link header()}.
* @deprecated
* @var string used in {@link header()}.
*/
const MAIN_CONTENT_TOKEN = '[MAIN CONTENT GOES HERE]';
/**
* Used to pass information from {@link doctype()} to {@link standard_head_html()}.
* @var string
* @var string Used to pass information from {@link doctype()} to
* {@link standard_head_html()}.
*/
protected $contenttype;
/**
* Used by {@link redirect_message()} method to communicate with {@link header()}.
* @var string
* @var string Used by {@link redirect_message()} method to communicate
* with {@link header()}.
*/
protected $metarefreshtag = '';
/**
* Unique token for the closing HTML
* @var string
* @var string Unique token for the closing HTML
*/
protected $unique_end_html_token;
/**
* Unique token for performance information
* @var string
* @var string Unique token for performance information
*/
protected $unique_performance_info_token;
/**
* Unique token for the main content.
* @var string
* @var string Unique token for the main content.
*/
protected $unique_main_content_token;
@@ -2721,8 +2715,8 @@ EOD;
* @copyright 2009 Tim Hunt
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class core_renderer_cli extends core_renderer {
@@ -2807,8 +2801,8 @@ class core_renderer_cli extends core_renderer {
* @copyright 2010 Petr Skoda
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class core_renderer_ajax extends core_renderer {
lib/outputrequirementslib.php
+24 -39
View File
@@ -21,8 +21,8 @@
*
* @copyright 2009 Tim Hunt, 2010 Petr Skoda
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @package core
* @subpackage output
* @package core_output
* @category output
*/
defined('MOODLE_INTERNAL') || die();
@@ -53,111 +53,96 @@ defined('MOODLE_INTERNAL') || die();
* @copyright 2009 Tim Hunt, 2010 Petr Skoda
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
* @since Moodle 2.0
* @package core
* @subpackage output
* @package core_output
* @category output
*/
class page_requirements_manager {
/**
* List of string available from JS
* @var array
* @var array List of string available from JS
*/
protected $stringsforjs = array();
/**
* List of JS variables to be initialised
* @var array
* @var array List of JS variables to be initialised
*/
protected $jsinitvariables = array('head'=>array(), 'footer'=>array());
/**
* Included JS scripts
* @var array
* @var array Included JS scripts
*/
protected $jsincludes = array('head'=>array(), 'footer'=>array());
/**
* List of needed function calls
* @var array
* @var array List of needed function calls
*/
protected $jscalls = array('normal'=>array(), 'ondomready'=>array());
/**
* List of skip links, those are needed for accessibility reasons
* @var array
* @var array List of skip links, those are needed for accessibility reasons
*/
protected $skiplinks = array();
/**
* Javascript code used for initialisation of page, it should be relatively small
* @var array
* @var array Javascript code used for initialisation of page, it should
* be relatively small
*/
protected $jsinitcode = array();
/**
* Theme sheets, initialised only from core_renderer
* @var array of moodle_url
* @var array of moodle_url Theme sheets, initialised only from core_renderer
*/
protected $cssthemeurls = array();
/**
* List of custom theme sheets, these are strongly discouraged!
* @var array of moodle_url List of custom theme sheets, these are strongly discouraged!
* Useful mostly only for CSS submitted by teachers that is not part of the theme.
* @var array of moodle_url
*/
protected $cssurls = array();
/**
* List of requested event handlers
* @var array
* @var array List of requested event handlers
*/
protected $eventhandlers = array();
/**
* Extra modules
* @var array
* @var array Extra modules
*/
protected $extramodules = array();
/**
* Flag indicated head stuff already printed
* @var bool
* @var bool Flag indicated head stuff already printed
*/
protected $headdone = false;
/**
* Flag indicating top of body already printed
* @var bool
* @var bool Flag indicating top of body already printed
*/
protected $topofbodydone = false;
/**
* YUI PHPLoader instance responsible for YUI2 loading from PHP only
* @var YAHOO_util_Loader
* @var YAHOO_util_Loader YUI PHPLoader instance responsible for YUI2 loading
* from PHP only
*/
protected $yui2loader;
/**
* YUI PHPLoader instance responsible for YUI3 loading from PHP only
* @var stdClass
* @var stdClass YUI PHPLoader instance responsible for YUI3 loading from PHP only
*/
protected $yui3loader;
/**
* YUI loader information for YUI3 loading from javascript
* @var stdClass
* @var stdClass YUI loader information for YUI3 loading from javascript
*/
protected $M_yui_loader;
/**
* Some config vars exposed in JS, please no secret stuff there
* @var array
* @var array Some config vars exposed in JS, please no secret stuff there
*/
protected $M_cfg;
/**
* Stores debug backtraces from when JS modules were included in the page
* @var array
* @var array Stores debug backtraces from when JS modules were included in the page
*/
protected $debug_moduleloadstacktraces = array();