MediaWiki
master
ResourceLoaderUserModule.php
Go to the documentation of this file.
1
<?php
23
use
MediaWiki\MainConfigNames
;
24
use
MediaWiki\MediaWikiServices
;
25
32
class
ResourceLoaderUserModule
extends
ResourceLoaderWikiModule
{
33
protected
$origin
= self::ORIGIN_USER_INDIVIDUAL;
34
protected
$targets
= [
'desktop'
,
'mobile'
];
35
40
protected
function
getPages
(
ResourceLoaderContext
$context ) {
41
$user = $context->
getUserIdentity
();
42
if
( !$user || !$user->isRegistered() ) {
43
return
[];
44
}
45
46
$config
= $this->
getConfig
();
47
$pages = [];
48
49
if
(
$config
->
get
( MainConfigNames::AllowUserJs ) ) {
50
$titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
51
// Use localised/normalised variant to ensure $excludepage matches
52
$userPage = $titleFormatter->getPrefixedDBkey(
new
TitleValue
(
NS_USER
, $user->getName() ) );
53
$pages[
"$userPage/common.js"
] = [
'type'
=>
'script'
];
54
$pages[
"$userPage/"
. $context->
getSkin
() .
'.js'
] = [
'type'
=>
'script'
];
55
}
56
57
// User group pages are maintained site-wide and enabled with site JS/CSS.
58
if
(
$config
->
get
( MainConfigNames::UseSiteJs ) ) {
59
$userGroupManager = MediaWikiServices::getInstance()->getUserGroupManager();
60
foreach
( $userGroupManager->getUserEffectiveGroups( $user ) as
$group
) {
61
if
(
$group
==
'*'
) {
62
continue
;
63
}
64
$pages[
"MediaWiki:Group-$group.js"
] = [
'type'
=>
'script'
];
65
}
66
}
67
68
// This is obsolete since 1.32 (T112474). It was formerly used by
69
// OutputPage to implement previewing of user CSS and JS.
70
// @todo: Remove it once we're sure nothing else is using the parameter
71
$excludepage = $context->
getRequest
()->getVal(
'excludepage'
);
72
unset( $pages[$excludepage] );
73
74
return
$pages;
75
}
76
82
public
function
getGroup
() {
83
return
self::GROUP_USER;
84
}
85
}
NS_USER
const NS_USER
Definition:
Defines.php:66
MediaWiki\MainConfigNames
A class containing constants representing the names of configuration variables.
Definition:
MainConfigNames.php:23
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition:
MediaWikiServices.php:213
ResourceLoaderContext
Context object that contains information about the state of a specific ResourceLoader web request.
Definition:
ResourceLoaderContext.php:37
ResourceLoaderContext\getRequest
getRequest()
Definition:
ResourceLoaderContext.php:186
ResourceLoaderContext\getSkin
getSkin()
Definition:
ResourceLoaderContext.php:237
ResourceLoaderContext\getUserIdentity
getUserIdentity()
Get the possibly-cached UserIdentity object for the specified username.
Definition:
ResourceLoaderContext.php:277
ResourceLoaderModule\getConfig
getConfig()
Definition:
ResourceLoaderModule.php:247
ResourceLoaderModule\$config
Config $config
Definition:
ResourceLoaderModule.php:43
ResourceLoaderUserModule
Module for user customizations scripts.
Definition:
ResourceLoaderUserModule.php:32
ResourceLoaderUserModule\getGroup
getGroup()
Get group name.
Definition:
ResourceLoaderUserModule.php:82
ResourceLoaderUserModule\$targets
$targets
Definition:
ResourceLoaderUserModule.php:34
ResourceLoaderUserModule\$origin
$origin
Definition:
ResourceLoaderUserModule.php:33
ResourceLoaderUserModule\getPages
getPages(ResourceLoaderContext $context)
Definition:
ResourceLoaderUserModule.php:40
ResourceLoaderWikiModule
Abstraction for ResourceLoader modules which pull from wiki pages.
Definition:
ResourceLoaderWikiModule.php:57
ResourceLoaderWikiModule\$group
string null $group
Group of module.
Definition:
ResourceLoaderWikiModule.php:89
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition:
TitleValue.php:40
Config\get
get( $name)
Get a configuration variable such as "Sitename" or "UploadMaintenance.".
includes
resourceloader
ResourceLoaderUserModule.php
Generated on Sat May 21 2022 21:08:40 for MediaWiki by
1.9.1