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.
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'.
Private Member Functions
	doExport ($page, $history, $list_authors, $exportall)
	Do the actual page exporting.
	getImages ($inputPages, $pageSet)
	Expand a list of pages to include images used in those pages.
	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.
Private Attributes
	$curonly
	$images

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

SpecialExport::__construct ( )

Definition at line 35 of file SpecialExport.php.

Member Function Documentation

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, $title, array(), as, WikiExporter\BUFFER, WikiExporter\CURRENT, WikiExporter\FULL, getPageLinks(), getTemplates(), Title\newFromText(), WikiExporter\STREAM, wfGetDB(), wfGetLBFactory(), wfRestoreWarnings(), and wfSuppressWarnings().

Referenced by 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(), Xml\openElement(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), Xml\submitButton(), text, Linker\tooltipAndAccesskeyAttribs(), true, userCanOverrideExportDepth(), validateLinkDepth(), wfResetOutputBuffers(), wfTimestamp(), and wfTimestampNow().

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.

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(), and 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, $result, $title, array(), as, Title\makeTitle(), Title\newFromText(), and wfGetDB().

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

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

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, global, and wfGetDB().

Referenced by execute().

SpecialExport::getPagesFromNamespace ( $ nsindex ) [private]

Parameters:

$nsindex int

Returns:: array

Definition at line 436 of file SpecialExport.php.

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

Referenced by execute().

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

SpecialExport::userCanOverrideExportDepth ( ) [private]

Returns:: bool

Definition at line 292 of file SpecialExport.php.

References SpecialPage\getUser().

Referenced by execute(), and 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

SpecialExport::$curonly [private]

Definition at line 32 of file SpecialExport.php.

SpecialExport::$doExport

Definition at line 32 of file SpecialExport.php.

SpecialExport::$images [private]

Definition at line 33 of file SpecialExport.php.

SpecialExport::$pageLinkDepth

Definition at line 32 of file SpecialExport.php.

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

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation