MediaWiki master
|
Public Member Functions | |
__construct ( $db, CommentStore $commentStore, 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. | |
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. | |
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. | |
setOutputSink (&$sink) | |
Set the DumpOutput or DumpFilter object which will receive various row objects and XML output for filtering. | |
setSchemaVersion ( $schemaVersion) | |
Static Public Member Functions | |
static | schemaVersion () |
Returns the default export schema version, as defined by the XmlDumpSchemaVersion setting. | |
Public Attributes | |
string | $author_list = "" |
bool | $dumpUploadFileContents = false |
bool | $dumpUploads = false |
bool | $list_authors = false |
Return distinct author list (when not returning full history) | |
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. | |
dumpFrom ( $cond='', $orderRevs=false) | |
dumpLogs ( $cond) | |
dumpPages ( $cond, $orderRevs) | |
finishPageStreamOutput ( $lastRow) | |
Final page stream output, after all batches are complete. | |
getSlotRowBatch ( $results, &$carry=null) | |
Returns all slot rows for a revision. | |
outputLogStream ( $resultset) | |
outputPageStreamBatch ( $results, $lastRow) | |
Runs through a query result set dumping page, revision, and slot records. | |
Protected Attributes | |
IReadableDatabase | $db |
array int | $history |
array null | $limitNamespaces |
const | BATCH_SIZE = 10000 |
Definition at line 49 of file WikiExporter.php.
WikiExporter::__construct | ( | $db, | |
CommentStore | $commentStore, | ||
HookContainer | $hookContainer, | ||
RevisionStore | $revisionStore, | ||
TitleParser | $titleParser, | ||
$history = self::CURRENT, | |||
$text = self::TEXT, | |||
$limitNamespaces = null ) |
IReadableDatabase | $db | |
CommentStore | $commentStore | |
HookContainer | $hookContainer | |
RevisionStore | $revisionStore | |
TitleParser | $titleParser | |
int | array | $history | One of WikiExporter::FULL, WikiExporter::CURRENT, WikiExporter::RANGE or WikiExporter::STABLE, or an associative array:
|
int | $text | One of WikiExporter::TEXT or WikiExporter::STUB |
null | array | $limitNamespaces | List of namespace numbers to limit results |
Definition at line 126 of file WikiExporter.php.
References $limitNamespaces.
WikiExporter::allLogs | ( | ) |
Definition at line 259 of file WikiExporter.php.
References dumpFrom().
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 188 of file WikiExporter.php.
References dumpFrom().
WikiExporter::closeStream | ( | ) |
Definition at line 178 of file WikiExporter.php.
|
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.
string | $cond |
Definition at line 282 of file WikiExporter.php.
Referenced by dumpPages().
|
protected |
string | $cond | |
bool | $orderRevs |
Definition at line 310 of file WikiExporter.php.
References dumpLogs(), and dumpPages().
Referenced by allLogs(), allPages(), logsByRange(), pageByName(), pageByTitle(), pagesByRange(), and revsByRange().
|
protected |
string | $cond |
Definition at line 321 of file WikiExporter.php.
References outputLogStream().
Referenced by dumpFrom().
|
protected |
string | $cond | |
bool | $orderRevs |
Definition at line 366 of file WikiExporter.php.
References do_list_authors(), finishPageStreamOutput(), and outputPageStreamBatch().
Referenced by dumpFrom().
|
protected |
Final page stream output, after all batches are complete.
stdClass | $lastRow | the last row output from the last batch (or null if none) |
Definition at line 594 of file WikiExporter.php.
Referenced by dumpPages().
|
protected |
Returns all slot rows for a revision.
Takes and returns a carry row from the last batch;
IResultWrapper | array | $results | |
null | stdClass | &$carry | A row carried over from the last call to getSlotRowBatch() |
Definition at line 565 of file WikiExporter.php.
Referenced by outputPageStreamBatch().
WikiExporter::logsByRange | ( | $start, | |
$end ) |
int | $start | |
int | $end |
Definition at line 267 of file WikiExporter.php.
References dumpFrom().
WikiExporter::openStream | ( | ) |
Definition at line 173 of file WikiExporter.php.
|
protected |
IResultWrapper | $resultset |
Definition at line 608 of file WikiExporter.php.
Referenced by dumpLogs().
|
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.
IResultWrapper | $results | |
stdClass | null | $lastRow | the last row output from the previous call (or null if none) |
Definition at line 505 of file WikiExporter.php.
References getSlotRowBatch().
Referenced by dumpPages().
WikiExporter::pageByName | ( | $name | ) |
string | $name |
Definition at line 239 of file WikiExporter.php.
References dumpFrom().
Referenced by pagesByName().
WikiExporter::pageByTitle | ( | PageIdentity | $page | ) |
Definition at line 230 of file WikiExporter.php.
References dumpFrom(), MediaWiki\Page\PageReference\getDBkey(), and MediaWiki\Page\PageReference\getNamespace().
WikiExporter::pagesByName | ( | $names | ) |
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.
int | $start | Inclusive lower limit (this id is included) |
int | $end | Exclusive upper limit (this id is not included) If 0, no upper limit. |
bool | $orderRevs | order revisions within pages in ascending order |
Definition at line 200 of file WikiExporter.php.
References dumpFrom().
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.
int | $start | Inclusive lower limit (this id is included) |
int | $end | Exclusive upper limit (this id is not included) If 0, no upper limit. |
Definition at line 222 of file WikiExporter.php.
References dumpFrom().
|
static |
Returns the default export schema version, as defined by the XmlDumpSchemaVersion setting.
Definition at line 107 of file WikiExporter.php.
Referenced by MediaWiki\Api\ApiQuery\getAllowedParams().
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.
DumpOutput | DumpFilter | &$sink |
Definition at line 169 of file WikiExporter.php.
WikiExporter::setSchemaVersion | ( | $schemaVersion | ) |
string | $schemaVersion | which 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 158 of file WikiExporter.php.
string WikiExporter::$author_list = "" |
Definition at line 60 of file WikiExporter.php.
|
protected |
Definition at line 83 of file WikiExporter.php.
bool WikiExporter::$dumpUploadFileContents = false |
Definition at line 57 of file WikiExporter.php.
bool WikiExporter::$dumpUploads = false |
Definition at line 54 of file WikiExporter.php.
|
protected |
Definition at line 86 of file WikiExporter.php.
|
protected |
Definition at line 89 of file WikiExporter.php.
Referenced by __construct().
bool WikiExporter::$list_authors = false |
Return distinct author list (when not returning full history)
Definition at line 51 of file WikiExporter.php.
DumpOutput WikiExporter::$sink |
Definition at line 77 of file WikiExporter.php.
int WikiExporter::$text |
Definition at line 74 of file WikiExporter.php.
|
protected |
Definition at line 71 of file WikiExporter.php.
const WikiExporter::CURRENT = 2 |
Definition at line 63 of file WikiExporter.php.
const WikiExporter::FULL = 1 |
Definition at line 62 of file WikiExporter.php.
const WikiExporter::LOGS = 8 |
Definition at line 65 of file WikiExporter.php.
const WikiExporter::RANGE = 16 |
Definition at line 66 of file WikiExporter.php.
const WikiExporter::STABLE = 4 |
Definition at line 64 of file WikiExporter.php.
const WikiExporter::STUB = XmlDumpWriter::WRITE_STUB |
Definition at line 69 of file WikiExporter.php.
const WikiExporter::TEXT = XmlDumpWriter::WRITE_CONTENT |
Definition at line 68 of file WikiExporter.php.