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

Inheritance diagram for SpecialContributions:

[legend]

Collaboration diagram for SpecialContributions:

[legend]

Public Member Functions
	__construct (LinkBatchFactory $linkBatchFactory=null, PermissionManager $permissionManager=null, ILoadBalancer $loadBalancer=null, ActorMigration $actorMigration=null, RevisionStore $revisionStore=null, NamespaceInfo $namespaceInfo=null, UserNameUtils $userNameUtils=null, UserNamePrefixSearch $userNamePrefixSearch=null, UserOptionsLookup $userOptionsLookup=null)

	execute ( $par)
	Default execute method Checks user permissions.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

Public Member Functions inherited from 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 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.

	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 name of this Special Page.

	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.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	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.

	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)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

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

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

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

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

	getLanguageConverter ()
	Shortcut to get language's converter.

	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 Per 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
	$opts

Protected Attributes inherited from 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 for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Private Member Functions
	getPager ( $targetUser)

Additional Inherited Members
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).

Detailed Description

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

Definition at line 41 of file SpecialContributions.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialContributions::__construct	(	LinkBatchFactory	$linkBatchFactory = `null`,
		PermissionManager	$permissionManager = `null`,
		ILoadBalancer	$loadBalancer = `null`,
		ActorMigration	$actorMigration = `null`,
		RevisionStore	$revisionStore = `null`,
		NamespaceInfo	$namespaceInfo = `null`,
		UserNameUtils	$userNameUtils = `null`,
		UserNamePrefixSearch	$userNamePrefixSearch = `null`,
		UserOptionsLookup	$userOptionsLookup = `null`
	)

Parameters

LinkBatchFactory \| null	$linkBatchFactory
PermissionManager \| null	$permissionManager
ILoadBalancer \| null	$loadBalancer
ActorMigration \| null	$actorMigration
RevisionStore \| null	$revisionStore
NamespaceInfo \| null	$namespaceInfo
UserNameUtils \| null	$userNameUtils
UserNamePrefixSearch \| null	$userNamePrefixSearch
UserOptionsLookup \| null	$userOptionsLookup

Definition at line 85 of file SpecialContributions.php.

References $userOptionsLookup.

Member Function Documentation

◆ contributionsSub()

SpecialContributions::contributionsSub	(	$userObj,
		$targetName
	)

protected

Generates the subheading with links.

Parameters

User	$userObj	User object for the target
string	$targetName	This 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 376 of file SpecialContributions.php.

References NS_USER, and wfEscapeWikiText().

Referenced by execute().

◆ execute()

SpecialContributions::execute ( $subPage )

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

Reimplemented from SpecialPage.

Definition at line 110 of file SpecialContributions.php.

References $pager, SpecialPage\addFeedLinks(), SpecialPage\addHelpLink(), contributionsSub(), PoolCounterWork\execute(), IndexPager\getBody(), SpecialPage\getConfig(), getForm(), SpecialPage\getHookRunner(), ContribsPager\getNavigationBar(), IndexPager\getNumRows(), SpecialPage\getOutput(), getPager(), ContribsPager\getPreventClickjacking(), SpecialPage\getRequest(), SpecialPage\getSkin(), SpecialPage\getUser(), SpecialPage\including(), ContribsPager\isQueryableRange(), SpecialPage\msg(), User\newFromName(), NS_MAIN, NS_USER, SpecialPage\outputHeader(), SpecialPage\setHeaders(), wfAppendQuery(), and wfScript().

◆ getForm()

SpecialContributions::getForm ( array $pagerOptions )

protected

Generates the namespace selector form with hidden attributes.

Parameters

array $pagerOptions with keys contribs, user, deletedOnly, limit, target, topOnly, newOnly, hideMinor, namespace, associated, nsInvert, tagfilter, year, start, end

Returns: string HTML fragment

Definition at line 619 of file SpecialContributions.php.

References getContext(), wfDeprecated(), and wfScript().

Referenced by execute().

◆ getGroupName()

SpecialContributions::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 SpecialPage.

Definition at line 863 of file SpecialContributions.php.

◆ getPager()

SpecialContributions::getPager ( $targetUser )

private

Parameters

User $targetUser The normalized target user

Returns: ContribsPager

Definition at line 831 of file SpecialContributions.php.

References getContext().

Referenced by execute().

◆ getUserLinks()

static SpecialContributions::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	$sp	SpecialPage instance, for context
User	$target	Target user object
PermissionManager \| null	$permissionManager	(Since 1.36)
HookRunner \| null	$hookRunner	(Since 1.36)

Returns: array

Definition at line 506 of file SpecialContributions.php.

References SpecialPage\getTitleFor().

◆ prefixSearchSubpages()

SpecialContributions::prefixSearchSubpages	(	$search,
		$limit,
		$offset
	)

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

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 816 of file SpecialContributions.php.

Member Data Documentation

◆ $actorMigration

ActorMigration SpecialContributions::$actorMigration

private

Definition at line 54 of file SpecialContributions.php.

◆ $linkBatchFactory

LinkBatchFactory SpecialContributions::$linkBatchFactory

private

Definition at line 45 of file SpecialContributions.php.

◆ $loadBalancer

ILoadBalancer SpecialContributions::$loadBalancer

private

Definition at line 51 of file SpecialContributions.php.

◆ $namespaceInfo

NamespaceInfo SpecialContributions::$namespaceInfo

private

Definition at line 60 of file SpecialContributions.php.

◆ $opts

SpecialContributions::$opts

protected

Definition at line 42 of file SpecialContributions.php.

◆ $pager

ContribsPager null SpecialContributions::$pager = null

private

Definition at line 72 of file SpecialContributions.php.

Referenced by execute().

◆ $permissionManager

PermissionManager SpecialContributions::$permissionManager

private

Definition at line 48 of file SpecialContributions.php.

◆ $revisionStore

RevisionStore SpecialContributions::$revisionStore

private

Definition at line 57 of file SpecialContributions.php.

◆ $userNamePrefixSearch

UserNamePrefixSearch SpecialContributions::$userNamePrefixSearch

private

Definition at line 66 of file SpecialContributions.php.

◆ $userNameUtils

UserNameUtils SpecialContributions::$userNameUtils

private

Definition at line 63 of file SpecialContributions.php.

◆ $userOptionsLookup

UserOptionsLookup SpecialContributions::$userOptionsLookup

private

Definition at line 69 of file SpecialContributions.php.

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

includes/specials/SpecialContributions.php

Private Attributes
ActorMigration	$actorMigration

LinkBatchFactory	$linkBatchFactory

ILoadBalancer	$loadBalancer

NamespaceInfo	$namespaceInfo

ContribsPager null	$pager = null

PermissionManager	$permissionManager

RevisionStore	$revisionStore

UserNamePrefixSearch	$userNamePrefixSearch

UserNameUtils	$userNameUtils

UserOptionsLookup	$userOptionsLookup

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ contributionsSub()

◆ execute()

◆ getForm()

◆ getGroupName()

◆ getPager()

◆ getUserLinks()

◆ prefixSearchSubpages()

Member Data Documentation

◆ $actorMigration

◆ $linkBatchFactory

◆ $loadBalancer

◆ $namespaceInfo

◆ $opts

◆ $pager

◆ $permissionManager

◆ $revisionStore

◆ $userNamePrefixSearch

◆ $userNameUtils

◆ $userOptionsLookup