Links
Extends AbstractMediawikiObjectMediaWiki API Links class.
since |
1.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
Mediawiki options object.- client
\Joomla\Mediawiki\Http
The HTTP client object.
Response
mixed
buildParameter
Method to build request parameters from a string array.
buildParameter(array params) : string
since |
1.0 |
---|
Arguments
- params
array
string array that contains the parameters
Response
string
request parameter
enumerateLinks
Method to enumerate all links that point to a given namespace.
enumerateLinks(bool alcontinue = false, string alfrom = null, string alto = null, string alprefix = null, string alunique = null, array alprop = null, string alnamespace = null, int allimit = null) : object
since |
1.0 |
---|
Arguments
- alcontinue
bool
When more results are available, use this to continue.- alfrom
string
Start listing at this title. The title need not exist.- alto
string
The page title to stop enumerating at.- alprefix
string
Search for all page titles that begin with this value.- alunique
string
Only show unique links.- alprop
array
What pieces of information to include.- alnamespace
string
The namespace to enumerate.- allimit
int
Number of links to return.
Response
object
fetchUrl
Method to build and return a full request URL for the request.
fetchUrl(string path) : string
since |
1.0 |
---|
Arguments
- path
string
URL to inflect
Response
string
The request URL.
getExtLinks
Method to return all external urls from the given page(s).
getExtLinks(array titles, int ellimit = null, string eloffset = null, string elprotocol = null, string elquery = null) : object
since |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve links.- ellimit
int
Number of links to return.- eloffset
string
When more results are available, use this to continue.- elprotocol
string
Protocol of the url.- elquery
string
Search string without protocol.
Response
object
getIWLinks
Method to return all interwiki links from the given page(s).
getIWLinks(array titles, bool iwurl = false, int iwlimit = null, bool iwcontinue = false, string iwprefix = null, string iwtitle = null, string iwdir = null) : object
since |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve links.- iwurl
bool
Whether to get the full url.- iwlimit
int
Number of interwiki links to return.- iwcontinue
bool
When more results are available, use this to continue.- iwprefix
string
Prefix for the interwiki.- iwtitle
string
Interwiki link to search for.- iwdir
string
The direction in which to list.
Response
object
getLangLinks
Method to return all interlanguage links from the given page(s).
getLangLinks(array titles, int lllimit = null, bool llcontinue = false, string llurl = null, string lllang = null, string lltitle = null, string lldir = null) : object
since |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve links.- lllimit
int
Number of langauge links to return.- llcontinue
bool
When more results are available, use this to continue.- llurl
string
Whether to get the full URL.- lllang
string
Language code.- lltitle
string
Link to search for.- lldir
string
The direction in which to list.
Response
object
getLinks
Method to return all links from the given page(s).
getLinks(array titles, array plnamespace = null, string pllimit = null, string plcontinue = null, array pltitles = null, string pldir = null) : object
since |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve links.- plnamespace
array
Namespaces to get links.- pllimit
string
Number of links to return.- plcontinue
string
Continue when more results are available.- pltitles
array
List links to these titles.- pldir
string
Direction of listing.
Response
object
getLinksUsed
Method to return info about the link pages.
getLinksUsed(array titles) : object
since |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve links.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response from the mediawiki server.
Response
\SimpleXMLElement
Properties
options
Options for the Mediawiki object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Mediawiki\Http