Image

Type

Class

Namespace

craft\helpers

Inherits

craft\helpers\Image

Since

3.0.0

Class Image

View source

Public Methods

Method	Description
calculateMissingDimension()	Calculates a missing target dimension for an image.
canHaveExifData()	Returns whether an image can have EXIF information embedded.
canManipulateAsImage()	Returns whether an image extension is considered manipulatable.
cleanExifDataFromImagickImage()	Clean EXIF data from an image loaded inside an Imagick instance, taking care not to wipe the ICC profile.
cleanImageByPath()	Clean an image provided by path from all malicious code and the like.
imageSize()	Returns the size of an image based on its file path.
imageSizeByStream()	Determines image dimensions by a stream pointing to the start of the image.
isWebSafe()	Returns whether an extension is web-safe.
parseSvgSize()	Parses SVG data and determines its size (normalized to pixels).
pngImageInfo()	Returns any info that’s embedded in a given PNG file.
targetDimensions()	Returns the target image width and height for an image, based on its transform type and constraints, and whether the source image should be upscaled.
webSafeFormats()	Returns a list of web-safe image formats.

calculateMissingDimension()

Calculates a missing target dimension for an image.

View source

Arguments

• $targetWidth (float, integer, null)
• $targetHeight (float, integer, null)
• $sourceWidth (float, integer)
• $sourceHeight (float, integer)

Returns

integer[] – Array of the width and height.

canHaveExifData()

Returns whether an image can have EXIF information embedded.

View source

Arguments

• $filePath (string) – The file path to check.

Returns

boolean

canManipulateAsImage()

Returns whether an image extension is considered manipulatable.

View source

Arguments

• $extension (string)

Returns

boolean

cleanExifDataFromImagickImage()

Clean EXIF data from an image loaded inside an Imagick instance, taking care not to wipe the ICC profile.

View source

Arguments

• $imagick (\Imagick)

cleanImageByPath()

Clean an image provided by path from all malicious code and the like.

View source

Arguments

• $imagePath (string)

imageSize()

Returns the size of an image based on its file path.

View source

Arguments

• $filePath (string) – The path to the image

Returns

array – [width, height]

imageSizeByStream()

Determines image dimensions by a stream pointing to the start of the image.

View source

Arguments

• $stream (resource)

Returns

array, false

Throws

• TypeError

isWebSafe()

Since

4.3.6

Returns whether an extension is web-safe.

View source

Arguments

• $extension (string)

Returns

boolean

parseSvgSize()

Parses SVG data and determines its size (normalized to pixels).

View source

Arguments

• $svg (string) – The SVG data

Returns

array – [width, height]

pngImageInfo()

Returns any info that’s embedded in a given PNG file.

Adapted from https://github.com/ktomk/Miscellaneous/tree/master/get_png_imageinfo.

View source

Arguments

• $file (string) – The path to the PNG file.

Returns

array, false – Info embedded in the PNG file, or false if it wasn’t found.

targetDimensions()

Since

3.7.55

Returns the target image width and height for an image, based on its transform type and constraints, and whether the source image should be upscaled.

View source

Arguments

• $sourceWidth (integer)
• $sourceHeight (integer)
• $transformWidth (integer, null)
• $transformHeight (integer, null)
• $mode (string) – The transform mode (crop, fit, letterbox or stretch)
• $upscale (boolean, null) – Whether to upscale the image to fill the transform dimensions. Defaults to the upscaleImages config setting.

Returns

integer[]

webSafeFormats()

Returns a list of web-safe image formats.

View source

Returns

string[]

Constants

Constant	Description
EXIF_IFD0_ROTATE_180
EXIF_IFD0_ROTATE_270
EXIF_IFD0_ROTATE_90