ForeignTitle Class Reference

A simple, immutable structure to hold the title of a page on a foreign MediaWiki installation. More...

Collaboration diagram for ForeignTitle:

Public Member Functions
	__construct ( $namespaceId, $namespaceName, $pageName)
	Creates a new ForeignTitle object. More...
	__toString ()
	Returns a string representation of the title, for logging. More...
	getFullText ()
	getNamespaceId ()
	getNamespaceName ()
	getText ()
	isNamespaceIdKnown ()
	Do we know the namespace ID of the page on the foreign wiki? More...

Private Attributes
int null	$namespaceId
	Null if we don't know the namespace ID (e.g. More...
string	$namespaceName
string	$pageName

Detailed Description

A simple, immutable structure to hold the title of a page on a foreign MediaWiki installation.

Definition at line 28 of file ForeignTitle.php.

Constructor & Destructor Documentation

__construct()

ForeignTitle::__construct	(		$namespaceId,
			$namespaceName,
			$pageName
	)

Creates a new ForeignTitle object.

Parameters

int | null	$namespaceId	Null if the namespace ID is unknown (e.g. interwiki links)
string	$namespaceName
string	$pageName

Definition at line 47 of file ForeignTitle.php.

References $namespaceId, $namespaceName, and $pageName.

Member Function Documentation

__toString()

ForeignTitle::__toString

(

)

Returns a string representation of the title, for logging.

This is purely informative and must not be used programmatically. Use the appropriate ImportTitleFactory to generate the correct string representation for a given use.

Returns

string

Definition at line 106 of file ForeignTitle.php.

References $name, $pageName, and isNamespaceIdKnown().

getFullText()

ForeignTitle::getFullText

(

)

Returns

string

Definition at line 89 of file ForeignTitle.php.

References $pageName.

Referenced by NaiveImportTitleFactory\createTitleFromForeignTitle(), SubpageImportTitleFactory\createTitleFromForeignTitle(), and NaiveForeignTitleFactoryTest\testBasic().

getNamespaceId()

ForeignTitle::getNamespaceId

(

)

Returns

int

Exceptions

MWException

If isNamespaceIdKnown() is false, it does not make sense to call this function.

Definition at line 70 of file ForeignTitle.php.

References $namespaceId.

Referenced by NaiveImportTitleFactory\createTitleFromForeignTitle(), NaiveForeignTitleFactoryTest\testBasic(), and NamespaceAwareForeignTitleFactoryTest\testBasic().

getNamespaceName()

ForeignTitle::getNamespaceName

(

)

Returns

string

Definition at line 79 of file ForeignTitle.php.

References $namespaceName.

Referenced by NaiveImportTitleFactory\createTitleFromForeignTitle(), NaiveForeignTitleFactoryTest\testBasic(), and NamespaceAwareForeignTitleFactoryTest\testBasic().

getText()

ForeignTitle::getText

(

)

Returns

string

Definition at line 84 of file ForeignTitle.php.

References $pageName.

Referenced by NaiveImportTitleFactory\createTitleFromForeignTitle(), NamespaceImportTitleFactory\createTitleFromForeignTitle(), NaiveForeignTitleFactoryTest\testBasic(), and NamespaceAwareForeignTitleFactoryTest\testBasic().

isNamespaceIdKnown()

ForeignTitle::isNamespaceIdKnown

(

)

Do we know the namespace ID of the page on the foreign wiki?

Returns

bool

Definition at line 61 of file ForeignTitle.php.

Referenced by __toString(), NaiveImportTitleFactory\createTitleFromForeignTitle(), NaiveForeignTitleFactoryTest\testBasic(), and NamespaceAwareForeignTitleFactoryTest\testBasic().

Member Data Documentation

$namespaceId

int null ForeignTitle::$namespaceId

private

Null if we don't know the namespace ID (e.g.

interwiki links)

Definition at line 33 of file ForeignTitle.php.

Referenced by __construct(), and getNamespaceId().

$namespaceName

string ForeignTitle::$namespaceName

private

Definition at line 35 of file ForeignTitle.php.

Referenced by __construct(), and getNamespaceName().

$pageName

string ForeignTitle::$pageName

private

Definition at line 37 of file ForeignTitle.php.

Referenced by __construct(), __toString(), getFullText(), and getText().

---

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

• includes/title/ForeignTitle.php