<?php
/**
- * Provide things related to namespaces
- */
-
-/**
- * Definitions of the NS_ constants are in Defines.php
- * @private
+ * Provide things related to namespaces.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
*/
-$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_IMAGE => 'Image',
- NS_IMAGE_TALK => 'Image_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',
-);
-
-if( is_array( $wgExtraNamespaces ) ) {
- $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
-}
/**
* This is a utility class with only static functions
* Users and translators should not change them
*
*/
-class Namespace {
+class MWNamespace {
/**
- * Check if the given namespace might be moved
+ * 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 );
+
+ /**
+ * 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 bool
*/
- static function isMovable( $index ) {
- return !( $index < NS_MAIN || $index == NS_IMAGE || $index == NS_CATEGORY );
+ 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;
}
/**
- * Check if the given namespace is not a talk page
+ * Can pages in the given namespace be moved?
+ *
+ * @param $index Int: namespace index
* @return bool
*/
- static function isMain( $index ) {
- return ! Namespace::isTalk( $index );
+ public static function isMovable( $index ) {
+ global $wgAllowImageMoving;
+ return !( $index < NS_MAIN || ( $index == NS_FILE && !$wgAllowImageMoving ) || $index == NS_CATEGORY );
}
/**
- * Check if the give namespace is a talk page
+ * Is the given namespace is a subject (non-talk) namespace?
+ *
+ * @param $index Int: namespace index
* @return bool
+ * @since 1.19
*/
- static function isTalk( $index ) {
- return ($index > NS_MAIN) // Special namespaces are negative
- && ($index % 2); // Talk namespaces are odd-numbered
+ public static function isSubject( $index ) {
+ return !self::isTalk( $index );
}
/**
- * Get the talk namespace corresponding to the given index
+ * @see self::isSubject
+ * @deprecated Please use the more consistently named isSubject (since 1.19)
+ * @return bool
+ */
+ public static function isMain( $index ) {
+ wfDeprecated( __METHOD__, '1.19' );
+ return self::isSubject( $index );
+ }
+
+ /**
+ * Is the given namespace a talk namespace?
+ *
+ * @param $index Int: namespace index
+ * @return bool
+ */
+ public static function isTalk( $index ) {
+ return $index > NS_MAIN
+ && $index % 2;
+ }
+
+ /**
+ * Get the talk namespace index for a given namespace
+ *
+ * @param $index Int: namespace index
+ * @return int
+ */
+ public static function getTalk( $index ) {
+ self::isMethodValidFor( $index, __METHOD__ );
+ return self::isTalk( $index )
+ ? $index
+ : $index + 1;
+ }
+
+ /**
+ * 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
*/
- static function getTalk( $index ) {
- if ( Namespace::isTalk( $index ) ) {
+ public static function getSubject( $index ) {
+ # Handle special namespaces
+ if ( $index < NS_MAIN ) {
return $index;
- } else {
- # FIXME
- return $index + 1;
}
+
+ return self::isTalk( $index )
+ ? $index - 1
+ : $index;
}
- static function getSubject( $index ) {
- if ( Namespace::isTalk( $index ) ) {
- return $index - 1;
+ /**
+ * 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 $index;
+ return null;
}
}
/**
- * Returns the canonical (English Wikipedia) name for a given index
+ * 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
*/
- static function getCanonicalName( $index ) {
- global $wgCanonicalNamespaceNames;
- return $wgCanonicalNamespaceNames[$index];
+ public static function subjectEquals( $ns1, $ns2 ) {
+ return self::getSubject( $ns1 ) == self::getSubject( $ns2 );
+ }
+
+ /**
+ * Returns array of all defined namespaces with their canonical
+ * (English) names.
+ *
+ * @param bool $rebuild rebuild namespace list (default = false). Used for testing.
+ *
+ * @return array
+ * @since 1.17
+ */
+ public static function getCanonicalNamespaces( $rebuild = false ) {
+ static $namespaces = null;
+ if ( $namespaces === null || $rebuild ) {
+ global $wgExtraNamespaces, $wgCanonicalNamespaceNames;
+ $namespaces = array( NS_MAIN => '' ) + $wgCanonicalNamespaceNames;
+ if ( is_array( $wgExtraNamespaces ) ) {
+ $namespaces += $wgExtraNamespaces;
+ }
+ wfRunHooks( 'CanonicalNamespaces', array( &$namespaces ) );
+ }
+ return $namespaces;
+ }
+
+ /**
+ * 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 ) {
+ $nslist = self::getCanonicalNamespaces();
+ if ( isset( $nslist[$index] ) ) {
+ return $nslist[$index];
+ } else {
+ return false;
+ }
}
/**
* 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
*/
- static function getCanonicalIndex( $name ) {
- global $wgCanonicalNamespaceNames;
+ public static function getCanonicalIndex( $name ) {
static $xNamespaces = false;
if ( $xNamespaces === false ) {
$xNamespaces = array();
- foreach ( $wgCanonicalNamespaceNames as $i => $text ) {
- $xNamespaces[strtolower($text)] = $i;
+ foreach ( self::getCanonicalNamespaces() as $i => $text ) {
+ $xNamespaces[strtolower( $text )] = $i;
}
}
if ( array_key_exists( $name, $xNamespaces ) ) {
return $xNamespaces[$name];
} else {
- return NULL;
+ return null;
+ }
+ }
+
+ /**
+ * 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?
- * @param $index Namespace index
+ *
+ * @param $index Int: namespace index
+ * @return bool
*/
- static function canTalk( $index ) {
- return( $index >= NS_MAIN );
+ public static function canTalk( $index ) {
+ return $index >= NS_MAIN;
}
-
+
/**
- * Does this namespace contain content, for the purposes
- * of calculating statistics, etc?
+ * Does this namespace contain content, for the purposes of calculating
+ * statistics, etc?
*
- * @param $index Index to check
+ * @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] );
+ }
+
+ /**
+ * Get a list of all namespace indices which are considered to contain content
+ * @return array of namespace indices
+ */
+ public static function getContentNamespaces() {
+ global $wgContentNamespaces;
+ if ( !is_array( $wgContentNamespaces ) || $wgContentNamespaces === array() ) {
+ return NS_MAIN;
+ } elseif ( !in_array( NS_MAIN, $wgContentNamespaces ) ) {
+ // always force NS_MAIN to be part of array (to match the algorithm used by isContent)
+ return array_merge( array( NS_MAIN ), $wgContentNamespaces );
+ } else {
+ return $wgContentNamespaces;
+ }
+ }
+ /**
+ * Is the namespace first-letter capitalized?
+ *
+ * @param $index int Index to check
+ * @return bool
+ */
+ public static function isCapitalized( $index ) {
+ 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;
+ }
+ if ( isset( $wgCapitalLinkOverrides[ $index ] ) ) {
+ // $wgCapitalLinkOverrides is explicitly set
+ return $wgCapitalLinkOverrides[ $index ];
+ }
+ // Default to the global setting
+ return $wgCapitalLinks;
+ }
+
+ /**
+ * Does the namespace (potentially) have different aliases for different
+ * genders. Not all languages make a distinction here.
+ *
+ * @since 1.18
+ * @param $index int Index to check
+ * @return bool
+ */
+ public static function hasGenderDistinction( $index ) {
+ return $index == NS_USER || $index == NS_USER_TALK;
+ }
+
+ /**
+ * It is not possible to use pages from this namespace as template?
+ *
+ * @since 1.20
+ * @param $index int Index to check
+ * @return bool
+ */
+ public static function isNonincludable( $index ) {
+ global $wgNonincludableNamespaces;
+ return $wgNonincludableNamespaces && in_array( $index, $wgNonincludableNamespaces );
+ }
-?>
+}
dépôts / lhc / web / wiklou.git / blobdiff