Docs For Class JMediawikiImages

Description

MediaWiki API Images class for the Joomla Platform.

since: 12.3

Located in /libraries/joomla/mediawiki/images.php (line 19)

JMediawikiObject
   |
   --JMediawikiImages

Method Summary

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

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

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

object getImagesUsed (array $titles)

Variables

Inherited Variables

Inherited from JMediawikiObject

JMediawikiObject::$client
JMediawikiObject::$options

Methods

enumerateImages (line 185)

Method to enumerate all images.

since: 12.3
access: public

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

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.

getImageInfo (line 109)

Method to get all image information and upload history.

since: 12.3
access: public

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

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.

getImages (line 35)

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

since: 12.3
access: public

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

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.

getImagesUsed (line 78)

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

since: 12.3
access: public

object getImagesUsed (array $titles)

array $titles: Page titles to retrieve links.

Inherited Methods

Inherited From JMediawikiObject

JMediawikiObject::__construct()
JMediawikiObject::buildParameter()
JMediawikiObject::fetchUrl()
JMediawikiObject::validateResponse()