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

Collaboration diagram for NamespaceInfo:

[legend]

Public Member Functions
	__construct (ServiceOptions $options, HookContainer $hookContainer)

	canHaveTalkPage (LinkTarget $target)
	Can the title have a corresponding talk page?

	equals ( $ns1, $ns2)
	Returns whether the specified namespaces are the same namespace.

	exists ( $index)
	Returns whether the specified namespace exists.

	getAssociated ( $index)
	Get the associated namespace.

	getAssociatedPage (LinkTarget $target)

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

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

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

	getCategoryLinkType ( $index)
	Returns the link type to be used for categories.

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

	getNamespaceContentModel ( $index)
	Get the default content model for a namespace This does not mean that all pages in that namespace have the model.

	getRestrictionLevels ( $index, User $user=null)
	Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a user's rights.

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

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

	getSubjectPage (LinkTarget $target)

	getTalk ( $index)
	Get the talk namespace index for a given namespace.

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

	getTalkPage (LinkTarget $target)
	Get a LinkTarget referring to the talk page of $target.

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

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

	hasSubpages ( $index)
	Does the namespace allow subpages? Note that this refers to structured handling of subpages, and does not include SpecialPage subpage parameters.

	hasTalkNamespace ( $index)
	Does this namespace ever have a talk namespace?

	isCapitalized ( $index)
	Is the namespace first-letter capitalized?

	isContent ( $index)
	Does this namespace contain content, for the purposes of calculating statistics, etc?

	isMovable ( $index)
	Can pages in the given namespace be moved?

	isNonincludable ( $index)
	It is not possible to use pages from this namespace as template?

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

	isTalk ( $index)
	Is the given namespace a talk namespace?

	isWatchable ( $index)
	Can pages in a namespace be watched?

	subjectEquals ( $ns1, $ns2)
	Returns whether the specified namespaces share the same subject.

	wantSignatures ( $index)
	Might pages in this namespace require the use of the Signature button on the edit toolbar?

Static Public Member Functions
static	getCommonNamespaces ()
	Retrieve the indexes for the namespaces defined by core.

Public Attributes
const	CANONICAL_NAMES
	Definitions of the NS_ constants are in Defines.php.

const	CONSTRUCTOR_OPTIONS

Private Member Functions
	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.

	makeValidNamespace ( $index, $method)
	Throw if given index isn't an integer or integer-like string and so can't be a valid namespace.

Private Attributes
	$alwaysCapitalizedNamespaces = [ NS_SPECIAL, NS_USER, NS_MEDIAWIKI ]
	These namespaces should always be first-letter capitalized, now and forevermore.

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

HookRunner	$hookRunner

array false	$namespaceIndexes = false
	Canonical namespaces index cache.

ServiceOptions	$options

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

Detailed Description

This is a utility class 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.

Since: 1.34

Definition at line 35 of file NamespaceInfo.php.

Constructor & Destructor Documentation

◆ __construct()

NamespaceInfo::__construct	(	ServiceOptions	$options,
		HookContainer	$hookContainer
	)

Parameters

ServiceOptions	$options
HookContainer	$hookContainer

Definition at line 104 of file NamespaceInfo.php.

References MediaWiki\Config\ServiceOptions\assertRequiredOptions().

Member Function Documentation

◆ canHaveTalkPage()

NamespaceInfo::canHaveTalkPage ( LinkTarget $target )

Can the title have a corresponding talk page?

False for relative section-only links (with getText() === ''), interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.

See also: getTalkPage

Parameters

LinkTarget $target

Returns: bool True if this title either is a talk page or can have a talk page associated.

Definition at line 251 of file NamespaceInfo.php.

References MediaWiki\Linker\LinkTarget\getInterwiki(), MediaWiki\Linker\LinkTarget\getNamespace(), MediaWiki\Linker\LinkTarget\getText(), and NS_MAIN.

◆ equals()

NamespaceInfo::equals	(	$ns1,
		$ns2
	)

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

Definition at line 356 of file NamespaceInfo.php.

◆ exists()

NamespaceInfo::exists ( $index )

Returns whether the specified namespace exists.

Parameters

int $index

Returns: bool

Definition at line 338 of file NamespaceInfo.php.

Referenced by NamespaceImportTitleFactory\__construct().

◆ getAssociated()

NamespaceInfo::getAssociated ( $index )

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

Exceptions

MWException if called on a namespace that has no talk pages (e.g., NS_SPECIAL)

Definition at line 303 of file NamespaceInfo.php.

◆ getAssociatedPage()

NamespaceInfo::getAssociatedPage ( LinkTarget $target )

Parameters

LinkTarget $target

Returns: LinkTarget Talk page for $target if it's a subject page, subject page if it's a talk page

Exceptions

MWException if $target's namespace doesn't have talk pages (e.g., NS_SPECIAL)

Definition at line 318 of file NamespaceInfo.php.

◆ getCanonicalIndex()

NamespaceInfo::getCanonicalIndex ( $name )

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

Definition at line 412 of file NamespaceInfo.php.

◆ getCanonicalName()

NamespaceInfo::getCanonicalName ( $index )

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

Parameters

int $index Namespace index

Returns: string|bool If no canonical definition.

Definition at line 400 of file NamespaceInfo.php.

◆ getCanonicalNamespaces()

NamespaceInfo::getCanonicalNamespaces ( )

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

Returns: string[]

Definition at line 380 of file NamespaceInfo.php.

References NS_MAIN.

◆ getCategoryLinkType()

NamespaceInfo::getCategoryLinkType ( $index )

Returns the link type to be used for categories.

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

Parameters

int $index Namespace index

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

Definition at line 632 of file NamespaceInfo.php.

References NS_CATEGORY, and NS_FILE.

◆ getCommonNamespaces()

static NamespaceInfo::getCommonNamespaces ( )

static

Retrieve the indexes for the namespaces defined by core.

Since: 1.34

Returns: int[]

Definition at line 651 of file NamespaceInfo.php.

◆ getContentNamespaces()

NamespaceInfo::getContentNamespaces ( )

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

Returns: int[] Array of namespace indices

Definition at line 504 of file NamespaceInfo.php.

References NS_MAIN.

◆ getNamespaceContentModel()

NamespaceInfo::getNamespaceContentModel ( $index )

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

Note: To determine the default model for a new page's main slot, or any slot in general, use SlotRoleHandler::getDefaultModel() together with SlotRoleRegistry::getRoleHandler().

Parameters

int $index Index to check

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

Definition at line 600 of file NamespaceInfo.php.

◆ getRestrictionLevels()

NamespaceInfo::getRestrictionLevels	(		$index,
		User	$user = `null`
	)

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

Deprecated:: since 1.34 User PermissionManager::getNamespaceRestrictionLevels instead.

Parameters

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

Returns: array

Definition at line 613 of file NamespaceInfo.php.

References wfDeprecated().

◆ getSubject()

NamespaceInfo::getSubject ( $index )

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 270 of file NamespaceInfo.php.

References NS_MAIN.

◆ getSubjectNamespaces()

NamespaceInfo::getSubjectNamespaces ( )

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

◆ getSubjectPage()

NamespaceInfo::getSubjectPage ( LinkTarget $target )

Parameters

LinkTarget $target

Returns: LinkTarget Subject page for $target

Definition at line 287 of file NamespaceInfo.php.

Referenced by ApiQueryInfo\getTSIDs().

◆ getTalk()

NamespaceInfo::getTalk ( $index )

Get the talk namespace index for a given namespace.

Parameters

int $index Namespace index

Returns: int

Exceptions

MWException if the given namespace doesn't have an associated talk namespace (e.g. NS_SPECIAL).

Definition at line 205 of file NamespaceInfo.php.

References isMethodValidFor(), isTalk(), and makeValidNamespace().

◆ getTalkNamespaces()

NamespaceInfo::getTalkNamespaces ( )

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

◆ getTalkPage()

NamespaceInfo::getTalkPage ( LinkTarget $target )

Get a LinkTarget referring to the talk page of $target.

See also: canHaveTalkPage

Parameters

LinkTarget $target

Returns: LinkTarget Talk page for $target

Exceptions

MWException if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL, because it's a relative section-only link, or it's an interwiki link.

Definition at line 223 of file NamespaceInfo.php.

◆ getValidNamespaces()

NamespaceInfo::getValidNamespaces ( )

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

Used primarily by the API in help documentation. The array is sorted numerically and omits negative namespaces.

Returns: array

Definition at line 431 of file NamespaceInfo.php.

◆ hasGenderDistinction()

NamespaceInfo::hasGenderDistinction ( $index )

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

Not all languages make a distinction here.

Parameters

int $index Index to check

Returns: bool

Definition at line 575 of file NamespaceInfo.php.

References NS_USER, and NS_USER_TALK.

◆ hasSubpages()

NamespaceInfo::hasSubpages ( $index )

Does the namespace allow subpages? Note that this refers to structured handling of subpages, and does not include SpecialPage subpage parameters.

Parameters

int $index Index to check

Returns: bool

Definition at line 496 of file NamespaceInfo.php.

Referenced by SubpageImportTitleFactory\__construct().

◆ hasTalkNamespace()

NamespaceInfo::hasTalkNamespace ( $index )

Does this namespace ever have a talk namespace?

Parameters

int $index Namespace ID

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

Definition at line 452 of file NamespaceInfo.php.

References NS_MAIN.

◆ isCapitalized()

NamespaceInfo::isCapitalized ( $index )

Is the namespace first-letter capitalized?

Parameters

int $index Index to check

Returns: bool

Definition at line 548 of file NamespaceInfo.php.

References NS_FILE, and NS_MEDIA.

◆ isContent()

NamespaceInfo::isContent ( $index )

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

Parameters

int $index Index to check

Returns: bool

Definition at line 463 of file NamespaceInfo.php.

References NS_MAIN.

◆ isMethodValidFor()

NamespaceInfo::isMethodValidFor	(	$index,
		$method
	)

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

int	$index
string	$method

Exceptions

MWException

Returns: bool

Definition at line 122 of file NamespaceInfo.php.

References NS_MAIN.

Referenced by getTalk().

◆ isMovable()

NamespaceInfo::isMovable ( $index )

Can pages in the given namespace be moved?

Parameters

int $index Namespace index

Returns: bool

Definition at line 160 of file NamespaceInfo.php.

References NS_MAIN.

◆ isNonincludable()

NamespaceInfo::isNonincludable ( $index )

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

Parameters

int $index Index to check

Returns: bool

Definition at line 585 of file NamespaceInfo.php.

◆ isSubject()

NamespaceInfo::isSubject ( $index )

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

Parameters

int $index Namespace index

Returns: bool

Definition at line 180 of file NamespaceInfo.php.

References isTalk().

Referenced by CoreMagicVariables\expand().

◆ isTalk()

NamespaceInfo::isTalk ( $index )

Is the given namespace a talk namespace?

Parameters

int $index Namespace index

Returns: bool

Definition at line 190 of file NamespaceInfo.php.

References makeValidNamespace(), and NS_MAIN.

Referenced by getTalk(), and isSubject().

◆ isWatchable()

NamespaceInfo::isWatchable ( $index )

Can pages in a namespace be watched?

Parameters

int $index

Returns: bool

Definition at line 485 of file NamespaceInfo.php.

References NS_MAIN.

◆ makeValidNamespace()

NamespaceInfo::makeValidNamespace	(	$index,
		$method
	)

private

Throw if given index isn't an integer or integer-like string and so can't be a valid namespace.

Parameters

int \| string	$index
string	$method

Exceptions

InvalidArgumentException

Returns: int Cleaned up namespace index

Definition at line 138 of file NamespaceInfo.php.

Referenced by getTalk(), and isTalk().

◆ subjectEquals()

NamespaceInfo::subjectEquals	(	$ns1,
		$ns2
	)

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

Definition at line 370 of file NamespaceInfo.php.

◆ wantSignatures()

NamespaceInfo::wantSignatures ( $index )

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

Member Data Documentation

◆ $alwaysCapitalizedNamespaces

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

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 42 of file NamespaceInfo.php.

◆ $canonicalNamespaces

string [] null NamespaceInfo::$canonicalNamespaces = null

private

Canonical namespaces cache.

Definition at line 45 of file NamespaceInfo.php.

◆ $hookRunner

HookRunner NamespaceInfo::$hookRunner

private

Definition at line 57 of file NamespaceInfo.php.

◆ $namespaceIndexes

array false NamespaceInfo::$namespaceIndexes = false

private

Canonical namespaces index cache.

Definition at line 48 of file NamespaceInfo.php.

◆ $options

ServiceOptions NamespaceInfo::$options

private

Definition at line 54 of file NamespaceInfo.php.

◆ $validNamespaces

int [] null NamespaceInfo::$validNamespaces = null

private

Valid namespaces cache.

Definition at line 51 of file NamespaceInfo.php.

◆ CANONICAL_NAMES

const NamespaceInfo::CANONICAL_NAMES

Initial value:

= [
        NS_MEDIA            => 'Media',
        NS_SPECIAL          => 'Special',
        NS_MAIN             => '',
        NS_TALK             => 'Talk',
        NS_USER             => 'User',
        NS_USER_TALK        => 'User_talk',
        NS_PROJECT          => 'Project',
        NS_PROJECT_TALK     => 'Project_talk',
        NS_FILE             => 'File',
        NS_FILE_TALK        => 'File_talk',
        NS_MEDIAWIKI        => 'MediaWiki',
        NS_MEDIAWIKI_TALK   => 'MediaWiki_talk',
        NS_TEMPLATE         => 'Template',
        NS_TEMPLATE_TALK    => 'Template_talk',
        NS_HELP             => 'Help',
        NS_HELP_TALK        => 'Help_talk',
        NS_CATEGORY         => 'Category',
        NS_CATEGORY_TALK    => 'Category_talk',
    ]

Definitions of the NS_ constants are in Defines.php.

Access: internal

Definition at line 64 of file NamespaceInfo.php.

◆ CONSTRUCTOR_OPTIONS

const NamespaceInfo::CONSTRUCTOR_OPTIONS

Initial value:

= [
        'CanonicalNamespaceNames',
        'CapitalLinkOverrides',
        'CapitalLinks',
        'ContentNamespaces',
        'ExtraNamespaces',
        'ExtraSignatureNamespaces',
        'NamespaceContentModels',
        'NamespacesWithSubpages',
        'NonincludableNamespaces',
    ]

Access: internal: For use by ServiceWiring

Definition at line 88 of file NamespaceInfo.php.

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

includes/title/NamespaceInfo.php

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canHaveTalkPage()

◆ equals()

◆ exists()

◆ getAssociated()

◆ getAssociatedPage()

◆ getCanonicalIndex()

◆ getCanonicalName()

◆ getCanonicalNamespaces()

◆ getCategoryLinkType()

◆ getCommonNamespaces()

◆ getContentNamespaces()

◆ getNamespaceContentModel()

◆ getRestrictionLevels()

◆ getSubject()

◆ getSubjectNamespaces()

◆ getSubjectPage()

◆ getTalk()

◆ getTalkNamespaces()

◆ getTalkPage()

◆ getValidNamespaces()

◆ hasGenderDistinction()

◆ hasSubpages()

◆ hasTalkNamespace()

◆ isCapitalized()

◆ isContent()

◆ isMethodValidFor()

◆ isMovable()

◆ isNonincludable()

◆ isSubject()

◆ isTalk()

◆ isWatchable()

◆ makeValidNamespace()

◆ subjectEquals()

◆ wantSignatures()

Member Data Documentation

◆ $alwaysCapitalizedNamespaces

◆ $canonicalNamespaces

◆ $hookRunner

◆ $namespaceIndexes

◆ $options

◆ $validNamespaces

◆ CANONICAL_NAMES

◆ CONSTRUCTOR_OPTIONS