Set values from query params (bug 12750)
[lhc/web/wiklou.git] / includes / Namespace.php
index 69ee063..7c7b7de 100644 (file)
@@ -1,15 +1,9 @@
 <?php
 /**
  * Provide things related to namespaces
- * @package MediaWiki
+ * @file
  */
-/**
- * This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
- */
-if( defined( 'MEDIAWIKI' ) ) {
 
 /**
  * Definitions of the NS_ constants are in Defines.php
  * @private
@@ -17,7 +11,7 @@ if( defined( 'MEDIAWIKI' ) ) {
 $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',
@@ -30,14 +24,11 @@ $wgCanonicalNamespaceNames = array(
        NS_TEMPLATE_TALK    => 'Template_talk',
        NS_HELP             => 'Help',
        NS_HELP_TALK        => 'Help_talk',
-       NS_CATEGORY             => 'Category',
-       NS_CATEGORY_TALK    => 'Category_talk'
-    
-       NS_THREAD               => 'Thread',        // Reserved for Forum-like
-       NS_THREAD_TALK      => 'Thread_talk'    // Reserved for Forum-like
+       NS_CATEGORY         => 'Category',
+       NS_CATEGORY_TALK    => 'Category_talk',
 );
 
-if( defined( 'MEDIAWIKI' ) && is_array( $wgExtraNamespaces ) ) {
+if( is_array( $wgExtraNamespaces ) ) {
        $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
 }
 
@@ -50,72 +41,73 @@ if( defined( 'MEDIAWIKI' ) && is_array( $wgExtraNamespaces ) ) {
  * 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
-        * @deprecated
+class MWNamespace {
+
+       /**
+        * Can pages in the given namespace be moved?
+        *
+        * @param $index Int: namespace index
+        * @return bool
         */
-       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; }
-       /**#@-*/
+       public static function isMovable( $index ) {
+               global $wgAllowImageMoving;
+               return !( $index < NS_MAIN || ($index == NS_IMAGE && !$wgAllowImageMoving)  || $index == NS_CATEGORY );
+       }
 
        /**
-        * Check if the given namespace might be moved
+        * Is the given namespace is a subject (non-talk) namespace?
+        *
+        * @param $index Int: namespace index
         * @return bool
         */
-       function isMovable( $index ) {
-               if ( $index < NS_MAIN || $index == NS_IMAGE  || $index == NS_CATEGORY ) { 
-                       return false; 
-               }
-               return true;
+       public static function isMain( $index ) {
+               return !self::isTalk( $index );
        }
 
        /**
-        * Check if the give namespace is a talk page
+        * Is the given namespace a talk namespace?
+        *
+        * @param $index Int: namespace index
         * @return bool
         */
-       function isTalk( $index ) {
-               global $wgExtraNamespaces;
-               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 
-                                ||  ( (isset($wgExtraNamespaces) && $index % 2) )
-                                );
-               
+       public static function isTalk( $index ) {
+               return $index > NS_MAIN
+                       && $index % 2;
        }
 
        /**
-        * Get the talk namespace corresponding to the given index
+        * Get the talk namespace index for a given namespace
+        *
+        * @param $index Int: namespace index
+        * @return int
         */
-       function getTalk( $index ) {
-               if ( Namespace::isTalk( $index ) ) {
-                       return $index;
-               } else {
-                       # FIXME
-                       return $index + 1;
-               }
+       public static function getTalk( $index ) {
+               return self::isTalk( $index )
+                       ? $index
+                       : $index + 1;
        }
 
-       function getSubject( $index ) {
-               if ( Namespace::isTalk( $index ) ) {
-                       return $index - 1;
-               } else {
-                       return $index;
-               }
+       /**
+        * Get the subject namespace index for a given namespace
+        *
+        * @param $index Int: Namespace index
+        * @return int
+        */
+       public static function getSubject( $index ) {
+               return self::isTalk( $index )
+                       ? $index - 1
+                       : $index;
        }
 
        /**
         * Returns the canonical (English Wikipedia) name for a given index
+        *
+        * @param $index Int: namespace index
+        * @return string
         */
-       function &getCanonicalName( $index ) {
+       public static function getCanonicalName( $index ) {
                global $wgCanonicalNamespaceNames;
                return $wgCanonicalNamespaceNames[$index];
        }
@@ -123,8 +115,11 @@ class Namespace {
        /**
         * Returns the index for a given canonical name, or NULL
         * The input *must* be converted to lower case first
+        *
+        * @param $name String: namespace name
+        * @return int
         */
-       function &getCanonicalIndex( $name ) {
+       public static function getCanonicalIndex( $name ) {
                global $wgCanonicalNamespaceNames;
                static $xNamespaces = false;
                if ( $xNamespaces === false ) {
@@ -139,7 +134,48 @@ class Namespace {
                        return NULL;
                }
        }
-}
+
+       /**
+        * Can this namespace ever have a talk namespace?
+        *
+        * @param $index Int: namespace index
+        * @return bool
+        */
+        public static function canTalk( $index ) {
+               return $index >= NS_MAIN;
+        }
+
+       /**
+        * Does this namespace contain content, for the purposes of calculating
+        * statistics, etc?
+        *
+        * @param $index Int: index to check
+        * @return bool
+        */
+       public static function isContent( $index ) {
+               global $wgContentNamespaces;
+               return $index == NS_MAIN || in_array( $index, $wgContentNamespaces );
+       }
+
+       /**
+        * Can pages in a namespace be watched?
+        *
+        * @param $index Int
+        * @return bool
+        */
+       public static function isWatchable( $index ) {
+               return $index >= NS_MAIN;
+       }
+
+       /**
+        * Does the namespace allow subpages?
+        *
+        * @param $index int Index to check
+        * @return bool
+        */
+       public static function hasSubpages( $index ) {
+               global $wgNamespacesWithSubpages;
+               return !empty( $wgNamespacesWithSubpages[$index] );
+       }
 
 }
-?>