Links

Extends AbstractMediawikiObject

MediaWiki API Links class.

since

1.0

package

Joomla Framework

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : mixed
inherited
since

1.0

Arguments

options

\Joomla\Registry\RegistryMediawiki options object.

client

\Joomla\Mediawiki\HttpThe HTTP client object.

Response

mixed

buildParameter

Method to build request parameters from a string array.

buildParameter(array params) : string
inherited
since

1.0

Arguments

params

arraystring array that contains the parameters

Response

stringrequest parameter

fetchUrl

Method to build and return a full request URL for the request.

fetchUrl(string path) : string
inherited
since

1.0

Arguments

path

stringURL to inflect

Response

stringThe request URL.

getLinksUsed

Method to return info about the link pages.

getLinksUsed(array titles) : object
since

1.0

Arguments

titles

arrayPage titles to retrieve links.

Response

object

validateResponse

Method to validate response for errors

validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
inherited
since

1.0

throws

\DomainException

Arguments

response

\Joomla\Http\ResponseThe response from the mediawiki server.

Response

\SimpleXMLElement

Properties

options

Options for the Mediawiki object.

inherited
since

1.0

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

1.0

Type(s)

\Joomla\Mediawiki\Http