SpecialExport Class Reference

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

Inheritance diagram for SpecialExport:

Collaboration diagram for SpecialExport:

List of all members.

Public Member Functions
	__construct ()
	execute ($par)
	Default execute method Checks user permissions, calls the function given in mFunction.
Public Attributes
	$doExport
	$pageLinkDepth
	$templates
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 36 of file SpecialExport.php.

---

Member Function Documentation

SpecialExport::doExport	(	$	page,
		$	history,
		$	list_authors,
		$	exportall
	)		[private]

Do the actual page exporting.

Parameters:

$page	String: 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 281 of file SpecialExport.php.

References $lb, $page, $title, 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:

$subPage

string|null

Reimplemented from SpecialPage.

Definition at line 40 of file SpecialExport.php.

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

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

References getLinks().

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

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

Returns:

array

Definition at line 531 of file SpecialExport.php.

References $dbr, $page, $result, $title, 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 496 of file SpecialExport.php.

References getLinks().

Referenced by doExport().

SpecialExport::getPagesFromCategory

(

$

title

)

[private]

Parameters:

$title

Title

Returns:

array

Definition at line 390 of file SpecialExport.php.

References $dbr, $n, $res, $title, $wgContLang, and wfGetDB().

Referenced by execute().

SpecialExport::getPagesFromNamespace

(

$

nsindex

)

[private]

Parameters:

$nsindex

int

Returns:

array

Definition at line 422 of file SpecialExport.php.

References $dbr, $n, $res, $wgContLang, 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 455 of file SpecialExport.php.

References getLinks().

Referenced by doExport().

SpecialExport::userCanOverrideExportDepth

(

)

[private]

Returns:

bool

Definition at line 268 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 468 of file SpecialExport.php.

References userCanOverrideExportDepth().

Referenced by execute().

---

Member Data Documentation

SpecialExport::$curonly [private]

Definition at line 33 of file SpecialExport.php.

SpecialExport::$doExport

Definition at line 33 of file SpecialExport.php.

SpecialExport::$images [private]

Definition at line 34 of file SpecialExport.php.

SpecialExport::$pageLinkDepth

Definition at line 33 of file SpecialExport.php.

SpecialExport::$templates

Definition at line 33 of file SpecialExport.php.

---

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

• includes/specials/SpecialExport.php