Go to the documentation of this file.
21 use Wikimedia\WrappedStringList;
74 foreach ( $vars
as $key =>
$value ) {
75 $this->config[$key] =
$value;
116 $this->exemptStates = $states;
145 foreach ( $this->modules
as $name ) {
146 $module = $rl->getModule(
$name );
152 if ( $module->isKnownEmpty(
$context ) ) {
158 if ( $module->shouldEmbedModule( $this->context ) ) {
169 foreach ( $this->moduleStyles
as $name ) {
170 $module = $rl->getModule(
$name );
176 $logger = $rl->getLogger();
177 $logger->error(
'Unexpected general module "{module}" in styles queue.', [
188 $group = $module->getGroup();
191 if ( !$module->isKnownEmpty(
$context ) ) {
192 if ( $module->shouldEmbedModule( $this->context ) ) {
202 foreach ( $this->moduleScripts
as $name ) {
203 $module = $rl->getModule(
$name );
208 $group = $module->getGroup();
210 if ( $module->isKnownEmpty(
$context ) ) {
229 return [
'class' =>
'client-nojs' ];
254 'document.documentElement.className = document.documentElement.className'
255 .
'.replace( /(^|\s)client-nojs(\s|$)/, "$1client-js$2" );'
259 if ( $this->config ) {
266 $states = array_merge( $this->exemptStates,
$data[
'states'] );
274 if (
$data[
'embed'][
'general'] ) {
276 $data[
'embed'][
'general'],
282 if (
$data[
'general'] ) {
289 if (
$data[
'scripts'] ) {
297 if (
$data[
'styles'] ) {
305 if (
$data[
'embed'][
'styles'] ) {
307 $data[
'embed'][
'styles'],
314 $startupQuery = isset( $this->
options[
'target'] )
323 return WrappedStringList::join(
"\n", $chunks );
342 array $extraQuery = []
349 if ( $group !==
'user' && $group !==
'private' ) {
350 $req->setVal(
'user',
null );
367 array $extraQuery = []
381 return new WrappedStringList(
"\n", $chunks );
387 $module = $rl->getModule(
$name );
389 $rl->getLogger()->warning(
'Unknown module "{module}"', [
'module' =>
$name ] );
392 $sortedModules[$module->getSource()][$module->getGroup()][
$name] = $module;
395 foreach ( $sortedModules
as $source => $groups ) {
396 foreach ( $groups
as $group => $grpModules ) {
402 foreach ( $grpModules
as $name => $module ) {
403 $shouldEmbed = $module->shouldEmbedModule(
$context );
404 if ( !$moduleSets || $moduleSets[$idx][0] !== $shouldEmbed ) {
405 $moduleSets[++$idx] = [ $shouldEmbed, [] ];
407 $moduleSets[$idx][1][
$name] = $module;
411 foreach ( $moduleSets
as list( $embed, $moduleSet ) ) {
412 $context->setModules( array_keys( $moduleSet ) );
417 $rl->makeModuleResponse(
$context, $moduleSet )
421 $rl->makeModuleResponse(
$context, $moduleSet )
427 foreach ( $moduleSet
as $key => $module ) {
428 $isRaw |= $module->isRaw();
436 if ( $group ===
'user' ) {
450 'async' => !isset( $extraQuery[
'sync'] ),
460 if ( $group ==
'noscript' ) {
470 return new WrappedStringList(
"\n", $chunks );
Object passed around to modules which contains information about the state of a specific loader reque...
WebRequest clone which takes values from a provided array.
Bootstrap a ResourceLoader client on an HTML page.
static makeConfigSetScript(array $configuration)
Returns JS code which will set the MediaWiki configuration array to the given value.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
the array() calling protocol came about after MediaWiki 1.4rc1.
static makeContext(ResourceLoaderContext $mainContext, $group, $type, array $extraQuery=[])
getContext( $group, $type)
This code would result in ircNotify being run twice when an article is and once for brion Hooks can return three possible true was required This is the default since MediaWiki *some string
setModuleScripts(array $modules)
Ensure the scripts of one or more modules are loaded.
setExemptStates(array $states)
Set state of special modules that are handled by the caller manually.
static inlineScript( $contents)
Output a "<script>" tag with the given contents.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
ResourceLoaderContext $context
ResourceLoader $resourceLoader
setConfig(array $vars)
Set mw.config variables.
static encodeJsCall( $name, $args, $pretty=false)
Create a call to a JavaScript function.
static makeLoaderStateScript( $name, $state=null)
Returns a JS call to mw.loader.state, which sets the state of a module or modules to a given value.
getLoad( $modules, $only, array $extraQuery=[])
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
static inlineStyle( $contents, $media='all', $attribs=[])
Output a "<style>" tag with the given contents for the given media type (if any).
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
Allows changing specific properties of a context object, without changing the main one.
this hook is for auditing only $req
static makeLoad(ResourceLoaderContext $mainContext, array $modules, $only, array $extraQuery=[])
Explicily load or embed modules on a page.
Allows to change the fields on the form that will be generated $name
Dynamic JavaScript and CSS resource loading system.
setModules(array $modules)
Ensure one or more modules are loaded.
static linkedStyle( $url, $media='all')
Output a "<link rel=stylesheet>" linking to the given URL for the given media type (if any).
setModuleStyles(array $modules)
Ensure the styles of one or more modules are loaded.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
static rawElement( $element, $attribs=[], $contents='')
Returns an HTML element in a string.
static configuration should be added through ResourceLoaderGetConfigVars instead & $vars
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
__construct(ResourceLoaderContext $context, array $options=[])
static makeInlineScript( $script)
Returns an HTML script tag that runs given JS code after startup and base modules.
and how to run hooks for an and one after Each event has a preferably in CamelCase For ArticleDelete hook A clump of code and data that should be run when an event happens This can be either a function and a chunk of data
getHeadHtml()
The order of elements in the head is as follows: