5d8f62bdd3
This data is the same as the 'credits' data that is already compiled, cached and made available via ExtensionRegistry. Similar to various other configuration variables previously, the $wgExtensionCredits variable is now also required to only be used for providing input to the system (e.g. from LocalSettings.php, or from legacy extension PHP entry points). It is no longer supported to use this variable to reliably read out a full view of all extension credits (specifically those registered via extension.json). Doing so had the downside of adding processing cost to every web request, as well as taking one the single largest portion of the ExtensionRegistry APCu cache key, which in PHP7+ incurs a linear cost for every string value, string key, of every (sub)array in this huge structure; and does to on every request just in case something reads from $wgExtensionCredits. The new method to access this information reliably is owned by SpecialVersion for now (could be moved elsewhere). This also makes the merging logic more testable and incurs it on-demand rather than upfront. Details: * Move 'type' internally from NOT_ATTRIBS to CREDIT_ATTRIBS. These two arrays behave identically for most purposes (they are both used to mean "don't export this as a global attribute"). By placing it in CREDIT_ATTRIBS it becomes complete and makes it easy to refer to in docs. Previously, extractCredits() read the 'type' key outside the loop for CREDIT_ATTRIBS. * Remove redundant code in ApiBase.php, that is now more obviously redundant. Looks like a left-over or merge conflict mistake from when ExtensionRegistry was first introduced. Bug: T187154 Change-Id: I6d66c58fbe57c530f9a43cae504b0d6aa4ffcd0d
112 lines
3.2 KiB
PHP
112 lines
3.2 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Copyright 2014
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
use Wikimedia\ObjectFactory;
|
|
|
|
/**
|
|
* Factory class to create Skin objects
|
|
*
|
|
* @since 1.24
|
|
*/
|
|
class SkinFactory {
|
|
|
|
/**
|
|
* Map of skin name to object factory spec or factory function.
|
|
*
|
|
* @var array<string,array|callable>
|
|
*/
|
|
private $factoryFunctions = [];
|
|
/**
|
|
* Map of name => fallback human-readable name, used when the 'skinname-<skin>' message is not
|
|
* available
|
|
*
|
|
* @var array
|
|
*/
|
|
private $displayNames = [];
|
|
/**
|
|
* @var ObjectFactory
|
|
*/
|
|
private $objectFactory;
|
|
|
|
/**
|
|
* @internal For ServiceWiring only
|
|
*
|
|
* @param ObjectFactory $objectFactory
|
|
*/
|
|
public function __construct( ObjectFactory $objectFactory ) {
|
|
$this->objectFactory = $objectFactory;
|
|
}
|
|
|
|
/**
|
|
* Register a new Skin factory function.
|
|
*
|
|
* Will override if it's already registered.
|
|
*
|
|
* @param string $name Internal skin name. Should be all-lowercase (technically doesn't have
|
|
* to be, but doing so would change the case of i18n message keys).
|
|
* @param string $displayName For backwards-compatibility with old skin loading system. This is
|
|
* the text used as skin's human-readable name when the 'skinname-<skin>' message is not
|
|
* available.
|
|
* @param array|callable $spec Callback that takes the skin name as an argument, or
|
|
* object factory spec specifying how to create the skin
|
|
* @throws InvalidArgumentException If an invalid callback is provided
|
|
*/
|
|
public function register( $name, $displayName, $spec ) {
|
|
if ( !is_array( $spec ) && !is_callable( $spec ) ) {
|
|
throw new InvalidArgumentException( 'Invalid callback provided' );
|
|
}
|
|
$this->factoryFunctions[$name] = $spec;
|
|
$this->displayNames[$name] = $displayName;
|
|
}
|
|
|
|
/**
|
|
* Returns an associative array of:
|
|
* skin name => human readable name
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getSkinNames() {
|
|
return $this->displayNames;
|
|
}
|
|
|
|
/**
|
|
* Create a given Skin using the registered callback for $name.
|
|
* @param string $name Name of the skin you want
|
|
* @throws SkinException If a factory function isn't registered for $name
|
|
* @return Skin
|
|
*/
|
|
public function makeSkin( $name ) {
|
|
if ( !isset( $this->factoryFunctions[$name] ) ) {
|
|
throw new SkinException( "No registered builder available for $name." );
|
|
}
|
|
|
|
return $this->objectFactory->createObject(
|
|
$this->factoryFunctions[$name],
|
|
[
|
|
'allowCallable' => true,
|
|
'assertClass' => Skin::class,
|
|
'extraArgs' => [ $name ]
|
|
]
|
|
);
|
|
}
|
|
}
|