includes/Namespace.php

   1 <?php
   2 /**
   3  * Provide things related to namespaces
   4  * @package MediaWiki
   5  */
   6
   7 /**
   8  * This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
   9  */
  10 if( defined( 'MEDIAWIKI' ) ) {
  11
  12
  13 /**
  14  * Definitions of the NS_ constants are in Defines.php
  15  * @private
  16  */
  17 $wgCanonicalNamespaceNames = array(
  18         NS_MEDIA            => 'Media',
  19         NS_SPECIAL          => 'Special',
  20         NS_TALK             => 'Talk',
  21         NS_USER             => 'User',
  22         NS_USER_TALK        => 'User_talk',
  23         NS_PROJECT          => 'Project',
  24         NS_PROJECT_TALK     => 'Project_talk',
  25         NS_IMAGE            => 'Image',
  26         NS_IMAGE_TALK       => 'Image_talk',
  27         NS_MEDIAWIKI        => 'MediaWiki',
  28         NS_MEDIAWIKI_TALK   => 'MediaWiki_talk',
  29         NS_TEMPLATE         => 'Template',
  30         NS_TEMPLATE_TALK    => 'Template_talk',
  31         NS_HELP             => 'Help',
  32         NS_HELP_TALK        => 'Help_talk',
  33         NS_CATEGORY         => 'Category',
  34         NS_CATEGORY_TALK    => 'Category_talk',
  35 );
  36
  37 if( is_array( $wgExtraNamespaces ) ) {
  38         $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
  39 }
  40
  41 /**
  42  * This is a utility class with only static functions
  43  * for dealing with namespaces that encodes all the
  44  * "magic" behaviors of them based on index.  The textual
  45  * names of the namespaces are handled by Language.php.
  46  *
  47  * These are synonyms for the names given in the language file
  48  * Users and translators should not change them
  49  *
  50  * @package MediaWiki
  51  */
  52 class Namespace {
  53
  54         /**
  55          * Check if the given namespace might be moved
  56          * @return bool
  57          */
  58         function isMovable( $index ) {
  59                 if ( $index < NS_MAIN || $index == NS_IMAGE  || $index == NS_CATEGORY ) {
  60                         return false;
  61                 }
  62                 return true;
  63         }
  64
  65         /**
  66          * Check if the give namespace is a talk page
  67          * @return bool
  68          */
  69         function isTalk( $index ) {
  70                 return ($index > 0)  // Special namespaces are negative
  71                         && ($index % 2); // Talk namespaces are odd-numbered
  72         }
  73
  74         /**
  75          * Get the talk namespace corresponding to the given index
  76          */
  77         function getTalk( $index ) {
  78                 if ( Namespace::isTalk( $index ) ) {
  79                         return $index;
  80                 } else {
  81                         # FIXME
  82                         return $index + 1;
  83                 }
  84         }
  85
  86         function getSubject( $index ) {
  87                 if ( Namespace::isTalk( $index ) ) {
  88                         return $index - 1;
  89                 } else {
  90                         return $index;
  91                 }
  92         }
  93
  94         /**
  95          * Returns the canonical (English Wikipedia) name for a given index
  96          */
  97         function getCanonicalName( $index ) {
  98                 global $wgCanonicalNamespaceNames;
  99                 return $wgCanonicalNamespaceNames[$index];
 100         }
 101
 102         /**
 103          * Returns the index for a given canonical name, or NULL
 104          * The input *must* be converted to lower case first
 105          */
 106         function getCanonicalIndex( $name ) {
 107                 global $wgCanonicalNamespaceNames;
 108                 static $xNamespaces = false;
 109                 if ( $xNamespaces === false ) {
 110                         $xNamespaces = array();
 111                         foreach ( $wgCanonicalNamespaceNames as $i => $text ) {
 112                                 $xNamespaces[strtolower($text)] = $i;
 113                         }
 114                 }
 115                 if ( array_key_exists( $name, $xNamespaces ) ) {
 116                         return $xNamespaces[$name];
 117                 } else {
 118                         return NULL;
 119                 }
 120         }
 121 }
 122
 123 }
 124 ?>