JMediawikiImages

class JMediawikiImages extends JMediawikiObject

MediaWiki API Images class for the Joomla Platform.

Methods

__construct( Registry $options = null, JMediawikiHttp $client = null)

Constructor.

from JMediawikiObject
string
buildParameter( array $params)

Method to build request parameters from a string array.

from JMediawikiObject
Object
validateResponse( JHttpresponse $response)

Method to validate response for errors

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

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

object
getImagesUsed( array $titles)

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

object
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)

Method to get all image information and upload history.

object
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)

Method to enumerate all images.

Details

__construct( Registry $options = null, JMediawikiHttp $client = null)

Constructor.

Parameters

Registry $options Mediawiki options object.
JMediawikiHttp $client The HTTP client object.

string buildParameter( array $params)

Method to build request parameters from a string array.

Parameters

array $params string array that contains the parameters

Return Value

string request parameter

Object validateResponse( JHttpresponse $response)

Method to validate response for errors

Parameters

JHttpresponse $response reponse from the mediawiki server

Return Value

Object

Exceptions

DomainException

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

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

Parameters

array $titles Page titles to retrieve images.
integer $imagelimit How many images to return.
boolean $imagecontinue When more results are available, use this to continue.
integer $imimages Only list these images.
string $imdir The direction in which to list.

Return Value

object

object getImagesUsed( array $titles)

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

Parameters

array $titles Page titles to retrieve links.

Return Value

object

object 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)

Method to get all image information and upload history.

Parameters

array $liprop What image information to get.
integer $lilimit How many image revisions to return.
string $listart Timestamp to start listing from.
string $liend Timestamp to stop listing at.
integer $liurlwidth URL to an image scaled to this width will be returned..
integer $liurlheight URL to an image scaled to this height will be returned.
string $limetadataversion Version of metadata to use.
string $liurlparam A handler specific parameter string.
boolean $licontinue When more results are available, use this to continue.

Return Value

object

object 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)

Method to enumerate all images.

Parameters

string $aifrom The image title to start enumerating from.
string $aito The image title to stop enumerating at.
string $aiprefix Search for all image titles that begin with this value.
integer $aiminsize Limit to images with at least this many bytes.
integer $aimaxsize Limit to images with at most this many bytes.
integer $ailimit How many images in total to return.
string $aidir The direction in which to list.
string $aisha1 SHA1 hash of image.
string $aisha1base36 SHA1 hash of image in base 36.
array $aiprop What image information to get.
string $aimime What MIME type to search for.

Return Value

object