XmlDumpWriter Class Reference

Public Member Functions
	__construct ( $contentMode=self::WRITE_CONTENT, $schemaVersion=XML_DUMP_SCHEMA_VERSION_11, ?HookContainer $hookContainer=null, ?CommentStore $commentStore=null)
	closePage ()
	Closes a "<page>" section on the output stream.
	closeStream ()
	Closes the output stream with the closing root element.
	openPage ( $row)
	Opens a "<page>" section on the output stream, with data from the given database row.
	openStream ()
	Opens the XML output stream's root "<mediawiki>" element.
	writeContributor ( $id, $text, $indent=" ")
	writeLogItem ( $row)
	Dumps a "<logitem>" section on the output stream, with data filled in from the given database row.
	writeRevision ( $row, $slotRows=null)
	Dumps a "<revision>" section on the output stream, with data filled in from the given database row.
	writeTimestamp ( $timestamp, $indent=" ")
	writeUploads ( $row, $dumpContents=false)
	Warning! This data is potentially inconsistent.

Static Public Member Functions
static	canonicalTitle (Title $title)
	Return prefixed text form of title, but using the content language's canonical namespace.

Public Attributes
const	WRITE_CONTENT = 0
	Output serialized revision content.
const	WRITE_STUB = 1
	Only output subs for revision content.

Static Public Attributes
static string[]	$supportedSchemas
	the schema versions supported for output @final

Detailed Description

Definition at line 48 of file XmlDumpWriter.php.

Constructor & Destructor Documentation

__construct()

XmlDumpWriter::__construct	(		$contentMode = self::WRITE_CONTENT,
			$schemaVersion = XML_DUMP_SCHEMA_VERSION_11,
		?HookContainer	$hookContainer = null,
		?CommentStore	$commentStore = null )

Parameters

int	$contentMode	WRITE_CONTENT or WRITE_STUB.
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.
HookContainer | null	$hookContainer
CommentStore | null	$commentStore

Definition at line 104 of file XmlDumpWriter.php.

Member Function Documentation

canonicalTitle()

static XmlDumpWriter::canonicalTitle ( Title $title )

static

Return prefixed text form of title, but using the content language's canonical namespace.

This skips any special-casing such as gendered user namespaces – which while useful, are not yet listed in the XML "<siteinfo>" data so are unsafe in export.

Parameters

Title

$title

Returns

string

Since

1.18

Definition at line 743 of file XmlDumpWriter.php.

References MediaWiki\Title\Title\getNamespace(), MediaWiki\Title\Title\getPrefixedText(), MediaWiki\Title\Title\getText(), and MediaWiki\Linker\LinkTarget\isExternal().

closePage()

XmlDumpWriter::closePage

(

)

Closes a "<page>" section on the output stream.

Access: internal

Returns

string

Definition at line 297 of file XmlDumpWriter.php.

closeStream()

XmlDumpWriter::closeStream

(

)

Closes the output stream with the closing root element.

Call when finished dumping things.

Returns

string

Definition at line 251 of file XmlDumpWriter.php.

openPage()

XmlDumpWriter::openPage

(

$row

)

Opens a "<page>" section on the output stream, with data from the given database row.

Parameters

stdClass

$row

Returns

string

Definition at line 262 of file XmlDumpWriter.php.

References MediaWiki\Title\Title\isValidRedirectTarget().

openStream()

XmlDumpWriter::openStream

(

)

Opens the XML output stream's root "<mediawiki>" element.

This does not include an xml directive, so is safe to include as a subelement in a larger XML stream. Namespace and XML Schema references are included.

Output will be encoded in UTF-8.

Returns

string

Definition at line 141 of file XmlDumpWriter.php.

writeContributor()

XmlDumpWriter::writeContributor	(		$id,
			$text,
			$indent = "      " )

Parameters

int	$id
string	$text
string	$indent	Default to six spaces

Returns

string

Definition at line 647 of file XmlDumpWriter.php.

Referenced by writeLogItem(), and writeRevision().

writeLogItem()

XmlDumpWriter::writeLogItem

(

$row

)

Dumps a "<logitem>" section on the output stream, with data filled in from the given database row.

Parameters

stdClass

$row

Returns

string

Definition at line 592 of file XmlDumpWriter.php.

References writeContributor(), and writeTimestamp().

writeRevision()

XmlDumpWriter::writeRevision	(		$row,
			$slotRows = null )

Dumps a "<revision>" section on the output stream, with data filled in from the given database row.

Parameters

stdClass	$row
null | stdClass[]	$slotRows

Returns

string

Exceptions

RevisionAccessException

Definition at line 352 of file XmlDumpWriter.php.

References writeContributor(), and writeTimestamp().

writeTimestamp()

XmlDumpWriter::writeTimestamp	(		$timestamp,
			$indent = "      " )

Parameters

string	$timestamp
string	$indent	Default to six spaces

Returns

string

Definition at line 636 of file XmlDumpWriter.php.

References wfTimestamp().

Referenced by writeLogItem(), and writeRevision().

writeUploads()

XmlDumpWriter::writeUploads	(		$row,
			$dumpContents = false )

Warning! This data is potentially inconsistent.

:(

Parameters

stdClass	$row
bool	$dumpContents

Returns

string

Definition at line 665 of file XmlDumpWriter.php.

References NS_FILE.

Member Data Documentation

$supportedSchemas

string [] XmlDumpWriter::$supportedSchemas

static

Initial value:

= [
        XML_DUMP_SCHEMA_VERSION_10,
        XML_DUMP_SCHEMA_VERSION_11
    ]

the schema versions supported for output @final

Definition at line 66 of file XmlDumpWriter.php.

Referenced by MediaWiki\Api\ApiQuery\getAllowedParams().

WRITE_CONTENT

const XmlDumpWriter::WRITE_CONTENT = 0

Output serialized revision content.

Definition at line 51 of file XmlDumpWriter.php.

WRITE_STUB

const XmlDumpWriter::WRITE_STUB = 1

Only output subs for revision content.

Definition at line 54 of file XmlDumpWriter.php.

---

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

• includes/export/XmlDumpWriter.php