Throw an exception if Parser::disableCache is called before mOutput initialized ...

[lhc/web/wiklou.git] / includes / Namespace.php

diff --git a/includes/Namespace.php b/includes/Namespace.php
index 2e4b789..512a78a 100644 (file)
--- a/includes/Namespace.php
+++ b/includes/Namespace.php
@@ -4,35 +4,6 @@
  * @file
  */
 
-/**
- * Definitions of the NS_ constants are in Defines.php
- * @private
- */
-$wgCanonicalNamespaceNames = array(
-       NS_MEDIA            => 'Media',
-       NS_SPECIAL          => 'Special',
-       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',
-);
-
-/// @todo UGLY UGLY
-if( is_array( $wgExtraNamespaces ) ) {
-       $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
-}
-
 /**
  * This is a utility class with only static functions
  * for dealing with namespaces that encodes all the
@@ -53,6 +24,24 @@ class MWNamespace {
         */
        private static $alwaysCapitalizedNamespaces = array( NS_SPECIAL, NS_USER, NS_MEDIAWIKI );
 
+       /**
+        * Throw an exception when trying to get the subject or talk page
+        * for a given namespace where it does not make sense.
+        * Special namespaces are defined in includes/Defines.php and have
+        * a value below 0 (ex: NS_SPECIAL = -1 , NS_MEDIA = -2)
+        *
+        * @param $index
+        * @param $method
+        *
+        * @return true
+        */
+       private static function isMethodValidFor( $index, $method ) {
+               if( $index < NS_MAIN ) {
+                       throw new MWException( "$method does not make any sense for given namespace $index" );
+               }
+               return true;
+       }
+
        /**
         * Can pages in the given namespace be moved?
         *
@@ -69,11 +58,21 @@ class MWNamespace {
         *
         * @param $index Int: namespace index
         * @return bool
+        * @since 1.19
         */
-       public static function isMain( $index ) {
+       public static function isSubject( $index ) {
                return !self::isTalk( $index );
        }
 
+       /**
+        * @see self::isSubject
+        * @deprecated Please use the more consistently named isSubject (since 1.19)
+        */
+       public static function isMain( $index ) {
+               wfDeprecated( __METHOD__, '1.19' );
+               return self::isSubject( $index );
+       }
+
        /**
         * Is the given namespace a talk namespace?
         *
@@ -92,6 +91,7 @@ class MWNamespace {
         * @return int
         */
        public static function getTalk( $index ) {
+               self::isMethodValidFor( $index, __METHOD__ );
                return self::isTalk( $index )
                        ? $index
                        : $index + 1;
@@ -99,24 +99,88 @@ class MWNamespace {
 
        /**
         * Get the subject namespace index for a given namespace
+        * Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
         *
         * @param $index Int: Namespace index
         * @return int
         */
        public static function getSubject( $index ) {
+               # Handle special namespaces
+               if( $index < NS_MAIN ) {
+                       return $index;
+               }
+
                return self::isTalk( $index )
                        ? $index - 1
                        : $index;
        }
 
+       /**
+        * Get the associated namespace.
+        * For talk namespaces, returns the subject (non-talk) namespace
+        * For subject (non-talk) namespaces, returns the talk namespace
+        *
+        * @param $index Int: namespace index
+        * @return int or null if no associated namespace could be found
+        */
+       public static function getAssociated( $index ) {
+               self::isMethodValidFor( $index, __METHOD__ );
+
+               if( self::isSubject( $index ) ) {
+                       return self::getTalk( $index );
+               } elseif( self::isTalk( $index ) ) {
+                       return self::getSubject( $index );
+               } else {
+                       return null;
+               }
+       }
+
        /**
         * Returns whether the specified namespace exists
+        *
+        * @param $index
+        *
+        * @return bool
+        * @since 1.19
         */
        public static function exists( $index ) {
                $nslist = self::getCanonicalNamespaces();
                return isset( $nslist[$index] );
        }
 
+       /**
+        * 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.
+        *
+        * @param $ns1 int The first namespace index
+        * @param $ns2 int The second namespae index
+        *
+        * @return bool
+        * @since 1.19
+        */
+       public static function equals( $ns1, $ns2 ) {
+               return $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.
+        *
+        * @param $ns1 int The first namespace index
+        * @param $ns2 int The second namespae index
+        *
+        * @return bool
+        * @since 1.19
+        */
+       public static function subjectEquals( $ns1, $ns2 ) {
+               return self::getSubject( $ns1 ) == self::getSubject( $ns2 );
+       }
+
        /**
         * Returns array of all defined namespaces with their canonical
         * (English) names.