Class JMediawikiImages
MediaWiki API Images class for the Joomla Platform.
-
JMediawikiObject
-
JMediawikiImages
Methods summary
public
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).
Method to get all images contained on the given page(s).
Parameters
- $titles
array - $titles Page titles to retrieve images.- $imagelimit
integer - $imagelimit How many images to return.- $imagecontinue
boolean - $imagecontinue When more results are available, use this to continue.- $imimages
integer - $imimages Only list these images.- $imdir
string - $imdir The direction in which to list. Returns
object
Since
12.3
|
public
object
|
#
getImagesUsed( array $titles )
Method to get all images contained on the given page(s).
Method to get all images contained on the given page(s).
Parameters
- $titles
array - $titles Page titles to retrieve links. Returns
object
Since
12.3
|
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 )
Method to get all image information and upload history.
Method to get all image information and upload history.
Parameters
- $liprop
array - $liprop What image information to get.- $lilimit
integer - $lilimit How many image revisions to return.- $listart
string - $listart Timestamp to start listing from.- $liend
string - $liend Timestamp to stop listing at.- $liurlwidth
integer - $liurlwidth URL to an image scaled to this width will be returned..- $liurlheight
integer - $liurlheight URL to an image scaled to this height will be returned.- $limetadataversion
string - $limetadataversion Version of metadata to use.- $liurlparam
string - $liurlparam A handler specific parameter string.- $licontinue
boolean - $licontinue When more results are available, use this to continue. Returns
object
Since
12.3
|
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 )
Method to enumerate all images.
Method to enumerate all images.
Parameters
- $aifrom
string - $aifrom The image title to start enumerating from.- $aito
string - $aito The image title to stop enumerating at.- $aiprefix
string - $aiprefix Search for all image titles that begin with this value.- $aiminsize
integer - $aiminsize Limit to images with at least this many bytes.- $aimaxsize
integer - $aimaxsize Limit to images with at most this many bytes.- $ailimit
integer - $ailimit How many images in total to return.- $aidir
string - $aidir The direction in which to list.- $aisha1
string - $aisha1 SHA1 hash of image.- $aisha1base36
string - $aisha1base36 SHA1 hash of image in base 36.- $aiprop
array - $aiprop What image information to get.- $aimime
string - $aimime What MIME type to search for. Returns
object
Since
12.3
|
__construct(),
buildParameter(),
fetchUrl(),
validateResponse()
Magic methods summary
Properties summary
$client,
$options
