* @file
*/
-/**
- * Definitions of the NS_ constants are in Defines.php
- * @private
- */
-global $wgCanonicalNamespaceNames;
-$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',
-);
-
-if( isset( $wgExtraNamespaces ) && is_array( $wgExtraNamespaces ) ) {
- $wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
-}
-
/**
* This is a utility class with only static functions
* for dealing with namespaces that encodes all the
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 );
+ /**
+ * 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?
*
* @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
*/
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::isMain( $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
*/
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;
+ $namespaces = array( NS_MAIN => '' ) + $wgCanonicalNamespaceNames;
+ if ( is_array( $wgExtraNamespaces ) ) {
+ $namespaces += $wgExtraNamespaces;
+ }
+ 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;
}
* @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;
}
}
}
}
+ /**
+ * 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?
*
* @return bool
*/
public static function canTalk( $index ) {
- return $index >= NS_MAIN;
+ return $index >= NS_MAIN;
}
/**
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
*/
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;
// 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;
+ }
+
}
dépôts / lhc / web / wiklou.git / blobdiff