Graphe d'héritage de JMediawikiImages:

Graphe de collaboration 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 inherited from JMediawikiObject
	__construct (JRegistry $options=null, JMediawikiHttp $client=null)
	buildParameter (array $params)
	validateResponse ($response)

Additional Inherited Members
Fonctions membres protégées inherited from JMediawikiObject
	fetchUrl ($path)
Attributs protégés inherited from JMediawikiObject
	$options
	$client

Description détaillée

Définition à la ligne 19 du fichier images.php.

Documentation des fonctions membres

JMediawikiImages::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	$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.

Renvoie:: object

Depuis:: 12.3

Définition à la ligne 185 du fichier images.php.

        {
                // Build the request.
                $path = '?action=query&list=allimages';
                if (isset($aifrom))
                {
                        $path .= '&aifrom=' . $aifrom;
                }
                if (isset($aito))
                {
                        $path .= '&aito=' . $aito;
                }
                if (isset($aiprefix))
                {
                        $path .= '&aiprefix=' . $aiprefix;
                }
                if (isset($aiminsize))
                {
                        $path .= '&aiminsize=' . $aiminsize;
                }
                if (isset($aimaxsize))
                {
                        $path .= '&aimaxsize=' . $aimaxsize;
                }
                if (isset($ailimit))
                {
                        $path .= '&ailimit=' . $ailimit;
                }
                if (isset($aidir))
                {
                        $path .= '&aidir=' . $aidir;
                }
                if (isset($aisha1))
                {
                        $path .= '&aisha1=' . $aisha1;
                }
                if (isset($aisha1base36))
                {
                        $path .= '&$aisha1base36=' . $aisha1base36;
                }
                if (isset($aiprop))
                {
                        $path .= '&aiprop=' . $this->buildParameter($aiprop);
                }
                if (isset($aimime))
                {
                        $path .= '&aimime=' . $aimime;
                }
                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));
                return $this->validateResponse($response);
        }

JMediawikiImages::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	$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.

Renvoie:: object

Depuis:: 12.3

Définition à la ligne 109 du fichier images.php.

        {
                // Build the request.
                $path = '?action=query&prop=imageinfo';
                if (isset($liprop))
                {
                        $path .= '&liprop=' . $this->buildParameter($liprop);
                }
                if (isset($lilimit))
                {
                        $path .= '&lilimit=' . $lilimit;
                }
                if (isset($listart))
                {
                        $path .= '&listart=' . $listart;
                }
                if (isset($liend))
                {
                        $path .= '&liend=' . $liend;
                }
                if (isset($liurlwidth))
                {
                        $path .= '&liurlwidth=' . $liurlwidth;
                }
                if (isset($liurlheight))
                {
                        $path .= '&liurlheight=' . $liurlheight;
                }
                if (isset($limetadataversion))
                {
                        $path .= '&limetadataversion=' . $limetadataversion;
                }
                if (isset($liurlparam))
                {
                        $path .= '&liurlparam=' . $liurlparam;
                }
                if ($licontinue)
                {
                        $path .= '&alcontinue=';
                }
                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));
                return $this->validateResponse($response);
        }

JMediawikiImages::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	$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.

Renvoie:: object

Depuis:: 12.3

Définition à la ligne 35 du fichier images.php.

        {
                // Build the request.
                $path = '?action=query&prop=images';
                // Append titles to the request.
                $path .= '&titles=' . $this->buildParameter($titles);
                if (isset($imagelimit))
                {
                        $path .= '&imagelimit=' . $imagelimit;
                }
                if ($imagecontinue)
                {
                        $path .= '&imagecontinue=';
                }
                if (isset($imimages))
                {
                        $path .= '&imimages=' . $imimages;
                }
                if (isset($imdir))
                {
                        $path .= '&imdir=' . $imdir;
                }
                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));
                return $this->validateResponse($response);
        }

JMediawikiImages::getImagesUsed ( array $titles )

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

Paramètres:

array $titles Page titles to retrieve links.

Renvoie:: object

Depuis:: 12.3

Définition à la ligne 78 du fichier images.php.

        {
                // Build the request.
                $path = '?action=query&generator=images&prop=info';
                // Append titles to the request.
                $path .= '&titles=' . $this->buildParameter($titles);
                // Send the request.
                $response = $this->client->get($this->fetchUrl($path));
                return $this->validateResponse($response);
        }

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

jplatform-13.1/joomla/mediawiki/images.php

Fonctions membres publiques

Additional Inherited Members

Description détaillée

Documentation des fonctions membres