Collaboration diagram for CreditsAction:

[legend]

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.

	onView ()
	This is largely cadged from PageHistory::history.

Public Member Functions inherited from FormlessAction
	show ()

Public Member Functions inherited from 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 this action may perform database writes.

	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 ()
	Whether this action requires the wiki not to be locked.

	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.

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

Constructor & Destructor Documentation

◆ __construct()

CreditsAction::__construct	(	Article	$article,
		IContextSource	$context,
		LinkRenderer	$linkRenderer,
		UserFactory	$userFactory )

Parameters

Article	$article
IContextSource	$context
LinkRenderer	$linkRenderer
UserFactory	$userFactory

Definition at line 48 of file CreditsAction.php.

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

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

◆ getContributors()

CreditsAction::getContributors	(		$cnt,
			$showIfMax )

protected

Get a list of contributors of $article.

Parameters

int	$cnt	Maximum list of contributors to show
bool	$showIfMax	Whether to contributors if there more than $cnt

Returns: string Html

Definition at line 147 of file CreditsAction.php.

References $contributors, 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	$cnt	Maximum list of contributors to show
bool	$showIfMax	Whether to contributors if there more than $cnt

Returns: string Html

Definition at line 93 of file CreditsAction.php.

References getContributors().

Referenced by onView().

◆ getDescription()

CreditsAction::getDescription ( )

protected

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

Since: 1.17

Stability: stable: to override

Returns: string HTML

Reimplemented from Action.

Definition at line 63 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 59 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 230 of file CreditsAction.php.

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

Referenced by getContributors(), and userLink().

◆ onView()

CreditsAction::onView ( )

This is largely cadged from PageHistory::history.

Returns: string HTML

Reimplemented from FormlessAction.

Definition at line 72 of file CreditsAction.php.

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

◆ othersLink()

CreditsAction::othersLink ( )

protected

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

Returns: string HTML link

Definition at line 263 of file CreditsAction.php.

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

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

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

includes/actions/CreditsAction.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canShowRealUserName()

◆ getContributors()

◆ getCredits()

◆ getDescription()

◆ getName()

◆ link()

◆ onView()

◆ othersLink()

◆ userLink()