<?php
+/**
+ * Provide things related to namespaces
+ * @package MediaWiki
+ */
-# This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
-if( defined( 'MEDIAWIKI' ) ) {
-
-# 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.
-
-# Definitions of the NS_ constants are in Defines.php
-
-# These are synonyms for the names given in the language file
-# Users and translators should not change them
-/* private */ $wgCanonicalNamespaceNames = array(
+/**
+ * Definitions of the NS_ constants are in Defines.php
+ * @private
+ */
+$wgCanonicalNamespaceNames = array(
NS_MEDIA => 'Media',
NS_SPECIAL => 'Special',
- NS_TALK => 'Talk',
+ NS_TALK => 'Talk',
NS_USER => 'User',
NS_USER_TALK => 'User_talk',
NS_PROJECT => 'Project',
NS_TEMPLATE_TALK => 'Template_talk',
NS_HELP => 'Help',
NS_HELP_TALK => 'Help_talk',
- NS_CATEGORY => 'Category',
- NS_CATEGORY_TALK => 'Category_talk'
+ NS_CATEGORY => 'Category',
+ NS_CATEGORY_TALK => 'Category_talk',
);
+if( is_array( $wgExtraNamespaces ) ) {
+ $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
+}
+
+/**
+ * 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
+ *
+ * @package MediaWiki
+ */
class Namespace {
- /* These functions are deprecated */
- function getSpecial() { return NS_SPECIAL; }
- function getUser() { return NS_USER; }
- function getWikipedia() { return NS_PROJECT; }
- function getImage() { return NS_IMAGE; }
- function getMedia() { return NS_MEDIA; }
- function getCategory() { return NS_CATEGORY; }
+ /**
+ * Check if the given namespace might be moved
+ * @return bool
+ */
+ static function isMovable( $index ) {
+ return !( $index < NS_MAIN || $index == NS_IMAGE || $index == NS_CATEGORY );
+ }
- function isMovable( $index )
- {
- if ( $index < NS_MAIN || $index == NS_IMAGE || $index == NS_CATEGORY ) {
- return false;
- }
- return true;
+ /**
+ * Check if the given namespace is not a talk page
+ * @return bool
+ */
+ static function isMain( $index ) {
+ return ! Namespace::isTalk( $index );
}
- function isTalk( $index )
- {
- return ( $index == NS_TALK || $index == NS_USER_TALK ||
- $index == NS_PROJECT_TALK || $index == NS_IMAGE_TALK ||
- $index == NS_MEDIAWIKI_TALK || $index == NS_TEMPLATE_TALK ||
- $index == NS_HELP_TALK || $index == NS_CATEGORY_TALK );
+ /**
+ * Check if the give namespace is a talk page
+ * @return bool
+ */
+ static function isTalk( $index ) {
+ return ($index > NS_MAIN) // Special namespaces are negative
+ && ($index % 2); // Talk namespaces are odd-numbered
}
- # Get the talk namespace corresponding to the given index
- #
- function getTalk( $index )
- {
+ /**
+ * Get the talk namespace corresponding to the given index
+ */
+ static function getTalk( $index ) {
if ( Namespace::isTalk( $index ) ) {
return $index;
} else {
}
}
- function getSubject( $index )
- {
+ static function getSubject( $index ) {
if ( Namespace::isTalk( $index ) ) {
return $index - 1;
} else {
}
}
- # Returns the canonical (English Wikipedia) name for a given index
- function &getCanonicalName( $index )
- {
+ /**
+ * Returns the canonical (English Wikipedia) name for a given index
+ */
+ static function getCanonicalName( $index ) {
global $wgCanonicalNamespaceNames;
return $wgCanonicalNamespaceNames[$index];
}
- # Returns the index for a given canonical name, or NULL
- # The input *must* be converted to lower case first
- function &getCanonicalIndex( $name )
- {
+ /**
+ * Returns the index for a given canonical name, or NULL
+ * The input *must* be converted to lower case first
+ */
+ static function getCanonicalIndex( $name ) {
global $wgCanonicalNamespaceNames;
static $xNamespaces = false;
if ( $xNamespaces === false ) {
return NULL;
}
}
-}
-
+
+ /**
+ * Can this namespace ever have a talk namespace?
+ * @param $index Namespace index
+ */
+ static function canTalk( $index ) {
+ return( $index >= NS_MAIN );
+ }
}
?>