Graphe d'héritage de Image:

Fonctions membres publiques
	__construct ($source=null)

	getHandle ()

	getLogger ()

	setLogger (LoggerInterface $logger)

	getOrientation ()

	generateThumbs ($thumbSizes, $creationMethod=self::SCALE_INSIDE)

	createThumbs ($thumbSizes, $creationMethod=self::SCALE_INSIDE, $thumbsFolder=null)

	crop ($width, $height, $left=null, $top=null, $createNew=true)

	filter ($type, array $options=array())

	getHeight ()

	getWidth ()

	getPath ()

	isLoaded ()

	isTransparent ()

	loadFile ($path)

	resize ($width, $height, $createNew=true, $scaleMethod=self::SCALE_INSIDE)

	cropResize ($width, $height, $createNew=true)

	rotate ($angle, $background=-1, $createNew=true)

	flip ($mode, $createNew=true)

	watermark (Image $watermark, $transparency=50, $bottomMargin=0, $rightMargin=0)

	toFile ($path, $type=IMAGETYPE_JPEG, array $options=array())

	destroy ()

	__destruct ()

	setThumbnailGenerate ($quality=true)

Fonctions membres publiques statiques
static	getImageFileProperties ($path)

Champs de données
const	SCALE_FILL = 1

const	SCALE_INSIDE = 2

const	SCALE_OUTSIDE = 3

const	CROP = 4

const	CROP_RESIZE = 5

const	SCALE_FIT = 6

const	ORIENTATION_LANDSCAPE = 'landscape'

const	ORIENTATION_PORTRAIT = 'portrait'

const	ORIENTATION_SQUARE = 'square'

Fonctions membres protégées
	getFilterInstance ($type)

	prepareDimensions ($width, $height, $scaleMethod)

	sanitizeHeight ($height, $width)

	sanitizeOffset ($offset)

	sanitizeWidth ($width, $height)

Attributs protégés
	$handle

	$path

	$logger

	$generateBestQuality = true

Attributs protégés statiques
static	$formats = array()

Fonctions membres privées
	isValidImage ($handle)

Fonctions membres privées statiques
static	getOrientationString ($width, $height)

Description détaillée

Class to manipulate an image.

Depuis: 1.0

Obsolète:: The joomla/image package is deprecated

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( $source = null )

Class constructor.

Paramètres

mixed $source Either a file path for a source image or a GD resource handler for an image.

Depuis: 1.0

Exceptions

Références $info, elseif, Image\isValidImage(), et Image\loadFile().

◆ __destruct()

__destruct ( )

Method to call the destroy() method one last time to free any memory when the object is unset

Voir également: Image::destroy()

Depuis: 1.0

Références Image\destroy().

Documentation des fonctions membres

◆ createThumbs()

createThumbs	(	$thumbSizes,
		$creationMethod = `self::SCALE_INSIDE`,
		$thumbsFolder = `null`
	)

Method to create thumbnails from the current image and save them to disk. It allows creation by resizing or cropping the original image.

Paramètres

mixed	$thumbSizes	string or array of strings. Example: $thumbSizes = array('150x75','250x150');
integer	$creationMethod	1-3 resize $scaleMethod \| 4 create cropping
string	$thumbsFolder	destination thumbs folder. null generates a thumbs folder in the image folder

Renvoie: array

Depuis: 1.0

Exceptions

Références Image\generateThumbs(), Image\getPath(), Image\isLoaded(), et null.

◆ crop()

crop	(	$width,
		$height,
		$left = `null`,
		$top = `null`,
		$createNew = `true`
	)

Method to crop the current image.

Paramètres

mixed	$width	The width of the image section to crop in pixels or a percentage.
mixed	$height	The height of the image section to crop in pixels or a percentage.
integer	$left	The number of pixels from the left to start cropping.
integer	$top	The number of pixels from the top to start cropping.
boolean	$createNew	If true the current image will be cloned, cropped and returned; else the current image will be cropped and returned.

Renvoie: Image

Depuis: 1.0

Exceptions

Références $color, Image\$handle, $height, $width, Image\destroy(), Image\getHandle(), Image\getHeight(), Image\getWidth(), Image\isTransparent(), null, Image\sanitizeHeight(), Image\sanitizeOffset(), et Image\sanitizeWidth().

Référencé par Image\generateThumbs().

◆ cropResize()

cropResize	(	$width,
		$height,
		$createNew = `true`
	)

Method to crop an image after resizing it to maintain proportions without having to do all the set up work.

Paramètres

integer	$width	The desired width of the image in pixels or a percentage.
integer	$height	The desired height of the image in pixels or a percentage.
integer	$createNew	If true the current image will be cloned, resized, cropped and returned.

Renvoie: Image

Depuis: 1.0

Références $height, $width, Image\getHeight(), Image\getWidth(), null, Image\resize(), Image\sanitizeHeight(), et Image\sanitizeWidth().

Référencé par Image\generateThumbs().

◆ destroy()

destroy ( )

Method to destroy an image handle and free the memory associated with the handle

Renvoie: boolean True on success, false on failure or if no image is loaded

Depuis: 1.0

Références Image\getHandle(), et Image\isLoaded().

Référencé par Image\__destruct(), Image\crop(), Image\flip(), Image\loadFile(), Image\resize(), et Image\rotate().

◆ filter()

filter	(		$type,
		array	$options = `array()`
	)

Method to apply a filter to the image by type. Two examples are: grayscale and sketchy.

Paramètres

string	$type	The name of the image filter to apply.
array	$options	An array of options for the filter.

Renvoie: Image

Depuis: 1.0

Voir également: Joomla

Exceptions

Références $filter, $options, $type, Image\getFilterInstance(), et Image\isLoaded().

◆ flip()

flip	(	$mode,
		$createNew = `true`
	)

Method to flip the current image.

Paramètres

integer	$mode	The flip mode for flipping the image https://www.php.net/imageflip#refsect1-function.imageflip-parameters
boolean	$createNew	If true the current image will be cloned, flipped and returned; else the current image will be flipped and returned.

Renvoie: Image

Depuis: 1.2.0

Exceptions

Références Image\$handle, $mode, Image\destroy(), Image\getHandle(), Image\getHeight(), et Image\getWidth().

◆ generateThumbs()

generateThumbs	(	$thumbSizes,
		$creationMethod = `self::SCALE_INSIDE`
	)

Method to generate thumbnails from the current image. It allows creation by resizing or cropping the original image.

Paramètres

mixed	$thumbSizes	String or array of strings. Example: $thumbSizes = array('150x75','250x150');
integer	$creationMethod	1-3 resize $scaleMethod \| 4 create cropping \| 5 resize then crop

Renvoie: array

Depuis: 1.0

Exceptions

Références Image\crop(), Image\cropResize(), Image\isLoaded(), null, et Image\resize().

Référencé par Image\createThumbs().

◆ getFilterInstance()

getFilterInstance ( $type )

protected

Method to get an image filter instance of a specified type.

Paramètres

string $type The image filter type to get.

Renvoie: ImageFilter

Depuis: 1.0

Exceptions

Références $className, $type, Image\getHandle(), et Image\getLogger().

Référencé par Image\filter().

◆ getHandle()

getHandle ( )

Get the image resource handle

Renvoie: resource

Depuis: 1.3.0

Exceptions

Références Image\$handle, et Image\isLoaded().

Référencé par Image\crop(), Image\destroy(), Image\flip(), Image\getFilterInstance(), Image\getHeight(), Image\getWidth(), Image\isTransparent(), Image\resize(), Image\rotate(), Image\toFile(), et Image\watermark().

◆ getHeight()

getHeight ( )

Method to get the height of the image in pixels.

Renvoie: integer

Depuis: 1.0

Exceptions

Références Image\getHandle().

Référencé par Image\crop(), Image\cropResize(), Image\flip(), Image\getOrientation(), Image\prepareDimensions(), Image\resize(), Image\rotate(), Image\sanitizeHeight(), et Image\watermark().

◆ getImageFileProperties()

static getImageFileProperties ( $path )

static

Method to return a properties object for an image given a filesystem path.

The result object has values for image width, height, type, attributes, mime type, bits, and channels.

Paramètres

string $path The filesystem path to the image for which to get properties.

Renvoie

Depuis: 1.0

Exceptions

Références $info, Image\$path, et null.

◆ getLogger()

getLogger ( )

Get the logger.

Renvoie: LoggerInterface

Depuis: 1.0

Références Image\$logger.

Référencé par Image\getFilterInstance(), et Image\loadFile().

◆ getOrientation()

getOrientation ( )

Method to detect whether an image's orientation is landscape, portrait or square.

The orientation will be returned as a string.

Renvoie: mixed Orientation string or null.

Depuis: 1.2.0

Références Image\getHeight(), Image\getWidth(), et Image\isLoaded().

◆ getOrientationString()

static getOrientationString	(	$width,
		$height
	)

staticprivate

Compare width and height integers to determine image orientation.

Paramètres

integer	$width	The width value to use for calculation
integer	$height	The height value to use for calculation

Renvoie: string Orientation string

Depuis: 1.2.0

Références $height, et $width.

◆ getPath()

getPath ( )

Method to return the path

Renvoie: string

Depuis: 1.0

Références Image\$path.

Référencé par Image\createThumbs().

◆ getWidth()

getWidth ( )

Method to get the width of the image in pixels.

Renvoie: integer

Depuis: 1.0

Exceptions

Références Image\getHandle().

Référencé par Image\crop(), Image\cropResize(), Image\flip(), Image\getOrientation(), Image\prepareDimensions(), Image\rotate(), Image\sanitizeWidth(), et Image\watermark().

◆ isLoaded()

isLoaded ( )

Method to determine whether or not an image has been loaded into the object.

Renvoie: boolean

Depuis: 1.0

Références Image\isValidImage().

Référencé par Image\createThumbs(), Image\destroy(), Image\filter(), Image\generateThumbs(), Image\getHandle(), et Image\getOrientation().

◆ isTransparent()

isTransparent ( )

Method to determine whether or not the image has transparency.

Renvoie: boolean

Depuis: 1.0

Exceptions

Références Image\getHandle().

Référencé par Image\crop(), et Image\resize().

◆ isValidImage()

isValidImage ( $handle )

private

Paramètres

mixed $handle A potential image handle

Renvoie: boolean

Références Image\$handle.

Référencé par Image\__construct(), Image\isLoaded(), et Image\loadFile().

◆ loadFile()

loadFile ( $path )

Method to load a file into the Image object as the resource.

Paramètres

string $path The filesystem path to load as an image.

Renvoie: void

Depuis: 1.0

Exceptions

Références Image\$handle, Image\$path, Image\destroy(), Image\getLogger(), et Image\isValidImage().

Référencé par Image\__construct().

◆ prepareDimensions()

prepareDimensions	(	$width,
		$height,
		$scaleMethod
	)

protected

Method to get the new dimensions for a resized image.

Paramètres

integer	$width	The width of the resized image in pixels.
integer	$height	The height of the resized image in pixels.
integer	$scaleMethod	The method to use for scaling

Renvoie

Depuis: 1.0

Exceptions

Références $height, $width, Image\getHeight(), et Image\getWidth().

Référencé par Image\resize().

◆ resize()

resize	(	$width,
		$height,
		$createNew = `true`,
		$scaleMethod = `self::SCALE_INSIDE`
	)

Method to resize the current image.

Paramètres

mixed	$width	The width of the resized image in pixels or a percentage.
mixed	$height	The height of the resized image in pixels or a percentage.
boolean	$createNew	If true the current image will be cloned, resized and returned; else the current image will be resized and returned.
integer	$scaleMethod	Which method to use for scaling

Renvoie: Image

Depuis: 1.0

Exceptions

Références $color, Image\$handle, $height, $offset, $width, Image\destroy(), Image\getHandle(), Image\getHeight(), Image\isTransparent(), Image\prepareDimensions(), Image\sanitizeHeight(), et Image\sanitizeWidth().

Référencé par Image\cropResize(), et Image\generateThumbs().

◆ rotate()

rotate	(	$angle,
		$background = `-1`,
		$createNew = `true`
	)

Method to rotate the current image.

Paramètres

mixed	$angle	The angle of rotation for the image
integer	$background	The background color to use when areas are added due to rotation
boolean	$createNew	If true the current image will be cloned, rotated and returned; else the current image will be rotated and returned.

Renvoie: Image

Depuis: 1.0

Exceptions

Références Image\$handle, Image\destroy(), Image\getHandle(), Image\getHeight(), et Image\getWidth().

◆ sanitizeHeight()

sanitizeHeight	(	$height,
		$width
	)

protected

Method to sanitize a height value.

Paramètres

mixed	$height	The input height value to sanitize.
mixed	$width	The input width value for reference.

Renvoie: integer

Depuis: 1.0

Références $height, $width, Image\getHeight(), et null.

Référencé par Image\crop(), Image\cropResize(), et Image\resize().

◆ sanitizeOffset()

sanitizeOffset ( $offset )

protected

Method to sanitize an offset value like left or top.

Paramètres

mixed $offset An offset value.

Renvoie: integer

Depuis: 1.0

Références $offset.

Référencé par Image\crop().

◆ sanitizeWidth()

sanitizeWidth	(	$width,
		$height
	)

protected

Method to sanitize a width value.

Paramètres

mixed	$width	The input width value to sanitize.
mixed	$height	The input height value for reference.

Renvoie: integer

Depuis: 1.0

Références $height, $width, Image\getWidth(), et null.

Référencé par Image\crop(), Image\cropResize(), et Image\resize().

◆ setLogger()

setLogger ( LoggerInterface $logger )

Sets a logger instance on the object

Paramètres

LoggerInterface $logger A PSR-3 compliant logger.

Renvoie: Image This object for message chaining.

Depuis: 1.0

Implémente LoggerAwareInterface.

Références Image\$logger.

◆ setThumbnailGenerate()

setThumbnailGenerate ( $quality = true )

Method for set option of generate thumbnail method

Paramètres

boolean $quality True for best quality. False for best speed.

Renvoie: void

Depuis: 1.4.0

◆ toFile()

toFile	(		$path,
			$type = `IMAGETYPE_JPEG`,
		array	$options = `array()`
	)

Method to write the current image out to a file or output directly.

Paramètres

mixed	$path	The filesystem path to save the image. When null, the raw image stream will be outputted directly.
integer	$type	The image type to save the file as.
array	$options	The image type options to use in saving the file. For PNG and JPEG formats use `quality` key to set compression level (0..9 and 0..100)

Renvoie: boolean

1.0

Références $options, Image\$path, $type, et Image\getHandle().

◆ watermark()

watermark	(	Image	$watermark,
			$transparency = `50`,
			$bottomMargin = `0`,
			$rightMargin = `0`
	)

Watermark the image

Paramètres

Image	$watermark	The Image object containing the watermark graphic
integer	$transparency	The transparency to use for the watermark graphic
integer	$bottomMargin	The margin from the bottom of this image
integer	$rightMargin	The margin from the right side of this image

Renvoie: Image

Depuis: 1.3.0 https://www.php.net/manual/en/image.examples-watermark.php

Références Image\getHandle(), Image\getHeight(), et Image\getWidth().

Documentation des champs

◆ $formats

$formats = array()

staticprotected

◆ $generateBestQuality

$generateBestQuality = true

protected

◆ $handle

$handle

protected

Référencé par Image\crop(), Image\flip(), Image\getHandle(), Image\isValidImage(), Image\loadFile(), Image\resize(), et Image\rotate().

◆ $logger

$logger

protected

Référencé par Image\getLogger(), et Image\setLogger().

◆ $path

$path

protected

Référencé par Image\getImageFileProperties(), Image\getPath(), Image\loadFile(), et Image\toFile().

◆ CROP

const CROP = 4

integer

Depuis: 1.0

◆ CROP_RESIZE

const CROP_RESIZE = 5

integer

Depuis: 1.0

◆ ORIENTATION_LANDSCAPE

const ORIENTATION_LANDSCAPE = 'landscape'

string

Depuis: 1.2.0

◆ ORIENTATION_PORTRAIT

const ORIENTATION_PORTRAIT = 'portrait'

string

Depuis: 1.2.0

◆ ORIENTATION_SQUARE

const ORIENTATION_SQUARE = 'square'

string

Depuis: 1.2.0

◆ SCALE_FILL

const SCALE_FILL = 1

integer

Depuis: 1.0

◆ SCALE_FIT

const SCALE_FIT = 6

integer

Depuis: 1.0

◆ SCALE_INSIDE

const SCALE_INSIDE = 2

integer

Depuis: 1.0

◆ SCALE_OUTSIDE

const SCALE_OUTSIDE = 3

integer

Depuis: 1.0

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

vendor/joomla/image/src/Image.php

Fonctions membres publiques

Fonctions membres publiques statiques

Champs de données

Fonctions membres protégées

Attributs protégés

Attributs protégés statiques

Fonctions membres privées

Fonctions membres privées statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

◆ __destruct()

Documentation des fonctions membres

◆ createThumbs()

◆ crop()

◆ cropResize()

◆ destroy()

◆ filter()

◆ flip()

◆ generateThumbs()

◆ getFilterInstance()

◆ getHandle()

◆ getHeight()

◆ getImageFileProperties()

◆ getLogger()

◆ getOrientation()

◆ getOrientationString()

◆ getPath()

◆ getWidth()

◆ isLoaded()

◆ isTransparent()

◆ isValidImage()

◆ loadFile()

◆ prepareDimensions()

◆ resize()

◆ rotate()

◆ sanitizeHeight()

◆ sanitizeOffset()

◆ sanitizeWidth()

◆ setLogger()

◆ setThumbnailGenerate()

◆ toFile()

◆ watermark()

Documentation des champs

◆ $formats

◆ $generateBestQuality

◆ $handle

◆ $logger

◆ $path

◆ CROP

◆ CROP_RESIZE

◆ ORIENTATION_LANDSCAPE

◆ ORIENTATION_PORTRAIT

◆ ORIENTATION_SQUARE

◆ SCALE_FILL

◆ SCALE_FIT

◆ SCALE_INSIDE

◆ SCALE_OUTSIDE