MediaWiki
1.30.0
|
This is a utility class with only static functions for dealing with namespaces that encodes all the "magic" behaviors of them based on index. More...
Static Public Member Functions | |
static | canTalk ( $index) |
Does this namespace ever have a talk namespace? More... | |
static | equals ( $ns1, $ns2) |
Returns whether the specified namespaces are the same namespace. More... | |
static | exists ( $index) |
Returns whether the specified namespace exists. More... | |
static | getAssociated ( $index) |
Get the associated namespace. More... | |
static | getCanonicalIndex ( $name) |
Returns the index for a given canonical name, or NULL The input must be converted to lower case first. More... | |
static | getCanonicalName ( $index) |
Returns the canonical (English) name for a given index. More... | |
static | getCanonicalNamespaces ( $rebuild=false) |
Returns array of all defined namespaces with their canonical (English) names. More... | |
static | getContentNamespaces () |
Get a list of all namespace indices which are considered to contain content. More... | |
static | getNamespaceContentModel ( $index) |
Get the default content model for a namespace This does not mean that all pages in that namespace have the model. More... | |
static | getRestrictionLevels ( $index, User $user=null) |
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a user's rights. More... | |
static | getSubject ( $index) |
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject. More... | |
static | getSubjectNamespaces () |
List all namespace indices which are considered subject, aka not a talk or special namespace. More... | |
static | getTalk ( $index) |
Get the talk namespace index for a given namespace. More... | |
static | getTalkNamespaces () |
List all namespace indices which are considered talks, aka not a subject or special namespace. More... | |
static | getValidNamespaces () |
Returns an array of the namespaces (by integer id) that exist on the wiki. More... | |
static | hasGenderDistinction ( $index) |
Does the namespace (potentially) have different aliases for different genders. More... | |
static | hasSubpages ( $index) |
Does the namespace allow subpages? More... | |
static | hasTalkNamespace ( $index) |
Does this namespace ever have a talk namespace? More... | |
static | isCapitalized ( $index) |
Is the namespace first-letter capitalized? More... | |
static | isContent ( $index) |
Does this namespace contain content, for the purposes of calculating statistics, etc? More... | |
static | isMovable ( $index) |
Can pages in the given namespace be moved? More... | |
static | isNonincludable ( $index) |
It is not possible to use pages from this namespace as template? More... | |
static | isSubject ( $index) |
Is the given namespace is a subject (non-talk) namespace? More... | |
static | isTalk ( $index) |
Is the given namespace a talk namespace? More... | |
static | isWatchable ( $index) |
Can pages in a namespace be watched? More... | |
static | subjectEquals ( $ns1, $ns2) |
Returns whether the specified namespaces share the same subject. More... | |
static | wantSignatures ( $index) |
Might pages in this namespace require the use of the Signature button on the edit toolbar? More... | |
Static Private Member Functions | |
static | isMethodValidFor ( $index, $method) |
Throw an exception when trying to get the subject or talk page for a given namespace where it does not make sense. More... | |
Static Private Attributes | |
static | $alwaysCapitalizedNamespaces = [ NS_SPECIAL, NS_USER, NS_MEDIAWIKI ] |
These namespaces should always be first-letter capitalized, now and forevermore. More... | |
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
Definition at line 32 of file MWNamespace.php.
|
static |
Does this namespace ever have a talk namespace?
int | $index | Namespace index |
Definition at line 288 of file MWNamespace.php.
References hasTalkNamespace().
Referenced by ChangesFeed\buildItems(), and MWNamespaceTest\testCanTalk().
|
static |
Returns whether the specified namespaces are the same namespace.
int | $ns1 | The first namespace index |
int | $ns2 | The second namespace index |
Definition at line 179 of file MWNamespace.php.
Referenced by Title\inNamespace(), and MWNamespaceTest\testEquals().
|
static |
Returns whether the specified namespace exists.
int | $index |
Definition at line 160 of file MWNamespace.php.
References getCanonicalNamespaces().
Referenced by NamespaceImportTitleFactory\__construct(), NaiveImportTitleFactory\createTitleFromForeignTitle(), Linker\getInvalidTitleDescription(), OutputPage\getJSVars(), Title\getNamespaceKey(), Title\getNsText(), Title\isValid(), Title\makeTitleSafe(), TitleCleanup\moveInconsistentPage(), and WikiImporter\setTargetNamespace().
|
static |
Get the associated namespace.
For talk namespaces, returns the subject (non-talk) namespace For subject (non-talk) namespaces, returns the talk namespace
int | $index | Namespace index |
Definition at line 140 of file MWNamespace.php.
References getSubject(), getTalk(), and isMethodValidFor().
Referenced by ChangesListSpecialPage\buildQuery(), ContribsPager\getNamespaceCond(), MWNamespaceTest\testGetAssociated(), MWNamespaceTest\testGetAssociatedExceptionsForNsMedia(), and MWNamespaceTest\testGetAssociatedExceptionsForNsSpecial().
|
static |
Returns the index for a given canonical name, or NULL The input must be converted to lower case first.
string | $name | Namespace name |
Definition at line 244 of file MWNamespace.php.
Referenced by Language\getNsIndex().
|
static |
Returns the canonical (English) name for a given index.
int | $index | Namespace index |
Definition at line 228 of file MWNamespace.php.
References getCanonicalNamespaces().
Referenced by MWNamespaceTest\__call(), SpecialContributions\contributionsSub(), RevisionStorageTest\createPage(), TestPageProps\createPage(), SpecialListGroupRights\execute(), Linker\formatLinksInComment(), SpecialStatistics\getGroupStats(), OutputPage\getJSVars(), Title\getNamespaceKey(), Title\getNsText(), DeletedContributionsPage\getSubTitle(), Linker\makeCommentLink(), Title\makeName(), Title\moveSubpages(), EditPage\showIntro(), and Article\showMissingArticle().
|
static |
Returns array of all defined namespaces with their canonical (English) names.
bool | $rebuild | Rebuild namespace list (default = false). Used for testing. |
Definition at line 207 of file MWNamespace.php.
References $namespaces, $wgCanonicalNamespaceNames, $wgExtraNamespaces, ExtensionRegistry\getInstance(), global, NS_MAIN, and Hooks\run().
Referenced by NamespaceConflictChecker\checkAll(), exists(), getCanonicalName(), ResourceLoaderStartUpModule\getConfigSettings(), Language\getNamespaces(), RevisionTest\setUp(), ContentHandlerTest\setUp(), TitleMethodsTest\setUp(), EditPageTest\setUp(), ApiEditPageTest\setUp(), TestPageProps\setUp(), RevisionStorageTest\setUp(), PrefixSearchTest\setUp(), TitleMethodsTest\tearDown(), ContentHandlerTest\tearDown(), ApiEditPageTest\tearDown(), RevisionTest\tearDown(), RevisionStorageTest\tearDown(), and TestPageProps\tearDown().
|
static |
Get a list of all namespace indices which are considered to contain content.
Definition at line 353 of file MWNamespace.php.
References $wgContentNamespaces, global, and NS_MAIN.
Referenced by RandomPage\__construct(), SiteStatsInit\articles(), Title\canUseNoindex(), RebuildFileCache\execute(), ResourceLoaderStartUpModule\getConfigSettings(), MediaWikiTestCase\getDefaultWikitextNS(), UncategorizedPagesPage\getOrderFields(), DeadendPagesPage\getOrderFields(), LonelyPagesPage\getOrderFields(), FewestrevisionsPage\getQueryInfo(), ShortPagesPage\getQueryInfo(), AncientPagesPage\getQueryInfo(), MostinterwikisPage\getQueryInfo(), MostcategoriesPage\getQueryInfo(), UncategorizedPagesPage\getQueryInfo(), LonelyPagesPage\getQueryInfo(), DeadendPagesPage\getQueryInfo(), WithoutInterwikiPage\getQueryInfo(), and MWNamespaceTest\testGetContentNamespaces().
|
static |
Get the default content model for a namespace This does not mean that all pages in that namespace have the model.
int | $index | Index to check |
Definition at line 449 of file MWNamespace.php.
References $wgNamespaceContentModels, and global.
Referenced by ContentHandler\getDefaultModelFor().
|
static |
Determine which restriction levels it makes sense to use in a namespace, optionally filtered by a user's rights.
Definition at line 465 of file MWNamespace.php.
References $user, $wgNamespaceProtection, $wgRestrictionLevels, array(), as, User\getGroupsWithPermission(), global, and use.
Referenced by EditPage\addPageProtectionWarningHeaders(), SkinTemplate\buildContentNavigationUrls(), ProtectionForm\buildSelector(), ProtectionForm\execute(), ProtectionForm\loadData(), and EditPage\showTextbox1().
|
static |
Get the subject namespace index for a given namespace Special namespaces (NS_MEDIA, NS_SPECIAL) are always the subject.
int | $index | Namespace index |
Definition at line 121 of file MWNamespace.php.
References isTalk(), and NS_MAIN.
Referenced by getAssociated(), Title\getNamespaceKey(), Title\getSubjectNsText(), Title\getSubjectPage(), ApiQueryInfo\getTSIDs(), isCapitalized(), MovePage\move(), MediaWiki\Widget\Search\SearchFormWidget\powerSearchBox(), subjectEquals(), SkinTemplate\tabAction(), MWNamespaceTest\testGetSubject(), and SpecialEditWatchlist\watchTitles().
|
static |
List all namespace indices which are considered subject, aka not a talk or special namespace.
See also MWNamespace::isSubject
Definition at line 371 of file MWNamespace.php.
Referenced by MWNamespaceTest\testGetSubjectNamespaces().
|
static |
Get the talk namespace index for a given namespace.
int | $index | Namespace index |
Definition at line 107 of file MWNamespace.php.
References isMethodValidFor(), and isTalk().
Referenced by getAssociated(), NamespaceConflictChecker\getDestinationTitle(), Title\getTalkNsText(), Title\getTalkPage(), ApiQueryInfo\getTSIDs(), MWNamespaceTest\testGetTalk(), MWNamespaceTest\testGetTalkExceptionsForNsMedia(), MWNamespaceTest\testGetTalkExceptionsForNsSpecial(), and SpecialEditWatchlist\watchTitles().
|
static |
List all namespace indices which are considered talks, aka not a subject or special namespace.
See also MWNamespace::isTalk
Definition at line 384 of file MWNamespace.php.
Referenced by MWNamespaceTest\testGetTalkNamespaces().
|
static |
Returns an array of the namespaces (by integer id) that exist on the wiki.
Used primarily by the api in help documentation.
Definition at line 264 of file MWNamespace.php.
References as.
Referenced by MediaWikiTestCase\getDefaultWikitextNS(), ApiHelp\getHelpInternal(), ApiBase\getParameterFromSettings(), TrackingCategories\getTrackingCategories(), SpecialListGroupRights\outputNamespaceProtectionInfo(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), SpecialSearch\saveNamespaces(), and Preferences\searchPreferences().
|
static |
Does the namespace (potentially) have different aliases for different genders.
Not all languages make a distinction here.
int | $index | Index to check |
Definition at line 425 of file MWNamespace.php.
References NS_USER, and NS_USER_TALK.
Referenced by GenderCache\doLinkBatch(), GenderCache\doTitlesArray(), MediaWikiTitleCodec\getNamespaceName(), ApiPageSet\initFromQueryResult(), ApiPageSet\processTitlesArray(), ApiQueryAllPages\run(), and MWNamespaceTest\testHasGenderDistinction().
|
static |
Does the namespace allow subpages?
int | $index | Index to check |
Definition at line 344 of file MWNamespace.php.
References $wgNamespacesWithSubpages, and global.
Referenced by SubpageImportTitleFactory\__construct(), MovePageForm\doSubmit(), Title\getBaseText(), Title\getEditNotices(), Title\getRootText(), Title\getSubpages(), Title\getSubpageText(), Title\hasSubpages(), Title\isSubpage(), Title\moveSubpages(), Linker\normalizeSubpageLink(), InfoAction\pageCounts(), InfoAction\pageInfo(), WikiImporter\setTargetRootPage(), MovePageForm\showSubpages(), and Skin\subPageSubtitle().
|
static |
Does this namespace ever have a talk namespace?
int | $index | Namespace ID |
Definition at line 300 of file MWNamespace.php.
References NS_MAIN.
Referenced by Title\canHaveTalkPage(), canTalk(), and MWNamespaceTest\testHasTalkNamespace().
|
static |
Is the namespace first-letter capitalized?
int | $index | Index to check |
Definition at line 397 of file MWNamespace.php.
References $wgCapitalLinkOverrides, $wgCapitalLinks, getSubject(), global, NS_FILE, and NS_MEDIA.
Referenced by FileRepo\__construct(), UploadForm\addUploadJS(), Title\capitalize(), CapsCleanup\execute(), ResourceLoaderStartUpModule\getConfigSettings(), FileRepo\getNameFromTitle(), XmlDumpWriter\namespaces(), and MWNamespaceTest\testIsCapitalizedHardcodedAssertions().
|
static |
Does this namespace contain content, for the purposes of calculating statistics, etc?
int | $index | Index to check |
Definition at line 311 of file MWNamespace.php.
References $wgContentNamespaces, global, and NS_MAIN.
Referenced by MediaWiki\Linker\LinkRenderer\getLinkClasses(), and Title\isContentPage().
|
staticprivate |
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)
int | $index | |
string | $method |
MWException |
Definition at line 53 of file MWNamespace.php.
References NS_MAIN.
Referenced by getAssociated(), and getTalk().
|
static |
Can pages in the given namespace be moved?
int | $index | Namespace index |
Definition at line 66 of file MWNamespace.php.
References $wgAllowImageMoving, global, NS_FILE, NS_MAIN, and Hooks\run().
Referenced by Title\checkActionPermissions(), Title\isMovable(), MovePageForm\showForm(), and MWNamespaceTest\testIsMovable().
|
static |
It is not possible to use pages from this namespace as template?
int | $index | Index to check |
Definition at line 436 of file MWNamespace.php.
References $wgNonincludableNamespaces, and global.
Referenced by MWNamespaceTest\testIsNonincludable().
|
static |
Is the given namespace is a subject (non-talk) namespace?
int | $index | Namespace index |
Definition at line 86 of file MWNamespace.php.
References isTalk().
Referenced by NamespaceConflictChecker\getDestinationTitle(), and NamespaceConflictChecker\getTargetList().
|
static |
Is the given namespace a talk namespace?
int | $index | Namespace index |
Definition at line 96 of file MWNamespace.php.
References NS_MAIN.
Referenced by MediaWikiTestCase\getDefaultWikitextNS(), getSubject(), getTalk(), ApiQueryInfo\getTSIDs(), SpecialEditWatchlist\getWatchlistInfo(), isSubject(), Title\isTalkPage(), DumpNotalkFilter\pass(), and wantSignatures().
|
static |
Can pages in a namespace be watched?
int | $index |
Definition at line 334 of file MWNamespace.php.
References NS_MAIN.
Referenced by Title\isWatchable().
|
static |
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.
int | $ns1 | The first namespace index |
int | $ns2 | The second namespace index |
Definition at line 194 of file MWNamespace.php.
References getSubject().
Referenced by MWNamespaceTest\assertDifferentSubject(), MWNamespaceTest\assertSameSubject(), and Title\hasSubjectNamespace().
|
static |
Might pages in this namespace require the use of the Signature button on the edit toolbar?
int | $index | Index to check |
Definition at line 323 of file MWNamespace.php.
References $wgExtraSignatureNamespaces, global, and isTalk().
Referenced by EditPage\getEditToolbar().
|
staticprivate |
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. :)
Definition at line 39 of file MWNamespace.php.