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...

Collaboration diagram for MWNamespace:

[legend]

Static Public Member Functions
static	canTalk ( $index)
	Does this namespace ever have a talk namespace?

static	clearCaches ()
	Clear internal caches.

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	getCategoryLinkType ( $index)
	Returns the link type to be used for categories.

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	getRestrictionLevels ( $index, User $user=null)
	Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a user's rights.

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	hasTalkNamespace ( $index)
	Does this namespace ever have a talk namespace?

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	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	wantSignatures ( $index)
	Might pages in this namespace require the use of the Signature button on the edit toolbar?

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 = [ NS_SPECIAL, NS_USER, NS_MEDIAWIKI ]
	These namespaces should always be first-letter capitalized, now and forevermore.

static string[] null	$canonicalNamespaces = null
	Canonical namespaces cache.

static array false	$namespaceIndexes = false
	Canonical namespaces index cache.

static int[] null	$validNamespaces = null
	Valid namespaces cache.

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 32 of file MWNamespace.php.

Member Function Documentation

◆ canTalk()

static MWNamespace::canTalk ( $index )

static

Does this namespace ever have a talk namespace?

Deprecated: since 1.30, use hasTalkNamespace() instead.

Parameters

int $index Namespace index

Returns: bool True if this namespace either is or has a corresponding talk namespace.

Definition at line 308 of file MWNamespace.php.

◆ clearCaches()

static MWNamespace::clearCaches ( )

static

Clear internal caches.

For use in unit testing when namespace configuration is changed.

Since: 1.31

Definition at line 76 of file MWNamespace.php.

◆ equals()

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 201 of file MWNamespace.php.

◆ exists()

static MWNamespace::exists ( $index )

static

Returns whether the specified namespace exists.

Parameters

int $index

Returns: bool

Since: 1.19

Definition at line 182 of file MWNamespace.php.

◆ getAssociated()

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|null If no associated namespace could be found

Definition at line 162 of file MWNamespace.php.

◆ getCanonicalIndex()

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 267 of file MWNamespace.php.

References $name.

◆ getCanonicalName()

static MWNamespace::getCanonicalName ( $index )

static

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

Parameters

int $index Namespace index

Returns: string|bool If no canonical definition.

Definition at line 255 of file MWNamespace.php.

◆ getCanonicalNamespaces()

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. Deprecated since 1.31, use self::clearCaches() instead.

Returns: array

Since: 1.17

Definition at line 230 of file MWNamespace.php.

References $wgCanonicalNamespaceNames, $wgExtraNamespaces, ExtensionRegistry\getInstance(), and NS_MAIN.

◆ getCategoryLinkType()

static MWNamespace::getCategoryLinkType ( $index )

static

Returns the link type to be used for categories.

This determines which section of a category page titles in the namespace will appear within.

Since: 1.32

Parameters

int $index Namespace index

Returns: string One of 'subcat', 'file', 'page'

Definition at line 554 of file MWNamespace.php.

References NS_CATEGORY, and NS_FILE.

◆ getContentNamespaces()

static MWNamespace::getContentNamespaces ( )

static

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

Returns: array Array of namespace indices

Definition at line 373 of file MWNamespace.php.

References $wgContentNamespaces, and NS_MAIN.

◆ getNamespaceContentModel()

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 469 of file MWNamespace.php.

References $wgNamespaceContentModels.

◆ getRestrictionLevels()

static MWNamespace::getRestrictionLevels	(		$index,
		User	$user = null )

static

Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a user's rights.

Since: 1.23

Parameters

int	$index	Index to check
User \| null	$user	User to check

Returns: array

Definition at line 483 of file MWNamespace.php.

References $wgNamespaceProtection, $wgRestrictionLevels, array(), and User\getGroupsWithPermission().

Referenced by MediaWiki\EditPage\TextboxBuilder\getTextboxProtectionCSSClasses().

◆ getSubject()

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 143 of file MWNamespace.php.

References NS_MAIN.

◆ getSubjectNamespaces()

static MWNamespace::getSubjectNamespaces ( )

static

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

◆ getTalk()

static MWNamespace::getTalk ( $index )

static

Get the talk namespace index for a given namespace.

Parameters

int $index Namespace index

Returns: int

Definition at line 129 of file MWNamespace.php.

◆ getTalkNamespaces()

static MWNamespace::getTalkNamespaces ( )

static

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

◆ getValidNamespaces()

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 286 of file MWNamespace.php.

◆ hasGenderDistinction()

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 445 of file MWNamespace.php.

References NS_USER_TALK.

◆ hasSubpages()

static MWNamespace::hasSubpages ( $index )

static

Does the namespace allow subpages?

Parameters

int $index Index to check

Returns: bool

Definition at line 364 of file MWNamespace.php.

References $wgNamespacesWithSubpages.

◆ hasTalkNamespace()

static MWNamespace::hasTalkNamespace ( $index )

static

Does this namespace ever have a talk namespace?

Since: 1.30

Parameters

int $index Namespace ID

Returns: bool True if this namespace either is or has a corresponding talk namespace.

Definition at line 320 of file MWNamespace.php.

References NS_MAIN.

◆ isCapitalized()

static MWNamespace::isCapitalized ( $index )

static

Is the namespace first-letter capitalized?

Parameters

int $index Index to check

Returns: bool

Definition at line 417 of file MWNamespace.php.

References $wgCapitalLinkOverrides, $wgCapitalLinks, NS_FILE, and NS_MEDIA.

◆ isContent()

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 331 of file MWNamespace.php.

References $wgContentNamespaces, and NS_MAIN.

◆ isMethodValidFor()

static MWNamespace::isMethodValidFor	(		$index,
			$method )

staticprivate

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

int	$index
string	$method

Exceptions

MWException

Returns: bool

Definition at line 62 of file MWNamespace.php.

References NS_MAIN.

◆ isMovable()

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 88 of file MWNamespace.php.

References $result, $wgAllowImageMoving, NS_FILE, and NS_MAIN.

◆ isNonincludable()

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 456 of file MWNamespace.php.

References $wgNonincludableNamespaces.

◆ isSubject()

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 108 of file MWNamespace.php.

◆ isTalk()

static MWNamespace::isTalk ( $index )

static

Is the given namespace a talk namespace?

Parameters

int $index Namespace index

Returns: bool

Definition at line 118 of file MWNamespace.php.

References NS_MAIN.

◆ isWatchable()

static MWNamespace::isWatchable ( $index )

static

Can pages in a namespace be watched?

Parameters

int $index

Returns: bool

Definition at line 354 of file MWNamespace.php.

References NS_MAIN.

◆ subjectEquals()

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 216 of file MWNamespace.php.

◆ wantSignatures()

static MWNamespace::wantSignatures ( $index )

static

Might pages in this namespace require the use of the Signature button on the edit toolbar?

Parameters

int $index Index to check

Returns: bool

Definition at line 343 of file MWNamespace.php.

References $wgExtraSignatureNamespaces.

Member Data Documentation

◆ $alwaysCapitalizedNamespaces

MWNamespace::$alwaysCapitalizedNamespaces = [ NS_SPECIAL, NS_USER, NS_MEDIAWIKI ]

staticprivate

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 39 of file MWNamespace.php.

◆ $canonicalNamespaces

string [] null MWNamespace::$canonicalNamespaces = null

staticprivate

Canonical namespaces cache.

Definition at line 42 of file MWNamespace.php.

◆ $namespaceIndexes

array false MWNamespace::$namespaceIndexes = false

staticprivate

Canonical namespaces index cache.

Definition at line 45 of file MWNamespace.php.

◆ $validNamespaces

int [] null MWNamespace::$validNamespaces = null

staticprivate

Valid namespaces cache.

Definition at line 48 of file MWNamespace.php.

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

includes/MWNamespace.php
docs/hooks.txt

Static Public Member Functions

Static Private Member Functions

Static Private Attributes

Detailed Description

Member Function Documentation

◆ canTalk()

◆ clearCaches()

◆ equals()

◆ exists()

◆ getAssociated()

◆ getCanonicalIndex()

◆ getCanonicalName()

◆ getCanonicalNamespaces()

◆ getCategoryLinkType()

◆ getContentNamespaces()

◆ getNamespaceContentModel()

◆ getRestrictionLevels()

◆ getSubject()

◆ getSubjectNamespaces()

◆ getTalk()

◆ getTalkNamespaces()

◆ getValidNamespaces()

◆ hasGenderDistinction()

◆ hasSubpages()

◆ hasTalkNamespace()

◆ isCapitalized()

◆ isContent()

◆ isMethodValidFor()

◆ isMovable()

◆ isNonincludable()

◆ isSubject()

◆ isTalk()

◆ isWatchable()

◆ subjectEquals()

◆ wantSignatures()

Member Data Documentation

◆ $alwaysCapitalizedNamespaces

◆ $canonicalNamespaces

◆ $namespaceIndexes

◆ $validNamespaces