SkinFactory.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Skin;
 
use InvalidArgumentException;
use Wikimedia\ObjectFactory\ObjectFactory;
 
class SkinFactory {
    private const SKIP_BY_SITECONFIG = 1;
    private const SKIP_BY_REGISTER = 2;
 
    private $factoryFunctions = [];
    private $displayNames = [];
    private $objectFactory;
 
    private $skipSkins;
 
    public function __construct( ObjectFactory $objectFactory, array $skipSkins ) {
        $this->objectFactory = $objectFactory;
        $this->skipSkins = array_fill_keys( $skipSkins, self::SKIP_BY_SITECONFIG );
    }
 
    public function register( $name, $displayName, $spec, ?bool $skippable = null ) {
        if ( !is_callable( $spec ) ) {
            if ( is_array( $spec ) ) {
                if ( !isset( $spec['args'] ) ) {
                    // make sure name option is set:
                    $spec['args'] = [
                        [ 'name' => $name ]
                    ];
                }
            } else {
                throw new InvalidArgumentException( 'Invalid callback provided' );
            }
        }
        $this->factoryFunctions[$name] = $spec;
        $this->displayNames[$name] = $displayName;
 
        // If skipped by site config, leave as-is.
        if ( ( $this->skipSkins[$name] ?? null ) !== self::SKIP_BY_SITECONFIG ) {
            if ( $skippable === true ) {
                $this->skipSkins[$name] = self::SKIP_BY_REGISTER;
            } else {
                // Make sure the register() call is unaffected by previous calls.
                unset( $this->skipSkins[$name] );
            }
        }
    }
 
    public function getSkinNames() {
        wfDeprecated( __METHOD__, '1.37' );
        return $this->displayNames;
    }
 
    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,
            ]
        );
    }
 
    public function getAllowedSkins() {
        $skins = $this->getInstalledSkins();
 
        foreach ( $this->skipSkins as $name => $_ ) {
            unset( $skins[$name] );
        }
 
        return $skins;
    }
 
    public function getInstalledSkins() {
        return $this->displayNames;
    }
 
    public function getSkinOptions( string $name ): array {
        $skin = $this->makeSkin( $name );
        $options = $skin->getOptions();
        return $options;
    }
}
 
class_alias( SkinFactory::class, 'SkinFactory' );