MediaWiki  REL1_21
WikiPage Class Reference

Class representing a MediaWiki article and history. More...

Inheritance diagram for WikiPage:
Collaboration diagram for WikiPage:

List of all members.

Public Member Functions

 __construct (Title $title)
 Constructor and clear the article.
 checkFlags ($flags)
 Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.
 checkTouched ()
 Loads page_touched and returns a value indicating if it should be used.
 clear ()
 Clear the object.
 commitRollback ($fromP, $summary, $bot, &$resultDetails, User $guser)
 Backend implementation of doRollback(), please refer there for parameter and return value documentation.
 createUpdates ($rev)
 Perform article updates on a special page creation.
 doCascadeProtectionUpdates (ParserOutput $parserOutput)
 Updates cascading protections.
 doDeleteArticle ($reason, $suppress=false, $id=0, $commit=true, &$error= '', User $user=null)
 Same as doDeleteArticleReal(), but returns a simple boolean.
 doDeleteArticleReal ($reason, $suppress=false, $id=0, $commit=true, &$error= '', User $user=null)
 Back-end article deletion Deletes the article with database consistency, writes logs, purges caches.
 doDeleteUpdates ($id, Content $content=null)
 Do some database updates after deletion.
 doEdit ($text, $summary, $flags=0, $baseRevId=false, $user=null)
 Change an existing article or create a new article.
 doEditContent (Content $content, $summary, $flags=0, $baseRevId=false, User $user=null, $serialisation_format=null)
 Change an existing article or create a new article.
 doEditUpdates (Revision $revision, User $user, array $options=array())
 Do standard deferred updates after page edit.
 doPurge ()
 Perform the actions of a page purging.
 doQuickEdit ($text, User $user, $comment= '', $minor=0)
 Edit an article without doing all that other stuff The article must already exist; link tables etc are not updated, caches are not flushed.
 doQuickEditContent (Content $content, User $user, $comment= '', $minor=0, $serialisation_format=null)
 Edit an article without doing all that other stuff The article must already exist; link tables etc are not updated, caches are not flushed.
 doRollback ($fromP, $summary, $token, $bot, &$resultDetails, User $user)
 Roll back the most recent consecutive set of edits to a page from the same user; fails if there are no eligible edits to roll back to, e.g.
 doUpdateRestrictions (array $limit, array $expiry, &$cascade, $reason, User $user)
 Update the article's restriction field, and leave a log entry.
 doViewUpdates (User $user)
 Do standard deferred updates after page view.
 estimateRevisionCount ()
 Get the approximate revision count of this page.
 exists ()
 followRedirect ()
 Get the Title object or URL this page redirects to.
 getActionOverrides ()
 Returns overrides for action handlers.
 getAutoDeleteReason (&$hasHistory)
 Auto-generates a deletion reason.
 getComment ($audience=Revision::FOR_PUBLIC, User $user=null)
 getContent ($audience=Revision::FOR_PUBLIC, User $user=null)
 Get the content of the current revision.
 getContentHandler ()
 Returns the ContentHandler instance to be used to deal with the content of this WikiPage.
 getContentModel ()
 Returns the page's content model id (see the CONTENT_MODEL_XXX constants).
 getContributors ()
 Get a list of users who have edited this article, not including the user who made the most recent revision, which you can get from $article->getUser() if you want it.
 getCount ()
 getCreator ($audience=Revision::FOR_PUBLIC, User $user=null)
 Get the User object of the user who created the page.
 getDeletionUpdates (Content $content=null)
 Returns a list of updates to be performed when this page is deleted.
 getHiddenCategories ()
 #@-
 getId ()
 getLastNAuthors ($num, $revLatest=0)
 Get the last N authors.
 getLatest ()
 Get the page_latest field.
 getMinorEdit ()
 Returns true if last revision was marked as "minor edit".
 getOldestRevision ()
 Get the Revision object of the oldest revision.
 getParserOutput (ParserOptions $parserOptions, $oldid=null)
 Get a ParserOutput for the given ParserOptions and revision ID.
 getRawText ()
 Get the text of the current revision.
 getRedirectTarget ()
 If this page is a redirect, get its target.
 getRedirectURL ($rt)
 Get the Title object or URL to use for a redirect.
 getRevision ()
 Get the latest revision.
 getText ($audience=Revision::FOR_PUBLIC, User $user=null)
 Get the text of the current revision.
 getTimestamp ()
 getTitle ()
 Get the title object of the article.
 getTouched ()
 Get the page_touched field.
 getUndoContent (Revision $undo, Revision $undoafter=null)
 Get the content that needs to be saved in order to undo all revisions between $undo and $undoafter.
 getUndoText (Revision $undo, Revision $undoafter=null)
 Get the text that needs to be saved in order to undo all revisions between $undo and $undoafter.
 getUsedTemplates ()
 Return a list of templates used by this article.
 getUser ($audience=Revision::FOR_PUBLIC, User $user=null)
 getUserText ($audience=Revision::FOR_PUBLIC, User $user=null)
 hasViewableContent ()
 Check if this page is something we're going to be showing some sort of sensible content for.
 insertOn ($dbw)
 Insert a new empty page record for this article.
 insertRedirect ()
 Insert an entry for this page into the redirect table.
 insertRedirectEntry ($rt)
 Insert or update the redirect table entry for this page to indicate it redirects to $rt .
 isBigDeletion ()
 Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit.
 isCountable ($editInfo=false)
 Determine whether a page would be suitable for being counted as an article in the site_stats table based on the title & its content.
 isParserCacheUsed (ParserOptions $parserOptions, $oldid)
 Should the parser cache be used?
 isRedirect ()
 Tests if the article content represents a redirect.
 loadFromRow ($data, $from)
 Load the object from a database row.
 loadPageData ($from= 'fromdb')
 Set the general counter, title etc data loaded from some source.
 makeParserOptions ($context)
 Get parser options suitable for rendering the primary article wikitext.
 pageDataFromId ($dbr, $id, $options=array())
 Fetch a page record matching the requested ID.
 pageDataFromTitle ($dbr, $title, $options=array())
 Fetch a page record matching the Title object's namespace and title using a sanitized title string.
 prepareContentForEdit (Content $content, $revid=null, User $user=null, $serialization_format=null)
 Prepare content which is about to be saved.
 prepareTextForEdit ($text, $revid=null, User $user=null)
 Prepare text which is about to be saved.
 preSaveTransform ($text, User $user=null, ParserOptions $popts=null)
 This function is called right before saving the wikitext, so we can do things like signatures and links-in-context.
 quickEdit ($text, $comment= '', $minor=0)
 replaceSection ($section, $text, $sectionTitle= '', $edittime=null)
 replaceSectionContent ($section, Content $sectionContent, $sectionTitle= '', $edittime=null)
 setCachedLastEditTime ($timestamp)
 Set the cached timestamp for the last time the page changed.
 setTimestamp ($ts)
 Set the page timestamp (use only to avoid DB queries)
 supportsSections ()
 Returns true iff this page's content model supports sections.
 updateCategoryCounts ($added, $deleted)
 Update all the appropriate counts in the category table, given that we've added the categories $added and deleted the categories $deleted.
 updateIfNewerOn ($dbw, $revision)
 If the given revision is newer than the currently set page_latest, update the page record.
 updateRedirectOn ($dbw, $redirectTitle, $lastRevIsRedirect=null)
 Add row to the redirect table if this is a redirect, remove otherwise.
 updateRestrictions ($limit=array(), $reason= '', &$cascade=0, $expiry=array(), User $user=null)
 Update the article's restriction field, and leave a log entry.
 updateRevisionOn ($dbw, $revision, $lastRevision=null, $lastRevIsRedirect=null)
 Update the page record to point to a newly saved revision.
 useParserCache ($oldid)
 viewUpdates ()

Static Public Member Functions

static factory (Title $title)
 Create a WikiPage object of the appropriate class for the given title.
static getAutosummary ($oldtext, $newtext, $flags)
 Return an applicable autosummary if one exists for the given edit.
static newFromID ($id, $from= 'fromdb')
 Constructor from a page id.
static newFromRow ($row, $from= 'fromdb')
 Constructor from a database row.
static onArticleCreate ($title)
 The onArticle*() functions are supposed to be a kind of hooks which should be called whenever any of the specified actions are done.
static onArticleDelete ($title)
 Clears caches when article is deleted.
static onArticleEdit ($title)
 Purge caches on page update etc.
static selectFields ()
 Return the list of revision fields that should be selected to create a new page.

Public Attributes

 $mDataLoadedFrom = self::READ_NONE
 $mTimestamp = ''
Title $mTitle = null
 $mDataLoaded = false
 $mIsRedirect = false
 $mLatest = false
 $mPreparedEdit = false

Protected Member Functions

 clearCacheFields ()
 Clear the object cache fields.
 getCachedLastEditTime ()
 Get the cached timestamp for the last time the page changed.
 loadLastEdit ()
 Loads everything except the text This isn't necessary for all uses, so it's only done if needed.
 pageData ($dbr, $conditions, $options=array())
 Fetch a page record with the given conditions.
 setLastEdit (Revision $revision)
 Set the latest revision.

Static Protected Member Functions

static flattenRestrictions ($limit)
 Take an array of page restrictions and flatten it to a string suitable for insertion into the page_restrictions field.

Protected Attributes

int null $mCounter = null
Revision $mLastRevision = null
Title $mRedirectTarget = null
string $mTouched = '19700101000000'
 int
 one of the READ_* constants
 string
 timestamp of the current revision or empty string if not loaded

Static Private Member Functions

static convertSelectType ($type)
 Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.

Detailed Description

Class representing a MediaWiki article and history.

Some fields are public only for backwards-compatibility. Use accessors. In the past, this class was part of Article.php and everything was public.

Definition at line 36 of file WikiPage.php.


Constructor & Destructor Documentation

Constructor and clear the article.

Parameters:
$titleTitle Reference to a Title object.

Definition at line 80 of file WikiPage.php.


Member Function Documentation

WikiPage::checkFlags ( flags)

Check flags and add EDIT_NEW or EDIT_UPDATE to them as needed.

Parameters:
$flagsInt
Returns:
Int updated $flags

Definition at line 1501 of file WikiPage.php.

Loads page_touched and returns a value indicating if it should be used.

Returns:
boolean true if not a redirect

Definition at line 479 of file WikiPage.php.

Clear the object.

Returns:
void

Definition at line 212 of file WikiPage.php.

Referenced by EditPageTest\forceRevisionDate(), and ApiEditPageTest\forceRevisionDate().

WikiPage::clearCacheFields ( ) [protected]

Clear the object cache fields.

Returns:
void

Definition at line 223 of file WikiPage.php.

WikiPage::commitRollback ( fromP,
summary,
bot,
&$  resultDetails,
User guser 
)

Backend implementation of doRollback(), please refer there for parameter and return value documentation.

NOTE: This function does NOT check ANY permissions, it just commits the rollback to the DB. Therefore, you should only call this function direct- ly if you want to use custom permissions checks. If you don't, use doRollback() instead.

Parameters:
string$fromPName of the user whose edits to rollback.
string$summaryCustom summary. Set to default summary if empty.
$botBoolean: If true, mark all reverted edits as bot.
array$resultDetailscontains result-specific array of additional values
$guserUser The user performing the rollback
Returns:
array

Definition at line 2705 of file WikiPage.php.

static WikiPage::convertSelectType ( type) [static, private]

Convert 'fromdb', 'fromdbmaster' and 'forupdate' to READ_* constants.

Parameters:
$typeobject|string|int
Returns:
mixed

Definition at line 158 of file WikiPage.php.

References IDBAccessObject\READ_LATEST, IDBAccessObject\READ_LOCKING, and IDBAccessObject\READ_NORMAL.

Perform article updates on a special page creation.

Parameters:
$revRevision object
Todo:
This is a shitty interface function. Kill it and replace the other shitty functions like doEditUpdates and such so it's not needed anymore.
Deprecated:
since 1.18, use doEditUpdates()

Definition at line 3139 of file WikiPage.php.

Updates cascading protections.

Parameters:
$parserOutputParserOutput object for the current version

Definition at line 3071 of file WikiPage.php.

WikiPage::doDeleteArticle ( reason,
suppress = false,
id = 0,
commit = true,
&$  error = '',
User user = null 
)

Same as doDeleteArticleReal(), but returns a simple boolean.

This is kept around for backwards compatibility, if you care about error reporting you should use doDeleteArticleReal() instead.

Deletes the article with database consistency, writes logs, purges caches

Parameters:
string$reasondelete reason for deletion log
$suppressboolean suppress all revisions and log the deletion in the suppression log instead of the deletion log
int$idarticle ID
$commitboolean defaults to true, triggers transaction end
&$errorArray of errors to append to
$userUser The deleting user
Returns:
boolean true if successful

Definition at line 2467 of file WikiPage.php.

Referenced by WikiPageTest\testExists().

WikiPage::doDeleteArticleReal ( reason,
suppress = false,
id = 0,
commit = true,
&$  error = '',
User user = null 
)

Back-end article deletion Deletes the article with database consistency, writes logs, purges caches.

Since:
1.19
Parameters:
string$reasondelete reason for deletion log
$suppressboolean suppress all revisions and log the deletion in the suppression log instead of the deletion log
int$idarticle ID
$commitboolean defaults to true, triggers transaction end
&$errorArray of errors to append to
$userUser The deleting user
Returns:
Status: Status object; if successful, $status->value is the log_id of the deletion log entry. If the page couldn't be deleted because it wasn't found, $status is a non-fatal 'cannotdelete' error

Definition at line 2491 of file WikiPage.php.

WikiPage::doDeleteUpdates ( id,
Content content = null 
)

Do some database updates after deletion.

Parameters:
int$idpage_id value of the page being deleted (B/C, currently unused)
$contentContent: optional page content to be used when determining the required updates. This may be needed because $this->getContent() may already return null when the page proper was deleted.

Definition at line 2621 of file WikiPage.php.

WikiPage::doEdit ( text,
summary,
flags = 0,
baseRevId = false,
user = null 
)

Change an existing article or create a new article.

Updates RC and all necessary caches, optionally via the deferred update array.

Parameters:
string$textnew text
string$summaryedit summary
$flagsInteger bitfield: EDIT_NEW Article is known or assumed to be non-existent, create a new one EDIT_UPDATE Article is known or assumed to be pre-existing, update it EDIT_MINOR Mark this edit minor, if the user is allowed to do so EDIT_SUPPRESS_RC Do not log the change in recentchanges EDIT_FORCE_BOT Mark the edit a "bot" edit regardless of user rights EDIT_DEFER_UPDATES Defer some of the updates until the end of index.php EDIT_AUTOSUMMARY Fill in blank summaries with generated text where possible

If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected. If EDIT_UPDATE is specified and the article doesn't exist, the function will return an edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an edit-already-exists error will be returned. These two conditions are also possible with auto-detection due to MediaWiki's performance-optimised locking strategy.

Parameters:
bool | int$baseRevIdint the revision ID this edit was based off, if any
$userUser the user doing the edit
Exceptions:
MWException
Returns:
Status object. Possible errors: edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status edit-gone-missing: In update mode, but the article didn't exist edit-conflict: In update mode, the article changed unexpectedly edit-no-change: Warning that the text was the same as before edit-already-exists: In creation mode, but the article already exists

Extensions may define additional errors.

$return->value will contain an associative array with members as follows: new: Boolean indicating if the function attempted to create a new article revision: The revision object for the inserted revision, or null

Compatibility note: this function previously returned a boolean value indicating success/failure

Deprecated:
since 1.21: use doEditContent() instead.

Definition at line 1562 of file WikiPage.php.

WikiPage::doEditContent ( Content content,
summary,
flags = 0,
baseRevId = false,
User user = null,
serialisation_format = null 
)

Change an existing article or create a new article.

Updates RC and all necessary caches, optionally via the deferred update array.

Parameters:
$contentContent: new content
string$summaryedit summary
$flagsInteger bitfield: EDIT_NEW Article is known or assumed to be non-existent, create a new one EDIT_UPDATE Article is known or assumed to be pre-existing, update it EDIT_MINOR Mark this edit minor, if the user is allowed to do so EDIT_SUPPRESS_RC Do not log the change in recentchanges EDIT_FORCE_BOT Mark the edit a "bot" edit regardless of user rights EDIT_DEFER_UPDATES Defer some of the updates until the end of index.php EDIT_AUTOSUMMARY Fill in blank summaries with generated text where possible

If neither EDIT_NEW nor EDIT_UPDATE is specified, the status of the article will be detected. If EDIT_UPDATE is specified and the article doesn't exist, the function will return an edit-gone-missing error. If EDIT_NEW is specified and the article does exist, an edit-already-exists error will be returned. These two conditions are also possible with auto-detection due to MediaWiki's performance-optimised locking strategy.

Parameters:
bool|\the$baseRevId the revision ID this edit was based off, if any
$userUser the user doing the edit
$serialisation_formatString: format for storing the content in the database
Exceptions:
MWException
Returns:
Status object. Possible errors: edit-hook-aborted: The ArticleSave hook aborted the edit but didn't set the fatal flag of $status edit-gone-missing: In update mode, but the article didn't exist edit-conflict: In update mode, the article changed unexpectedly edit-no-change: Warning that the text was the same as before edit-already-exists: In creation mode, but the article already exists

Extensions may define additional errors.

$return->value will contain an associative array with members as follows: new: Boolean indicating if the function attempted to create a new article revision: The revision object for the inserted revision, or null

Since:
1.21

Definition at line 1618 of file WikiPage.php.

WikiPage::doEditUpdates ( Revision revision,
User user,
array options = array() 
)

Do standard deferred updates after page edit.

Update links tables, site stats, search index and message cache. Purges pages that include this page if the text was changed here. Every 100th edit, prune the recent changes table.

Parameters:
$revisionRevision object
$userUser object that did the revision
array$optionsof options, following indexes are used:
  • changed: boolean, whether the revision changed the content (default true)
  • created: boolean, whether the revision created the page (default false)
  • oldcountable: boolean or null (default null):
    • boolean: whether the page was counted as an article before that revision, only used in changed is true and created is false
    • null: don't change the article count

Definition at line 2017 of file WikiPage.php.

Perform the actions of a page purging.

Returns:
bool

Reimplemented in WikiFilePage.

Definition at line 1133 of file WikiPage.php.

WikiPage::doQuickEdit ( text,
User user,
comment = '',
minor = 0 
)

Edit an article without doing all that other stuff The article must already exist; link tables etc are not updated, caches are not flushed.

Parameters:
string$texttext submitted
$userUser The relevant user
string$commentcomment submitted
$minorBoolean: whereas it's a minor modification
Deprecated:
since 1.21, use doEditContent() instead.

Definition at line 2144 of file WikiPage.php.

WikiPage::doQuickEditContent ( Content content,
User user,
comment = '',
minor = 0,
serialisation_format = null 
)

Edit an article without doing all that other stuff The article must already exist; link tables etc are not updated, caches are not flushed.

Parameters:
$contentContent: content submitted
$userUser The relevant user
string$commentcomment submitted
$serialisation_formatString: format for storing the content in the database
$minorBoolean: whereas it's a minor modification

Definition at line 2162 of file WikiPage.php.

WikiPage::doRollback ( fromP,
summary,
token,
bot,
&$  resultDetails,
User user 
)

Roll back the most recent consecutive set of edits to a page from the same user; fails if there are no eligible edits to roll back to, e.g.

user is the sole contributor. This function performs permissions checks on $user, then calls commitRollback() to do the dirty work

Todo:
: separate the business/permission stuff out from backend code
Parameters:
string$fromPName of the user whose edits to rollback.
string$summaryCustom summary. Set to default summary if empty.
string$tokenRollback token.
$botBoolean: If true, mark all reverted edits as bot.
array$resultDetailscontains result-specific array of additional values 'alreadyrolled' : 'current' (rev) success : 'summary' (str), 'current' (rev), 'target' (rev)
$userUser The user performing the rollback
Returns:
array of errors, each error formatted as array(messagekey, param1, param2, ...). On success, the array is empty. This array can also be passed to OutputPage::showPermissionsErrorPage().

Definition at line 2663 of file WikiPage.php.

WikiPage::doUpdateRestrictions ( array limit,
array expiry,
&$  cascade,
reason,
User user 
)

Update the article's restriction field, and leave a log entry.

This works for protection both existing and non-existing pages.

Parameters:
array$limitset of restriction keys
$reasonString
&$cascadeInteger. Set to false if cascading protection isn't allowed.
array$expiryper restriction type expiration
$userUser The user updating the restrictions
Returns:
Status

Definition at line 2195 of file WikiPage.php.

Do standard deferred updates after page view.

Parameters:
$userUser The relevant user

Definition at line 1113 of file WikiPage.php.

Get the approximate revision count of this page.

Deprecated:
in 1.19; use Title::estimateRevisionCount() instead.
Returns:
int

Definition at line 3188 of file WikiPage.php.

References wfDeprecated().

Returns:
bool Whether or not the page exists in the database

Definition at line 409 of file WikiPage.php.

Referenced by LinksDeletionUpdate\__construct().

static WikiPage::factory ( Title title) [static]

Create a WikiPage object of the appropriate class for the given title.

Parameters:
$titleTitle
Exceptions:
MWException
Returns:
WikiPage object of the appropriate type

Definition at line 91 of file WikiPage.php.

Referenced by BackupDumperPageTest\addDBData(), TextPassDumperTest\addDBData(), EditPageTest\assertEdit(), Orphans\checkSeparation(), CleanupSpam\cleanupArticle(), UploadFromUrlTest\deleteFile(), ApiTestCaseUpload\deleteFileByTitle(), MovePageForm\doSubmit(), ApiEditPage\execute(), ApiRollback\execute(), DeleteDefaultMessages\execute(), ImportSiteScripts\execute(), AttachLatest\execute(), Protect\execute(), RollbackEdits\execute(), EditCLI\execute(), DeleteBatch\execute(), ApiPurge\execute(), DeleteEqualMessages\execute(), ListredirectsPage\getRedirectTarget(), ApiPageSet\getRedirectTargets(), ApiBase\getTitleOrPageId(), SearchEngineTest\insertPage(), Title\invalidateCache(), SpecialMergeHistory\merge(), Title\moveToInternal(), ImportReporter\reportPage(), EditPageTest\testAutoMerge(), ArticleTablesTest\testbug14404(), ApiQueryRevisionsTest\testContentComesWithContentModelAndFormat(), TextContentTest\testDeletionUpdates(), ApiEditPageTest\testEditConflict(), ApiEditPageTest\testEditConflict_bug41990(), ApiEditPageTest\testEditConflict_redirect(), WikitextContentTest\testGetSecondaryDataUpdates(), UploadFromUrlTest\testLeaveMessage(), ApiEditPageTest\testNonTextEdit(), TemplateCategoriesTest\testTemplateCategories(), RequestContextTest\testWikiPageTitle(), SpecialEditWatchlist\unwatchTitles(), LinksUpdate\updateCategoryCounts(), LinksDeletionUpdate\updateCategoryCounts(), and Title\updateTitleProtection().

static WikiPage::flattenRestrictions ( limit) [static, protected]

Take an array of page restrictions and flatten it to a string suitable for insertion into the page_restrictions field.

Parameters:
$limitArray
Exceptions:
MWException
Returns:
String

Definition at line 2434 of file WikiPage.php.

Get the Title object or URL this page redirects to.

Returns:
mixed false, Title of in-wiki target, or string with URL

Reimplemented in WikiFilePage.

Definition at line 902 of file WikiPage.php.

Returns overrides for action handlers.

Classes listed here will be used instead of the default one when (and only when) $wgActions[$action] === true. This allows subclasses to override the default behavior.

Todo:
: move this UI stuff somewhere else
Returns:
Array

Reimplemented in WikiFilePage.

Definition at line 182 of file WikiPage.php.

WikiPage::getAutoDeleteReason ( &$  hasHistory)

Auto-generates a deletion reason.

Parameters:
&$hasHistoryBoolean: whether the page has a history
Returns:
mixed String containing deletion reason or empty string, or boolean false if no revision occurred

Definition at line 2990 of file WikiPage.php.

static WikiPage::getAutosummary ( oldtext,
newtext,
flags 
) [static]

Return an applicable autosummary if one exists for the given edit.

Parameters:
string | null$oldtextthe previous text of the page.
string | null$newtextThe submitted text of the page.
int$flagsbitmask: a bitmask of flags submitted for the edit.
Returns:
string An appropriate autosummary, or an empty string.
Deprecated:
since 1.21, use ContentHandler::getAutosummary() instead

Definition at line 2971 of file WikiPage.php.

Get the cached timestamp for the last time the page changed.

This is only used to help handle slave lag by comparing to page_touched.

Returns:
string MW timestamp

Definition at line 763 of file WikiPage.php.

WikiPage::getComment ( audience = Revision::FOR_PUBLIC,
User user = null 
)
Parameters:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
string Comment stored for the last article revision

Definition at line 735 of file WikiPage.php.

WikiPage::getContent ( audience = Revision::FOR_PUBLIC,
User user = null 
)

Get the content of the current revision.

No side-effects...

Parameters:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to $wgUser Revision::RAW get the text regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
Content|null The content of the current revision
Since:
1.21

Definition at line 607 of file WikiPage.php.

Referenced by insertRedirect().

Returns the ContentHandler instance to be used to deal with the content of this WikiPage.

Shorthand for ContentHandler::getForModelID( $this->getContentModel() );

Returns:
ContentHandler
Since:
1.21

Definition at line 196 of file WikiPage.php.

Returns the page's content model id (see the CONTENT_MODEL_XXX constants).

Will use the revisions actual content model if the page exists, and the page's default if the page doesn't exist yet.

Returns:
String
Since:
1.21

Definition at line 458 of file WikiPage.php.

Get a list of users who have edited this article, not including the user who made the most recent revision, which you can get from $article->getUser() if you want it.

Returns:
UserArrayFromResult

Definition at line 954 of file WikiPage.php.

Returns:
int The view count for the page

Definition at line 428 of file WikiPage.php.

WikiPage::getCreator ( audience = Revision::FOR_PUBLIC,
User user = null 
)

Get the User object of the user who created the page.

Parameters:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
User|null

Definition at line 698 of file WikiPage.php.

WikiPage::getDeletionUpdates ( Content content = null)

Returns a list of updates to be performed when this page is deleted.

The updates should remove any information about this page from secondary data stores such as links tables.

Parameters:
Content | null$contentoptional Content object for determining the necessary updates
Returns:
Array an array of DataUpdates objects

Definition at line 3250 of file WikiPage.php.

#@-

Returns a list of hidden categories this page is a member of. Uses the page_props and categorylinks tables.

Returns:
Array of Title objects

Definition at line 2938 of file WikiPage.php.

Returns:
int Page ID

Definition at line 402 of file WikiPage.php.

WikiPage::getLastNAuthors ( num,
revLatest = 0 
)

Get the last N authors.

Parameters:
$numInteger: number of revisions to get
string$revLatestthe latest rev_id, selected from the master (optional)
Returns:
array Array of authors, duplicates not removed

Definition at line 1006 of file WikiPage.php.

References $res, array(), as, wfGetDB(), wfProfileIn(), and wfProfileOut().

Get the page_latest field.

Returns:
integer rev_id of current revision

Definition at line 501 of file WikiPage.php.

Referenced by EditPageTest\forceRevisionDate(), and ApiEditPageTest\forceRevisionDate().

Returns true if last revision was marked as "minor edit".

Returns:
boolean Minor edit indicator for the last article revision.

Definition at line 749 of file WikiPage.php.

Get the Revision object of the oldest revision.

Returns:
Revision|null

Definition at line 512 of file WikiPage.php.

WikiPage::getParserOutput ( ParserOptions parserOptions,
oldid = null 
)

Get a ParserOutput for the given ParserOptions and revision ID.

The parser cache will be used if possible.

Since:
1.19
Parameters:
$parserOptionsParserOptions to use for the parse operation
$oldidRevision ID to get the text from, passing null or 0 will get the current revision (default value)
Returns:
ParserOutput or false if the revision was not found

Definition at line 1080 of file WikiPage.php.

Get the text of the current revision.

No side-effects...

Returns:
String|bool The text of the current revision. False on failure
Deprecated:
as of 1.21, getContent() should be used instead.

Definition at line 643 of file WikiPage.php.

References ContentHandler\deprecated().

If this page is a redirect, get its target.

The target will be fetched from the redirect table if possible. If this page doesn't have an entry there, call insertRedirect()

Returns:
Title|mixed object, or null if this page is not a redirect

Reimplemented in WikiFilePage.

Definition at line 833 of file WikiPage.php.

Get the Title object or URL to use for a redirect.

We use Title objects for same-wiki, non-special redirects and URLs for everything else.

Parameters:
$rtTitle Redirect target
Returns:
mixed false, Title object of local target, or string with URL

Definition at line 913 of file WikiPage.php.

Get the latest revision.

Returns:
Revision|null

Definition at line 586 of file WikiPage.php.

WikiPage::getText ( audience = Revision::FOR_PUBLIC,
User user = null 
)

Get the text of the current revision.

No side-effects...

Parameters:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
String|false The text of the current revision
Deprecated:
as of 1.21, getContent() should be used instead.

Definition at line 627 of file WikiPage.php.

Returns:
string MW timestamp of last article revision

Definition at line 652 of file WikiPage.php.

Get the title object of the article.

Returns:
Title object of this page

Definition at line 204 of file WikiPage.php.

Referenced by prepareTextForEdit(), and RequestContext\setWikiPage().

Get the page_touched field.

Returns:
string containing GMT timestamp

Definition at line 490 of file WikiPage.php.

WikiPage::getUndoContent ( Revision undo,
Revision undoafter = null 
)

Get the content that needs to be saved in order to undo all revisions between $undo and $undoafter.

Revisions must belong to the same page, must exist and must not be deleted

Parameters:
$undoRevision
$undoafterRevision Must be an earlier revision than $undo
Returns:
mixed string on success, false on failure
Since:
1.21 Before we had the Content object, this was done in getUndoText

Definition at line 1364 of file WikiPage.php.

WikiPage::getUndoText ( Revision undo,
Revision undoafter = null 
)

Get the text that needs to be saved in order to undo all revisions between $undo and $undoafter.

Revisions must belong to the same page, must exist and must not be deleted

Parameters:
$undoRevision
$undoafterRevision Must be an earlier revision than $undo
Returns:
mixed string on success, false on failure
Deprecated:
since 1.21: use ContentHandler::getUndoContent() instead.

Definition at line 1378 of file WikiPage.php.

Return a list of templates used by this article.

Uses the templatelinks table

Deprecated:
in 1.19; use Title::getTemplateLinksFrom()
Returns:
Array of Title objects

Definition at line 3125 of file WikiPage.php.

WikiPage::getUser ( audience = Revision::FOR_PUBLIC,
User user = null 
)
Parameters:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
int user ID for the user that made the last article revision

Definition at line 679 of file WikiPage.php.

WikiPage::getUserText ( audience = Revision::FOR_PUBLIC,
User user = null 
)
Parameters:
$audienceInteger: one of: Revision::FOR_PUBLIC to be displayed to all users Revision::FOR_THIS_USER to be displayed to the given user Revision::RAW get the text regardless of permissions
$userUser object to check for, only if FOR_THIS_USER is passed to the $audience parameter
Returns:
string username of the user that made the last article revision

Definition at line 717 of file WikiPage.php.

Check if this page is something we're going to be showing some sort of sensible content for.

If we return false, page views (plain action=view) will return an HTTP 404 response, so spiders and robots can know they're following a bad link.

Returns:
bool

Reimplemented in WikiCategoryPage.

Definition at line 421 of file WikiPage.php.

WikiPage::insertOn ( dbw)

Insert a new empty page record for this article.

This *must* be followed up by creating a revision and running $this->updateRevisionOn( ... ); or else the record will be left in a funky state. Best if all done inside a transaction.

Parameters:
$dbwDatabaseBase
Returns:
int The newly created page_id key, or false if the title already existed

Definition at line 1184 of file WikiPage.php.

Insert an entry for this page into the redirect table.

Don't call this function directly unless you know what you're doing.

Returns:
Title object or null if not a redirect

Definition at line 867 of file WikiPage.php.

References $retval, getContent(), and insertRedirectEntry().

Insert or update the redirect table entry for this page to indicate it redirects to $rt .

Parameters:
$rtTitle redirect target

Definition at line 883 of file WikiPage.php.

Referenced by insertRedirect().

Check whether the number of revisions of this page surpasses $wgDeleteRevisionsLimit.

Deprecated:
in 1.19; use Title::isBigDeletion() instead.
Returns:
bool

Definition at line 3177 of file WikiPage.php.

References wfDeprecated().

WikiPage::isCountable ( editInfo = false)

Determine whether a page would be suitable for being counted as an article in the site_stats table based on the title & its content.

Parameters:
$editInfoObject|bool (false): object returned by prepareTextForEdit(), if false, the current database state will be used
Returns:
Boolean

Definition at line 789 of file WikiPage.php.

WikiPage::isParserCacheUsed ( ParserOptions parserOptions,
oldid 
)

Should the parser cache be used?

Parameters:
$parserOptionsParserOptions to check
$oldidint
Returns:
boolean

Definition at line 1059 of file WikiPage.php.

Tests if the article content represents a redirect.

Returns:
bool

Reimplemented in WikiFilePage.

Definition at line 441 of file WikiPage.php.

WikiPage::loadFromRow ( data,
from 
)

Load the object from a database row.

Since:
1.20
Parameters:
$dataobject: database row containing at least fields returned by selectFields()
string | int$fromOne of the following:

Definition at line 365 of file WikiPage.php.

WikiPage::loadLastEdit ( ) [protected]

Loads everything except the text This isn't necessary for all uses, so it's only done if needed.

Definition at line 551 of file WikiPage.php.

WikiPage::loadPageData ( from = 'fromdb')

Set the general counter, title etc data loaded from some source.

Parameters:
$fromobject|string|int One of the following:
Returns:
void

Definition at line 322 of file WikiPage.php.

Get parser options suitable for rendering the primary article wikitext.

See also:
ContentHandler::makeParserOptions
Parameters:
IContextSource | User | string$contextOne of the following:
  • IContextSource: Use the User and the Language of the provided context
  • User: Use the provided User object and $wgLang for the language, so use an IContextSource object if possible.
  • 'canonical': Canonical options (anonymous user with default preferences and content language).
Returns:
ParserOptions

Definition at line 1925 of file WikiPage.php.

static WikiPage::newFromID ( id,
from = 'fromdb' 
) [static]

Constructor from a page id.

Parameters:
int$idarticle ID to load
string | int$fromone of the following values:
Returns:
WikiPage|null

Definition at line 124 of file WikiPage.php.

Referenced by RefreshLinks\fixLinksFromArticle(), RefreshLinks\fixRedirect(), and ApiBase\getTitleOrPageId().

static WikiPage::newFromRow ( row,
from = 'fromdb' 
) [static]

Constructor from a database row.

Since:
1.20
Parameters:
$rowobject: database row containing at least fields returned by selectFields().
string | int$fromsource of $data:
Returns:
WikiPage

Definition at line 146 of file WikiPage.php.

static WikiPage::onArticleCreate ( title) [static]

The onArticle*() functions are supposed to be a kind of hooks which should be called whenever any of the specified actions are done.

This is a good place to put code to clear caches, for instance.

This is called on page move and undelete, as well as edit

Parameters:
$titleTitle object

Definition at line 2849 of file WikiPage.php.

Referenced by Title\moveToInternal().

static WikiPage::onArticleDelete ( title) [static]

Clears caches when article is deleted.

Parameters:
$titleTitle

Definition at line 2870 of file WikiPage.php.

Referenced by Title\moveToInternal().

static WikiPage::onArticleEdit ( title) [static]

Purge caches on page update etc.

Parameters:
$titleTitle object
Todo:
: verify that $title is always a Title object (and never false or null), add Title hint to parameter $title

Definition at line 2916 of file WikiPage.php.

References DeferredUpdates\addHTMLCacheUpdate(), HTMLFileCache\clearFileCache(), and Title\purgeSquid().

WikiPage::pageData ( dbr,
conditions,
options = array() 
) [protected]

Fetch a page record with the given conditions.

Parameters:
$dbrDatabaseBase object
$conditionsArray
$optionsArray
Returns:
mixed Database result resource, or false on failure

Definition at line 271 of file WikiPage.php.

WikiPage::pageDataFromId ( dbr,
id,
options = array() 
)

Fetch a page record matching the requested ID.

Parameters:
$dbrDatabaseBase
$idInteger
$optionsArray
Returns:
mixed Database result resource, or false on failure

Definition at line 306 of file WikiPage.php.

WikiPage::pageDataFromTitle ( dbr,
title,
options = array() 
)

Fetch a page record matching the Title object's namespace and title using a sanitized title string.

Parameters:
$dbrDatabaseBase object
$titleTitle object
$optionsArray
Returns:
mixed Database result resource, or false on failure

Definition at line 292 of file WikiPage.php.

WikiPage::prepareContentForEdit ( Content content,
revid = null,
User user = null,
serialization_format = null 
)

Prepare content which is about to be saved.

Returns a stdclass with source, pst and output members

Parameters:
\Content$content
null$revid
null|\User$user
null$serialization_format
Returns:
bool|object
Since:
1.21

Definition at line 1961 of file WikiPage.php.

Referenced by prepareTextForEdit().

WikiPage::prepareTextForEdit ( text,
revid = null,
User user = null 
)

Prepare text which is about to be saved.

Returns a stdclass with source, pst and output members

Deprecated:
in 1.21: use prepareContentForEdit instead.

Definition at line 1942 of file WikiPage.php.

References ContentHandler\deprecated(), getTitle(), ContentHandler\makeContent(), and prepareContentForEdit().

WikiPage::preSaveTransform ( text,
User user = null,
ParserOptions popts = null 
)

This function is called right before saving the wikitext, so we can do things like signatures and links-in-context.

Deprecated:
in 1.19; use Parser::preSaveTransform() instead
Parameters:
string$textarticle contents
$userUser object: user doing the edit
$poptsParserOptions object: parser options, default options for the user loaded if null given
Returns:
string article contents with altered wikitext markup (signatures converted, {{subst:}}, templates, etc.)

Definition at line 3157 of file WikiPage.php.

WikiPage::quickEdit ( text,
comment = '',
minor = 0 
)
Deprecated:
since 1.18

Definition at line 3217 of file WikiPage.php.

WikiPage::replaceSection ( section,
text,
sectionTitle = '',
edittime = null 
)
Parameters:
$sectionnull|bool|int or a section number (0, 1, 2, T1, T2...)
string$textnew text of the section
string$sectionTitlenew section's subject, only if $section is 'new'
string$edittimerevision timestamp or null to use the current revision
Exceptions:
MWException
Returns:
String new complete article text, or null if error
Deprecated:
since 1.21, use replaceSectionContent() instead

Definition at line 1411 of file WikiPage.php.

WikiPage::replaceSectionContent ( section,
Content sectionContent,
sectionTitle = '',
edittime = null 
)
Parameters:
$sectionnull|bool|int or a section number (0, 1, 2, T1, T2...)
$sectionContentContent: new content of the section
string$sectionTitlenew section's subject, only if $section is 'new'
string$edittimerevision timestamp or null to use the current revision
Exceptions:
MWException
Returns:
Content new complete article content, or null if error
Since:
1.21

Definition at line 1454 of file WikiPage.php.

static WikiPage::selectFields ( ) [static]

Return the list of revision fields that should be selected to create a new page.

Returns:
array

Definition at line 240 of file WikiPage.php.

References array(), and global.

Set the cached timestamp for the last time the page changed.

This is only used to help handle slave lag by comparing to page_touched.

Parameters:
$timestampstring
Returns:
void

Definition at line 775 of file WikiPage.php.

References $timestamp, $wgMemc, global, wfMemcKey(), and wfTimestamp().

WikiPage::setLastEdit ( Revision revision) [protected]

Set the latest revision.

Definition at line 577 of file WikiPage.php.

Set the page timestamp (use only to avoid DB queries)

Parameters:
string$tsMW timestamp of last article revision
Returns:
void

Definition at line 666 of file WikiPage.php.

Returns true iff this page's content model supports sections.

Returns:
boolean whether sections are supported.
Todo:

: the skin should check this and not offer section functionality if sections are not supported.

: the EditPage should check this and not offer section functionality if sections are not supported.

Definition at line 1439 of file WikiPage.php.

WikiPage::updateCategoryCounts ( added,
deleted 
)

Update all the appropriate counts in the category table, given that we've added the categories $added and deleted the categories $deleted.

Parameters:
array$addedThe names of categories that were added
array$deletedThe names of categories that were deleted

Definition at line 3001 of file WikiPage.php.

WikiPage::updateIfNewerOn ( dbw,
revision 
)

If the given revision is newer than the currently set page_latest, update the page record.

Otherwise, do nothing.

Parameters:
$dbwDatabaseBase object
$revisionRevision object
Returns:
mixed

Definition at line 1324 of file WikiPage.php.

WikiPage::updateRedirectOn ( dbw,
redirectTitle,
lastRevIsRedirect = null 
)

Add row to the redirect table if this is a redirect, remove otherwise.

Parameters:
$dbwDatabaseBase
$redirectTitleTitle object pointing to the redirect target, or NULL if this is not a redirect
$lastRevIsRedirectnull|bool If given, will optimize adding and removing rows in redirect table.
Returns:
bool true on success, false on failure
Access:
private

Definition at line 1289 of file WikiPage.php.

WikiPage::updateRestrictions ( limit = array(),
reason = '',
&$  cascade = 0,
expiry = array(),
User user = null 
)

Update the article's restriction field, and leave a log entry.

Deprecated:
since 1.19
Parameters:
array$limitset of restriction keys
$reasonString
&$cascadeInteger. Set to false if cascading protection isn't allowed.
array$expiryper restriction type expiration
$userUser The user updating the restrictions
Returns:
bool true on success

Definition at line 3204 of file WikiPage.php.

WikiPage::updateRevisionOn ( dbw,
revision,
lastRevision = null,
lastRevIsRedirect = null 
)

Update the page record to point to a newly saved revision.

Parameters:
$dbwDatabaseBase: object
$revisionRevision: For ID number, and text used to set length and redirect status fields
$lastRevisionInteger: if given, will not overwrite the page field when different from the currently set value. Giving 0 indicates the new page flag should be set on.
$lastRevIsRedirectBoolean: if given, will optimize adding and removing rows in redirect table.
Returns:
bool true on success, false on failure
Access:
private

Definition at line 1228 of file WikiPage.php.

Deprecated:
since 1.18
Parameters:
$oldidint
Returns:
bool

Definition at line 3237 of file WikiPage.php.

Deprecated:
since 1.18

Definition at line 3226 of file WikiPage.php.


Member Data Documentation

int null WikiPage::$mCounter = null [protected]

Definition at line 74 of file WikiPage.php.

WikiPage::$mDataLoaded = false

{

Access:
protected

Definition at line 46 of file WikiPage.php.

WikiPage::$mDataLoadedFrom = self::READ_NONE

Definition at line 54 of file WikiPage.php.

WikiPage::$mIsRedirect = false

{

Access:
protected

Definition at line 47 of file WikiPage.php.

Revision WikiPage::$mLastRevision = null [protected]

Definition at line 62 of file WikiPage.php.

WikiPage::$mLatest = false

{

Access:
protected

Definition at line 48 of file WikiPage.php.

WikiPage::$mPreparedEdit = false

{

Access:
protected

Definition at line 49 of file WikiPage.php.

Title WikiPage::$mRedirectTarget = null [protected]

Definition at line 58 of file WikiPage.php.

WikiPage::$mTimestamp = ''

Definition at line 66 of file WikiPage.php.

Title WikiPage::$mTitle = null

Definition at line 41 of file WikiPage.php.

string WikiPage::$mTouched = '19700101000000' [protected]

Definition at line 70 of file WikiPage.php.

WikiPage::int [protected]

one of the READ_* constants

Definition at line 54 of file WikiPage.php.

WikiPage::string [protected]

timestamp of the current revision or empty string if not loaded

Definition at line 66 of file WikiPage.php.


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