Special page to act as an endpoint for accessing raw page data. More...

Inheritance diagram for SpecialPageData:

[legend]

Collaboration diagram for SpecialPageData:

[legend]

Public Member Functions
	__construct ()

	execute ( $subPage)

	isListed ()
	Whether this special page is listed in Special:SpecialPages Stable to override.

	setRequestHandler (PageDataRequestHandler $requestHandler)
	Sets the request handler to be used by the special page.

	showForm ()
	Shows an informative page to the user; Called when there is no page to output.

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.

	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 Stable to override.

	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}} Stable to override.

	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.

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

	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.

	setHookContainer (HookContainer $hookContainer)

	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
	initDependencies ()
	Initialize any un-initialized members from global context.

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.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have Stable to override.

	getCacheTTL ()
	Stable to override.

	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'.

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	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.

	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.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes! Stable to override.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

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

Private Member Functions
	newDefaultRequestHandler ()
	Creates a PageDataRequestHandler based on global defaults.

Private Attributes
PageDataRequestHandler null	$requestHandler = null

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).

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

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Detailed Description

Special page to act as an endpoint for accessing raw page data.

The web server should generally be configured to make this accessible via a canonical URL/URI, such as http://my.domain.org/data/main/Foo.

Definition at line 30 of file SpecialPageData.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialPageData::__construct ( )

Definition at line 37 of file SpecialPageData.php.

Member Function Documentation

◆ execute()

SpecialPageData::execute ( $subPage )

See also: SpecialWikibasePage::execute

Parameters

string | null $subPage

Exceptions

HttpError

Reimplemented from SpecialPage.

Definition at line 81 of file SpecialPageData.php.

References SpecialPage\getOutput(), SpecialPage\getRequest(), initDependencies(), and showForm().

◆ initDependencies()

SpecialPageData::initDependencies ( )

protected

Initialize any un-initialized members from global context.

In particular, this initializes $this->requestHandler

Definition at line 59 of file SpecialPageData.php.

References newDefaultRequestHandler().

Referenced by execute().

◆ isListed()

SpecialPageData::isListed ( )

Whether this special page is listed in Special:SpecialPages Stable to override.

Since: 1.3 (r3583)

Returns: bool

Reimplemented from SpecialPage.

Definition at line 101 of file SpecialPageData.php.

◆ newDefaultRequestHandler()

SpecialPageData::newDefaultRequestHandler ( )

private

Creates a PageDataRequestHandler based on global defaults.

Returns: PageDataRequestHandler

Definition at line 70 of file SpecialPageData.php.

Referenced by initDependencies().

◆ setRequestHandler()

SpecialPageData::setRequestHandler ( PageDataRequestHandler $requestHandler )

Sets the request handler to be used by the special page.

May be used when a particular instance of PageDataRequestHandler is already known, e.g. during testing.

If no request handler is set using this method, a default handler is created on demand by initDependencies().

Parameters

PageDataRequestHandler $requestHandler

Definition at line 51 of file SpecialPageData.php.

References $requestHandler.

◆ showForm()

SpecialPageData::showForm ( )

Shows an informative page to the user; Called when there is no page to output.

Definition at line 97 of file SpecialPageData.php.

References SpecialPage\getOutput().

Referenced by execute().

Member Data Documentation

◆ $requestHandler

PageDataRequestHandler null SpecialPageData::$requestHandler = null

private

Definition at line 35 of file SpecialPageData.php.

Referenced by setRequestHandler().

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

includes/specials/SpecialPageData.php

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members