JMediawikiImages

Extends \JMediawikiObject

MediaWiki API Images class for the Joomla Platform.

since

3.1.4

package

Joomla.Platform

Methods

__construct

Constructor.

__construct(\Joomla\Registry\Registry $options = null, \JMediawikiHttp $client = null) 
inherited
since

3.1.4

Arguments

$options

\Joomla\Registry\RegistryMediawiki options object.

$client

\JMediawikiHttpThe HTTP client object.

buildParameter

Method to build request parameters from a string array.

buildParameter(array $params) : string
inherited
since

3.1.4

Arguments

$params

arraystring array that contains the parameters

Response

stringrequest parameter

enumerateImages

Method to enumerate all images.

enumerateImages(string $aifrom = null, string $aito = null, string $aiprefix = null, integer $aiminsize = null, integer $aimaxsize = null, integer $ailimit = null, string $aidir = null, string $aisha1 = null, string $aisha1base36 = null, array $aiprop = null, string $aimime = null) : object
since

3.1.4

Arguments

$aifrom

stringThe image title to start enumerating from.

$aito

stringThe image title to stop enumerating at.

$aiprefix

stringSearch for all image titles that begin with this value.

$aiminsize

integerLimit to images with at least this many bytes.

$aimaxsize

integerLimit to images with at most this many bytes.

$ailimit

integerHow many images in total to return.

$aidir

stringThe direction in which to list.

$aisha1

stringSHA1 hash of image.

$aisha1base36

stringSHA1 hash of image in base 36.

$aiprop

arrayWhat image information to get.

$aimime

stringWhat MIME type to search for.

Response

object

fetchUrl

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

fetchUrl(string $path) : string
inherited
since

3.1.4

Arguments

$path

stringURL to inflect

Response

stringThe request URL.

getImageInfo

Method to get all image information and upload history.

getImageInfo(array $liprop = null, integer $lilimit = null, string $listart = null, string $liend = null, integer $liurlwidth = null, integer $liurlheight = null, string $limetadataversion = null, string $liurlparam = null, boolean $licontinue = null) : object
since

3.1.4

Arguments

$liprop

arrayWhat image information to get.

$lilimit

integerHow many image revisions to return.

$listart

stringTimestamp to start listing from.

$liend

stringTimestamp to stop listing at.

$liurlwidth

integerURL to an image scaled to this width will be returned..

$liurlheight

integerURL to an image scaled to this height will be returned.

$limetadataversion

stringVersion of metadata to use.

$liurlparam

stringA handler specific parameter string.

$licontinue

booleanWhen more results are available, use this to continue.

Response

object

getImages

Method to get all images contained on the given page(s).

getImages(array $titles, integer $imagelimit = null, boolean $imagecontinue = null, integer $imimages = null, string $imdir = null) : object
since

3.1.4

Arguments

$titles

arrayPage titles to retrieve images.

$imagelimit

integerHow many images to return.

$imagecontinue

booleanWhen more results are available, use this to continue.

$imimages

integerOnly list these images.

$imdir

stringThe direction in which to list.

Response

object

getImagesUsed

Method to get all images contained on the given page(s).

getImagesUsed(array $titles) : object
since

3.1.4

Arguments

$titles

arrayPage titles to retrieve links.

Response

object

validateResponse

Method to validate response for errors

validateResponse(\JHttpresponse $response) : Object
inherited
since

3.1.4

throws

\DomainException

Arguments

$response

\JHttpresponsereponse from the mediawiki server

Response

Object

Properties

options

Options for the MediaWiki object.

inherited
since

3.1.4

Type(s)

\Joomla\Registry\Registry

client

The HTTP client object to use in sending HTTP requests.

inherited
since

3.1.4

Type(s)

\JMediawikiHttp