Inheritance diagram for page_requirements_manager:

Public Member Functions
	__construct ()
	Page requirements constructor.

	css ($stylesheet)
	Ensure that the specified CSS file is linked to from this page. More...

	css_theme (moodle_url $stylesheet)
	Add theme stylesheet to page - do not use from plugin code, this should be called only from the core renderer! More...

	data_for_js ($variable, $data, $inhead=false)
	!!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now. More...

	event_handler ($selector, $event, $function, array $arguments=null)
	Creates a YUI event handler. More...

	get_config_for_javascript (moodle_page $page, renderer_base $renderer)
	Return the safe config values that get set for javascript in "M.cfg". More...

	get_end_code ()
	Generate any HTML that needs to go at the end of the page. More...

	get_head_code (moodle_page $page, core_renderer $renderer)
	Generate any HTML that needs to go inside the <head> tag. More...

	get_top_of_body_code (renderer_base $renderer)
	Generate any HTML that needs to go at the start of the <body> tag. More...

	has_one_time_item_been_created ($thing)
	Has a particular bit of HTML that is only required once on this page (e.g. More...

	is_head_done ()
	Have we already output the code in the <head> tag? More...

	is_top_of_body_done ()
	Have we already output the code at the start of the <body> tag? More...

	jquery ()
	Request inclusion of jQuery library in the page. More...

	jquery_override_plugin ($oldplugin, $newplugin)
	Request replacement of one jQuery plugin by another. More...

	jquery_plugin ($plugin, $component='core')
	Request inclusion of jQuery plugin. More...

	js ($url, $inhead=false)
	Ensure that the specified JavaScript file is linked to from this page. More...

	js_amd_inline ($code)
	This function appends a block of code to the AMD specific javascript block executed in the page footer, just after loading the requirejs library. More...

	js_call_amd ($fullmodule, $func=null, $params=array())
	Load an AMD module and eventually call its method. More...

	js_function_call ($function, array $arguments=null, $ondomready=false, $delay=0)
	!!!DEPRECATED!!! please use js_init_call() if possible Ensure that the specified JavaScript function is called from an inline script somewhere on this page. More...

	js_init_call ($function, array $extraarguments=null, $ondomready=false, array $module=null)
	Ensure that the specified JavaScript function is called from an inline script from page footer. More...

	js_init_code ($jscode, $ondomready=false, array $module=null)
	Add short static javascript code fragment to page footer. More...

	js_module ($module)
	Append YUI3 module to default YUI3 JS loader. More...

	set_one_time_item_created ($thing)
	Indicate that a particular bit of HTML that is only required once on this page (e.g. More...

	set_yuicssmodules (array $modules=array())
	Set the CSS Modules to be included from YUI. More...

	should_create_one_time_item_now ($thing)
	Should we generate a bit of content HTML that is only required once on this page (e.g. More...

	skip_link_to ($target, $linktext)
	Ensure that a skip link to a given target is printed at the top of the <body>. More...

	string_for_js ($identifier, $component, $a=null)
	Make a language string available to JavaScript. More...

	strings_for_js ($identifiers, $component, $a=null)
	Make an array of language strings available for JS. More...

	yui_module ($modules, $function, array $arguments=null, $galleryversion=null, $ondomready=false)
	Creates a JavaScript function call that requires one or more modules to be loaded. More...

Protected Member Functions
	find_module ($component)
	Find out if JS module present and return details. More...

	get_amd_footercode ()
	Returns js code to load amd module loader, then insert inline script tags that contain require() calls using RequireJS. More...

	get_css_code ()
	Returns html tags needed for inclusion of theme CSS. More...

	get_event_handler_code ()
	Returns code needed for registering of event handlers. More...

	get_extra_modules_code ()
	Adds extra modules specified after printing of page header. More...

	get_javascript_code ($ondomready)
	Get the inline JavaScript code that need to appear in a particular place. More...

	get_javascript_init_code ()
	Returns js code to be executed when Y is available. More...

	get_jquery_headcode ()
	Return jQuery related markup for page start. More...

	get_jsrev ()
	Determine the correct JS Revision to use for this load. More...

	get_templaterev ()
	Determine the correct Template revision to use for this load. More...

	get_yui3lib_headcode ()
	Returns basic YUI3 JS loading code. More...

	get_yui3lib_headcss ()
	Returns basic YUI3 CSS code. More...

	init_requirements_data (moodle_page $page, core_renderer $renderer)
	Initialise with the bits of JavaScript that every Moodle page should have. More...

	js_fix_url ($url)
	Returns the actual url through which a script is served. More...

	js_module_loaded ($module)
	Returns true if the module has already been loaded. More...

Protected Attributes
array	$amdjscode = array('')
	Inline scripts using RequireJS module loading.

array	$cssthemeurls = array()
	of moodle_url Theme sheets, initialised only from core_renderer

array	$cssurls = 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.

array	$eventhandlers = array()
	List of requested event handlers.

array	$extramodules = array()
	Extra modules.

bool	$headdone = false
	Flag indicated head stuff already printed.

array	$jquerypluginoverrides = array()
	list of jQuery plugin overrides

array	$jqueryplugins = array()
	list of requested jQuery plugins

array	$jscalls = array('normal'=>array(), 'ondomready'=>array())
	List of needed function calls.

array	$jsincludes = array('head'=>array(), 'footer'=>array())
	Included JS scripts.

array	$jsinitcode = array()
	Javascript code used for initialisation of page, it should be relatively small.

array	$jsinitvariables = array('head'=>array(), 'footer'=>array())
	List of JS variables to be initialised.

array	$M_cfg
	Some config vars exposed in JS, please no secret stuff there.

array	$onetimeitemsoutput = array()
	trackes the names of bits of HTML that are only required once per page. More...

array	$skiplinks = array()
	List of skip links, those are needed for accessibility reasons.

array	$stringsforjs = array()
	List of string available from JS.

array	$stringsforjs_as = array()
	List of get_string $a parameters - used for validation only.

bool	$topofbodydone = false
	Flag indicating top of body already printed.

stdClass	$yui3loader
	YUI PHPLoader instance responsible for YUI3 loading from PHP only.

YUI_config	$YUI_config
	default YUI loader configuration

array	$yuicssmodules = array()
	$yuicssmodules

Member Function Documentation

◆ css()

page_requirements_manager::css ( $stylesheet )

Ensure that the specified CSS file is linked to from this page.

Because stylesheet links must go in the <head> part of the HTML, you must call this function before get_head_code() is called. That normally means before the call to print_header. If you call it when it is too late, an exception will be thrown.

Even if a particular style sheet is requested more than once, it will only be linked to once.

Please note use of this feature is strongly discouraged, it is suitable only for places where CSS is submitted directly by teachers. (Students must not be allowed to submit any external CSS because it may contain embedded javascript!). Example of correct use is mod/data.

Parameters

string $stylesheet The path to the .css file, relative to $CFG->wwwroot. For example: $PAGE->requires->css('mod/data/css.php?d='.$data->id);

◆ css_theme()

page_requirements_manager::css_theme ( moodle_url $stylesheet )

Add theme stylesheet to page - do not use from plugin code, this should be called only from the core renderer!

Parameters

moodle_url $stylesheet

Return values

void

◆ data_for_js()

page_requirements_manager::data_for_js	(	$variable,
		$data,
		$inhead = `false`
	)

!!!!!!DEPRECATED!!!!!! please use js_init_call() for everything now.

Make some data from PHP available to JavaScript code.

For example, if you call

     $PAGE->requires->data_for_js('mydata', array('name' => 'Moodle'));

then in JavsScript mydata.name will be 'Moodle'.

Deprecated:

Parameters

string	$variable	the the name of the JavaScript variable to assign the data to. Will probably work if you use a compound name like 'mybuttons.button[1]', but this should be considered an experimental feature.
mixed	$data	The data to pass to JavaScript. This will be escaped using json_encode, so passing objects and arrays should work.
bool	$inhead	initialise in head

Return values

void

◆ event_handler()

page_requirements_manager::event_handler	(		$selector,
			$event,
			$function,
		array	$arguments = `null`
	)

Creates a YUI event handler.

Parameters

mixed	$selector	standard YUI selector for elements, may be array or string, element id is in the form "#idvalue"
string	$event	A valid DOM event (click, mousedown, change etc.)
string	$function	The name of the function to call
array	$arguments	An optional array of argument parameters to pass to the function

◆ find_module()

page_requirements_manager::find_module ( $component )

protected

Find out if JS module present and return details.

Parameters

string $component name of component in frankenstyle, ex: core_group, mod_forum

Return values

array description of module or null if not found

◆ get_amd_footercode()

page_requirements_manager::get_amd_footercode ( )

protected

Returns js code to load amd module loader, then insert inline script tags that contain require() calls using RequireJS.

Return values

string

Reimplemented in fragment_requirements_manager.

◆ get_config_for_javascript()

page_requirements_manager::get_config_for_javascript	(	moodle_page	$page,
		renderer_base	$renderer
	)

Return the safe config values that get set for javascript in "M.cfg".

Since: 2.9

Return values

array List of safe config values that are available to javascript.

◆ get_css_code()

page_requirements_manager::get_css_code ( )

protected

Returns html tags needed for inclusion of theme CSS.

Return values

string

◆ get_end_code()

page_requirements_manager::get_end_code ( )

Generate any HTML that needs to go at the end of the page.

Normally, this method is called automatically by the code that prints the page footer. You should not normally need to call it in your own code.

Return values

string the HTML code to to at the end of the page.

Reimplemented in fragment_requirements_manager.

◆ get_event_handler_code()

page_requirements_manager::get_event_handler_code ( )

protected

Returns code needed for registering of event handlers.

Return values

string JS code

◆ get_extra_modules_code()

page_requirements_manager::get_extra_modules_code ( )

protected

Adds extra modules specified after printing of page header.

Return values

string

◆ get_head_code()

page_requirements_manager::get_head_code	(	moodle_page	$page,
		core_renderer	$renderer
	)

Generate any HTML that needs to go inside the <head> tag.

Normally, this method is called automatically by the code that prints the <head> tag. You should not normally need to call it in your own code.

Parameters

moodle_page	$page
core_renderer	$renderer

Return values

string the HTML code to to inside the <head> tag.

◆ get_javascript_code()

page_requirements_manager::get_javascript_code ( $ondomready )

protected

Get the inline JavaScript code that need to appear in a particular place.

Parameters

bool $ondomready

Return values

string

◆ get_javascript_init_code()

page_requirements_manager::get_javascript_init_code ( )

protected

Returns js code to be executed when Y is available.

Return values

string

◆ get_jquery_headcode()

page_requirements_manager::get_jquery_headcode ( )

protected

Return jQuery related markup for page start.

Return values

string

◆ get_jsrev()

page_requirements_manager::get_jsrev ( )

protected

Determine the correct JS Revision to use for this load.

Return values

int	the jsrev to use.

◆ get_templaterev()

page_requirements_manager::get_templaterev ( )

protected

Determine the correct Template revision to use for this load.

Return values

int	the templaterev to use.

◆ get_top_of_body_code()

page_requirements_manager::get_top_of_body_code ( renderer_base $renderer )

Generate any HTML that needs to go at the start of the <body> tag.

Normally, this method is called automatically by the code that prints the <head> tag. You should not normally need to call it in your own code.

Parameters

renderer_base $renderer

Return values

string the HTML code to go at the start of the <body> tag.

◆ get_yui3lib_headcode()

page_requirements_manager::get_yui3lib_headcode ( )

protected

Returns basic YUI3 JS loading code.

Return values

string

◆ get_yui3lib_headcss()

page_requirements_manager::get_yui3lib_headcss ( )

protected

Returns basic YUI3 CSS code.

Return values

string

◆ has_one_time_item_been_created()

page_requirements_manager::has_one_time_item_been_created ( $thing )

Has a particular bit of HTML that is only required once on this page (e.g.

the contents of the modchooser) already been generated?

Normally, you can use the should_create_one_time_item_now() helper method rather than calling this method directly.

Parameters

string $thing identifier for the bit of content. Should be of the form frankenstyle_things, e.g. core_course_modchooser.

Return values

bool	whether that bit of output has been created.

◆ init_requirements_data()

page_requirements_manager::init_requirements_data	(	moodle_page	$page,
		core_renderer	$renderer
	)

protected

Initialise with the bits of JavaScript that every Moodle page should have.

Parameters

moodle_page	$page
core_renderer	$renderer

◆ is_head_done()

page_requirements_manager::is_head_done ( )

Have we already output the code in the <head> tag?

Return values

bool

◆ is_top_of_body_done()

page_requirements_manager::is_top_of_body_done ( )

Have we already output the code at the start of the <body> tag?

Return values

bool

◆ jquery()

page_requirements_manager::jquery ( )

Request inclusion of jQuery library in the page.

NOTE: this should not be used in official Moodle distribution!

{

See also: http://docs.moodle.org/dev/jQuery}

◆ jquery_override_plugin()

page_requirements_manager::jquery_override_plugin	(	$oldplugin,
		$newplugin
	)

Request replacement of one jQuery plugin by another.

This is useful when themes want to replace the jQuery UI theme, the problem is that theme can not prevent others from including the core ui-css plugin.

Example: 1/ generate new jQuery UI theme and place it into theme/yourtheme/jquery/ 2/ write theme/yourtheme/jquery/plugins.php 3/ init jQuery from theme

// file theme/yourtheme/lib.php function theme_yourtheme_page_init($page) { $page->requires->jquery_plugin('yourtheme-ui-css', 'theme_yourtheme'); $page->requires->jquery_override_plugin('ui-css', 'yourtheme-ui-css'); }

This code prevents loading of standard 'ui-css' which my be requested by other plugins, the 'yourtheme-ui-css' gets loaded only if some other code requires jquery.

{

See also: http://docs.moodle.org/dev/jQuery}

Parameters

string	$oldplugin	original plugin
string	$newplugin	the replacement

◆ jquery_plugin()

page_requirements_manager::jquery_plugin	(	$plugin,
		$component = `'core'`
	)

Request inclusion of jQuery plugin.

NOTE: this should not be used in official Moodle distribution!

jQuery plugins are located in plugin/jquery/* subdirectory, plugin/jquery/plugins.php lists all available plugins.

Included core plugins:

jQuery UI

Add-ons may include extra jQuery plugins in jquery/ directory, plugins.php file defines the mapping between plugin names and necessary page includes.

Examples: // file: mod/xxx/view.php $PAGE->requires->jquery(); $PAGE->requires->jquery_plugin('ui'); $PAGE->requires->jquery_plugin('ui-css');

// file: theme/yyy/lib.php function theme_yyy_page_init(moodle_page $page) { $page->requires->jquery(); $page->requires->jquery_plugin('ui'); $page->requires->jquery_plugin('ui-css'); }

// file: blocks/zzz/block_zzz.php public function get_required_javascript() { parent::get_required_javascript(); $this->page->requires->jquery(); $page->requires->jquery_plugin('ui'); $page->requires->jquery_plugin('ui-css'); }

{

See also: http://docs.moodle.org/dev/jQuery}

Parameters

string	$plugin	name of the jQuery plugin as defined in jquery/plugins.php
string	$component	name of the component

Return values

bool success

◆ js()

page_requirements_manager::js	(	$url,
		$inhead = `false`
	)

Ensure that the specified JavaScript file is linked to from this page.

NOTE: This function is to be used in RARE CASES ONLY, please store your JS in module.js file and use $PAGE->requires->js_init_call() instead or use /yui/ subdirectories for YUI modules.

By default the link is put at the end of the page, since this gives best page-load performance.

Even if a particular script is requested more than once, it will only be linked to once.

Parameters

string \| moodle_url	$url	The path to the .js file, relative to $CFG->dirroot / $CFG->wwwroot. For example '/mod/mymod/customscripts.js'; use moodle_url for external scripts
bool	$inhead	initialise in head

◆ js_amd_inline()

page_requirements_manager::js_amd_inline ( $code )

This function appends a block of code to the AMD specific javascript block executed in the page footer, just after loading the requirejs library.

The code passed here can rely on AMD module loading, e.g. require('jquery', function($) {...});

Parameters

string $code The JS code to append.

◆ js_call_amd()

page_requirements_manager::js_call_amd	(	$fullmodule,
		$func = `null`,
		$params = `array()`
	)

Load an AMD module and eventually call its method.

This function creates a minimal inline JS snippet that requires an AMD module and eventually calls a single function from the module with given arguments. If it is called multiple times, it will be create multiple snippets.

Parameters

string	$fullmodule	The name of the AMD module to load, formatted as <component name>/<module name>.
string	$func	Optional function from the module to call, defaults to just loading the AMD module.
array	$params	The params to pass to the function (will be serialized into JSON).

◆ js_fix_url()

page_requirements_manager::js_fix_url ( $url )

protected

Returns the actual url through which a script is served.

Parameters

moodle_url | string $url full moodle url, or shortened path to script

Return values

moodle_url

◆ js_function_call()

page_requirements_manager::js_function_call	(		$function,
		array	$arguments = `null`,
			$ondomready = `false`,
			$delay = `0`
	)

!!!DEPRECATED!!! please use js_init_call() if possible Ensure that the specified JavaScript function is called from an inline script somewhere on this page.

By default the call will be put in a script tag at the end of the page after initialising Y instance, since this gives best page-load performance and allows you to use YUI3 library.

If you request that a particular function is called several times, then that is what will happen (unlike linking to a CSS or JS file, where only one link will be output).

The main benefit of the method is the automatic encoding of all function parameters.

Deprecated:

Parameters

string	$function	the name of the JavaScritp function to call. Can be a compound name like 'Y.Event.purgeElement'. Can also be used to create and object by using a 'function name' like 'new user_selector'.
array	$arguments	and array of arguments to be passed to the function. When generating the function call, this will be escaped using json_encode, so passing objects and arrays should work.
bool	$ondomready	If tru the function is only called when the dom is ready for manipulation.
int	$delay	The delay before the function is called.

◆ js_init_call()

page_requirements_manager::js_init_call	(		$function,
		array	$extraarguments = `null`,
			$ondomready = `false`,
		array	$module = `null`
	)

Ensure that the specified JavaScript function is called from an inline script from page footer.

Parameters

string	$function	the name of the JavaScritp function to with init code, usually something like 'M.mod_mymodule.init'
array	$extraarguments	and array of arguments to be passed to the function. The first argument is always the YUI3 Y instance with all required dependencies already loaded.
bool	$ondomready	wait for dom ready (helps with some IE problems when modifying DOM)
array	$module	JS module specification array

◆ js_init_code()

page_requirements_manager::js_init_code	(		$jscode,
			$ondomready = `false`,
		array	$module = `null`
	)

Add short static javascript code fragment to page footer.

This is intended primarily for loading of js modules and initialising page layout. Ideally the JS code fragment should be stored in plugin renderer so that themes may override it.

Parameters

string	$jscode
bool	$ondomready	wait for dom ready (helps with some IE problems when modifying DOM)
array	$module	JS module specification array

◆ js_module()

page_requirements_manager::js_module ( $module )

Append YUI3 module to default YUI3 JS loader.

The structure of module array is described at http://developer.yahoo.com/yui/3/yui/

Parameters

string | array $module name of module (details are autodetected), or full module specification as array

Return values

void

◆ js_module_loaded()

page_requirements_manager::js_module_loaded ( $module )

protected

Returns true if the module has already been loaded.

Parameters

string | array $module

Return values

bool	True if the module has already been loaded

◆ set_one_time_item_created()

page_requirements_manager::set_one_time_item_created ( $thing )

Indicate that a particular bit of HTML that is only required once on this page (e.g.

the contents of the modchooser) has been generated (or is about to be)?

Normally, you can use the should_create_one_time_item_now() helper method rather than calling this method directly.

Parameters

string $thing identifier for the bit of content. Should be of the form frankenstyle_things, e.g. core_course_modchooser.

◆ set_yuicssmodules()

page_requirements_manager::set_yuicssmodules ( array $modules = array() )

Set the CSS Modules to be included from YUI.

Parameters

array $modules The list of YUI CSS Modules to include.

◆ should_create_one_time_item_now()

page_requirements_manager::should_create_one_time_item_now ( $thing )

Should we generate a bit of content HTML that is only required once on this page (e.g.

the contents of the modchooser), now? Basically, we call has_one_time_item_been_created(), and if the thing has not already been output, we return true to tell the caller to generate it, and also call set_one_time_item_created() to record the fact that it is about to be generated.

That is, a typical usage pattern (in a renderer method) is:

if (!$this->page->requires->should_create_one_time_item_now($thing)) {
    return '';
}
// Else generate it.

Parameters

string $thing identifier for the bit of content. Should be of the form frankenstyle_things, e.g. core_course_modchooser.

Return values

bool	if true, the caller should generate that bit of output now, otherwise don't.

◆ skip_link_to()

page_requirements_manager::skip_link_to	(	$target,
		$linktext
	)

Ensure that a skip link to a given target is printed at the top of the <body>.

You must call this function before get_top_of_body_code(), (if not, an exception will be thrown). That normally means you must call this before the call to print_header.

If you ask for a particular skip link to be printed, it is then your responsibility to ensure that the appropriate tag is printed in the body of the page, so that the skip link goes somewhere.

Even if a particular skip link is requested more than once, only one copy of it will be output.

Parameters

string	$target	the name of anchor this link should go to. For example 'maincontent'.
string	$linktext	The text to use for the skip link. Normally get_string('skipto', 'access', ...);

◆ string_for_js()

page_requirements_manager::string_for_js	(	$identifier,
		$component,
		$a = `null`
	)

Make a language string available to JavaScript.

All the strings will be available in a M.str object in the global namespace. So, for example, after a call to $PAGE->requires->string_for_js('course', 'moodle'); then the JavaScript variable M.str.moodle.course will be 'Course', or the equivalent in the current language.

The arguments to this function are just like the arguments to get_string except that $component is not optional, and there are some aspects to consider when the string contains {$a} placeholder.

If the string does not contain any {$a} placeholder, you can simply use M.str.component.identifier to obtain it. If you prefer, you can call M.util.get_string(identifier, component) to get the same result.

If you need to use {$a} placeholders, there are two options. Either the placeholder should be substituted in PHP on server side or it should be substituted in Javascript at client side.

To substitute the placeholder at server side, just provide the required value for the placeholder when you require the string. Because each string is only stored once in the JavaScript (based on $identifier and $module) you cannot get the same string with two different values of $a. If you try, an exception will be thrown. Once the placeholder is substituted, you can use M.str or M.util.get_string() as shown above:

// Require the string in PHP and replace the placeholder.
$PAGE->requires->string_for_js('fullnamedisplay', 'moodle', $USER);
// Use the result of the substitution in Javascript.
alert(M.str.moodle.fullnamedisplay);

To substitute the placeholder at client side, use M.util.get_string() function. It implements the same logic as get_string():

// Require the string in PHP but keep {$a} as it is.
$PAGE->requires->string_for_js('fullnamedisplay', 'moodle');
// Provide the values on the fly in Javascript.
user = { firstname : 'Harry', lastname : 'Potter' }
alert(M.util.get_string('fullnamedisplay', 'moodle', user);

If you do need the same string expanded with different $a values in PHP on server side, then the solution is to put them in your own data structure (e.g. and array) that you pass to JavaScript with data_for_js().

Parameters

string	$identifier	the desired string.
string	$component	the language file to look in.
mixed	$a	any extra data to add into the string (optional).

◆ strings_for_js()

page_requirements_manager::strings_for_js	(	$identifiers,
		$component,
		$a = `null`
	)

Make an array of language strings available for JS.

This function calls the above function string_for_js() for each requested string in the $identifiers array that is passed to the argument for a single module passed in $module.

$PAGE->requires->strings_for_js(array('one', 'two', 'three'), 'mymod', array('a', null, 3));

// The above is identical to calling:

$PAGE->requires->string_for_js('one', 'mymod', 'a'); $PAGE->requires->string_for_js('two', 'mymod'); $PAGE->requires->string_for_js('three', 'mymod', 3);

Parameters

array	$identifiers	An array of desired strings
string	$component	The module to load for
mixed	$a	This can either be a single variable that gets passed as extra information for every string or it can be an array of mixed data where the key for the data matches that of the identifier it is meant for.

◆ yui_module()

page_requirements_manager::yui_module	(		$modules,
			$function,
		array	$arguments = `null`,
			$galleryversion = `null`,
			$ondomready = `false`
	)

Creates a JavaScript function call that requires one or more modules to be loaded.

This function can be used to include all of the standard YUI module types within JavaScript:

YUI3 modules [node, event, io]
YUI2 modules [yui2-*]
Moodle modules [moodle-*]
Gallery modules [gallery-*]

Before writing new code that makes extensive use of YUI, you should consider it's replacement AMD/JQuery.

See also: js_call_amd()

Parameters

array \| string	$modules	One or more modules
string	$function	The function to call once modules have been loaded
array	$arguments	An array of arguments to pass to the function
string	$galleryversion	Deprecated: The gallery version to use
bool	$ondomready

Member Data Documentation

◆ $onetimeitemsoutput

array page_requirements_manager::$onetimeitemsoutput = array()

protected

trackes the names of bits of HTML that are only required once per page.

See }, * set_one_time_item_created()} and should_create_one_time_item_now().

The documentation for this class was generated from the following file:

lib/outputrequirementslib.php

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ css()

◆ css_theme()

◆ data_for_js()

◆ event_handler()

◆ find_module()

◆ get_amd_footercode()

◆ get_config_for_javascript()

◆ get_css_code()

◆ get_end_code()

◆ get_event_handler_code()

◆ get_extra_modules_code()

◆ get_head_code()

◆ get_javascript_code()

◆ get_javascript_init_code()

◆ get_jquery_headcode()

◆ get_jsrev()

◆ get_templaterev()

◆ get_top_of_body_code()

◆ get_yui3lib_headcode()

◆ get_yui3lib_headcss()

◆ has_one_time_item_been_created()

◆ init_requirements_data()

◆ is_head_done()

◆ is_top_of_body_done()

◆ jquery()

◆ jquery_override_plugin()

◆ jquery_plugin()

◆ js()

◆ js_amd_inline()

◆ js_call_amd()

◆ js_fix_url()

◆ js_function_call()

◆ js_init_call()

◆ js_init_code()

◆ js_module()

◆ js_module_loaded()

◆ set_one_time_item_created()

◆ set_yuicssmodules()

◆ should_create_one_time_item_now()

◆ skip_link_to()

◆ string_for_js()

◆ strings_for_js()

◆ yui_module()

Member Data Documentation

◆ $onetimeitemsoutput