MediaWiki  master
WikiExporter Class Reference
Collaboration diagram for WikiExporter:

Public Member Functions

 __construct ($db, $history=WikiExporter::CURRENT, $buffer=WikiExporter::BUFFER, $text=WikiExporter::TEXT)
 If using WikiExporter::STREAM to stream a large amount of data, provide a database connection which is not managed by LoadBalancer to read from: some history blob types will make additional queries to pull source data while the main query is still running. More...
 
 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 ($title)
 
 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...
 

Static Public Member Functions

static schemaVersion ()
 Returns the export schema version. More...
 

Public Attributes

string $author_list = ""
 
int $buffer
 
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 BUFFER = 0
 
const CURRENT = 2
 
const FULL = 1
 
const LOGS = 8
 
const RANGE = 16
 
const STABLE = 4
 
const STREAM = 1
 
const STUB = 1
 
const TEXT = 0
 

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)
 
 outputLogStream ($resultset)
 
 outputPageStream ($resultset)
 Runs through a query result set dumping page and revision records. More...
 

Detailed Description

Definition at line 35 of file WikiExporter.php.

Constructor & Destructor Documentation

WikiExporter::__construct (   $db,
  $history = WikiExporter::CURRENT,
  $buffer = WikiExporter::BUFFER,
  $text = WikiExporter::TEXT 
)

If using WikiExporter::STREAM to stream a large amount of data, provide a database connection which is not managed by LoadBalancer to read from: some history blob types will make additional queries to pull source data while the main query is still running.

Parameters
IDatabase$db
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$bufferOne of WikiExporter::BUFFER or WikiExporter::STREAM
int$textOne of WikiExporter::TEXT or WikiExporter::STUB

Definition at line 93 of file WikiExporter.php.

References $buffer, $text, history, text, and writer.

Member Function Documentation

WikiExporter::allLogs ( )

Definition at line 202 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 129 of file WikiExporter.php.

References dumpFrom().

WikiExporter::closeStream ( )

Definition at line 119 of file WikiExporter.php.

References $output, and writer.

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
array$cond

Definition at line 225 of file WikiExporter.php.

References $res, as, and Revision\DELETED_USER.

Referenced by dumpFrom().

WikiExporter::dumpFrom (   $cond = '',
  $orderRevs = false 
)
protected
WikiExporter::logsByRange (   $start,
  $end 
)
Parameters
int$start
int$end

Definition at line 210 of file WikiExporter.php.

References dumpFrom().

WikiExporter::openStream ( )

Definition at line 114 of file WikiExporter.php.

References $output, and writer.

WikiExporter::outputLogStream (   $resultset)
protected
Parameters
ResultWrapper$resultset

Definition at line 481 of file WikiExporter.php.

References $output, as, and writer.

Referenced by dumpFrom().

WikiExporter::outputPageStream (   $resultset)
protected

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

The result set should be sorted/grouped by page to avoid duplicate page records in the output.

Should be safe for streaming (non-buffered) queries, as long as it was made on a separate database connection not managed by LoadBalancer; some blob storage types will make queries to pull source data.

Parameters
ResultWrapper$resultset

Definition at line 446 of file WikiExporter.php.

References $author_list, $last, $output, as, and writer.

Referenced by dumpFrom().

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

Definition at line 184 of file WikiExporter.php.

References $name, $title, Title\newFromText(), and pageByTitle().

Referenced by pagesByName().

WikiExporter::pageByTitle (   $title)
Parameters
Title$title

Definition at line 174 of file WikiExporter.php.

References $title, and dumpFrom().

Referenced by pageByName().

WikiExporter::pagesByName (   $names)
Parameters
array$names

Definition at line 196 of file WikiExporter.php.

References $name, as, and pageByName().

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 141 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.

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 163 of file WikiExporter.php.

References dumpFrom().

static WikiExporter::schemaVersion ( )
static

Returns the export schema version.

Returns
string

Definition at line 73 of file WikiExporter.php.

Referenced by XmlDumpWriter\openStream(), and ExportDemoTest\testExportDemo().

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$sink

Definition at line 110 of file WikiExporter.php.

References $sink.

Member Data Documentation

string WikiExporter::$author_list = ""

Definition at line 46 of file WikiExporter.php.

Referenced by outputPageStream().

int WikiExporter::$buffer

Definition at line 61 of file WikiExporter.php.

Referenced by __construct().

bool WikiExporter::$dumpUploadFileContents = false

Definition at line 43 of file WikiExporter.php.

bool WikiExporter::$dumpUploads = false

Definition at line 40 of file WikiExporter.php.

bool WikiExporter::$list_authors = false

Return distinct author list (when not returning full history)

Definition at line 37 of file WikiExporter.php.

DumpOutput WikiExporter::$sink

Definition at line 67 of file WikiExporter.php.

Referenced by setOutputSink().

int WikiExporter::$text

Definition at line 64 of file WikiExporter.php.

Referenced by __construct().

const WikiExporter::BUFFER = 0

Definition at line 54 of file WikiExporter.php.

Referenced by SpecialExport\doExport().

const WikiExporter::LOGS = 8
const WikiExporter::RANGE = 16

Definition at line 52 of file WikiExporter.php.

Referenced by dumpFrom(), and DumpBackup\execute().

const WikiExporter::STABLE = 4

Definition at line 50 of file WikiExporter.php.

Referenced by dumpFrom(), and DumpBackup\execute().

const WikiExporter::STREAM = 1

Definition at line 55 of file WikiExporter.php.

Referenced by SpecialExport\doExport(), BackupDumper\dump(), and dumpFrom().


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