A special page that allows users to export pages in a XML file. More...

Inherits MediaWiki\SpecialPage\SpecialPage.

Collaboration diagram for MediaWiki\Specials\SpecialExport:

[legend]

Public Member Functions
	__construct (IConnectionProvider $dbProvider, WikiExporterFactory $wikiExporterFactory, TitleFormatter $titleFormatter, LinksMigration $linksMigration)

	execute ( $par)
	Default execute method Checks user permissions.

Public Member Functions inherited from MediaWiki\SpecialPage\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.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	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 canonical, unlocalized name of this special page without namespace.

	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.

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages and designed for display in tabs.

	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.

	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.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Protected Member Functions
	doExport ( $page, $history, $list_authors, $exportall)
	Do the actual page exporting.

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

	getLinks ( $inputPages, $pageSet, $table, $fields, $join)
	Expand a list of pages to include items used in those pages.

	getPageLinks ( $inputPages, $pageSet, $depth)
	Expand a list of pages to include pages linked to from that page.

	getPagesFromCategory ( $title)

	getPagesFromNamespace ( $nsindex)

	getTemplates ( $inputPages, $pageSet)
	Expand a list of pages to include templates used in those pages.

	userCanOverrideExportDepth ()

	validateLinkDepth ( $depth)
	Validate link depth setting, if available.

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

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

	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.

	getAuthManager ()

	getCacheTTL ()

	getHookContainer ()

	getHookRunner ()

	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.

	getSpecialPageFactory ()

	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, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

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

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

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

Protected Attributes
	$curonly

	$doExport

	$pageLinkDepth

	$templates

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

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used as the message key for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\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	newSearchPage (User $user)
	Get the users preferred search page.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\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

A special page that allows users to export pages in a XML file.

Definition at line 45 of file SpecialExport.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Specials\SpecialExport::__construct	(	IConnectionProvider	$dbProvider,
		WikiExporterFactory	$wikiExporterFactory,
		TitleFormatter	$titleFormatter,
		LinksMigration	$linksMigration )

Parameters

IConnectionProvider	$dbProvider
WikiExporterFactory	$wikiExporterFactory
TitleFormatter	$titleFormatter
LinksMigration	$linksMigration

Definition at line 59 of file SpecialExport.php.

Member Function Documentation

◆ doExport()

MediaWiki\Specials\SpecialExport::doExport	(	$page,
		$history,
		$list_authors,
		$exportall )

protected

Do the actual page exporting.

Parameters

string	$page	User input on what page(s) to export
int	$history	One of the WikiExporter history export constants
bool	$list_authors	Whether to add distinct author list (when not returning full history)
bool	$exportall	Whether to export everything

Definition at line 377 of file SpecialExport.php.

References MediaWiki\Specials\SpecialExport\$pageLinkDepth, MediaWiki\SpecialPage\SpecialPage\getAuthority(), MediaWiki\Specials\SpecialExport\getPageLinks(), and MediaWiki\Specials\SpecialExport\getTemplates().

Referenced by MediaWiki\Specials\SpecialExport\execute().

◆ execute()

MediaWiki\Specials\SpecialExport::execute ( $subPage )

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stability: stable: to override

Parameters

string | null $subPage

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 72 of file SpecialExport.php.

◆ getGroupName()

MediaWiki\Specials\SpecialExport::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'.

Stability: stable: to override

Returns: string

Since: 1.21

Reimplemented from MediaWiki\SpecialPage\SpecialPage.

Definition at line 622 of file SpecialExport.php.

◆ getLinks()

MediaWiki\Specials\SpecialExport::getLinks	(	$inputPages,
		$pageSet,
		$table,
		$fields,
		$join )

protected

Expand a list of pages to include items used in those pages.

Parameters

array	$inputPages	Array of page titles
array	$pageSet
string[]	$table
array	$fields	Array of field names
array	$join

Returns: array

Definition at line 590 of file SpecialExport.php.

Referenced by MediaWiki\Specials\SpecialExport\getPageLinks(), and MediaWiki\Specials\SpecialExport\getTemplates().

◆ getPageLinks()

MediaWiki\Specials\SpecialExport::getPageLinks	(	$inputPages,
		$pageSet,
		$depth )

protected

Expand a list of pages to include pages linked to from that page.

Parameters

array	$inputPages
array	$pageSet
int	$depth

Returns: array

Definition at line 566 of file SpecialExport.php.

References MediaWiki\Specials\SpecialExport\getLinks().

Referenced by MediaWiki\Specials\SpecialExport\doExport().

◆ getPagesFromCategory()

MediaWiki\Specials\SpecialExport::getPagesFromCategory ( $title )

protected

Parameters

Title $title

Returns: string[]

Definition at line 452 of file SpecialExport.php.

References MediaWiki\MainConfigNames\ExportPagelistLimit, and MediaWiki\SpecialPage\SpecialPage\getConfig().

Referenced by MediaWiki\Specials\SpecialExport\execute().

◆ getPagesFromNamespace()

MediaWiki\Specials\SpecialExport::getPagesFromNamespace ( $nsindex )

protected

Parameters

int $nsindex

Returns: string[]

Definition at line 479 of file SpecialExport.php.

References MediaWiki\MainConfigNames\ExportPagelistLimit, and MediaWiki\SpecialPage\SpecialPage\getConfig().

Referenced by MediaWiki\Specials\SpecialExport\execute().

◆ getTemplates()

MediaWiki\Specials\SpecialExport::getTemplates	(		$inputPages,
			$pageSet )

protected

Expand a list of pages to include templates used in those pages.

Parameters

array	$inputPages	List of titles to look up
array	$pageSet	Associative array indexed by titles for output

Returns: array Associative array index by titles

Definition at line 505 of file SpecialExport.php.

References MediaWiki\Specials\SpecialExport\getLinks().

Referenced by MediaWiki\Specials\SpecialExport\doExport().

◆ userCanOverrideExportDepth()

MediaWiki\Specials\SpecialExport::userCanOverrideExportDepth ( )

protected

Returns: bool

Definition at line 364 of file SpecialExport.php.

References MediaWiki\SpecialPage\SpecialPage\getAuthority().

Referenced by MediaWiki\Specials\SpecialExport\validateLinkDepth().

◆ validateLinkDepth()

MediaWiki\Specials\SpecialExport::validateLinkDepth ( $depth )

protected

Validate link depth setting, if available.

Parameters

int | null $depth

Returns: int

Definition at line 538 of file SpecialExport.php.

References MediaWiki\MainConfigNames\ExportMaxLinkDepth, MediaWiki\SpecialPage\SpecialPage\getConfig(), and MediaWiki\Specials\SpecialExport\userCanOverrideExportDepth().

Referenced by MediaWiki\Specials\SpecialExport\execute().

Member Data Documentation

◆ $curonly

MediaWiki\Specials\SpecialExport::$curonly

protected

Definition at line 46 of file SpecialExport.php.

◆ $doExport

MediaWiki\Specials\SpecialExport::$doExport

protected

Definition at line 46 of file SpecialExport.php.

◆ $pageLinkDepth

MediaWiki\Specials\SpecialExport::$pageLinkDepth

protected

Definition at line 46 of file SpecialExport.php.

Referenced by MediaWiki\Specials\SpecialExport\doExport().

◆ $templates

MediaWiki\Specials\SpecialExport::$templates

protected

Definition at line 46 of file SpecialExport.php.

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

includes/specials/SpecialExport.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doExport()

◆ execute()

◆ getGroupName()

◆ getLinks()

◆ getPageLinks()

◆ getPagesFromCategory()

◆ getPagesFromNamespace()

◆ getTemplates()

◆ userCanOverrideExportDepth()

◆ validateLinkDepth()

Member Data Documentation

◆ $curonly

◆ $doExport

◆ $pageLinkDepth

◆ $templates