Collaboration diagram for XmlDumpWriter:

[legend]

Public Member Functions
	caseSetting ()

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

	closeStream ()
	Closes the output stream with the closing root element.

	dbname ()

	generator ()

	homelink ()

	namespaces ()

	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.

	siteInfo ()

	sitename ()

	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)
	Dumps a "<revision>" section on the output stream, with data filled in from the given database row.

	writeTimestamp ( $timestamp, $indent=" ")

	writeUpload ( $file, $dumpContents=false)

	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.

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

Private Member Functions
	getBlobStore ()

	getRevisionStore ()

Private Attributes
Title null	$currentTitle = null
	Title of the currently processed page.

Detailed Description

Definition at line 32 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 528 of file XmlDumpWriter.php.

References $title.

◆ caseSetting()

XmlDumpWriter::caseSetting ( )

Returns: string

Definition at line 132 of file XmlDumpWriter.php.

References $wgCapitalLinks.

Referenced by siteInfo().

◆ closePage()

XmlDumpWriter::closePage ( )

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

Access:\n private

Returns: string

Definition at line 209 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 165 of file XmlDumpWriter.php.

◆ dbname()

XmlDumpWriter::dbname ( )

Returns: string

Definition at line 109 of file XmlDumpWriter.php.

References $wgDBname.

Referenced by siteInfo().

◆ generator()

XmlDumpWriter::generator ( )

Returns: string

Definition at line 117 of file XmlDumpWriter.php.

References $wgVersion.

Referenced by siteInfo().

◆ getBlobStore()

XmlDumpWriter::getBlobStore ( )

private

Returns: SqlBlobStore

Definition at line 229 of file XmlDumpWriter.php.

Referenced by writeRevision().

◆ getRevisionStore()

XmlDumpWriter::getRevisionStore ( )

private

Returns: RevisionStore

Definition at line 222 of file XmlDumpWriter.php.

Referenced by writeRevision().

◆ homelink()

XmlDumpWriter::homelink ( )

Returns: string

Definition at line 125 of file XmlDumpWriter.php.

Referenced by siteInfo().

◆ namespaces()

XmlDumpWriter::namespaces ( )

Returns: string

Definition at line 142 of file XmlDumpWriter.php.

References $title, and as.

◆ openPage()

XmlDumpWriter::openPage ( $row )

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

Parameters

object $row

Returns: string

Definition at line 176 of file XmlDumpWriter.php.

References $out, and 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 58 of file XmlDumpWriter.php.

References siteInfo().

◆ siteInfo()

XmlDumpWriter::siteInfo ( )

Returns: string

Definition at line 85 of file XmlDumpWriter.php.

References caseSetting(), dbname(), generator(), homelink(), namespaces, and sitename().

Referenced by openStream().

◆ sitename()

XmlDumpWriter::sitename ( )

Returns: string

Definition at line 101 of file XmlDumpWriter.php.

References $wgSitename.

Referenced by siteInfo().

◆ writeContributor()

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

Parameters

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

Returns: string

Definition at line 442 of file XmlDumpWriter.php.

References $out.

Referenced by writeLogItem(), writeRevision(), and writeUpload().

◆ writeLogItem()

XmlDumpWriter::writeLogItem ( $row )

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

Parameters

object $row

Returns: string

Access:\n private

Definition at line 387 of file XmlDumpWriter.php.

References $out, $title, LogPage\DELETED_ACTION, LogPage\DELETED_COMMENT, LogPage\DELETED_USER, writeContributor(), and writeTimestamp().

◆ writeRevision()

XmlDumpWriter::writeRevision ( $row )

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

Parameters

object $row

Returns: string

Access:\n private

Definition at line 241 of file XmlDumpWriter.php.

References $content, $out, $rev, Revision\DELETED_COMMENT, Revision\DELETED_TEXT, Revision\DELETED_USER, getBlobStore(), getRevisionStore(), Revision\getRevisionText(), wfLogWarning(), writeContributor(), and writeTimestamp().

◆ writeTimestamp()

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

Parameters

string	$timestamp
string	$indent	Default to six spaces

Returns: string

Definition at line 431 of file XmlDumpWriter.php.

References wfTimestamp().

Referenced by writeLogItem(), writeRevision(), and writeUpload().

◆ writeUpload()

XmlDumpWriter::writeUpload	(	$file,
		$dumpContents = `false`
	)

Parameters

File	$file
bool	$dumpContents

Returns: string

Definition at line 480 of file XmlDumpWriter.php.

References $file, File\DELETED_COMMENT, writeContributor(), and writeTimestamp().

Referenced by writeUploads().

◆ writeUploads()

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

Warning! This data is potentially inconsistent.

:(

Parameters

object	$row
bool	$dumpContents

Returns: string

Definition at line 460 of file XmlDumpWriter.php.

References $out, as, NS_FILE, wfLocalFile(), and writeUpload().

Member Data Documentation

◆ $currentTitle

Title null XmlDumpWriter::$currentTitle = null

private

Title of the currently processed page.

Definition at line 46 of file XmlDumpWriter.php.

◆ $supportedSchemas

string [] XmlDumpWriter::$supportedSchemas

static

Initial value:

= [
        XML_DUMP_SCHEMA_VERSION_10,
    ]

the schema versions supported for output @final

Definition at line 37 of file XmlDumpWriter.php.

Referenced by MediaWiki\Tests\Maintenance\BackupDumperPageTest\schemaVersionProvider().

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

includes/export/XmlDumpWriter.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ canonicalTitle()

◆ caseSetting()

◆ closePage()

◆ closeStream()

◆ dbname()

◆ generator()

◆ getBlobStore()

◆ getRevisionStore()

◆ homelink()

◆ namespaces()

◆ openPage()

◆ openStream()

◆ siteInfo()

◆ sitename()

◆ writeContributor()

◆ writeLogItem()

◆ writeRevision()

◆ writeTimestamp()

◆ writeUpload()

◆ writeUploads()

Member Data Documentation

◆ $currentTitle

◆ $supportedSchemas