Référence de la classe JMediawikiPages

Graphe d'héritage de JMediawikiPages:

Fonctions membres publiques
	editPage ($title, $section=null, $sectiontitle=null, $text=null, $summary=null)
	deletePageByName ($title, $reason=null, $watchlist=null, $oldimage=null)
	deletePageById ($pageid, $reason=null, $watchlist=null, $oldimage=null)
	undeletePage ($title, $reason=null, $timestamp=null, $watchlist=null)
	movePageByName ($from, $to, $reason=null, $movetalk=null, $movesubpages=null, $noredirect=null, $watchlist=null, $ignorewarnings=null)
	movePageById ($fromid, $to, $reason=null, $movetalk=null, $movesubpages=null, $noredirect=null, $watchlist=null, $ignorewarnings=null)
	rollback ($title, $user, $summary=null, $markbot=null, $watchlist=null)
	changeProtection ($title, $protections, $expiry=null, $reason=null, $cascade=null, $watchlist=null)
	getPageInfo (array $titles, array $inprop=null, array $intoken=null, $incontinue=null)
	getPageProperties (array $titles, $ppcontinue=null, $ppprop=null)
	getRevisions (array $titles, array $rvprop=null, $rvparse=null, $rvlimit=null)
	getPageTemplates (array $titles, array $tlnamespace=null, $tllimit=null, $tlcontinue=null, $tltemplates=null, $tldir=null)
	getBackLinks ($bltitle, $blpageid=null, $blcontinue=null, array $blnamespace=null, $blfilterredirect=null, $bllimit=null, $blredirect=null)
	getIWBackLinks ($iwbltitle, $iwblprefix=null, $iwblcontinue=null, $iwbllimit=null, array $iwblprop=null)
	getToken ($user, $intoken)
Fonctions membres publiques hérités de JMediawikiObject
	__construct (Registry $options=null, JMediawikiHttp $client=null)
	buildParameter (array $params)
	validateResponse ($response)

Membres hérités additionnels
Fonctions membres protégées hérités de JMediawikiObject
	fetchUrl ($path)
Attributs protégés hérités de JMediawikiObject
	$options
	$client

Description détaillée

MediaWiki API Pages class for the Joomla Platform.

Depuis

3.1.4

Documentation des fonctions membres

changeProtection()

changeProtection	(		$title,
			$protections,
			$expiry = null,
			$reason = null,
			$cascade = null,
			$watchlist = null
	)

Method to change the protection level of a page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, et $title.

deletePageById()

deletePageById	(		$pageid,
			$reason = null,
			$watchlist = null,
			$oldimage = null
	)

Method to delete a page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, et $path.

deletePageByName()

deletePageByName	(		$title,
			$reason = null,
			$watchlist = null,
			$oldimage = null
	)

Method to delete a page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, et $title.

editPage()

editPage	(		$title,
			$section = null,
			$sectiontitle = null,
			$text = null,
			$summary = null
	)

Method to edit a page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, $section, $text, et $title.

getBackLinks()

getBackLinks	(		$bltitle,
			$blpageid = null,
			$blcontinue = null,
		array	$blnamespace = null,
			$blfilterredirect = null,
			$bllimit = null,
			$blredirect = null
	)

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

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $path.

getIWBackLinks()

getIWBackLinks	(		$iwbltitle,
			$iwblprefix = null,
			$iwblcontinue = null,
			$iwbllimit = null,
		array	$iwblprop = null
	)

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

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $path.

getPageInfo()

getPageInfo	(	array	$titles,
		array	$inprop = null,
		array	$intoken = null,
			$incontinue = null
	)

Method to get basic page information.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $path.

getPageProperties()

getPageProperties	(	array	$titles,
			$ppcontinue = null,
			$ppprop = null
	)

Method to get various properties defined in the page content.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $path.

getPageTemplates()

getPageTemplates	(	array	$titles,
		array	$tlnamespace = null,
			$tllimit = null,
			$tlcontinue = null,
			$tltemplates = null,
			$tldir = null
	)

Method to get all page templates from the given page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $path.

getRevisions()

getRevisions	(	array	$titles,
		array	$rvprop = null,
			$rvparse = null,
			$rvlimit = null
	)

Method to get a list of revisions.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $path.

getToken()

getToken	(		$user,
			$intoken
	)

Method to get access token.

Paramètres

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

Renvoie

object

Depuis

3.0.0

Références $path, $user, et null.

movePageById()

movePageById	(		$fromid,
			$to,
			$reason = null,
			$movetalk = null,
			$movesubpages = null,
			$noredirect = null,
			$watchlist = null,
			$ignorewarnings = null
	)

Method to move a page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, et $path.

movePageByName()

movePageByName	(		$from,
			$to,
			$reason = null,
			$movetalk = null,
			$movesubpages = null,
			$noredirect = null,
			$watchlist = null,
			$ignorewarnings = null
	)

Method to move a page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, et $path.

rollback()

rollback	(		$title,
			$user,
			$summary = null,
			$markbot = null,
			$watchlist = null
	)

Method to undo the last edit to the page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, $title, et $user.

undeletePage()

undeletePage	(		$title,
			$reason = null,
			$timestamp = null,
			$watchlist = null
	)

Method to restore certain revisions of a deleted page.

Paramètres

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.

Renvoie

object

Depuis

3.1.4

Références $data, $path, et $title.

---

La documentation de cette classe a été générée à partir du fichier suivant :

• pages.php