MediaWiki  REL1_19
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
SpecialExport Class Reference
SpecialPage

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

Inheritance diagram for SpecialExport:
Inheritance graph
[legend]
Collaboration diagram for SpecialExport:
Collaboration graph
[legend]

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:
$pageString: user 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 265 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().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialExport::execute ( $  par)

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:
$parString subpage string, if one was specified

Reimplemented from SpecialPage.

Definition at line 40 of file SpecialExport.php.

References $dir, $limit, $out, $page, $t, $wgExportAllowAll, $wgExportAllowHistory, $wgExportAllowListContributors, $wgExportFromNamespaces, $wgExportMaxHistory, $wgExportMaxLinkDepth, $wgSitename, Xml\checkLabel(), Xml\closeElement(), WikiExporter\CURRENT, doExport(), Xml\element(), false, WikiExporter\FULL, SpecialPage\getOutput(), getPagesFromCategory(), getPagesFromNamespace(), SpecialPage\getRequest(), SpecialPage\getTitle(), Xml\inputLabel(), Title\makeTitleSafe(), Xml\namespaceSelector(), Xml\openElement(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), Xml\submitButton(), Linker\tooltipAndAccesskeyAttribs(), userCanOverrideExportDepth(), validateLinkDepth(), wfMsg(), wfMsgExt(), wfResetOutputBuffers(), wfTimestamp(), and wfTimestampNow().

Here is the call graph for this function:

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

References getLinks().

Here is the call graph for this function:

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

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

Definition at line 514 of file SpecialExport.php.

References $dbr, $page, $result, $title, Title\makeTitle(), Title\newFromText(), and wfGetDB().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

References getLinks().

Referenced by doExport().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialExport::getPagesFromCategory ( $  title) [private]
Parameters:
$titleTitle
Returns:
array

Definition at line 374 of file SpecialExport.php.

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

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialExport::getPagesFromNamespace ( $  nsindex) [private]
Parameters:
$nsindexint
Returns:
array

Definition at line 406 of file SpecialExport.php.

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

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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

References getLinks().

Referenced by doExport().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialExport::userCanOverrideExportDepth ( ) [private]
Returns:
bool

Definition at line 252 of file SpecialExport.php.

References SpecialPage\getUser().

Referenced by execute(), and validateLinkDepth().

Here is the call graph for this function:

Here is the caller graph for this function:

SpecialExport::validateLinkDepth ( $  depth) [private]

Validate link depth setting, if available.

Parameters:
$depthint
Returns:
int

Definition at line 452 of file SpecialExport.php.

References $wgExportMaxLinkDepth, and userCanOverrideExportDepth().

Referenced by execute().

Here is the call graph for this function:

Here is the caller graph for this function:

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: