2004-02-18 02:15:00 +00:00
|
|
|
<?php
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Provide things related to namespaces
|
WARNING: HUGE COMMIT
Doxygen documentation update:
* Changed alls @addtogroup to @ingroup. @addtogroup adds the comment to the group description, but doesn't add the file, class, function, ... to the group like @ingroup does. See for example http://svn.wikimedia.org/doc/group__SpecialPage.html where it's impossible to see related files, classes, ... that should belong to that group.
* Added @file to file description, it seems that it should be explicitely decalred for file descriptions, otherwise doxygen will think that the comment document the first class, variabled, function, ... that is in that file.
* Removed some empty comments
* Removed some ?>
Added following groups:
* ExternalStorage
* JobQueue
* MaintenanceLanguage
One more thing: there are still a lot of warnings when generating the doc.
2008-05-20 17:13:28 +00:00
|
|
|
* @file
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2005-08-02 13:35:19 +00:00
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Definitions of the NS_ constants are in Defines.php
|
2006-06-10 18:28:50 +00:00
|
|
|
* @private
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
|
|
|
|
$wgCanonicalNamespaceNames = array(
|
2004-08-22 17:24:50 +00:00
|
|
|
NS_MEDIA => 'Media',
|
|
|
|
|
NS_SPECIAL => 'Special',
|
2006-11-27 22:55:12 +00:00
|
|
|
NS_TALK => 'Talk',
|
2004-08-22 17:24:50 +00:00
|
|
|
NS_USER => 'User',
|
|
|
|
|
NS_USER_TALK => 'User_talk',
|
2004-08-28 17:53:12 +00:00
|
|
|
NS_PROJECT => 'Project',
|
|
|
|
|
NS_PROJECT_TALK => 'Project_talk',
|
2004-08-22 17:24:50 +00:00
|
|
|
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',
|
2006-11-27 22:55:12 +00:00
|
|
|
NS_CATEGORY => 'Category',
|
2004-12-21 15:04:40 +00:00
|
|
|
NS_CATEGORY_TALK => 'Category_talk',
|
2004-04-05 10:38:40 +00:00
|
|
|
);
|
|
|
|
|
|
2005-06-24 06:08:53 +00:00
|
|
|
if( is_array( $wgExtraNamespaces ) ) {
|
2004-09-09 06:12:04 +00:00
|
|
|
$wgCanonicalNamespaceNames = $wgCanonicalNamespaceNames + $wgExtraNamespaces;
|
2004-08-31 10:23:55 +00:00
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* This is a utility class with only static functions
|
|
|
|
|
* for dealing with namespaces that encodes all the
|
|
|
|
|
* "magic" behaviors of them based on index. The textual
|
|
|
|
|
* names of the namespaces are handled by Language.php.
|
|
|
|
|
*
|
|
|
|
|
* These are synonyms for the names given in the language file
|
|
|
|
|
* Users and translators should not change them
|
2004-09-03 23:00:01 +00:00
|
|
|
*
|
|
|
|
|
*/
|
2007-12-16 15:39:24 +00:00
|
|
|
|
2008-03-21 23:13:34 +00:00
|
|
|
class MWNamespace {
|
2003-04-14 23:10:40 +00:00
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2007-08-14 01:14:42 +00:00
|
|
|
* Can pages in the given namespace be moved?
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: namespace index
|
2004-09-02 23:28:24 +00:00
|
|
|
* @return bool
|
|
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function isMovable( $index ) {
|
2008-05-03 13:09:34 +00:00
|
|
|
global $wgAllowImageMoving;
|
|
|
|
|
return !( $index < NS_MAIN || ($index == NS_IMAGE && !$wgAllowImageMoving) || $index == NS_CATEGORY );
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2005-11-03 01:29:02 +00:00
|
|
|
/**
|
2007-08-14 01:14:42 +00:00
|
|
|
* Is the given namespace is a subject (non-talk) namespace?
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: namespace index
|
2005-11-03 01:29:02 +00:00
|
|
|
* @return bool
|
|
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function isMain( $index ) {
|
|
|
|
|
return !self::isTalk( $index );
|
2005-11-03 01:29:02 +00:00
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2007-08-14 01:14:42 +00:00
|
|
|
* Is the given namespace a talk namespace?
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: namespace index
|
2004-09-02 23:28:24 +00:00
|
|
|
* @return bool
|
|
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function isTalk( $index ) {
|
|
|
|
|
return $index > NS_MAIN
|
|
|
|
|
&& $index % 2;
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
2007-08-14 01:14:42 +00:00
|
|
|
* Get the talk namespace index for a given namespace
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: namespace index
|
2007-08-14 01:14:42 +00:00
|
|
|
* @return int
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function getTalk( $index ) {
|
|
|
|
|
return self::isTalk( $index )
|
|
|
|
|
? $index
|
|
|
|
|
: $index + 1;
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
|
|
|
|
|
2007-08-14 01:14:42 +00:00
|
|
|
/**
|
|
|
|
|
* Get the subject namespace index for a given namespace
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: Namespace index
|
2007-08-14 01:14:42 +00:00
|
|
|
* @return int
|
|
|
|
|
*/
|
|
|
|
|
public static function getSubject( $index ) {
|
|
|
|
|
return self::isTalk( $index )
|
|
|
|
|
? $index - 1
|
|
|
|
|
: $index;
|
2003-04-14 23:10:40 +00:00
|
|
|
}
|
2004-04-05 10:38:40 +00:00
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Returns the canonical (English Wikipedia) name for a given index
|
2007-08-14 01:14:42 +00:00
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: namespace index
|
2007-08-14 01:14:42 +00:00
|
|
|
* @return string
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function getCanonicalName( $index ) {
|
2004-04-05 10:38:40 +00:00
|
|
|
global $wgCanonicalNamespaceNames;
|
|
|
|
|
return $wgCanonicalNamespaceNames[$index];
|
|
|
|
|
}
|
|
|
|
|
|
2004-09-02 23:28:24 +00:00
|
|
|
/**
|
|
|
|
|
* Returns the index for a given canonical name, or NULL
|
|
|
|
|
* The input *must* be converted to lower case first
|
2007-08-14 01:14:42 +00:00
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $name String: namespace name
|
2007-08-14 01:14:42 +00:00
|
|
|
* @return int
|
2004-09-02 23:28:24 +00:00
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function getCanonicalIndex( $name ) {
|
2004-04-05 10:38:40 +00:00
|
|
|
global $wgCanonicalNamespaceNames;
|
|
|
|
|
static $xNamespaces = false;
|
|
|
|
|
if ( $xNamespaces === false ) {
|
|
|
|
|
$xNamespaces = array();
|
|
|
|
|
foreach ( $wgCanonicalNamespaceNames as $i => $text ) {
|
|
|
|
|
$xNamespaces[strtolower($text)] = $i;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
if ( array_key_exists( $name, $xNamespaces ) ) {
|
|
|
|
|
return $xNamespaces[$name];
|
|
|
|
|
} else {
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2006-04-12 15:38:17 +00:00
|
|
|
/**
|
|
|
|
|
* Can this namespace ever have a talk namespace?
|
2007-08-14 01:14:42 +00:00
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: namespace index
|
2007-08-14 01:14:42 +00:00
|
|
|
* @return bool
|
2006-04-12 15:38:17 +00:00
|
|
|
*/
|
2007-08-14 01:14:42 +00:00
|
|
|
public static function canTalk( $index ) {
|
|
|
|
|
return $index >= NS_MAIN;
|
2006-04-12 15:38:17 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2007-01-08 15:32:58 +00:00
|
|
|
/**
|
|
|
|
|
* Does this namespace contain content, for the purposes
|
|
|
|
|
* of calculating statistics, etc?
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int: index to check
|
2007-01-08 15:32:58 +00:00
|
|
|
* @return bool
|
|
|
|
|
*/
|
|
|
|
|
public static function isContent( $index ) {
|
|
|
|
|
global $wgContentNamespaces;
|
|
|
|
|
return $index == NS_MAIN || in_array( $index, $wgContentNamespaces );
|
2007-07-05 18:20:46 +00:00
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
2007-07-05 18:20:46 +00:00
|
|
|
/**
|
|
|
|
|
* Can pages in a namespace be watched?
|
|
|
|
|
*
|
2008-05-21 18:18:58 +00:00
|
|
|
* @param $index Int
|
2007-07-05 18:20:46 +00:00
|
|
|
* @return bool
|
|
|
|
|
*/
|
|
|
|
|
public static function isWatchable( $index ) {
|
|
|
|
|
return $index >= NS_MAIN;
|
|
|
|
|
}
|
2008-04-14 07:45:50 +00:00
|
|
|
|
|
|
|
|
}
|