MediaWiki  master
WikiExporter Class Reference
Collaboration diagram for WikiExporter:

Public Member Functions

 __construct ( $db, HookContainer $hookContainer, RevisionStore $revisionStore, TitleParser $titleParser, $history=self::CURRENT, $text=self::TEXT, $limitNamespaces=null)
 
 allLogs ()
 
 allPages ()
 Dumps a series of page and revision records for all pages in the database, either including complete history or only the most recent version. More...
 
 closeStream ()
 
 logsByRange ( $start, $end)
 
 openStream ()
 
 pageByName ( $name)
 
 pageByTitle (PageIdentity $page)
 
 pagesByName ( $names)
 
 pagesByRange ( $start, $end, $orderRevs)
 Dumps a series of page and revision records for those pages in the database falling within the page_id range given. More...
 
 revsByRange ( $start, $end)
 Dumps a series of page and revision records for those pages in the database with revisions falling within the rev_id range given. More...
 
 setOutputSink (&$sink)
 Set the DumpOutput or DumpFilter object which will receive various row objects and XML output for filtering. More...
 
 setSchemaVersion ( $schemaVersion)
 

Static Public Member Functions

static schemaVersion ()
 Returns the default export schema version, as defined by $wgXmlDumpSchemaVersion. More...
 

Public Attributes

string $author_list = ""
 
bool $dumpUploadFileContents = false
 
bool $dumpUploads = false
 
bool $list_authors = false
 Return distinct author list (when not returning full history) More...
 
DumpOutput $sink
 
int $text
 
const CURRENT = 2
 
const FULL = 1
 
const LOGS = 8
 
const RANGE = 16
 
const STABLE = 4
 
const STUB = XmlDumpWriter::WRITE_STUB
 
const TEXT = XmlDumpWriter::WRITE_CONTENT
 

Protected Member Functions

 do_list_authors ( $cond)
 Generates the distinct list of authors of an article Not called by default (depends on $this->list_authors) Can be set by Special:Export when not exporting whole history. More...
 
 dumpFrom ( $cond='', $orderRevs=false)
 
 dumpLogs ( $cond)
 
 dumpPages ( $cond, $orderRevs)
 
 finishPageStreamOutput ( $lastRow)
 Final page stream output, after all batches are complete. More...
 
 getSlotRowBatch ( $results, &$carry=null)
 Returns all slot rows for a revision. More...
 
 outputLogStream ( $resultset)
 
 outputPageStreamBatch ( $results, $lastRow)
 Runs through a query result set dumping page, revision, and slot records. More...
 

Protected Attributes

IDatabase $db
 
array int $history
 
array null $limitNamespaces
 
const BATCH_SIZE = 50000
 

Private Attributes

HookRunner $hookRunner
 
RevisionStore $revisionStore
 
TitleParser $titleParser
 
XmlDumpWriter $writer
 

Detailed Description

Definition at line 42 of file WikiExporter.php.

Constructor & Destructor Documentation

◆ __construct()

WikiExporter::__construct (   $db,
HookContainer  $hookContainer,
RevisionStore  $revisionStore,
TitleParser  $titleParser,
  $history = self::CURRENT,
  $text = self::TEXT,
  $limitNamespaces = null 
)
Parameters
IDatabase$db
HookContainer$hookContainer
RevisionStore$revisionStore
TitleParser$titleParser
int | array$historyOne of WikiExporter::FULL, WikiExporter::CURRENT, WikiExporter::RANGE or WikiExporter::STABLE, or an associative array:
  • offset: non-inclusive offset at which to start the query
  • limit: maximum number of rows to return
  • dir: "asc" or "desc" timestamp order
int$textOne of WikiExporter::TEXT or WikiExporter::STUB
null | array$limitNamespacesComma-separated list of namespace numbers to limit results

Definition at line 116 of file WikiExporter.php.

References $db, $history, $limitNamespaces, $revisionStore, $text, and $titleParser.

Member Function Documentation

◆ allLogs()

WikiExporter::allLogs ( )

Definition at line 248 of file WikiExporter.php.

References dumpFrom().

◆ allPages()

WikiExporter::allPages ( )

Dumps a series of page and revision records for all pages in the database, either including complete history or only the most recent version.

Definition at line 173 of file WikiExporter.php.

References dumpFrom().

◆ closeStream()

WikiExporter::closeStream ( )

Definition at line 163 of file WikiExporter.php.

◆ do_list_authors()

WikiExporter::do_list_authors (   $cond)
protected

Generates the distinct list of authors of an article Not called by default (depends on $this->list_authors) Can be set by Special:Export when not exporting whole history.

Parameters
string$cond

Definition at line 271 of file WikiExporter.php.

References $res, and $revQuery.

Referenced by dumpPages().

◆ dumpFrom()

WikiExporter::dumpFrom (   $cond = '',
  $orderRevs = false 
)
protected
Parameters
string$cond
bool$orderRevs
Exceptions
MWException
Exception

Definition at line 310 of file WikiExporter.php.

References dumpLogs(), and dumpPages().

Referenced by allLogs(), allPages(), logsByRange(), pageByName(), pageByTitle(), pagesByRange(), and revsByRange().

◆ dumpLogs()

WikiExporter::dumpLogs (   $cond)
protected
Parameters
string$cond
Exceptions
Exception

Definition at line 322 of file WikiExporter.php.

References BATCH_SIZE, LogEventsList\getExcludeClause(), CommentStore\getStore(), and outputLogStream().

Referenced by dumpFrom().

◆ dumpPages()

WikiExporter::dumpPages (   $cond,
  $orderRevs 
)
protected
Parameters
string$cond
bool$orderRevs
Exceptions
MWException
Exception

Definition at line 378 of file WikiExporter.php.

References $revQuery, BATCH_SIZE, do_list_authors(), finishPageStreamOutput(), and outputPageStreamBatch().

Referenced by dumpFrom().

◆ finishPageStreamOutput()

WikiExporter::finishPageStreamOutput (   $lastRow)
protected

Final page stream output, after all batches are complete.

Parameters
stdClass$lastRowthe last row output from the last batch (or null if none)

Definition at line 603 of file WikiExporter.php.

References $author_list.

Referenced by dumpPages().

◆ getSlotRowBatch()

WikiExporter::getSlotRowBatch (   $results,
$carry = null 
)
protected

Returns all slot rows for a revision.

Takes and returns a carry row from the last batch;

Parameters
IResultWrapper | array$results
null | stdClass&$carryA row carried over from the last call to getSlotRowBatch()
Returns
stdClass[]

Definition at line 576 of file WikiExporter.php.

Referenced by outputPageStreamBatch().

◆ logsByRange()

WikiExporter::logsByRange (   $start,
  $end 
)
Parameters
int$start
int$end

Definition at line 256 of file WikiExporter.php.

References dumpFrom().

◆ openStream()

WikiExporter::openStream ( )

Definition at line 158 of file WikiExporter.php.

◆ outputLogStream()

WikiExporter::outputLogStream (   $resultset)
protected
Parameters
IResultWrapper$resultset
Returns
int|null the log_id value of the last item output, or null if none

Definition at line 617 of file WikiExporter.php.

Referenced by dumpLogs().

◆ outputPageStreamBatch()

WikiExporter::outputPageStreamBatch (   $results,
  $lastRow 
)
protected

Runs through a query result set dumping page, revision, and slot records.

The result set should join the page, revision, slots, and content tables, and be sorted/grouped by page and revision to avoid duplicate page records in the output.

Parameters
IResultWrapper$results
stdClass$lastRowthe last row output from the previous call (or null if none)
Returns
stdClass the last row processed

Definition at line 517 of file WikiExporter.php.

References getSlotRowBatch(), and MWDebug\warning().

Referenced by dumpPages().

◆ pageByName()

WikiExporter::pageByName (   $name)
Parameters
string$name
Exceptions
MWException

Definition at line 228 of file WikiExporter.php.

References dumpFrom().

Referenced by pagesByName().

◆ pageByTitle()

WikiExporter::pageByTitle ( PageIdentity  $page)
Parameters
PageIdentity$page

Definition at line 218 of file WikiExporter.php.

References dumpFrom(), Page\PageReference\getDBkey(), and Page\PageReference\getNamespace().

◆ pagesByName()

WikiExporter::pagesByName (   $names)
Parameters
string[]$names

Definition at line 242 of file WikiExporter.php.

References pageByName().

◆ pagesByRange()

WikiExporter::pagesByRange (   $start,
  $end,
  $orderRevs 
)

Dumps a series of page and revision records for those pages in the database falling within the page_id range given.

Parameters
int$startInclusive lower limit (this id is included)
int$endExclusive upper limit (this id is not included) If 0, no upper limit.
bool$orderRevsorder revisions within pages in ascending order

Definition at line 185 of file WikiExporter.php.

References dumpFrom().

◆ revsByRange()

WikiExporter::revsByRange (   $start,
  $end 
)

Dumps a series of page and revision records for those pages in the database with revisions falling within the rev_id range given.

Parameters
int$startInclusive lower limit (this id is included)
int$endExclusive upper limit (this id is not included) If 0, no upper limit.

Definition at line 207 of file WikiExporter.php.

References dumpFrom().

◆ schemaVersion()

static WikiExporter::schemaVersion ( )
static

Returns the default export schema version, as defined by $wgXmlDumpSchemaVersion.

Returns
string

Definition at line 97 of file WikiExporter.php.

References $wgXmlDumpSchemaVersion.

Referenced by BackupDumper\__construct(), ApiQuery\getAllowedParams(), and BackupDumper\processOptions().

◆ setOutputSink()

WikiExporter::setOutputSink ( $sink)

Set the DumpOutput or DumpFilter object which will receive various row objects and XML output for filtering.

Filters can be chained or used as callbacks.

Parameters
DumpOutput | DumpFilter&$sink

Definition at line 154 of file WikiExporter.php.

References $sink.

◆ setSchemaVersion()

WikiExporter::setSchemaVersion (   $schemaVersion)
Parameters
string$schemaVersionwhich schema version the generated XML should comply to. One of the values from self::$supportedSchemas, using the XML_DUMP_SCHEMA_VERSION_XX constants.

Definition at line 143 of file WikiExporter.php.

Member Data Documentation

◆ $author_list

string WikiExporter::$author_list = ""

Definition at line 53 of file WikiExporter.php.

Referenced by finishPageStreamOutput().

◆ $db

IDatabase WikiExporter::$db
protected

Definition at line 76 of file WikiExporter.php.

Referenced by __construct().

◆ $dumpUploadFileContents

bool WikiExporter::$dumpUploadFileContents = false

Definition at line 50 of file WikiExporter.php.

◆ $dumpUploads

bool WikiExporter::$dumpUploads = false

Definition at line 47 of file WikiExporter.php.

◆ $history

array int WikiExporter::$history
protected

Definition at line 79 of file WikiExporter.php.

Referenced by __construct().

◆ $hookRunner

HookRunner WikiExporter::$hookRunner
private

Definition at line 91 of file WikiExporter.php.

◆ $limitNamespaces

array null WikiExporter::$limitNamespaces
protected

Definition at line 82 of file WikiExporter.php.

Referenced by __construct().

◆ $list_authors

bool WikiExporter::$list_authors = false

Return distinct author list (when not returning full history)

Definition at line 44 of file WikiExporter.php.

◆ $revisionStore

RevisionStore WikiExporter::$revisionStore
private

Definition at line 85 of file WikiExporter.php.

Referenced by __construct().

◆ $sink

DumpOutput WikiExporter::$sink

Definition at line 70 of file WikiExporter.php.

Referenced by setOutputSink().

◆ $text

int WikiExporter::$text

Definition at line 67 of file WikiExporter.php.

Referenced by __construct().

◆ $titleParser

TitleParser WikiExporter::$titleParser
private

Definition at line 88 of file WikiExporter.php.

Referenced by __construct().

◆ $writer

XmlDumpWriter WikiExporter::$writer
private

Definition at line 73 of file WikiExporter.php.

◆ BATCH_SIZE

const WikiExporter::BATCH_SIZE = 50000
protected

Definition at line 64 of file WikiExporter.php.

Referenced by dumpLogs(), and dumpPages().

◆ CURRENT

const WikiExporter::CURRENT = 2

◆ FULL

const WikiExporter::FULL = 1

◆ LOGS

const WikiExporter::LOGS = 8

Definition at line 58 of file WikiExporter.php.

Referenced by BackupDumper\dump(), and DumpBackup\execute().

◆ RANGE

const WikiExporter::RANGE = 16

Definition at line 59 of file WikiExporter.php.

Referenced by DumpBackup\execute().

◆ STABLE

const WikiExporter::STABLE = 4

Definition at line 57 of file WikiExporter.php.

Referenced by DumpBackup\execute().

◆ STUB

const WikiExporter::STUB = XmlDumpWriter::WRITE_STUB

Definition at line 62 of file WikiExporter.php.

Referenced by DumpBackup\execute().

◆ TEXT

const WikiExporter::TEXT = XmlDumpWriter::WRITE_CONTENT

Definition at line 61 of file WikiExporter.php.

Referenced by DumpBackup\execute().


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