Docs For Class JMediawikiLinks

Description

MediaWiki API Links class for the Joomla Platform.

since: 12.3

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

JMediawikiObject
   |
   --JMediawikiLinks

Method Summary

object enumerateLinks ([boolean $alcontinue = false], [string $alfrom = null], [string $alto = null], [string $alprefix = null], [string $alunique = null], [array $alprop = null], [string $alnamespace = null], [integer $allimit = null])

object getExtLinks (array $titles, [integer $ellimit = null], [string $eloffset = null], [string $elprotocol = null], [string $elquery = null])

object getIWLinks (array $titles, [boolean $iwurl = false], [integer $iwlimit = null], [boolean $iwcontinue = false], [string $iwprefix = null], [string $iwtitle = null], [string $iwdir = null])

object getLangLinks (array $titles, [integer $lllimit = null], [boolean $llcontinue = false], [string $llurl = null], [string $lllang = null], [string $lltitle = null], [string $lldir = null])

object getLinks (array $titles, [array $plnamespace = null], [string $pllimit = null], [string $plcontinue = null], [array $pltitles = null], [string $pldir = null])

object getLinksUsed (array $titles)

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

enumerateLinks (line 279)

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

since: 12.3
access: public

object enumerateLinks ([boolean $alcontinue = false], [string $alfrom = null], [string $alto = null], [string $alprefix = null], [string $alunique = null], [array $alprop = null], [string $alnamespace = null], [integer $allimit = null])

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.

getExtLinks (line 229)

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

since: 12.3
access: public

object getExtLinks (array $titles, [integer $ellimit = null], [string $eloffset = null], [string $elprotocol = null], [string $elquery = null])

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.

getIWLinks (line 113)

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

since: 12.3
access: public

object getIWLinks (array $titles, [boolean $iwurl = false], [integer $iwlimit = null], [boolean $iwcontinue = false], [string $iwprefix = null], [string $iwtitle = null], [string $iwdir = null])

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.

getLangLinks (line 172)

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

since: 12.3
access: public

object getLangLinks (array $titles, [integer $lllimit = null], [boolean $llcontinue = false], [string $llurl = null], [string $lllang = null], [string $lltitle = null], [string $lldir = null])

array $titles: Page titles to retrieve links.
integer $lllimit: Number of langauge 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.

getLinks (line 36)

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

since: 12.3
access: public

object getLinks (array $titles, [array $plnamespace = null], [string $pllimit = null], [string $plcontinue = null], [array $pltitles = null], [string $pldir = null])

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.

getLinksUsed (line 84)

Method to return info about the link pages.

since: 12.3
access: public

object getLinksUsed (array $titles)

array $titles: Page titles to retrieve links.

Inherited Methods

Inherited From JMediawikiObject

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