Images
Extends AbstractMediawikiObjectMediaWiki API Images class.
since |
1.0 |
---|---|
package |
Joomla Framework |
Methods
__construct
Constructor.
__construct(\Joomla\Registry\Registry options = null, \Joomla\Mediawiki\Http client = null) : mixed
since |
1.0 |
---|
Arguments
- options
\Joomla\Registry\Registry
Mediawiki options object.- client
\Joomla\Mediawiki\Http
The HTTP client object.
Response
mixed
buildParameter
Method to build request parameters from a string array.
buildParameter(array params) : string
since |
1.0 |
---|
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, int aiminsize = null, int aimaxsize = null, int ailimit = null, string aidir = null, string aisha1 = null, string aisha1base36 = null, array aiprop = null, string aimime = null) : object
since |
1.0 |
---|
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
int
Limit to images with at least this many bytes.- aimaxsize
int
Limit to images with at most this many bytes.- ailimit
int
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 |
1.0 |
---|
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, int lilimit = null, string listart = null, string liend = null, int liurlwidth = null, int liurlheight = null, string limetadataversion = null, string liurlparam = null, bool licontinue = null) : object
since |
1.0 |
---|
Arguments
- liprop
array
What image information to get.- lilimit
int
How many image revisions to return.- listart
string
Timestamp to start listing from.- liend
string
Timestamp to stop listing at.- liurlwidth
int
URL to an image scaled to this width will be returned..- liurlheight
int
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
bool
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, int imagelimit = null, bool imagecontinue = null, int imimages = null, string imdir = null) : object
since |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve images.- imagelimit
int
How many images to return.- imagecontinue
bool
When more results are available, use this to continue.- imimages
int
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 |
1.0 |
---|
Arguments
- titles
array
Page titles to retrieve links.
Response
object
validateResponse
Method to validate response for errors
validateResponse(\Joomla\Http\Response response) : \SimpleXMLElement
since |
1.0 |
---|---|
throws |
|
Arguments
- response
\Joomla\Http\Response
The response from the mediawiki server.
Response
\SimpleXMLElement
Properties
options
Options for the Mediawiki object.
since |
1.0 |
---|
Type(s)
\Joomla\Registry\Registry
client
The HTTP client object to use in sending HTTP requests.
since |
1.0 |
---|
Type(s)
\Joomla\Mediawiki\Http