MediaWiki  1.23.1
CreditsAction Class Reference
Inheritance diagram for CreditsAction:
Collaboration diagram for CreditsAction:

Public Member Functions

 getCredits ( $cnt, $showIfMax=true)
 Get a list of contributors. More...
 
 getName ()
 Return the name of the action this object responds to. More...
 
 onView ()
 This is largely cadged from PageHistory::history. More...
 
- Public Member Functions inherited from FormlessAction
 execute (array $data=null, $captureErrors=true)
 Execute the action silently, not giving any output. More...
 
 onSubmit ( $data)
 
 onSuccess ()
 
 show ()
 The main action entry point. More...
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Constructor. More...
 
 execute ()
 Execute the action in a silent fashion: do not display anything or release any errors. More...
 
 getContext ()
 Get the IContextSource in use here. More...
 
 getLang ()
 Shortcut to get the user Language being used for this instance. More...
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance. More...
 
 getOutput ()
 Get the OutputPage being used for this instance. More...
 
 getRequest ()
 Get the WebRequest being used for this instance. More...
 
 getRestriction ()
 Get the permission required to perform this action. More...
 
 getSkin ()
 Shortcut to get the Skin being used for this instance. More...
 
 getTitle ()
 Shortcut to get the Title object from the page. More...
 
 getUser ()
 Shortcut to get the User being used for this instance. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user. More...
 
 requiresWrite ()
 Whether this action requires the wiki not to be locked. More...
 

Protected Member Functions

 getAuthor (Page $page)
 Get the last author with the last modification time. More...
 
 getContributors ( $cnt, $showIfMax)
 Get a list of contributors of $article. More...
 
 getDescription ()
 Returns the description that goes below the <h1> tag. More...
 
 link (User $user)
 Get a link to $user's user page. More...
 
 othersLink ()
 Get a link to action=credits of $article page. More...
 
 userLink (User $user)
 Get a link to $user's user page. More...
 
- Protected Member Functions inherited from FormlessAction
 getFormFields ()
 We don't want an HTMLForm. More...
 
- Protected Member Functions inherited from Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getPageTitle ()
 Returns the name that goes in the <h1> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists ( $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory ( $action, Page $page, IContextSource $context=null)
 Get an appropriate Action subclass for the given action. More...
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter. More...
 
- Protected Attributes inherited from Action
IContextSource $context
 IContextSource if specified; otherwise we'll use the Context from the Page $context. More...
 
array $fields
 The fields used to create the HTMLForm $fields. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action $page. More...
 

Detailed Description

Definition at line 29 of file CreditsAction.php.

Member Function Documentation

◆ getAuthor()

CreditsAction::getAuthor ( Page  $page)
protected

Get the last author with the last modification time.

Parameters
Page$page
Returns
string HTML

Definition at line 86 of file CreditsAction.php.

References Action\$page, $t, $timestamp, $user, false, Action\getLanguage(), WikiPage\getTimestamp(), WikiPage\getUserText(), Action\msg(), User\newFromName(), true, and userLink().

Referenced by getCredits().

◆ getContributors()

CreditsAction::getContributors (   $cnt,
  $showIfMax 
)
protected

Get a list of contributors of $article.

Parameters
int$cntMaximum list of contributors to show
bool$showIfMaxWhether to contributors if there more than $cnt
Returns
string html

Definition at line 109 of file CreditsAction.php.

References $count, $link, $s, $user, array(), as, Action\getLanguage(), global, link(), Action\msg(), othersLink(), and page.

Referenced by getCredits().

◆ getCredits()

CreditsAction::getCredits (   $cnt,
  $showIfMax = true 
)

Get a list of contributors.

Parameters
int$cntMaximum list of contributors to show
bool$showIfMaxWhether to contributors if there more than $cnt
Returns
string html

Definition at line 65 of file CreditsAction.php.

References $s, getAuthor(), getContributors(), page, wfProfileIn(), and wfProfileOut().

Referenced by onView().

◆ getDescription()

CreditsAction::getDescription ( )
protected

Returns the description that goes below the <h1> tag.

Returns
string

Reimplemented from Action.

Definition at line 35 of file CreditsAction.php.

References Action\msg().

◆ getName()

CreditsAction::getName ( )

Return the name of the action this object responds to.

Returns
string Lowercase name

Reimplemented from Action.

Definition at line 31 of file CreditsAction.php.

◆ link()

CreditsAction::link ( User  $user)
protected

Get a link to $user's user page.

Parameters
User$user
Returns
string Html

Definition at line 194 of file CreditsAction.php.

References Action\$page, $user, SpecialPage\getTitleFor(), global, and Linker\link().

Referenced by getContributors(), and userLink().

◆ onView()

CreditsAction::onView ( )

This is largely cadged from PageHistory::history.

Returns
string HTML

Reimplemented from FormlessAction.

Definition at line 44 of file CreditsAction.php.

References $s, array(), getCredits(), Action\msg(), page, Html\rawElement(), wfProfileIn(), and wfProfileOut().

◆ othersLink()

CreditsAction::othersLink ( )
protected

Get a link to action=credits of $article page.

Returns
string HTML link

Definition at line 232 of file CreditsAction.php.

References array(), Action\getTitle(), Linker\linkKnown(), and Action\msg().

Referenced by getContributors().

◆ userLink()

CreditsAction::userLink ( User  $user)
protected

Get a link to $user's user page.

Parameters
User$user
Returns
string Html

Definition at line 214 of file CreditsAction.php.

References $link, $user, User\getName(), global, link(), and Action\msg().

Referenced by getAuthor().


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