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)
	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
	$author_list = ""

	$buffer

	$dumpUploadFileContents = false

	$dumpUploads = false

	$list_authors = false

DumpOutput	$sink

	$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='')

	outputLogStream ( $resultset)

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

Detailed Description

Definition at line 33 of file Export.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

DatabaseBase	$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 84 of file Export.php.

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

Member Function Documentation

◆ allLogs()

WikiExporter::allLogs ( )

Definition at line 185 of file Export.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 120 of file Export.php.

References dumpFrom().

◆ closeStream()

WikiExporter::closeStream ( )

Definition at line 110 of file Export.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

$cond

Definition at line 208 of file Export.php.

References $res, array(), as, Revision\DELETED_USER, wfProfileIn(), and wfProfileOut().

Referenced by dumpFrom().

◆ dumpFrom()

WikiExporter::dumpFrom ( $cond = '' )

protected

Parameters

$cond string

Exceptions

MWException
Exception

Definition at line 243 of file Export.php.

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

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

◆ logsByRange()

WikiExporter::logsByRange	(	$start,
		$end
	)

Parameters

$start	int
$end	int

Definition at line 193 of file Export.php.

References dumpFrom().

◆ openStream()

WikiExporter::openStream ( )

Definition at line 105 of file Export.php.

References $output, and writer.

◆ outputLogStream()

WikiExporter::outputLogStream ( $resultset )

protected

Parameters

$resultset array

Definition at line 465 of file Export.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

$resultset ResultWrapper

Definition at line 430 of file Export.php.

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

Referenced by dumpFrom().

◆ pageByName()

WikiExporter::pageByName ( $name )

Parameters

$name string

Exceptions

MWException

Definition at line 167 of file Export.php.

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

Referenced by pagesByName().

◆ pageByTitle()

WikiExporter::pageByTitle ( $title )

Parameters

$title Title

Definition at line 157 of file Export.php.

References $title, and dumpFrom().

Referenced by pageByName().

◆ pagesByName()

WikiExporter::pagesByName ( $names )

Parameters

$names array

Definition at line 179 of file Export.php.

References $name, as, and pageByName().

◆ pagesByRange()

WikiExporter::pagesByRange	(	$start,
		$end
	)

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.

Definition at line 131 of file Export.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 146 of file Export.php.

References dumpFrom().

◆ schemaVersion()

static WikiExporter::schemaVersion ( )

static

Returns the export schema version.

Returns: string

Definition at line 64 of file Export.php.

Referenced by XmlDumpWriter\openStream(), XmlDumpWriter\schemaVersion(), 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

$sink mixed

Definition at line 101 of file Export.php.

References $sink.

Member Data Documentation

◆ $author_list

WikiExporter::$author_list = ""

Definition at line 35 of file Export.php.

Referenced by outputPageStream().

◆ $buffer

WikiExporter::$buffer

Definition at line 52 of file Export.php.

Referenced by __construct().

◆ $dumpUploadFileContents

WikiExporter::$dumpUploadFileContents = false

Definition at line 38 of file Export.php.

◆ $dumpUploads

WikiExporter::$dumpUploads = false

Definition at line 37 of file Export.php.

◆ $list_authors

WikiExporter::$list_authors = false

Definition at line 34 of file Export.php.

◆ $sink

DumpOutput WikiExporter::$sink

Definition at line 58 of file Export.php.

Referenced by setOutputSink().

◆ $text

WikiExporter::$text

Definition at line 54 of file Export.php.

Referenced by __construct().

◆ BUFFER

const WikiExporter::BUFFER = 0

Definition at line 46 of file Export.php.

Referenced by SpecialExport\doExport().

◆ CURRENT

const WikiExporter::CURRENT = 2

Definition at line 41 of file Export.php.

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

◆ FULL

const WikiExporter::FULL = 1

Definition at line 40 of file Export.php.

Referenced by TextPassDumperTest\checkpointHelper(), SpecialExport\doExport(), dumpFrom(), SpecialExport\execute(), TextPassDumper\processOption(), BackupDumperPageTest\testFullStubPlain(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), and BackupDumperPageTest\testXmlDumpsBackupUseCase().

◆ LOGS

const WikiExporter::LOGS = 8

Definition at line 43 of file Export.php.

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

◆ RANGE

const WikiExporter::RANGE = 16

Definition at line 44 of file Export.php.

Referenced by dumpFrom().

◆ STABLE

const WikiExporter::STABLE = 4

Definition at line 42 of file Export.php.

Referenced by dumpFrom().

◆ STREAM

const WikiExporter::STREAM = 1

Definition at line 47 of file Export.php.

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

◆ STUB

const WikiExporter::STUB = 1

Definition at line 50 of file Export.php.

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

◆ TEXT

const WikiExporter::TEXT = 0

Definition at line 49 of file Export.php.

Referenced by TextPassDumperTest\checkpointHelper(), BackupDumperPageTest\testFullTextPlain(), TextPassDumperTest\testPlain(), BackupDumperLoggerTest\testPlain(), TextPassDumperTest\testPrefetchPlain(), and BackupDumperLoggerTest\testXmlDumpsBackupUseCaseLogging().

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

includes/Export.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