Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
90.91% covered (success)
90.91%
30 / 33
85.71% covered (warning)
85.71%
6 / 7
 CRAP
0.00% covered (danger)
0.00%
0 / 1
SkinFactory
90.91% covered (success)
90.91%
30 / 33
85.71% covered (warning)
85.71%
6 / 7
 14.15
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
 1
 register
100.00% covered (success)
100.00%
13 / 13
100.00% covered (success)
100.00%
1 / 1
 6
 getSkinNames
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 makeSkin
100.00% covered (success)
100.00%
9 / 9
100.00% covered (success)
100.00%
1 / 1
 2
 getAllowedSkins
100.00% covered (success)
100.00%
4 / 4
100.00% covered (success)
100.00%
1 / 1
 2
 getInstalledSkins
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
 1
 getSkinOptions
0.00% covered (danger)
0.00%
0 / 3
0.00% covered (danger)
0.00%
0 / 1
 2
1<?php
2
3/**
4 * Copyright 2014
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 * http://www.gnu.org/copyleft/gpl.html
20 *
21 * @file
22 */
23
24use Wikimedia\ObjectFactory\ObjectFactory;
25
26/**
27 * Factory class to create Skin objects
28 *
29 * @since 1.24
30 */
31class SkinFactory {
32    private const SKIP_BY_SITECONFIG = 1;
33    private const SKIP_BY_REGISTER = 2;
34
35    /**
36     * Map of skin name to object factory spec or factory function.
37     *
38     * @var array<string,array|callable>
39     */
40    private $factoryFunctions = [];
41    /**
42     * Map of name => fallback human-readable name, used when the 'skinname-<skin>' message is not
43     * available
44     *
45     * @var array
46     */
47    private $displayNames = [];
48    /**
49     * @var ObjectFactory
50     */
51    private $objectFactory;
52
53    /**
54     * Array of skins that should not be presented in the list of
55     * available skins in user preferences, while they're still installed.
56     *
57     * @var array<string,int>
58     */
59    private $skipSkins;
60
61    /**
62     * @internal For ServiceWiring only
63     *
64     * @param ObjectFactory $objectFactory
65     * @param string[] $skipSkins
66     */
67    public function __construct( ObjectFactory $objectFactory, array $skipSkins ) {
68        $this->objectFactory = $objectFactory;
69        $this->skipSkins = array_fill_keys( $skipSkins, self::SKIP_BY_SITECONFIG );
70    }
71
72    /**
73     * Register a new skin.
74     *
75     * This will replace any previously registered skin by the same name.
76     *
77     * @param string $name Internal skin name. See also Skin::__construct.
78     * @param string $displayName For backwards-compatibility with old skin loading system. This is
79     *   the text used as skin's human-readable name when the 'skinname-<skin>' message is not
80     *   available.
81     * @param array|callable $spec ObjectFactory spec to construct a Skin object,
82     *   or callback that takes a skin name and returns a Skin object.
83     *   See Skin::__construct for the constructor arguments.
84     * @param true|null $skippable Whether the skin is skippable and should be hidden
85     *   from user preferences. By default, this is determined based by $wgSkipSkins.
86     */
87    public function register( $name, $displayName, $spec, bool $skippable = null ) {
88        if ( !is_callable( $spec ) ) {
89            if ( is_array( $spec ) ) {
90                if ( !isset( $spec['args'] ) ) {
91                    // make sure name option is set:
92                    $spec['args'] = [
93                        [ 'name' => $name ]
94                    ];
95                }
96            } else {
97                throw new InvalidArgumentException( 'Invalid callback provided' );
98            }
99        }
100        $this->factoryFunctions[$name] = $spec;
101        $this->displayNames[$name] = $displayName;
102
103        // If skipped by site config, leave as-is.
104        if ( ( $this->skipSkins[$name] ?? null ) !== self::SKIP_BY_SITECONFIG ) {
105            if ( $skippable === true ) {
106                $this->skipSkins[$name] = self::SKIP_BY_REGISTER;
107            } else {
108                // Make sure the register() call is unaffected by previous calls.
109                unset( $this->skipSkins[$name] );
110            }
111        }
112    }
113
114    /**
115     * Return an associative array of `skin name => human readable name`.
116     *
117     * @deprecated since 1.37 Use getInstalledSkins instead
118     * @return array
119     */
120    public function getSkinNames() {
121        return $this->displayNames;
122    }
123
124    /**
125     * Create a given Skin using the registered callback for $name.
126     *
127     * @param string $name Name of the skin you want
128     * @throws SkinException If a factory function isn't registered for $name
129     * @return Skin
130     */
131    public function makeSkin( $name ) {
132        if ( !isset( $this->factoryFunctions[$name] ) ) {
133            throw new SkinException( "No registered builder available for $name." );
134        }
135
136        return $this->objectFactory->createObject(
137            $this->factoryFunctions[$name],
138            [
139                'allowCallable' => true,
140                'assertClass' => Skin::class,
141            ]
142        );
143    }
144
145    /**
146     * Get the list of user-selectable skins.
147     *
148     * Useful for Special:Preferences and other places where you
149     * only want to show skins users _can_ select from preferences page,
150     * thus excluding those as configured by $wgSkipSkins.
151     *
152     * @return string[]
153     * @since 1.36
154     */
155    public function getAllowedSkins() {
156        $skins = $this->getInstalledSkins();
157
158        foreach ( $this->skipSkins as $name => $_ ) {
159            unset( $skins[$name] );
160        }
161
162        return $skins;
163    }
164
165    /**
166     * Get the list of installed skins.
167     *
168     * Returns an associative array of skin name => human readable name
169     *
170     * @return string[]
171     * @since 1.37
172     */
173    public function getInstalledSkins() {
174        return $this->displayNames;
175    }
176
177    /**
178     * Return options provided for a given skin name
179     *
180     * For documentation about keys you can expect to exist,
181     * and their default values, refer to the Skin constructor.
182     *
183     * @since 1.38
184     * @param string $name Name of the skin you want options from
185     * @return array
186     */
187    public function getSkinOptions( string $name ): array {
188        $skin = $this->makeSkin( $name );
189        $options = $skin->getOptions();
190        return $options;
191    }
192}