Collaboration diagram for WikiExporter:

[legend]

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.

	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 ( $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.

	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.

Static Public Member Functions
static	schemaVersion ()
	Returns the export schema version.

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)

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.

	dumpFrom ( $cond='', $orderRevs=false)

	outputLogStream ( $resultset)

	outputPageStream ( $resultset)
	Runs through a query result set dumping page and revision records.

Detailed Description

Definition at line 33 of file WikiExporter.php.

Constructor & Destructor Documentation

◆ __construct()

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	$history	One 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	$buffer	One of WikiExporter::BUFFER or WikiExporter::STREAM
int	$text	One of WikiExporter::TEXT or WikiExporter::STUB

Definition at line 91 of file WikiExporter.php.

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

Member Function Documentation

◆ allLogs()

WikiExporter::allLogs ( )

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

References dumpFrom().

◆ closeStream()

WikiExporter::closeStream ( )

Definition at line 117 of file WikiExporter.php.

References $output, and writer.

◆ 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

array $cond

Definition at line 223 of file WikiExporter.php.

References $res, as, and Revision\DELETED_USER.

Referenced by dumpFrom().

◆ dumpFrom()

WikiExporter::dumpFrom	(	$cond = `''`,
		$orderRevs = `false`
	)

protected

Parameters

string $cond

Exceptions

MWException
Exception

Definition at line 256 of file WikiExporter.php.

References $e, $tables, CURRENT, do_list_authors(), FULL, LogEventsList\getExcludeClause(), history, outputLogStream(), outputPageStream(), RANGE, STABLE, STREAM, STUB, and text.

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

◆ logsByRange()

WikiExporter::logsByRange	(	$start,
		$end
	)

Parameters

int	$start
int	$end

Definition at line 208 of file WikiExporter.php.

References dumpFrom().

◆ openStream()

WikiExporter::openStream ( )

Definition at line 112 of file WikiExporter.php.

References $output, and writer.

◆ outputLogStream()

WikiExporter::outputLogStream ( $resultset )

protected

Parameters

ResultWrapper $resultset

Definition at line 479 of file WikiExporter.php.

References $output, as, and writer.

Referenced by dumpFrom().

◆ outputPageStream()

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

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

Referenced by dumpFrom().

◆ pageByName()

WikiExporter::pageByName ( $name )

Parameters

string $name

Exceptions

MWException

Definition at line 182 of file WikiExporter.php.

References $name, $title, and pageByTitle().

Referenced by pagesByName().

◆ pageByTitle()

WikiExporter::pageByTitle ( $title )

Parameters

Title $title

Definition at line 172 of file WikiExporter.php.

References $title, and dumpFrom().

Referenced by pageByName().

◆ pagesByName()

WikiExporter::pagesByName ( $names )

Parameters

array $names

Definition at line 194 of file WikiExporter.php.

References $name, as, and 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	$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 139 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	$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 161 of file WikiExporter.php.

References dumpFrom().

◆ schemaVersion()

static WikiExporter::schemaVersion ( )

static

Returns the export schema version.

Returns: string

Definition at line 71 of file WikiExporter.php.

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

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

Definition at line 108 of file WikiExporter.php.

References $sink.

Member Data Documentation

◆ $author_list

string WikiExporter::$author_list = ""

Definition at line 44 of file WikiExporter.php.

Referenced by outputPageStream().

◆ $buffer

int WikiExporter::$buffer

Definition at line 59 of file WikiExporter.php.

Referenced by __construct().

◆ $dumpUploadFileContents

bool WikiExporter::$dumpUploadFileContents = false

Definition at line 41 of file WikiExporter.php.

◆ $dumpUploads

bool WikiExporter::$dumpUploads = false

Definition at line 38 of file WikiExporter.php.

◆ $list_authors

bool WikiExporter::$list_authors = false

Return distinct author list (when not returning full history)

Definition at line 35 of file WikiExporter.php.

◆ $sink

DumpOutput WikiExporter::$sink

Definition at line 65 of file WikiExporter.php.

Referenced by setOutputSink().

◆ $text

int WikiExporter::$text

Definition at line 62 of file WikiExporter.php.

Referenced by __construct().

◆ BUFFER

const WikiExporter::BUFFER = 0

Definition at line 52 of file WikiExporter.php.

Referenced by SpecialExport\doExport().

◆ CURRENT

const WikiExporter::CURRENT = 2

Definition at line 47 of file WikiExporter.php.

Referenced by SpecialExport\doExport(), dumpFrom(), SpecialExport\execute(), DumpBackup\execute(), BackupDumper\initProgress(), TextPassDumper\processOptions(), BackupDumperPageTest\testCurrentStubGzip(), and BackupDumperPageTest\testCurrentStubPlain().

◆ FULL

const WikiExporter::FULL = 1

Definition at line 46 of file WikiExporter.php.

Referenced by SpecialExport\doExport(), dumpFrom(), SpecialExport\execute(), DumpBackup\execute(), TextPassDumper\processOptions(), ExportTest\testPageByTitle(), TextPassDumperDatabaseTest\testPlain(), TextPassDumperDatabaseTest\testPrefetchPlain(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ LOGS

const WikiExporter::LOGS = 8

Definition at line 49 of file WikiExporter.php.

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

◆ RANGE

const WikiExporter::RANGE = 16

Definition at line 50 of file WikiExporter.php.

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

◆ STABLE

const WikiExporter::STABLE = 4

Definition at line 48 of file WikiExporter.php.

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

◆ STREAM

const WikiExporter::STREAM = 1

Definition at line 53 of file WikiExporter.php.

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

◆ STUB

const WikiExporter::STUB = 1

Definition at line 56 of file WikiExporter.php.

Referenced by dumpFrom(), DumpBackup\execute(), BackupDumperPageTest\testCurrentStubGzip(), BackupDumperPageTest\testCurrentStubPlain(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ TEXT

const WikiExporter::TEXT = 0

Definition at line 55 of file WikiExporter.php.

Referenced by DumpBackup\execute(), BackupDumperLoggerTest\testPlain(), TextPassDumperDatabaseTest\testPlain(), and TextPassDumperDatabaseTest\testPrefetchPlain().

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

includes/export/WikiExporter.php

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allLogs()

◆ allPages()

◆ closeStream()

◆ do_list_authors()

◆ dumpFrom()

◆ logsByRange()

◆ openStream()

◆ outputLogStream()

◆ outputPageStream()

◆ pageByName()

◆ pageByTitle()

◆ pagesByName()

◆ pagesByRange()

◆ revsByRange()

◆ schemaVersion()

◆ setOutputSink()

Member Data Documentation

◆ $author_list

◆ $buffer

◆ $dumpUploadFileContents

◆ $dumpUploads

◆ $list_authors

◆ $sink

◆ $text

◆ BUFFER

◆ CURRENT

◆ FULL

◆ LOGS

◆ RANGE

◆ STABLE

◆ STREAM

◆ STUB

◆ TEXT