Title Class Reference

Title class. More...

Collaboration diagram for Title:

Public Member Functions
	__construct ()
	#- More...
	isLocal ()
	Determine whether the object refers to a page within this project. More...
	isTrans ()
	Determine whether the object refers to a page within this project and is transcludable. More...
	getText ()
	Simple accessors. More...
	getPartialURL ()
	Get the URL-encoded form of the main part. 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 namespace text of the subject (rather than talk) page. More...
	getFragment ()
	Get the Title fragment (i.e. More...
	getFragmentForURL ()
	Get the fragment in URL form, including the "#" character if there is one. More...
	getDefaultNamespace ()
	Get the default namespace index, for when there is no namespace. More...
	getIndexTitle ()
	Get title for search index. More...
	getPrefixedDBkey ()
	Get the prefixed database key form. More...
	getPrefixedText ()
	Get the prefixed title with spaces. More...
	getFullText ()
	Get the prefixed title with spaces, plus any fragment (part beginning with '#') More...
	getBaseText ()
	Get the base name, i.e. More...
	getSubpageText ()
	Get the lowest-level subpage name, i.e. More...
	getSubpageUrlForm ()
	Get a URL-encoded form of the subpage text. More...
	getPrefixedURL ()
	Get a URL-encoded title (not an actual URL) including interwiki. More...
	getFullURL ($query='', $variant=false)
	Get a real URL referring to this title, with interwiki link and fragment. More...
	getLocalURL ($query='', $variant=false)
	Get a URL with no fragment or server name. More...
	escapeLocalURL ($query='')
	Get an HTML-escaped version of the URL form, suitable for using in a link, without a server name or fragment. More...
	escapeFullURL ($query='')
	Get an HTML-escaped version of the URL form, suitable for using in a link, including the server name and fragment. More...
	getInternalURL ($query='', $variant=false)
	Get the URL form for an internal link. More...
	getEditURL ()
	Get the edit URL for this Title. More...
	getEscapedText ()
	Get the HTML-escaped displayable text form. More...
	isExternal ()
	Is this Title interwiki? More...
	isSemiProtected ($action='edit')
	Is this page "semi-protected" - the only protection is autoconfirm? More...
	isProtected ($action='')
	Does the title correspond to a protected article? More...
	userIsWatching ()
	Is $wgUser is watching this page? More...
	quickUserCan ($action)
	Can $wgUser perform $action on this page? This skips potentially expensive cascading permission checks. More...
	userCan ($action, $doExpensiveQueries=true)
	Can $wgUser perform $action on this page? More...
	userCanEdit ($doExpensiveQueries=true)
	Can $wgUser edit this page? More...
	userCanCreate ($doExpensiveQueries=true)
	Can $wgUser create this page? More...
	userCanMove ($doExpensiveQueries=true)
	Can $wgUser move this page? More...
	userCanRead ()
	Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable. More...
	isSubpage ()
	Is this a talk page of some sort? More...
	getSkinFromCssJsSubpage ()
	Trim down a .css or .js subpage title to get the corresponding skin name. More...
	isCssSubpage ()
	Is this a .css subpage of a user page? More...
	isJsSubpage ()
	Is this a .js subpage of a user page? More...
	userCanEditCssJsSubpage ()
	Protect css/js subpages of user pages: can $wgUser edit this page? More...
	areRestrictionsCascading ()
	loadRestrictions ($oldFashionedRestrictions=null)
	getRestrictions ($action)
	Accessor/initialisation for mRestrictions. More...
	isDeleted ()
	Is there a version of this page in the deletion archive? More...
	getArticleID ($flags=0)
	Get the article ID for this Title from the link cache, adding it if necessary. More...
	getLatestRevID ()
	resetArticleID ($newid)
	This clears some fields in this object, and clears any associated keys in the "bad links" section of the link cache. More...
	invalidateCache ()
	Updates page_touched for this page; called from LinksUpdate.php. 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...
	getLinksTo ($options='', $table='pagelinks', $prefix='pl')
	Get a Title object associated with the talk page of this article. More...
	getTemplateLinksTo ($options='')
	Get an array of Title objects using this Title as a template Also stores the IDs in the link cache. More...
	getBrokenLinksFrom ($options='')
	Get an array of Title objects referring to non-existent articles linked from this page. More...
	getSquidURLs ()
	Get a list of URLs to purge from the Squid cache when this page changes. More...
	purgeSquid ()
	moveNoAuth (&$nt)
	Move this page without authentication. More...
	isValidMoveOperation ($nt, $auth=true)
	Check whether a given move operation would be valid. More...
	moveTo (&$nt, $auth=true, $reason='')
	Move a title to a new location. More...
	isValidMoveTarget ($nt)
	Checks if $this can be moved to a given Title. More...
	getParentCategories ()
	Get categories to which this Title belongs and return an array of categories' names. More...
	getParentCategoryTree ($children=array())
	Get a tree of parent categories. More...
	pageCond ()
	Get an associative array for selecting this title from the "page" table. More...
	getPreviousRevisionID ($revision)
	Get the revision ID of the previous revision. More...
	getNextRevisionID ($revision)
	Get the revision ID of the next revision. More...
	countRevisionsBetween ($old, $new)
	Get the number of revisions between the given revision IDs. More...
	equals ($title)
	Compare with another title. More...
	exists ()
	Check if page exists. More...
	isAlwaysKnown ()
	Should a link should be displayed as a known link, just based on its title? More...
	touchLinks ()
	Update page_touched timestamps and send squid purge messages for pages linking to this title. More...
	getTouched ()
	Get the last touched timestamp. More...
	trackbackURL ()
	trackbackRDF ()
	getNamespaceKey ()
	Generate strings used for xml 'id' names in monobook tabs. More...
	isSpecial ($name)
	Returns true if this title resolves to the named special page. More...
	fixSpecialName ()
	If the Title refers to a special page alias which is not the local default, returns a new Title which points to the local default. More...

Static Public Member Functions
static	newFromDBkey ($key)
	Create a new Title from a prefixed DB key. More...
static	newFromText ($text, $defaultNamespace=NS_MAIN)
	Create a new Title from text, such as what one would find in a link. More...
static	newFromURL ($url)
	Create a new Title from URL-encoded text. More...
static	newFromID ($id)
	Create a new Title from an article ID. More...
static	newFromIDs ($ids)
	Make an array of titles from an array of IDs. More...
static &	makeTitle ($ns, $title)
	Create a new Title from a namespace index and a DB key. More...
static	makeTitleSafe ($ns, $title)
	Create a new Title from a namespace index and a DB key. More...
static	newMainPage ()
	Create a new Title for the Main Page. More...
	nameOf ($id)
	Get the prefixed DB key associated with an ID. More...
static	legalChars ()
	Get a regex character class describing the legal characters in a link. More...
static	makeName ($ns, $title)
	getInterwikiLink ($key)
	Returns the URL associated with an interwiki prefix. More...
static	getInterwikiCached ($key)
	Fetch interwiki prefix data from local cache in constant database. More...
static	escapeFragmentForURL ($fragment)
	Escape a text fragment, say from a link, for a URL. More...
static	purgeExpiredRestrictions ()
	Purge expired restrictions from the page_restrictions table. 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

Private Member Functions
	loadRestrictionsFromRow ($res, $oldFashionedRestrictions=null)
	Loads a string into mRestrictions array. More...
	secureAndSplit ()
	Secure and split - main initialisation function for this object. More...
	moveOverExistingRedirect ($nt, $reason='')
	Move page to a title which is at present a redirect to the source page. More...
	moveToNewTitle (&$nt, $reason='')
	Move page to non-existing title. 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 26 of file Title.php.

Constructor & Destructor Documentation

__construct()

Title::__construct

(

)

#-

Constructor

Definition at line 69 of file Title.php.

References NS_MAIN.

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

areRestrictionsCascading()

Title::areRestrictionsCascading

(

)

Definition at line 1272 of file Title.php.

References $mCascadeRestriction, and loadRestrictions().

    {
        if (!$this->mRestrictionsLoaded) {
            $this->loadRestrictions();
        }

        return $this->mCascadeRestriction;
    }

Here is the call graph for this function:

countRevisionsBetween()

Title::countRevisionsBetween	(		$old,
			$new
	)

Get the number of revisions between the given revision IDs.

Parameters

int	$old	Revision ID.
int	$new	Revision ID.

Returns

int Number of revisions between these IDs.

Definition at line 2364 of file Title.php.

References getArticleID().

    {
        $dbr = wfGetDB(DB_SLAVE);
        return $dbr->selectField(
            'revision',
            'count(*)',
            'rev_page = ' . $this->getArticleID() .
            ' AND rev_id > ' . intval($old) .
            ' AND rev_id < ' . intval($new)
        );
    }

Here is the call graph for this function:

equals()

Title::equals

(

$title

)

Compare with another title.

Parameters

Title

$title

Returns

bool

Definition at line 2382 of file Title.php.

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

Referenced by isValidMoveOperation().

    {
        // 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:

Here is the caller graph for this function:

escapeFragmentForURL()

static Title::escapeFragmentForURL (   $fragment )

static

Escape a text fragment, say from a link, for a URL.

Definition at line 484 of file Title.php.

References Sanitizer\decodeCharReferences().

Referenced by getFragmentForURL().

    {
        $fragment = str_replace(' ', '_', $fragment);
        $fragment = urlencode(Sanitizer::decodeCharReferences($fragment));
        $replaceArray = array(
            '%3A' => ':',
            '%' => '.'
        );
        return strtr($fragment, $replaceArray);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

escapeFullURL()

Title::escapeFullURL

(

$query = ''

)

Get an HTML-escaped version of the URL form, suitable for using in a link, including the server name and fragment.

Returns

string the URL

Parameters

string

$query

an optional query string

Definition at line 871 of file Title.php.

References $query, and getFullURL().

    {
        return htmlspecialchars($this->getFullURL($query));
    }

Here is the call graph for this function:

escapeLocalURL()

Title::escapeLocalURL

(

$query = ''

)

Get an HTML-escaped version of the URL form, suitable for using in a link, without a server name or fragment.

Parameters

string

$query

an optional query string

Returns

string the URL

Definition at line 859 of file Title.php.

References $query, and getLocalURL().

    {
        return htmlspecialchars($this->getLocalURL($query));
    }

Here is the call graph for this function:

exists()

Title::exists

(

)

Check if page exists.

Returns

bool

Definition at line 2394 of file Title.php.

References getArticleID().

Referenced by getRestrictions(), isSemiProtected(), and isValidMoveOperation().

    {
        return $this->getArticleID() != 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fixSpecialName()

Title::fixSpecialName

(

)

If the Title refers to a special page alias which is not the local default, returns a new Title which points to the local default.

Otherwise, returns $this.

Definition at line 2531 of file Title.php.

References getNamespace(), makeTitle(), and NS_SPECIAL.

    {
        if ($this->getNamespace() == NS_SPECIAL) {
            $canonicalName = SpecialPage::resolveAlias($this->mDbkeyform);
            if ($canonicalName) {
                $localName = SpecialPage::getLocalNameFor($canonicalName);
                if ($localName != $this->mDbkeyform) {
                    return Title::makeTitle(NS_SPECIAL, $localName);
                }
            }
        }
        return $this;
    }

Here is the call graph for this function:

getArticleID()

Title::getArticleID

(

$flags = 0

)

Get the article ID for this Title from the link cache, adding it if necessary.

Parameters

int

$flags

a bit field; may be GAID_FOR_UPDATE to select for update

Returns

int the ID

Definition at line 1426 of file Title.php.

References $mArticleID, and GAID_FOR_UPDATE.

Referenced by countRevisionsBetween(), exists(), getBrokenLinksFrom(), getLatestRevID(), getNextRevisionID(), getParentCategories(), getPreviousRevisionID(), isValidMoveOperation(), loadRestrictions(), loadRestrictionsFromRow(), moveTo(), and moveToNewTitle().

    {
        $linkCache = &LinkCache::singleton();
        if ($flags & GAID_FOR_UPDATE) {
            $oldUpdate = $linkCache->forUpdate(true);
            $this->mArticleID = $linkCache->addLinkObj($this);
            $linkCache->forUpdate($oldUpdate);
        } else {
            if (-1 == $this->mArticleID) {
                $this->mArticleID = $linkCache->addLinkObj($this);
            }
        }
        return $this->mArticleID;
    }

Here is the caller graph for this function:

getBaseText()

Title::getBaseText

(

)

Get the base name, i.e.

the leftmost parts before the /

Returns

string Base name

Definition at line 672 of file Title.php.

References $parts, and getText().

    {
        global $wgNamespacesWithSubpages;
        if (isset($wgNamespacesWithSubpages[ $this->mNamespace ]) && $wgNamespacesWithSubpages[ $this->mNamespace ]) {
            $parts = explode('/', $this->getText());
            # Don't discard the real title if there's no subpage involved
            if (count($parts) > 1) {
                unset($parts[ count($parts) - 1 ]);
            }
            return implode('/', $parts);
        } else {
            return $this->getText();
        }
    }

Here is the call graph for this function:

getBrokenLinksFrom()

Title::getBrokenLinksFrom

(

$options = ''

)

Get an array of Title objects referring to non-existent articles linked from this page.

Parameters

string

$options

may be FOR UPDATE

Returns

array the Title objects

Definition at line 1822 of file Title.php.

References $res, getArticleID(), and makeTitle().

    {
        if ($options) {
            $db = wfGetDB(DB_MASTER);
        } else {
            $db = wfGetDB(DB_SLAVE);
        }

        $res = $db->safeQuery(
            "SELECT pl_namespace, pl_title
                             FROM !
                        LEFT JOIN !
                               ON pl_namespace=page_namespace
                              AND pl_title=page_title
                            WHERE pl_from=?
                              AND page_namespace IS NULL
                                  !",
            $db->tableName('pagelinks'),
            $db->tableName('page'),
            $this->getArticleID(),
            $options
        );

        $retVal = array();
        if ($db->numRows($res)) {
            while ($row = $db->fetchObject($res)) {
                $retVal[] = Title::makeTitle($row->pl_namespace, $row->pl_title);
            }
        }
        $db->freeResult($res);
        return $retVal;
    }

Here is the call graph for this function:

getDBkey()

Title::getDBkey

(

)

Get the main part with underscores.

Returns

string

Definition at line 520 of file Title.php.

References $mDbkeyform.

Referenced by equals(), getLinksTo(), getTouched(), invalidateCache(), isDeleted(), isSpecial(), and isValidMoveOperation().

    {
        return $this->mDbkeyform;
    }

Here is the caller graph for this function:

getDefaultNamespace()

Title::getDefaultNamespace

(

)

Get the default namespace index, for when there is no namespace.

Returns

int

Definition at line 611 of file Title.php.

References $mDefaultNamespace.

    {
        return $this->mDefaultNamespace;
    }

getEditURL()

Title::getEditURL

(

)

Get the edit URL for this Title.

Returns

string the URL, or a null string if this is an interwiki link

Definition at line 898 of file Title.php.

References getLocalURL().

    {
        if ('' != $this->mInterwiki) {
            return '';
        }
        $s = $this->getLocalURL('action=edit');

        return $s;
    }

Here is the call graph for this function:

getEscapedText()

Title::getEscapedText

(

)

Get the HTML-escaped displayable text form.

Used for the title field in tags.

Returns

string the text, including any prefixes

Definition at line 913 of file Title.php.

References getPrefixedText().

    {
        return htmlspecialchars($this->getPrefixedText());
    }

Here is the call 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 591 of file Title.php.

References $mFragment.

    {
        return $this->mFragment;
    }

getFragmentForURL()

Title::getFragmentForURL

(

)

Get the fragment in URL form, including the "#" character if there is one.

Returns

string

Definition at line 599 of file Title.php.

References escapeFragmentForURL().

Referenced by getFullURL().

    {
        if ($this->mFragment == '') {
            return '';
        } else {
            return '#' . Title::escapeFragmentForURL($this->mFragment);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFullText()

Title::getFullText

(

)

Get the prefixed title with spaces, plus any fragment (part beginning with '#')

Returns

string the prefixed title, with spaces and the fragment, including '#'

Definition at line 659 of file Title.php.

References $mFragment, and getPrefixedText().

Referenced by getParentCategories().

    {
        $text = $this->getPrefixedText();
        if ('' != $this->mFragment) {
            $text .= '#' . $this->mFragment;
        }
        return $text;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getFullURL()

Title::getFullURL	(		$query = '',
			$variant = false
	)

Get a real URL referring to this title, with interwiki link and fragment.

Parameters

string	$query	an optional query string, not used for interwiki links
string	$variant	language variant of url (for sr, zh..)

Returns

string the URL

Definition at line 741 of file Title.php.

References $namespace, $query, $url, getFragmentForURL(), getInterwikiLink(), getLocalURL(), and getNsText().

Referenced by escapeFullURL(), getLocalURL(), and trackbackRDF().

    {
        global $wgContLang, $wgServer, $wgRequest;

        if ('' == $this->mInterwiki) {
            $url = $this->getLocalURL($query, $variant);

            // Ugly quick hack to avoid duplicate prefixes (bug 4571 etc)
            // Correct fix would be to move the prepending elsewhere.
            if ($wgRequest->getVal('action') != 'render') {
                $url = $wgServer . $url;
            }
        } else {
            $baseUrl = $this->getInterwikiLink($this->mInterwiki);

            $namespace = wfUrlencode($this->getNsText());
            if ('' != $namespace) {
                # Can this actually happen? Interwikis shouldn't be parsed.
                # Yes! It can in interwiki transclusion. But... it probably shouldn't.
                $namespace .= ':';
            }
            $url = str_replace('$1', $namespace . $this->mUrlform, $baseUrl);
            $url = wfAppendQuery($url, $query);
        }

        # Finally, add the fragment.
        $url .= $this->getFragmentForURL();

        wfRunHooks('GetFullURL', array( &$this, &$url, $query ));
        return $url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIndexTitle()

Title::getIndexTitle

(

)

Get title for search index.

Returns

string a stripped-down title string ready for the search index

Definition at line 621 of file Title.php.

    {
        return Title::indexTitle($this->mNamespace, $this->mTextform);
    }

getInternalURL()

Title::getInternalURL	(		$query = '',
			$variant = false
	)

Get the URL form for an internal link.

• Used in various Squid-related code, in case we have a different internal hostname for the server from the exposed one.

Parameters

string	$query	an optional query string
string	$variant	language variant of url (for sr, zh..)

Returns

string the URL

Definition at line 885 of file Title.php.

References $query, $url, and getLocalURL().

Referenced by getSquidURLs().

    {
        global $wgInternalServer;
        $url = $wgInternalServer . $this->getLocalURL($query, $variant);
        wfRunHooks('GetInternalURL', array( &$this, &$url, $query ));
        return $url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInterwiki()

Title::getInterwiki

(

)

Get the namespace text of the subject (rather than talk) page.

Returns

string Get the namespace text of the talk page

string Could this title have a corresponding talk page?

bool Get the interwiki prefix (or null string)

string

Definition at line 583 of file Title.php.

References $mInterwiki.

Referenced by equals().

    {
        return $this->mInterwiki;
    }

Here is the caller graph for this function:

getInterwikiCached()

static Title::getInterwikiCached (   $key )

static

Fetch interwiki prefix data from local cache in constant database.

More logic is explained in DefaultSettings

Returns

string URL of interwiki site

Definition at line 406 of file Title.php.

References $interwikiCache, ILIAS\LTI\ToolProvider\$key, $url, ILIAS\Repository\int(), and ILIAS\Repository\object().

Referenced by getInterwikiLink().

    {
        global $wgInterwikiCache, $wgInterwikiScopes, $wgInterwikiFallbackSite;
        static $db, $site;

        if (!$db) {
            $db = dba_open($wgInterwikiCache, 'r', 'cdb');
        }
        /* Resolve site name */
        if ($wgInterwikiScopes >= 3 and !$site) {
            $site = dba_fetch('__sites:' . wfWikiID(), $db);
            if ($site == "") {
                $site = $wgInterwikiFallbackSite;
            }
        }
        $value = dba_fetch(wfMemcKey($key), $db);
        if ($value == '' and $wgInterwikiScopes >= 3) {
            /* try site-level */
            $value = dba_fetch("_{$site}:{$key}", $db);
        }
        if ($value == '' and $wgInterwikiScopes >= 2) {
            /* try globals */
            $value = dba_fetch("__global:{$key}", $db);
        }
        if ($value == 'undef') {
            $value = '';
        }
        $s = (object) false;
        $s->iw_url = '';
        $s->iw_local = 0;
        $s->iw_trans = 0;
        if ($value != '') {
            list($local, $url) = explode(' ', $value, 2);
            $s->iw_url = $url;
            $s->iw_local = (int) $local;
        }
        Title::$interwikiCache[wfMemcKey('interwiki', $key)] = $s;
        return $s->iw_url;
    }

Here is the call graph for this function:

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 347 of file Title.php.

References $interwikiCache, ILIAS\LTI\ToolProvider\$key, $res, getInterwikiCached(), and ILIAS\Repository\object().

Referenced by getFullURL(), isLocal(), isTrans(), and secureAndSplit().

    {
        global $wgMemc, $wgInterwikiExpiry;
        global $wgInterwikiCache, $wgContLang;

        return "";              // changed. alex

        $fname = 'Title::getInterwikiLink';

        $key = $wgContLang->lc($key);

        $k = wfMemcKey('interwiki', $key);
        if (array_key_exists($k, Title::$interwikiCache)) {
            return Title::$interwikiCache[$k]->iw_url;
        }

        if ($wgInterwikiCache) {
            return Title::getInterwikiCached($key);
        }

        $s = $wgMemc->get($k);
        # Ignore old keys with no iw_local
        if ($s && isset($s->iw_local) && isset($s->iw_trans)) {
            Title::$interwikiCache[$k] = $s;
            return $s->iw_url;
        }

        $dbr = wfGetDB(DB_SLAVE);
        $res = $dbr->select(
            'interwiki',
            array( 'iw_url', 'iw_local', 'iw_trans' ),
            array( 'iw_prefix' => $key ),
            $fname
        );
        if (!$res) {
            return '';
        }

        $s = $dbr->fetchObject($res);
        if (!$s) {
            # Cache non-existence: create a blank object and save it to memcached
            $s = (object) false;
            $s->iw_url = '';
            $s->iw_local = 0;
            $s->iw_trans = 0;
        }
        $wgMemc->set($k, $s, $wgInterwikiExpiry);
        Title::$interwikiCache[$k] = $s;

        return $s->iw_url;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLatestRevID()

Title::getLatestRevID

(

)

Definition at line 1441 of file Title.php.

References $mLatestID, and getArticleID().

    {
        if ($this->mLatestID !== false) {
            return $this->mLatestID;
        }

        $db = wfGetDB(DB_SLAVE);
        return $this->mLatestID = $db->selectField(
            'revision',
            "max(rev_id)",
            array('rev_page' => $this->getArticleID()),
            'Title::getLatestRevID'
        );
    }

Here is the call graph for this function:

getLinksTo()

Title::getLinksTo	(		$options = '',
			$table = 'pagelinks',
			$prefix = 'pl'
	)

Get a Title object associated with the talk page of this article.

Returns

Title the object for the talk page Get a title object associated with the subject page of this talk page

Title the object for the subject page 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.

Parameters

string

$options

may be FOR UPDATE

Returns

array the Title objects linking here

Definition at line 1767 of file Title.php.

References $res, getDBkey(), getNamespace(), and makeTitle().

Referenced by getTemplateLinksTo().

    {
        $linkCache = &LinkCache::singleton();

        if ($options) {
            $db = wfGetDB(DB_MASTER);
        } else {
            $db = wfGetDB(DB_SLAVE);
        }

        $res = $db->select(
            array( 'page', $table ),
            array( 'page_namespace', 'page_title', 'page_id' ),
            array(
                "{$prefix}_from=page_id",
                "{$prefix}_namespace" => $this->getNamespace(),
                "{$prefix}_title" => $this->getDBkey() ),
            'Title::getLinksTo',
            $options
        );

        $retVal = array();
        if ($db->numRows($res)) {
            while ($row = $db->fetchObject($res)) {
                if ($titleObj = Title::makeTitle($row->page_namespace, $row->page_title)) {
                    $linkCache->addGoodLinkObj($row->page_id, $titleObj);
                    $retVal[] = $titleObj;
                }
            }
        }
        $db->freeResult($res);
        return $retVal;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLocalURL()

Title::getLocalURL	(		$query = '',
			$variant = false
	)

Get a URL with no fragment or server name.

If this page is generated with action=render, $wgServer is prepended.

Parameters

string	$query	an optional query string; if not specified, $wgArticlePath will be used.
string	$variant	language variant of url (for sr, zh..)

Returns

string the URL

Definition at line 781 of file Title.php.

References $query, $url, getFullURL(), getPrefixedDBkey(), and isExternal().

Referenced by escapeLocalURL(), getEditURL(), getFullURL(), and getInternalURL().

    {
        global $wgArticlePath, $wgScript, $wgServer, $wgRequest;
        global $wgVariantArticlePath, $wgContLang, $wgUser;

        // internal links should point to same variant as current page (only anonymous users)
        if ($variant == false && $wgContLang->hasVariants() && !$wgUser->isLoggedIn()) {
            $pref = $wgContLang->getPreferredVariant(false);
            if ($pref != $wgContLang->getCode()) {
                $variant = $pref;
            }
        }

        if ($this->isExternal()) {
            $url = $this->getFullURL();
            if ($query) {
                // This is currently only used for edit section links in the
                // context of interwiki transclusion. In theory we should
                // append the query to the end of any existing query string,
                // but interwiki transclusion is already broken in that case.
                $url .= "?$query";
            }
        } else {
            $dbkey = wfUrlencode($this->getPrefixedDBkey());
            if ($query == '') {
                if ($variant != false && $wgContLang->hasVariants()) {
                    if ($wgVariantArticlePath == false) {
                        $variantArticlePath = "$wgScript?title=$1&variant=$2"; // default
                    } else {
                        $variantArticlePath = $wgVariantArticlePath;
                    }
                    $url = str_replace('$2', urlencode($variant), $variantArticlePath);
                    $url = str_replace('$1', $dbkey, $url);
                } else {
                    $url = str_replace('$1', $dbkey, $wgArticlePath);
                }
            } else {
                global $wgActionPaths;
                $url = false;
                $matches = array();
                if (!empty($wgActionPaths) &&
                    preg_match('/^(.*&|)action=([^&]*)(&(.*)|)$/', $query, $matches)) {
                    $action = urldecode($matches[2]);
                    if (isset($wgActionPaths[$action])) {
                        $query = $matches[1];
                        if (isset($matches[4])) {
                            $query .= $matches[4];
                        }
                        $url = str_replace('$1', $dbkey, $wgActionPaths[$action]);
                        if ($query != '') {
                            $url .= '?' . $query;
                        }
                    }
                }
                if ($url === false) {
                    if ($query == '-') {
                        $query = '';
                    }
                    $url = "{$wgScript}?title={$dbkey}&{$query}";
                }
            }

            // FIXME: this causes breakage in various places when we
            // actually expected a local URL and end up with dupe prefixes.
            if ($wgRequest->getVal('action') == 'render') {
                $url = $wgServer . $url;
            }
        }
        wfRunHooks('GetLocalURL', array( &$this, &$url, $query ));
        return $url;
    }

Here is the call graph for this function:

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 528 of file Title.php.

References $mNamespace.

Referenced by equals(), fixSpecialName(), getLinksTo(), getNamespaceKey(), getTouched(), invalidateCache(), isDeleted(), isProtected(), isSpecial(), touchLinks(), and userCanRead().

    {
        return $this->mNamespace;
    }

Here is the caller graph for this function:

getNamespaceKey()

Title::getNamespaceKey

(

)

Generate strings used for xml 'id' names in monobook tabs.

Returns

string

Definition at line 2475 of file Title.php.

References getNamespace(), NS_MAIN, and NS_SPECIAL.

    {
        global $wgContLang;
        switch ($this->getNamespace()) {
            case NS_MAIN:
            case NS_TALK:
                return 'nstab-main';
            case NS_USER:
            case NS_USER_TALK:
                return 'nstab-user';
            case NS_MEDIA:
                return 'nstab-media';
            case NS_SPECIAL:
                return 'nstab-special';
            case NS_PROJECT:
            case NS_PROJECT_TALK:
                return 'nstab-project';
            case NS_IMAGE:
            case NS_IMAGE_TALK:
                return 'nstab-image';
            case NS_MEDIAWIKI:
            case NS_MEDIAWIKI_TALK:
                return 'nstab-mediawiki';
            case NS_TEMPLATE:
            case NS_TEMPLATE_TALK:
                return 'nstab-template';
            case NS_HELP:
            case NS_HELP_TALK:
                return 'nstab-help';
            case NS_CATEGORY:
            case NS_CATEGORY_TALK:
                return 'nstab-category';
            default:
                return 'nstab-' . $wgContLang->lc($this->getSubjectNsText());
        }
    }

Here is the call graph for this function:

getNextRevisionID()

Title::getNextRevisionID

(

$revision

)

Get the revision ID of the next revision.

Parameters

int

$revision

Revision ID. Get the revision that was after this one.

Returns

int $oldrevision|false

Definition at line 2347 of file Title.php.

References getArticleID().

    {
        $dbr = wfGetDB(DB_SLAVE);
        return $dbr->selectField(
            'revision',
            'rev_id',
            'rev_page=' . $this->getArticleID() .
            ' AND rev_id>' . intval($revision) . ' ORDER BY rev_id'
        );
    }

Here is the call graph for this function:

getNsText()

Title::getNsText

(

)

Get the namespace text.

Returns

string

Definition at line 536 of file Title.php.

References $mNamespace.

Referenced by getFullURL(), and 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:

getParentCategories()

Title::getParentCategories

(

)

Get categories to which this Title belongs and return an array of categories' names.

Returns

array an array of parents in the form: $parent => $currentarticle

Definition at line 2259 of file Title.php.

References $data, $res, getArticleID(), and getFullText().

Referenced by getParentCategoryTree().

    {
        global $wgContLang;
        $data = [];
        $titlekey = $this->getArticleID();
        $dbr = wfGetDB(DB_SLAVE);
        $categorylinks = $dbr->tableName('categorylinks');

        # NEW SQL
        $sql = "SELECT * FROM $categorylinks"
             . " WHERE cl_from='$titlekey'"
             . " AND cl_from <> '0'"
             . " ORDER BY cl_sortkey";

        $res = $dbr->query($sql) ;

        if ($dbr->numRows($res) > 0) {
            while ($x = $dbr->fetchObject($res)) {
                //$data[] = Title::newFromText($wgContLang->getNSText ( NS_CATEGORY ).':'.$x->cl_to);
                $data[$wgContLang->getNSText(NS_CATEGORY) . ':' . $x->cl_to] = $this->getFullText();
            }
            $dbr->freeResult($res) ;
        } else {
            $data = '';
        }
        return $data;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentCategoryTree()

Title::getParentCategoryTree

(

$children = array()

)

Get a tree of parent categories.

Parameters

array

$children

an array with the children in the keys, to check for circular refs

Returns

array

Definition at line 2292 of file Title.php.

References getParentCategories(), and newFromText().

    {
        $parents = $this->getParentCategories();
        $stack = [];
        if ($parents != '') {
            foreach ($parents as $parent => $current) {
                if (array_key_exists($parent, $children)) {
                    # Circular reference
                    $stack[$parent] = array();
                } else {
                    $nt = Title::newFromText($parent);
                    if ($nt) {
                        $stack[$parent] = $nt->getParentCategoryTree($children + array($parent => 1));
                    }
                }
            }
            return $stack;
        } else {
            return array();
        }
    }

Here is the call graph for this function:

getPartialURL()

Title::getPartialURL

(

)

Get the URL-encoded form of the main part.

Returns

string

Definition at line 512 of file Title.php.

References $mUrlform.

    {
        return $this->mUrlform;
    }

getPrefixedDBkey()

Title::getPrefixedDBkey

(

)

Get the prefixed database key form.

Returns

string the prefixed title, with underscores and any interwiki and namespace prefixes

Definition at line 631 of file Title.php.

References prefix().

Referenced by getLocalURL(), isValidMoveTarget(), moveToNewTitle(), and resetArticleID().

    {
        $s = $this->prefix($this->mDbkeyform);
        $s = str_replace(' ', '_', $s);
        return $s;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPrefixedText()

Title::getPrefixedText

(

)

Get the prefixed title with spaces.

This is the form usually used for display

Returns

string the prefixed title, with spaces

Definition at line 643 of file Title.php.

References $mPrefixedText, and prefix().

Referenced by getEscapedText(), getFullText(), moveToNewTitle(), and userCanRead().

    {
        if (empty($this->mPrefixedText)) { // FIXME: bad usage of empty() ?
            $s = $this->prefix($this->mTextform);
            $s = str_replace('_', ' ', $s);
            $this->mPrefixedText = $s;
        }
        return $this->mPrefixedText;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPrefixedURL()

Title::getPrefixedURL

(

)

Get a URL-encoded title (not an actual URL) including interwiki.

Returns

string the URL-encoded form

Definition at line 718 of file Title.php.

References prefix().

    {
        $s = $this->prefix($this->mDbkeyform);
        $s = str_replace(' ', '_', $s);

        $s = wfUrlencode($s) ;

        # Cleaning up URL to make it look nice -- is this safe?
        $s = str_replace('%28', '(', $s);
        $s = str_replace('%29', ')', $s);

        return $s;
    }

Here is the call graph for this function:

getPreviousRevisionID()

Title::getPreviousRevisionID

(

$revision

)

Get the revision ID of the previous revision.

Parameters

int

$revision

Revision ID. Get the revision that was before this one.

Returns

int $oldrevision|false

Definition at line 2331 of file Title.php.

References getArticleID().

    {
        $dbr = wfGetDB(DB_SLAVE);
        return $dbr->selectField(
            'revision',
            'rev_id',
            'rev_page=' . $this->getArticleID() .
            ' AND rev_id<' . intval($revision) . ' ORDER BY rev_id DESC'
        );
    }

Here is the call graph for this function:

getRestrictions()

Title::getRestrictions

(

$action

)

Accessor/initialisation for mRestrictions.

Parameters

string

$action

action that permission needs to be checked for

Returns

array the array of groups allowed to edit this article

Definition at line 1382 of file Title.php.

References exists(), and loadRestrictions().

Referenced by isProtected(), isSemiProtected(), and userCan().

    {
        if ($this->exists()) {
            if (!$this->mRestrictionsLoaded) {
                $this->loadRestrictions();
            }
            return $this->mRestrictions[$action] ?? array();
        } else {
            return array();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSkinFromCssJsSubpage()

Title::getSkinFromCssJsSubpage

(

)

Trim down a .css or .js subpage title to get the corresponding skin name.

Definition at line 1238 of file Title.php.

    {
        $subpage = explode('/', $this->mTextform);
        $subpage = $subpage[ count($subpage) - 1 ];
        return(str_replace(array( '.css', '.js' ), array( '', '' ), $subpage));
    }

getSquidURLs()

Title::getSquidURLs

(

)

Get a list of URLs to purge from the Squid cache when this page changes.

Returns

array the URLs

Definition at line 1862 of file Title.php.

References getInternalURL().

Referenced by purgeSquid().

    {
        global $wgContLang;

        $urls = array(
            $this->getInternalURL(),
            $this->getInternalURL('action=history')
        );

        // purge variant urls as well
        if ($wgContLang->hasVariants()) {
            $variants = $wgContLang->getVariants();
            foreach ($variants as $vCode) {
                if ($vCode == $wgContLang->getCode()) {
                    continue;
                } // we don't want default variant
                $urls[] = $this->getInternalURL('', $vCode);
            }
        }

        return $urls;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubpageText()

Title::getSubpageText

(

)

Get the lowest-level subpage name, i.e.

the rightmost part after /

Returns

string Subpage name

Definition at line 691 of file Title.php.

References $parts.

Referenced by getSubpageUrlForm().

    {
        global $wgNamespacesWithSubpages;
        if (isset($wgNamespacesWithSubpages[ $this->mNamespace ]) && $wgNamespacesWithSubpages[ $this->mNamespace ]) {
            $parts = explode('/', $this->mTextform);
            return($parts[ count($parts) - 1 ]);
        } else {
            return($this->mTextform);
        }
    }

Here is the caller graph for this function:

getSubpageUrlForm()

Title::getSubpageUrlForm

(

)

Get a URL-encoded form of the subpage text.

Returns

string URL-encoded subpage name

Definition at line 706 of file Title.php.

References getSubpageText(), and ILIAS\UI\examples\Symbol\Glyph\Up\up().

    {
        $text = $this->getSubpageText();
        $text = wfUrlencode(str_replace(' ', '_', $text));
        $text = str_replace('%28', '(', str_replace('%29', ')', $text)); # Clean up the URL; per below, this might not be safe
        return($text);
    }

Here is the call graph for this function:

getTemplateLinksTo()

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.

Parameters

string

$options

may be FOR UPDATE

Returns

array the Title objects linking here

Definition at line 1811 of file Title.php.

References getLinksTo().

    {
        return $this->getLinksTo($options, 'templatelinks', 'tl');
    }

Here is the call 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 504 of file Title.php.

References $mTextform.

Referenced by getBaseText(), isSubpage(), and trackbackRDF().

    {
        return $this->mTextform;
    }

Here is the caller graph for this function:

getTouched()

Title::getTouched

(

)

Get the last touched timestamp.

Definition at line 2430 of file Title.php.

References getDBkey(), and getNamespace().

    {
        $dbr = wfGetDB(DB_SLAVE);
        $touched = $dbr->selectField(
            'page',
            'page_touched',
            array(
                'page_namespace' => $this->getNamespace(),
                'page_title' => $this->getDBkey()
            ),
            __METHOD__
        );
        return $touched;
    }

Here is the call graph for this function:

invalidateCache()

Title::invalidateCache

(

)

Updates page_touched for this page; called from LinksUpdate.php.

Returns

bool true if the update succeded

Definition at line 1484 of file Title.php.

References getDBkey(), and getNamespace().

    {
        global $wgUseFileCache;

        if (wfReadOnly()) {
            return;
        }

        $dbw = wfGetDB(DB_MASTER);
        $success = $dbw->update(
            'page',
            array( /* SET */
                'page_touched' => $dbw->timestamp()
            ),
            array( /* WHERE */
                'page_namespace' => $this->getNamespace() ,
                'page_title' => $this->getDBkey()
            ),
            'Title::invalidateCache'
        );

        if ($wgUseFileCache) {
            $cache = new HTMLFileCache($this);
            @unlink($cache->fileCacheName());
        }

        return $success;
    }

Here is the call graph for this function:

isAlwaysKnown()

Title::isAlwaysKnown

(

)

Should a link should be displayed as a known link, just based on its title?

Currently, a self-link with a fragment and special pages are in this category. Special pages never exist in the database.

Definition at line 2405 of file Title.php.

References $mDbkeyform, isExternal(), and NS_SPECIAL.

    {
        return  $this->isExternal() || (0 == $this->mNamespace && "" == $this->mDbkeyform)
          || NS_SPECIAL == $this->mNamespace;
    }

Here is the call graph for this function:

isCssSubpage()

Title::isCssSubpage

(

)

Is this a .css subpage of a user page?

Returns

bool

Definition at line 1248 of file Title.php.

    {
        return (NS_USER == $this->mNamespace and preg_match("/\\/.*\\.css$/", $this->mTextform));
    }

isDeleted()

Title::isDeleted

(

)

Is there a version of this page in the deletion archive?

Returns

int the number of archived revisions

Definition at line 1398 of file Title.php.

References getDBkey(), and getNamespace().

    {
        $fname = 'Title::isDeleted';
        if ($this->getNamespace() < 0) {
            $n = 0;
        } else {
            $dbr = wfGetDB(DB_SLAVE);
            $n = $dbr->selectField('archive', 'COUNT(*)', array( 'ar_namespace' => $this->getNamespace(),
                'ar_title' => $this->getDBkey() ), $fname);
            if ($this->getNamespace() == NS_IMAGE) {
                $n += $dbr->selectField(
                    'filearchive',
                    'COUNT(*)',
                    array( 'fa_name' => $this->getDBkey() ),
                    $fname
                );
            }
        }
        return (int) $n;
    }

Here is the call graph for this function:

isExternal()

Title::isExternal

(

)

Is this Title interwiki?

Returns

bool

Definition at line 922 of file Title.php.

Referenced by getLocalURL(), and isAlwaysKnown().

    {
        return ('' != $this->mInterwiki);
    }

Here is the caller graph for this function:

isJsSubpage()

Title::isJsSubpage

(

)

Is this a .js subpage of a user page?

Returns

bool

Definition at line 1256 of file Title.php.

    {
        return (NS_USER == $this->mNamespace and preg_match("/\\/.*\\.js$/", $this->mTextform));
    }

isLocal()

Title::isLocal

(

)

Determine whether the object refers to a page within this project.

Returns

bool TRUE if this is an in-project interwiki link or a wikilink, FALSE otherwise

Definition at line 452 of file Title.php.

References $interwikiCache, and getInterwikiLink().

    {
        if ($this->mInterwiki != '') {
            # Make sure key is loaded into cache
            $this->getInterwikiLink($this->mInterwiki);
            $k = wfMemcKey('interwiki', $this->mInterwiki);
            return (bool) (Title::$interwikiCache[$k]->iw_local);
        } else {
            return true;
        }
    }

Here is the call graph for this function:

isProtected()

Title::isProtected

(

$action = ''

)

Does the title correspond to a protected article?

Parameters

string

$what

the action the page is protected from, by default checks move and edit

Returns

bool

Definition at line 960 of file Title.php.

References getNamespace(), getRestrictions(), and NS_SPECIAL.

    {
        global $wgRestrictionLevels;

        # Special pages have inherent protection
        if ($this->getNamespace() == NS_SPECIAL) {
            return true;
        }

        # Check regular protection levels
        if ($action == 'edit' || $action == '') {
            $r = $this->getRestrictions('edit');
            foreach ($wgRestrictionLevels as $level) {
                if (in_array($level, $r) && $level != '') {
                    return(true);
                }
            }
        }

        if ($action == 'move' || $action == '') {
            $r = $this->getRestrictions('move');
            foreach ($wgRestrictionLevels as $level) {
                if (in_array($level, $r) && $level != '') {
                    return(true);
                }
            }
        }

        return false;
    }

Here is the call graph for this function:

isSemiProtected()

Title::isSemiProtected

(

$action = 'edit'

)

Is this page "semi-protected" - the only protection is autoconfirm?

Parameters

string

Action to check (default: edit)

Returns

bool

Definition at line 933 of file Title.php.

References exists(), and getRestrictions().

    {
        if ($this->exists()) {
            $restrictions = $this->getRestrictions($action);
            if (count($restrictions) > 0) {
                foreach ($restrictions as $restriction) {
                    if (strtolower($restriction) != 'autoconfirmed') {
                        return false;
                    }
                }
            } else {
                # Not protected
                return false;
            }
            return true;
        } else {
            # If it doesn't exist, it can't be protected
            return false;
        }
    }

Here is the call graph for this function:

isSpecial()

Title::isSpecial

(

$name

)

Returns true if this title resolves to the named special page.

Parameters

string

$name

The special page name

Definition at line 2516 of file Title.php.

References $name, getDBkey(), getNamespace(), and NS_SPECIAL.

Referenced by userCanRead().

    {
        if ($this->getNamespace() == NS_SPECIAL) {
            list($thisName, /* $subpage */ ) = SpecialPage::resolveAliasWithSubpage($this->getDBkey());
            if ($name == $thisName) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSubpage()

Title::isSubpage

(

)

Is this a talk page of some sort?

Returns

bool Is this a subpage?

bool

Definition at line 1224 of file Title.php.

References getText().

    {
        global $wgNamespacesWithSubpages;

        if (isset($wgNamespacesWithSubpages[ $this->mNamespace ])) {
            return (strpos($this->getText(), '/') !== false && $wgNamespacesWithSubpages[ $this->mNamespace ] == true);
        } else {
            return false;
        }
    }

Here is the call graph for this function:

isTrans()

Title::isTrans

(

)

Determine whether the object refers to a page within this project and is transcludable.

Returns

bool TRUE if this is transcludable

Definition at line 470 of file Title.php.

References $interwikiCache, and getInterwikiLink().

    {
        if ($this->mInterwiki == '') {
            return false;
        }
        # Make sure key is loaded into cache
        $this->getInterwikiLink($this->mInterwiki);
        $k = wfMemcKey('interwiki', $this->mInterwiki);
        return (bool) (Title::$interwikiCache[$k]->iw_trans);
    }

Here is the call graph for this function:

isValidMoveOperation()

Title::isValidMoveOperation	(		$nt,
			$auth = true
	)

Check whether a given move operation would be valid.

Returns true if ok, or a message key string for an error message if invalid. (Scarrrrry ugly interface this.)

Parameters

Title	&$nt	the new title
bool	$auth	indicates whether $wgUser's permissions should be checked

Returns

mixed true on success, message name on failure

Definition at line 1913 of file Title.php.

References $auth, equals(), exists(), getArticleID(), getDBkey(), isValidMoveTarget(), and userCan().

Referenced by moveTo().

    {
        if (!$this or !$nt) {
            return 'badtitletext';
        }
        if ($this->equals($nt)) {
            return 'selfmove';
        }
        if (!$this->isMovable() || !$nt->isMovable()) {
            return 'immobile_namespace';
        }

        $oldid = $this->getArticleID();
        $newid = $nt->getArticleID();

        if (strlen($nt->getDBkey()) < 1) {
            return 'articleexists';
        }
        if (('' == $this->getDBkey()) ||
             (!$oldid) ||
             ('' == $nt->getDBkey())) {
            return 'badarticleerror';
        }

        if ($auth && (
            !$this->userCan('edit') || !$nt->userCan('edit') ||
                !$this->userCan('move') || !$nt->userCan('move')
        )) {
            return 'protectedpage';
        }

        # The move is allowed only if (1) the target doesn't exist, or
        # (2) the target is a redirect to the source, and has no history
        # (so we can undo bad moves right after they're done).

        if (0 != $newid) { # Target exists; check for validity
            if (!$this->isValidMoveTarget($nt)) {
                return 'articleexists';
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isValidMoveTarget()

Title::isValidMoveTarget

(

$nt

)

Checks if $this can be moved to a given Title.

• Selects for update, so don't call it unless you mean business

Parameters

Title

&$nt

the new title to check

Definition at line 2197 of file Title.php.

References $id, getPrefixedDBkey(), and newFromText().

Referenced by isValidMoveOperation().

    {
        $fname = 'Title::isValidMoveTarget';
        $dbw = wfGetDB(DB_MASTER);

        # Is it a redirect?
        $id = $nt->getArticleID();
        $obj = $dbw->selectRow(
            array( 'page', 'revision', 'text'),
            array( 'page_is_redirect','old_text','old_flags' ),
            array( 'page_id' => $id, 'page_latest=rev_id', 'rev_text_id=old_id' ),
            $fname,
            'FOR UPDATE'
        );

        if (!$obj || 0 == $obj->page_is_redirect) {
            # Not a redirect
            wfDebug(__METHOD__ . ": not a redirect\n");
            return false;
        }
        $text = Revision::getRevisionText($obj);

        # Does the redirect point to the source?
        # Or is it a broken self-redirect, usually caused by namespace collisions?
        $m = array();
        if (preg_match("/\\[\\[\\s*([^\\]\\|]*)]]/", $text, $m)) {
            $redirTitle = Title::newFromText($m[1]);
            if (!is_object($redirTitle) ||
                ($redirTitle->getPrefixedDBkey() != $this->getPrefixedDBkey() &&
                $redirTitle->getPrefixedDBkey() != $nt->getPrefixedDBkey())) {
                wfDebug(__METHOD__ . ": redirect points to other page\n");
                return false;
            }
        } else {
            # Fail safe
            wfDebug(__METHOD__ . ": failsafe\n");
            return false;
        }

        # Does the article have a history?
        $row = $dbw->selectRow(
            array( 'page', 'revision'),
            array( 'rev_id' ),
            array( 'page_namespace' => $nt->getNamespace(),
                'page_title' => $nt->getDBkey(),
                'page_id=rev_page AND page_latest != rev_id'
            ),
            $fname,
            'FOR UPDATE'
        );

        # Return true if there was no history
        return $row === false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

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 316 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:

loadRestrictions()

Title::loadRestrictions

(

$oldFashionedRestrictions = null

)

Definition at line 1347 of file Title.php.

References $res, getArticleID(), and loadRestrictionsFromRow().

Referenced by areRestrictionsCascading(), and getRestrictions().

    {
        if (!$this->mRestrictionsLoaded) {
            $dbr = wfGetDB(DB_SLAVE);

            $res = $dbr->select(
                'page_restrictions',
                '*',
                array( 'pr_page' => $this->getArticleID() ),
                __METHOD__
            );

            $this->loadRestrictionsFromRow($res, $oldFashionedRestrictions);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadRestrictionsFromRow()

Title::loadRestrictionsFromRow (   $res,   $oldFashionedRestrictions = null  )

private

Loads a string into mRestrictions array.

Parameters

resource

$res

restrictions as an SQL result.

Definition at line 1285 of file Title.php.

References $res, getArticleID(), and purgeExpiredRestrictions().

Referenced by loadRestrictions().

    {
        $dbr = wfGetDb(DB_SLAVE);

        $this->mRestrictions['edit'] = array();
        $this->mRestrictions['move'] = array();

        # Backwards-compatibility: also load the restrictions from the page record (old format).

        if ($oldFashionedRestrictions == null) {
            $oldFashionedRestrictions = $dbr->selectField('page', 'page_restrictions', array( 'page_id' => $this->getArticleID() ), __METHOD__);
        }

        if ($oldFashionedRestrictions != '') {
            foreach (explode(':', trim($oldFashionedRestrictions)) as $restrict) {
                $temp = explode('=', trim($restrict));
                if (count($temp) == 1) {
                    // old old format should be treated as edit/move restriction
                    $this->mRestrictions["edit"] = explode(',', trim($temp[0]));
                    $this->mRestrictions["move"] = explode(',', trim($temp[0]));
                } else {
                    $this->mRestrictions[$temp[0]] = explode(',', trim($temp[1]));
                }
            }

            $this->mOldRestrictions = true;
            $this->mCascadeRestriction = false;
            $this->mRestrictionsExpiry = Block::decodeExpiry('');
        }

        if ($dbr->numRows($res)) {
            # Current system - load second to make them override.
            $now = wfTimestampNow();
            $purgeExpired = false;

            while ($row = $dbr->fetchObject($res)) {
                # Cycle through all the restrictions.

                // This code should be refactored, now that it's being used more generally,
                // But I don't really see any harm in leaving it in Block for now -werdna
                $expiry = Block::decodeExpiry($row->pr_expiry);

                // Only apply the restrictions if they haven't expired!
                if (!$expiry || $expiry > $now) {
                    $this->mRestrictionsExpiry = $expiry;
                    $this->mRestrictions[$row->pr_type] = explode(',', trim($row->pr_level));

                    $this->mCascadeRestriction |= $row->pr_cascade;
                } else {
                    // Trigger a lazy purge of expired restrictions
                    $purgeExpired = true;
                }
            }

            if ($purgeExpired) {
                Title::purgeExpiredRestrictions();
            }
        }

        $this->mRestrictionsLoaded = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

makeName()

static Title::makeName (   $ns,   $title  )

static

Definition at line 332 of file Title.php.

Referenced by makeTitleSafe(), and nameOf().

    {
        global $wgContLang;

        $n = $wgContLang->getNsText($ns);
        return $n == '' ? $title : "$n:$title";
    }

Here is the caller graph for this function:

makeTitle()

static& Title::makeTitle (   $ns,   $title  )

static

Create a new Title from a namespace index and a DB key.

It's assumed that $ns and $title are valid, for instance when they came directly from the database or a special page name. For convenience, spaces are converted to underscores so that eg user_text fields can be used directly.

Parameters

int	$ns	the namespace of the article
string	$title	the unprefixed database key form

Returns

Title the new object

Definition at line 243 of file Title.php.

Referenced by fixSpecialName(), getBrokenLinksFrom(), getLinksTo(), newFromID(), and newFromIDs().

    {
        $t = new Title();
        $t->mInterwiki = '';
        $t->mFragment = '';
        $t->mNamespace = intval($ns);
        $t->mDbkeyform = str_replace(' ', '_', $title);
        $t->mArticleID = ($ns >= 0) ? -1 : 0;
        $t->mUrlform = wfUrlencode($t->mDbkeyform);
        $t->mTextform = str_replace('_', ' ', $title);
        return $t;
    }

Here is the caller graph for this function:

makeTitleSafe()

static Title::makeTitleSafe (   $ns,   $title  )

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.

Parameters

int	$ns	the namespace of the article
string	$title	the database key form

Returns

Title the new object, or NULL on an error

Definition at line 265 of file Title.php.

References makeName().

    {
        $t = new Title();
        $t->mDbkeyform = Title::makeName($ns, $title);
        if ($t->secureAndSplit()) {
            return $t;
        } else {
            return null;
        }
    }

Here is the call graph for this function:

moveNoAuth()

Title::moveNoAuth

(

&

$nt

)

Move this page without authentication.

Parameters

Title

&$nt

the new page Title

Definition at line 1899 of file Title.php.

References moveTo().

    {
        return $this->moveTo($nt, false);
    }

Here is the call graph for this function:

moveOverExistingRedirect()

Title::moveOverExistingRedirect (   $nt,   $reason = ''  )

private

Move page to a title which is at present a redirect to the source page.

Parameters

Title

&$nt

the page to move to, which should currently be a redirect

Definition at line 2037 of file Title.php.

Referenced by moveTo().

    {
        global $wgUseSquid;
        $fname = 'Title::moveOverExistingRedirect';
        $comment = wfMsgForContent('1movedto2_redir', $this->getPrefixedText(), $nt->getPrefixedText());

        if ($reason) {
            $comment .= ": $reason";
        }

        $now = wfTimestampNow();
        $newid = $nt->getArticleID();
        $oldid = $this->getArticleID();
        $dbw = wfGetDB(DB_MASTER);
        $linkCache = &LinkCache::singleton();

        # Delete the old redirect. We don't save it to history since
        # by definition if we've got here it's rather uninteresting.
        # We have to remove it so that the next step doesn't trigger
        # a conflict on the unique namespace+title index...
        $dbw->delete('page', array( 'page_id' => $newid ), $fname);

        # Save a null revision in the page's history notifying of the move
        $nullRevision = Revision::newNullRevision($dbw, $oldid, $comment, true);
        $nullRevId = $nullRevision->insertOn($dbw);

        # Change the name of the target page:
        $dbw->update(
            'page',
            /* SET */
            array(
                'page_touched' => $dbw->timestamp($now),
                'page_namespace' => $nt->getNamespace(),
                'page_title' => $nt->getDBkey(),
                'page_latest' => $nullRevId,
            ),
            /* WHERE */
            array( 'page_id' => $oldid ),
            $fname
        );
        $linkCache->clearLink($nt->getPrefixedDBkey());

        # Recreate the redirect, this time in the other direction.
        $mwRedir = MagicWord::get('redirect');
        $redirectText = $mwRedir->getSynonym(0) . ' [[' . $nt->getPrefixedText() . "]]\n";
        $redirectArticle = new Article($this);
        $newid = $redirectArticle->insertOn($dbw);
        $redirectRevision = new Revision(array(
            'page' => $newid,
            'comment' => $comment,
            'text' => $redirectText ));
        $redirectRevision->insertOn($dbw);
        $redirectArticle->updateRevisionOn($dbw, $redirectRevision, 0);
        $linkCache->clearLink($this->getPrefixedDBkey());

        # Log the move
        $log = new LogPage('move');
        $log->addEntry('move_redir', $this, $reason, array( 1 => $nt->getPrefixedText() ));

        # Now, we record the link from the redirect to the new title.
        # It should have no other outgoing links...
        $dbw->delete('pagelinks', array( 'pl_from' => $newid ), $fname);
        $dbw->insert(
            'pagelinks',
            array(
                'pl_from' => $newid,
                'pl_namespace' => $nt->getNamespace(),
                'pl_title' => $nt->getDBkey() ),
            $fname
        );

        # Purge squid
        if ($wgUseSquid) {
            $urls = array_merge($nt->getSquidURLs(), $this->getSquidURLs());
            $u = new SquidUpdate($urls);
            $u->doUpdate();
        }
    }

Here is the caller graph for this function:

moveTo()

Title::moveTo	(	&	$nt,
			$auth = true,
			$reason = ''
	)

Move a title to a new location.

Parameters

Title	&$nt	the new title
bool	$auth	indicates whether $wgUser's permissions should be checked

Returns

mixed true on success, message name on failure

Definition at line 1963 of file Title.php.

References $auth, ILIAS\LTI\ToolProvider\$reason, getArticleID(), isValidMoveOperation(), and moveOverExistingRedirect().

Referenced by moveNoAuth().

    {
        $err = $this->isValidMoveOperation($nt, $auth);
        if (is_string($err)) {
            return $err;
        }

        $pageid = $this->getArticleID();
        if ($nt->exists()) {
            $this->moveOverExistingRedirect($nt, $reason);
            $pageCountChange = 0;
        } else { # Target didn't exist, do normal move.
            $this->moveToNewTitle($nt, $reason);
            $pageCountChange = 1;
        }
        $redirid = $this->getArticleID();

        # Fixing category links (those without piped 'alternate' names) to be sorted under the new title
        $dbw = wfGetDB(DB_MASTER);
        $categorylinks = $dbw->tableName('categorylinks');
        $sql = "UPDATE $categorylinks SET cl_sortkey=" . $dbw->addQuotes($nt->getPrefixedText()) .
            " WHERE cl_from=" . $dbw->addQuotes($pageid) .
            " AND cl_sortkey=" . $dbw->addQuotes($this->getPrefixedText());
        $dbw->query($sql, 'SpecialMovepage::doSubmit');

        # Update watchlists

        $oldnamespace = $this->getNamespace() & ~1;
        $newnamespace = $nt->getNamespace() & ~1;
        $oldtitle = $this->getDBkey();
        $newtitle = $nt->getDBkey();

        if ($oldnamespace != $newnamespace || $oldtitle != $newtitle) {
            WatchedItem::duplicateEntries($this, $nt);
        }

        # Update search engine
        $u = new SearchUpdate($pageid, $nt->getPrefixedDBkey());
        $u->doUpdate();
        $u = new SearchUpdate($redirid, $this->getPrefixedDBkey(), '');
        $u->doUpdate();

        # Update site_stats
        if ($this->isContentPage() && !$nt->isContentPage()) {
            # No longer a content page
            # Not viewed, edited, removing
            $u = new SiteStatsUpdate(0, 1, -1, $pageCountChange);
        } elseif (!$this->isContentPage() && $nt->isContentPage()) {
            # Now a content page
            # Not viewed, edited, adding
            $u = new SiteStatsUpdate(0, 1, +1, $pageCountChange);
        } elseif ($pageCountChange) {
            # Redirect added
            $u = new SiteStatsUpdate(0, 0, 0, 1);
        } else {
            # Nothing special
            $u = false;
        }
        if ($u) {
            $u->doUpdate();
        }

        global $wgUser;
        wfRunHooks('TitleMoveComplete', array( &$this, &$nt, &$wgUser, $pageid, $redirid ));
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

moveToNewTitle()

Title::moveToNewTitle ( &  $nt,   $reason = ''  )

private

Move page to non-existing title.

Parameters

Title

&$nt

the new Title

Definition at line 2120 of file Title.php.

References $comment, $log, ILIAS\LTI\ToolProvider\$reason, ILIAS\Repository\get(), getArticleID(), getPrefixedDBkey(), getPrefixedText(), and purgeSquid().

    {
        global $wgUseSquid;
        $fname = 'MovePageForm::moveToNewTitle';
        $comment = wfMsgForContent('1movedto2', $this->getPrefixedText(), $nt->getPrefixedText());
        if ($reason) {
            $comment .= ": $reason";
        }

        $newid = $nt->getArticleID();
        $oldid = $this->getArticleID();
        $dbw = wfGetDB(DB_MASTER);
        $now = $dbw->timestamp();
        $linkCache = &LinkCache::singleton();

        # Save a null revision in the page's history notifying of the move
        $nullRevision = Revision::newNullRevision($dbw, $oldid, $comment, true);
        $nullRevId = $nullRevision->insertOn($dbw);

        # Rename cur entry
        $dbw->update(
            'page',
            /* SET */
            array(
                'page_touched' => $now,
                'page_namespace' => $nt->getNamespace(),
                'page_title' => $nt->getDBkey(),
                'page_latest' => $nullRevId,
            ),
            /* WHERE */
            array( 'page_id' => $oldid ),
            $fname
        );

        $linkCache->clearLink($nt->getPrefixedDBkey());

        # Insert redirect
        $mwRedir = MagicWord::get('redirect');
        $redirectText = $mwRedir->getSynonym(0) . ' [[' . $nt->getPrefixedText() . "]]\n";
        $redirectArticle = new Article($this);
        $newid = $redirectArticle->insertOn($dbw);
        $redirectRevision = new Revision(array(
            'page' => $newid,
            'comment' => $comment,
            'text' => $redirectText ));
        $redirectRevision->insertOn($dbw);
        $redirectArticle->updateRevisionOn($dbw, $redirectRevision, 0);
        $linkCache->clearLink($this->getPrefixedDBkey());

        # Log the move
        $log = new LogPage('move');
        $log->addEntry('move', $this, $reason, array( 1 => $nt->getPrefixedText()));

        # Purge caches as per article creation
        Article::onArticleCreate($nt);

        # Record the just-created redirect's linking to the page
        $dbw->insert(
            'pagelinks',
            array(
                'pl_from' => $newid,
                'pl_namespace' => $nt->getNamespace(),
                'pl_title' => $nt->getDBkey() ),
            $fname
        );

        # Purge old title from squid
        # The new title, and links to the new title, are purged in Article::onArticleCreate()
        $this->purgeSquid();
    }

Here is the call graph for this function:

nameOf()

Title::nameOf (   $id )

static

Get the prefixed DB key associated with an ID.

Parameters

int

$id

the page_id of the article

Returns

Title an object representing the article, or NULL if no such article was found public

Definition at line 298 of file Title.php.

References $id, and makeName().

    {
        $fname = 'Title::nameOf';
        $dbr = wfGetDB(DB_SLAVE);

        $s = $dbr->selectRow('page', array( 'page_namespace','page_title' ), array( 'page_id' => $id ), $fname);
        if ($s === false) {
            return null;
        }

        $n = Title::makeName($s->page_namespace, $s->page_title);
        return $n;
    }

Here is the call graph for this function:

newFromDBkey()

static Title::newFromDBkey (   $key )

static

Create a new Title from a prefixed DB key.

Parameters

string

$key

The database key, which has underscores instead of spaces, possibly including namespace and interwiki prefixes

Returns

Title the new object, or NULL on an error

Definition at line 92 of file Title.php.

References ILIAS\LTI\ToolProvider\$key.

    {
        $t = new Title();
        $t->mDbkeyform = $key;
        if ($t->secureAndSplit()) {
            return $t;
        } else {
            return null;
        }
    }

newFromID()

static Title::newFromID (   $id )

static

Create a new Title from an article ID.

Todo:

This is inefficiently implemented, the page row is requested but not used for anything else

Parameters

int

$id

the page_id corresponding to the Title to create

Returns

Title the new object, or NULL on an error

Definition at line 194 of file Title.php.

References $id, and makeTitle().

    {
        $fname = 'Title::newFromID';
        $dbr = wfGetDB(DB_SLAVE);
        $row = $dbr->selectRow(
            'page',
            array( 'page_namespace', 'page_title' ),
            array( 'page_id' => $id ),
            $fname
        );
        if ($row !== false) {
            $title = Title::makeTitle($row->page_namespace, $row->page_title);
        } else {
            $title = null;
        }
        return $title;
    }

Here is the call graph for this function:

newFromIDs()

static Title::newFromIDs (   $ids )

static

Make an array of titles from an array of IDs.

Definition at line 215 of file Title.php.

References $res, and makeTitle().

    {
        $dbr = wfGetDB(DB_SLAVE);
        $res = $dbr->select(
            'page',
            array( 'page_namespace', 'page_title' ),
            'page_id IN (' . $dbr->makeList($ids) . ')',
            __METHOD__
        );

        $titles = array();
        while ($row = $dbr->fetchObject($res)) {
            $titles[] = Title::makeTitle($row->page_namespace, $row->page_title);
        }
        return $titles;
    }

Here is the call 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 114 of file Title.php.

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

Referenced by getParentCategoryTree(), isValidMoveTarget(), newMainPage(), and ilWikiUtil\processInternalLinks().

    {
        if (is_object($text)) {
            throw new MWException('Title::newFromText given an object');
        }

        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:

newFromURL()

static Title::newFromURL (   $url )

static

Create a new Title from URL-encoded text.

Ensures that the given title's length does not exceed the maximum.

Parameters

string

$url

the title, as might be taken from a URL

Returns

Title the new object, or NULL on an error

Definition at line 165 of file Title.php.

References $url.

    {
        global $wgLegalTitleChars;
        $t = new Title();

        # For compatibility with old buggy URLs. "+" is usually not valid in titles,
        # but some URLs used it as a space replacement and they still come
        # from some external search tools.
        if (strpos($wgLegalTitleChars, '+') === false) {
            $url = str_replace('+', ' ', $url);
        }

        $t->mDbkeyform = str_replace(' ', '_', $url);
        if ($t->secureAndSplit()) {
            return $t;
        } else {
            return null;
        }
    }

newMainPage()

static Title::newMainPage ( )

static

Create a new Title for the Main Page.

Returns

Title the new object

Definition at line 280 of file Title.php.

References newFromText().

    {
        return Title::newFromText(wfMsgForContent('mainpage'));
    }

Here is the call graph for this function:

pageCond()

Title::pageCond

(

)

Get an associative array for selecting this title from the "page" table.

Returns

array

Definition at line 2321 of file Title.php.

    {
        return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
    }

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 1521 of file Title.php.

References $name, and getNsText().

Referenced by getPrefixedDBkey(), getPrefixedText(), and getPrefixedURL().

    {
        $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:

Here is the caller graph for this function:

purgeExpiredRestrictions()

static Title::purgeExpiredRestrictions ( )

static

Purge expired restrictions from the page_restrictions table.

Definition at line 1366 of file Title.php.

Referenced by loadRestrictionsFromRow().

    {
        $dbw = wfGetDB(DB_MASTER);
        $dbw->delete(
            'page_restrictions',
            array( 'pr_expiry < ' . $dbw->addQuotes($dbw->timestamp()) ),
            __METHOD__
        );
    }

Here is the caller graph for this function:

purgeSquid()

Title::purgeSquid

(

)

Definition at line 1885 of file Title.php.

References getSquidURLs().

Referenced by moveToNewTitle().

    {
        global $wgUseSquid;
        if ($wgUseSquid) {
            $urls = $this->getSquidURLs();
            $u = new SquidUpdate($urls);
            $u->doUpdate();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

quickUserCan()

Title::quickUserCan

(

$action

)

Can $wgUser perform $action on this page? This skips potentially expensive cascading permission checks.

Suitable for use for nonessential UI controls in common cases, but not for functional access control. May provide false positives, but should never provide a false negative.

Parameters

string

$action

action that permission needs to be checked for

Returns

bool

Definition at line 1018 of file Title.php.

References userCan().

    {
        return $this->userCan($action, false);
    }

Here is the call graph for this function:

resetArticleID()

Title::resetArticleID

(

$newid

)

This clears some fields in this object, and clears any associated keys in the "bad links" section of the link cache.

• This is called from Article::insertNewArticle() to allow loading of the new page_id. It's also called from Article::doDeleteArticle()

Parameters

int

$newid

the new Article ID

Definition at line 1466 of file Title.php.

References getPrefixedDBkey().

    {
        $linkCache = &LinkCache::singleton();
        $linkCache->clearBadLink($this->getPrefixedDBkey());

        if (0 == $newid) {
            $this->mArticleID = -1;
        } else {
            $this->mArticleID = $newid;
        }
        $this->mRestrictionsLoaded = false;
        $this->mRestrictions = array();
    }

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 1543 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 1734 of file Title.php.

Referenced by secureAndSplit().

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

Here is the caller graph for this function:

touchLinks()

Title::touchLinks

(

)

Update page_touched timestamps and send squid 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 2416 of file Title.php.

References getNamespace().

    {
        $u = new HTMLCacheUpdate($this, 'pagelinks');
        $u->doUpdate();

        if ($this->getNamespace() == NS_CATEGORY) {
            $u = new HTMLCacheUpdate($this, 'categorylinks');
            $u->doUpdate();
        }
    }

Here is the call graph for this function:

trackbackRDF()

Title::trackbackRDF

(

)

Definition at line 2453 of file Title.php.

References $url, getFullURL(), getText(), and trackbackURL().

    {
        $url = htmlspecialchars($this->getFullURL());
        $title = htmlspecialchars($this->getText());
        $tburl = $this->trackbackURL();

        return "
<rdf:RDF xmlns:rdf=\"http://www.w3.org/1999/02/22-rdf-syntax-ns#\"
         xmlns:dc=\"http://purl.org/dc/elements/1.1/\"
         xmlns:trackback=\"http://madskills.com/public/xml/rss/module/trackback/\">
<rdf:Description
   rdf:about=\"$url\"
   dc:identifier=\"$url\"
   dc:title=\"$title\"
   trackback:ping=\"$tburl\" />
</rdf:RDF>";
    }

Here is the call graph for this function:

trackbackURL()

Title::trackbackURL

(

)

Definition at line 2445 of file Title.php.

Referenced by trackbackRDF().

    {
        global $wgTitle, $wgScriptPath, $wgServer;

        return "$wgServer$wgScriptPath/trackback.php?article="
            . htmlspecialchars(urlencode($wgTitle->getPrefixedDBkey()));
    }

Here is the caller graph for this function:

userCan()

Title::userCan	(		$action,
			$doExpensiveQueries = true
	)

Can $wgUser perform $action on this page?

Parameters

string	$action	action that permission needs to be checked for
bool	$doExpensiveQueries	Set this to false to avoid doing unnecessary queries.

Returns

bool

Definition at line 1029 of file Title.php.

References $mNamespace, getRestrictions(), and NS_SPECIAL.

Referenced by isValidMoveOperation(), quickUserCan(), userCanCreate(), userCanEdit(), and userCanMove().

    {
        $fname = 'Title::userCan';
        wfProfileIn($fname);

        global $wgUser, $wgNamespaceProtection;

        $result = null;
        wfRunHooks('userCan', array( &$this, &$wgUser, $action, &$result ));
        if ($result !== null) {
            wfProfileOut($fname);
            return $result;
        }

        if (NS_SPECIAL == $this->mNamespace) {
            wfProfileOut($fname);
            return false;
        }

        if (array_key_exists($this->mNamespace, $wgNamespaceProtection)) {
            $nsProt = $wgNamespaceProtection[ $this->mNamespace ];
            if (!is_array($nsProt)) {
                $nsProt = array($nsProt);
            }
            foreach ($nsProt as $right) {
                if ('' != $right && !$wgUser->isAllowed($right)) {
                    wfProfileOut($fname);
                    return false;
                }
            }
        }

        if ($this->mDbkeyform == '_') {
            # FIXME: Is this necessary? Shouldn't be allowed anyway...
            wfProfileOut($fname);
            return false;
        }

        # protect css/js subpages of user pages
        # XXX: this might be better using restrictions
        # XXX: Find a way to work around the php bug that prevents using $this->userCanEditCssJsSubpage() from working
        if ($this->isCssJsSubpage()
            && !$wgUser->isAllowed('editinterface')
            && !preg_match('/^' . preg_quote($wgUser->getName(), '/') . '\//', $this->mTextform)) {
            wfProfileOut($fname);
            return false;
        }

        if ($doExpensiveQueries && !$this->isCssJsSubpage()) {
            # We /could/ use the protection level on the source page, but it's fairly ugly
            #  as we have to establish a precedence hierarchy for pages included by multiple
            #  cascade-protected pages. So just restrict it to people with 'protect' permission,
            #  as they could remove the protection anyway.
            list($cascadingSources, $restrictions) = $this->getCascadeProtectionSources();
            # Cascading protection depends on more than this page...
            # Several cascading protected pages may include this page...
            # Check each cascading level
            # This is only for protection restrictions, not for all actions
            if ($cascadingSources > 0 && isset($restrictions[$action])) {
                foreach ($restrictions[$action] as $right) {
                    $right = ($right == 'sysop') ? 'protect' : $right;
                    if ('' != $right && !$wgUser->isAllowed($right)) {
                        wfProfileOut($fname);
                        return false;
                    }
                }
            }
        }

        foreach ($this->getRestrictions($action) as $right) {
            // Backwards compatibility, rewrite sysop -> protect
            if ($right == 'sysop') {
                $right = 'protect';
            }
            if ('' != $right && !$wgUser->isAllowed($right)) {
                wfProfileOut($fname);
                return false;
            }
        }

        if ($action == 'move' &&
            !($this->isMovable() && $wgUser->isAllowed('move'))) {
            wfProfileOut($fname);
            return false;
        }

        if ($action == 'create') {
            if (($this->isTalkPage() && !$wgUser->isAllowed('createtalk')) ||
                (!$this->isTalkPage() && !$wgUser->isAllowed('createpage'))) {
                wfProfileOut($fname);
                return false;
            }
        }

        wfProfileOut($fname);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userCanCreate()

Title::userCanCreate

(

$doExpensiveQueries = true

)

Can $wgUser create this page?

Returns

bool

Deprecated:

use userCan('create')

Definition at line 1142 of file Title.php.

References userCan().

    {
        return $this->userCan('create', $doExpensiveQueries);
    }

Here is the call graph for this function:

userCanEdit()

Title::userCanEdit

(

$doExpensiveQueries = true

)

Can $wgUser edit this page?

Returns

bool

Deprecated:

use userCan('edit')

Definition at line 1132 of file Title.php.

References userCan().

    {
        return $this->userCan('edit', $doExpensiveQueries);
    }

Here is the call graph for this function:

userCanEditCssJsSubpage()

Title::userCanEditCssJsSubpage

(

)

Protect css/js subpages of user pages: can $wgUser edit this page?

Returns

bool

Todo:

XXX: this might be better using restrictions

Definition at line 1266 of file Title.php.

    {
        global $wgUser;
        return ($wgUser->isAllowed('editinterface') or preg_match('/^' . preg_quote($wgUser->getName(), '/') . '\//', $this->mTextform));
    }

userCanMove()

Title::userCanMove

(

$doExpensiveQueries = true

)

Can $wgUser move this page?

Returns

bool

Deprecated:

use userCan('move')

Definition at line 1152 of file Title.php.

References userCan().

    {
        return $this->userCan('move', $doExpensiveQueries);
    }

Here is the call graph for this function:

userCanRead()

Title::userCanRead

(

)

Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable.

Returns

bool Can $wgUser read this page?

bool

Todo:

fold these checks into userCan()

Always grant access to the login page. Even anons need to be able to log in.

some pages are explicitly allowed

Definition at line 1173 of file Title.php.

References $name, getNamespace(), getPrefixedText(), isSpecial(), and NS_MAIN.

    {
        global $wgUser;

        $result = null;
        wfRunHooks('userCan', array( &$this, &$wgUser, 'read', &$result ));
        if ($result !== null) {
            return $result;
        }

        if ($wgUser->isAllowed('read')) {
            return true;
        } else {
            global $wgWhitelistRead;

            if ($this->isSpecial('Userlogin') || $this->isSpecial('Resetpass')) {
                return true;
            }

            $name = $this->getPrefixedText();
            if ($wgWhitelistRead && in_array($name, $wgWhitelistRead)) {
                return true;
            }

            # Compatibility with old settings
            if ($wgWhitelistRead && $this->getNamespace() == NS_MAIN) {
                if (in_array(':' . $name, $wgWhitelistRead)) {
                    return true;
                }
            }
        }
        return false;
    }

Here is the call graph for this function:

userIsWatching()

Title::userIsWatching

(

)

Is $wgUser is watching this page?

Returns

bool

Definition at line 995 of file Title.php.

References $mWatched, and NS_SPECIAL.

    {
        global $wgUser;

        if (is_null($this->mWatched)) {
            if (NS_SPECIAL == $this->mNamespace || !$wgUser->isLoggedIn()) {
                $this->mWatched = false;
            } else {
                $this->mWatched = $wgUser->isWatched($this);
            }
        }
        return $this->mWatched;
    }

Field Documentation

$interwikiCache

Title::$interwikiCache = array()

staticprivate

Definition at line 32 of file Title.php.

Referenced by getInterwikiCached(), getInterwikiLink(), isLocal(), and isTrans().

$mArticleID

Title::$mArticleID

Definition at line 50 of file Title.php.

Referenced by getArticleID().

$mCascadeRestriction

Title::$mCascadeRestriction

Definition at line 53 of file Title.php.

Referenced by areRestrictionsCascading().

$mCascadeRestrictionSources

Title::$mCascadeRestrictionSources

Definition at line 56 of file Title.php.

$mDbkeyform

Title::$mDbkeyform

Definition at line 46 of file Title.php.

Referenced by getDBkey(), isAlwaysKnown(), and secureAndSplit().

$mDefaultNamespace

Title::$mDefaultNamespace

Definition at line 59 of file Title.php.

Referenced by getDefaultNamespace(), and secureAndSplit().

$mFragment

Title::$mFragment

Definition at line 49 of file Title.php.

Referenced by getFragment(), and getFullText().

$mHasCascadingRestrictions

Title::$mHasCascadingRestrictions

Definition at line 55 of file Title.php.

$mInterwiki

Title::$mInterwiki

Definition at line 48 of file Title.php.

Referenced by getInterwiki().

$mLatestID

Title::$mLatestID

Definition at line 51 of file Title.php.

Referenced by getLatestRevID().

$mNamespace

Title::$mNamespace

Definition at line 47 of file Title.php.

Referenced by getNamespace(), getNsText(), and userCan().

$mPrefixedText

Title::$mPrefixedText

Definition at line 58 of file Title.php.

Referenced by getPrefixedText().

$mRestrictions

Title::$mRestrictions

Definition at line 52 of file Title.php.

$mRestrictionsExpiry

Title::$mRestrictionsExpiry

Definition at line 54 of file Title.php.

$mRestrictionsLoaded

Title::$mRestrictionsLoaded

Definition at line 57 of file Title.php.

$mTextform

Title::$mTextform

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

#+

Definition at line 44 of file Title.php.

Referenced by getText().

$mUrlform

Title::$mUrlform

Definition at line 45 of file Title.php.

Referenced by getPartialURL().

$mWatched

Title::$mWatched

Definition at line 61 of file Title.php.

Referenced by userIsWatching().

$titleCache

Title::$titleCache = array()

staticprivate

Static cache variables.

Definition at line 31 of file Title.php.

Referenced by newFromText().

---

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

• Modules/Wiki/mediawiki/Title.php