Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
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
12.3

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$titleTitle of the page you want to (un)protect.
string$protectionsPipe-separated list of protection levels.
string$expiryExpiry timestamps.
string$reasonReason for (un)protecting (optional).
string$cascadeEnable cascading protection.
string$watchlistUnconditionally add or remove the page from your watchlist.
Renvoie
object
Depuis
12.3

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

◆ deletePageById()

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

Method to delete a page.

Paramètres
string$pageidPage ID of the page you want to delete.
string$reasonReason for the deletion.
string$watchlistUnconditionally add or remove the page from your watchlis.
string$oldimageThe name of the old image to delete.
Renvoie
object
Depuis
12.3

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

◆ deletePageByName()

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

Method to delete a page.

Paramètres
string$titleTitle of the page you want to delete.
string$reasonReason for the deletion.
string$watchlistUnconditionally add or remove the page from your watchlis.
string$oldimageThe name of the old image to delete.
Renvoie
object
Depuis
12.3

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$titlePage title.
int$sectionSection number.
string$sectiontitleThe title for a new section.
string$textPage content.
string$summaryTitle of the page you want to delete.
Renvoie
object
Depuis
12.3

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$bltitleTitle to search.
integer$blpageidPageid to search.
boolean$blcontinueWhen more results are available, use this to continue.
array$blnamespaceThe namespace to enumerate.
string$blfilterredirectHow to filter for redirects..
integer$bllimitHow many total pages to return.
boolean$blredirectIf linking page is a redirect, find all pages that link to that redirect as well.
Renvoie
object
Depuis
12.3

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$iwbltitleInterwiki link to search for. Must be used with iwblprefix.
string$iwblprefixPrefix for the interwiki.
boolean$iwblcontinueWhen more results are available, use this to continue.
integer$iwbllimitHow many total pages to return.
array$iwblpropWhich properties to get.
Renvoie
object
Depuis
12.3

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$titlesPage titles to retrieve info.
array$inpropWhich additional properties to get.
array$intokenRequest a token to perform a data-modifying action on a page
boolean$incontinueWhen more results are available, use this to continue.
Renvoie
object
Depuis
12.3

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$titlesPage titles to retrieve properties.
boolean$ppcontinueWhen more results are available, use this to continue.
string$pppropPage prop to look on the page for.
Renvoie
object
Depuis
12.3

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$titlesPage titles to retrieve templates.
array$tlnamespaceShow templates in this namespace(s) only.
integer$tllimitHow many templates to return.
boolean$tlcontinueWhen more results are available, use this to continue.
string$tltemplatesOnly list these templates.
string$tldirThe direction in which to list.
Renvoie
object
Depuis
12.3

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$titlesPage titles to retrieve revisions.
array$rvpropWhich properties to get for each revision.
boolean$rvparseParse revision content.
int$rvlimitLimit how many revisions will be returned.
Renvoie
object
Depuis
12.3

Références $path.

◆ getToken()

getToken (   $user,
  $intoken 
)

Method to get access token.

Paramètres
string$userThe User to get token.
string$intokenThe type of token.
Renvoie
object
Depuis
12.1

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$fromidPage ID of the page you want to move.
string$toTitle you want to rename the page to.
string$reasonReason for the move (optional).
string$movetalkMove the talk page, if it exists.
string$movesubpagesMove subpages, if applicable.
boolean$noredirectDon't create a redirect.
string$watchlistUnconditionally add or remove the page from your watchlist.
boolean$ignorewarningsIgnore any warnings.
Renvoie
object
Depuis
12.3

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$fromTitle of the page you want to move.
string$toTitle you want to rename the page to.
string$reasonReason for the move (optional).
string$movetalkMove the talk page, if it exists.
string$movesubpagesMove subpages, if applicable.
boolean$noredirectDon't create a redirect.
string$watchlistUnconditionally add or remove the page from your watchlist.
boolean$ignorewarningsIgnore any warnings.
Renvoie
object
Depuis
12.3

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$titleTitle of the page you want to rollback.
string$userName of the user whose edits are to be rolled back.
string$summaryCustom edit summary. If not set, default summary will be used.
string$markbotMark the reverted edits and the revert as bot edits.
string$watchlistUnconditionally add or remove the page from your watchlist.
Renvoie
object
Depuis
12.3

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$titleTitle of the page you want to restore.
string$reasonReason for restoring (optional).
string$timestampTimestamps of the revisions to restore.
string$watchlistUnconditionally add or remove the page from your watchlist.
Renvoie
object
Depuis
12.3

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


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