ILIAS  Release_4_1_x_branch Revision 61804
 All Data Structures Namespaces Files Functions Variables Groups Pages
Public Member Functions | Static Public Member Functions | Data Fields | Private Member Functions | Private Attributes | Static Private Attributes
Title Class Reference

Title class. More...

+ Collaboration diagram for Title:

Public Member Functions

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

Static Public Member Functions

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

Data Fields

 $mUrlform
 $mDbkeyform
 $mNamespace
 $mInterwiki
 $mFragment
 $mArticleID
 $mLatestID
 $mRestrictions
 $mCascadeRestriction
 $mRestrictionsExpiry
 $mHasCascadingRestrictions
 $mCascadeRestrictionSources
 $mRestrictionsLoaded
 $mPrefixedText
 $mDefaultNamespace
 $mWatched

Private Member Functions

 __construct ()
 #@-
 loadRestrictionsFromRow ($res, $oldFashionedRestrictions=NULL)
 Loads a string into mRestrictions array.
 prefix ($name)
 Prefix some arbitrary text with the namespace or interwiki prefix of this object.
 secureAndSplit ()
 Secure and split - main initialisation function for this object.
 moveOverExistingRedirect (&$nt, $reason= '')
 Move page to a title which is at present a redirect to the source page.
 moveToNewTitle (&$nt, $reason= '')
 Move page to non-existing title.

Private Attributes

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

Static Private Attributes

static $titleCache = array()
 Static cache variables.
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 30 of file Title.php.

Constructor & Destructor Documentation

Title::__construct ( )
private

#@-

Constructor

Definition at line 72 of file Title.php.

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

Title::areRestrictionsCascading ( )

Definition at line 1359 of file Title.php.

References $mCascadeRestriction, and loadRestrictions().

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

+ Here is the call graph for this function:

Title::countRevisionsBetween (   $old,
  $new 
)

Get the number of revisions between the given revision IDs.

Parameters
integer$oldRevision ID.
integer$newRevision ID.
Returns
integer Number of revisions between these IDs.

Definition at line 2383 of file Title.php.

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

Compare with another title.

Parameters
Title$title
Returns
bool

Definition at line 2397 of file Title.php.

References $title, 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:

static Title::escapeFragmentForURL (   $fragment)
static

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

Definition at line 509 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:

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$queryan optional query string

Definition at line 857 of file Title.php.

References $query, and getFullURL().

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

+ Here is the call graph for this function:

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$queryan optional query string
Returns
string the URL

Definition at line 846 of file Title.php.

References $query, and getLocalURL().

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

+ Here is the call graph for this function:

Title::exists ( )

Check if page exists.

Returns
bool

Definition at line 2408 of file Title.php.

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

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

+ Here is the caller graph for this function:

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

References getNamespace(), and makeTitle().

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

Title::getArticleID (   $flags = 0)

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

Parameters
int$flagsa bit field; may be GAID_FOR_UPDATE to select for update
Returns
int the ID

Definition at line 1501 of file Title.php.

References $mArticleID, and GAID_FOR_UPDATE.

Referenced by getLatestRevID(), isValidMoveOperation(), 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:

Title::getBaseText ( )

Get the base name, i.e.

the leftmost parts before the /

Returns
string Base name

Definition at line 669 of file Title.php.

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

Title::getBrokenLinksFrom (   $options = '')

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

Parameters
string$optionsmay be FOR UPDATE
Returns
array the Title objects

Definition at line 1879 of file Title.php.

References $res, $row, 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:

Title::getCascadeProtectionSources (   $get_pages = true)

Cascading protection: Get the source of any cascading restrictions on this page.

Parameters
$get_pagesbool Whether or not to retrieve the actual pages that the restrictions have come from.
Returns
array( mixed title array, restriction array) Array of the Title objects of the pages from which cascading restrictions have come, false for none, or true if such restrictions exist, but $get_pages was not set. The restriction array is an array of each type, each of which contains an array of unique groups

Definition at line 1272 of file Title.php.

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

Referenced by isCascadeProtected(), and userCan().

{
global $wgEnableCascadingProtection, $wgRestrictionTypes;
# Define our dimension of restrictions types
$pagerestrictions = array();
foreach( $wgRestrictionTypes as $action )
$pagerestrictions[$action] = array();
if (!$wgEnableCascadingProtection)
return array( false, $pagerestrictions );
if ( isset( $this->mCascadeSources ) && $get_pages ) {
return array( $this->mCascadeSources, $this->mCascadingRestrictions );
} else if ( isset( $this->mHasCascadingRestrictions ) && !$get_pages ) {
return array( $this->mHasCascadingRestrictions, $pagerestrictions );
}
wfProfileIn( __METHOD__ );
$dbr = wfGetDb( DB_SLAVE );
if ( $this->getNamespace() == NS_IMAGE ) {
$tables = array ('imagelinks', 'page_restrictions');
$where_clauses = array(
'il_to' => $this->getDBkey(),
'il_from=pr_page',
'pr_cascade' => 1 );
} else {
$tables = array ('templatelinks', 'page_restrictions');
$where_clauses = array(
'tl_namespace' => $this->getNamespace(),
'tl_title' => $this->getDBkey(),
'tl_from=pr_page',
'pr_cascade' => 1 );
}
if ( $get_pages ) {
$cols = array('pr_page', 'page_namespace', 'page_title', 'pr_expiry', 'pr_type', 'pr_level' );
$where_clauses[] = 'page_id=pr_page';
$tables[] = 'page';
} else {
$cols = array( 'pr_expiry' );
}
$res = $dbr->select( $tables, $cols, $where_clauses, __METHOD__ );
$sources = $get_pages ? array() : false;
$now = wfTimestampNow();
$purgeExpired = false;
while( $row = $dbr->fetchObject( $res ) ) {
$expiry = Block::decodeExpiry( $row->pr_expiry );
if( $expiry > $now ) {
if ($get_pages) {
$page_id = $row->pr_page;
$page_ns = $row->page_namespace;
$page_title = $row->page_title;
$sources[$page_id] = Title::makeTitle($page_ns, $page_title);
# Add groups needed for each restriction type if its not already there
# Make sure this restriction type still exists
if ( isset($pagerestrictions[$row->pr_type]) && !in_array($row->pr_level, $pagerestrictions[$row->pr_type]) ) {
$pagerestrictions[$row->pr_type][]=$row->pr_level;
}
} else {
$sources = true;
}
} else {
// Trigger lazy purge of expired restrictions from the db
$purgeExpired = true;
}
}
if( $purgeExpired ) {
Title::purgeExpiredRestrictions();
}
wfProfileOut( __METHOD__ );
if ( $get_pages ) {
$this->mCascadeSources = $sources;
$this->mCascadingRestrictions = $pagerestrictions;
} else {
$this->mHasCascadingRestrictions = $sources;
}
return array( $sources, $pagerestrictions );
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Title::getDBkey ( )

Get the main part with underscores.

Returns
string

Definition at line 538 of file Title.php.

References $mDbkeyform.

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

{ return $this->mDbkeyform; }

+ Here is the caller graph for this function:

Title::getDefaultNamespace ( )

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

Returns
int

Definition at line 615 of file Title.php.

References $mDefaultNamespace.

{ return $this->mDefaultNamespace; }
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 882 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:

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

References getPrefixedText().

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

+ Here is the call graph for this function:

Title::getFragment ( )

Get the Title fragment (i.e.

the bit after the #) in text form

Returns
string

Definition at line 599 of file Title.php.

References $mFragment.

{ return $this->mFragment; }
Title::getFragmentForURL ( )

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

Returns
string

Definition at line 604 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:

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

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

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

Parameters
string$queryan optional query string, not used for interwiki links
string$variantlanguage variant of url (for sr, zh..)
Returns
string the URL

Definition at line 733 of file Title.php.

References $namespace, $query, getFragmentForURL(), getInterwikiLink(), 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:

Title::getIndexTitle ( )

Get title for search index.

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

Definition at line 622 of file Title.php.

References indexTitle().

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

+ Here is the call graph for this function:

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$queryan optional query string
string$variantlanguage variant of url (for sr, zh..)
Returns
string the URL

Definition at line 870 of file Title.php.

References $query, 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:

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

References $mInterwiki.

Referenced by equals().

{ return $this->mInterwiki; }

+ Here is the caller graph for this function:

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

References $interwikiCache.

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 caller graph for this function:

Title::getInterwikiLink (   $key)
static

Returns the URL associated with an interwiki prefix.

Parameters
string$keythe interwiki prefix (e.g. "MeatBall")
Returns
the associated URL, containing "$1", which should be replaced by an article title (arguably)

Definition at line 383 of file Title.php.

References $interwikiCache, $res, and getInterwikiCached().

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:

Title::getLatestRevID ( )

Definition at line 1515 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:

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$optionsmay be FOR UPDATE
Returns
array the Title objects linking here

Definition at line 1828 of file Title.php.

References $res, $row, 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:

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$queryan optional query string; if not specified, $wgArticlePath will be used.
string$variantlanguage variant of url (for sr, zh..)
Returns
string the URL

Definition at line 772 of file Title.php.

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

Referenced by escapeLocalURL(), getEditURL(), 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:

Title::getNamespace ( )

Get the namespace index, i.e.

one of the NS_xxxx constants

Returns
int

Definition at line 543 of file Title.php.

References $mNamespace.

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

{ return $this->mNamespace; }

+ Here is the caller graph for this function:

Title::getNamespaceKey ( )

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

Returns
string

Definition at line 2480 of file Title.php.

References getNamespace().

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

Title::getNextRevisionID (   $revision)

Get the revision ID of the next revision.

Parameters
integer$revisionRevision ID. Get the revision that was after this one.
Returns
integer $oldrevision|false

Definition at line 2369 of file Title.php.

References $revision.

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

Get the namespace text.

Returns
string

Definition at line 548 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:

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

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

Referenced by getParentCategoryTree().

{
global $wgContLang;
$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:

Title::getParentCategoryTree (   $children = array())

Get a tree of parent categories.

Parameters
array$childrenan array with the children in the keys, to check for circular refs
Returns
array

Definition at line 2318 of file Title.php.

References getParentCategories(), and newFromText().

{
$parents = $this->getParentCategories();
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:

Title::getPartialURL ( )

Get the URL-encoded form of the main part.

Returns
string

Definition at line 533 of file Title.php.

References $mUrlform.

{ return $this->mUrlform; }
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:

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

Title::getPrefixedURL ( )

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

Returns
string the URL-encoded form

Definition at line 711 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:

Title::getPreviousRevisionID (   $revision)

Get the revision ID of the previous revision.

Parameters
integer$revisionRevision ID. Get the revision that was before this one.
Returns
integer $oldrevision|false

Definition at line 2356 of file Title.php.

References $revision.

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

Accessor/initialisation for mRestrictions.

Parameters
string$actionaction that permission needs to be checked for
Returns
array the array of groups allowed to edit this article

Definition at line 1461 of file Title.php.

References exists(), and loadRestrictions().

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

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

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Title::getSkinFromCssJsSubpage ( )

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

Definition at line 1223 of file Title.php.

Referenced by isValidCssJsSubpage().

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

+ Here is the caller graph for this function:

Title::getSquidURLs ( )

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

Returns
array the URLs

Definition at line 1917 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:

Title::getSubpageText ( )

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

the rightmost part after /

Returns
string Subpage name

Definition at line 686 of file Title.php.

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:

Title::getSubpageUrlForm ( )

Get a URL-encoded form of the subpage text.

Returns
string URL-encoded subpage name

Definition at line 700 of file Title.php.

References getSubpageText().

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

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$optionsmay be FOR UPDATE
Returns
array the Title objects linking here

Definition at line 1869 of file Title.php.

References getLinksTo().

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

+ Here is the call graph for this function:

Title::getText ( )

Simple accessors.

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

Returns
string

Definition at line 528 of file Title.php.

References $mTextform.

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

{ return $this->mTextform; }

+ Here is the caller graph for this function:

Title::getTouched ( )

Get the last touched timestamp.

Definition at line 2441 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:

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

Get a string representation of a title suitable for including in a search index.

Parameters
int$nsa namespace index
string$titletext-form main part
Returns
string a stripped-down title string ready for the search index

Definition at line 343 of file Title.php.

References $t, and $title.

Referenced by getIndexTitle().

{
global $wgContLang;
$lc = SearchEngine::legalSearchChars() . '&#;';
$t = $wgContLang->stripForSearch( $title );
$t = preg_replace( "/[^{$lc}]+/", ' ', $t );
$t = $wgContLang->lc( $t );
# Handle 's, s'
$t = preg_replace( "/([{$lc}]+)'s( |$)/", "\\1 \\1's ", $t );
$t = preg_replace( "/([{$lc}]+)s'( |$)/", "\\1s ", $t );
$t = preg_replace( "/\\s+/", ' ', $t );
if ( $ns == NS_IMAGE ) {
$t = preg_replace( "/ (png|gif|jpg|jpeg|ogg)$/", "", $t );
}
return trim( $t );
}

+ Here is the caller graph for this function:

Title::invalidateCache ( )

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

Returns
bool true if the update succeded

Definition at line 1550 of file Title.php.

References $success, 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:

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

References $mDbkeyform, and isExternal().

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

+ Here is the call graph for this function:

Title::isCascadeProtected ( )

Cascading protection: Return true if cascading restrictions apply to this page, false if not.

Returns
bool If the page is subject to cascading restrictions.

Definition at line 1259 of file Title.php.

References getCascadeProtectionSources().

{
list( $sources, $restrictions ) = $this->getCascadeProtectionSources( false );
return ( $sources > 0 );
}

+ Here is the call graph for this function:

Title::isCssJsSubpage ( )

Is this a .css or .js subpage of a user page?

Returns
bool

Definition at line 1205 of file Title.php.

Referenced by isValidCssJsSubpage(), and userCan().

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

+ Here is the caller graph for this function:

Title::isCssSubpage ( )

Is this a .css subpage of a user page?

Returns
bool

Definition at line 1232 of file Title.php.

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

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

Returns
int the number of archived revisions

Definition at line 1478 of file Title.php.

References $n, 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:

Title::isExternal ( )

Is this Title interwiki?

Returns
boolean

Definition at line 902 of file Title.php.

Referenced by getLocalURL(), and isAlwaysKnown().

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

+ Here is the caller graph for this function:

Title::isJsSubpage ( )

Is this a .js subpage of a user page?

Returns
bool

Definition at line 1239 of file Title.php.

{
return ( NS_USER == $this->mNamespace and preg_match("/\\/.*\\.js$/", $this->mTextform ) );
}
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 480 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:

Title::isProtected (   $action = '')

Does the title correspond to a protected article?

Parameters
string$whatthe action the page is protected from, by default checks move and edit
Returns
boolean

Definition at line 935 of file Title.php.

References getNamespace(), and getRestrictions().

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

Title::isSemiProtected (   $action = 'edit')

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

Parameters
stringAction to check (default: edit)
Returns
bool

Definition at line 910 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:

Title::isSpecial (   $name)

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

Parameters
string$nameThe special page name

Definition at line 2520 of file Title.php.

References getDBkey(), and getNamespace().

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:

Title::isSubpage ( )

Is this a talk page of some sort?

Returns
bool Is this a subpage?
bool

Definition at line 1191 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:

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

Title::isValidCssJsSubpage ( )

Is this a valid .css or .js subpage of a user page? Check that the corresponding skin exists.

Definition at line 1212 of file Title.php.

References getSkinFromCssJsSubpage(), and isCssJsSubpage().

{
if ( $this->isCssJsSubpage() ) {
$skinNames = Skin::getSkinNames();
return array_key_exists( $this->getSkinFromCssJsSubpage(), $skinNames );
} else {
return false;
}
}

+ Here is the call graph for this function:

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&$ntthe new title
bool$authindicates 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, 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:

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&$ntthe new title to check

Definition at line 2231 of file Title.php.

References $row, 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:

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

Title::loadRestrictions (   $oldFashionedRestrictions = NULL)

Definition at line 1434 of file Title.php.

References $res, 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:

Title::loadRestrictionsFromRow (   $res,
  $oldFashionedRestrictions = NULL 
)
private

Loads a string into mRestrictions array.

Parameters
resource$resrestrictions as an SQL result.

Definition at line 1371 of file Title.php.

References $res, $row, 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:

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

Definition at line 369 of file Title.php.

References $n, and $title.

Referenced by makeTitleSafe(), and nameOf().

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

+ Here is the caller graph for this function:

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$nsthe namespace of the article
string$titlethe unprefixed database key form
Returns
Title the new object

Definition at line 231 of file Title.php.

References $t, and $title.

Referenced by fixSpecialName(), getBrokenLinksFrom(), getCascadeProtectionSources(), 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:

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$nsthe namespace of the article
string$titlethe database key form
Returns
Title the new object, or NULL on an error

Definition at line 252 of file Title.php.

References $t, $title, and 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:

Title::moveNoAuth ( &  $nt)

Move this page without authentication.

Parameters
Title&$ntthe new page Title

Definition at line 1950 of file Title.php.

References moveTo().

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

+ Here is the call graph for this function:

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

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

Parameters
Title&$ntthe page to move to, which should currently be a redirect

Definition at line 2083 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:

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

Move a title to a new location.

Parameters
Title&$ntthe new title
bool$authindicates whether $wgUser's permissions should be checked
Returns
mixed true on success, message name on failure

Definition at line 2011 of file Title.php.

References $auth, 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:

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

Move page to non-existing title.

Parameters
Title&$ntthe new Title

Definition at line 2160 of file Title.php.

References $comment, $log, 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:

Title::nameOf (   $id)
static

Get the prefixed DB key associated with an ID.

Parameters
int$idthe page_id of the article
Returns
Title an object representing the article, or NULL if no such article was found public

Definition at line 311 of file Title.php.

References $n, 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:

static Title::newFromDBkey (   $key)
static

Create a new Title from a prefixed DB key.

Parameters
string$keyThe 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 94 of file Title.php.

References $t.

{
$t = new Title();
$t->mDbkeyform = $key;
if( $t->secureAndSplit() )
return $t;
else
return NULL;
}
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$idthe page_id corresponding to the Title to create
Returns
Title the new object, or NULL on an error

Definition at line 192 of file Title.php.

References $row, $title, 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:

static Title::newFromIDs (   $ids)
static

Make an array of titles from an array of IDs.

Definition at line 208 of file Title.php.

References $res, $row, 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:

static Title::newFromRedirect (   $text)
static

Create a new Title for a redirect.

Parameters
string$textthe redirect title text
Returns
Title the new object, or NULL if the text is not a valid redirect

Definition at line 276 of file Title.php.

References newFromText().

{
$mwRedir = MagicWord::get( 'redirect' );
$rt = NULL;
if ( $mwRedir->matchStart( $text ) ) {
$m = array();
if ( preg_match( '/\[{2}(.*?)(?:\||\]{2})/', $text, $m ) ) {
# categories are escaped using : for example one can enter:
# #REDIRECT [[:Category:Music]]. Need to remove it.
if ( substr($m[1],0,1) == ':') {
# We don't want to keep the ':'
$m[1] = substr( $m[1], 1 );
}
$rt = Title::newFromText( $m[1] );
# Disallow redirects to Special:Userlogout
if ( !is_null($rt) && $rt->isSpecial( 'Userlogout' ) ) {
$rt = NULL;
}
}
}
return $rt;
}

+ Here is the call graph for this function:

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$textthe link text; spaces, prefixes, and an initial ':' indicating the main namespace are accepted
int$defaultNamespacethe 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 é &#257; or &#x3017; into real text...

Definition at line 114 of file Title.php.

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

Referenced by getParentCategoryTree(), isValidMoveTarget(), newFromRedirect(), 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:

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$urlthe title, as might be taken from a URL
Returns
Title the new object, or NULL on an error

Definition at line 164 of file Title.php.

References $t.

{
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;
}
}
static Title::newMainPage ( )
static

Create a new Title for the Main Page.

Returns
Title the new object

Definition at line 266 of file Title.php.

References newFromText().

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

+ Here is the call graph for this function:

Title::pageCond ( )

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

Returns
array

Definition at line 2346 of file Title.php.

{
return array( 'page_namespace' => $this->mNamespace, 'page_title' => $this->mDbkeyform );
}
Title::prefix (   $name)
private

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

Parameters
string$namethe text
Returns
string the prefixed text

Definition at line 1583 of file Title.php.

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

static Title::purgeExpiredRestrictions ( )
static

Purge expired restrictions from the page_restrictions table.

Definition at line 1448 of file Title.php.

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

Title::purgeSquid ( )

Definition at line 1937 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:

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$actionaction that permission needs to be checked for
Returns
boolean

Definition at line 993 of file Title.php.

References userCan().

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

+ Here is the call graph for this function:

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$newidthe new Article ID

Definition at line 1536 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:

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

References $mDbkeyform, $mDefaultNamespace, getInterwikiLink(), legalChars(), setFragment(), UTF8_REPLACEMENT, 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:

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$fragmenttext
Todo:
clarify whether access is supposed to be public (was marked as "kind of public")

Definition at line 1796 of file Title.php.

Referenced by secureAndSplit().

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

+ Here is the caller graph for this function:

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

Title::trackbackRDF ( )

Definition at line 2459 of file Title.php.

References $title, 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:

Title::trackbackURL ( )

Definition at line 2452 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:

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

Can $wgUser perform $action on this page?

Parameters
string$actionaction that permission needs to be checked for
bool$doExpensiveQueriesSet this to false to avoid doing unnecessary queries.
Returns
boolean

Definition at line 1003 of file Title.php.

References $mNamespace, $result, getCascadeProtectionSources(), getRestrictions(), and isCssJsSubpage().

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:

Title::userCanCreate (   $doExpensiveQueries = true)

Can $wgUser create this page?

Returns
boolean
Deprecated:
use userCan('create')

Definition at line 1112 of file Title.php.

References userCan().

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

+ Here is the call graph for this function:

Title::userCanEdit (   $doExpensiveQueries = true)

Can $wgUser edit this page?

Returns
boolean
Deprecated:
use userCan('edit')

Definition at line 1103 of file Title.php.

References userCan().

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

+ Here is the call graph for this function:

Title::userCanEditCssJsSubpage ( )

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

Returns
boolean
Todo:
XXX: this might be better using restrictions

Definition at line 1249 of file Title.php.

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

Can $wgUser move this page?

Returns
boolean
Deprecated:
use userCan('move')

Definition at line 1121 of file Title.php.

References userCan().

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

+ Here is the call graph for this function:

Title::userCanRead ( )

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

Returns
boolean Can $wgUser read this page?
boolean
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 1141 of file Title.php.

References $result, getNamespace(), getPrefixedText(), and isSpecial().

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

Title::userIsWatching ( )

Is $wgUser is watching this page?

Returns
boolean

Definition at line 968 of file Title.php.

References $mWatched.

{
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

Title::$interwikiCache = array()
staticprivate

Definition at line 35 of file Title.php.

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

Title::$mArticleID

Definition at line 53 of file Title.php.

Referenced by getArticleID().

Title::$mCascadeRestriction

Definition at line 56 of file Title.php.

Referenced by areRestrictionsCascading().

Title::$mCascadeRestrictionSources

Definition at line 59 of file Title.php.

Title::$mDbkeyform

Definition at line 49 of file Title.php.

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

Title::$mDefaultNamespace

Definition at line 62 of file Title.php.

Referenced by getDefaultNamespace(), and secureAndSplit().

Title::$mFragment

Definition at line 52 of file Title.php.

Referenced by getFragment(), and getFullText().

Title::$mHasCascadingRestrictions

Definition at line 58 of file Title.php.

Title::$mInterwiki

Definition at line 51 of file Title.php.

Referenced by getInterwiki().

Title::$mLatestID

Definition at line 54 of file Title.php.

Referenced by getLatestRevID().

Title::$mNamespace

Definition at line 50 of file Title.php.

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

Title::$mPrefixedText

Definition at line 61 of file Title.php.

Referenced by getPrefixedText().

Title::$mRestrictions

Definition at line 55 of file Title.php.

Title::$mRestrictionsExpiry

Definition at line 57 of file Title.php.

Title::$mRestrictionsLoaded

Definition at line 60 of file Title.php.

Title::$mTextform
private

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

#@+

Definition at line 47 of file Title.php.

Referenced by getText().

Title::$mUrlform

Definition at line 48 of file Title.php.

Referenced by getPartialURL().

Title::$mWatched

Definition at line 64 of file Title.php.

Referenced by userIsWatching().

Title::$titleCache = array()
staticprivate

Static cache variables.

Definition at line 34 of file Title.php.

Referenced by newFromText().

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