JMediawikiImages
Extends \JMediawikiObjectMediaWiki 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)
since |
3.1.4 |
---|
Arguments
- $options
\Joomla\Registry\Registry
Mediawiki options object.- $client
\JMediawikiHttp
The HTTP client object.
buildParameter
Method to build request parameters from a string array.
buildParameter(array $params) : string
since |
3.1.4 |
---|
Arguments
- $params
array
string array that contains the parameters
Response
string
request 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
string
The image title to start enumerating from.- $aito
string
The image title to stop enumerating at.- $aiprefix
string
Search for all image titles that begin with this value.- $aiminsize
integer
Limit to images with at least this many bytes.- $aimaxsize
integer
Limit to images with at most this many bytes.- $ailimit
integer
How many images in total to return.- $aidir
string
The direction in which to list.- $aisha1
string
SHA1 hash of image.- $aisha1base36
string
SHA1 hash of image in base 36.- $aiprop
array
What image information to get.- $aimime
string
What MIME type to search for.
Response
object
fetchUrl
Method to build and return a full request URL for the request.
fetchUrl(string $path) : string
since |
3.1.4 |
---|
Arguments
- $path
string
URL to inflect
Response
string
The 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
array
What image information to get.- $lilimit
integer
How many image revisions to return.- $listart
string
Timestamp to start listing from.- $liend
string
Timestamp to stop listing at.- $liurlwidth
integer
URL to an image scaled to this width will be returned..- $liurlheight
integer
URL to an image scaled to this height will be returned.- $limetadataversion
string
Version of metadata to use.- $liurlparam
string
A handler specific parameter string.- $licontinue
boolean
When 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
array
Page titles to retrieve images.- $imagelimit
integer
How many images to return.- $imagecontinue
boolean
When more results are available, use this to continue.- $imimages
integer
Only list these images.- $imdir
string
The 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
array
Page titles to retrieve links.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\JHttpresponse $response) : Object
since |
3.1.4 |
---|---|
throws |
|
Arguments
- $response
\JHttpresponse
reponse from the mediawiki server
Response
Object
Properties
client
The HTTP client object to use in sending HTTP requests.