Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JMediawikiLinks
+ Graphe d'héritage de JMediawikiLinks:

Fonctions membres publiques

 getLinks (array $titles, array $plnamespace=null, $pllimit=null, $plcontinue=null, array $pltitles=null, $pldir=null)
 
 getLinksUsed (array $titles)
 
 getIWLinks (array $titles, $iwurl=false, $iwlimit=null, $iwcontinue=false, $iwprefix=null, $iwtitle=null, $iwdir=null)
 
 getLangLinks (array $titles, $lllimit=null, $llcontinue=false, $llurl=null, $lllang=null, $lltitle=null, $lldir=null)
 
 getExtLinks (array $titles, $ellimit=null, $eloffset=null, $elprotocol=null, $elquery=null)
 
 enumerateLinks ($alcontinue=false, $alfrom=null, $alto=null, $alprefix=null, $alunique=null, array $alprop=null, $alnamespace=null, $allimit=null)
 
- 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 Links class for the Joomla Platform.

Depuis
3.1.4

Documentation des fonctions membres

◆ enumerateLinks()

enumerateLinks (   $alcontinue = false,
  $alfrom = null,
  $alto = null,
  $alprefix = null,
  $alunique = null,
array  $alprop = null,
  $alnamespace = null,
  $allimit = null 
)

Method to enumerate all links that point to a given namespace.

Paramètres
boolean$alcontinueWhen more results are available, use this to continue.
string$alfromStart listing at this title. The title need not exist.
string$altoThe page title to stop enumerating at.
string$alprefixSearch for all page titles that begin with this value.
string$aluniqueOnly show unique links.
array$alpropWhat pieces of information to include.
string$alnamespaceThe namespace to enumerate.
integer$allimitNumber of links to return.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getExtLinks()

getExtLinks ( array  $titles,
  $ellimit = null,
  $eloffset = null,
  $elprotocol = null,
  $elquery = null 
)

Method to return all external urls from the given page(s).

Paramètres
array$titlesPage titles to retrieve links.
integer$ellimitNumber of links to return.
string$eloffsetWhen more results are available, use this to continue.
string$elprotocolProtocol of the url.
string$elquerySearch string without protocol.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getIWLinks()

getIWLinks ( array  $titles,
  $iwurl = false,
  $iwlimit = null,
  $iwcontinue = false,
  $iwprefix = null,
  $iwtitle = null,
  $iwdir = null 
)

Method to return all interwiki links from the given page(s).

Paramètres
array$titlesPage titles to retrieve links.
boolean$iwurlWhether to get the full url.
integer$iwlimitNumber of interwiki links to return.
boolean$iwcontinueWhen more results are available, use this to continue.
string$iwprefixPrefix for the interwiki.
string$iwtitleInterwiki link to search for.
string$iwdirThe direction in which to list.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getLangLinks()

getLangLinks ( array  $titles,
  $lllimit = null,
  $llcontinue = false,
  $llurl = null,
  $lllang = null,
  $lltitle = null,
  $lldir = null 
)

Method to return all interlanguage links from the given page(s).

Paramètres
array$titlesPage titles to retrieve links.
integer$lllimitNumber of language links to return.
boolean$llcontinueWhen more results are available, use this to continue.
string$llurlWhether to get the full URL.
string$lllangLanguage code.
string$lltitleLink to search for.
string$lldirThe direction in which to list.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getLinks()

getLinks ( array  $titles,
array  $plnamespace = null,
  $pllimit = null,
  $plcontinue = null,
array  $pltitles = null,
  $pldir = null 
)

Method to return all links from the given page(s).

Paramètres
array$titlesPage titles to retrieve links.
array$plnamespaceNamespaces to get links.
string$pllimitNumber of links to return.
string$plcontinueContinue when more results are available.
array$pltitlesList links to these titles.
string$pldirDirection of listing.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getLinksUsed()

getLinksUsed ( array  $titles)

Method to return info about the link pages.

Paramètres
array$titlesPage titles to retrieve links.
Renvoie
object
Depuis
3.1.4

Références $path.


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