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	$alcontinue	When more results are available, use this to continue.
string	$alfrom	Start listing at this title. The title need not exist.
string	$alto	The page title to stop enumerating at.
string	$alprefix	Search for all page titles that begin with this value.
string	$alunique	Only show unique links.
array	$alprop	What pieces of information to include.
string	$alnamespace	The namespace to enumerate.
integer	$allimit	Number 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	$titles	Page titles to retrieve links.
integer	$ellimit	Number of links to return.
string	$eloffset	When more results are available, use this to continue.
string	$elprotocol	Protocol of the url.
string	$elquery	Search 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	$titles	Page titles to retrieve links.
boolean	$iwurl	Whether to get the full url.
integer	$iwlimit	Number of interwiki links to return.
boolean	$iwcontinue	When more results are available, use this to continue.
string	$iwprefix	Prefix for the interwiki.
string	$iwtitle	Interwiki link to search for.
string	$iwdir	The 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	$titles	Page titles to retrieve links.
integer	$lllimit	Number of language links to return.
boolean	$llcontinue	When more results are available, use this to continue.
string	$llurl	Whether to get the full URL.
string	$lllang	Language code.
string	$lltitle	Link to search for.
string	$lldir	The 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	$titles	Page titles to retrieve links.
array	$plnamespace	Namespaces to get links.
string	$pllimit	Number of links to return.
string	$plcontinue	Continue when more results are available.
array	$pltitles	List links to these titles.
string	$pldir	Direction 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

$titles

Page 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 :

• libraries/joomla/mediawiki/links.php