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

Public Member Functions

 __construct (Page $page, IContextSource $context, LinkRenderer $linkRenderer, UserFactory $userFactory)
 
 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
 show ()
 
- Public Member Functions inherited from Action
 __construct (Page $page, IContextSource $context=null)
 Only public since 1.21. More...
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators. More...
 
 doesWrites ()
 Indicates whether this action may perform database writes. More...
 
 getArticle ()
 Get a Article object. More...
 
 getContext ()
 Get the IContextSource in use here. 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...
 
 getWikiPage ()
 Get a WikiPage object. More...
 
 msg ( $key,... $params)
 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

 canShowRealUserName ()
 Whether we can display the user's real name (not a hidden pref) 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 Action
 checkCanExecute (User $user)
 Checks if the given user (identified by an object) can perform this action. More...
 
 getHookContainer ()
 
 getHookRunner ()
 
 getPageTitle ()
 Returns the name that goes in the \<h1\> page title. More...
 
 setHeaders ()
 Set output headers for noindexing etc. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 

Private Member Functions

 getAuthor ()
 Get the last author with the last modification time. More...
 

Private Attributes

LinkRenderer $linkRenderer
 
UserFactory $userFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from Action
static exists (string $name)
 Check if a given action is recognised, even if it's disabled. More...
 
static factory (string $action, Article $article, 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. More...
 
array $fields
 The fields used to create the HTMLForm. More...
 
WikiPage Article ImagePage CategoryPage Page $page
 Page on which we're performing the action. More...
 

Detailed Description

Definition at line 32 of file CreditsAction.php.

Constructor & Destructor Documentation

◆ __construct()

CreditsAction::__construct ( Page  $page,
IContextSource  $context,
LinkRenderer  $linkRenderer,
UserFactory  $userFactory 
)
Parameters
Page$page
IContextSource$context
LinkRenderer$linkRenderer
UserFactory$userFactory

Definition at line 46 of file CreditsAction.php.

References Action\$context, $linkRenderer, Action\$page, and $userFactory.

Member Function Documentation

◆ canShowRealUserName()

CreditsAction::canShowRealUserName ( )
protected

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

Since
1.24
Returns
bool

Definition at line 133 of file CreditsAction.php.

Referenced by getContributors(), link(), and userLink().

◆ getAuthor()

CreditsAction::getAuthor ( )
private

Get the last author with the last modification time.

Returns
string HTML

Definition at line 109 of file CreditsAction.php.

References $lang, Action\$page, $t, Action\getLanguage(), WikiPage\getTimestamp(), WikiPage\getUserText(), Action\getWikiPage(), Action\msg(), 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 144 of file CreditsAction.php.

References $contributors, $lang, $s, canShowRealUserName(), Action\getLanguage(), Action\getWikiPage(), link(), Action\msg(), and othersLink().

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 91 of file CreditsAction.php.

References $s, getAuthor(), and getContributors().

Referenced by onView().

◆ getDescription()

CreditsAction::getDescription ( )
protected

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

Since
1.17
Stability: stable
to override
Returns
string HTML

Reimplemented from Action.

Definition at line 61 of file CreditsAction.php.

References Action\msg().

◆ getName()

CreditsAction::getName ( )

Return the name of the action this object responds to.

Since
1.17
Returns
string Lowercase name

Reimplemented from Action.

Definition at line 57 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 227 of file CreditsAction.php.

References canShowRealUserName(), User\getId(), User\getName(), User\getRealName(), User\isAnon(), and Linker\userLink().

Referenced by getContributors(), and userLink().

◆ onView()

CreditsAction::onView ( )

This is largely cadged from PageHistory::history.

Returns
string HTML

Reimplemented from FormlessAction.

Definition at line 70 of file CreditsAction.php.

References $s, getCredits(), Action\getOutput(), Action\getWikiPage(), Action\msg(), and Html\rawElement().

◆ othersLink()

CreditsAction::othersLink ( )
protected

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

Returns
string HTML link

Definition at line 260 of file CreditsAction.php.

References Action\getTitle(), 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 245 of file CreditsAction.php.

References canShowRealUserName(), User\getName(), User\getRealName(), User\isAnon(), link(), and Action\msg().

Referenced by getAuthor().

Member Data Documentation

◆ $linkRenderer

LinkRenderer CreditsAction::$linkRenderer
private

Definition at line 35 of file CreditsAction.php.

Referenced by __construct().

◆ $userFactory

UserFactory CreditsAction::$userFactory
private

Definition at line 38 of file CreditsAction.php.

Referenced by __construct().


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