Bootstrap a ResourceLoader client on an HTML page. More...

Collaboration diagram for ResourceLoaderClientHtml:

[legend]

Public Member Functions
	__construct (ResourceLoaderContext $context, array $options=[])

	getBodyHtml ()

	getDocumentAttributes ()

	getHeadHtml ()
	The order of elements in the head is as follows:

	setConfig (array $vars)
	Set mw.config variables.

	setExemptStates (array $states)
	Set state of special modules that are handled by the caller manually.

	setModules (array $modules)
	Ensure one or more modules are loaded.

	setModuleScripts (array $modules)
	Ensure the scripts of one or more modules are loaded.

	setModuleStyles (array $modules)
	Ensure the styles of one or more modules are loaded.

Static Public Member Functions
static	makeLoad (ResourceLoaderContext $mainContext, array $modules, $only, array $extraQuery=[], $nonce=null)
	Explicily load or embed modules on a page.

Private Member Functions
	getContext ( $group, $type)

	getData ()

	getLoad ( $modules, $only, $nonce, array $extraQuery=[])

Static Private Member Functions
static	makeContext (ResourceLoaderContext $mainContext, $group, $type, array $extraQuery=[])

Private Attributes
array	$config = []

ResourceLoaderContext	$context

array	$data

array	$exemptStates = []

array	$modules = []

array	$moduleScripts = []

array	$moduleStyles = []

array	$options

ResourceLoader	$resourceLoader

Detailed Description

Bootstrap a ResourceLoader client on an HTML page.

Since: 1.28

Definition at line 29 of file ResourceLoaderClientHtml.php.

Constructor & Destructor Documentation

◆ __construct()

ResourceLoaderClientHtml::__construct	(	ResourceLoaderContext	$context,
		array	$options = [] )

Parameters

ResourceLoaderContext	$context
array	$options	[optional] Array of options 'target': Parameter for modules=startup request, see ResourceLoaderStartUpModule. 'safemode': Parameter for modules=startup request, see ResourceLoaderStartUpModule. 'nonce': From OutputPage::getCSPNonce().

Definition at line 65 of file ResourceLoaderClientHtml.php.

References $context, ResourceLoaderContext\getResourceLoader(), and options().

Member Function Documentation

◆ getBodyHtml()

ResourceLoaderClientHtml::getBodyHtml ( )

Returns: string|WrappedStringList HTML

Definition at line 363 of file ResourceLoaderClientHtml.php.

References $data, getData(), ResourceLoader\makeInlineScript(), and options().

◆ getContext()

ResourceLoaderClientHtml::getContext	(		$group,
			$type )

private

Definition at line 378 of file ResourceLoaderClientHtml.php.

References $type, and makeContext().

◆ getData()

ResourceLoaderClientHtml::getData ( )

private

Returns: array

Definition at line 128 of file ResourceLoaderClientHtml.php.

References $context, $data, $name, $resourceLoader, getContext(), ResourceLoader\getModule(), ResourceLoaderModule\LOAD_STYLES, ResourceLoaderModule\TYPE_COMBINED, ResourceLoaderModule\TYPE_SCRIPTS, and ResourceLoaderModule\TYPE_STYLES.

Referenced by getBodyHtml(), and getHeadHtml().

◆ getDocumentAttributes()

ResourceLoaderClientHtml::getDocumentAttributes ( )

Returns: array Attribute key-value pairs for the HTML document element

Definition at line 246 of file ResourceLoaderClientHtml.php.

◆ getHeadHtml()

ResourceLoaderClientHtml::getHeadHtml ( )

The order of elements in the head is as follows:

Inline scripts.
Stylesheets.
Async external script-src.

Reasons:

Script execution may be blocked on preceeding stylesheets.
Async scripts are not blocked on stylesheets.
Inline scripts can't be asynchronous.
For styles, earlier is better.

Returns: string|WrappedStringList HTML

Definition at line 264 of file ResourceLoaderClientHtml.php.

References $data, ResourceLoader\encodeJsonForScript(), getData(), getLoad(), ResourceLoader\makeConfigSetScript(), ResourceLoader\makeInlineScript(), ResourceLoader\makeLoaderStateScript(), options(), string, ResourceLoaderModule\TYPE_COMBINED, ResourceLoaderModule\TYPE_SCRIPTS, and ResourceLoaderModule\TYPE_STYLES.

◆ getLoad()

ResourceLoaderClientHtml::getLoad	(		$modules,
			$only,
			$nonce,
		array	$extraQuery = [] )

private

Definition at line 382 of file ResourceLoaderClientHtml.php.

References $modules, array(), and makeLoad().

Referenced by getHeadHtml().

◆ makeContext()

static ResourceLoaderClientHtml::makeContext	(	ResourceLoaderContext	$mainContext,
			$group,
			$type,
		array	$extraQuery = [] )

staticprivate

Definition at line 386 of file ResourceLoaderClientHtml.php.

References $context, $req, $ret, $type, and ResourceLoaderModule\TYPE_COMBINED.

Referenced by getContext(), and makeLoad().

◆ makeLoad()

static ResourceLoaderClientHtml::makeLoad	(	ResourceLoaderContext	$mainContext,
		array	$modules,
			$only,
		array	$extraQuery = [],
			$nonce = null )

static

Explicily load or embed modules on a page.

Parameters

ResourceLoaderContext	$mainContext
array	$modules	One or more module names
string	$only	ResourceLoaderModule TYPE_ class constant
array	$extraQuery	[optional] Array with extra query parameters for the request
string \| null	$nonce	[optional] Content-Security-Policy nonce (from OutputPage::getCSPNonce)