MediaWiki  master
SlotRoleRegistry.php
Go to the documentation of this file.
1 <?php
23 namespace MediaWiki\Revision;
24 
30 
49 
53  private $roleNamesStore;
54 
58  private $instantiators = [];
59 
63  private $handlers;
64 
68  public function __construct( NameTableStore $roleNamesStore ) {
69  $this->roleNamesStore = $roleNamesStore;
70  }
71 
84  public function defineRole( $role, callable $instantiator ) {
85  if ( $this->isDefinedRole( $role ) ) {
86  throw new LogicException( "Role $role is already defined" );
87  }
88 
89  $this->instantiators[$role] = $instantiator;
90  }
91 
106  public function defineRoleWithModel( $role, $model, $layout = [] ) {
107  $this->defineRole(
108  $role,
109  function ( $role ) use ( $model, $layout ) {
110  return new SlotRoleHandler( $role, $model, $layout );
111  }
112  );
113  }
114 
124  public function getRoleHandler( $role ) {
125  if ( !isset( $this->handlers[$role] ) ) {
126  if ( !$this->isDefinedRole( $role ) ) {
127  if ( $this->isKnownRole( $role ) ) {
128  // The role has no handler defined, but is represented in the database.
129  // This may happen e.g. when the extension that defined the role was uninstalled.
130  wfWarn( __METHOD__ . ": known but undefined slot role $role" );
131  $this->handlers[$role] = new FallbackSlotRoleHandler( $role );
132  } else {
133  // The role doesn't have a handler defined, and is not represented in
134  // the database. Something must be quite wrong.
135  throw new InvalidArgumentException( "Unknown role $role" );
136  }
137  } else {
138  $handler = call_user_func( $this->instantiators[$role], $role );
139 
140  Assert::postcondition(
141  $handler instanceof SlotRoleHandler,
142  "Instantiator for $role role must return a SlotRoleHandler"
143  );
144 
145  $this->handlers[$role] = $handler;
146  }
147  }
148 
149  return $this->handlers[$role];
150  }
151 
163  public function getAllowedRoles( LinkTarget $title ) {
164  // TODO: allow this to be overwritten per namespace (or page type)
165  // TODO: decide how to control which slots are offered for editing per default (T209927)
166  return $this->getDefinedRoles();
167  }
168 
181  public function getRequiredRoles( LinkTarget $title ) {
182  // TODO: allow this to be overwritten per namespace (or page type)
183  return [ 'main' ];
184  }
185 
193  public function getDefinedRoles() {
194  return array_keys( $this->instantiators );
195  }
196 
206  public function getKnownRoles() {
207  return array_unique( array_merge(
208  $this->getDefinedRoles(),
209  $this->roleNamesStore->getMap()
210  ) );
211  }
212 
219  public function isDefinedRole( $role ) {
220  return in_array( $role, $this->getDefinedRoles(), true );
221  }
222 
230  public function isKnownRole( $role ) {
231  return in_array( $role, $this->getKnownRoles(), true );
232  }
233 
234 }
getAllowedRoles(LinkTarget $title)
Returns the list of roles allowed when creating a new revision on the given page. ...
getKnownRoles()
Returns the list of known roles, including the ones returned by getDefinedRoles(), and roles that exist according to the NameTableStore provided to the constructor.
wfWarn( $msg, $callerOffset=1, $level=E_USER_NOTICE)
Send a warning either to the debug log or in a PHP error depending on $wgDevelopmentWarnings.
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
getDefinedRoles()
Returns the list of roles defined by calling defineRole().
A registry service for SlotRoleHandlers, used to define which slot roles are available on which page...
getRequiredRoles(LinkTarget $title)
Returns the list of roles required when creating a new revision on the given page.
defineRole( $role, callable $instantiator)
Defines a slot role.
SlotRoleHandler instances are used to declare the existence and behavior of slot roles.
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output modifiable modifiable after all normalizations have been except for the $wgMaxImageArea check set to true or false to override the $wgMaxImageArea check result gives extension the possibility to transform it themselves $handler
Definition: hooks.txt:767
Created by PhpStorm.
isKnownRole( $role)
Whether the given role is known, that is, it&#39;s either defined or exist according to the NameTableStor...
isDefinedRole( $role)
Whether the given role is defined, that is, it was defined by calling defineRole().
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
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
getRoleHandler( $role)
Gets the SlotRoleHandler that should be used when processing content of the given role...
__construct(NameTableStore $roleNamesStore)
A SlotRoleHandler for providing basic functionality for undefined slot roles.
SlotRoleHandler [] $handlers
defineRoleWithModel( $role, $model, $layout=[])
Defines a slot role that allows only the given content model, and has no special behavior.