includes/skins/SkinFactory.php

   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
  24 use MediaWiki\MediaWikiServices;
  25
  26 /**
  27  * Factory class to create Skin objects
  28  *
  29  * @since 1.24
  30  */
  31 class SkinFactory {
  32
  33         /**
  34          * Map of name => callback
  35          * @var array
  36          */
  37         private $factoryFunctions = [];
  38         /**
  39          * Map of name => fallback human-readable name, used when the 'skinname-<skin>' message is not
  40          * available
  41          *
  42          * @var array
  43          */
  44         private $displayNames = [];
  45
  46         /**
  47          * @deprecated in 1.27
  48          * @return SkinFactory
  49          */
  50         public static function getDefaultInstance() {
  51                 wfDeprecated( __METHOD__, '1.27' );
  52                 return MediaWikiServices::getInstance()->getSkinFactory();
  53         }
  54
  55         /**
  56          * Register a new Skin factory function.
  57          *
  58          * Will override if it's already registered.
  59          *
  60          * @param string $name Internal skin name. Should be all-lowercase (technically doesn't have
  61          *     to be, but doing so would change the case of i18n message keys).
  62          * @param string $displayName For backwards-compatibility with old skin loading system. This is
  63          *     the text used as skin's human-readable name when the 'skinname-<skin>' message is not
  64          *     available. It should be the same as the skin name provided in $wgExtensionCredits.
  65          * @param callable $callback Callback that takes the skin name as an argument
  66          * @throws InvalidArgumentException If an invalid callback is provided
  67          */
  68         public function register( $name, $displayName, $callback ) {
  69                 if ( !is_callable( $callback ) ) {
  70                         throw new InvalidArgumentException( 'Invalid callback provided' );
  71                 }
  72                 $this->factoryFunctions[$name] = $callback;
  73                 $this->displayNames[$name] = $displayName;
  74         }
  75
  76         /**
  77          * Returns an associative array of:
  78          *  skin name => human readable name
  79          *
  80          * @return array
  81          */
  82         public function getSkinNames() {
  83                 return $this->displayNames;
  84         }
  85
  86         /**
  87          * Create a given Skin using the registered callback for $name.
  88          * @param string $name Name of the skin you want
  89          * @throws SkinException If a factory function isn't registered for $name
  90          * @throws UnexpectedValueException If the factory function returns a non-Skin object
  91          * @return Skin
  92          */
  93         public function makeSkin( $name ) {
  94                 if ( !isset( $this->factoryFunctions[$name] ) ) {
  95                         throw new SkinException( "No registered builder available for $name." );
  96                 }
  97                 $skin = call_user_func( $this->factoryFunctions[$name], $name );
  98                 if ( $skin instanceof Skin ) {
  99                         return $skin;
 100                 } else {
 101                         throw new UnexpectedValueException( "The builder for $name returned a non-Skin object." );
 102                 }
 103         }
 104 }