Helper for asserting the structure of an XML dump stream. More...

Collaboration diagram for MediaWiki\Tests\Maintenance\DumpAsserter:

[legend]

Public Member Functions
	__construct ( $schemaVersion)
	DumpAsserts constructor.

	assertDumpEnd ( $name="mediawiki")
	Asserts that the xml reader is at the final closing tag of an xml file and closes the reader.

	assertDumpStart ( $fname, $skip_siteinfo=true)
	Opens an XML file to analyze and optionally skips past siteinfo.

	assertLogItem ( $id, $user_name, $user_id, $comment, $type, $subtype, $title, $parameters=[])
	asserts that the xml reader is at the beginning of a log entry and skips over it while analyzing it.

	assertNodeEnd ( $name, $skip=true)
	Asserts that the xml reader is at an closing element of given name, and optionally skips past it.

	assertNodeStart ( $name, $skip=true)
	Asserts that the xml reader is at an element of given name, and optionally skips past it.

	assertPageEnd ()
	Asserts that the xml reader is at the page's closing element and skips to the next element.

	assertPageStart ( $id, $ns, $name)
	Asserts that the xml reader is at the start of a page element and skips over the first tags, after checking them.

	assertRevision ( $id, $summary, $text_id, $text_bytes, $text_sha1, $text=false, $parentid=false, $model=CONTENT_MODEL_WIKITEXT, $format=CONTENT_FORMAT_WIKITEXT)
	Asserts that the xml reader is at a revision and checks its representation before skipping over it.

	assertText ( $id, $text_id, $text_bytes, $text)

	assertTextNode ( $name, $text, $skip_ws=true)
	Asserts that the xml reader is at an element of given tag that contains a given text, and skips over the element.

	skipPastNodeEnd ( $name)
	Step the current XML reader to the first element start after the node end of a given name.

	skipToNodeEnd ( $name)
	Step the current XML reader until node end of given name is found.

	skipWhitespace ()
	Steps the xml reader over white space.

Protected Attributes
string	$schemaVersion
	XML dump schema version.

XMLReader null	$xml = null
	Holds the XMLReader used for analyzing an XML dump.

Detailed Description

Helper for asserting the structure of an XML dump stream.

Definition at line 11 of file DumpAsserter.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Tests\Maintenance\DumpAsserter::__construct ( $schemaVersion )

DumpAsserts constructor.

Parameters

string $schemaVersion see XML_DUMP_SCHEMA_VERSION_XX

Definition at line 32 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\$schemaVersion.

Member Function Documentation

◆ assertDumpEnd()

MediaWiki\Tests\Maintenance\DumpAsserter::assertDumpEnd ( $name = "mediawiki" )

Asserts that the xml reader is at the final closing tag of an xml file and closes the reader.

Parameters

string $name (optional) the name of the final tag (e.g.: "mediawiki" for </mediawiki>)

Definition at line 103 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeEnd(), and MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace().

◆ assertDumpStart()

MediaWiki\Tests\Maintenance\DumpAsserter::assertDumpStart	(		$fname,
			$skip_siteinfo = true )

Opens an XML file to analyze and optionally skips past siteinfo.

Parameters

string	$fname	Name of file to analyze
bool	$skip_siteinfo	(optional) If true, step the xml reader to the first element after </siteinfo>

Definition at line 85 of file DumpAsserter.php.

References $fname, and MediaWiki\Tests\Maintenance\DumpAsserter\skipPastNodeEnd().

◆ assertLogItem()

MediaWiki\Tests\Maintenance\DumpAsserter::assertLogItem	(	$id,
		$user_name,
		$user_id,
		$comment,
		$type,
		$subtype,
		$title,
		$parameters = [] )

asserts that the xml reader is at the beginning of a log entry and skips over it while analyzing it.

Parameters

int	$id	Id of the log entry
string	$user_name	User name of the log entry's performer
int	$user_id	User id of the log entry 's performer
string \| null	$comment	Comment of the log entry. If null, the comment text is ignored.
string	$type	Type of the log entry
string	$subtype	Subtype of the log entry
string	$title	Title of the log entry's target
array	$parameters	(optional) unserialized data accompanying the log entry

Definition at line 315 of file DumpAsserter.php.

References $type, MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeStart(), MediaWiki\Tests\Maintenance\DumpAsserter\assertTextNode(), MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace(), and unserialize().

◆ assertNodeEnd()

MediaWiki\Tests\Maintenance\DumpAsserter::assertNodeEnd	(		$name,
			$skip = true )

Asserts that the xml reader is at an closing element of given name, and optionally skips past it.

Parameters

string	$name	The name of the closing element to check for (e.g.: "mediawiki" for </mediawiki>)
bool	$skip	(optional) if true, skip past the found element

Definition at line 148 of file DumpAsserter.php.

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\assertDumpEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertLogItem(), MediaWiki\Tests\Maintenance\DumpAsserter\assertPageEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertRevision(), MediaWiki\Tests\Maintenance\DumpAsserter\assertText(), and MediaWiki\Tests\Maintenance\DumpAsserter\assertTextNode().

◆ assertNodeStart()

MediaWiki\Tests\Maintenance\DumpAsserter::assertNodeStart	(		$name,
			$skip = true )

Asserts that the xml reader is at an element of given name, and optionally skips past it.

Parameters

string	$name	The name of the element to check for (e.g.: "mediawiki" for <mediawiki>)
bool	$skip	(optional) if true, skip past the found element

Definition at line 132 of file DumpAsserter.php.

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\assertLogItem(), MediaWiki\Tests\Maintenance\DumpAsserter\assertPageStart(), MediaWiki\Tests\Maintenance\DumpAsserter\assertRevision(), MediaWiki\Tests\Maintenance\DumpAsserter\assertText(), and MediaWiki\Tests\Maintenance\DumpAsserter\assertTextNode().

◆ assertPageEnd()

MediaWiki\Tests\Maintenance\DumpAsserter::assertPageEnd ( )

Asserts that the xml reader is at the page's closing element and skips to the next element.

Definition at line 206 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeEnd(), and MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace().

◆ assertPageStart()

MediaWiki\Tests\Maintenance\DumpAsserter::assertPageStart	(	$id,
		$ns,
		$name )

Asserts that the xml reader is at the start of a page element and skips over the first tags, after checking them.

Besides the opening page element, this function also checks for and skips over the title, ns, and id tags. Hence after this function, the xml reader is at the first revision of the current page.

Parameters

int	$id	Id of the page to assert
int	$ns	Number of namespage to assert
string	$name	Title of the current page

Definition at line 193 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeStart(), MediaWiki\Tests\Maintenance\DumpAsserter\assertTextNode(), and MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace().

◆ assertRevision()

MediaWiki\Tests\Maintenance\DumpAsserter::assertRevision	(	$id,
		$summary,
		$text_id,
		$text_bytes,
		$text_sha1,
		$text = false,
		$parentid = false,
		$model = CONTENT_MODEL_WIKITEXT,
		$format = CONTENT_FORMAT_WIKITEXT )

Asserts that the xml reader is at a revision and checks its representation before skipping over it.

Parameters

int	$id	Id of the revision
string	$summary	Summary of the revision
int	$text_id	Id of the revision's text
int	$text_bytes	Number of bytes in the revision's text
string	$text_sha1	The base36 SHA-1 of the revision's text
string \| bool	$text	(optional) The revision's string, or false to check for a revision stub
int \| bool	$parentid	(optional) id of the parent revision
string	$model	The expected content model id (default: CONTENT_MODEL_WIKITEXT)
string	$format	The expected format model id (default: CONTENT_FORMAT_WIKITEXT)

Definition at line 226 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeStart(), MediaWiki\Tests\Maintenance\DumpAsserter\assertText(), MediaWiki\Tests\Maintenance\DumpAsserter\assertTextNode(), and MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace().

◆ assertText()

MediaWiki\Tests\Maintenance\DumpAsserter::assertText	(	$id,
		$text_id,
		$text_bytes,
		$text )

Definition at line 273 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeStart(), and MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace().

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\assertRevision().

◆ assertTextNode()

MediaWiki\Tests\Maintenance\DumpAsserter::assertTextNode	(	$name,
		$text,
		$skip_ws = true )

Asserts that the xml reader is at an element of given tag that contains a given text, and skips over the element.

Parameters

string	$name	The name of the element to check for (e.g.: "mediawiki" for <mediawiki>...</mediawiki>)
string \| bool	$text	If string, check if it equals the elements text. If false, ignore the element's text
bool	$skip_ws	(optional) if true, skip past white spaces that trail the closing element.

Definition at line 167 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertNodeStart(), and MediaWiki\Tests\Maintenance\DumpAsserter\skipWhitespace().

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\assertLogItem(), MediaWiki\Tests\Maintenance\DumpAsserter\assertPageStart(), and MediaWiki\Tests\Maintenance\DumpAsserter\assertRevision().

◆ skipPastNodeEnd()

MediaWiki\Tests\Maintenance\DumpAsserter::skipPastNodeEnd ( $name )

Step the current XML reader to the first element start after the node end of a given name.

Parameters

string $name Name of the closing element to look for (e.g.: "mediawiki" when looking for </mediawiki>)

Returns: bool True if new element after the closing of $name could be found. false otherwise.

Definition at line 66 of file DumpAsserter.php.

References MediaWiki\Tests\Maintenance\DumpAsserter\skipToNodeEnd().

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\assertDumpStart().

◆ skipToNodeEnd()

MediaWiki\Tests\Maintenance\DumpAsserter::skipToNodeEnd ( $name )

Step the current XML reader until node end of given name is found.

Parameters

string $name Name of the closing element to look for (e.g.: "mediawiki" when looking for </mediawiki>)

Returns: bool True if the end node could be found. false otherwise.

Definition at line 44 of file DumpAsserter.php.

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\skipPastNodeEnd().

◆ skipWhitespace()

MediaWiki\Tests\Maintenance\DumpAsserter::skipWhitespace ( )

Steps the xml reader over white space.

Definition at line 116 of file DumpAsserter.php.

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\assertDumpEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertLogItem(), MediaWiki\Tests\Maintenance\DumpAsserter\assertPageEnd(), MediaWiki\Tests\Maintenance\DumpAsserter\assertPageStart(), MediaWiki\Tests\Maintenance\DumpAsserter\assertRevision(), MediaWiki\Tests\Maintenance\DumpAsserter\assertText(), and MediaWiki\Tests\Maintenance\DumpAsserter\assertTextNode().

Member Data Documentation

◆ $schemaVersion

string MediaWiki\Tests\Maintenance\DumpAsserter::$schemaVersion

protected

XML dump schema version.

Definition at line 25 of file DumpAsserter.php.

Referenced by MediaWiki\Tests\Maintenance\DumpAsserter\__construct().

◆ $xml

XMLReader null MediaWiki\Tests\Maintenance\DumpAsserter::$xml = null

protected

Holds the XMLReader used for analyzing an XML dump.

Definition at line 18 of file DumpAsserter.php.

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

tests/phpunit/maintenance/DumpAsserter.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ assertDumpEnd()

◆ assertDumpStart()

◆ assertLogItem()

◆ assertNodeEnd()

◆ assertNodeStart()

◆ assertPageEnd()

◆ assertPageStart()

◆ assertRevision()

◆ assertText()

◆ assertTextNode()

◆ skipPastNodeEnd()

◆ skipToNodeEnd()

◆ skipWhitespace()

Member Data Documentation

◆ $schemaVersion

◆ $xml