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 
52 interface PreferencesFactory {
53 
63  public function getForm(
64  User $user,
65  IContextSource $contextSource,
66  $formClass = PreferencesFormOOUI::class,
67  array $remove = []
68  );
69 
76  public function getFormDescriptor( User $user, IContextSource $contextSource );
77 
83  public function getSaveBlacklist();
84 }
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:52
IContextSource
Interface for objects which can provide a MediaWiki context on request.
Definition: IContextSource.php:53
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:54
HTMLForm
Object handling generic submission, CSRF protection, layout and other logic for UI forms in a reusabl...
Definition: HTMLForm.php:133