MediaWiki  REL1_31
PreferencesFactory.php
Go to the documentation of this file.
1 <?php
21 namespace MediaWiki\Preferences;
22 
25 use User;
26 
51 interface PreferencesFactory {
52 
62  public function getForm(
63  User $user,
64  IContextSource $contextSource,
65  $formClass = \PreferencesForm::class,
66  array $remove = []
67  );
68 
75  public function getFormDescriptor( User $user, IContextSource $contextSource );
76 
82  public function getSaveBlacklist();
83 }
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
array
the array() calling protocol came about after MediaWiki 1.4rc1.
User
User
Definition: All_system_messages.txt:425
php
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:37
MediaWiki\Preferences
Definition: DefaultPreferencesFactory.php:21
MediaWiki\Preferences\PreferencesFactory\getForm
getForm(User $user, IContextSource $contextSource, $formClass=\PreferencesForm::class, array $remove=[])
Get the preferences form for a given user.
MediaWiki\Preferences\PreferencesFactory\getSaveBlacklist
getSaveBlacklist()
Get the names of preferences that should never be saved (such as 'realname' and 'emailaddress').
MediaWiki\Preferences\PreferencesFactory\getFormDescriptor
getFormDescriptor(User $user, IContextSource $contextSource)
Get the preferences form descriptor.
MediaWiki\Preferences\PreferencesFactory
A PreferencesFactory is a MediaWiki service that provides the definitions of preferences for a given ...
Definition: PreferencesFactory.php:51
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:53
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms.
Definition: HTMLForm.php:130