This is a utility class with only static functions for dealing with namespaces that encodes all the "magic" behaviors of them based on index. More...

Static Public Member Functions
static	canTalk ($index)
	Can this namespace ever have a talk namespace?
static	equals ($ns1, $ns2)
	Returns whether the specified namespaces are the same namespace.
static	exists ($index)
	Returns whether the specified namespace exists.
static	getAssociated ($index)
	Get the associated namespace.
static	getCanonicalIndex ($name)
	Returns the index for a given canonical name, or NULL The input must be converted to lower case first.
static	getCanonicalName ($index)
	Returns the canonical (English) name for a given index.
static	getCanonicalNamespaces ($rebuild=false)
	Returns array of all defined namespaces with their canonical (English) names.
static	getContentNamespaces ()
	Get a list of all namespace indices which are considered to contain content.
static	getNamespaceContentModel ($index)
	Get the default content model for a namespace This does not mean that all pages in that namespace have the model.
static	getSubject ($index)
	Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
static	getSubjectNamespaces ()
	List all namespace indices which are considered subject, aka not a talk or special namespace.
static	getTalk ($index)
	Get the talk namespace index for a given namespace.
static	getTalkNamespaces ()
	List all namespace indices which are considered talks, aka not a subject or special namespace.
static	getValidNamespaces ()
	Returns an array of the namespaces (by integer id) that exist on the wiki.
static	hasGenderDistinction ($index)
	Does the namespace (potentially) have different aliases for different genders.
static	hasSubpages ($index)
	Does the namespace allow subpages?
static	isCapitalized ($index)
	Is the namespace first-letter capitalized?
static	isContent ($index)
	Does this namespace contain content, for the purposes of calculating statistics, etc?
static	isMain ($index)
static	isMovable ($index)
	Can pages in the given namespace be moved?
static	isNonincludable ($index)
	It is not possible to use pages from this namespace as template?
static	isSubject ($index)
	Is the given namespace is a subject (non-talk) namespace?
static	isTalk ($index)
	Is the given namespace a talk namespace?
static	isWatchable ($index)
	Can pages in a namespace be watched?
static	subjectEquals ($ns1, $ns2)
	Returns whether the specified namespaces share the same subject.
Static Private Member Functions
static	isMethodValidFor ($index, $method)
	Throw an exception when trying to get the subject or talk page for a given namespace where it does not make sense.
Static Private Attributes
static	$alwaysCapitalizedNamespaces = array( NS_SPECIAL, NS_USER, NS_MEDIAWIKI )
	These namespaces should always be first-letter capitalized, now and forevermore.

Detailed Description

This is a utility class with only static functions for dealing with namespaces that encodes all the "magic" behaviors of them based on index.

The textual names of the namespaces are handled by Language.php.

These are synonyms for the names given in the language file Users and translators should not change them

Definition at line 33 of file Namespace.php.

Member Function Documentation

static MWNamespace::canTalk ( $ index ) [static]

Can this namespace ever have a talk namespace?

Parameters:

int $index namespace index

Returns:: bool

Definition at line 293 of file Namespace.php.

Referenced by ChangesFeed\generateFeed().

static MWNamespace::equals	(	$	ns1,
		$	ns2
	)		`[static]`

Returns whether the specified namespaces are the same namespace.

Note:: It's possible that in the future we may start using something other than just namespace indexes. Under that circumstance making use of this function rather than directly doing comparison will make sure that code will not potentially break.

Parameters:

int	$ns1	The first namespace index
int	$ns2	The second namespace index

Returns:: bool

Since:: 1.19

Definition at line 190 of file Namespace.php.

Referenced by MWNamespaceTest\testEquals().

static MWNamespace::exists ( $ index ) [static]

Returns whether the specified namespace exists.

Parameters:

$index

Returns:: bool

Since:: 1.19

Definition at line 171 of file Namespace.php.

References getCanonicalNamespaces().

Referenced by Linker\getInvalidTitleDescription(), Title\getNamespaceKey(), Title\getNsText(), and Title\makeTitleSafe().

static MWNamespace::getAssociated ( $ index ) [static]

Get the associated namespace.

For talk namespaces, returns the subject (non-talk) namespace For subject (non-talk) namespaces, returns the talk namespace

Parameters:

int $index namespace index

Returns:: int or null if no associated namespace could be found

Definition at line 151 of file Namespace.php.

References getSubject(), getTalk(), and isMethodValidFor().

Referenced by SpecialRecentChanges\buildMainQueryConds(), SpecialWatchlist\execute(), ContribsPager\getNamespaceCond(), MWNamespaceTest\testGetAssociated(), MWNamespaceTest\testGetAssociatedExceptionsForNsMedia(), and MWNamespaceTest\testGetAssociatedExceptionsForNsSpecial().

static MWNamespace::getCanonicalIndex ( $ name ) [static]

Returns the index for a given canonical name, or NULL The input *must* be converted to lower case first.

Parameters:

string $name namespace name

Returns:: int

Definition at line 253 of file Namespace.php.

References $name, array(), and as.

static MWNamespace::getCanonicalName ( $ index ) [static]

Returns the canonical (English) name for a given index.

Parameters:

int $index namespace index

Returns:: string or false if no canonical definition.

Definition at line 237 of file Namespace.php.

References getCanonicalNamespaces().

Referenced by MWNamespaceTest\__call(), ApiQuerySiteinfo\appendNamespaces(), RevisionStorageTest\createPage(), SpecialListGroupRights\execute(), Linker\formatLinksInCommentCallback(), SpecialStatistics\getGroupStats(), Title\getNamespaceKey(), Title\getNsText(), and Title\moveSubpages().

static MWNamespace::getCanonicalNamespaces ( $ rebuild = false ) [static]

Returns array of all defined namespaces with their canonical (English) names.

Parameters:

bool $rebuild rebuild namespace list (default = false). Used for testing.

Returns:: array

Since:: 1.17

Definition at line 218 of file Namespace.php.

References $namespaces, $wgCanonicalNamespaceNames, array(), global, and wfRunHooks().

Referenced by MysqlUpdater\doPagelinksUpdate(), exists(), getCanonicalName(), ResourceLoaderStartUpModule\getConfig(), RevisionTest\setUp(), TitleMethodsTest\setUp(), ContentHandlerTest\setUp(), ApiEditPageTest\setUp(), RevisionStorageTest\setUp(), NewParserTest\setUp(), ApiEditPageTest\tearDown(), TitleMethodsTest\tearDown(), ContentHandlerTest\tearDown(), RevisionTest\tearDown(), RevisionStorageTest\tearDown(), and NewParserTest\tearDown().

static MWNamespace::getContentNamespaces ( ) [static]

Get a list of all namespace indices which are considered to contain content.

Returns:: array of namespace indices

Definition at line 334 of file Namespace.php.

References array(), and global.

Referenced by RandomPage\__construct(), SiteStatsInit\articles(), UncategorizedPagesPage\getOrderFields(), DeadendPagesPage\getOrderFields(), LonelyPagesPage\getOrderFields(), ShortPagesPage\getQueryInfo(), FewestrevisionsPage\getQueryInfo(), AncientPagesPage\getQueryInfo(), PopularPagesPage\getQueryInfo(), MostinterwikisPage\getQueryInfo(), MostcategoriesPage\getQueryInfo(), UncategorizedPagesPage\getQueryInfo(), LonelyPagesPage\getQueryInfo(), DeadendPagesPage\getQueryInfo(), WithoutInterwikiPage\getQueryInfo(), and MWNamespaceTest\testGetContentNamespaces().

static MWNamespace::getNamespaceContentModel ( $ index ) [static]

Get the default content model for a namespace This does not mean that all pages in that namespace have the model.

Since:: 1.21

Parameters:

int $index Index to check

Returns:: null|string default model name for the given namespace, if set

Definition at line 430 of file Namespace.php.

References global.

Referenced by ApiQuerySiteinfo\appendNamespaces(), and ContentHandler\getDefaultModelFor().

static MWNamespace::getSubject ( $ index ) [static]

Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.

Parameters:

int $index Namespace index

Returns:: int

Definition at line 132 of file Namespace.php.

References isTalk().

Referenced by WatchedItem\addWatch(), getAssociated(), Title\getNamespaceKey(), Title\getSubjectNsText(), Title\getSubjectPage(), ApiQueryInfo\getTSIDs(), isCapitalized(), Title\moveTo(), WatchedItem\removeWatch(), subjectEquals(), SkinTemplate\tabAction(), MWNamespaceTest\testGetSubject(), SpecialEditWatchlist\unwatchTitles(), and SpecialEditWatchlist\watchTitles().

static MWNamespace::getSubjectNamespaces ( ) [static]

List all namespace indices which are considered subject, aka not a talk or special namespace.

See also MWNamespace::isTalk

Returns:: array of namespace indices

Definition at line 365 of file Namespace.php.

References getValidNamespaces().

Referenced by MWNamespaceTest\testGetTalkNamespaces().

static MWNamespace::getValidNamespaces ( ) [static]

Returns an array of the namespaces (by integer id) that exist on the wiki.

Used primarily by the api in help documentation.

Returns:: array

Definition at line 273 of file Namespace.php.

References as.

Referenced by getSubjectNamespaces(), getTalkNamespaces(), and ApiBase\makeHelpMsgParameters().

static MWNamespace::hasGenderDistinction ( $ index ) [static]

Does the namespace (potentially) have different aliases for different genders.

Not all languages make a distinction here.

Since:: 1.18

Parameters:

int $index Index to check

Returns:: bool

Definition at line 406 of file Namespace.php.

Referenced by GenderCache\doLinkBatch(), GenderCache\doTitlesArray(), Title\getNsText(), ApiQueryAllPages\run(), and MWNamespaceTest\testHasGenderDistinction().

static MWNamespace::hasSubpages ( $ index ) [static]

Does the namespace allow subpages?

Parameters:

int $index Index to check

Returns:: bool

Definition at line 325 of file Namespace.php.

References empty, and global.

Referenced by ApiQuerySiteinfo\appendNamespaces(), MovePageForm\doSubmit(), Title\getBaseText(), Title\getEditNotices(), Title\getRootText(), Title\getSubpages(), Title\getSubpageText(), Title\hasSubpages(), Title\moveSubpages(), Linker\normalizeSubpageLink(), InfoAction\pageCounts(), InfoAction\pageInfo(), WikiImporter\setTargetRootPage(), MovePageForm\showSubpages(), and Skin\subPageSubtitle().

static MWNamespace::isCapitalized ( $ index ) [static]

Is the namespace first-letter capitalized?

Parameters:

int $index Index to check

Returns:: bool

Definition at line 378 of file Namespace.php.

References getSubject(), and global.

Referenced by ApiQuerySiteinfo\appendNamespaces(), Title\capitalize(), ResourceLoaderStartUpModule\getConfig(), and MWNamespaceTest\testIsCapitalizedHardcodedAssertions().

static MWNamespace::isContent ( $ index ) [static]

Does this namespace contain content, for the purposes of calculating statistics, etc?

Parameters:

int $index index to check

Returns:: bool

Definition at line 304 of file Namespace.php.

References global.

Referenced by ApiQuerySiteinfo\appendNamespaces(), and Title\isContentPage().

static MWNamespace::isMain ( $ index ) [static]

See also:: self::isSubject

Deprecated:: Please use the more consistently named isSubject (since 1.19)

Returns:: bool

Definition at line 96 of file Namespace.php.

References isSubject(), and wfDeprecated().

static MWNamespace::isMethodValidFor	(	$	index,
		$	method
	)		`[static, private]`

Throw an exception when trying to get the subject or talk page for a given namespace where it does not make sense.

Special namespaces are defined in includes/Defines.php and have a value below 0 (ex: NS_SPECIAL = -1 , NS_MEDIA = -2)

Parameters:

$index
$method

Exceptions:

MWException

Returns:: bool

Definition at line 54 of file Namespace.php.

Referenced by getAssociated(), and getTalk().

namespace are movable Hooks may change this value to override the return value of MWNamespace::isMovable ( $ index ) [static]

Can pages in the given namespace be moved?

Parameters:

int $index namespace index

Returns:: bool

Definition at line 67 of file Namespace.php.

References $result, array(), global, and wfRunHooks().

Referenced by Title\checkActionPermissions(), Title\isMovable(), and MWNamespaceTest\testIsMovable().

static MWNamespace::isNonincludable ( $ index ) [static]

It is not possible to use pages from this namespace as template?

Since:: 1.20

Parameters:

int $index Index to check

Returns:: bool

Definition at line 417 of file Namespace.php.

References global.

Referenced by ApiQuerySiteinfo\appendNamespaces(), and MWNamespaceTest\testIsNonincludable().

static MWNamespace::isSubject ( $ index ) [static]

Is the given namespace is a subject (non-talk) namespace?

Parameters:

int $index namespace index

Returns:: bool

Since:: 1.19

Definition at line 87 of file Namespace.php.

References isTalk().

Referenced by isMain().

static MWNamespace::isTalk ( $ index ) [static]

Is the given namespace a talk namespace?

Parameters:

int $index namespace index

Returns:: bool

Definition at line 107 of file Namespace.php.

Referenced by getSubject(), getTalk(), ApiQueryInfo\getTSIDs(), SpecialEditWatchlist\getWatchlistInfo(), isSubject(), and Title\isTalkPage().

static MWNamespace::isWatchable ( $ index ) [static]

Can pages in a namespace be watched?

Parameters:

$index Int

Returns:: bool

Definition at line 315 of file Namespace.php.

static MWNamespace::subjectEquals	(	$	ns1,
		$	ns2
	)		`[static]`

Returns whether the specified namespaces share the same subject.

eg: NS_USER and NS_USER wil return true, as well NS_USER and NS_USER_TALK will return true.

Parameters:

int	$ns1	The first namespace index
int	$ns2	The second namespace index

Returns:: bool

Since:: 1.19

Definition at line 205 of file Namespace.php.

References getSubject().

Referenced by MWNamespaceTest\assertDifferentSubject(), MWNamespaceTest\assertSameSubject(), and Title\hasSubjectNamespace().

Member Data Documentation

MWNamespace::$alwaysCapitalizedNamespaces = array( NS_SPECIAL, NS_USER, NS_MEDIAWIKI ) [static, private]

These namespaces should always be first-letter capitalized, now and forevermore.

Historically, they could've probably been lowercased too, but some things are just too ingrained now. :)

Definition at line 40 of file Namespace.php.

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

includes/Namespace.php
docs/hooks.txt

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

Member Data Documentation