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

Inheritance diagram for SpecialExport:

Collaboration diagram for SpecialExport:

Public Member Functions
	__construct ()

	execute ( $par)
	Default execute method Checks user permissions, calls the function given in mFunction. More...

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='default', $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. More...

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError. More...

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError. More...

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

	getContext ()
	Gets the context this SpecialPage is executed in. More...

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

	getFile ()
	Get the file which will be included by SpecialPage::execute() if your extension is still stuck in the past and hasn't overridden the execute() method. More...

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

	getFullTitle ()
	Return the full title, including $par. More...

	getLang ()
	Shortcut to get user's language. More...

	getLanguage ()
	Shortcut to get user's language. More...

	getLocalName ()
	Get the localised name of the special page. More...

	getName ()
	Get the name of this Special Page. More...

	getOutput ()
	Get the OutputPage being used for this instance. More...

	getPageTitle ( $subpage=false)
	Get a self-referential title object. More...

	getRequest ()
	Get the WebRequest being used for this instance. More...

	getRestriction ()
	Get the permission that a user must have to execute this page. More...

	getSkin ()
	Shortcut to get the skin being used for this instance. More...

	getTitle ( $subpage=false)
	Get a self-referential title object. More...

	getUser ()
	Shortcut to get the User executing this instance. More...

	including ( $x=null)
	Whether the special page is being evaluated via transclusion. More...

	isCached ()
	Is this page cached? Expensive pages are cached or disabled in miser mode. More...

	isExpensive ()
	Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode. More...

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

	isListed ()
	Whether this special page is listed in Special:SpecialPages. More...

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes. More...

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages. More...

	msg ()
	Wrapper around wfMessage that sets the current context. More...

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

	requireLogin ( $reasonMsg=null, $titleMsg=null)
	If the user is not logged in, throws UserNotLoggedIn error. More...

	run ( $subPage)
	Entry point. More...

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

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

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time. More...

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

Public Attributes
	$doExport

	$pageLinkDepth

	$templates

Protected Member Functions
	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'. More...

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

	afterExecute ( $subPage)
	Gets called after. More...

	beforeExecute ( $subPage)
	Gets called before. More...

	getRobotPolicy ()
	Return the robot policy. More...

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

	getImages ( $inputPages, $pageSet)
	Expand a list of pages to include images used in those pages. More...

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

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

	getPagesFromCategory ( $title)

	getPagesFromNamespace ( $nsindex)

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

	userCanOverrideExportDepth ()

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

Private Attributes
	$curonly

	$images

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

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name. More...

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

	$mIncludable

	$mIncluding

	$mName

Detailed Description

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

Definition at line 31 of file SpecialExport.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialExport::__construct ( )

Definition at line 35 of file SpecialExport.php.

Member Function Documentation

◆ doExport()

SpecialExport::doExport	(	$page,
		$history,
		$list_authors,
		$exportall
	)

private

Do the actual page exporting.

Parameters

string	$page	user input on what page(s) to export
	$history	Mixed: one of the WikiExporter history export constants
	$list_authors	Boolean: Whether to add distinct author list (when not returning full history)
	$exportall	Boolean: Whether to export everything

Definition at line 305 of file SpecialExport.php.

References $lb, $pageLinkDepth, $title, array(), as, WikiExporter\BUFFER, WikiExporter\CURRENT, DB_SLAVE, WikiExporter\FULL, getPageLinks(), getTemplates(), Title\newFromText(), WikiExporter\STREAM, wfGetDB(), wfGetLBFactory(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by execute().

◆ execute()

SpecialExport::execute ( $subPage )

Default execute method Checks user permissions, calls the function given in mFunction.

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

Parameters

string | null $subPage

Reimplemented from SpecialPage.

Definition at line 39 of file SpecialExport.php.

References $dir, $form, $limit, $out, $t, array(), Xml\checkLabel(), Xml\closeElement(), WikiExporter\CURRENT, doExport(), Xml\element(), false, WikiExporter\FULL, SpecialPage\getOutput(), getPagesFromCategory(), getPagesFromNamespace(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), global, Xml\inputLabel(), Title\makeTitleSafe(), SpecialPage\msg(), Html\namespaceSelector(), NS_MAIN, Xml\openElement(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), Xml\submitButton(), text, Linker\tooltipAndAccesskeyAttribs(), true, TS_MW, userCanOverrideExportDepth(), validateLinkDepth(), wfResetOutputBuffers(), wfTimestamp(), and wfTimestampNow().

◆ getGroupName()

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

Returns: string

Since: 1.21

Reimplemented from SpecialPage.

Definition at line 585 of file SpecialExport.php.

◆ getImages()

SpecialExport::getImages	(	$inputPages,
		$pageSet
	)

private

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

Parameters

$inputPages	array, list of titles to look up
$pageSet	array, associative array indexed by titles for output

Returns: array associative array index by titles

Definition at line 533 of file SpecialExport.php.

References array(), getLinks(), and NS_FILE.

◆ getLinks()

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

private

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 552 of file SpecialExport.php.

References $dbr, $title, array(), as, DB_SLAVE, Title\makeTitle(), Title\newFromText(), and wfGetDB().

Referenced by getImages(), getPageLinks(), and getTemplates().

◆ getPageLinks()

SpecialExport::getPageLinks	(	$inputPages,
		$pageSet,
		$depth
	)

private

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

Parameters

$inputPages	array
$pageSet	array
$depth	int

Returns: array

Definition at line 512 of file SpecialExport.php.

References array(), and getLinks().

Referenced by doExport().

◆ getPagesFromCategory()

SpecialExport::getPagesFromCategory ( $title )

private

Parameters

$title Title

Returns: array

Definition at line 403 of file SpecialExport.php.

References $dbr, $n, $name, $res, $title, $wgContLang, array(), as, DB_SLAVE, global, and wfGetDB().

Referenced by execute().

◆ getPagesFromNamespace()

SpecialExport::getPagesFromNamespace ( $nsindex )

private

Parameters

$nsindex int

Returns: array

Definition at line 436 of file SpecialExport.php.

References $dbr, $n, $res, $wgContLang, array(), as, DB_SLAVE, global, and wfGetDB().

Referenced by execute().

◆ getTemplates()

SpecialExport::getTemplates	(	$inputPages,
		$pageSet
	)

private

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

Parameters

$inputPages	array, list of titles to look up
$pageSet	array, associative array indexed by titles for output

Returns: array associative array index by titles

Definition at line 470 of file SpecialExport.php.

References array(), and getLinks().

Referenced by doExport().

◆ userCanOverrideExportDepth()

SpecialExport::userCanOverrideExportDepth ( )

private

Returns: bool

Definition at line 292 of file SpecialExport.php.

References SpecialPage\getUser().

Referenced by execute(), and validateLinkDepth().

◆ validateLinkDepth()

SpecialExport::validateLinkDepth ( $depth )

private

Validate link depth setting, if available.

Parameters

$depth int

Returns: int

Definition at line 483 of file SpecialExport.php.

References global, and userCanOverrideExportDepth().

Referenced by execute().

Member Data Documentation

◆ $curonly

SpecialExport::$curonly

private

Definition at line 32 of file SpecialExport.php.

◆ $doExport

SpecialExport::$doExport

Definition at line 32 of file SpecialExport.php.

◆ $images

SpecialExport::$images

private

Definition at line 33 of file SpecialExport.php.

◆ $pageLinkDepth

SpecialExport::$pageLinkDepth

Definition at line 32 of file SpecialExport.php.

Referenced by doExport().

◆ $templates

SpecialExport::$templates

Definition at line 32 of file SpecialExport.php.

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

includes/specials/SpecialExport.php

Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ doExport()

◆ execute()

◆ getGroupName()

◆ getImages()

◆ getLinks()

◆ getPageLinks()

◆ getPagesFromCategory()

◆ getPagesFromNamespace()

◆ getTemplates()

◆ userCanOverrideExportDepth()

◆ validateLinkDepth()

Member Data Documentation

◆ $curonly

◆ $doExport

◆ $images

◆ $pageLinkDepth

◆ $templates