MediaWiki  master
PreferencesFactory.php
Go to the documentation of this file.
1 <?php
21 namespace MediaWiki\Preferences;
22 
23 use HTMLForm;
24 use IContextSource;
26 use User;
27 
54 interface PreferencesFactory {
55 
65  public function getForm(
66  User $user,
67  IContextSource $contextSource,
68  $formClass = PreferencesFormOOUI::class,
69  array $remove = []
70  );
71 
78  public function getFormDescriptor( User $user, IContextSource $contextSource );
79 
85  public function getSaveBlacklist();
86 }
PreferencesFormOOUI
Form to edit user preferences.
Definition: PreferencesFormOOUI.php:26
MediaWiki\Preferences
Definition: DefaultPreferencesFactory.php:21
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\getForm
getForm(User $user, IContextSource $contextSource, $formClass=PreferencesFormOOUI::class, array $remove=[])
Get the preferences form for a given user.
MediaWiki\Preferences\PreferencesFactory
A PreferencesFactory is a MediaWiki service that provides the definitions of preferences for a given ...
Definition: PreferencesFactory.php:54
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:55
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:56
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms in a reusabl...
Definition: HTMLForm.php:135