Collaboration diagram for Title:

Public Member Functions
	__construct ()
	#- More...

	getText ()
	Simple accessors. More...

	getDBkey ()
	Get the main part with underscores. More...

	getNamespace ()
	Get the namespace index, i.e. More...

	getNsText ()
	Get the namespace text. More...

	getInterwiki ()
	Get the interwiki prefix (or null string) More...

	getFragment ()
	Get the Title fragment (i.e. More...

	prefix ($name)
	Prefix some arbitrary text with the namespace or interwiki prefix of this object. More...

	setFragment ($fragment)
	Set the fragment for this title This is kind of bad, since except for this rarely-used function, Title objects are immutable. More...

	equals ($title)
	Compare with another title. More...

Static Public Member Functions
static	newFromText ($text, $defaultNamespace=NS_MAIN)
	Create a new Title from text, such as what one would find in a link. More...

static	legalChars ()
	Get a regex character class describing the legal characters in a link. More...

	getInterwikiLink ($key)
	Returns the URL associated with an interwiki prefix. More...

Data Fields
	$mTextform
	All member variables should be considered private Please use the accessor functions. More...

	$mUrlform

	$mDbkeyform

	$mNamespace

	$mInterwiki

	$mFragment

	$mArticleID

	$mLatestID

	$mRestrictions

	$mCascadeRestriction

	$mRestrictionsExpiry

	$mHasCascadingRestrictions

	$mCascadeRestrictionSources

	$mRestrictionsLoaded

	$mPrefixedText

	$mDefaultNamespace

	$mWatched

Protected Attributes
bool	$mOldRestrictions

Private Member Functions
	secureAndSplit ()
	Secure and split - main initialisation function for this object. More...

Static Private Attributes
static	$titleCache = array()
	Static cache variables. More...

static	$interwikiCache = array()

Detailed Description

Title class.

Represents a title, which may contain an interwiki designation or namespace
Can fetch various kinds of data from the database, albeit inefficiently.

Definition at line 41 of file Title.php.

Constructor & Destructor Documentation

◆ __construct()

Title::__construct ( )

#-

Constructor

Definition at line 87 of file Title.php.

References NS_MAIN, and null.

     {
         $this->mInterwiki = $this->mUrlform =
         $this->mTextform = $this->mDbkeyform = '';
         $this->mArticleID = -1;
         $this->mNamespace = NS_MAIN;
         $this->mRestrictionsLoaded = false;
         $this->mRestrictions = array();
         # Dont change the following, NS_MAIN is hardcoded in several place
         # See bug #696
         $this->mDefaultNamespace = NS_MAIN;
         $this->mWatched = null;
         $this->mLatestID = false;
         $this->mOldRestrictions = false;
     }

Member Function Documentation

◆ equals()

Title::equals ( $title )

Compare with another title.

Parameters

Title $title

Returns: bool

Definition at line 488 of file Title.php.

References getDBkey(), getInterwiki(), and getNamespace().

     {
         // Note: === is necessary for proper matching of number-like titles.
         return $this->getInterwiki() === $title->getInterwiki()
             && $this->getNamespace() == $title->getNamespace()
             && $this->getDBkey() === $title->getDBkey();
     }

Here is the call graph for this function:

◆ getDBkey()

Title::getDBkey ( )

Get the main part with underscores.

Returns: string

Definition at line 206 of file Title.php.

References $mDbkeyform.

Referenced by equals().

     {
         return $this->mDbkeyform;
     }

Here is the caller graph for this function:

◆ getFragment()

Title::getFragment ( )

Get the Title fragment (i.e.

the bit after the #) in text form

Returns: string

Definition at line 251 of file Title.php.

References $mFragment.

     {
         return $this->mFragment;
     }

◆ getInterwiki()

Title::getInterwiki ( )

Get the interwiki prefix (or null string)

Returns: string

Definition at line 243 of file Title.php.

References $mInterwiki.

Referenced by equals().

     {
         return $this->mInterwiki;
     }

Here is the caller graph for this function:

◆ getInterwikiLink()

Title::getInterwikiLink ( $key )

static

Returns the URL associated with an interwiki prefix.

Parameters

string $key the interwiki prefix (e.g. "MeatBall")

Returns: string the associated URL, containing "$1", which should be replaced by an article title (arguably)

Definition at line 183 of file Title.php.

Referenced by secureAndSplit().

     {
         return "";
     }

Here is the caller graph for this function:

◆ getNamespace()

Title::getNamespace ( )

Get the namespace index, i.e.

one of the NS_xxxx constants

Returns: int

Definition at line 214 of file Title.php.

References $mNamespace.

Referenced by equals().

     {
         return $this->mNamespace;
     }

Here is the caller graph for this function:

◆ getNsText()

Title::getNsText ( )

Get the namespace text.

Returns: string

Definition at line 222 of file Title.php.

References $mNamespace.

Referenced by prefix().

     {
         global $wgContLang, $wgCanonicalNamespaceNames;
 
         if ('' != $this->mInterwiki) {
             // This probably shouldn't even happen. ohh man, oh yuck.
             // But for interwiki transclusion it sometimes does.
             // Shit. Shit shit shit.
             //
             // Use the canonical namespaces if possible to try to
             // resolve a foreign namespace.
             if (isset($wgCanonicalNamespaceNames[$this->mNamespace])) {
                 return $wgCanonicalNamespaceNames[$this->mNamespace];
             }
         }
         return $wgContLang->getNsText($this->mNamespace);
     }

Here is the caller graph for this function:

◆ getText()

Title::getText ( )

Simple accessors.

Get the text form (spaces not underscores) of the main part

Returns: string

Definition at line 197 of file Title.php.

References $mTextform.

     {
         return $this->mTextform;
     }

◆ legalChars()

static Title::legalChars ( )

static

Get a regex character class describing the legal characters in a link.

Returns: string the list of characters, not delimited

Definition at line 166 of file Title.php.

Referenced by secureAndSplit().

     {
         global $wgLegalTitleChars;
 
         $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+";
 
         return $wgLegalTitleChars;
     }

Here is the caller graph for this function:

◆ newFromText()

static Title::newFromText	(	$text,
		$defaultNamespace = `NS_MAIN`
	)

static

Create a new Title from text, such as what one would find in a link.

Decodes any HTML entities in the text.

Parameters

string	$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

Returns: Title the new object, or NULL on an error

Wiki pages often contain multiple links to the same page. Title normalization and parsing can become expensive on pages with many links, so we can save a little time by caching them.

In theory these are value objects and won't get changed...

Convert things like é ā or 〗 into real text...

Definition at line 115 of file Title.php.

References $titleCache, Sanitizer\decodeCharReferences(), MW_TITLECACHE_MAX, NS_MAIN, and null.

Referenced by ilWikiUtil\processInternalLinks().

     {
         if ($defaultNamespace == NS_MAIN && isset(Title::$titleCache[$text])) {
             return Title::$titleCache[$text];
         }
 
         $filteredText = Sanitizer::decodeCharReferences($text);
 
         $t = new Title();
         $t->mDbkeyform = str_replace(' ', '_', $filteredText);
         $t->mDefaultNamespace = $defaultNamespace;
 
         static $cachedcount = 0 ;
         if ($t->secureAndSplit()) {
             if ($defaultNamespace == NS_MAIN) {
                 if ($cachedcount >= MW_TITLECACHE_MAX) {
                     # Avoid memory leaks on mass operations...
                     Title::$titleCache = array();
                     $cachedcount = 0;
                 }
                 $cachedcount++;
                 Title::$titleCache[$text] = &$t;
             }
             return $t;
         } else {
             $ret = null;
             return $ret;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prefix()

Title::prefix ( $name )

Prefix some arbitrary text with the namespace or interwiki prefix of this object.

Parameters

string $name the text

Returns: string the prefixed text

Definition at line 264 of file Title.php.

References getNsText().

     {
         $p = '';
         if ('' != $this->mInterwiki) {
             $p = $this->mInterwiki . ':';
         }
         if (0 != $this->mNamespace) {
             $p .= $this->getNsText() . ':';
         }
         return $p . $name;
     }

Here is the call graph for this function:

◆ secureAndSplit()

Title::secureAndSplit ( )

private

Secure and split - main initialisation function for this object.

Assumes that mDbkeyform has been set, and is urldecoded and uses underscores, but not otherwise munged. This function removes illegal characters, splits off the interwiki and namespace prefixes, sets the other forms, and canonicalizes everything.

Returns: bool true on success

Pages with "/./" or "/../" appearing in the URLs will often be unreachable due to the way web browsers deal with 'relative' URLs. Forbid them explicitly.

Magic tilde sequences? Nu-uh!

Limit the size of titles to 255 bytes. This is typically the size of the underlying database field. We make an exception for special pages, which don't need to be stored in the database, and may edge over 255 bytes due to subpage syntax for long titles, e.g. [[Special:Block/Long name]]

Normally, all wiki links are forced to have an initial capital letter so [[foo]] and [[Foo]] point to the same place.

Don't force it for interwikis, since the other site might be case-sensitive.

Can't make a link to a namespace alone... "empty" local links can only be self-links with a fragment identifier.

Definition at line 286 of file Title.php.

References $mDbkeyform, $mDefaultNamespace, getInterwikiLink(), legalChars(), NS_MAIN, NS_SPECIAL, setFragment(), and ilWikiUtil\wfUrlencode().

     {
         global $wgContLang, $wgLocalInterwiki, $wgCapitalLinks;
 
         # Initialisation
         static $rxTc = false;
         if (!$rxTc) {
             # % is needed as well
             $rxTc = '/[^' . Title::legalChars() . ']|%[0-9A-Fa-f]{2}/S';
         }
 
         $this->mInterwiki = $this->mFragment = '';
         $this->mNamespace = $this->mDefaultNamespace; # Usually NS_MAIN
 
         $dbkey = $this->mDbkeyform;
 
         # Strip Unicode bidi override characters.
         # Sometimes they slip into cut-n-pasted page titles, where the
         # override chars get included in list displays.
         $dbkey = str_replace("\xE2\x80\x8E", '', $dbkey); // 200E LEFT-TO-RIGHT MARK
         $dbkey = str_replace("\xE2\x80\x8F", '', $dbkey); // 200F RIGHT-TO-LEFT MARK
 
         # Clean up whitespace
         #
         $dbkey = preg_replace('/[ _]+/', '_', $dbkey);
         $dbkey = trim($dbkey, '_');
 
         if ('' == $dbkey) {
             return false;
         }
 
         if (false !== strpos($dbkey, UTF8_REPLACEMENT)) {
             # Contained illegal UTF-8 sequences or forbidden Unicode chars.
             return false;
         }
 
         $this->mDbkeyform = $dbkey;
 
         # Initial colon indicates main namespace rather than specified default
         # but should not create invalid {ns,title} pairs such as {0,Project:Foo}
         if (':' == $dbkey[0]) {
             $this->mNamespace = NS_MAIN;
             $dbkey = substr($dbkey, 1); # remove the colon but continue processing
             $dbkey = trim($dbkey, '_'); # remove any subsequent whitespace
         }
 
         # Namespace or interwiki prefix
         $firstPass = true;
         do {
             $m = array();
             if (preg_match("/^(.+?)_*:_*(.*)$/S", $dbkey, $m)) {
                 $p = $m[1];
                 if ($ns = $wgContLang->getNsIndex($p)) {
                     # Ordinary namespace
                     $dbkey = $m[2];
                     $this->mNamespace = $ns;
                 } elseif ($this->getInterwikiLink($p)) {
                     if (!$firstPass) {
                         # Can't make a local interwiki link to an interwiki link.
                         # That's just crazy!
                         return false;
                     }
 
                     # Interwiki link
                     $dbkey = $m[2];
                     $this->mInterwiki = $wgContLang->lc($p);
 
                     # Redundant interwiki prefix to the local wiki
                     if (0 == strcasecmp($this->mInterwiki, $wgLocalInterwiki)) {
                         if ($dbkey == '') {
                             # Can't have an empty self-link
                             return false;
                         }
                         $this->mInterwiki = '';
                         $firstPass = false;
                         # Do another namespace split...
                         continue;
                     }
 
                     # If there's an initial colon after the interwiki, that also
                     # resets the default namespace
                     if ($dbkey !== '' && $dbkey[0] == ':') {
                         $this->mNamespace = NS_MAIN;
                         $dbkey = substr($dbkey, 1);
                     }
                 }
                 # If there's no recognized interwiki or namespace,
                 # then let the colon expression be part of the title.
             }
             break;
         } while (true);
 
         # We already know that some pages won't be in the database!
         #
         if ('' != $this->mInterwiki || NS_SPECIAL == $this->mNamespace) {
             $this->mArticleID = 0;
         }
         $fragment = strstr($dbkey, '#');
         if (false !== $fragment) {
             $this->setFragment($fragment);
             $dbkey = substr($dbkey, 0, strlen($dbkey) - strlen($fragment));
             # remove whitespace again: prevents "Foo_bar_#"
             # becoming "Foo_bar_"
             $dbkey = preg_replace('/_*$/', '', $dbkey);
         }
 
         # Reject illegal characters.
         #
         if (preg_match($rxTc, $dbkey)) {
             return false;
         }
 
         if (strpos($dbkey, '.') !== false &&
              ($dbkey === '.' || $dbkey === '..' ||
                strpos($dbkey, './') === 0 ||
                strpos($dbkey, '../') === 0 ||
                strpos($dbkey, '/./') !== false ||
                strpos($dbkey, '/../') !== false)) {
             return false;
         }
 
         if (strpos($dbkey, '~~~') !== false) {
             return false;
         }
 
         if (($this->mNamespace != NS_SPECIAL && strlen($dbkey) > 255) ||
           strlen($dbkey) > 512) {
             return false;
         }
 
         if ($wgCapitalLinks && $this->mInterwiki == '') {
             $dbkey = $wgContLang->ucfirst($dbkey);
         }
 
         if ($dbkey == '' &&
             $this->mInterwiki == '' &&
             $this->mNamespace != NS_MAIN) {
             return false;
         }
 
         // Any remaining initial :s are illegal.
         if ($dbkey !== '' && ':' == $dbkey[0]) {
             return false;
         }
 
         # Fill fields
         $this->mDbkeyform = $dbkey;
         $this->mUrlform = ilWikiUtil::wfUrlencode($dbkey);
 
         $this->mTextform = str_replace('_', ' ', $dbkey);
 
         return true;
     }

Here is the call graph for this function:

◆ setFragment()

Title::setFragment ( $fragment )

Set the fragment for this title This is kind of bad, since except for this rarely-used function, Title objects are immutable.

The reason this is here is because it's better than setting the members directly, which is what Linker::formatComment was doing previously.

Parameters

string $fragment text

Todo:: clarify whether access is supposed to be public (was marked as "kind of public")

Definition at line 477 of file Title.php.

Referenced by secureAndSplit().

     {
         $this->mFragment = str_replace('_', ' ', substr($fragment, 1));
     }

Here is the caller graph for this function:

Field Documentation

◆ $interwikiCache

Title::$interwikiCache = array()

staticprivate

Definition at line 47 of file Title.php.

◆ $mArticleID

Title::$mArticleID

Definition at line 68 of file Title.php.

◆ $mCascadeRestriction

Title::$mCascadeRestriction

Definition at line 71 of file Title.php.

◆ $mCascadeRestrictionSources

Title::$mCascadeRestrictionSources

Definition at line 74 of file Title.php.

◆ $mDbkeyform

Title::$mDbkeyform

Definition at line 64 of file Title.php.

Referenced by getDBkey(), and secureAndSplit().

◆ $mDefaultNamespace

Title::$mDefaultNamespace

Definition at line 77 of file Title.php.

Referenced by secureAndSplit().

◆ $mFragment

Title::$mFragment

Definition at line 67 of file Title.php.

Referenced by getFragment().

◆ $mHasCascadingRestrictions

Title::$mHasCascadingRestrictions

Definition at line 73 of file Title.php.

◆ $mInterwiki

Title::$mInterwiki

Definition at line 66 of file Title.php.

Referenced by getInterwiki().

◆ $mLatestID

Title::$mLatestID

Definition at line 69 of file Title.php.

◆ $mNamespace

Title::$mNamespace

Definition at line 65 of file Title.php.

Referenced by getNamespace(), and getNsText().

◆ $mOldRestrictions

bool Title::$mOldRestrictions

protected

Definition at line 51 of file Title.php.

◆ $mPrefixedText

Title::$mPrefixedText

Definition at line 76 of file Title.php.

◆ $mRestrictions

Title::$mRestrictions

Definition at line 70 of file Title.php.

◆ $mRestrictionsExpiry

Title::$mRestrictionsExpiry

Definition at line 72 of file Title.php.

◆ $mRestrictionsLoaded

Title::$mRestrictionsLoaded

Definition at line 75 of file Title.php.

◆ $mTextform

Title::$mTextform

All member variables should be considered private Please use the accessor functions.

#+

Definition at line 62 of file Title.php.

Referenced by getText().

◆ $mUrlform

Title::$mUrlform

Definition at line 63 of file Title.php.

◆ $mWatched

Title::$mWatched

Definition at line 79 of file Title.php.

◆ $titleCache

Title::$titleCache = array()

staticprivate

Static cache variables.

Definition at line 46 of file Title.php.

Referenced by newFromText().

The documentation for this class was generated from the following file:

components/ILIAS/Wiki/mediawiki/Title.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ equals()

◆ getDBkey()

◆ getFragment()

◆ getInterwiki()

◆ getInterwikiLink()

◆ getNamespace()

◆ getNsText()

◆ getText()

◆ legalChars()

◆ newFromText()

◆ prefix()

◆ secureAndSplit()

◆ setFragment()

Field Documentation

◆ $interwikiCache

◆ $mArticleID

◆ $mCascadeRestriction

◆ $mCascadeRestrictionSources

◆ $mDbkeyform

◆ $mDefaultNamespace

◆ $mFragment

◆ $mHasCascadingRestrictions

◆ $mInterwiki

◆ $mLatestID

◆ $mNamespace

◆ $mOldRestrictions

◆ $mPrefixedText

◆ $mRestrictions

◆ $mRestrictionsExpiry

◆ $mRestrictionsLoaded

◆ $mTextform

◆ $mUrlform

◆ $mWatched

◆ $titleCache