Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JMediawikiImages
+ Graphe d'héritage de JMediawikiImages:

Fonctions membres publiques

 getImages (array $titles, $imagelimit=null, $imagecontinue=null, $imimages=null, $imdir=null)
 
 getImagesUsed (array $titles)
 
 getImageInfo (array $liprop=null, $lilimit=null, $listart=null, $liend=null, $liurlwidth=null, $liurlheight=null, $limetadataversion=null, $liurlparam=null, $licontinue=null)
 
 enumerateImages ($aifrom=null, $aito=null, $aiprefix=null, $aiminsize=null, $aimaxsize=null, $ailimit=null, $aidir=null, $aisha1=null, $aisha1base36=null, array $aiprop=null, $aimime=null)
 
- Fonctions membres publiques hérités de JMediawikiObject
 __construct (Registry $options=null, JMediawikiHttp $client=null)
 
 buildParameter (array $params)
 
 validateResponse ($response)
 

Membres hérités additionnels

- Fonctions membres protégées hérités de JMediawikiObject
 fetchUrl ($path)
 
- Attributs protégés hérités de JMediawikiObject
 $options
 
 $client
 

Description détaillée

MediaWiki API Images class for the Joomla Platform.

Depuis
3.1.4

Documentation des fonctions membres

◆ enumerateImages()

enumerateImages (   $aifrom = null,
  $aito = null,
  $aiprefix = null,
  $aiminsize = null,
  $aimaxsize = null,
  $ailimit = null,
  $aidir = null,
  $aisha1 = null,
  $aisha1base36 = null,
array  $aiprop = null,
  $aimime = null 
)

Method to enumerate all images.

Paramètres
string$aifromThe image title to start enumerating from.
string$aitoThe image title to stop enumerating at.
string$aiprefixSearch for all image titles that begin with this value.
integer$aiminsizeLimit to images with at least this many bytes.
integer$aimaxsizeLimit to images with at most this many bytes.
integer$ailimitHow many images in total to return.
string$aidirThe direction in which to list.
string$aisha1SHA1 hash of image.
string$aisha1base36SHA1 hash of image in base 36.
array$aipropWhat image information to get.
string$aimimeWhat MIME type to search for.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getImageInfo()

getImageInfo ( array  $liprop = null,
  $lilimit = null,
  $listart = null,
  $liend = null,
  $liurlwidth = null,
  $liurlheight = null,
  $limetadataversion = null,
  $liurlparam = null,
  $licontinue = null 
)

Method to get all image information and upload history.

Paramètres
array$lipropWhat image information to get.
integer$lilimitHow many image revisions to return.
string$listartTimestamp to start listing from.
string$liendTimestamp to stop listing at.
integer$liurlwidthURL to an image scaled to this width will be returned..
integer$liurlheightURL to an image scaled to this height will be returned.
string$limetadataversionVersion of metadata to use.
string$liurlparamA handler specific parameter string.
boolean$licontinueWhen more results are available, use this to continue.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getImages()

getImages ( array  $titles,
  $imagelimit = null,
  $imagecontinue = null,
  $imimages = null,
  $imdir = null 
)

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

Paramètres
array$titlesPage titles to retrieve images.
integer$imagelimitHow many images to return.
boolean$imagecontinueWhen more results are available, use this to continue.
integer$imimagesOnly list these images.
string$imdirThe direction in which to list.
Renvoie
object
Depuis
3.1.4

Références $path.

◆ getImagesUsed()

getImagesUsed ( array  $titles)

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

Paramètres
array$titlesPage titles to retrieve links.
Renvoie
object
Depuis
3.1.4

Références $path.


La documentation de cette classe a été générée à partir du fichier suivant :