MediaWiki  master
SkinFactory.php
Go to the documentation of this file.
1 <?php
2 
25 
31 class SkinFactory {
32 
37  private $factoryFunctions = [];
44  private $displayNames = [];
45 
50  public static function getDefaultInstance() {
51  return MediaWikiServices::getInstance()->getSkinFactory();
52  }
53 
67  public function register( $name, $displayName, $callback ) {
68  if ( !is_callable( $callback ) ) {
69  throw new InvalidArgumentException( 'Invalid callback provided' );
70  }
71  $this->factoryFunctions[$name] = $callback;
72  $this->displayNames[$name] = $displayName;
73  }
74 
81  public function getSkinNames() {
82  return $this->displayNames;
83  }
84 
92  public function makeSkin( $name ) {
93  if ( !isset( $this->factoryFunctions[$name] ) ) {
94  throw new SkinException( "No registered builder available for $name." );
95  }
96  $skin = call_user_func( $this->factoryFunctions[$name], $name );
97  if ( $skin instanceof Skin ) {
98  return $skin;
99  } else {
100  throw new UnexpectedValueException( "The builder for $name returned a non-Skin object." );
101  }
102  }
103 }
array $displayNames
Map of name => fallback human-readable name, used when the &#39;skinname-<skin>&#39; message is not available...
Definition: SkinFactory.php:44
makeSkin( $name)
Create a given Skin using the registered callback for $name.
Definition: SkinFactory.php:92
Exceptions for skin-related failures.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
getSkinNames()
Returns an associative array of: skin name => human readable name.
Definition: SkinFactory.php:81
array $factoryFunctions
Map of name => callback.
Definition: SkinFactory.php:37
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:1982
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:271
static getDefaultInstance()
Definition: SkinFactory.php:50