MediaWiki master
MediaWiki\SpecialPage\ContributionsSpecialPage Class Reference

Show user contributions in a paged list. More...

Inherits MediaWiki\SpecialPage\IncludableSpecialPage.

Inherited by MediaWiki\Specials\SpecialContributions.

Collaboration diagram for MediaWiki\SpecialPage\ContributionsSpecialPage:

Public Member Functions

 __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.
 
- 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 this special page may perform database writes.
 
 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.
 
 getShortDescription (string $path='')
 Similar to getDescription but takes into account sub pages 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.
 
 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')
 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).
 

Static Public Member Functions

static getUserLinks (SpecialPage $sp, User $target, PermissionManager $permissionManager=null, HookRunner $hookRunner=null)
 Links to different places.
 
- 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

 contributionsSub ( $userObj, $targetName)
 Generates the subheading with links.
 
 getForm (array $pagerOptions)
 Generates the namespace selector form with hidden attributes.
 
 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'.
 
 getPager ( $targetUser)
 
 getTargetField ( $target)
 Get the target field for the form.
 
 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.
 

Protected Attributes

DatabaseBlockStore $blockStore
 
IConnectionProvider $dbProvider
 
 $formErrors = false
 
NamespaceInfo $namespaceInfo
 
 $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.
 

Additional Inherited Members

- 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).
 

Detailed Description

Show user contributions in a paged list.

This was refactored out from SpecialContributions to make it easier to add new special pages with similar functionality and similar output. Hooks formerly for SpecialContributions are run here to avoid needing to duplicate hooks for each subclass.

The subclass must provide an implementation of ::getPager, and may disable syndication feed functionality by overriding ::providesFeeds.

Stability: stable
to extend
Since
1.43 Refactored from SpecialContributions

Definition at line 70 of file ContributionsSpecialPage.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\SpecialPage\ContributionsSpecialPage::__construct ( PermissionManager $permissionManager,
IConnectionProvider $dbProvider,
NamespaceInfo $namespaceInfo,
UserNameUtils $userNameUtils,
UserNamePrefixSearch $userNamePrefixSearch,
UserOptionsLookup $userOptionsLookup,
UserFactory $userFactory,
UserIdentityLookup $userIdentityLookup,
DatabaseBlockStore $blockStore,
$name,
$restriction = '' )

Member Function Documentation

◆ contributionsSub()

MediaWiki\SpecialPage\ContributionsSpecialPage::contributionsSub ( $userObj,
$targetName )
protected

Generates the subheading with links.

Parameters
User$userObjUser object for the target
string$targetNameThis mostly the same as $userObj->getName() but normalization may make it differ. // T272225
Returns
string Appropriately-escaped HTML to be output literally
Todo
FIXME: Almost the same as getSubTitle in SpecialDeletedContributions.php. Could be combined.

Definition at line 399 of file ContributionsSpecialPage.php.

References getUser(), NS_USER, and wfEscapeWikiText().

Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\execute().

◆ execute()

◆ getForm()

MediaWiki\SpecialPage\ContributionsSpecialPage::getForm ( array $pagerOptions)
protected

Generates the namespace selector form with hidden attributes.

Parameters
array$pagerOptionswith keys contribs, user, deletedOnly, limit, target, topOnly, newOnly, hideMinor, namespace, associated, nsInvert, tagfilter, tagInvert, year, start, end
Returns
string HTML fragment

Definition at line 713 of file ContributionsSpecialPage.php.

References getContext(), StatusValue\isGood(), wfDeprecatedMsg(), and wfScript().

Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\execute().

◆ getGroupName()

MediaWiki\SpecialPage\ContributionsSpecialPage::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'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 943 of file ContributionsSpecialPage.php.

◆ getPager()

MediaWiki\SpecialPage\ContributionsSpecialPage::getPager ( $targetUser)
protected
Parameters
UserIdentity$targetUserThe normalized target user identity
Returns
ContributionsPager

Reimplemented in MediaWiki\Specials\SpecialContributions.

Definition at line 937 of file ContributionsSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\execute().

◆ getTargetField()

MediaWiki\SpecialPage\ContributionsSpecialPage::getTargetField ( $target)
protected

Get the target field for the form.

Parameters
string$target
Returns
array

Definition at line 690 of file ContributionsSpecialPage.php.

◆ getUserLinks()

static MediaWiki\SpecialPage\ContributionsSpecialPage::getUserLinks ( SpecialPage $sp,
User $target,
PermissionManager $permissionManager = null,
HookRunner $hookRunner = null )
static

Links to different places.

Note
This function is also called in DeletedContributionsPage
Parameters
SpecialPage$spSpecialPage instance, for context
User$targetTarget user object
PermissionManager | null$permissionManager(Since 1.36)
HookRunner | null$hookRunner(Since 1.36)
Returns
array

Definition at line 559 of file ContributionsSpecialPage.php.

References MediaWiki\SpecialPage\SpecialPage\getTitleFor().

◆ prefixSearchSubpages()

MediaWiki\SpecialPage\ContributionsSpecialPage::prefixSearchSubpages ( $search,
$limit,
$offset )

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 915 of file ContributionsSpecialPage.php.

◆ providesFeeds()

MediaWiki\SpecialPage\ContributionsSpecialPage::providesFeeds ( )
protected
Returns
bool This SpecialPage provides syndication feeds.

Definition at line 929 of file ContributionsSpecialPage.php.

Referenced by MediaWiki\SpecialPage\ContributionsSpecialPage\execute().

Member Data Documentation

◆ $blockStore

DatabaseBlockStore MediaWiki\SpecialPage\ContributionsSpecialPage::$blockStore
protected

◆ $dbProvider

IConnectionProvider MediaWiki\SpecialPage\ContributionsSpecialPage::$dbProvider
protected

◆ $formErrors

MediaWiki\SpecialPage\ContributionsSpecialPage::$formErrors = false
protected

Definition at line 72 of file ContributionsSpecialPage.php.

◆ $namespaceInfo

NamespaceInfo MediaWiki\SpecialPage\ContributionsSpecialPage::$namespaceInfo
protected

◆ $opts

MediaWiki\SpecialPage\ContributionsSpecialPage::$opts = []
protected

Definition at line 71 of file ContributionsSpecialPage.php.

◆ $permissionManager

PermissionManager MediaWiki\SpecialPage\ContributionsSpecialPage::$permissionManager
protected

◆ $userFactory

UserFactory MediaWiki\SpecialPage\ContributionsSpecialPage::$userFactory
protected

◆ $userIdentityLookup

UserIdentityLookup MediaWiki\SpecialPage\ContributionsSpecialPage::$userIdentityLookup
protected

◆ $userNamePrefixSearch

UserNamePrefixSearch MediaWiki\SpecialPage\ContributionsSpecialPage::$userNamePrefixSearch
protected

◆ $userNameUtils

UserNameUtils MediaWiki\SpecialPage\ContributionsSpecialPage::$userNameUtils
protected

◆ $userOptionsLookup

UserOptionsLookup MediaWiki\SpecialPage\ContributionsSpecialPage::$userOptionsLookup
protected

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