1. class
  2. Illuminate
  3. \
  4. Image
  5. \
  6. Image

Image

class Image implements Stringable (View source)

Traits

Conditionable
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable
protected $pipeline

The image processing pipeline.
protected $driver

The driver override.
protected $processed

Whether the image has been processed.
protected $hashName

The cached hash name.

Methods

$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(Closure|string $contents, UploadedFile|null $file = null)

Create a new image instance.

Image
cover(int $width, int $height)

Set the cover dimensions.

Image
contain(int $width, int $height, string|null $background = null)

Set the contain dimensions.

Image
crop(int $width, int $height, int $x = 0, int $y = 0)

Crop the image to the given dimensions and position.

Image
resize(int|null $width = null, int|null $height = null)

Resize the image to the given dimensions.

Image
rotate(float $angle, string|null $background = null)

Rotate the image clockwise by the given angle.

Image
scale(int|null $width = null, int|null $height = null)

Set the scale dimensions.

Image
orient()

Auto-orient the image based on EXIF data.

Image
blur(int $amount = 5)

Apply a blur effect.

Image
grayscale()

Convert the image to grayscale.

Image
sharpen(int $amount = 10)

Sharpen the image.

Image
flipVertically()

Flip the image vertically.

Image
flipHorizontally()

Flip the image horizontally.

Image
flip()

Flip the image vertically.

Image
flop()

Flip the image horizontally.

Image
transform(Transformation $transformation)

Add a transformation to the image pipeline.

Image
optimize(string $format = 'webp', int $quality = ImageOutputOptions::DEFAULT_QUALITY)

Set the optimization options.

Image
quality(int $quality)

Set the output quality.

Image
toWebp()

Convert the image to WebP format.

Image
toJpg()

Convert the image to JPEG format.

Image
toJpeg()

Convert the image to JPEG format.

Image
toFormat(string $format)

Set the output format.

string|false
store(string $path = '', string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk.

string|false
storePublicly(string $path = '', string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk with public visibility.

string|false
storeAs(string $path, string|null $name = null, string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk with a given name.

string|false
storePubliclyAs(string $path, string|null $name = null, string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk with public visibility and a given name.

string
hashName(string $path = '')

Get a hashed filename with the correct extension.

string
toBytes()

Process the image and return the raw bytes.

string
toBase64()

Process the image and return as a base64 encoded string.

string
toDataUri()

Process the image and return as a data URI.

string
extension()

Get the file extension based on the MIME type.

string
mimeType()

Get the MIME type of the processed image.

array
dimensions()

Get the dimensions of the processed image.

int
width()

Get the width of the processed image.

int
height()

Get the height of the processed image.

Image
using(string $driver)

Set the driver to use for processing.

Image
usingGd()

Use the GD driver for processing.

Image
usingImagick()

Use the Imagick driver for processing.

Driver
resolveDriver()

Resolve the image processing driver.

UploadedFile|null
file()

Get the underlying uploaded file instance.

Image
newClone()

Create an immutable clone with copied options.

Image
withOutput(Closure $callback)

Create an immutable clone with updated output options.

Image
withClone(Closure $callback)

Create an immutable clone with the given callback applied.

never
__serialize()

Prevent serialization of the image.

string
toString()

Get the string representation of the image.

string
__toString()

Get the string representation of the image.

Details

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Macroable at line 31
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 45
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 64
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 74
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 88
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 114
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 57
__construct(Closure|string $contents, UploadedFile|null $file = null)

Create a new image instance.

Parameters

Closure|string $contents
UploadedFile|null $file

at line 70
Image cover(int $width, int $height)

Set the cover dimensions.

Parameters

int $width
int $height

Return Value

Image

at line 81
Image contain(int $width, int $height, string|null $background = null)

Set the contain dimensions.

Parameters

int $width
int $height
string|null $background

Return Value

Image

at line 92
Image crop(int $width, int $height, int $x = 0, int $y = 0)

Crop the image to the given dimensions and position.

Parameters

int $width
int $height
int $x
int $y

Return Value

Image

at line 103
Image resize(int|null $width = null, int|null $height = null)

Resize the image to the given dimensions.

Parameters

int|null $width
int|null $height

Return Value

Image

at line 118
Image rotate(float $angle, string|null $background = null)

Rotate the image clockwise by the given angle.

Parameters

float $angle
string|null $background

Return Value

Image

at line 129
Image scale(int|null $width = null, int|null $height = null)

Set the scale dimensions.

Parameters

int|null $width
int|null $height

Return Value

Image

at line 144
Image orient()

Auto-orient the image based on EXIF data.

Return Value

Image

at line 154
Image blur(int $amount = 5)

Apply a blur effect.

Parameters

int $amount

Return Value

Image

at line 162
Image grayscale()

Convert the image to grayscale.

Return Value

Image

at line 172
Image sharpen(int $amount = 10)

Sharpen the image.

Parameters

int $amount

Return Value

Image

at line 180
Image flipVertically()

Flip the image vertically.

Return Value

Image

at line 188
Image flipHorizontally()

Flip the image horizontally.

Return Value

Image

at line 196
Image flip()

Flip the image vertically.

Return Value

Image

at line 204
Image flop()

Flip the image horizontally.

Return Value

Image

at line 212
Image transform(Transformation $transformation)

Add a transformation to the image pipeline.

Parameters

Transformation $transformation

Return Value

Image

at line 222
Image optimize(string $format = 'webp', int $quality = ImageOutputOptions::DEFAULT_QUALITY)

Set the optimization options.

Parameters

string $format
int $quality

Return Value

Image

Exceptions

ImageException

at line 232
Image quality(int $quality)

Set the output quality.

Parameters

int $quality

Return Value

Image

at line 240
Image toWebp()

Convert the image to WebP format.

Return Value

Image

at line 248
Image toJpg()

Convert the image to JPEG format.

Return Value

Image

at line 256
Image toJpeg()

Convert the image to JPEG format.

Return Value

Image

at line 266
protected Image toFormat(string $format)

Set the output format.

Parameters

string $format

Return Value

Image

Exceptions

ImageException

at line 280
string|false store(string $path = '', string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk.

Parameters

string $path
string|null $disk
array $options

Return Value

string|false

at line 290
string|false storePublicly(string $path = '', string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk with public visibility.

Parameters

string $path
string|null $disk
array $options

Return Value

string|false

at line 302
string|false storeAs(string $path, string|null $name = null, string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk with a given name.

Parameters

string $path
string|null $name
string|null $disk
array $options

Return Value

string|false

at line 322
string|false storePubliclyAs(string $path, string|null $name = null, string|null $disk = null, array $options = [])

Store the processed image on a filesystem disk with public visibility and a given name.

Parameters

string $path
string|null $name
string|null $disk
array $options

Return Value

string|false

at line 336
string hashName(string $path = '')

Get a hashed filename with the correct extension.

Parameters

string $path

Return Value

string

at line 348
string toBytes()

Process the image and return the raw bytes.

Return Value

string

at line 370
string toBase64()

Process the image and return as a base64 encoded string.

Return Value

string

at line 378
string toDataUri()

Process the image and return as a data URI.

Return Value

string

at line 386
string extension()

Get the file extension based on the MIME type.

Return Value

string

at line 403
string mimeType()

Get the MIME type of the processed image.

Return Value

string

at line 415
array dimensions()

Get the dimensions of the processed image.

Return Value

array

at line 431
int width()

Get the width of the processed image.

Return Value

int

at line 439
int height()

Get the height of the processed image.

Return Value

int

at line 447
Image using(string $driver)

Set the driver to use for processing.

Parameters

string $driver

Return Value

Image

at line 459
Image usingGd()

Use the GD driver for processing.

Return Value

Image

at line 467
Image usingImagick()

Use the Imagick driver for processing.

Return Value

Image

at line 475
protected Driver resolveDriver()

Resolve the image processing driver.

Return Value

Driver

at line 487
UploadedFile|null file()

Get the underlying uploaded file instance.

Return Value

UploadedFile|null

at line 495
protected Image newClone()

Create an immutable clone with copied options.

Return Value

Image

at line 508
protected Image withOutput(Closure $callback)

Create an immutable clone with updated output options.

Parameters

Closure $callback

Return Value

Image

at line 516
protected Image withClone(Closure $callback)

Create an immutable clone with the given callback applied.

Parameters

Closure $callback

Return Value

Image

at line 531
never __serialize()

Prevent serialization of the image.

Return Value

never

Exceptions

ImageException

at line 539
string toString()

Get the string representation of the image.

Return Value

string

at line 547
string __toString()

Get the string representation of the image.

Return Value

string