MediaWiki master
MediaWiki\Specials\SpecialContributions Class Reference

Special:Contributions, show user contributions in a paged list. More...

Inherits MediaWiki\SpecialPage\ContributionsSpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialContributions:

Public Member Functions

 __construct (LinkBatchFactory $linkBatchFactory, PermissionManager $permissionManager, IConnectionProvider $dbProvider, RevisionStore $revisionStore, NamespaceInfo $namespaceInfo, UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, UserOptionsLookup $userOptionsLookup, CommentFormatter $commentFormatter, UserFactory $userFactory, UserIdentityLookup $userIdentityLookup, DatabaseBlockStore $blockStore, TempUserConfig $tempUserConfig)
 
 getAssociatedNavigationLinks ()
 Return an array of strings representing page titles that are discoverable to end users via UI.
Since
1.39
Stability: stable
to call or override
Returns
string[] strings representing page titles that can be rendered by skins if required.

 
 getShortDescription (string $path='')
 Similar to getDescription, but takes into account subpages and designed for display in tabs.
Since
1.39
Stability: stable
to override if special page has complex parameter handling. Use default message keys where possible.
Parameters
string$path(optional)
Returns
string

 
- Public Member Functions inherited from MediaWiki\SpecialPage\ContributionsSpecialPage
 __construct (PermissionManager $permissionManager, IConnectionProvider $dbProvider, NamespaceInfo $namespaceInfo, UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, UserOptionsLookup $userOptionsLookup, UserFactory $userFactory, UserIdentityLookup $userIdentityLookup, DatabaseBlockStore $blockStore, $name, $restriction='')
 
 execute ( $par)
 Default execute method Checks user permissions.This must be overridden by subclasses; it will be made abstract in a future version
Stability: stable
to override
Parameters
string | null$subPage

 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
 shouldShowBlockLogExtract (UserIdentity $target)
 Whether the block log extract should be shown on the special page.
 
- Public Member Functions inherited from MediaWiki\SpecialPage\IncludableSpecialPage
 __construct ( $name, $restriction='', $listed=true, $function=false, $file='default')
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
- Public Member Functions inherited from MediaWiki\SpecialPage\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.
 
 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.
 
 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.
 
 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.
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 
 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 $mRestriction).
 

Protected Member Functions

 getPager ( $targetUser)
 
Parameters
UserIdentity$targetUserThe normalized target user identity
Returns
ContributionsPager

 
 getResultsPageTitleMessageKey (UserIdentity $target)
 
Parameters
UserIdentity$targetThe target of the search that produced the results page
Returns
string Message key for the results page title

 
- Protected Member Functions inherited from MediaWiki\SpecialPage\ContributionsSpecialPage
 contributionsSub ( $userObj, $targetName)
 Generates the subheading with links.
 
 getForm (array $pagerOptions)
 Generates the namespace selector form with hidden attributes.
 
 getFormWrapperLegendMessageKey ()
 
 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'.
Stability: stable
to override
Returns
string
Since
1.21

 
 getTargetField ( $target)
 Get the target field for the form.
 
 getUserLinks (SpecialPage $sp, User $target)
 Links to different places.
 
 isArchive ()
 Define whether this page shows existing revisions (from the revision table) or revisions of deleted pages (from the archive table).
 
 modifyFields (&$fields)
 Allow children classes to call this function and make modifications to the field options before they're used to create the form in getForm.
 
 providesFeeds ()
 
- Protected Member Functions inherited from MediaWiki\SpecialPage\SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 authorizeAction (?string $action=null)
 Utility function for authorizing an action to be performed by the special page.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 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.
 

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.
 
- 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\ContributionsSpecialPage
DatabaseBlockStore $blockStore
 
IConnectionProvider $dbProvider
 
bool $formErrors = false
 
NamespaceInfo $namespaceInfo
 
array $opts = []
 
PermissionManager $permissionManager
 
UserFactory $userFactory
 
UserIdentityLookup $userIdentityLookup
 
UserNamePrefixSearch $userNamePrefixSearch
 
UserNameUtils $userNameUtils
 
UserOptionsLookup $userOptionsLookup
 
- Protected Attributes inherited from MediaWiki\SpecialPage\SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
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.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Detailed Description

Special:Contributions, show user contributions in a paged list.

Definition at line 48 of file SpecialContributions.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialContributions::__construct ( LinkBatchFactory $linkBatchFactory,
PermissionManager $permissionManager,
IConnectionProvider $dbProvider,
RevisionStore $revisionStore,
NamespaceInfo $namespaceInfo,
UserNameUtils $userNameUtils,
UserNamePrefixSearch $userNamePrefixSearch,
UserOptionsLookup $userOptionsLookup,
CommentFormatter $commentFormatter,
UserFactory $userFactory,
UserIdentityLookup $userIdentityLookup,
DatabaseBlockStore $blockStore,
TempUserConfig $tempUserConfig )
Parameters
LinkBatchFactory$linkBatchFactory
PermissionManager$permissionManager
IConnectionProvider$dbProvider
RevisionStore$revisionStore
NamespaceInfo$namespaceInfo
UserNameUtils$userNameUtils
UserNamePrefixSearch$userNamePrefixSearch
UserOptionsLookup$userOptionsLookup
CommentFormatter$commentFormatter
UserFactory$userFactory
UserIdentityLookup$userIdentityLookup
DatabaseBlockStore$blockStore
TempUserConfig$tempUserConfig

Definition at line 70 of file SpecialContributions.php.

References MediaWiki\SpecialPage\ContributionsSpecialPage\$blockStore, MediaWiki\SpecialPage\ContributionsSpecialPage\$dbProvider, MediaWiki\SpecialPage\ContributionsSpecialPage\$namespaceInfo, MediaWiki\SpecialPage\ContributionsSpecialPage\$permissionManager, MediaWiki\SpecialPage\ContributionsSpecialPage\$userFactory, MediaWiki\SpecialPage\ContributionsSpecialPage\$userIdentityLookup, MediaWiki\SpecialPage\ContributionsSpecialPage\$userNamePrefixSearch, MediaWiki\SpecialPage\ContributionsSpecialPage\$userNameUtils, and MediaWiki\SpecialPage\ContributionsSpecialPage\$userOptionsLookup.

Member Function Documentation

◆ getAssociatedNavigationLinks()

MediaWiki\Specials\SpecialContributions::getAssociatedNavigationLinks ( )

Return an array of strings representing page titles that are discoverable to end users via UI.

Since
1.39
Stability: stable
to call or override
Returns
string[] strings representing page titles that can be rendered by skins if required.

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 150 of file SpecialContributions.php.

◆ getPager()

MediaWiki\Specials\SpecialContributions::getPager ( $targetUser)
protected

Parameters
UserIdentity$targetUserThe normalized target user identity
Returns
ContributionsPager

Reimplemented from MediaWiki\SpecialPage\ContributionsSpecialPage.

Definition at line 107 of file SpecialContributions.php.

References MediaWiki\SpecialPage\SpecialPage\getContext(), MediaWiki\SpecialPage\SpecialPage\getHookContainer(), and MediaWiki\SpecialPage\SpecialPage\getLinkRenderer().

◆ getResultsPageTitleMessageKey()

MediaWiki\Specials\SpecialContributions::getResultsPageTitleMessageKey ( UserIdentity $target)
protected

Parameters
UserIdentity$targetThe target of the search that produced the results page
Returns
string Message key for the results page title

Reimplemented from MediaWiki\SpecialPage\ContributionsSpecialPage.

Definition at line 166 of file SpecialContributions.php.

References MediaWiki\User\UserIdentity\getName().

◆ getShortDescription()

MediaWiki\Specials\SpecialContributions::getShortDescription ( string $path = '')

Similar to getDescription, but takes into account subpages and designed for display in tabs.

Since
1.39
Stability: stable
to override if special page has complex parameter handling. Use default message keys where possible.
Parameters
string$path(optional)
Returns
string

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 143 of file SpecialContributions.php.


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