3 * Provide things related to namespaces
8 * Definitions of the NS_ constants are in Defines.php
11 $wgCanonicalNamespaceNames = array(
13 NS_SPECIAL
=> 'Special',
16 NS_USER_TALK
=> 'User_talk',
17 NS_PROJECT
=> 'Project',
18 NS_PROJECT_TALK
=> 'Project_talk',
20 NS_FILE_TALK
=> 'File_talk',
21 NS_MEDIAWIKI
=> 'MediaWiki',
22 NS_MEDIAWIKI_TALK
=> 'MediaWiki_talk',
23 NS_TEMPLATE
=> 'Template',
24 NS_TEMPLATE_TALK
=> 'Template_talk',
26 NS_HELP_TALK
=> 'Help_talk',
27 NS_CATEGORY
=> 'Category',
28 NS_CATEGORY_TALK
=> 'Category_talk',
31 if( isset( $wgExtraNamespaces ) && is_array( $wgExtraNamespaces ) ) {
32 $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames +
$wgExtraNamespaces;
36 * This is a utility class with only static functions
37 * for dealing with namespaces that encodes all the
38 * "magic" behaviors of them based on index. The textual
39 * names of the namespaces are handled by Language.php.
41 * These are synonyms for the names given in the language file
42 * Users and translators should not change them
49 * These namespaces should always be first-letter capitalized, now and
50 * forevermore. Historically, they could've probably been lowercased too,
51 * but some things are just too ingrained now. :)
53 private static $alwaysCapitalizedNamespaces = array( NS_SPECIAL
, NS_USER
, NS_MEDIAWIKI
);
56 * Can pages in the given namespace be moved?
58 * @param $index Int: namespace index
61 public static function isMovable( $index ) {
62 global $wgAllowImageMoving;
63 return !( $index < NS_MAIN ||
($index == NS_FILE
&& !$wgAllowImageMoving) ||
$index == NS_CATEGORY
);
67 * Is the given namespace is a subject (non-talk) namespace?
69 * @param $index Int: namespace index
72 public static function isMain( $index ) {
73 return !self
::isTalk( $index );
77 * Is the given namespace a talk namespace?
79 * @param $index Int: namespace index
82 public static function isTalk( $index ) {
83 return $index > NS_MAIN
88 * Get the talk namespace index for a given namespace
90 * @param $index Int: namespace index
93 public static function getTalk( $index ) {
94 return self
::isTalk( $index )
100 * Get the subject namespace index for a given namespace
102 * @param $index Int: Namespace index
105 public static function getSubject( $index ) {
106 return self
::isTalk( $index )
112 * Returns whether the specified namespace exists
114 public static function exists( $index ) {
115 global $wgCanonicalNamespaceNames;
116 return isset( $wgCanonicalNamespaceNames[$index] );
121 * Returns the canonical (English Wikipedia) name for a given index
123 * @param $index Int: namespace index
124 * @return string or false if no canonical definition.
126 public static function getCanonicalName( $index ) {
127 global $wgCanonicalNamespaceNames;
128 if( isset( $wgCanonicalNamespaceNames[$index] ) ) {
129 return $wgCanonicalNamespaceNames[$index];
136 * Returns the index for a given canonical name, or NULL
137 * The input *must* be converted to lower case first
139 * @param $name String: namespace name
142 public static function getCanonicalIndex( $name ) {
143 global $wgCanonicalNamespaceNames;
144 static $xNamespaces = false;
145 if ( $xNamespaces === false ) {
146 $xNamespaces = array();
147 foreach ( $wgCanonicalNamespaceNames as $i => $text ) {
148 $xNamespaces[strtolower($text)] = $i;
151 if ( array_key_exists( $name, $xNamespaces ) ) {
152 return $xNamespaces[$name];
159 * Can this namespace ever have a talk namespace?
161 * @param $index Int: namespace index
164 public static function canTalk( $index ) {
165 return $index >= NS_MAIN
;
169 * Does this namespace contain content, for the purposes of calculating
172 * @param $index Int: index to check
175 public static function isContent( $index ) {
176 global $wgContentNamespaces;
177 return $index == NS_MAIN ||
in_array( $index, $wgContentNamespaces );
181 * Can pages in a namespace be watched?
186 public static function isWatchable( $index ) {
187 return $index >= NS_MAIN
;
191 * Does the namespace allow subpages?
193 * @param $index int Index to check
196 public static function hasSubpages( $index ) {
197 global $wgNamespacesWithSubpages;
198 return !empty( $wgNamespacesWithSubpages[$index] );
202 * Is the namespace first-letter capitalized?
204 * @param $index int Index to check
207 public static function isCapitalized( $index ) {
208 global $wgCapitalLinks, $wgCapitalLinkOverrides;
209 // Turn NS_MEDIA into NS_FILE
210 $index = $index === NS_MEDIA ? NS_FILE
: $index;
212 // Make sure to get the subject of our namespace
213 $index = self
::getSubject( $index );
215 // Some namespaces are special and should always be upper case
216 if ( in_array( $index, self
::$alwaysCapitalizedNamespaces ) ) {
219 if ( isset( $wgCapitalLinkOverrides[ $index ] ) ) {
220 // $wgCapitalLinkOverrides is explicitly set
221 return $wgCapitalLinkOverrides[ $index ];
223 // Default to the global setting
224 return $wgCapitalLinks;