MediaWiki  1.28.0
MWNamespace.php
Go to the documentation of this file.
1 <?php
33 class MWNamespace {
34 
41 
54  private static function isMethodValidFor( $index, $method ) {
55  if ( $index < NS_MAIN ) {
56  throw new MWException( "$method does not make any sense for given namespace $index" );
57  }
58  return true;
59  }
60 
67  public static function isMovable( $index ) {
69 
70  $result = !( $index < NS_MAIN || ( $index == NS_FILE && !$wgAllowImageMoving ) );
71 
75  Hooks::run( 'NamespaceIsMovable', [ $index, &$result ] );
76 
77  return $result;
78  }
79 
87  public static function isSubject( $index ) {
88  return !self::isTalk( $index );
89  }
90 
97  public static function isTalk( $index ) {
98  return $index > NS_MAIN
99  && $index % 2;
100  }
101 
108  public static function getTalk( $index ) {
109  self::isMethodValidFor( $index, __METHOD__ );
110  return self::isTalk( $index )
111  ? $index
112  : $index + 1;
113  }
114 
122  public static function getSubject( $index ) {
123  # Handle special namespaces
124  if ( $index < NS_MAIN ) {
125  return $index;
126  }
127 
128  return self::isTalk( $index )
129  ? $index - 1
130  : $index;
131  }
132 
141  public static function getAssociated( $index ) {
142  self::isMethodValidFor( $index, __METHOD__ );
143 
144  if ( self::isSubject( $index ) ) {
145  return self::getTalk( $index );
146  } elseif ( self::isTalk( $index ) ) {
147  return self::getSubject( $index );
148  } else {
149  return null;
150  }
151  }
152 
161  public static function exists( $index ) {
162  $nslist = self::getCanonicalNamespaces();
163  return isset( $nslist[$index] );
164  }
165 
180  public static function equals( $ns1, $ns2 ) {
181  return $ns1 == $ns2;
182  }
183 
195  public static function subjectEquals( $ns1, $ns2 ) {
196  return self::getSubject( $ns1 ) == self::getSubject( $ns2 );
197  }
198 
208  public static function getCanonicalNamespaces( $rebuild = false ) {
209  static $namespaces = null;
210  if ( $namespaces === null || $rebuild ) {
213  // Add extension namespaces
214  $namespaces += ExtensionRegistry::getInstance()->getAttribute( 'ExtensionNamespaces' );
215  if ( is_array( $wgExtraNamespaces ) ) {
217  }
218  Hooks::run( 'CanonicalNamespaces', [ &$namespaces ] );
219  }
220  return $namespaces;
221  }
222 
229  public static function getCanonicalName( $index ) {
230  $nslist = self::getCanonicalNamespaces();
231  if ( isset( $nslist[$index] ) ) {
232  return $nslist[$index];
233  } else {
234  return false;
235  }
236  }
237 
245  public static function getCanonicalIndex( $name ) {
246  static $xNamespaces = false;
247  if ( $xNamespaces === false ) {
248  $xNamespaces = [];
249  foreach ( self::getCanonicalNamespaces() as $i => $text ) {
250  $xNamespaces[strtolower( $text )] = $i;
251  }
252  }
253  if ( array_key_exists( $name, $xNamespaces ) ) {
254  return $xNamespaces[$name];
255  } else {
256  return null;
257  }
258  }
259 
265  public static function getValidNamespaces() {
266  static $mValidNamespaces = null;
267 
268  if ( is_null( $mValidNamespaces ) ) {
269  foreach ( array_keys( self::getCanonicalNamespaces() ) as $ns ) {
270  if ( $ns >= 0 ) {
271  $mValidNamespaces[] = $ns;
272  }
273  }
274  // T109137: sort numerically
275  sort( $mValidNamespaces, SORT_NUMERIC );
276  }
277 
278  return $mValidNamespaces;
279  }
280 
287  public static function canTalk( $index ) {
288  return $index >= NS_MAIN;
289  }
290 
298  public static function isContent( $index ) {
300  return $index == NS_MAIN || in_array( $index, $wgContentNamespaces );
301  }
302 
310  public static function wantSignatures( $index ) {
311  global $wgExtraSignatureNamespaces;
312  return self::isTalk( $index ) || in_array( $index, $wgExtraSignatureNamespaces );
313  }
314 
321  public static function isWatchable( $index ) {
322  return $index >= NS_MAIN;
323  }
324 
331  public static function hasSubpages( $index ) {
333  return !empty( $wgNamespacesWithSubpages[$index] );
334  }
335 
340  public static function getContentNamespaces() {
342  if ( !is_array( $wgContentNamespaces ) || $wgContentNamespaces === [] ) {
343  return [ NS_MAIN ];
344  } elseif ( !in_array( NS_MAIN, $wgContentNamespaces ) ) {
345  // always force NS_MAIN to be part of array (to match the algorithm used by isContent)
346  return array_merge( [ NS_MAIN ], $wgContentNamespaces );
347  } else {
348  return $wgContentNamespaces;
349  }
350  }
351 
358  public static function getSubjectNamespaces() {
359  return array_filter(
361  'MWNamespace::isSubject'
362  );
363  }
364 
371  public static function getTalkNamespaces() {
372  return array_filter(
374  'MWNamespace::isTalk'
375  );
376  }
377 
384  public static function isCapitalized( $index ) {
386  // Turn NS_MEDIA into NS_FILE
387  $index = $index === NS_MEDIA ? NS_FILE : $index;
388 
389  // Make sure to get the subject of our namespace
390  $index = self::getSubject( $index );
391 
392  // Some namespaces are special and should always be upper case
393  if ( in_array( $index, self::$alwaysCapitalizedNamespaces ) ) {
394  return true;
395  }
396  if ( isset( $wgCapitalLinkOverrides[$index] ) ) {
397  // $wgCapitalLinkOverrides is explicitly set
398  return $wgCapitalLinkOverrides[$index];
399  }
400  // Default to the global setting
401  return $wgCapitalLinks;
402  }
403 
412  public static function hasGenderDistinction( $index ) {
413  return $index == NS_USER || $index == NS_USER_TALK;
414  }
415 
423  public static function isNonincludable( $index ) {
424  global $wgNonincludableNamespaces;
425  return $wgNonincludableNamespaces && in_array( $index, $wgNonincludableNamespaces );
426  }
427 
436  public static function getNamespaceContentModel( $index ) {
437  global $wgNamespaceContentModels;
438  return isset( $wgNamespaceContentModels[$index] )
439  ? $wgNamespaceContentModels[$index]
440  : null;
441  }
442 
452  public static function getRestrictionLevels( $index, User $user = null ) {
453  global $wgNamespaceProtection, $wgRestrictionLevels;
454 
455  if ( !isset( $wgNamespaceProtection[$index] ) ) {
456  // All levels are valid if there's no namespace restriction.
457  // But still filter by user, if necessary
458  $levels = $wgRestrictionLevels;
459  if ( $user ) {
460  $levels = array_values( array_filter( $levels, function ( $level ) use ( $user ) {
461  $right = $level;
462  if ( $right == 'sysop' ) {
463  $right = 'editprotected'; // BC
464  }
465  if ( $right == 'autoconfirmed' ) {
466  $right = 'editsemiprotected'; // BC
467  }
468  return ( $right == '' || $user->isAllowed( $right ) );
469  } ) );
470  }
471  return $levels;
472  }
473 
474  // First, get the list of groups that can edit this namespace.
475  $namespaceGroups = [];
476  $combine = 'array_merge';
477  foreach ( (array)$wgNamespaceProtection[$index] as $right ) {
478  if ( $right == 'sysop' ) {
479  $right = 'editprotected'; // BC
480  }
481  if ( $right == 'autoconfirmed' ) {
482  $right = 'editsemiprotected'; // BC
483  }
484  if ( $right != '' ) {
485  $namespaceGroups = call_user_func( $combine, $namespaceGroups,
486  User::getGroupsWithPermission( $right ) );
487  $combine = 'array_intersect';
488  }
489  }
490 
491  // Now, keep only those restriction levels where there is at least one
492  // group that can edit the namespace but would be blocked by the
493  // restriction.
494  $usableLevels = [ '' ];
495  foreach ( $wgRestrictionLevels as $level ) {
496  $right = $level;
497  if ( $right == 'sysop' ) {
498  $right = 'editprotected'; // BC
499  }
500  if ( $right == 'autoconfirmed' ) {
501  $right = 'editsemiprotected'; // BC
502  }
503  if ( $right != '' && ( !$user || $user->isAllowed( $right ) ) &&
504  array_diff( $namespaceGroups, User::getGroupsWithPermission( $right ) )
505  ) {
506  $usableLevels[] = $level;
507  }
508  }
509 
510  return $usableLevels;
511  }
512 }
static isMovable($index)
Can pages in the given namespace be moved?
Definition: MWNamespace.php:67
static hasGenderDistinction($index)
Does the namespace (potentially) have different aliases for different genders.
$wgCanonicalNamespaceNames
Definitions of the NS_ constants are in Defines.php.
Definition: Setup.php:379
the array() calling protocol came about after MediaWiki 1.4rc1.
const NS_MAIN
Definition: Defines.php:56
$wgNamespacesWithSubpages
Which namespaces should support subpages? See Language.php for a list of namespaces.
static isNonincludable($index)
It is not possible to use pages from this namespace as template?
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
static getSubjectNamespaces()
List all namespace indices which are considered subject, aka not a talk or special namespace...
static canTalk($index)
Can this namespace ever have a talk namespace?
static isTalk($index)
Is the given namespace a talk namespace?
Definition: MWNamespace.php:97
const NS_SPECIAL
Definition: Defines.php:45
static exists($index)
Returns whether the specified namespace exists.
static getTalkNamespaces()
List all namespace indices which are considered talks, aka not a subject or special namespace...
when a variable name is used in a it is silently declared as a new local masking the global
Definition: design.txt:93
static getRestrictionLevels($index, User $user=null)
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a use...
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message.Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item.Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page.Return false to stop further processing of the tag $reader:XMLReader object &$pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision.Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag.Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload.Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports.&$fullInterwikiPrefix:Interwiki prefix, may contain colons.&$pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable.Can be used to lazy-load the import sources list.&$importSources:The value of $wgImportSources.Modify as necessary.See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page.$context:IContextSource object &$pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect.&$title:Title object for the current page &$request:WebRequest &$ignoreRedirect:boolean to skip redirect check &$target:Title/string of redirect target &$article:Article object 'InternalParseBeforeLinks':during Parser's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InternalParseBeforeSanitize':during Parser's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings.Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments.&$parser:Parser object &$text:string containing partially parsed text &$stripState:Parser's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not.Return true without providing an interwiki to continue interwiki search.$prefix:interwiki prefix we are looking for.&$iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user's email has been invalidated successfully.$user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification.Callee may modify $url and $query, URL will be constructed as $url.$query &$url:URL to index.php &$query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) &$article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() &$ip:IP being check &$result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from &$allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn't match your organization.$addr:The e-mail address entered by the user &$result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user &$result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we're looking for a messages file for &$file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED!Use $magicWords in a file listed in $wgExtensionMessagesFiles instead.Use this to define synonyms of magic words depending of the language &$magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces.Do not use this hook to add namespaces.Use CanonicalNamespaces for that.&$namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED!Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead.Use to define aliases of special pages names depending of the language &$specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names.&$names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page's language links.This is called in various places to allow extensions to define the effective language links for a page.$title:The page's Title.&$links:Associative array mapping language codes to prefixed links of the form"language:title".&$linkFlags:Associative array mapping prefixed links to arrays of flags.Currently unused, but planned to provide support for marking individual language links in the UI, e.g.for featured articles. 'LanguageSelector':Hook to change the language selector available on a page.$out:The output page.$cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED!Use HtmlPageLinkRendererBegin instead.Used when generating internal and interwiki links in Linker::link(), before processing starts.Return false to skip default processing and return $ret.See documentation for Linker::link() for details on the expected meanings of parameters.$skin:the Skin object $target:the Title that the link is pointing to &$html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1934
static getNamespaceContentModel($index)
Get the default content model for a namespace This does not mean that all pages in that namespace hav...
static isCapitalized($index)
Is the namespace first-letter capitalized?
if($wgScript===false) if($wgLoadScript===false) if($wgArticlePath===false) if(!empty($wgActionPaths)&&!isset($wgActionPaths['view'])) if($wgResourceBasePath===null) if($wgStylePath===false) if($wgLocalStylePath===false) if($wgExtensionAssetsPath===false) if($wgLogo===false) if($wgUploadPath===false) if($wgUploadDirectory===false) if($wgReadOnlyFile===false) if($wgFileCacheDirectory===false) if($wgDeletedDirectory===false) if($wgGitInfoCacheDirectory===false &&$wgCacheDirectory!==false) if($wgEnableParserCache===false) if($wgRightsIcon) if(isset($wgFooterIcons['copyright']['copyright'])&&$wgFooterIcons['copyright']['copyright']===[]) if(isset($wgFooterIcons['poweredby'])&&isset($wgFooterIcons['poweredby']['mediawiki'])&&$wgFooterIcons['poweredby']['mediawiki']['src']===null) $wgNamespaceProtection[NS_MEDIAWIKI]
Unconditional protection for NS_MEDIAWIKI since otherwise it's too easy for a sysadmin to set $wgName...
Definition: Setup.php:155
static getCanonicalName($index)
Returns the canonical (English) name for a given index.
$wgCapitalLinks
Set this to false to avoid forcing the first letter of links to capitals.
const NS_MEDIA
Definition: Defines.php:44
$wgCapitalLinkOverrides
static getContentNamespaces()
Get a list of all namespace indices which are considered to contain content.
static subjectEquals($ns1, $ns2)
Returns whether the specified namespaces share the same subject.
static hasSubpages($index)
Does the namespace allow subpages?
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
static isMethodValidFor($index, $method)
Throw an exception when trying to get the subject or talk page for a given namespace where it does no...
Definition: MWNamespace.php:54
const NS_FILE
Definition: Defines.php:62
static equals($ns1, $ns2)
Returns whether the specified namespaces are the same namespace.
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:953
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
const NS_MEDIAWIKI
Definition: Defines.php:64
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
$wgContentNamespaces
Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are...
$wgExtraNamespaces
Additional namespaces.
static getTalk($index)
Get the talk namespace index for a given namespace.
static $alwaysCapitalizedNamespaces
These namespaces should always be first-letter capitalized, now and forevermore.
Definition: MWNamespace.php:40
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
static isSubject($index)
Is the given namespace is a subject (non-talk) namespace?
Definition: MWNamespace.php:87
static isContent($index)
Does this namespace contain content, for the purposes of calculating statistics, etc?
$wgAllowImageMoving
Allows to move images and other media files.
const NS_USER_TALK
Definition: Defines.php:59
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
static getSubject($index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
static getAssociated($index)
Get the associated namespace.
static getCanonicalIndex($name)
Returns the index for a given canonical name, or NULL The input must be converted to lower case first...
static getCanonicalNamespaces($rebuild=false)
Returns array of all defined namespaces with their canonical (English) names.
static isWatchable($index)
Can pages in a namespace be watched?
static getGroupsWithPermission($role)
Get all the groups who have a given permission.
Definition: User.php:4602
static wantSignatures($index)
Might pages in this namespace require the use of the Signature button on the edit toolbar...
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300