MediaWiki  REL1_24
Public Member Functions | Static Public Member Functions
XmlDumpWriter Class Reference
Dump

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

XmlDumpWriter::caseSetting ( )
Returns:
string

Definition at line 570 of file Export.php.

References array(), Xml\element(), and Title\newMainPage().

XmlDumpWriter::closePage ( )

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

Access:
private
Returns:
string

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

XmlDumpWriter::dbname ( )
Returns:
string

Definition at line 547 of file Export.php.

XmlDumpWriter::generator ( )
Returns:
string

Definition at line 555 of file Export.php.

XmlDumpWriter::homelink ( )
Returns:
string

Definition at line 563 of file Export.php.

XmlDumpWriter::namespaces ( )
Returns:
string

Definition at line 580 of file Export.php.

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

XmlDumpWriter::schemaVersion ( )

Returns the export schema version.

Deprecated:
since 1.20; use WikiExporter::schemaVersion() instead
Returns:
string

Definition at line 480 of file Export.php.

XmlDumpWriter::siteInfo ( )
Returns:
string

Definition at line 523 of file Export.php.

XmlDumpWriter::sitename ( )
Returns:
string

Definition at line 539 of file Export.php.

XmlDumpWriter::writeContributor ( $  id,
$  text,
$  indent = "      " 
)
Parameters:
int$id
string$text
string$indentDefault to six spaces
Returns:
string

Definition at line 799 of file Export.php.

References $out, Xml\element(), Xml\elementClean(), and IP\isValid().

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:
private

Definition at line 744 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:
object$row
Returns:
string
Access:
private

Definition at line 656 of file Export.php.

XmlDumpWriter::writeTimestamp ( $  timestamp,
$  indent = "      " 
)
Parameters:
string$timestamp
string$indentDefault to six spaces
Returns:
string

Definition at line 788 of file Export.php.

XmlDumpWriter::writeUpload ( $  file,
$  dumpContents = false 
)
Parameters:
File$file
bool$dumpContents
Returns:
string

Definition at line 837 of file Export.php.

Referenced by writeUploads().

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

Warning! This data is potentially inconsistent.

:(

Parameters:
object$row
bool$dumpContents
Returns:
string

Definition at line 817 of file Export.php.

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

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