MediaWiki REL1_32
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 ()
 
 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.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 getConfig ()
 Shortcut to get main config object.
 
 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.
 
 getTitle ( $subpage=false)
 Get a self-referential title object.
 
 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)
 Wrapper around wfMessage that sets the current context.
 
 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.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 run ( $subPage)
 Entry point.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time.
 
 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)
 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)
 Generates the subheading with links.
 
 getForm ()
 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.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 getCacheTTL ()
 
 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.
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 prefixSearchString ( $search, $limit, $offset)
 Perform a regular substring search for prefixSearchSubpages.
 
 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.
 
 $mIncludable
 
 $mIncluding
 
 $mName
 
 $mRestriction
 

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 32 of file SpecialContributions.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialContributions::__construct ( )

Definition at line 35 of file SpecialContributions.php.

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 280 of file SpecialContributions.php.

References $out, $user, SpecialPage\getLanguage(), SpecialPage\getLinkRenderer(), SpecialPage\getOutput(), getUserLinks(), in, SpecialPage\including(), User\isIP(), Block\newFromTarget(), NS_USER, LogEventsList\showLogExtract(), Block\TYPE_AUTO, Block\TYPE_RANGE, and wfEscapeWikiText().

Referenced by execute().

◆ execute()

SpecialContributions::execute (   $subPage)

◆ getForm()

SpecialContributions::getForm ( )
protected

Generates the namespace selector form with hidden attributes.

Returns
string HTML fragment

Definition at line 454 of file SpecialContributions.php.

References $input, $name, $value, as, SpecialPage\getContext(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getUser(), SpecialPage\msg(), text, true, 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'.

Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 773 of file SpecialContributions.php.

◆ getUserLinks()

static SpecialContributions::getUserLinks ( SpecialPage  $sp,
User  $target 
)
static

Links to different places.

Note
This function is also called in DeletedContributionsPage
Parameters
SpecialPage$spSpecialPage instance, for context
User$targetTarget user object
Returns
array

Definition at line 358 of file SpecialContributions.php.

References SpecialPage\$linkRenderer, $username, change, SpecialPage\getTitleFor(), page, and user.

Referenced by contributionsSub(), and DeletedContributionsPage\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 763 of file SpecialContributions.php.

References $user, User\newFromName(), and UserNamePrefixSearch\search().

Member Data Documentation

◆ $opts

SpecialContributions::$opts
protected

Definition at line 33 of file SpecialContributions.php.


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