ImageVariation

ImageVariation.php : 16 Copy path

Extends Variation

Base class for file variations (i.e. image aliases).

Properties¶

$dirPath read-only ¶

Variation.php Copy path

public string $dirPath

The path to the file (for example "var/storage/images/test/199-2-eng-GB")

$fileName read-only ¶

Variation.php Copy path

public string $fileName

The name of the file (for example "my_image.png")

$fileSize read-only ¶

Variation.php Copy path

public int $fileSize

Number of bytes for current variation

$height read-only ¶

ImageVariation.php Copy path

public int|null $height

The height as number of pixels (for example "256")

$imageId read-only ¶

ImageVariation.php Copy path

public mixed $imageId

$info read-only ¶

ImageVariation.php Copy path

public mixed $info

Extra information about the image, depending on the image type

$lastModified read-only ¶

Variation.php Copy path

public DateTime $lastModified

When the variation was last modified

$mimeType read-only ¶

Variation.php Copy path

public string $mimeType

The MIME type (for example "image/png")

$name read-only ¶

ImageVariation.php Copy path

public string $name

The name of the image alias (for example "original")

$uri read-only ¶

Variation.php Copy path

public string $uri

Complete path + name of image file (for example "var/storage/images/test/199-2-eng-GB/apple.png")

$width read-only ¶

ImageVariation.php Copy path

public int|null $width

The width as number of pixels (for example "320")

$dirPath ¶

Variation.php : 49 Copy path

The path to the file (for example "var/storage/images/test/199-2-eng-GB").

protected string $dirPath

$fileName ¶

Variation.php : 42 Copy path

The name of the file (for example "my_image.png").

protected string $fileName

$fileSize ¶

Variation.php : 28 Copy path

Number of bytes for current variation.

protected int $fileSize

$handler ¶

ImageVariation.php : 57 Copy path

Contains identifier of variation handler used to generate this particular variation.

protected string|null $handler = null

$height ¶

ImageVariation.php : 30 Copy path

The height as number of pixels (for example "256").

protected int|null $height

$imageId ¶

ImageVariation.php : 52 Copy path

protected mixed $imageId

$info ¶

ImageVariation.php : 49 Copy path

Contains extra information about the image, depending on the image type.

protected mixed $info

It will typically contain EXIF information from digital cameras or information about animated GIFs. If there is no information, the info will be a boolean FALSE.

Beware: This information may contain e.g. HTML, JavaScript, or PHP code, and should be treated like any other user-submitted data. Make sure it is properly escaped before use.

$isExternal ¶

ImageVariation.php : 63 Copy path

Indicator if variation image is external (like Fastly IO) or local (like built-in Imagine based alias).

protected bool $isExternal = false

External images won't have SPLInfo data and image dimensions as it would be redundant to fetch file.

$lastModified ¶

Variation.php : 63 Copy path

When the variation was last modified.

protected DateTime $lastModified

$mimeType ¶

Variation.php : 35 Copy path

The MIME type (for example "image/png").

protected string $mimeType

$name ¶

ImageVariation.php : 37 Copy path

The name of the image alias (for example "original").

protected string $name

$uri ¶

Variation.php : 56 Copy path

Complete path + name of image file (for example "var/storage/images/test/199-2-eng-GB/apple.png").

protected string $uri

$width ¶

ImageVariation.php : 23 Copy path

The width as number of pixels (for example "320").

protected int|null $width

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

Construct object optionally with a set of properties.

public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$properties	array<string\|int, mixed>	[]	-

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

    
                        protected getProperties([array<string|int, mixed> $dynamicProperties = [] ]) : array<string|int, mixed>

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>