| [ Index ] |
PHP Cross Reference of MediaWiki-1.24.0 |
[Source view] [Print] [Project Stats]
Gadgets extension - lets users select custom javascript gadgets For more info see http://mediawiki.org/wiki/Extension:Gadgets
| Author: | Daniel Kinzler, brightbyte.de |
| Copyright: | © 2007 Daniel Kinzler |
| License: | GNU General Public Licence 2.0 or later |
| File Size: | 472 lines (12 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Gadget:: (25 methods):
newFromDefinition()
getName()
getDescription()
getRawDescription()
getCategory()
getModuleName()
isEnabled()
isAllowed()
isOnByDefault()
supportsResourceLoader()
hasModule()
getDefinition()
getScripts()
getStyles()
getScriptsAndStyles()
getModule()
getLegacyScripts()
getDependencies()
getRequiredRights()
getRequiredSkins()
getPosition()
loadList()
isValidList()
loadStructuredList()
listFromDefinition()
GadgetResourceLoaderModule:: (4 methods):
__construct()
getPages()
getDependencies()
getPosition()
| newFromDefinition( $definition ) X-Ref |
| Creates an instance of this class from definition in MediaWiki:Gadgets-definition param: $definition String: Gadget definition return: Gadget|bool Instance of Gadget class or false if $definition is invalid |
| getName() X-Ref |
return: String: Gadget name |
| getDescription() X-Ref |
return: String: Gadget description parsed into HTML |
| getRawDescription() X-Ref |
return: String: Wikitext of gadget description |
| getCategory() X-Ref |
return: String: Name of category (aka section) our gadget belongs to. Empty string if none. |
| getModuleName() X-Ref |
return: String: Name of ResourceLoader module for this gadget |
| isEnabled( $user ) X-Ref |
| Checks whether this gadget is enabled for given user param: $user User: user to check against return: Boolean |
| isAllowed( $user ) X-Ref |
| Checks whether given user has permissions to use this gadget param: $user User: user to check against return: Boolean |
| isOnByDefault() X-Ref |
return: Boolean: Whether this gadget is on by default for everyone (but can be disabled in preferences) |
| supportsResourceLoader() X-Ref |
return: Boolean: Whether all of this gadget's JS components support ResourceLoader |
| hasModule() X-Ref |
return: Boolean: Whether this gadget has resources that can be loaded via ResourceLoader |
| getDefinition() X-Ref |
return: String: Definition for this gadget from MediaWiki:gadgets-definition |
| getScripts() X-Ref |
return: Array: Array of pages with JS not prefixed with namespace |
| getStyles() X-Ref |
return: Array: Array of pages with CSS not prefixed with namespace |
| getScriptsAndStyles() X-Ref |
return: Array: Array of all of this gadget's resources |
| getModule() X-Ref |
| Returns module for ResourceLoader, see getModuleName() for its name. If our gadget has no scripts or styles suitable for RL, false will be returned. return: Mixed: GadgetResourceLoaderModule or false |
| getLegacyScripts() X-Ref |
| Returns list of scripts that don't support ResourceLoader return: Array |
| getDependencies() X-Ref |
| Returns names of resources this gadget depends on return: Array |
| getRequiredRights() X-Ref |
| Returns array of permissions required by this gadget return: Array |
| getRequiredSkins() X-Ref |
| Returns array of skins where this gadget works return: Array |
| getPosition() X-Ref |
| Returns the position of this Gadget's ResourceLoader module return: String: 'bottom' or 'top' |
| loadList() X-Ref |
| Loads and returns a list of all gadgets return: Mixed: Array of gadgets or false |
| isValidList( $gadgets ) X-Ref |
| Checks whether gadget list from cache can be used. param: $gadgets array return: Boolean |
| loadStructuredList( $forceNewText = null ) X-Ref |
| Loads list of gadgets and returns it as associative array of sections with gadgets e.g. array( 'sectionnname1' => array( $gadget1, $gadget2 ), 'sectionnname2' => array( $gadget3 ) ); param: $forceNewText String: New text of MediaWiki:gadgets-definition. If specified, will return: Mixed: Array or false |
| listFromDefinition( $definition ) X-Ref |
| Generates a structured list of Gadget objects from a definition param: $definition return: array Array( category => Array( name => Gadget ) ) |
Class: GadgetResourceLoaderModule - X-Ref
Class representing a list of resources for one gadget| __construct( $pages, $dependencies, $targets, $position ) X-Ref |
| Creates an instance of this class param: $pages Array: Associative array of pages in ResourceLoaderWikiModule-compatible param: $dependencies Array: Names of resources this module depends on param: $targets Array: List of targets this module support param: $position String: 'bottom' or 'top' |
| getPages( ResourceLoaderContext $context ) X-Ref |
| Overrides the abstract function from ResourceLoaderWikiModule class param: $context ResourceLoaderContext return: Array: $pages passed to __construct() |
| getDependencies() X-Ref |
| Overrides ResourceLoaderModule::getDependencies() return: Array: Names of resources this module depends on |
| getPosition() X-Ref |
| Overrides ResourceLoaderModule::getPosition() return: String: 'bottom' or 'top' |
| Generated: Fri Nov 28 14:03:12 2014 | Cross-referenced by PHPXref 0.7.1 |