Docs For Class JMediawikiPages

JMediawikiPages

Description

MediaWiki API Pages class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/mediawiki/pages.php (line 19)

JMediawikiObject
   |
   --JMediawikiPages

Method Summary

object changeProtection (string $title, string $protections, [string $expiry = null], [string $reason = null], [string $cascade = null], [string $watchlist = null])

object deletePageByID (string $pageid, [string $reason = null], [string $watchlist = null], [string $oldimage = null])

object deletePageByName (string $title, [string $reason = null], [string $watchlist = null], [string $oldimage = null])

object editPage (string $title, [int $section = null], [string $sectiontitle = null], [string $text = null], [string $summary = null])

object getBackLinks (string $bltitle, [integer $blpageid = null], [boolean $blcontinue = null], [array $blnamespace = null], [string $blfilterredirect = null], [integer $bllimit = null], [boolean $blredirect = null])

object getIWBackLinks (string $iwbltitle, [string $iwblprefix = null], [boolean $iwblcontinue = null], [integer $iwbllimit = null], [array $iwblprop = null])

object getPageInfo (array $titles, [array $inprop = null], [array $intoken = null], [boolean $incontinue = null])

object getPageProperties (array $titles, [boolean $ppcontinue = null], [string $ppprop = null])

object getPageTemplates (array $titles, [array $tlnamespace = null], [integer $tllimit = null], [boolean $tlcontinue = null], [string $tltemplates = null], [string $tldir = null])

object getRevisions (array $titles, [array $rvprop = null], [boolean $rvparse = null], [int $rvlimit = null])

object getToken (string $user, string $intoken)

object movePageByID (int $fromid, string $to, [string $reason = null], [string $movetalk = null], [string $movesubpages = null], [boolean $noredirect = null], [string $watchlist = null], [boolean $ignorewarnings = null])

object movePageByName (string $from, string $to, [string $reason = null], [string $movetalk = null], [string $movesubpages = null], [boolean $noredirect = null], [string $watchlist = null], [boolean $ignorewarnings = null])

object rollback (string $title, string $user, [string $summary = null], [string $markbot = null], [string $watchlist = null])

object undeletePage (string $title, [string $reason = null], [string $timestamp = null], [string $watchlist = null])

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

changeProtection (line 302)

Method to change the protection level of a page.

since: 12.3
access: public

object changeProtection (string $title, string $protections, [string $expiry = null], [string $reason = null], [string $cascade = null], [string $watchlist = null])

string $title: Title of the page you want to (un)protect.
string $protections: Pipe-separated list of protection levels.
string $expiry: Expiry timestamps.
string $reason: Reason for (un)protecting (optional).
string $cascade: Enable cascading protection.
string $watchlist: Unconditionally add or remove the page from your watchlist.

deletePageByID (line 105)

Method to delete a page.

since: 12.3
access: public

object deletePageByID (string $pageid, [string $reason = null], [string $watchlist = null], [string $oldimage = null])

string $pageid: Page ID of the page you want to delete.
string $reason: Reason for the deletion.
string $watchlist: Unconditionally add or remove the page from your watchlis.
string $oldimage: The name of the old image to delete.

deletePageByName (line 70)

Method to delete a page.

since: 12.3
access: public

object deletePageByName (string $title, [string $reason = null], [string $watchlist = null], [string $oldimage = null])

string $title: Title of the page you want to delete.
string $reason: Reason for the deletion.
string $watchlist: Unconditionally add or remove the page from your watchlis.
string $oldimage: The name of the old image to delete.

editPage (line 34)

Method to edit a page.

since: 12.3
access: public

object editPage (string $title, [int $section = null], [string $sectiontitle = null], [string $text = null], [string $summary = null])

string $title: Page title.
int $section: Section number.
string $sectiontitle: The title for a new section.
string $text: Page content.
string $summary: Title of the page you want to delete.

getBackLinks (line 512)

Method to get all pages that link to the given page.

since: 12.3
access: public

string $bltitle: Title to search.
integer $blpageid: Pageid to search.
boolean $blcontinue: When more results are available, use this to continue.
array $blnamespace: The namespace to enumerate.
string $blfilterredirect: How to filter for redirects..
integer $bllimit: How many total pages to return.
boolean $blredirect: If linking page is a redirect, find all pages that link to that redirect as well.

getIWBackLinks (line 572)

Method to get all pages that link to the given interwiki link.

since: 12.3
access: public

object getIWBackLinks (string $iwbltitle, [string $iwblprefix = null], [boolean $iwblcontinue = null], [integer $iwbllimit = null], [array $iwblprop = null])

string $iwbltitle: Interwiki link to search for. Must be used with iwblprefix.
string $iwblprefix: Prefix for the interwiki.
boolean $iwblcontinue: When more results are available, use this to continue.
integer $iwbllimit: How many total pages to return.
array $iwblprop: Which properties to get.

getPageInfo (line 339)

Method to get basic page information.

since: 12.3
access: public

object getPageInfo (array $titles, [array $inprop = null], [array $intoken = null], [boolean $incontinue = null])

array $titles: Page titles to retrieve info.
array $inprop: Which additional properties to get.
array $intoken: Request a token to perform a data-modifying action on a page
boolean $incontinue: When more results are available, use this to continue.

getPageProperties (line 379)

Method to get various properties defined in the page content.

since: 12.3
access: public

object getPageProperties (array $titles, [boolean $ppcontinue = null], [string $ppprop = null])

array $titles: Page titles to retrieve properties.
boolean $ppcontinue: When more results are available, use this to continue.
string $ppprop: Page prop to look on the page for.

getPageTemplates (line 458)

Method to get all page templates from the given page.

since: 12.3
access: public

object getPageTemplates (array $titles, [array $tlnamespace = null], [integer $tllimit = null], [boolean $tlcontinue = null], [string $tltemplates = null], [string $tldir = null])

array $titles: Page titles to retrieve templates.
array $tlnamespace: Show templates in this namespace(s) only.
integer $tllimit: How many templates to return.
boolean $tlcontinue: When more results are available, use this to continue.
string $tltemplates: Only list these templates.
string $tldir: The direction in which to list.

getRevisions (line 415)

Method to get a list of revisions.

since: 12.3
access: public

object getRevisions (array $titles, [array $rvprop = null], [boolean $rvparse = null], [int $rvlimit = null])

array $titles: Page titles to retrieve revisions.
array $rvprop: Which properties to get for each revision.
boolean $rvparse: Parse revision content.
int $rvlimit: Limit how many revisions will be returned.

getToken (line 618)

Method to get access token.

since: 12.1
access: public

object getToken (string $user, string $intoken)

string $user: The User to get token.
string $intoken: The type of token.

movePageByID (line 223)

Method to move a page.

since: 12.3
access: public

int $fromid: Page ID of the page you want to move.
string $to: Title you want to rename the page to.
string $reason: Reason for the move (optional).
string $movetalk: Move the talk page, if it exists.
string $movesubpages: Move subpages, if applicable.
boolean $noredirect: Don't create a redirect.
string $watchlist: Unconditionally add or remove the page from your watchlist.
boolean $ignorewarnings: Ignore any warnings.

movePageByName (line 179)

Method to move a page.

since: 12.3
access: public

string $from: Title of the page you want to move.
string $to: Title you want to rename the page to.
string $reason: Reason for the move (optional).
string $movetalk: Move the talk page, if it exists.
string $movesubpages: Move subpages, if applicable.
boolean $noredirect: Don't create a redirect.
string $watchlist: Unconditionally add or remove the page from your watchlist.
boolean $ignorewarnings: Ignore any warnings.

rollback (line 264)

Method to undo the last edit to the page.

since: 12.3
access: public

object rollback (string $title, string $user, [string $summary = null], [string $markbot = null], [string $watchlist = null])

string $title: Title of the page you want to rollback.
string $user: Name of the user whose edits are to be rolled back.
string $summary: Custom edit summary. If not set, default summary will be used.
string $markbot: Mark the reverted edits and the revert as bot edits.
string $watchlist: Unconditionally add or remove the page from your watchlist.

undeletePage (line 140)

Method to restore certain revisions of a deleted page.

since: 12.3
access: public

object undeletePage (string $title, [string $reason = null], [string $timestamp = null], [string $watchlist = null])

string $title: Title of the page you want to restore.
string $reason: Reason for restoring (optional).
string $timestamp: Timestamps of the revisions to restore.
string $watchlist: Unconditionally add or remove the page from your watchlist.

Inherited Methods

Inherited From JMediawikiObject

JMediawikiObject::__construct()
JMediawikiObject::buildParameter()
JMediawikiObject::fetchUrl()
JMediawikiObject::validateResponse()

Documentation generated on Tue, 19 Nov 2013 15:10:06 +0100 by phpDocumentor 1.4.3