MediaWiki  REL1_22
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

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

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$pageuser input on what page(s) to export
$historyMixed: one of the WikiExporter history export constants
$list_authorsBoolean: Whether to add distinct author list (when not returning full history)
$exportallBoolean: 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::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:
$inputPagesarray, list of titles to look up
$pageSetarray, 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$inputPagesArray of page titles
array$pageSet
string$table
array$fieldsArray 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:
$inputPagesarray
$pageSetarray
$depthint
Returns:
array

Definition at line 512 of file SpecialExport.php.

References array(), and getLinks().

Referenced by doExport().

SpecialExport::getPagesFromCategory ( title) [private]
Parameters:
$titleTitle
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:
$nsindexint
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:
$inputPagesarray, list of titles to look up
$pageSetarray, 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().

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:
$depthint
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: