MediaWiki master
MediaWiki\Actions\CreditsAction Class Reference

Inherits MediaWiki\Actions\FormlessAction.

Collaboration diagram for MediaWiki\Actions\CreditsAction:

Public Member Functions

 __construct (Article $article, IContextSource $context, LinkRenderer $linkRenderer, UserFactory $userFactory)
 
 getCredits ( $cnt, $showIfMax=true)
 Get a list of contributors.
 
 getName ()
 Return the name of the action this object responds to.
Since
1.17
Returns
string Lowercase name

 
 onView ()
 This is largely cadged from PageHistory::history.
 
- Public Member Functions inherited from MediaWiki\Actions\FormlessAction
 show ()
 
- Public Member Functions inherited from MediaWiki\Actions\Action
 __construct (Article $article, IContextSource $context)
 Only public since 1.21.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 doesWrites ()
 Indicates whether POST requests handled by this action require write access to the wiki.
 
 getArticle ()
 Get a Article object.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getContext ()
 Get the IContextSource in use here.
 
 getLanguage ()
 Shortcut to get the user Language being used for this instance.
 
 getOutput ()
 Get the OutputPage being used for this instance.
 
 getRequest ()
 Get the WebRequest being used for this instance.
 
 getRestriction ()
 Get the permission required to perform this action.
 
 getSkin ()
 Shortcut to get the Skin being used for this instance.
 
 getTitle ()
 Shortcut to get the Title object from the page.
 
 getUser ()
 Shortcut to get the User being used for this instance.
 
 getWikiPage ()
 Get a WikiPage object.
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage()
 
 needsReadRights ()
 Indicates whether this action requires read rights.
 
 requiresUnblock ()
 Whether this action can still be executed by a blocked user.
 
 requiresWrite ()
 Indicates whether this action page write access to the wiki.
 
 setHookContainer (HookContainer $hookContainer)
 

Protected Member Functions

 canShowRealUserName ()
 Whether we can display the user's real name (not a hidden pref)
 
 getContributors ( $cnt, $showIfMax)
 Get a list of contributors of $article.
 
 getDescription ()
 Returns the description that goes below the <h1> element.
Since
1.17
Stability: stable
to override
Returns
string HTML

 
 link (User $user)
 Get a link to $user's user page.
 
 othersLink ()
 Get a link to action=credits of $article page.
 
 userLink (User $user)
 Get a link to $user's user page.
 
- Protected Member Functions inherited from MediaWiki\Actions\Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action.
 
 getHookContainer ()
 
 getHookRunner ()
 
 getPageTitle ()
 Returns the name that goes in the <h1> page title.
 
 setHeaders ()
 Set output headers for noindexing etc.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Additional Inherited Members

- Static Public Member Functions inherited from MediaWiki\Actions\Action
static factory (string $action, Article $article, ?IContextSource $context=null)
 Get an appropriate Action subclass for the given action.
 
static getActionName (IContextSource $context)
 Get the action that will be executed, not necessarily the one passed passed through the "action" request parameter.
 
- Protected Attributes inherited from MediaWiki\Actions\Action
IContextSource null $context
 IContextSource if specified; otherwise we'll use the Context from the Page.
 
array $fields
 The fields used to create the HTMLForm.
 

Detailed Description

Definition at line 41 of file CreditsAction.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Actions\CreditsAction::__construct ( Article $article,
IContextSource $context,
LinkRenderer $linkRenderer,
UserFactory $userFactory )
Parameters
Article$article
IContextSource$context
LinkRenderer$linkRenderer
UserFactory$userFactory

Definition at line 52 of file CreditsAction.php.

References MediaWiki\Actions\Action\$context.

Member Function Documentation

◆ canShowRealUserName()

MediaWiki\Actions\CreditsAction::canShowRealUserName ( )
protected

Whether we can display the user's real name (not a hidden pref)

Since
1.24
Returns
bool

Definition at line 142 of file CreditsAction.php.

References MediaWiki\MainConfigNames\HiddenPrefs.

Referenced by MediaWiki\Actions\CreditsAction\getContributors(), MediaWiki\Actions\CreditsAction\link(), and MediaWiki\Actions\CreditsAction\userLink().

◆ getContributors()

MediaWiki\Actions\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 153 of file CreditsAction.php.

References MediaWiki\Actions\CreditsAction\canShowRealUserName(), MediaWiki\Actions\Action\getLanguage(), MediaWiki\Actions\Action\getWikiPage(), MediaWiki\Actions\CreditsAction\link(), MediaWiki\Actions\Action\msg(), and MediaWiki\Actions\CreditsAction\othersLink().

Referenced by MediaWiki\Actions\CreditsAction\getCredits().

◆ getCredits()

MediaWiki\Actions\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 99 of file CreditsAction.php.

References MediaWiki\Actions\CreditsAction\getContributors().

Referenced by MediaWiki\Actions\CreditsAction\onView().

◆ getDescription()

MediaWiki\Actions\CreditsAction::getDescription ( )
protected

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

Since
1.17
Stability: stable
to override
Returns
string HTML

Reimplemented from MediaWiki\Actions\Action.

Definition at line 69 of file CreditsAction.php.

References MediaWiki\Actions\Action\msg().

◆ getName()

MediaWiki\Actions\CreditsAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from MediaWiki\Actions\Action.

Definition at line 64 of file CreditsAction.php.

◆ link()

MediaWiki\Actions\CreditsAction::link ( User $user)
protected

◆ onView()

MediaWiki\Actions\CreditsAction::onView ( )

This is largely cadged from PageHistory::history.

Returns
string HTML

Reimplemented from MediaWiki\Actions\FormlessAction.

Definition at line 78 of file CreditsAction.php.

References MediaWiki\Actions\CreditsAction\getCredits(), MediaWiki\Actions\Action\getOutput(), MediaWiki\Actions\Action\getWikiPage(), and MediaWiki\Actions\Action\msg().

◆ othersLink()

MediaWiki\Actions\CreditsAction::othersLink ( )
protected

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

Returns
string HTML link

Definition at line 269 of file CreditsAction.php.

References MediaWiki\Actions\Action\getTitle(), and MediaWiki\Actions\Action\msg().

Referenced by MediaWiki\Actions\CreditsAction\getContributors().

◆ userLink()

MediaWiki\Actions\CreditsAction::userLink ( User $user)
protected

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