MediaWiki  1.30.0
MWNamespace.php
Go to the documentation of this file.
1 <?php
32 class MWNamespace {
33 
40 
53  private static function isMethodValidFor( $index, $method ) {
54  if ( $index < NS_MAIN ) {
55  throw new MWException( "$method does not make any sense for given namespace $index" );
56  }
57  return true;
58  }
59 
66  public static function isMovable( $index ) {
68 
69  $result = !( $index < NS_MAIN || ( $index == NS_FILE && !$wgAllowImageMoving ) );
70 
74  Hooks::run( 'NamespaceIsMovable', [ $index, &$result ] );
75 
76  return $result;
77  }
78 
86  public static function isSubject( $index ) {
87  return !self::isTalk( $index );
88  }
89 
96  public static function isTalk( $index ) {
97  return $index > NS_MAIN
98  && $index % 2;
99  }
100 
107  public static function getTalk( $index ) {
108  self::isMethodValidFor( $index, __METHOD__ );
109  return self::isTalk( $index )
110  ? $index
111  : $index + 1;
112  }
113 
121  public static function getSubject( $index ) {
122  # Handle special namespaces
123  if ( $index < NS_MAIN ) {
124  return $index;
125  }
126 
127  return self::isTalk( $index )
128  ? $index - 1
129  : $index;
130  }
131 
140  public static function getAssociated( $index ) {
141  self::isMethodValidFor( $index, __METHOD__ );
142 
143  if ( self::isSubject( $index ) ) {
144  return self::getTalk( $index );
145  } elseif ( self::isTalk( $index ) ) {
146  return self::getSubject( $index );
147  } else {
148  return null;
149  }
150  }
151 
160  public static function exists( $index ) {
161  $nslist = self::getCanonicalNamespaces();
162  return isset( $nslist[$index] );
163  }
164 
179  public static function equals( $ns1, $ns2 ) {
180  return $ns1 == $ns2;
181  }
182 
194  public static function subjectEquals( $ns1, $ns2 ) {
195  return self::getSubject( $ns1 ) == self::getSubject( $ns2 );
196  }
197 
207  public static function getCanonicalNamespaces( $rebuild = false ) {
208  static $namespaces = null;
209  if ( $namespaces === null || $rebuild ) {
212  // Add extension namespaces
213  $namespaces += ExtensionRegistry::getInstance()->getAttribute( 'ExtensionNamespaces' );
214  if ( is_array( $wgExtraNamespaces ) ) {
216  }
217  Hooks::run( 'CanonicalNamespaces', [ &$namespaces ] );
218  }
219  return $namespaces;
220  }
221 
228  public static function getCanonicalName( $index ) {
229  $nslist = self::getCanonicalNamespaces();
230  if ( isset( $nslist[$index] ) ) {
231  return $nslist[$index];
232  } else {
233  return false;
234  }
235  }
236 
244  public static function getCanonicalIndex( $name ) {
245  static $xNamespaces = false;
246  if ( $xNamespaces === false ) {
247  $xNamespaces = [];
248  foreach ( self::getCanonicalNamespaces() as $i => $text ) {
249  $xNamespaces[strtolower( $text )] = $i;
250  }
251  }
252  if ( array_key_exists( $name, $xNamespaces ) ) {
253  return $xNamespaces[$name];
254  } else {
255  return null;
256  }
257  }
258 
264  public static function getValidNamespaces() {
265  static $mValidNamespaces = null;
266 
267  if ( is_null( $mValidNamespaces ) ) {
268  foreach ( array_keys( self::getCanonicalNamespaces() ) as $ns ) {
269  if ( $ns >= 0 ) {
270  $mValidNamespaces[] = $ns;
271  }
272  }
273  // T109137: sort numerically
274  sort( $mValidNamespaces, SORT_NUMERIC );
275  }
276 
277  return $mValidNamespaces;
278  }
279 
288  public static function canTalk( $index ) {
289  return self::hasTalkNamespace( $index );
290  }
291 
300  public static function hasTalkNamespace( $index ) {
301  return $index >= NS_MAIN;
302  }
303 
311  public static function isContent( $index ) {
313  return $index == NS_MAIN || in_array( $index, $wgContentNamespaces );
314  }
315 
323  public static function wantSignatures( $index ) {
325  return self::isTalk( $index ) || in_array( $index, $wgExtraSignatureNamespaces );
326  }
327 
334  public static function isWatchable( $index ) {
335  return $index >= NS_MAIN;
336  }
337 
344  public static function hasSubpages( $index ) {
346  return !empty( $wgNamespacesWithSubpages[$index] );
347  }
348 
353  public static function getContentNamespaces() {
355  if ( !is_array( $wgContentNamespaces ) || $wgContentNamespaces === [] ) {
356  return [ NS_MAIN ];
357  } elseif ( !in_array( NS_MAIN, $wgContentNamespaces ) ) {
358  // always force NS_MAIN to be part of array (to match the algorithm used by isContent)
359  return array_merge( [ NS_MAIN ], $wgContentNamespaces );
360  } else {
361  return $wgContentNamespaces;
362  }
363  }
364 
371  public static function getSubjectNamespaces() {
372  return array_filter(
373  self::getValidNamespaces(),
374  'MWNamespace::isSubject'
375  );
376  }
377 
384  public static function getTalkNamespaces() {
385  return array_filter(
386  self::getValidNamespaces(),
387  'MWNamespace::isTalk'
388  );
389  }
390 
397  public static function isCapitalized( $index ) {
399  // Turn NS_MEDIA into NS_FILE
400  $index = $index === NS_MEDIA ? NS_FILE : $index;
401 
402  // Make sure to get the subject of our namespace
403  $index = self::getSubject( $index );
404 
405  // Some namespaces are special and should always be upper case
406  if ( in_array( $index, self::$alwaysCapitalizedNamespaces ) ) {
407  return true;
408  }
409  if ( isset( $wgCapitalLinkOverrides[$index] ) ) {
410  // $wgCapitalLinkOverrides is explicitly set
411  return $wgCapitalLinkOverrides[$index];
412  }
413  // Default to the global setting
414  return $wgCapitalLinks;
415  }
416 
425  public static function hasGenderDistinction( $index ) {
426  return $index == NS_USER || $index == NS_USER_TALK;
427  }
428 
436  public static function isNonincludable( $index ) {
438  return $wgNonincludableNamespaces && in_array( $index, $wgNonincludableNamespaces );
439  }
440 
449  public static function getNamespaceContentModel( $index ) {
451  return isset( $wgNamespaceContentModels[$index] )
452  ? $wgNamespaceContentModels[$index]
453  : null;
454  }
455 
465  public static function getRestrictionLevels( $index, User $user = null ) {
467 
468  if ( !isset( $wgNamespaceProtection[$index] ) ) {
469  // All levels are valid if there's no namespace restriction.
470  // But still filter by user, if necessary
471  $levels = $wgRestrictionLevels;
472  if ( $user ) {
473  $levels = array_values( array_filter( $levels, function ( $level ) use ( $user ) {
474  $right = $level;
475  if ( $right == 'sysop' ) {
476  $right = 'editprotected'; // BC
477  }
478  if ( $right == 'autoconfirmed' ) {
479  $right = 'editsemiprotected'; // BC
480  }
481  return ( $right == '' || $user->isAllowed( $right ) );
482  } ) );
483  }
484  return $levels;
485  }
486 
487  // First, get the list of groups that can edit this namespace.
488  $namespaceGroups = [];
489  $combine = 'array_merge';
490  foreach ( (array)$wgNamespaceProtection[$index] as $right ) {
491  if ( $right == 'sysop' ) {
492  $right = 'editprotected'; // BC
493  }
494  if ( $right == 'autoconfirmed' ) {
495  $right = 'editsemiprotected'; // BC
496  }
497  if ( $right != '' ) {
498  $namespaceGroups = call_user_func( $combine, $namespaceGroups,
499  User::getGroupsWithPermission( $right ) );
500  $combine = 'array_intersect';
501  }
502  }
503 
504  // Now, keep only those restriction levels where there is at least one
505  // group that can edit the namespace but would be blocked by the
506  // restriction.
507  $usableLevels = [ '' ];
508  foreach ( $wgRestrictionLevels as $level ) {
509  $right = $level;
510  if ( $right == 'sysop' ) {
511  $right = 'editprotected'; // BC
512  }
513  if ( $right == 'autoconfirmed' ) {
514  $right = 'editsemiprotected'; // BC
515  }
516  if ( $right != '' && ( !$user || $user->isAllowed( $right ) ) &&
517  array_diff( $namespaceGroups, User::getGroupsWithPermission( $right ) )
518  ) {
519  $usableLevels[] = $level;
520  }
521  }
522 
523  return $usableLevels;
524  }
525 }
$wgNonincludableNamespaces
$wgNonincludableNamespaces
Pages in namespaces in this array can not be used as templates.
Definition: DefaultSettings.php:5368
$wgCanonicalNamespaceNames
$wgCanonicalNamespaceNames
Definitions of the NS_ constants are in Defines.php.
Definition: Setup.php:404
$user
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 account $user
Definition: hooks.txt:244
$wgNamespaceContentModels
$wgNamespaceContentModels
Associative array mapping namespace IDs to the name of the content model pages in that namespace shou...
Definition: DefaultSettings.php:8448
MWNamespace\subjectEquals
static subjectEquals( $ns1, $ns2)
Returns whether the specified namespaces share the same subject.
Definition: MWNamespace.php:194
MWNamespace\isNonincludable
static isNonincludable( $index)
It is not possible to use pages from this namespace as template?
Definition: MWNamespace.php:436
MWNamespace\getValidNamespaces
static getValidNamespaces()
Returns an array of the namespaces (by integer id) that exist on the wiki.
Definition: MWNamespace.php:264
MWNamespace\hasGenderDistinction
static hasGenderDistinction( $index)
Does the namespace (potentially) have different aliases for different genders.
Definition: MWNamespace.php:425
MWNamespace\isTalk
static isTalk( $index)
Is the given namespace a talk namespace?
Definition: MWNamespace.php:96
MWNamespace\getTalkNamespaces
static getTalkNamespaces()
List all namespace indices which are considered talks, aka not a subject or special namespace.
Definition: MWNamespace.php:384
$result
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:Array with elements of the form "language:title" in the order that they will be output. & $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:1963
$namespaces
namespace and then decline to actually register it & $namespaces
Definition: hooks.txt:932
MWNamespace\getNamespaceContentModel
static getNamespaceContentModel( $index)
Get the default content model for a namespace This does not mean that all pages in that namespace hav...
Definition: MWNamespace.php:449
use
as see the revision history and available at free of to any person obtaining a copy of this software and associated documentation to deal in the Software without including without limitation the rights to use
Definition: MIT-LICENSE.txt:10
NS_FILE
const NS_FILE
Definition: Defines.php:71
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
MWNamespace\getSubjectNamespaces
static getSubjectNamespaces()
List all namespace indices which are considered subject, aka not a talk or special namespace.
Definition: MWNamespace.php:371
MWNamespace\getContentNamespaces
static getContentNamespaces()
Get a list of all namespace indices which are considered to contain content.
Definition: MWNamespace.php:353
php
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
NS_MAIN
const NS_MAIN
Definition: Defines.php:65
ExtensionRegistry\getInstance
static getInstance()
Definition: ExtensionRegistry.php:80
MWNamespace\getCanonicalIndex
static getCanonicalIndex( $name)
Returns the index for a given canonical name, or NULL The input must be converted to lower case first...
Definition: MWNamespace.php:244
NS_SPECIAL
const NS_SPECIAL
Definition: Defines.php:54
MWException
MediaWiki exception.
Definition: MWException.php:26
$wgExtraSignatureNamespaces
$wgExtraSignatureNamespaces
Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be use...
Definition: DefaultSettings.php:4128
MWNamespace\canTalk
static canTalk( $index)
Does this namespace ever have a talk namespace?
Definition: MWNamespace.php:288
MWNamespace\isContent
static isContent( $index)
Does this namespace contain content, for the purposes of calculating statistics, etc?
Definition: MWNamespace.php:311
MWNamespace\hasTalkNamespace
static hasTalkNamespace( $index)
Does this namespace ever have a talk namespace?
Definition: MWNamespace.php:300
MWNamespace\hasSubpages
static hasSubpages( $index)
Does the namespace allow subpages?
Definition: MWNamespace.php:344
MWNamespace
This is a utility class with only static functions for dealing with namespaces that encodes all the "...
Definition: MWNamespace.php:32
MWNamespace\isMovable
static isMovable( $index)
Can pages in the given namespace be moved?
Definition: MWNamespace.php:66
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
$wgNamespaceProtection
$wgNamespaceProtection
Set the minimum permissions required to edit pages in each namespace.
Definition: DefaultSettings.php:5357
MWNamespace\getRestrictionLevels
static getRestrictionLevels( $index, User $user=null)
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a use...
Definition: MWNamespace.php:465
MWNamespace\isSubject
static isSubject( $index)
Is the given namespace is a subject (non-talk) namespace?
Definition: MWNamespace.php:86
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:68
NS_MEDIA
const NS_MEDIA
Definition: Defines.php:53
MWNamespace\wantSignatures
static wantSignatures( $index)
Might pages in this namespace require the use of the Signature button on the edit toolbar?
Definition: MWNamespace.php:323
$wgAllowImageMoving
$wgAllowImageMoving
Allows to move images and other media files.
Definition: DefaultSettings.php:388
MWNamespace\exists
static exists( $index)
Returns whether the specified namespace exists.
Definition: MWNamespace.php:160
$wgContentNamespaces
$wgContentNamespaces
Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are...
Definition: DefaultSettings.php:4111
$wgCapitalLinks
$wgCapitalLinks
Set this to false to avoid forcing the first letter of links to capitals.
Definition: DefaultSettings.php:4050
MWNamespace\equals
static equals( $ns1, $ns2)
Returns whether the specified namespaces are the same namespace.
Definition: MWNamespace.php:179
MWNamespace\isMethodValidFor
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:53
as
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
MWNamespace\getCanonicalNamespaces
static getCanonicalNamespaces( $rebuild=false)
Returns array of all defined namespaces with their canonical (English) names.
Definition: MWNamespace.php:207
$wgCapitalLinkOverrides
$wgCapitalLinkOverrides
Definition: DefaultSettings.php:4066
MWNamespace\isCapitalized
static isCapitalized( $index)
Is the namespace first-letter capitalized?
Definition: MWNamespace.php:397
$wgRestrictionLevels
$wgRestrictionLevels
Rights which can be required for each protection level (via action=protect)
Definition: DefaultSettings.php:5323
MWNamespace\$alwaysCapitalizedNamespaces
static $alwaysCapitalizedNamespaces
These namespaces should always be first-letter capitalized, now and forevermore.
Definition: MWNamespace.php:39
NS_USER
const NS_USER
Definition: Defines.php:67
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:73
MWNamespace\isWatchable
static isWatchable( $index)
Can pages in a namespace be watched?
Definition: MWNamespace.php:334
MWNamespace\getTalk
static getTalk( $index)
Get the talk namespace index for a given namespace.
Definition: MWNamespace.php:107
MWNamespace\getSubject
static getSubject( $index)
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA,...
Definition: MWNamespace.php:121
$wgNamespacesWithSubpages
$wgNamespacesWithSubpages
Which namespaces should support subpages? See Language.php for a list of namespaces.
Definition: DefaultSettings.php:4072
User
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition: User.php:51
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203
MWNamespace\getAssociated
static getAssociated( $index)
Get the associated namespace.
Definition: MWNamespace.php:140
MWNamespace\getCanonicalName
static getCanonicalName( $index)
Returns the canonical (English) name for a given index.
Definition: MWNamespace.php:228
$wgExtraNamespaces
$wgExtraNamespaces
Additional namespaces.
Definition: DefaultSettings.php:3893
array
the array() calling protocol came about after MediaWiki 1.4rc1.
User\getGroupsWithPermission
static getGroupsWithPermission( $role)
Get all the groups who have a given permission.
Definition: User.php:4768