XmlDumpWriter Class Reference

List of all members.

Public Member Functions
	caseSetting ()
	closePage ()
	Closes a "<page>" section on the output stream.
	closeStream ()
	Closes the output stream with the closing root element.
	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.
	schemaVersion ()
	Returns the export schema version.
	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.

---

Detailed Description

Definition at line 472 of file Export.php.

---

Member Function Documentation

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 835 of file Export.php.

XmlDumpWriter::caseSetting

(

)

Returns:

string

Definition at line 549 of file Export.php.

XmlDumpWriter::closePage

(

)

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

Access:

private

Returns:

string

Definition at line 621 of file Export.php.

XmlDumpWriter::closeStream

(

)

Closes the output stream with the closing root element.

Call when finished dumping things.

Returns:

string

Definition at line 579 of file Export.php.

XmlDumpWriter::generator

(

)

Returns:

string

Definition at line 534 of file Export.php.

XmlDumpWriter::homelink

(

)

Returns:

string

Definition at line 542 of file Export.php.

XmlDumpWriter::namespaces

(

)

Returns:

string

Definition at line 559 of file Export.php.

XmlDumpWriter::openPage

(

$

row

)

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

Parameters:

$row

object

Returns:

string

Access:

private

Definition at line 591 of file Export.php.

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 493 of file Export.php.

XmlDumpWriter::schemaVersion

(

)

Returns the export schema version.

Deprecated:

in 1.20; use WikiExporter::schemaVersion() instead

Returns:

string

Definition at line 478 of file Export.php.

XmlDumpWriter::siteInfo

(

)

Returns:

string

Definition at line 511 of file Export.php.

XmlDumpWriter::sitename

(

)

Returns:

string

Definition at line 526 of file Export.php.

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

Parameters:

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

Returns:

string

Definition at line 752 of file Export.php.

XmlDumpWriter::writeLogItem

(

$

row

)

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

Parameters:

$row

object

Returns:

string

Access:

private

Definition at line 697 of file Export.php.

XmlDumpWriter::writeRevision

(

$

row

)

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

Parameters:

$row

object

Returns:

string

Access:

private

Definition at line 633 of file Export.php.

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

Parameters:

$timestamp	string
$indent	string Default to six spaces

Returns:

string

Definition at line 741 of file Export.php.

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

Parameters:

$file	File
$dumpContents	bool

Returns:

string

Definition at line 790 of file Export.php.

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

Warning! This data is potentially inconsistent.

:(

Parameters:

$row
$dumpContents	bool

Returns:

string

Definition at line 770 of file Export.php.

---

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

• includes/Export.php