Moved constant values from initialiseFromUser() to class definition
[lhc/web/wiklou.git] / includes / Namespace.php
index 8bf784f..48a93dd 100644 (file)
@@ -8,7 +8,6 @@
  * Definitions of the NS_ constants are in Defines.php
  * @private
  */
-global $wgCanonicalNamespaceNames;
 $wgCanonicalNamespaceNames = array(
        NS_MEDIA            => 'Media',
        NS_SPECIAL          => 'Special',
@@ -29,7 +28,8 @@ $wgCanonicalNamespaceNames = array(
        NS_CATEGORY_TALK    => 'Category_talk',
 );
 
-if( isset( $wgExtraNamespaces ) && is_array( $wgExtraNamespaces ) ) {
+/// @todo UGLY UGLY
+if( is_array( $wgExtraNamespaces ) ) {
        $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
 }
 
@@ -47,8 +47,8 @@ if( isset( $wgExtraNamespaces ) && is_array( $wgExtraNamespaces ) ) {
 class MWNamespace {
 
        /**
-        * These namespaces should always be first-letter capitalized, now and 
-        * forevermore. Historically, they could've probably been lowercased too, 
+        * 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. :)
         */
        private static $alwaysCapitalizedNamespaces = array( NS_SPECIAL, NS_USER, NS_MEDIAWIKI );
@@ -108,26 +108,47 @@ class MWNamespace {
                        ? $index - 1
                        : $index;
        }
-       
+
        /**
         * Returns whether the specified namespace exists
         */
        public static function exists( $index ) {
-               global $wgCanonicalNamespaceNames;
-               return isset( $wgCanonicalNamespaceNames[$index] );
+               $nslist = self::getCanonicalNamespaces();
+               return isset( $nslist[$index] );
        }
 
+       /**
+        * Returns array of all defined namespaces with their canonical
+        * (English) names.
+        *
+        * @return \array
+        * @since 1.17
+        */
+       public static function getCanonicalNamespaces() {
+               static $namespaces = null;
+               if ( $namespaces === null ) {
+                       global $wgExtraNamespaces, $wgCanonicalNamespaceNames;
+                       if ( is_array( $wgExtraNamespaces ) ) {
+                               $namespaces = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
+                       } else {
+                               $namespaces = $wgCanonicalNamespaceNames;
+                       }
+                       $namespaces[NS_MAIN] = '';
+                       wfRunHooks( 'CanonicalNamespaces', array( &$namespaces ) );
+               }
+               return $namespaces;
+       }
 
        /**
-        * Returns the canonical (English Wikipedia) name for a given index
+        * Returns the canonical (English) name for a given index
         *
         * @param $index Int: namespace index
         * @return string or false if no canonical definition.
         */
        public static function getCanonicalName( $index ) {
-               global $wgCanonicalNamespaceNames;
-               if( isset( $wgCanonicalNamespaceNames[$index] ) ) {
-                       return $wgCanonicalNamespaceNames[$index];
+               $nslist = self::getCanonicalNamespaces();
+               if( isset( $nslist[$index] ) ) {
+                       return $nslist[$index];
                } else {
                        return false;
                }
@@ -141,11 +162,10 @@ class MWNamespace {
         * @return int
         */
        public static function getCanonicalIndex( $name ) {
-               global $wgCanonicalNamespaceNames;
                static $xNamespaces = false;
                if ( $xNamespaces === false ) {
                        $xNamespaces = array();
-                       foreach ( $wgCanonicalNamespaceNames as $i => $text ) {
+                       foreach ( self::getCanonicalNamespaces() as $i => $text ) {
                                $xNamespaces[strtolower($text)] = $i;
                        }
                }
@@ -156,6 +176,25 @@ class MWNamespace {
                }
        }
 
+       /**
+        * Returns an array of the namespaces (by integer id) that exist on the
+        * wiki. Used primarily by the api in help documentation.
+        * @return array
+        */
+       public static function getValidNamespaces() {
+               static $mValidNamespaces = null;
+
+               if ( is_null( $mValidNamespaces ) ) {
+                       foreach ( array_keys( self::getCanonicalNamespaces() ) as $ns ) {
+                               if ( $ns >= 0 ) {
+                                       $mValidNamespaces[] = $ns;
+                               }
+                       }
+               }
+
+               return $mValidNamespaces;
+       }
+
        /**
         * Can this namespace ever have a talk namespace?
         *
@@ -163,7 +202,7 @@ class MWNamespace {
         * @return bool
         */
         public static function canTalk( $index ) {
-               return $index >= NS_MAIN;
+               return $index >= NS_MAIN;
         }
 
        /**
@@ -198,10 +237,10 @@ class MWNamespace {
                global $wgNamespacesWithSubpages;
                return !empty( $wgNamespacesWithSubpages[$index] );
        }
-       
+
        /**
         * Is the namespace first-letter capitalized?
-        * 
+        *
         * @param $index int Index to check
         * @return bool
         */
@@ -209,10 +248,10 @@ class MWNamespace {
                global $wgCapitalLinks, $wgCapitalLinkOverrides;
                // Turn NS_MEDIA into NS_FILE
                $index = $index === NS_MEDIA ? NS_FILE : $index;
-               
+
                // Make sure to get the subject of our namespace
                $index = self::getSubject( $index );
-               
+
                // Some namespaces are special and should always be upper case
                if ( in_array( $index, self::$alwaysCapitalizedNamespaces ) ) {
                        return true;