MediaWiki REL1_40
|
Represents a title within MediaWiki. More...
Inherits MediaWiki\Linker\LinkTarget, MediaWiki\Page\PageIdentity, and IDBAccessObject.
Public Member Functions | |
__clone () | |
__sleep () | |
__toString () | |
Return a string representation of this title. | |
__wakeup () | |
areCascadeProtectionSourcesLoaded () | |
Determines whether cascading protection sources have already been loaded from the database. | |
areRestrictionsCascading () | |
Returns cascading restrictions for the current article. | |
areRestrictionsLoaded () | |
Accessor for mRestrictionsLoaded. | |
canExist () | |
Can this title represent a page in the wiki's database? | |
canHaveTalkPage () | |
Can this title have a corresponding talk page? | |
canUseNoindex () | |
Whether the magic words INDEX and NOINDEX function for this page. | |
createFragmentTarget (string $fragment) | |
Creates a new Title for a different fragment of the same page. | |
deleteTitleProtection () | |
Remove any title protection due to page existing. | |
equals (object $other) | |
Compares with another Title. | |
estimateRevisionCount () | |
Get the approximate revision count of this page. | |
exists ( $flags=0) | |
Check if page exists. | |
fixSpecialName () | |
If the Title refers to a special page alias which is not the local default, resolve the alias, and localise the name as necessary. | |
flushRestrictions () | |
Flush the protection cache in this object and force reload from the database. | |
getAllRestrictions () | |
Accessor/initialisation for mRestrictions. | |
getArticleID ( $flags=0) | |
Get the article ID for this Title from the link cache, adding it if necessary. | |
getBacklinkCache () | |
Get a backlink cache object. | |
getBaseText () | |
Get the base page name without a namespace, i.e. | |
getBaseTitle () | |
Get the base page name title, i.e. | |
getBrokenLinksFrom () | |
Get an array of Title objects referring to non-existent articles linked from this page. | |
getCanonicalURL ( $query='', $query2=false) | |
Get the URL for a canonical link, for use in things like IRC and e-mail notifications. | |
getCascadeProtectionSources ( $getPages=true) | |
Cascading protection: Get the source of any cascading restrictions on this page. | |
getCategorySortkey ( $prefix='') | |
Returns the raw sort key to be used for categories, with the specified prefix. | |
getCdnUrls () | |
Get a list of URLs to purge from the CDN cache when this page changes. | |
getContentModel ( $flags=0) | |
Get the page's content model id, see the CONTENT_MODEL_XXX constants. | |
getDBkey () | |
Get the main part with underscores. | |
getDefaultMessageText () | |
Get the default (plain) message contents for an page that overrides an interface message key. | |
getDefaultSystemMessage () | |
Same as getDefaultMessageText, but returns a Message object. | |
getDeletedEditsCount () | |
Is there a version of this page in the deletion archive? | |
getEditNotices ( $oldid=0) | |
Get a list of rendered edit notices for this page. | |
getEditURL () | |
Get the edit URL for this Title. | |
getFragment () | |
Get the Title fragment (i.e. | |
getFragmentForURL () | |
Get the fragment in URL form, including the "#" character if there is one. | |
getFullText () | |
Get the prefixed title with spaces, plus any fragment (part beginning with '#') | |
getFullURL ( $query='', $query2=false, $proto=PROTO_RELATIVE) | |
Get a real URL referring to this title, with interwiki link and fragment. | |
getFullUrlForRedirect ( $query='', $proto=PROTO_CURRENT) | |
Get a url appropriate for making redirects based on an untrusted url arg. | |
getId ( $wikiId=self::LOCAL) | |
Returns the page ID. | |
getInternalURL ( $query='', $query2=false) | |
Get the URL form for an internal link. | |
getInterwiki () | |
Get the interwiki prefix. | |
getLatestRevID ( $flags=0) | |
What is the page_latest field for this page? | |
getLength ( $flags=0) | |
What is the length of this page? Uses link cache, adding it if necessary. | |
getLinksFrom ( $options=[], $table='pagelinks', $prefix='pl') | |
Get an array of Title objects linked from this Title Also stores the IDs in the link cache. | |
getLinksTo ( $options=[], $table='pagelinks', $prefix='pl') | |
Get an array of Title objects linking to this Title Also stores the IDs in the link cache. | |
getLinkURL ( $query='', $query2=false, $proto=false) | |
Get a URL that's the simplest URL that will be valid to link, locally, to the current Title. | |
getLocalURL ( $query='', $query2=false) | |
Get a URL with no fragment or server name (relative URL) from a Title object. | |
getNamespace () | |
Get the namespace index, i.e. | |
getNamespaceKey ( $prepend='nstab-') | |
Generate strings used for xml 'id' names in monobook tabs. | |
getNsText () | |
Get the namespace text. | |
getOtherPage () | |
Get the other title for this page, if this is a subject page get the talk page, if it is a subject page get the talk page. | |
getPageLanguage () | |
Get the language in which the content of this page is written in wikitext. | |
getPageViewLanguage () | |
Get the language in which the content of this page is written when viewed by user. | |
getParentCategories () | |
Get categories to which this Title belongs and return an array of categories' names. | |
getParentCategoryTree ( $children=[]) | |
Get a tree of parent categories. | |
getPartialURL () | |
Get the URL-encoded form of the main part. | |
getPrefixedDBkey () | |
Get the prefixed database key form. | |
getPrefixedText () | |
Get the prefixed title with spaces. | |
getPrefixedURL () | |
Get a URL-encoded title (not an actual URL) including interwiki. | |
getRedirectsHere ( $ns=null) | |
Get all extant redirects to this Title. | |
getRestrictionExpiry ( $action) | |
Get the expiry time for the restriction against a given action. | |
getRestrictions ( $action) | |
Accessor/initialisation for mRestrictions. | |
getRestrictionTypes () | |
Returns restriction types for the current Title. | |
getRootText () | |
Get the root page name text without a namespace, i.e. | |
getRootTitle () | |
Get the root page name title, i.e. | |
getSkinFromConfigSubpage () | |
Trim down a .css, .json, or .js subpage title to get the corresponding skin name. | |
getSubjectNsText () | |
Get the namespace text of the subject (rather than talk) page. | |
getSubjectPage () | |
Get a title object associated with the subject page of this talk page. | |
getSubpage ( $text) | |
Get the title for a subpage of the current page. | |
getSubpages ( $limit=-1) | |
Get all subpages of this page. | |
getSubpageText () | |
Get the lowest-level subpage name, i.e. | |
getSubpageUrlForm () | |
Get a URL-encoded form of the subpage text. | |
getTalkNsText () | |
Get the namespace text of the talk page. | |
getTalkPage () | |
Get a Title object associated with the talk page of this article. | |
getTalkPageIfDefined () | |
Get a Title object associated with the talk page of this article, if such a talk page can exist. | |
getTemplateLinksFrom ( $options=[]) | |
Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache. | |
getTemplateLinksTo ( $options=[]) | |
Get an array of Title objects using this Title as a template Also stores the IDs in the link cache. | |
getText () | |
Get the text form (spaces not underscores) of the main part. | |
getTitleProtection () | |
Is this title subject to title protection? Title protection is the one applied against creation of such title. | |
getTitleValue () | |
Get a TitleValue object representing this Title. | |
getTouched ( $flags=self::READ_NORMAL) | |
Get the last touched timestamp. | |
getTransWikiID () | |
Returns the DB name of the distant wiki which owns the object. | |
getWikiId () | |
Returns false to indicate that this Title belongs to the local wiki. | |
hasContentModel ( $id) | |
Convenience method for checking a title's content model name. | |
hasDeletedEdits () | |
Is there a version of this page in the deletion archive? | |
hasFragment () | |
Check if a Title fragment is set. | |
hasSourceText () | |
Does this page have source text? | |
hasSubjectNamespace ( $ns) | |
Returns true if the title has the same subject namespace as the namespace specified. | |
hasSubpages () | |
Does this have subpages? (Warning, usually requires an extra DB query.) | |
inNamespace (int $ns) | |
Returns true if the title is inside the specified namespace. | |
inNamespaces (... $namespaces) | |
Returns true if the title is inside one of the specified namespaces. | |
invalidateCache ( $purgeTime=null) | |
Updates page_touched for this page; called from LinksUpdate.php. | |
isAlwaysKnown () | |
Should links to this title be shown as potentially viewable (i.e. | |
isBigDeletion () | |
Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit. | |
isCascadeProtected () | |
Cascading protection: Return true if cascading restrictions apply to this page, false if not. | |
isContentPage () | |
Is this Title in a namespace which contains content? In other words, is this a content page, for the purposes of calculating statistics, etc? | |
isConversionTable () | |
Is this a conversion table for the LanguageConverter? | |
isDeleted () | |
Is there a version of this page in the deletion archive? | |
isDeletedQuick () | |
Is there a version of this page in the deletion archive? | |
isExternal () | |
Is this Title interwiki? | |
isKnown () | |
Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages). | |
isLocal () | |
Determine whether the object refers to a page within this project (either this wiki or a wiki with a local interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local ) | |
isMainPage () | |
Is this the mainpage? | |
isMovable () | |
Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable. | |
isNewPage ( $flags=self::READ_NORMAL) | |
Check if this is a new page. | |
isProtected ( $action='') | |
Does the title correspond to a protected article? | |
isRawHtmlMessage () | |
Is this a message which can contain raw HTML? | |
isRedirect ( $flags=0) | |
Is this an article that is a redirect page? Uses link cache, adding it if necessary. | |
isSameLinkAs (LinkTarget $other) | |
isSamePageAs (PageReference $other) | |
isSemiProtected ( $action='edit') | |
Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels? | |
isSingleRevRedirect () | |
Locks the page row and check if this page is single revision redirect. | |
isSiteConfigPage () | |
Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI. | |
isSiteCssConfigPage () | |
Is this a sitewide CSS "config" page? | |
isSiteJsConfigPage () | |
Is this a sitewide JS "config" page? | |
isSiteJsonConfigPage () | |
Is this a sitewide JSON "config" page? | |
isSpecial ( $name) | |
Returns true if this title resolves to the named special page. | |
isSpecialPage () | |
Returns true if this is a special page. | |
isSubpage () | |
Is this a subpage? | |
isSubpageOf (Title $title) | |
Check if this title is a subpage of another title. | |
isTalkPage () | |
Is this a talk page of some sort? | |
isTrans () | |
Determine whether the object refers to a page within this project and is transcludable. | |
isUserConfigPage () | |
Is this a "config" (.css, .json, or .js) sub-page of a user page? | |
isUserCssConfigPage () | |
Is this a CSS "config" sub-page of a user page? | |
isUserJsConfigPage () | |
Is this a JS "config" sub-page of a user page? | |
isUserJsonConfigPage () | |
Is this a JSON "config" sub-page of a user page? | |
isValid () | |
Returns true if the title is a valid link target, and that it has been properly normalized. | |
isValidRedirectTarget () | |
Check if this Title is a valid redirect target. | |
isWikitextPage () | |
Does that page contain wikitext, or it is JS, CSS or whatever? | |
loadFromRow ( $row) | |
Load Title object fields from a DB row. | |
loadRestrictions ( $flags=0) | |
Load restrictions from the page_restrictions table. | |
loadRestrictionsFromRows ( $rows) | |
Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page. | |
pageCond () | |
Get an associative array for selecting this title from the "page" table. | |
purgeSquid () | |
Purge all applicable CDN URLs. | |
resetArticleID ( $id) | |
Inject a page ID, reset DB-loaded fields, and clear the link cache for this title. | |
setContentModel ( $model) | |
Set a proposed content model for the page for permissions checking. | |
setFragment ( $fragment) | |
Set the fragment for this title. | |
toPageIdentity () | |
Returns the page represented by this Title as a ProperPageIdentity. | |
toPageRecord ( $flags=0) | |
Returns the page represented by this Title as a ProperPageRecord. | |
touchLinks () | |
Update page_touched timestamps and send CDN purge messages for pages linking to this title. | |
wasLocalInterwiki () | |
Was this a local interwiki link? | |
Public Member Functions inherited from MediaWiki\Page\PageIdentity | |
exists () | |
Checks if the page currently exists. | |
Public Member Functions inherited from MediaWiki\DAO\WikiAwareEntity | |
assertWiki ( $wikiId) | |
Throws if $wikiId is different from the return value of getWikiId(). | |
Static Public Member Functions | |
static | capitalize ( $text, $ns=NS_MAIN) |
Capitalize a text string for a title if it belongs to a namespace that capitalizes. | |
static | castFromLinkTarget ( $linkTarget) |
Same as newFromLinkTarget, but if passed null, returns null. | |
static | castFromPageIdentity (?PageIdentity $pageIdentity) |
Return a Title for a given PageIdentity. | |
static | castFromPageReference (?PageReference $pageReference) |
Return a Title for a given Reference. | |
static | clearCaches () |
static | compare ( $a, $b) |
Callback for usort() to do title sorts by (namespace, title) | |
static | convertByteClassToUnicodeClass ( $byteClass) |
Utility method for converting a character sequence from bytes to Unicode. | |
static | getFilteredRestrictionTypes ( $exists=true) |
Get a filtered list of all restriction types supported by this wiki. | |
static | legalChars () |
Get a regex character class describing the legal characters in a link. | |
static | makeName ( $ns, $title, $fragment='', $interwiki='', $canonicalNamespace=false) |
Make a prefixed DB key from a DB key and a namespace index. | |
static | makeTitle ( $ns, $title, $fragment='', $interwiki='') |
Create a new Title from a namespace index and a DB key. | |
static | makeTitleSafe ( $ns, $title, $fragment='', $interwiki='') |
Create a new Title from a namespace index and a DB key. | |
static | newFromDBkey ( $key) |
Create a new Title from a prefixed DB key. | |
static | newFromID ( $id, $flags=0) |
Create a new Title from an article ID. | |
static | newFromIDs ( $ids) |
Make an array of titles from an array of IDs. | |
static | newFromLinkTarget (LinkTarget $linkTarget, $forceClone='') |
Returns a Title given a LinkTarget. | |
static | newFromRow ( $row) |
Make a Title object from a DB row. | |
static | newFromText ( $text, $defaultNamespace=NS_MAIN) |
Create a new Title from text, such as what one would find in a link. | |
static | newFromTextThrow ( $text, $defaultNamespace=NS_MAIN) |
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null. | |
static | newFromTitleValue (TitleValue $titleValue, $forceClone='') |
Returns a Title given a TitleValue. | |
static | newFromURL ( $url) |
THIS IS NOT THE FUNCTION YOU WANT. | |
static | newMainPage (MessageLocalizer $localizer=null) |
Create a new Title for the Main Page. | |
static | purgeExpiredRestrictions () |
Purge expired restrictions from the page_restrictions table. | |
Public Attributes | |
const | GAID_FOR_UPDATE = 512 |
Used to be GAID_FOR_UPDATE define(). | |
const | NEW_CLONE = 'clone' |
Flag for use with factory methods like newFromLinkTarget() that have a $forceClone parameter. | |
Public Attributes inherited from IDBAccessObject | |
const | READ_NONE = -1 |
Constants for object loading bitfield flags (higher => higher QoS) | |
Static Protected Member Functions | |
static | getSelectFields () |
Returns a list of fields that are to be selected for initializing Title objects. | |
Private member variables | |
Please use the accessor functions instead.
| |
int | $mArticleID = -1 |
Article ID, fetched from the link cache on demand. | |
string null | $prefixedText = null |
Text form including namespace/interwiki, initialised on demand. | |
null bool | $mRedirect = null |
Is the article at this title a redirect? | |
int false | $mLatestID = false |
ID of most recent revision. | |
int | $mLength = -1 |
The page length, 0 for special pages. | |
Represents a title within MediaWiki.
Optionally may contain an interwiki designation or namespace.
MediaWiki\Title\Title::__toString | ( | ) |
Return a string representation of this title.
Implements MediaWiki\Linker\LinkTarget.
MediaWiki\Title\Title::__wakeup | ( | ) |
Definition at line 4193 of file Title.php.
References wfUrlencode().
MediaWiki\Title\Title::areCascadeProtectionSourcesLoaded | ( | ) |
Determines whether cascading protection sources have already been loaded from the database.
Definition at line 2549 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::areRestrictionsCascading | ( | ) |
Returns cascading restrictions for the current article.
Definition at line 2651 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::areRestrictionsLoaded | ( | ) |
Accessor for mRestrictionsLoaded.
Definition at line 2591 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::canExist | ( | ) |
Can this title represent a page in the wiki's database?
Titles can exist as pages in the database if they are valid, and they are not Special pages, interwiki links, or fragment-only links.
Implements MediaWiki\Page\PageIdentity.
Definition at line 1265 of file Title.php.
Referenced by RequestContext\canUseWikiPage().
MediaWiki\Title\Title::canHaveTalkPage | ( | ) |
Can this title have a corresponding talk page?
False for relative section links (with getText() === ''), interwiki links (with getInterwiki() !== ''), and pages in NS_SPECIAL.
MediaWiki\Title\Title::canUseNoindex | ( | ) |
Whether the magic words INDEX and NOINDEX function for this page.
Definition at line 3896 of file Title.php.
References $wgExemptFromUserRobotsControl.
|
static |
|
static |
|
static |
|
static |
|
static |
|
static |
Utility method for converting a character sequence from bytes to Unicode.
Primary usecase being converting $wgLegalTitleChars to a sequence usable in javascript, as PHP uses UTF-8 bytes where javascript uses Unicode code units.
string | $byteClass |
MediaWiki\Title\Title::createFragmentTarget | ( | string | $fragment | ) |
Creates a new Title for a different fragment of the same page.
string | $fragment |
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1856 of file Title.php.
Referenced by SpecialWhatLinksHere\listItem().
MediaWiki\Title\Title::deleteTitleProtection | ( | ) |
Remove any title protection due to page existing.
MediaWiki\Title\Title::equals | ( | object | $other | ) |
Compares with another Title.
A Title object is considered equal to another Title if it has the same text, the same interwiki prefix, and the same namespace.
@phpcs:disable MediaWiki.Commenting.FunctionComment.ObjectTypeHintParam
object | $other |
Definition at line 3450 of file Title.php.
Referenced by MediaWiki\Block\Restriction\PageRestriction\matches(), and MediaWiki\Storage\DerivedPageDataUpdater\prepareContent().
MediaWiki\Title\Title::estimateRevisionCount | ( | ) |
Get the approximate revision count of this page.
Definition at line 3422 of file Title.php.
References $dbr, DB_REPLICA, and wfGetDB().
MediaWiki\Title\Title::exists | ( | $flags = 0 | ) |
Check if page exists.
For historical reasons, this function simply checks for the existence of the title in the page table, and will thus return false for interwiki links, special pages and the like. If you want to know if a title can be meaningfully viewed, you should probably call the isKnown() method instead.
int | $flags | Either a bitfield of class READ_* constants or GAID_FOR_UPDATE |
Definition at line 3523 of file Title.php.
Referenced by RedirectSpecialArticle\getRedirectQuery(), and SpecialUpload\getUploadForm().
MediaWiki\Title\Title::fixSpecialName | ( | ) |
If the Title refers to a special page alias which is not the local default, resolve the alias, and localise the name as necessary.
Otherwise, return $this
Definition at line 1334 of file Title.php.
References NS_SPECIAL.
MediaWiki\Title\Title::flushRestrictions | ( | ) |
Flush the protection cache in this object and force reload from the database.
This is used when updating protection from WikiPage::doUpdateRestrictions().
MediaWiki\Title\Title::getAllRestrictions | ( | ) |
Accessor/initialisation for mRestrictions.
Definition at line 2623 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getArticleID | ( | $flags = 0 | ) |
Get the article ID for this Title from the link cache, adding it if necessary.
int | $flags | Either a bitfield of class READ_* constants or GAID_FOR_UPDATE |
Definition at line 2870 of file Title.php.
Referenced by MediaWiki\Block\Restriction\PageRestriction\newFromTitle().
MediaWiki\Title\Title::getBacklinkCache | ( | ) |
Get a backlink cache object.
MediaWiki\Title\Title::getBaseText | ( | ) |
Get the base page name without a namespace, i.e.
the part before the subpage name
MediaWiki\Title\Title::getBaseTitle | ( | ) |
MediaWiki\Title\Title::getBrokenLinksFrom | ( | ) |
Get an array of Title objects referring to non-existent articles linked from this page.
Definition at line 3207 of file Title.php.
References $dbr, $res, DB_REPLICA, and wfGetDB().
MediaWiki\Title\Title::getCanonicalURL | ( | $query = '', | |
$query2 = false ) |
Get the URL for a canonical link, for use in things like IRC and e-mail notifications.
Uses $wgCanonicalServer and the GetCanonicalURL hook.
NOTE: Unlike getInternalURL(), the canonical URL includes the fragment
string | array | $query | |
string | false | $query2 | Deprecated |
Definition at line 2421 of file Title.php.
References PROTO_CANONICAL, and wfExpandUrl().
MediaWiki\Title\Title::getCascadeProtectionSources | ( | $getPages = true | ) |
Cascading protection: Get the source of any cascading restrictions on this page.
bool | $getPages | Whether or not to retrieve the actual pages that the restrictions have come from and the actual restrictions themselves. |
Definition at line 2570 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getCategorySortkey | ( | $prefix = '' | ) |
Returns the raw sort key to be used for categories, with the specified prefix.
This will be fed to Collation::getSortKey() to get a binary sortkey that can be used for actual sorting.
string | $prefix | The prefix to be used, specified using {{defaultsort:}} or like [[Category:Foo|prefix]]. Empty for no prefix. |
MediaWiki\Title\Title::getCdnUrls | ( | ) |
Get a list of URLs to purge from the CDN cache when this page changes.
MediaWiki\Title\Title::getContentModel | ( | $flags = 0 | ) |
Get the page's content model id, see the CONTENT_MODEL_XXX constants.
int | $flags | Either a bitfield of class READ_* constants or GAID_FOR_UPDATE |
Definition at line 1121 of file Title.php.
Referenced by MediaWiki\EditPage\TextConflictHelper\__construct(), and SpecialWhatLinksHere\wlhLink().
MediaWiki\Title\Title::getDBkey | ( | ) |
Get the main part with underscores.
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1090 of file Title.php.
Referenced by ArchivedFile\__construct(), DoubleRedirectJob\fixRedirects(), UploadBase\getTitle(), and ForeignAPIFile\newFromTitle().
MediaWiki\Title\Title::getDefaultMessageText | ( | ) |
Get the default (plain) message contents for an page that overrides an interface message key.
Primary use cases:
MediaWiki\Title\Title::getDefaultSystemMessage | ( | ) |
MediaWiki\Title\Title::getDeletedEditsCount | ( | ) |
MediaWiki\Title\Title::getEditNotices | ( | $oldid = 0 | ) |
Get a list of rendered edit notices for this page.
Array is keyed by the original message key, and values are rendered using parseAsBlock, so they will already be wrapped in paragraphs.
int | $oldid | Revision ID that's being edited |
Definition at line 4073 of file Title.php.
References wfMessage().
MediaWiki\Title\Title::getEditURL | ( | ) |
|
static |
Get a filtered list of all restriction types supported by this wiki.
bool | $exists | True to get all restriction types that apply to titles that do exist, False for all restriction types that apply to titles that do not exist |
Definition at line 2452 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getFragment | ( | ) |
Get the Title fragment (i.e.
\ the bit after the #) in text form
Use Title::hasFragment to check for a fragment
Implements MediaWiki\Linker\LinkTarget.
MediaWiki\Title\Title::getFragmentForURL | ( | ) |
MediaWiki\Title\Title::getFullText | ( | ) |
Get the prefixed title with spaces, plus any fragment (part beginning with '#')
Definition at line 1947 of file Title.php.
Referenced by WikitextContentHandler\makeRedirectContent(), and WikitextContent\updateRedirect().
MediaWiki\Title\Title::getFullURL | ( | $query = '', | |
$query2 = false, | |||
$proto = PROTO_RELATIVE ) |
Get a real URL referring to this title, with interwiki link and fragment.
string | array | $query | |
string | string[] | false | $query2 | |
string | int | null | $proto | Protocol type to use in URL |
Definition at line 2213 of file Title.php.
References wfExpandUrl().
Referenced by CssContentHandler\makeRedirectContent(), and JavaScriptContentHandler\makeRedirectContent().
MediaWiki\Title\Title::getFullUrlForRedirect | ( | $query = '', | |
$proto = PROTO_CURRENT ) |
Get a url appropriate for making redirects based on an untrusted url arg.
This is basically the same as getFullUrl(), but in the case of external interwikis, we send the user to a landing page, to prevent possible phishing attacks and the like.
array | string | $query | |
string | $proto | Protocol type to use in URL |
Definition at line 2246 of file Title.php.
References SpecialPage\getTitleFor().
MediaWiki\Title\Title::getId | ( | $wikiId = self::LOCAL | ) |
Returns the page ID.
If this ID is 0, this means the page does not exist.
string | false | $wikiId | The wiki ID expected by the caller. |
PreconditionException | if this Title instance does not represent a proper page, that is, if it is a section link, interwiki link, link to a special page, or such. |
PreconditionException | if $wikiId is not false. |
Implements MediaWiki\Page\PageIdentity.
MediaWiki\Title\Title::getInternalURL | ( | $query = '', | |
$query2 = false ) |
Get the URL form for an internal link.
This uses $wgInternalServer to qualify the path, or $wgServer if $wgInternalServer is not set. If the server variable used is protocol-relative, the URL will be expanded to http://
string | array | $query | |
string | false | $query2 | Deprecated |
Definition at line 2399 of file Title.php.
References $wgInternalServer, $wgServer, PROTO_HTTP, and wfExpandUrl().
MediaWiki\Title\Title::getInterwiki | ( | ) |
Get the interwiki prefix.
Use Title::isExternal to check if a interwiki is set
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1000 of file Title.php.
Referenced by WikitextContentHandler\makeRedirectContent().
MediaWiki\Title\Title::getLatestRevID | ( | $flags = 0 | ) |
MediaWiki\Title\Title::getLength | ( | $flags = 0 | ) |
MediaWiki\Title\Title::getLinksFrom | ( | $options = [], | |
$table = 'pagelinks', | |||
$prefix = 'pl' ) |
Get an array of Title objects linked from this Title Also stores the IDs in the link cache.
WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.
array | $options | Query option to Database::select() |
string | $table | Table name |
string | $prefix | Fields prefix |
Definition at line 3129 of file Title.php.
References $res, DB_REPLICA, and wfGetDB().
MediaWiki\Title\Title::getLinksTo | ( | $options = [], | |
$table = 'pagelinks', | |||
$prefix = 'pl' ) |
Get an array of Title objects linking to this Title Also stores the IDs in the link cache.
WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.
array | $options | May be FOR UPDATE |
string | $table | Table name |
string | $prefix | Fields prefix |
Definition at line 3063 of file Title.php.
References $res, DB_PRIMARY, DB_REPLICA, and wfGetDB().
MediaWiki\Title\Title::getLinkURL | ( | $query = '', | |
$query2 = false, | |||
$proto = false ) |
Get a URL that's the simplest URL that will be valid to link, locally, to the current Title.
It includes the fragment, but does not include the server unless action=render is used (or the link is external). If there's a fragment but the prefixed text is empty, we just return a link to the fragment.
The result obviously should not be URL-escaped, but does need to be HTML-escaped if it's being output in HTML.
string | array | $query | |
string | string[] | false | $query2 | |
string | int | false | $proto | A PROTO_* constant on how the URL should be expanded, or false (default) for no expansion |
MediaWiki\Title\Title::getLocalURL | ( | $query = '', | |
$query2 = false ) |
Get a URL with no fragment or server name (relative URL) from a Title object.
If this page is generated with action=render, however, $wgServer is prepended to make an absolute URL.
string | array | $query | An optional query string, not used for interwiki links. Can be specified as an associative array as well, e.g., [ 'action' => 'edit' ] (keys and values will be URL-escaped). Some query patterns will trigger various shorturl path replacements. |
string | string[] | false | $query2 | An optional secondary query array. This one MUST be an array. If a string is passed it will be interpreted as a deprecated variant argument and urlencoded into a variant= argument. This second query argument will be added to the $query The second parameter is deprecated since 1.19. Pass it as a key,value pair in the first parameter array instead. |
Definition at line 2280 of file Title.php.
References $matches, $wgActionPaths, $wgArticlePath, $wgMainPageIsDomainRoot, $wgScript, $wgVariantArticlePath, wfAppendQuery(), and wfUrlencode().
MediaWiki\Title\Title::getNamespace | ( | ) |
Get the namespace index, i.e.
one of the NS_xxxx constants.
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1099 of file Title.php.
Referenced by SubpageImportTitleFactory\__construct(), LinkHolderArray\doVariants(), DoubleRedirectJob\fixRedirects(), LinkHolderArray\makeHolder(), WikitextContentHandler\makeRedirectContent(), MediaWiki\Block\Restriction\NamespaceRestriction\matches(), ImageQueryPage\outputResults(), and MediaWiki\Specials\SpecialMovePage\showForm().
MediaWiki\Title\Title::getNamespaceKey | ( | $prepend = 'nstab-' | ) |
MediaWiki\Title\Title::getNsText | ( | ) |
MediaWiki\Title\Title::getOtherPage | ( | ) |
Get the other title for this page, if this is a subject page get the talk page, if it is a subject page get the talk page.
MWException | If the page doesn't have an other page |
MediaWiki\Title\Title::getPageLanguage | ( | ) |
Get the language in which the content of this page is written in wikitext.
Defaults to content language, but in certain cases it can be e.g. $wgLang (such as special pages, which are in the user language).
Definition at line 3984 of file Title.php.
References $wgLang, and $wgLanguageCode.
MediaWiki\Title\Title::getPageViewLanguage | ( | ) |
Get the language in which the content of this page is written when viewed by user.
Defaults to content language, but in certain cases it can be e.g. $wgLang (such as special pages, which are in the user language).
Definition at line 4025 of file Title.php.
References $wgLang.
MediaWiki\Title\Title::getParentCategories | ( | ) |
Get categories to which this Title belongs and return an array of categories' names.
Definition at line 3303 of file Title.php.
References $dbr, $res, DB_REPLICA, NS_CATEGORY, and wfGetDB().
MediaWiki\Title\Title::getParentCategoryTree | ( | $children = [] | ) |
MediaWiki\Title\Title::getPartialURL | ( | ) |
MediaWiki\Title\Title::getPrefixedDBkey | ( | ) |
Get the prefixed database key form.
Definition at line 1911 of file Title.php.
Referenced by PPTemplateFrame_Hash\__construct(), PPFrame_Hash\loopCheck(), and LinkHolderArray\makeHolder().
MediaWiki\Title\Title::getPrefixedText | ( | ) |
Get the prefixed title with spaces.
This is the form usually used for display
Definition at line 1923 of file Title.php.
Referenced by SpecialChangeContentModel\setParameter(), MediaWiki\Specials\SpecialMovePage\showForm(), and SpecialWhatLinksHere\wlhLink().
MediaWiki\Title\Title::getPrefixedURL | ( | ) |
Get a URL-encoded title (not an actual URL) including interwiki.
Definition at line 2156 of file Title.php.
References wfUrlencode().
MediaWiki\Title\Title::getRedirectsHere | ( | $ns = null | ) |
MediaWiki\Title\Title::getRestrictionExpiry | ( | $action | ) |
Get the expiry time for the restriction against a given action.
string | $action |
Definition at line 2637 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getRestrictions | ( | $action | ) |
Accessor/initialisation for mRestrictions.
string | $action | Action that permission needs to be checked for |
Definition at line 2609 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getRestrictionTypes | ( | ) |
Returns restriction types for the current Title.
Definition at line 2466 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getRootText | ( | ) |
Get the root page name text without a namespace, i.e.
the leftmost part before any slashes
MediaWiki\Title\Title::getRootTitle | ( | ) |
|
staticprotected |
Returns a list of fields that are to be selected for initializing Title objects.
Definition at line 539 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::getSkinFromConfigSubpage | ( | ) |
MediaWiki\Title\Title::getSubjectNsText | ( | ) |
MediaWiki\Title\Title::getSubjectPage | ( | ) |
Get a title object associated with the subject page of this talk page.
Definition at line 1716 of file Title.php.
References $title.
MediaWiki\Title\Title::getSubpage | ( | $text | ) |
Get the title for a subpage of the current page.
string | $text | The subpage name to add to the title |
MediaWiki\Title\Title::getSubpages | ( | $limit = -1 | ) |
MediaWiki\Title\Title::getSubpageText | ( | ) |
MediaWiki\Title\Title::getSubpageUrlForm | ( | ) |
Get a URL-encoded form of the subpage text.
Definition at line 2145 of file Title.php.
References wfUrlencode().
MediaWiki\Title\Title::getTalkNsText | ( | ) |
MediaWiki\Title\Title::getTalkPage | ( | ) |
Get a Title object associated with the talk page of this article.
MWException | if $target doesn't have talk pages, e.g. because it's in NS_SPECIAL or because it's a relative link, or an interwiki link. |
Definition at line 1671 of file Title.php.
References $title.
Referenced by MediaWiki\Specials\SpecialMovePage\showForm().
MediaWiki\Title\Title::getTalkPageIfDefined | ( | ) |
MediaWiki\Title\Title::getTemplateLinksFrom | ( | $options = [] | ) |
Get an array of Title objects used on this Title as a template Also stores the IDs in the link cache.
WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.
array | $options | May be FOR UPDATE |
MediaWiki\Title\Title::getTemplateLinksTo | ( | $options = [] | ) |
Get an array of Title objects using this Title as a template Also stores the IDs in the link cache.
WARNING: do not use this function on arbitrary user-supplied titles! On heavily-used templates it will max out the memory.
array | $options | Query option to Database::select() |
MediaWiki\Title\Title::getText | ( | ) |
Get the text form (spaces not underscores) of the main part.
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1072 of file Title.php.
Referenced by TraditionalImageGallery\getCaptionHtml(), and MediaWiki\Specials\SpecialMovePage\showForm().
MediaWiki\Title\Title::getTitleProtection | ( | ) |
Is this title subject to title protection? Title protection is the one applied against creation of such title.
MediaWiki\Title\Title::getTitleValue | ( | ) |
Get a TitleValue object representing this Title.
Definition at line 1049 of file Title.php.
References wfDebug().
MediaWiki\Title\Title::getTouched | ( | $flags = self::READ_NORMAL | ) |
Get the last touched timestamp.
int | $flags | one of the READ_XXX constants. For historical reasons, an IDatabase instance is also accepted here. If an IDatabase is passed, a deprecation warning is triggered, caches will be bypassed, and the primary database connection will be used. However, the IDatabase instance itself will be ignored. |
Definition at line 3769 of file Title.php.
References wfDeprecatedMsg().
MediaWiki\Title\Title::getTransWikiID | ( | ) |
MediaWiki\Title\Title::getWikiId | ( | ) |
Returns false to indicate that this Title belongs to the local wiki.
Implements MediaWiki\Page\PageReference.
MediaWiki\Title\Title::hasContentModel | ( | $id | ) |
MediaWiki\Title\Title::hasDeletedEdits | ( | ) |
MediaWiki\Title\Title::hasFragment | ( | ) |
Check if a Title fragment is set.
Implements MediaWiki\Linker\LinkTarget.
Definition at line 1810 of file Title.php.
Referenced by CoreParserFunctions\displaytitle().
MediaWiki\Title\Title::hasSourceText | ( | ) |
Does this page have source text?
Definition at line 3608 of file Title.php.
References NS_MEDIAWIKI, and wfMessage().
MediaWiki\Title\Title::hasSubjectNamespace | ( | $ns | ) |
Returns true if the title has the same subject namespace as the namespace specified.
For example this method will take NS_USER and return true if namespace is either NS_USER or NS_USER_TALK since both of them have NS_USER as their subject namespace.
This is MUCH simpler than individually testing for equivalence against both NS_USER and NS_USER_TALK, and is also forward compatible.
int | $ns |
MediaWiki\Title\Title::hasSubpages | ( | ) |
MediaWiki\Title\Title::inNamespace | ( | int | $ns | ) |
Returns true if the title is inside the specified namespace.
int | $ns | The namespace |
Implements MediaWiki\Linker\LinkTarget.
MediaWiki\Title\Title::inNamespaces | ( | $namespaces | ) |
MediaWiki\Title\Title::invalidateCache | ( | $purgeTime = null | ) |
Updates page_touched for this page; called from LinksUpdate.php.
string | null | $purgeTime | [optional] TS_MW timestamp |
Definition at line 3702 of file Title.php.
References Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), DB_PRIMARY, Wikimedia\Rdbms\IReadableDatabase\getDomainID(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), Wikimedia\Rdbms\IDatabase\update(), and wfGetDB().
MediaWiki\Title\Title::isAlwaysKnown | ( | ) |
Should links to this title be shown as potentially viewable (i.e.
as "bluelinks"), even if there's no record by this title in the page table?
This function is semi-deprecated for public use, as well as somewhat misleadingly named. You probably just want to call isKnown(), which calls this function internally.
(ISSUE: Most of these checks are cheap, but the file existence check can potentially be quite expensive. Including it here fixes a lot of existing code, but we might want to add an optional parameter to skip it and any other expensive checks.)
Definition at line 3545 of file Title.php.
References NS_FILE, NS_MAIN, NS_MEDIA, NS_MEDIAWIKI, and NS_SPECIAL.
MediaWiki\Title\Title::isBigDeletion | ( | ) |
Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit.
Definition at line 3393 of file Title.php.
References $dbr, $wgDeleteRevisionsLimit, DB_REPLICA, and wfGetDB().
MediaWiki\Title\Title::isCascadeProtected | ( | ) |
Cascading protection: Return true if cascading restrictions apply to this page, false if not.
Definition at line 2535 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::isContentPage | ( | ) |
MediaWiki\Title\Title::isConversionTable | ( | ) |
Is this a conversion table for the LanguageConverter?
Definition at line 1464 of file Title.php.
References NS_MEDIAWIKI.
MediaWiki\Title\Title::isDeleted | ( | ) |
Is there a version of this page in the deletion archive?
MediaWiki\Title\Title::isDeletedQuick | ( | ) |
Is there a version of this page in the deletion archive?
MediaWiki\Title\Title::isExternal | ( | ) |
Is this Title interwiki?
Implements MediaWiki\Linker\LinkTarget.
Definition at line 989 of file Title.php.
Referenced by LinkHolderArray\makeHolder().
MediaWiki\Title\Title::isKnown | ( | ) |
Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages).
Adding something else to this function will cause inconsistency since LinkHolderArray calls isAlwaysKnown() and does its own page existence check.
MediaWiki\Title\Title::isLocal | ( | ) |
Determine whether the object refers to a page within this project (either this wiki or a wiki with a local interwiki, see https://www.mediawiki.org/wiki/Manual:Interwiki_table#iw_local )
MediaWiki\Title\Title::isMainPage | ( | ) |
MediaWiki\Title\Title::isMovable | ( | ) |
MediaWiki\Title\Title::isNewPage | ( | $flags = self::READ_NORMAL | ) |
MediaWiki\Title\Title::isProtected | ( | $action = '' | ) |
Does the title correspond to a protected article?
string | $action | The action the page is protected from, by default checks all actions. |
Definition at line 2521 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::isRawHtmlMessage | ( | ) |
Is this a message which can contain raw HTML?
Definition at line 1640 of file Title.php.
References $wgRawHtmlMessages, and NS_MEDIAWIKI.
MediaWiki\Title\Title::isRedirect | ( | $flags = 0 | ) |
Is this an article that is a redirect page? Uses link cache, adding it if necessary.
This is intended to provide fast access to page_is_redirect for linking. In rare cases, there might not be a valid target in the redirect table even though this function returns true.
To find a redirect target, just call WikiPage::getRedirectTarget() and check if it returns null, there's no need to call this first.
int | $flags | Either a bitfield of class READ_* constants or GAID_FOR_UPDATE |
MediaWiki\Title\Title::isSameLinkAs | ( | LinkTarget | $other | ) |
LinkTarget | $other |
Implements MediaWiki\Linker\LinkTarget.
MediaWiki\Title\Title::isSamePageAs | ( | PageReference | $other | ) |
PageReference | $other |
Implements MediaWiki\Page\PageReference.
MediaWiki\Title\Title::isSemiProtected | ( | $action = 'edit' | ) |
Is this page "semi-protected" - the only protection levels are listed in $wgSemiprotectedRestrictionLevels?
string | $action | Action to check (default: edit) |
Definition at line 2505 of file Title.php.
References wfDeprecated().
MediaWiki\Title\Title::isSingleRevRedirect | ( | ) |
Locks the page row and check if this page is single revision redirect.
This updates the cached fields of this instance via Title::loadFromRow()
Definition at line 3264 of file Title.php.
References DB_PRIMARY, and wfGetDB().
MediaWiki\Title\Title::isSiteConfigPage | ( | ) |
Could this MediaWiki namespace page contain custom CSS, JSON, or JavaScript for the global UI.
This is generally true for pages in the MediaWiki namespace having CONTENT_MODEL_CSS, CONTENT_MODEL_JSON, or CONTENT_MODEL_JAVASCRIPT.
This method does not return true for per-user JS/JSON/CSS. Use isUserConfigPage() for that!
Note that this method should not return true for pages that contain and show "inactive" CSS, JSON, or JS.
MediaWiki\Title\Title::isSiteCssConfigPage | ( | ) |
Is this a sitewide CSS "config" page?
Definition at line 1586 of file Title.php.
References CONTENT_MODEL_CSS, and NS_MEDIAWIKI.
MediaWiki\Title\Title::isSiteJsConfigPage | ( | ) |
Is this a sitewide JS "config" page?
Definition at line 1622 of file Title.php.
References CONTENT_MODEL_JAVASCRIPT, and NS_MEDIAWIKI.
MediaWiki\Title\Title::isSiteJsonConfigPage | ( | ) |
Is this a sitewide JSON "config" page?
Definition at line 1604 of file Title.php.
References CONTENT_MODEL_JSON, and NS_MEDIAWIKI.
MediaWiki\Title\Title::isSpecial | ( | $name | ) |
MediaWiki\Title\Title::isSpecialPage | ( | ) |
Returns true if this is a special page.
Definition at line 1306 of file Title.php.
References NS_SPECIAL.
Referenced by SkinTemplate\buildPersonalUrls().
MediaWiki\Title\Title::isSubpage | ( | ) |
MediaWiki\Title\Title::isSubpageOf | ( | Title | $title | ) |
MediaWiki\Title\Title::isTalkPage | ( | ) |
MediaWiki\Title\Title::isTrans | ( | ) |
MediaWiki\Title\Title::isUserConfigPage | ( | ) |
MediaWiki\Title\Title::isUserCssConfigPage | ( | ) |
Is this a CSS "config" sub-page of a user page?
Definition at line 1544 of file Title.php.
References CONTENT_MODEL_CSS, and NS_USER.
MediaWiki\Title\Title::isUserJsConfigPage | ( | ) |
Is this a JS "config" sub-page of a user page?
Definition at line 1572 of file Title.php.
References CONTENT_MODEL_JAVASCRIPT, and NS_USER.
MediaWiki\Title\Title::isUserJsonConfigPage | ( | ) |
Is this a JSON "config" sub-page of a user page?
Definition at line 1558 of file Title.php.
References CONTENT_MODEL_JSON, and NS_USER.
MediaWiki\Title\Title::isValid | ( | ) |
Returns true if the title is a valid link target, and that it has been properly normalized.
This method checks that the title is syntactically valid, and that the namespace it refers to exists.
Titles constructed using newFromText() or makeTitleSafe() are always valid.
MediaWiki\Title\Title::isValidRedirectTarget | ( | ) |
Check if this Title is a valid redirect target.
Definition at line 3854 of file Title.php.
References $wgInvalidRedirectTargets.
Referenced by WikitextContent\getRedirectTargetAndText(), and XmlDumpWriter\openPage().
MediaWiki\Title\Title::isWikitextPage | ( | ) |
Does that page contain wikitext, or it is JS, CSS or whatever?
Definition at line 1477 of file Title.php.
References CONTENT_MODEL_WIKITEXT.
|
static |
Get a regex character class describing the legal characters in a link.
Definition at line 767 of file Title.php.
References $wgLegalTitleChars.
MediaWiki\Title\Title::loadFromRow | ( | $row | ) |
MediaWiki\Title\Title::loadRestrictions | ( | $flags = 0 | ) |
Load restrictions from the page_restrictions table.
int | $flags | A bit field. If self::READ_LATEST is set, skip replicas and read from the primary DB. |
MediaWiki\Title\Title::loadRestrictionsFromRows | ( | $rows | ) |
Compiles list of active page restrictions from both page table (pre 1.10) and page_restrictions table for this existing page.
Public for usage by LiquidThreads.
stdClass[] | $rows | Array of db result objects |
Definition at line 2667 of file Title.php.
References wfDeprecated().
|
static |
Make a prefixed DB key from a DB key and a namespace index.
int | $ns | Numerical representation of the namespace |
string | $title | The DB key form the title |
string | $fragment | The link fragment (after the "#") |
string | $interwiki | The interwiki prefix |
bool | $canonicalNamespace | If true, use the canonical name for $ns instead of the localized version. |
Definition at line 887 of file Title.php.
References $title.
|
static |
Create a new Title from a namespace index and a DB key.
It's assumed that $ns and $title are safe, for instance when they came directly from the database or a special page name, not from user input.
No validation is applied. For convenience, spaces are normalized to underscores, so that e.g. user_text fields can be used directly.
int | $ns | The namespace of the article |
string | $title | The unprefixed database key form |
string | $fragment | The link fragment (after the "#") |
string | $interwiki | The interwiki prefix |
Definition at line 671 of file Title.php.
References $t, $title, and wfUrlencode().
|
static |
Create a new Title from a namespace index and a DB key.
The parameters will be checked for validity, which is a bit slower than makeTitle() but safer for user-provided data.
The Title object returned by this method is guaranteed to be valid. Call canExist() to check if the Title represents an editable page.
int | $ns | The namespace of the article |
string | $title | Database key form |
string | $fragment | The link fragment (after the "#") |
string | $interwiki | Interwiki prefix |
|
static |
|
static |
|
static |
Make an array of titles from an array of IDs.
int[] | $ids | Array of IDs |
Definition at line 578 of file Title.php.
References $dbr, $res, DB_REPLICA, wfDeprecated(), and wfGetDB().
|
static |
Returns a Title given a LinkTarget.
If the given LinkTarget is already a Title instance, that instance is returned, unless $forceClone is "clone". If $forceClone is "clone" and the given LinkTarget is already a Title instance, that instance is copied using the clone operator.
LinkTarget | $linkTarget | Assumed to be safe. |
string | $forceClone | set to NEW_CLONE to ensure a fresh instance is returned. |
Definition at line 315 of file Title.php.
References MediaWiki\Linker\LinkTarget\getFragment(), MediaWiki\Linker\LinkTarget\getInterwiki(), MediaWiki\Linker\LinkTarget\getNamespace(), and MediaWiki\Linker\LinkTarget\getText().
|
static |
Make a Title object from a DB row.
stdClass | $row | Object database row (needs at least page_title,page_namespace) |
Definition at line 606 of file Title.php.
References $t.
Referenced by MediaWiki\Title\TitleArrayFromResult\setCurrent().
|
static |
Create a new Title from text, such as what one would find in a link.
Decodes any HTML entities in the text. Titles returned by this method are guaranteed to be valid. Call canExist() to check if the Title represents an editable page.
string | int | null | $text | The link text; spaces, prefixes, and an initial ':' indicating the main namespace are accepted. |
int | $defaultNamespace | The namespace to use if none is specified by a prefix. If you want to force a specific namespace even if $text might begin with a namespace prefix, use makeTitle() or makeTitleSafe(). |
InvalidArgumentException |
|
static |
Like Title::newFromText(), but throws MalformedTitleException when the title is invalid, rather than returning null.
Titles returned by this method are guaranteed to be valid. Call canExist() to check if the Title represents an editable page.
string | $text | Title text to check |
int | $defaultNamespace |
MalformedTitleException | If the title is invalid. |
|
static |
Returns a Title given a TitleValue.
If the given TitleValue is already a Title instance, that instance is returned, unless $forceClone is "clone". If $forceClone is "clone" and the given TitleValue is already a Title instance, that instance is copied using the clone operator.
TitleValue | $titleValue | Assumed to be safe. |
string | $forceClone | set to NEW_CLONE to ensure a fresh instance is returned. |
Definition at line 299 of file Title.php.
References wfDeprecated().
|
static |
THIS IS NOT THE FUNCTION YOU WANT.
Use Title::newFromText().
Example of wrong and broken code: $title = Title::newFromURL( $request->getText( 'title' ) );
Example of right code: $title = Title::newFromText( $request->getText( 'title' ) );
Create a new Title from URL-encoded text. Ensures that the given title's length does not exceed the maximum.
string | $url | The title, as might be taken from a URL |
Definition at line 500 of file Title.php.
References $t.
|
static |
Create a new Title for the Main Page.
This uses the 'mainpage' interface message, which could be specified in $wgForceUIMsgAsContentMsg
. If that is the case, then calling this method will use the user language, which would involve initialising the session via RequestContext::getMain()->getLanguage()
. For session-less endpoints, be sure to pass in a MessageLocalizer (such as your own RequestContext or ResourceLoader Context) to prevent an error.
MessageLocalizer | null | $localizer | An optional context to use (since 1.34) |
Definition at line 733 of file Title.php.
References $title, and wfMessage().
MediaWiki\Title\Title::pageCond | ( | ) |
|
static |
Purge expired restrictions from the page_restrictions table.
This will purge no more than $wgUpdateRowsPerQuery page_restrictions rows
Definition at line 2701 of file Title.php.
References Wikimedia\Rdbms\Database\DbQuoter\addQuotes(), DB_PRIMARY, Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IReadableDatabase\selectFieldValues(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), and wfGetDB().
MediaWiki\Title\Title::purgeSquid | ( | ) |
Purge all applicable CDN URLs.
MediaWiki\Title\Title::resetArticleID | ( | $id | ) |
Inject a page ID, reset DB-loaded fields, and clear the link cache for this title.
This can be called on page insertion to allow loading of the new page_id without having to create a new Title instance. Likewise with deletion.
This is also used during page moves, to reflect the change in the relationship between article ID and title text.
int | bool | $id | Page ID, 0 for non-existent, or false for "unknown" (lazy-load) |
MediaWiki\Title\Title::setContentModel | ( | $model | ) |
Set a proposed content model for the page for permissions checking.
This does not actually change the content model of a title in the DB. It only affects this particular Title instance. The content model is forced to remain this value until another setContentModel() call.
ContentHandler::canBeUsedOn() should be checked before calling this if there is any doubt regarding the applicability of the content model
string | $model | CONTENT_MODEL_XXX constant |
MediaWiki\Title\Title::setFragment | ( | $fragment | ) |
Set the fragment for this title.
Removes the first character from the specified fragment before setting, so it assumes you're passing it with an initial "#".
string | $fragment | Text |
MediaWiki\Title\Title::toPageIdentity | ( | ) |
Returns the page represented by this Title as a ProperPageIdentity.
The ProperPageIdentity returned by this method is guaranteed to be immutable. If this Title does not represent a proper page, an exception is thrown.
It is preferred to use this method rather than using the Title as a PageIdentity directly.
PreconditionException | if the page is not a proper page, that is, if it is a section link, interwiki link, link to a special page, or such. |
MediaWiki\Title\Title::toPageRecord | ( | $flags = 0 | ) |
Returns the page represented by this Title as a ProperPageRecord.
The PageRecord returned by this method is guaranteed to be immutable, the page is guaranteed to exist.
int | $flags | Either a bitfield of class READ_* constants or GAID_FOR_UPDATE |
PreconditionException | if the page does not exist, or is not a proper page, that is, if it is a section link, interwiki link, link to a special page, or such. |
MediaWiki\Title\Title::touchLinks | ( | ) |
Update page_touched timestamps and send CDN purge messages for pages linking to this title.
May be sent to the job queue depending on the number of links. Typically called on create and delete.
Definition at line 3742 of file Title.php.
References NS_CATEGORY.
MediaWiki\Title\Title::wasLocalInterwiki | ( | ) |
int MediaWiki\Title\Title::$mArticleID = -1 |
|
protected |
|
protected |
null bool MediaWiki\Title\Title::$mRedirect = null |
string null MediaWiki\Title\Title::$prefixedText = null |
Text form including namespace/interwiki, initialised on demand.
Only public to share cache with TitleFormatter
const MediaWiki\Title\Title::GAID_FOR_UPDATE = 512 |
Used to be GAID_FOR_UPDATE define().
Used with getArticleID() and friends to use the primary DB and inject it into link cache.
const MediaWiki\Title\Title::NEW_CLONE = 'clone' |