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

Public Member Functions
	__construct (private readonly ServiceOptions $options, HookContainer $hookContainer, private readonly array $extensionNamespaces, private readonly array $immovableNamespaces)

	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 (string $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.

	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

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

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Title\NamespaceInfo::__construct	(	private readonly ServiceOptions	$options,
		HookContainer	$hookContainer,
		private readonly array	$extensionNamespaces,
		private readonly array	$immovableNamespaces )

Parameters

ServiceOptions	$options
HookContainer	$hookContainer
	array<int,string>	$extensionNamespaces From other extension's "ExtensionNamespaces" attributes
int[]	$immovableNamespaces	From other extension's "ImmovableNamespaces" attributes

Definition at line 93 of file NamespaceInfo.php.

Member Function Documentation

◆ canHaveTalkPage()

MediaWiki\Title\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

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

Definition at line 237 of file NamespaceInfo.php.

◆ equals()

MediaWiki\Title\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

Definition at line 330 of file NamespaceInfo.php.

◆ exists()

MediaWiki\Title\NamespaceInfo::exists ( $index )

Returns whether the specified namespace exists.

Parameters

int $index

Definition at line 314 of file NamespaceInfo.php.

Referenced by MediaWiki\Title\NamespaceImportTitleFactory\__construct().

◆ getAssociated()

MediaWiki\Title\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

Exceptions

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

Definition at line 281 of file NamespaceInfo.php.

◆ getAssociatedPage()

MediaWiki\Title\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 296 of file NamespaceInfo.php.

◆ getCanonicalIndex()

MediaWiki\Title\NamespaceInfo::getCanonicalIndex ( string $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

Definition at line 382 of file NamespaceInfo.php.

◆ getCanonicalName()

MediaWiki\Title\NamespaceInfo::getCanonicalName ( $index )

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

Parameters

int $index Namespace index

Returns: string|false If no canonical definition.

Definition at line 371 of file NamespaceInfo.php.

Referenced by MediaWiki\Logging\LogEventsList\getBlockLogWarningBox().

◆ getCanonicalNamespaces()

MediaWiki\Title\NamespaceInfo::getCanonicalNamespaces ( )

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

Returns: array<int,string>

Definition at line 352 of file NamespaceInfo.php.

References NS_MAIN.

◆ getCategoryLinkType()

MediaWiki\Title\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 572 of file NamespaceInfo.php.

References NS_CATEGORY, and NS_FILE.

◆ getCommonNamespaces()

static MediaWiki\Title\NamespaceInfo::getCommonNamespaces ( )

static

Retrieve the indexes for the namespaces defined by core.

Since: 1.34

Returns: int[]

Definition at line 589 of file NamespaceInfo.php.

◆ getContentNamespaces()

MediaWiki\Title\NamespaceInfo::getContentNamespaces ( )

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

Returns: int[] Array of namespace indices

Definition at line 467 of file NamespaceInfo.php.

References NS_MAIN.

Referenced by MediaWiki\Specials\SpecialRandomPage\__construct().

◆ getNamespaceContentModel()

MediaWiki\Title\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 559 of file NamespaceInfo.php.

◆ getSubject()

MediaWiki\Title\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

Definition at line 249 of file NamespaceInfo.php.

◆ getSubjectNamespaces()

MediaWiki\Title\NamespaceInfo::getSubjectNamespaces ( )

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

◆ getSubjectPage()

MediaWiki\Title\NamespaceInfo::getSubjectPage ( LinkTarget $target )

Parameters

LinkTarget $target

Returns: LinkTarget Subject page for $target

Definition at line 266 of file NamespaceInfo.php.

◆ getTalk()

MediaWiki\Title\NamespaceInfo::getTalk ( $index )

Get the talk namespace index for a given namespace.

Parameters

int $index Namespace index

Exceptions

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

Definition at line 192 of file NamespaceInfo.php.

◆ getTalkNamespaces()

MediaWiki\Title\NamespaceInfo::getTalkNamespaces ( )

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

◆ getTalkPage()

MediaWiki\Title\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 210 of file NamespaceInfo.php.

◆ getValidNamespaces()

MediaWiki\Title\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: int[]

Definition at line 397 of file NamespaceInfo.php.

◆ hasGenderDistinction()

MediaWiki\Title\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

Definition at line 535 of file NamespaceInfo.php.

◆ hasSubpages()

MediaWiki\Title\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

Definition at line 459 of file NamespaceInfo.php.

Referenced by MediaWiki\Title\SubpageImportTitleFactory\__construct().

◆ hasTalkNamespace()

MediaWiki\Title\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 418 of file NamespaceInfo.php.

◆ isCapitalized()

MediaWiki\Title\NamespaceInfo::isCapitalized ( $index )

Is the namespace first-letter capitalized?

Parameters

int $index Index to check

Definition at line 509 of file NamespaceInfo.php.

◆ isContent()

MediaWiki\Title\NamespaceInfo::isContent ( $index )

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

Parameters

int $index Index to check

Definition at line 428 of file NamespaceInfo.php.

◆ isMovable()

MediaWiki\Title\NamespaceInfo::isMovable ( $index )

Can pages in the given namespace be moved?

Parameters

int $index Namespace index

Definition at line 148 of file NamespaceInfo.php.

◆ isNonincludable()

MediaWiki\Title\NamespaceInfo::isNonincludable ( $index )

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

Parameters

int $index Index to check

Definition at line 544 of file NamespaceInfo.php.

◆ isSubject()

MediaWiki\Title\NamespaceInfo::isSubject ( $index )

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

Parameters

int $index Namespace index

Definition at line 169 of file NamespaceInfo.php.

◆ isTalk()

MediaWiki\Title\NamespaceInfo::isTalk ( $index )

Is the given namespace a talk namespace?

Parameters

int $index Namespace index

Definition at line 178 of file NamespaceInfo.php.

◆ isWatchable()

MediaWiki\Title\NamespaceInfo::isWatchable ( $index )

Can pages in a namespace be watched?

Parameters

int $index

Definition at line 449 of file NamespaceInfo.php.

◆ subjectEquals()

MediaWiki\Title\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

Definition at line 342 of file NamespaceInfo.php.

◆ wantSignatures()

MediaWiki\Title\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

Definition at line 439 of file NamespaceInfo.php.

Member Data Documentation

◆ CANONICAL_NAMES

const MediaWiki\Title\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 50 of file NamespaceInfo.php.

◆ CONSTRUCTOR_OPTIONS

const MediaWiki\Title\NamespaceInfo::CONSTRUCTOR_OPTIONS

Initial value:

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

Access: internal: For use by ServiceWiring

Definition at line 74 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

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canHaveTalkPage()

◆ equals()

◆ exists()

◆ getAssociated()

◆ getAssociatedPage()

◆ getCanonicalIndex()

◆ getCanonicalName()

◆ getCanonicalNamespaces()

◆ getCategoryLinkType()

◆ getCommonNamespaces()

◆ getContentNamespaces()

◆ getNamespaceContentModel()

◆ getSubject()

◆ getSubjectNamespaces()

◆ getSubjectPage()

◆ getTalk()

◆ getTalkNamespaces()

◆ getTalkPage()

◆ getValidNamespaces()

◆ hasGenderDistinction()

◆ hasSubpages()

◆ hasTalkNamespace()

◆ isCapitalized()

◆ isContent()

◆ isMovable()

◆ isNonincludable()

◆ isSubject()

◆ isTalk()

◆ isWatchable()

◆ subjectEquals()

◆ wantSignatures()

Member Data Documentation

◆ CANONICAL_NAMES

◆ CONSTRUCTOR_OPTIONS