[ Index ]

PHP Cross Reference of MediaWiki-1.24.0

title

Body

[close]

/includes/resourceloader/ -> ResourceLoaderStartUpModule.php (summary)

(no description)

File Size: 479 lines (16 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

ResourceLoaderStartUpModule:: (12 methods):
  getConfigSettings()
  getImplicitDependencies()
  compileUnresolvedDependencies()
  getModuleRegistrations()
  isRaw()
  getStartupModules()
  getStartupModulesUrl()
  getScript()
  supportsURLLoading()
  getModifiedTime()
  getModifiedHash()
  getGroup()


Class: ResourceLoaderStartUpModule  - X-Ref

Module for resource loader initialization.

This program 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 2 of the License, or
(at your option) any later version.

This program 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 this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
http://www.gnu.org/copyleft/gpl.html

getConfigSettings( $context )   X-Ref

param: ResourceLoaderContext $context
return: array

getImplicitDependencies( array $registryData, $moduleName )   X-Ref
Recursively get all explicit and implicit dependencies for to the given module.

param: array $registryData
param: string $moduleName
return: array

compileUnresolvedDependencies( array &$registryData )   X-Ref
Optimize the dependency tree in $this->modules and return it.

The optimization basically works like this:
Given we have module A with the dependencies B and C
and module B with the dependency C.
Now we don't have to tell the client to explicitly fetch module
C as that's already included in module B.

This way we can reasonably reduce the amout of module registration
data send to the client.

param: array &$registryData Modules keyed by name with properties:

getModuleRegistrations( ResourceLoaderContext $context )   X-Ref
Get registration code for all modules.

param: ResourceLoaderContext $context
return: string JavaScript code for registering all modules with the client loader

isRaw()   X-Ref

return: bool

getStartupModules()   X-Ref
Base modules required for the the base environment of ResourceLoader

return: array

getStartupModulesUrl( ResourceLoaderContext $context )   X-Ref
Get the load URL of the startup modules.

This is a helper for getScript(), but can also be called standalone, such
as when generating an AppCache manifest.

param: ResourceLoaderContext $context
return: string

getScript( ResourceLoaderContext $context )   X-Ref

param: ResourceLoaderContext $context
return: string

supportsURLLoading()   X-Ref

return: bool

getModifiedTime( ResourceLoaderContext $context )   X-Ref

param: ResourceLoaderContext $context
return: array|mixed

getModifiedHash( ResourceLoaderContext $context )   X-Ref
Hash of all dynamic data embedded in getScript().

Detect changes to mw.config settings embedded in #getScript (bug 28899).

param: ResourceLoaderContext $context
return: string Hash

getGroup()   X-Ref

return: string



Generated: Fri Nov 28 14:03:12 2014 Cross-referenced by PHPXref 0.7.1