Inheritance diagram for SpecialCiteThisPage:

[legend]

Collaboration diagram for SpecialCiteThisPage:

[legend]

Public Member Functions
	__construct ()

	citationTag ( $text, $params, Parser $parser)
	Implements the <citation> tag.

	execute ( $par)

	onSubmit (array $data)
	Process the form on POST submission.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requiresUnblock ()
	Whether this action cannot be executed by a blocked user.

	requiresWrite ()
	Whether this action requires the wiki not to be locked.

Public Member Functions inherited from FormSpecialPage
	onSuccess ()
	Do something exciting on successful processing of the form, most likely to show a confirmation message.

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.

	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.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}}.

	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,... $params)
	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).

Protected Member Functions
	alterForm (HTMLForm $form)
	Play with the HTMLForm if you need to more substantially.

	getDisplayFormat ()
	Get display format for the form.

	getFormFields ()
	Get an HTMLForm descriptor array.

	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 FormSpecialPage
	checkExecutePermissions (User $user)
	Called from execute() to check if the given user can perform this action.

	getForm ()
	Get the HTMLForm to control behavior.

	getMessagePrefix ()
	Get message prefix for HTMLForm.

	postText ()
	Add post-text to the form.

	preText ()
	Add pre-text to the form.

	setParameter ( $par)
	Maybe do something interesting with the subpage parameter.

	setReauthPostData (array $data)
	Preserve POST data across reauthentication.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	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.

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

Protected Attributes
Title bool	$title = false

Protected Attributes inherited from FormSpecialPage
string null	$par = null
	The sub-page of the special page.

array null	$reauthPostData = null
	POST data preserved across re-authentication.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Private Member Functions
	getContentText ()
	Get the content to parse.

	getParser ()

	getParserOptions ()
	Get the common ParserOptions for both parses.

	showCitations (Title $title, $revId)

Private Attributes
Parser	$citationParser

Additional Inherited Members
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.

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

Definition at line 5 of file SpecialCiteThisPage.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialCiteThisPage::__construct ( )

Definition at line 17 of file SpecialCiteThisPage.php.

Member Function Documentation

◆ alterForm()

SpecialCiteThisPage::alterForm ( HTMLForm $form )

protected

Play with the HTMLForm if you need to more substantially.

Parameters

HTMLForm $form

Reimplemented from FormSpecialPage.

Definition at line 34 of file SpecialCiteThisPage.php.

References HTMLForm\setMethod().

◆ citationTag()

SpecialCiteThisPage::citationTag	(		$text,
			$params,
		Parser	$parser )

Implements the <citation> tag.

This is a hack to allow content that is typically parsed using the page's timestamp/pagetitle to use the current request's time and title

Parameters

string	$text
array	$params
Parser	$parser

Returns: string

Definition at line 194 of file SpecialCiteThisPage.php.

References SpecialPage\getPageTitle(), and getParserOptions().

◆ execute()

SpecialCiteThisPage::execute ( $par )

Parameters

string $par

Reimplemented from FormSpecialPage.

Definition at line 24 of file SpecialCiteThisPage.php.

References FormSpecialPage\$par, SpecialPage\addHelpLink(), SpecialPage\getRequest(), SpecialPage\setHeaders(), and showCitations().

◆ getContentText()

SpecialCiteThisPage::getContentText ( )

private

Get the content to parse.

Returns: string

Definition at line 143 of file SpecialCiteThisPage.php.

References $wgContLanguageCode, and SpecialPage\msg().

Referenced by showCitations().

◆ getDisplayFormat()

SpecialCiteThisPage::getDisplayFormat ( )

protected

Get display format for the form.

See HTMLForm documentation for available values.

Since: 1.25

Returns: string

Reimplemented from FormSpecialPage.

Definition at line 211 of file SpecialCiteThisPage.php.

◆ getFormFields()

SpecialCiteThisPage::getFormFields ( )

protected

Get an HTMLForm descriptor array.

Returns: array

Reimplemented from FormSpecialPage.

Definition at line 38 of file SpecialCiteThisPage.php.

References FormSpecialPage\$par.

◆ getGroupName()

SpecialCiteThisPage::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 85 of file SpecialCiteThisPage.php.

◆ getParser()

SpecialCiteThisPage::getParser ( )

private

Returns: Parser

Definition at line 133 of file SpecialCiteThisPage.php.

References SpecialPage\getConfig().

Referenced by showCitations().

◆ getParserOptions()

SpecialCiteThisPage::getParserOptions ( )

private

Get the common ParserOptions for both parses.

Returns: ParserOptions

Definition at line 169 of file SpecialCiteThisPage.php.

References SpecialPage\getUser().

Referenced by citationTag(), and showCitations().

◆ onSubmit()

SpecialCiteThisPage::onSubmit ( array $data )

Process the form on POST submission.

Parameters

array	$data
HTMLForm \| null	$form	PhanCommentParamWithoutRealParam Many implementations don't have $form

Returns: bool|string|array|Status As documented for HTMLForm::trySubmit.

Reimplemented from FormSpecialPage.

Definition at line 54 of file SpecialCiteThisPage.php.

◆ prefixSearchSubpages()

SpecialCiteThisPage::prefixSearchSubpages	(	$search,
		$limit,
		$offset )

Return an array of subpages beginning with $search that this special page will accept.

Parameters

string	$search	Prefix to search for
int	$limit	Maximum number of results to return (usually 10)
int	$offset	Number of results to skip (usually 0)

Returns: string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 72 of file SpecialCiteThisPage.php.

References $title, and Title\canExist().

◆ requiresUnblock()

SpecialCiteThisPage::requiresUnblock ( )

Whether this action cannot be executed by a blocked user.

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 215 of file SpecialCiteThisPage.php.

◆ requiresWrite()

SpecialCiteThisPage::requiresWrite ( )

Whether this action requires the wiki not to be locked.

Returns: bool

Reimplemented from FormSpecialPage.

Definition at line 219 of file SpecialCiteThisPage.php.

◆ showCitations()

SpecialCiteThisPage::showCitations	(	Title	$title,
			$revId )

private

Definition at line 89 of file SpecialCiteThisPage.php.

References $title, getContentText(), Title\getLatestRevID(), SpecialPage\getOutput(), getParser(), getParserOptions(), and Title\getPrefixedText().

Referenced by execute().

Member Data Documentation

◆ $citationParser

Parser SpecialCiteThisPage::$citationParser

private

Definition at line 10 of file SpecialCiteThisPage.php.

◆ $title

Title bool SpecialCiteThisPage::$title = false

protected

Definition at line 15 of file SpecialCiteThisPage.php.

Referenced by prefixSearchSubpages(), and showCitations().

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

extensions/CiteThisPage/includes/SpecialCiteThisPage.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ alterForm()

◆ citationTag()

◆ execute()

◆ getContentText()

◆ getDisplayFormat()

◆ getFormFields()

◆ getGroupName()

◆ getParser()

◆ getParserOptions()

◆ onSubmit()

◆ prefixSearchSubpages()

◆ requiresUnblock()

◆ requiresWrite()

◆ showCitations()

Member Data Documentation

◆ $citationParser

◆ $title