wiki.techinc.nl/includes/ResourceLoader/UserStylesModule.php
Umherirrender 441017cb54 ResourceLoader: Add missing documentation to class properties
Add doc-typehints to class properties found by the PropertyDocumentation
sniff to improve the documentation.

Once the sniff is enabled it avoids that new code is missing type
declarations. This is focused on documentation and does not change code.

Change-Id: I90ecf85cb6f639af4be1947ccfbfb16d5b84cab3
2024-09-07 21:25:51 +02:00

92 lines
2.6 KiB
PHP

<?php
/**
* 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
*
* @file
* @author Trevor Parscal
* @author Roan Kattouw
*/
namespace MediaWiki\ResourceLoader;
use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\TitleValue;
/**
* Module for user customizations styles.
*
* @ingroup ResourceLoader
* @internal
*/
class UserStylesModule extends WikiModule {
/** @inheritDoc */
protected $origin = self::ORIGIN_USER_INDIVIDUAL;
/**
* @param Context $context
* @return array[]
*/
protected function getPages( Context $context ) {
$user = $context->getUserIdentity();
$tempUserConfig = MediaWikiServices::getInstance()->getTempUserConfig();
if ( !$user || !$user->isRegistered() || $tempUserConfig->isTempName( $user->getName() ) ) {
return [];
}
$config = $this->getConfig();
$pages = [];
if ( $config->get( MainConfigNames::AllowUserCss ) ) {
$titleFormatter = MediaWikiServices::getInstance()->getTitleFormatter();
// Use localised/normalised variant to ensure $excludepage matches
$userPage = $titleFormatter->getPrefixedDBkey( new TitleValue( NS_USER, $user->getName() ) );
$pages["$userPage/common.css"] = [ 'type' => 'style' ];
$pages["$userPage/" . $context->getSkin() . '.css'] = [ 'type' => 'style' ];
}
// User group pages are maintained site-wide and enabled with site JS/CSS.
if ( $config->get( MainConfigNames::UseSiteCss ) ) {
$effectiveGroups = MediaWikiServices::getInstance()->getUserGroupManager()
->getUserEffectiveGroups( $user );
foreach ( $effectiveGroups as $group ) {
if ( $group == '*' ) {
continue;
}
$pages["MediaWiki:Group-$group.css"] = [ 'type' => 'style' ];
}
}
return $pages;
}
/**
* @return string
*/
public function getType() {
return self::LOAD_STYLES;
}
/**
* Get group name
*
* @return string
*/
public function getGroup() {
return self::GROUP_USER;
}
}