MediaWiki  1.29.2
ResourceLoaderUserModule.php
Go to the documentation of this file.
1 <?php
27 
29  protected $targets = [ 'desktop', 'mobile' ];
30 
35  protected function getPages( ResourceLoaderContext $context ) {
36  $config = $this->getConfig();
37  $user = $context->getUserObj();
38  if ( $user->isAnon() ) {
39  return [];
40  }
41 
42  // Use localised/normalised variant to ensure $excludepage matches
43  $userPage = $user->getUserPage()->getPrefixedDBkey();
44  $pages = [];
45 
46  if ( $config->get( 'AllowUserJs' ) ) {
47  $pages["$userPage/common.js"] = [ 'type' => 'script' ];
48  $pages["$userPage/" . $context->getSkin() . '.js'] = [ 'type' => 'script' ];
49  }
50 
51  // User group pages are maintained site-wide and enabled with site JS/CSS.
52  if ( $config->get( 'UseSiteJs' ) ) {
53  foreach ( $user->getEffectiveGroups() as $group ) {
54  if ( $group == '*' ) {
55  continue;
56  }
57  $pages["MediaWiki:Group-$group.js"] = [ 'type' => 'script' ];
58  }
59  }
60 
61  // Hack for T28283: Allow excluding pages for preview on a CSS/JS page.
62  // The excludepage parameter is set by OutputPage.
63  $excludepage = $context->getRequest()->getVal( 'excludepage' );
64  if ( isset( $pages[$excludepage] ) ) {
65  unset( $pages[$excludepage] );
66  }
67 
68  return $pages;
69  }
70 
76  public function getGroup() {
77  return 'user';
78  }
79 
83  public function getDependencies( ResourceLoaderContext $context = null ) {
84  return [ 'user.styles' ];
85  }
86 }
ResourceLoaderContext
Object passed around to modules which contains information about the state of a specific loader reque...
Definition: ResourceLoaderContext.php:32
$context
error also a ContextSource you ll probably need to make sure the header is varied on and they can depend only on the ResourceLoaderContext $context
Definition: hooks.txt:2612
ResourceLoaderWikiModule
Abstraction for ResourceLoader modules which pull from wiki pages.
Definition: ResourceLoaderWikiModule.php:48
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:246
ContextSource\getRequest
getRequest()
Get the WebRequest object.
Definition: ContextSource.php:78
php
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
Definition: injection.txt:35
ResourceLoaderUserModule\$targets
$targets
Definition: ResourceLoaderUserModule.php:29
Config\get
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
ContextSource\getSkin
getSkin()
Get the Skin object.
Definition: ContextSource.php:153
ResourceLoaderUserModule\getDependencies
getDependencies(ResourceLoaderContext $context=null)
Definition: ResourceLoaderUserModule.php:83
ResourceLoaderModule\ORIGIN_USER_INDIVIDUAL
const ORIGIN_USER_INDIVIDUAL
Definition: ResourceLoaderModule.php:57
ResourceLoaderUserModule\getGroup
getGroup()
Get group name.
Definition: ResourceLoaderUserModule.php:76
ResourceLoaderUserModule\getPages
getPages(ResourceLoaderContext $context)
Definition: ResourceLoaderUserModule.php:35
ResourceLoaderUserModule\$origin
$origin
Definition: ResourceLoaderUserModule.php:28
ResourceLoaderWikiModule\$group
$group
Definition: ResourceLoaderWikiModule.php:63
ResourceLoaderModule\$config
Config $config
Definition: ResourceLoaderModule.php:85
ResourceLoaderUserModule
Module for user customizations scripts.
Definition: ResourceLoaderUserModule.php:26
as
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
Definition: distributors.txt:9
ResourceLoaderContext\getUserObj
getUserObj()
Get the possibly-cached User object for the specified username.
Definition: ResourceLoaderContext.php:243
ResourceLoaderModule\getConfig
getConfig()
Definition: ResourceLoaderModule.php:188