MediaWiki  master
NamespaceInfo Class Reference

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 (ServiceOptions $options, HookContainer $hookContainer)
 
 canHaveTalkPage (LinkTarget $target)
 Can the title have a corresponding talk page? More...
 
 equals ( $ns1, $ns2)
 Returns whether the specified namespaces are the same namespace. More...
 
 exists ( $index)
 Returns whether the specified namespace exists. More...
 
 getAssociated ( $index)
 Get the associated namespace. More...
 
 getAssociatedPage (LinkTarget $target)
 
 getCanonicalIndex ( $name)
 Returns the index for a given canonical name, or NULL The input must be converted to lower case first. More...
 
 getCanonicalName ( $index)
 Returns the canonical (English) name for a given index. More...
 
 getCanonicalNamespaces ()
 Returns array of all defined namespaces with their canonical (English) names. More...
 
 getCategoryLinkType ( $index)
 Returns the link type to be used for categories. More...
 
 getContentNamespaces ()
 Get a list of all namespace indices which are considered to contain content. More...
 
 getNamespaceContentModel ( $index)
 Get the default content model for a namespace This does not mean that all pages in that namespace have the model. More...
 
 getRestrictionLevels ( $index, User $user=null)
 Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a user's rights. More...
 
 getSubject ( $index)
 Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject. More...
 
 getSubjectNamespaces ()
 List all namespace indices which are considered subject, aka not a talk or special namespace. More...
 
 getSubjectPage (LinkTarget $target)
 
 getTalk ( $index)
 Get the talk namespace index for a given namespace. More...
 
 getTalkNamespaces ()
 List all namespace indices which are considered talks, aka not a subject or special namespace. More...
 
 getTalkPage (LinkTarget $target)
 Get a LinkTarget referring to the talk page of $target. More...
 
 getValidNamespaces ()
 Returns an array of the namespaces (by integer id) that exist on the wiki. More...
 
 hasGenderDistinction ( $index)
 Does the namespace (potentially) have different aliases for different genders. More...
 
 hasSubpages ( $index)
 Does the namespace allow subpages? Note that this refers to structured handling of subpages, and does not include SpecialPage subpage parameters. More...
 
 hasTalkNamespace ( $index)
 Does this namespace ever have a talk namespace? More...
 
 isCapitalized ( $index)
 Is the namespace first-letter capitalized? More...
 
 isContent ( $index)
 Does this namespace contain content, for the purposes of calculating statistics, etc? More...
 
 isMovable ( $index)
 Can pages in the given namespace be moved? More...
 
 isNonincludable ( $index)
 It is not possible to use pages from this namespace as template? More...
 
 isSubject ( $index)
 Is the given namespace is a subject (non-talk) namespace? More...
 
 isTalk ( $index)
 Is the given namespace a talk namespace? More...
 
 isWatchable ( $index)
 Can pages in a namespace be watched? More...
 
 subjectEquals ( $ns1, $ns2)
 Returns whether the specified namespaces share the same subject. More...
 
 wantSignatures ( $index)
 Might pages in this namespace require the use of the Signature button on the edit toolbar? More...
 

Static Public Member Functions

static getCommonNamespaces ()
 Retrieve the indexes for the namespaces defined by core. More...
 

Public Attributes

const CANONICAL_NAMES
 Definitions of the NS_ constants are in Defines.php. More...
 
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 36 of file NamespaceInfo.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 105 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 252 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$ns1The first namespace index
int$ns2The second namespace index
Returns
bool

Definition at line 357 of file NamespaceInfo.php.

◆ exists()

NamespaceInfo::exists (   $index)

Returns whether the specified namespace exists.

Parameters
int$index
Returns
bool

Definition at line 339 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$indexNamespace index
Returns
int
Exceptions
MWExceptionif called on a namespace that has no talk pages (e.g., NS_SPECIAL)

Definition at line 304 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
MWExceptionif $target's namespace doesn't have talk pages (e.g., NS_SPECIAL)

Definition at line 319 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$nameNamespace name
Returns
int|null

Definition at line 413 of file NamespaceInfo.php.

◆ getCanonicalName()

NamespaceInfo::getCanonicalName (   $index)

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

Parameters
int$indexNamespace index
Returns
string|bool If no canonical definition.

Definition at line 401 of file NamespaceInfo.php.

◆ getCanonicalNamespaces()

NamespaceInfo::getCanonicalNamespaces ( )

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

Returns
string[]

Definition at line 381 of file NamespaceInfo.php.

References ExtensionRegistry\getInstance(), and 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$indexNamespace index
Returns
string One of 'subcat', 'file', 'page'

Definition at line 634 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 653 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 506 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$indexIndex to check
Returns
null|string Default model name for the given namespace, if set

Definition at line 602 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$indexIndex to check
User | null$userUser to check
Returns
string[]

Definition at line 615 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$indexNamespace index
Returns
int

Definition at line 271 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.

See also NamespaceInfo::isSubject

Returns
int[] Array of namespace indices

Definition at line 524 of file NamespaceInfo.php.

◆ getSubjectPage()

NamespaceInfo::getSubjectPage ( LinkTarget  $target)
Parameters
LinkTarget$target
Returns
LinkTarget Subject page for $target

Definition at line 288 of file NamespaceInfo.php.

◆ getTalk()

NamespaceInfo::getTalk (   $index)

Get the talk namespace index for a given namespace.

Parameters
int$indexNamespace index
Returns
int
Exceptions
MWExceptionif the given namespace doesn't have an associated talk namespace (e.g. NS_SPECIAL).

Definition at line 206 of file NamespaceInfo.php.

References isTalk().

◆ getTalkNamespaces()

NamespaceInfo::getTalkNamespaces ( )

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

See also NamespaceInfo::isTalk

Returns
int[] Array of namespace indices

Definition at line 537 of file NamespaceInfo.php.

◆ 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
MWExceptionif $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 224 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 432 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$indexIndex to check
Returns
bool

Definition at line 577 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$indexIndex to check
Returns
bool

Definition at line 498 of file NamespaceInfo.php.

Referenced by SubpageImportTitleFactory\__construct().

◆ hasTalkNamespace()

NamespaceInfo::hasTalkNamespace (   $index)

Does this namespace ever have a talk namespace?

Parameters
int$indexNamespace ID
Returns
bool True if this namespace either is or has a corresponding talk namespace.

Definition at line 453 of file NamespaceInfo.php.

References NS_MAIN.

◆ isCapitalized()

NamespaceInfo::isCapitalized (   $index)

Is the namespace first-letter capitalized?

Parameters
int$indexIndex to check
Returns
bool

Definition at line 550 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$indexIndex to check
Returns
bool

Definition at line 464 of file NamespaceInfo.php.

References NS_MAIN.

◆ isMovable()

NamespaceInfo::isMovable (   $index)

Can pages in the given namespace be moved?

Parameters
int$indexNamespace index
Returns
bool

Definition at line 161 of file NamespaceInfo.php.

References ExtensionRegistry\getInstance(), and NS_MAIN.

◆ isNonincludable()

NamespaceInfo::isNonincludable (   $index)

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

Parameters
int$indexIndex to check
Returns
bool

Definition at line 587 of file NamespaceInfo.php.

◆ isSubject()

NamespaceInfo::isSubject (   $index)

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

Parameters
int$indexNamespace index
Returns
bool

Definition at line 181 of file NamespaceInfo.php.

References isTalk().

Referenced by CoreMagicVariables\expand().

◆ isTalk()

NamespaceInfo::isTalk (   $index)

Is the given namespace a talk namespace?

Parameters
int$indexNamespace index
Returns
bool

Definition at line 191 of file NamespaceInfo.php.

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

References NS_MAIN.

◆ 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$ns1The first namespace index
int$ns2The second namespace index
Returns
bool

Definition at line 371 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$indexIndex to check
Returns
bool

Definition at line 476 of file NamespaceInfo.php.

Member Data Documentation

◆ 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',
]
const NS_HELP
Definition: Defines.php:76
const NS_USER
Definition: Defines.php:66
const NS_FILE
Definition: Defines.php:70
const NS_MEDIAWIKI_TALK
Definition: Defines.php:73
const NS_MAIN
Definition: Defines.php:64
const NS_PROJECT_TALK
Definition: Defines.php:69
const NS_MEDIAWIKI
Definition: Defines.php:72
const NS_TEMPLATE
Definition: Defines.php:74
const NS_SPECIAL
Definition: Defines.php:53
const NS_FILE_TALK
Definition: Defines.php:71
const NS_HELP_TALK
Definition: Defines.php:77
const NS_CATEGORY_TALK
Definition: Defines.php:79
const NS_MEDIA
Definition: Defines.php:52
const NS_TALK
Definition: Defines.php:65
const NS_USER_TALK
Definition: Defines.php:67
const NS_PROJECT
Definition: Defines.php:68
const NS_CATEGORY
Definition: Defines.php:78
const NS_TEMPLATE_TALK
Definition: Defines.php:75

Definitions of the NS_ constants are in Defines.php.

Access: internal

Definition at line 65 of file NamespaceInfo.php.

◆ CONSTRUCTOR_OPTIONS

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


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