MediaWiki\Specials\SpecialEditPage Class Reference
Redirect from Special:Edit/$1 to index.php?title=$1&action=edit. More...
Inherits MediaWiki\SpecialPage\SpecialRedirectWithAction.
Collaboration diagram for MediaWiki\Specials\SpecialEditPage:
Public Member Functions | ||||
| __construct (SearchEngineFactory $searchEngineFactory) | ||||
 Public Member Functions inherited from MediaWiki\SpecialPage\SpecialRedirectWithAction | ||||
| __construct ( $name, $action, $msgPrefix, private readonly SearchEngineFactory $searchEngineFactory,) | ||||
| getRedirect ( $subpage) | ||||
If the special page is a redirect, then get the Title object it redirects to.False otherwise.
| ||||
| isListed () | ||||
| onFormSubmit ( $formData) | ||||
| prefixSearchSubpages ( $search, $limit, $offset) | ||||
| Return an array of subpages beginning with $search that this special page will accept. | ||||
| Public Member Functions inherited from MediaWiki\SpecialPage\RedirectSpecialPage | ||||
| execute ( $subpage) | ||||
| getRedirectQuery ( $subpage) | ||||
| Return part of the request string for a special redirect page This allows passing, e.g. | ||||
| personallyIdentifiableTarget () | ||||
| Indicate if the target of this redirect can be used to identify a particular user of this wiki (e.g., if the redirect is to the user page of a User). | ||||
| Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | ||||
| __construct ( $name='') | ||||
| Default constructor for special pages Derivative classes should call this from their constructor. | ||||
| addHelpLink ( $to, $overrideBaseUrl=false) | ||||
| Adds help link with an icon via page indicators. | ||||
| checkPermissions () | ||||
| Checks if userCanExecute, and if not throws a PermissionsError. | ||||
| checkReadOnly () | ||||
| If the wiki is currently in readonly mode, throws a ReadOnlyError. | ||||
| doesWrites () | ||||
| Indicates whether POST requests to this special page require write access to the wiki. | ||||
| getAssociatedNavigationLinks () | ||||
| Return an array of strings representing page titles that are discoverable to end users via UI. | ||||
| getAuthority () | ||||
| Shortcut to get the Authority executing this instance. | ||||
| getConfig () | ||||
| Shortcut to get main config object. | ||||
| getContentLanguage () | ||||
| Shortcut to get content language. | ||||
| getContext () | ||||
| Gets the context this SpecialPage is executed in. | ||||
| 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. | ||||
| 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. | ||||
| getFullTitle () | ||||
| Return the full title, including $par. | ||||
| getLanguage () | ||||
| Shortcut to get user's language. | ||||
| getLinkRenderer () | ||||
| getLocalName () | ||||
| Get the localised name of the special page. | ||||
| getName () | ||||
| Get the canonical, unlocalized name of this special page without namespace. | ||||
| getOutput () | ||||
| Get the OutputPage being used for this instance. | ||||
| getPageTitle ( $subpage=false) | ||||
| Get a self-referential title object. | ||||
| getRequest () | ||||
| Get the WebRequest being used for this instance. | ||||
| getRestriction () | ||||
| Get the permission that a user must have to execute this page, e.g. | ||||
| getShortDescription (string $path='') | ||||
| Similar to SpecialPage::getDescription, but takes into account subpages and designed for display in tabs. | ||||
| getSkin () | ||||
| Shortcut to get the skin being used for this instance. | ||||
| getUser () | ||||
| Shortcut to get the User executing this instance. | ||||
| including ( $x=null) | ||||
| Whether the special page is being evaluated via transclusion. | ||||
| isCached () | ||||
| Is this page cached? Expensive pages are cached or disabled in miser mode. | ||||
| isExpensive () | ||||
| Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. | ||||
| isIncludable () | ||||
| Whether it's allowed to transclude the special page via {{Special:Foo/params}}. | ||||
| isRestricted () | ||||
| Can be overridden by subclasses with more complicated permissions schemes. | ||||
| maxIncludeCacheTime () | ||||
| How long to cache page when it is being included. | ||||
| msg ( $key,... $params) | ||||
| Wrapper around wfMessage that sets the current context. | ||||
| requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin') | ||||
| If the user is not logged in, throws UserNotLoggedIn error. | ||||
| requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin', bool $alwaysRedirectToLoginPage=false) | ||||
| If the user is not logged in or is a temporary user, throws UserNotLoggedIn. | ||||
| run ( $subPage) | ||||
| Entry point. | ||||
| setContentLanguage (Language $contentLanguage) | ||||
| Set content language. | ||||
| setContext ( $context) | ||||
| Sets the context this SpecialPage is executed in. | ||||
| setHookContainer (HookContainer $hookContainer) | ||||
| setLinkRenderer (LinkRenderer $linkRenderer) | ||||
| setSpecialPageFactory (SpecialPageFactory $specialPageFactory) | ||||
| userCanExecute (User $user) | ||||
| Checks if the given user (identified by an object) can execute this special page (as defined by getRestriction). | ||||
Additional Inherited Members | |
| Static Public Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
| static | getSafeTitleFor ( $name, $subpage=false) |
| Get a localised Title object for a page name with a possibly unvalidated subpage. | |
| 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. | |
| static | getTitleValueFor ( $name, $subpage=false, $fragment='') |
| Get a localised TitleValue object for a specified special page name. | |
| static | newSearchPage (User $user) |
| Get the users preferred search page. | |
| Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialRedirectWithAction | |
| getGroupName () | |
| showNoRedirectPage () | |
| Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage | |
| addFeedLinks ( $params) | |
| Adds RSS/atom links. | |
| afterExecute ( $subPage) | |
Gets called after execute. | |
| authorizeAction (?string $action=null) | |
| Utility function for authorizing an action to be performed by the special page. | |
| beforeExecute ( $subPage) | |
Gets called before execute. | |
| buildPrevNextNavigation ( $offset, $limit, array $query=[], $atEnd=false, $subpage=false) | |
| Generate (prev x| next x) (20|50|100...) type links for paging. | |
| checkLoginSecurityLevel ( $level=null) | |
| Verifies that the user meets the security level, possibly reauthenticating them in the process. | |
| displayRestrictionError () | |
| Output an error message telling the user what access level they have to have. | |
| getAuthManager () | |
| getCacheTTL () | |
| getHookContainer () | |
| getHookRunner () | |
| getLoginSecurityLevel () | |
| Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g. | |
| getRobotPolicy () | |
| Return the robot policy. | |
| getSpecialPageFactory () | |
| getSubpagesForPrefixSearch () | |
| Return an array of subpages that this special page will accept for prefix searches. | |
| outputHeader ( $summaryMessageKey='') | |
| Outputs a summary message on top of special pages By default the message key is the canonical name of the special page May be overridden, i.e. | |
| prefixSearchString ( $search, $limit, $offset, ?SearchEngineFactory $searchEngineFactory=null) | |
| Perform a regular substring search for prefixSearchSubpages. | |
| setAuthManager (AuthManager $authManager) | |
| Set the injected AuthManager from the special page constructor. | |
| setHeaders () | |
| Sets headers - this should be called from the execute() method of all derived classes! | |
| setReauthPostData (array $data) | |
| Record preserved POST data after a reauthentication. | |
| useTransactionalTimeLimit () | |
| Call wfTransactionalTimeLimit() if this request was POSTed. | |
| Static Protected Member Functions inherited from MediaWiki\SpecialPage\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). | |
| Protected Attributes inherited from MediaWiki\SpecialPage\SpecialRedirectWithAction | |
| string | $action |
| string | $msgPrefix |
| Protected Attributes inherited from MediaWiki\SpecialPage\RedirectSpecialPage | |
| array | $mAddedRedirectParams = [] |
| Query parameters added by redirects. | |
| array | $mAllowedRedirectParams = [] |
| Query parameters that can be passed through redirects. | |
| Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage | |
| IContextSource | $mContext |
| Current request context. | |
| bool | $mIncluding |
| Whether or not this special page is being included from an article. | |
| string | $mName |
| The canonical name of this special page Also used as the message key for the default. | |
Detailed Description
Redirect from Special:Edit/$1 to index.php?title=$1&action=edit.
Definition at line 18 of file SpecialEditPage.php.
Constructor & Destructor Documentation
◆ __construct()
| MediaWiki\Specials\SpecialEditPage::__construct | ( | SearchEngineFactory | $searchEngineFactory | ) |
Definition at line 20 of file SpecialEditPage.php.
The documentation for this class was generated from the following file:
- includes/Specials/SpecialEditPage.php
