MediaWiki  master
SpecialContributions Class Reference

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

Inheritance diagram for SpecialContributions:
Collaboration diagram for SpecialContributions:

Public Member Functions

 __construct (LinkBatchFactory $linkBatchFactory, PermissionManager $permissionManager, ILoadBalancer $loadBalancer, ActorMigration $actorMigration, RevisionStore $revisionStore, NamespaceInfo $namespaceInfo, UserNameUtils $userNameUtils, UserNamePrefixSearch $userNamePrefixSearch, UserOptionsLookup $userOptionsLookup)
 
 execute ( $par)
 Default execute method Checks user permissions. More...
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept. More...
 
- 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}} Stable to override. More...
 
- 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...
 
 doesWrites ()
 Indicates whether this special page may perform database writes. 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...
 
 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...
 
 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...
 

Static Public Member Functions

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

Protected Member Functions

 contributionsSub ( $userObj)
 Generates the subheading with links. More...
 
 getForm (array $pagerOptions)
 Generates the namespace selector form with hidden attributes. 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...
 
- 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...
 

Protected Attributes

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

Private Attributes

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

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

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,
PermissionManager  $permissionManager,
ILoadBalancer  $loadBalancer,
ActorMigration  $actorMigration,
RevisionStore  $revisionStore,
NamespaceInfo  $namespaceInfo,
UserNameUtils  $userNameUtils,
UserNamePrefixSearch  $userNamePrefixSearch,
UserOptionsLookup  $userOptionsLookup 
)
Parameters
LinkBatchFactory$linkBatchFactory
PermissionManager$permissionManager
ILoadBalancer$loadBalancer
ActorMigration$actorMigration
RevisionStore$revisionStore
NamespaceInfo$namespaceInfo
UserNameUtils$userNameUtils
UserNamePrefixSearch$userNamePrefixSearch
UserOptionsLookup$userOptionsLookup

Definition at line 82 of file SpecialContributions.php.

References $actorMigration, $linkBatchFactory, $loadBalancer, $namespaceInfo, $permissionManager, $revisionStore, $userNamePrefixSearch, $userNameUtils, and $userOptionsLookup.

Member Function Documentation

◆ contributionsSub()

SpecialContributions::contributionsSub (   $userObj)
protected

Generates the subheading with links.

Parameters
User$userObjUser object for the target
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 380 of file SpecialContributions.php.

References Html\closeElement(), SpecialPage\getHookRunner(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), getUserLinks(), SpecialPage\including(), User\isIP(), NS_USER, Html\openElement(), Html\rawElement(), LogEventsList\showLogExtract(), and wfEscapeWikiText().

Referenced by execute().

◆ execute()

◆ getForm()

SpecialContributions::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, year, start, end
Returns
string HTML fragment

Definition at line 602 of file SpecialContributions.php.

References HTMLForm\factory(), SpecialPage\getContext(), SpecialPage\getHookRunner(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\msg(), 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'.

Stable to override

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 813 of file SpecialContributions.php.

◆ 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$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 489 of file SpecialContributions.php.

References SpecialPage\$linkRenderer, $permissionManager, SpecialPage\getTitleFor(), if, and MediaWiki\Permissions\PermissionManager\userHasRight().

Referenced by contributionsSub(), and SpecialDeletedContributions\getSubTitle().

◆ prefixSearchSubpages()

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

Definition at line 802 of file SpecialContributions.php.

Member Data Documentation

◆ $actorMigration

ActorMigration SpecialContributions::$actorMigration
private

Definition at line 54 of file SpecialContributions.php.

Referenced by __construct().

◆ $linkBatchFactory

LinkBatchFactory SpecialContributions::$linkBatchFactory
private

Definition at line 45 of file SpecialContributions.php.

Referenced by __construct().

◆ $loadBalancer

ILoadBalancer SpecialContributions::$loadBalancer
private

Definition at line 51 of file SpecialContributions.php.

Referenced by __construct().

◆ $namespaceInfo

NamespaceInfo SpecialContributions::$namespaceInfo
private

Definition at line 60 of file SpecialContributions.php.

Referenced by __construct().

◆ $opts

SpecialContributions::$opts
protected

Definition at line 42 of file SpecialContributions.php.

◆ $permissionManager

PermissionManager SpecialContributions::$permissionManager
private

Definition at line 48 of file SpecialContributions.php.

Referenced by __construct(), and getUserLinks().

◆ $revisionStore

RevisionStore SpecialContributions::$revisionStore
private

Definition at line 57 of file SpecialContributions.php.

Referenced by __construct().

◆ $userNamePrefixSearch

UserNamePrefixSearch SpecialContributions::$userNamePrefixSearch
private

Definition at line 66 of file SpecialContributions.php.

Referenced by __construct().

◆ $userNameUtils

UserNameUtils SpecialContributions::$userNameUtils
private

Definition at line 63 of file SpecialContributions.php.

Referenced by __construct().

◆ $userOptionsLookup

UserOptionsLookup SpecialContributions::$userOptionsLookup
private

Definition at line 69 of file SpecialContributions.php.

Referenced by __construct().


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