MediaWiki  master
SpecialPreferences Class Reference

A special page that allows users to change their preferences. More...

Inheritance diagram for SpecialPreferences:
Collaboration diagram for SpecialPreferences:

Public Member Functions

 __construct (PreferencesFactory $preferencesFactory=null, PermissionManager $permissionManager=null, UserOptionsManager $userOptionsManager=null)
 
 doesWrites ()
 Indicates whether this special page may perform database writes. More...
 
 execute ( $par)
 Default execute method Checks user permissions. More...
 
 submitReset ( $formData)
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError. More...
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError. More...
 
 getConfig ()
 Shortcut to get main config object. More...
 
 getContentLanguage ()
 Shortcut to get content language. More...
 
 getContext ()
 Gets the context this SpecialPage is executed in. More...
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages. More...
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side. More...
 
 getFullTitle ()
 Return the full title, including $par. More...
 
 getLanguage ()
 Shortcut to get user's language. More...
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page Stable to override. More...
 
 getName ()
 Get the name of this Special Page. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission that a user must have to execute this page. More...
 
 getSkin ()
 Shortcut to get the skin being used for this instance. More...
 
 getUser ()
 Shortcut to get the User executing this instance. More...
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion. More...
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode. More...
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override. More...
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages Stable to override. More...
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes. More...
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages. More...
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included. More...
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error. More...
 
 run ( $subPage)
 Entry point. More...
 
 setContentLanguage (Language $contentLanguage)
 Set content language. More...
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in. More...
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time. More...
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction). More...
 

Protected Member Functions

 getFormObject ( $user, IContextSource $context)
 Get the preferences form to use. More...
 
 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'. More...
 
 showResetForm ()
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links. More...
 
 afterExecute ( $subPage)
 Gets called after. More...
 
 beforeExecute ( $subPage)
 Gets called before. More...
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process. More...
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have Stable to override. More...
 
 getAuthManager ()
 
 getCacheTTL ()
 Stable to override. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter. More...
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. More...
 
 getRobotPolicy ()
 Return the robot policy. More...
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches. More...
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e. More...
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages. More...
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor. More...
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes! Stable to override. More...
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Attributes

PermissionManager $permissionManager
 
PreferencesFactory $preferencesFactory
 
UserOptionsManager $userOptionsManager
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage. More...
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below. More...
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name. More...
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query). More...
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context. More...
 
bool $mIncludable
 Whether the special page can be included in an article. More...
 
bool $mIncluding
 Whether or not this special page is being included from an article. More...
 
string $mName
 The canonical name of this special page Also used for the default. More...
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone. More...
 

Detailed Description

A special page that allows users to change their preferences.

Definition at line 34 of file SpecialPreferences.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPreferences::__construct ( PreferencesFactory  $preferencesFactory = null,
PermissionManager  $permissionManager = null,
UserOptionsManager  $userOptionsManager = null 
)
Parameters
PreferencesFactory | null$preferencesFactory
PermissionManager | null$permissionManager
UserOptionsManager | null$userOptionsManager

Definition at line 50 of file SpecialPreferences.php.

References $permissionManager, $preferencesFactory, and $userOptionsManager.

Member Function Documentation

◆ doesWrites()

SpecialPreferences::doesWrites ( )

Indicates whether this special page may perform database writes.

Stable to override

Returns
bool
Since
1.27

Reimplemented from SpecialPage.

Definition at line 63 of file SpecialPreferences.php.

◆ execute()

SpecialPreferences::execute (   $subPage)

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stable to override

Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 67 of file SpecialPreferences.php.

References SpecialPage\addHelpLink(), SpecialPage\checkReadOnly(), Html\element(), SpecialPage\getContext(), getFormObject(), SpecialPage\getOutput(), SpecialPage\getRequest(), SpecialPage\getUser(), SpecialPage\msg(), SpecialPage\outputHeader(), Html\rawElement(), SpecialPage\requireLogin(), SpecialPage\setHeaders(), and showResetForm().

◆ getFormObject()

SpecialPreferences::getFormObject (   $user,
IContextSource  $context 
)
protected

Get the preferences form to use.

Parameters
User$user
IContextSource$context
Returns
PreferencesFormOOUI|HTMLForm

Definition at line 138 of file SpecialPreferences.php.

Referenced by execute().

◆ getGroupName()

SpecialPreferences::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stable to override

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 178 of file SpecialPreferences.php.

◆ showResetForm()

SpecialPreferences::showResetForm ( )
protected

◆ submitReset()

SpecialPreferences::submitReset (   $formData)

Member Data Documentation

◆ $permissionManager

PermissionManager SpecialPreferences::$permissionManager
private

Definition at line 40 of file SpecialPreferences.php.

Referenced by __construct().

◆ $preferencesFactory

PreferencesFactory SpecialPreferences::$preferencesFactory
private

Definition at line 37 of file SpecialPreferences.php.

Referenced by __construct().

◆ $userOptionsManager

UserOptionsManager SpecialPreferences::$userOptionsManager
private

Definition at line 43 of file SpecialPreferences.php.

Referenced by __construct().


The documentation for this class was generated from the following file: