FakeTitle Class Reference

Fake title class that triggers an error if any members are called. More...

Inherits Title.

List of all members.

Public Member Functions

 error ()
 __call ($name, $args)
 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. one of the NS_xxxx constants.
 getNsText ()
 Get the namespace text.
 getSubjectNsText ()
 Get the namespace text of the subject (rather than talk) page.
 getInterwiki ()
 Get the interwiki prefix (or null string).
 getFragment ()
 Get the Title fragment (i.e. the bit after the #) in text form.
 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 '#').
 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 watching this page?
 userCan ($action, $doExpensiveQueries=true)
 Can $wgUser perform $action on this page?
 userCanCreate ()
 userCanEdit ($doExpensiveQueries=true)
 Can $wgUser edit this page?
 userCanMove ()
 isMovable ()
 Would anybody with sufficient privileges be able to move this page? Some pages just aren't movable.
 userCanRead ()
 Can $wgUser read this page?
 isTalkPage ()
 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?
 loadRestrictions ($res)
 Load restrictions from the page_restrictions table.
 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.
 getTalkPage ()
 Get a Title object associated with the talk page of this article.
 getSubjectPage ()
 Get a title object associated with the subject page of this talk page.
 getLinksTo ()
 getTemplateLinksTo ()
 getBrokenLinksFrom ()
 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.
 moveNoAuth ()
 isValidMoveOperation ()
 moveTo ()
 moveOverExistingRedirect ()
 moveToNewTitle ()
 isValidMoveTarget ()
 getParentCategories ()
 Get categories to which this Title belongs and return an array of categories' names.
 getParentCategoryTree ()
 pageCond ()
 Get an associative array for selecting this title from the "page" table.
 getPreviousRevisionID ()
 getNextRevisionID ()
 equals ()
 exists ()
 Check if page exists.
 isAlwaysKnown ()
 Should links to this title be shown as potentially viewable (i.e.
 isKnown ()
 Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages).
 touchLinks ()
 Update page_touched timestamps and send squid purge messages for pages linking to this title.
 trackbackURL ()
 Get the trackback URL for this page.
 trackbackRDF ()
 Get the trackback RDF for this page.


Detailed Description

Fake title class that triggers an error if any members are called.

Definition at line 6 of file FakeTitle.php.


Member Function Documentation

FakeTitle::__call ( name,
args 
)

Definition at line 10 of file FakeTitle.php.

References error().

FakeTitle::equals (  ) 

Definition at line 77 of file FakeTitle.php.

References error().

FakeTitle::error (  ) 

FakeTitle::escapeFullURL ( query = ''  ) 

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

Parameters:
$query  String : : an optional query string
Returns:
String : : the URL

Reimplemented from Title.

Definition at line 32 of file FakeTitle.php.

References error().

FakeTitle::escapeLocalURL ( query = ''  ) 

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

Parameters:
$query  String : : an optional query string
Returns:
String : : the URL

Reimplemented from Title.

Definition at line 31 of file FakeTitle.php.

References error().

FakeTitle::exists (  ) 

Check if page exists.

For historical reasons, this function simply checks for the existence of the title in the page table, and will thus return false for interwiki links, special pages and the like. If you want to know if a title can be meaningfully viewed, you should probably call the isKnown() method instead.

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 78 of file FakeTitle.php.

References error().

FakeTitle::getArticleID ( flags = 0  ) 

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

Parameters:
$flags  Integer : : a bit field; may be GAID_FOR_UPDATE to select for update
Returns:
Integer : : the ID

Reimplemented from Title.

Definition at line 56 of file FakeTitle.php.

References error().

FakeTitle::getBrokenLinksFrom (  ) 

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

Todo:
check if needed (used only in SpecialBrokenRedirects.php, and should use redirect table in this case)
Returns:
{Title} : the Title objects

Reimplemented from Title.

Definition at line 64 of file FakeTitle.php.

References error().

FakeTitle::getDBkey (  ) 

Get the main part with underscores.

Returns:
{} Main part of the title, with underscores

Reimplemented from Title.

Definition at line 17 of file FakeTitle.php.

References error().

FakeTitle::getDefaultNamespace (  ) 

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

Returns:
Integer : : Default namespace index

Reimplemented from Title.

Definition at line 23 of file FakeTitle.php.

References error().

FakeTitle::getEditURL (  ) 

Get the edit URL for this Title.

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

Reimplemented from Title.

Definition at line 34 of file FakeTitle.php.

References error().

FakeTitle::getEscapedText (  ) 

Get the HTML-escaped displayable text form.

Used for the title field in tags.

Returns:
String : : the text, including any prefixes

Reimplemented from Title.

Definition at line 35 of file FakeTitle.php.

References error().

FakeTitle::getFragment (  ) 

Get the Title fragment (i.e. the bit after the #) in text form.

Returns:
String : : Title fragment

Reimplemented from Title.

Definition at line 22 of file FakeTitle.php.

References error().

FakeTitle::getFullText (  ) 

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

Returns:
String : : the prefixed title, with spaces and the fragment, including '#'

Reimplemented from Title.

Definition at line 27 of file FakeTitle.php.

References error().

FakeTitle::getFullURL ( query = '',
variant = false 
)

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

Parameters:
$query { String :,} an optional query string, not used for interwiki links. Can be specified as an associative array as well, e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
$variant  String : : language variant of url (for sr, zh..)
Returns:
String : : the URL

Reimplemented from Title.

Definition at line 29 of file FakeTitle.php.

References error().

FakeTitle::getIndexTitle (  ) 

Get title for search index.

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

Reimplemented from Title.

Definition at line 24 of file FakeTitle.php.

References error().

FakeTitle::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:
$query  String : : an optional query string
$variant  String : : language variant of url (for sr, zh..)
Returns:
String : : the URL

Reimplemented from Title.

Definition at line 33 of file FakeTitle.php.

References error().

FakeTitle::getInterwiki (  ) 

Get the interwiki prefix (or null string).

Returns:
String : : Interwiki prefix

Reimplemented from Title.

Definition at line 21 of file FakeTitle.php.

References error().

FakeTitle::getLatestRevID (  ) 

Definition at line 57 of file FakeTitle.php.

References error().

FakeTitle::getLinksTo (  ) 

Definition at line 62 of file FakeTitle.php.

References error().

FakeTitle::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:
mixed $query an optional query string; if not specified, $wgArticlePath will be used. Can be specified as an associative array as well, e.g., array( 'action' => 'edit' ) (keys and values will be URL-escaped).
$variant  String : : language variant of url (for sr, zh..)
Returns:
String : : the URL

Reimplemented from Title.

Definition at line 30 of file FakeTitle.php.

References error().

FakeTitle::getNamespace (  ) 

Get the namespace index, i.e. one of the NS_xxxx constants.

Returns:
{} Namespace index

Reimplemented from Title.

Definition at line 18 of file FakeTitle.php.

References error().

FakeTitle::getNextRevisionID (  ) 

Definition at line 76 of file FakeTitle.php.

References error().

FakeTitle::getNsText (  ) 

Get the namespace text.

Returns:
{} Namespace text

Reimplemented from Title.

Definition at line 19 of file FakeTitle.php.

References error().

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

Reimplemented from Title.

Definition at line 72 of file FakeTitle.php.

References error().

FakeTitle::getParentCategoryTree (  ) 

Definition at line 73 of file FakeTitle.php.

References error().

FakeTitle::getPartialURL (  ) 

Get the URL-encoded form of the main part.

Returns:
{} Main part of the title, URL-encoded

Reimplemented from Title.

Definition at line 16 of file FakeTitle.php.

References error().

FakeTitle::getPrefixedDBkey (  ) 

Get the prefixed database key form.

Returns:
String : : the prefixed title, with underscores and any interwiki and namespace prefixes

Reimplemented from Title.

Definition at line 25 of file FakeTitle.php.

References error().

FakeTitle::getPrefixedText (  ) 

Get the prefixed title with spaces.

This is the form usually used for display

Returns:
String : : the prefixed title, with spaces

Reimplemented from Title.

Definition at line 26 of file FakeTitle.php.

References error().

FakeTitle::getPrefixedURL (  ) 

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

Returns:
String : : the URL-encoded form

Reimplemented from Title.

Definition at line 28 of file FakeTitle.php.

References error().

FakeTitle::getPreviousRevisionID (  ) 

Definition at line 75 of file FakeTitle.php.

References error().

FakeTitle::getRestrictions ( action  ) 

Accessor/initialisation for mRestrictions.

Parameters:
$action  String : : action that permission needs to be checked for
Returns:
{ String :} : the array of groups allowed to edit this article

Reimplemented from Title.

Definition at line 54 of file FakeTitle.php.

References error().

FakeTitle::getSkinFromCssJsSubpage (  ) 

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

Reimplemented from Title.

Definition at line 49 of file FakeTitle.php.

References error().

FakeTitle::getSquidURLs (  ) 

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

Returns:
{ String :} : the URLs

Reimplemented from Title.

Definition at line 65 of file FakeTitle.php.

References error().

FakeTitle::getSubjectNsText (  ) 

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

Returns:
String : : Namespace text

Reimplemented from Title.

Definition at line 20 of file FakeTitle.php.

References error().

FakeTitle::getSubjectPage (  ) 

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

Returns:
Title : the object for the subject page

Reimplemented from Title.

Definition at line 61 of file FakeTitle.php.

References error().

FakeTitle::getTalkPage (  ) 

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

Returns:
Title : the object for the talk page

Reimplemented from Title.

Definition at line 60 of file FakeTitle.php.

References error().

FakeTitle::getTemplateLinksTo (  ) 

Definition at line 63 of file FakeTitle.php.

References error().

FakeTitle::getText (  ) 

Simple accessors.

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

Returns:
{} Main part of the title

Reimplemented from Title.

Definition at line 15 of file FakeTitle.php.

References error().

FakeTitle::invalidateCache (  ) 

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

Returns:
Boolean : : true if the update succeded

Reimplemented from Title.

Definition at line 59 of file FakeTitle.php.

References error().

FakeTitle::isAlwaysKnown (  ) 

Should links to this title be shown as potentially viewable (i.e.

as "bluelinks"), even if there's no record by this title in the page table?

This function is semi-deprecated for public use, as well as somewhat misleadingly named. You probably just want to call isKnown(), which calls this function internally.

(ISSUE: Most of these checks are cheap, but the file existence check can potentially be quite expensive. Including it here fixes a lot of existing code, but we might want to add an optional parameter to skip it and any other expensive checks.)

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 79 of file FakeTitle.php.

References error().

FakeTitle::isCssJsSubpage (  ) 

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

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 47 of file FakeTitle.php.

References error().

FakeTitle::isCssSubpage (  ) 

Is this a .css subpage of a user page?

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 50 of file FakeTitle.php.

References error().

FakeTitle::isDeleted (  ) 

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

Returns:
Integer : : the number of archived revisions

Reimplemented from Title.

Definition at line 55 of file FakeTitle.php.

References error().

FakeTitle::isExternal (  ) 

Is this Title interwiki?

Returns:
Boolean : :

Reimplemented from Title.

Definition at line 36 of file FakeTitle.php.

References error().

FakeTitle::isJsSubpage (  ) 

Is this a .js subpage of a user page?

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 51 of file FakeTitle.php.

References error().

FakeTitle::isKnown (  ) 

Does this title refer to a page that can (or might) be meaningfully viewed? In particular, this function may be used to determine if links to the title should be rendered as "bluelinks" (as opposed to "redlinks" to non-existent pages).

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 80 of file FakeTitle.php.

References error().

FakeTitle::isLocal (  ) 

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

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

Reimplemented from Title.

Definition at line 13 of file FakeTitle.php.

References error().

FakeTitle::isMovable (  ) 

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

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 44 of file FakeTitle.php.

References error().

FakeTitle::isProtected ( action = ''  ) 

Does the title correspond to a protected article?

Parameters:
$what  String : : the action the page is protected from, by default checks move and edit
Returns:
Boolean : :

Reimplemented from Title.

Definition at line 38 of file FakeTitle.php.

References error().

FakeTitle::isSemiProtected ( action = 'edit'  ) 

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

Parameters:
@action  String : : Action to check (default: edit)
Returns:
Boolean : :

Reimplemented from Title.

Definition at line 37 of file FakeTitle.php.

References error().

FakeTitle::isTalkPage (  ) 

Is this a talk page of some sort?

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 46 of file FakeTitle.php.

References error().

FakeTitle::isTrans (  ) 

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

Returns:
Boolean : : TRUE if this is transcludable

Reimplemented from Title.

Definition at line 14 of file FakeTitle.php.

References error().

FakeTitle::isValidCssJsSubpage (  ) 

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

Returns:
Boolean : : TRUE or FALSE

Reimplemented from Title.

Definition at line 48 of file FakeTitle.php.

References error().

FakeTitle::isValidMoveOperation (  ) 

Definition at line 67 of file FakeTitle.php.

References error().

FakeTitle::isValidMoveTarget (  ) 

Definition at line 71 of file FakeTitle.php.

References error().

FakeTitle::loadRestrictions ( oldFashionedRestrictions  ) 

Load restrictions from the page_restrictions table.

Reimplemented from Title.

Definition at line 53 of file FakeTitle.php.

References error().

FakeTitle::moveNoAuth (  ) 

Definition at line 66 of file FakeTitle.php.

References error().

FakeTitle::moveOverExistingRedirect (  ) 

Definition at line 69 of file FakeTitle.php.

References error().

FakeTitle::moveTo (  ) 

Definition at line 68 of file FakeTitle.php.

References error().

FakeTitle::moveToNewTitle (  ) 

Definition at line 70 of file FakeTitle.php.

References error().

FakeTitle::pageCond (  ) 

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

Returns:
: Selection array

Reimplemented from Title.

Definition at line 74 of file FakeTitle.php.

References error().

FakeTitle::resetArticleID ( newid  ) 

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

Parameters:
$newid  Integer : : the new Article ID

Reimplemented from Title.

Definition at line 58 of file FakeTitle.php.

References error().

FakeTitle::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.

Reimplemented from Title.

Definition at line 81 of file FakeTitle.php.

References error().

FakeTitle::trackbackRDF (  ) 

Get the trackback RDF for this page.

Returns:
String : : Trackback RDF

Reimplemented from Title.

Definition at line 83 of file FakeTitle.php.

References error().

FakeTitle::trackbackURL (  ) 

Get the trackback URL for this page.

Returns:
String : : Trackback URL

Reimplemented from Title.

Definition at line 82 of file FakeTitle.php.

References error().

FakeTitle::userCan ( action,
doExpensiveQueries = true 
)

Can $wgUser perform $action on this page?

Parameters:
$action  String : : action that permission needs to be checked for
$doExpensiveQueries  Boolean : : Set this to false to avoid doing unnecessary queries.
Returns:
Boolean : :

Reimplemented from Title.

Definition at line 40 of file FakeTitle.php.

References error().

FakeTitle::userCanCreate (  ) 

Definition at line 41 of file FakeTitle.php.

References error().

FakeTitle::userCanEdit ( doExpensiveQueries = true  ) 

Can $wgUser edit this page?

Returns:
Boolean : : TRUE or FALSE
Deprecated:
use userCan('edit')

Reimplemented from Title.

Definition at line 42 of file FakeTitle.php.

References error().

FakeTitle::userCanEditCssJsSubpage (  ) 

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

Returns:
Boolean : : TRUE or FALSE
Todo:
XXX: this might be better using restrictions

Reimplemented from Title.

Definition at line 52 of file FakeTitle.php.

References error().

FakeTitle::userCanMove (  ) 

Definition at line 43 of file FakeTitle.php.

References error().

FakeTitle::userCanRead (  ) 

Can $wgUser read this page?

Returns:
Boolean : : TRUE or FALSE
Todo:
fold these checks into userCan()

Reimplemented from Title.

Definition at line 45 of file FakeTitle.php.

References error().

FakeTitle::userIsWatching (  ) 

Is $wgUser watching this page?

Returns:
Boolean : :

Reimplemented from Title.

Definition at line 39 of file FakeTitle.php.

References error().


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

Generated on Sat Sep 5 02:08:37 2009 for MediaWiki by  doxygen 1.5.9