Class JMediawikiLinks
MediaWiki API Links class for the Joomla Platform.
-
JMediawikiObject
-
JMediawikiLinks
Methods summary
public
object
|
#
getLinks( array $titles, array $plnamespace = null, string $pllimit = null, string $plcontinue = null, array $pltitles = null, string $pldir = null )
Method to return all links from the given page(s).
Method to return all links from the given page(s).
Parameters
- $titles
array - $titles Page titles to retrieve links.- $plnamespace
array - $plnamespace Namespaces to get links.- $pllimit
string - $pllimit Number of links to return.- $plcontinue
string - $plcontinue Continue when more results are available.- $pltitles
array - $pltitles List links to these titles.- $pldir
string - $pldir Direction of listing. Returns
object
Since
12.3
|
public
object
|
#
getLinksUsed( array $titles )
Method to return info about the link pages.
Method to return info about the link pages.
Parameters
- $titles
array - $titles Page titles to retrieve links. Returns
object
Since
12.3
|
public
object
|
#
getIWLinks( array $titles, boolean $iwurl = false, integer $iwlimit = null, boolean $iwcontinue = false, string $iwprefix = null, string $iwtitle = null, string $iwdir = null )
Method to return all interwiki links from the given page(s).
Method to return all interwiki links from the given page(s).
Parameters
- $titles
array - $titles Page titles to retrieve links.- $iwurl
boolean - $iwurl Whether to get the full url.- $iwlimit
integer - $iwlimit Number of interwiki links to return.- $iwcontinue
boolean - $iwcontinue When more results are available, use this to continue.- $iwprefix
string - $iwprefix Prefix for the interwiki.- $iwtitle
string - $iwtitle Interwiki link to search for.- $iwdir
string - $iwdir The direction in which to list. Returns
object
Since
12.3
|
public
object
|
#
getLangLinks( array $titles, integer $lllimit = null, boolean $llcontinue = false, string $llurl = null, string $lllang = null, string $lltitle = null, string $lldir = null )
Method to return all interlanguage links from the given page(s).
Method to return all interlanguage links from the given page(s).
Parameters
- $titles
array - $titles Page titles to retrieve links.- $lllimit
integer - $lllimit Number of langauge links to return.- $llcontinue
boolean - $llcontinue When more results are available, use this to continue.- $llurl
string - $llurl Whether to get the full URL.- $lllang
string - $lllang Language code.- $lltitle
string - $lltitle Link to search for.- $lldir
string - $lldir The direction in which to list. Returns
object
Since
12.3
|
public
object
|
#
getExtLinks( array $titles, integer $ellimit = null, string $eloffset = null, string $elprotocol = null, string $elquery = null )
Method to return all external urls from the given page(s).
Method to return all external urls from the given page(s).
Parameters
- $titles
array - $titles Page titles to retrieve links.- $ellimit
integer - $ellimit Number of links to return.- $eloffset
string - $eloffset When more results are available, use this to continue.- $elprotocol
string - $elprotocol Protocol of the url.- $elquery
string - $elquery Search string without protocol. Returns
object
Since
12.3
|
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 )
Method to enumerate all links that point to a given namespace.
Method to enumerate all links that point to a given namespace.
Parameters
- $alcontinue
boolean - $alcontinue When more results are available, use this to continue.- $alfrom
string - $alfrom Start listing at this title. The title need not exist.- $alto
string - $alto The page title to stop enumerating at.- $alprefix
string - $alprefix Search for all page titles that begin with this value.- $alunique
string - $alunique Only show unique links.- $alprop
array - $alprop What pieces of information to include.- $alnamespace
string - $alnamespace The namespace to enumerate.- $allimit
integer - $allimit Number of links to return. Returns
object
Since
12.3
|
__construct(),
buildParameter(),
fetchUrl(),
validateResponse()
Magic methods summary
Properties summary
$client,
$options
