1. class
  2. Nette
  3. \
  4. Utils
  5. \
  6. Image

Image

class Image

Basic manipulation with images.

$image = Image::fromFile('nette.jpg');
$image->resize(150, 100);
$image->sharpen();
$image->send();

Constants

SHRINK_ONLY

resize() only shrinks images
STRETCH

resize() will ignore aspect ratio
FIT

resize() fits in given area so its dimensions are less than or equal to the required dimensions
FILL

resize() fills given area so its dimensions are greater than or equal to the required dimensions
EXACT

resize() fills given area exactly
JPEG

image types
PNG

image types
GIF

image types
WEBP

image types
EMPTY_GIF

private FORMATS

Properties

int read-only $width
int read-only $height
resource|GdImage read-only $imageResource

Methods

static array
rgb(int $red, int $green, int $blue, int $transparency = 0)

Returns RGB color (0..255) and transparency (0..127).

static Image
fromFile(string $file, int $detectedFormat = null)

Opens image from file.

static Image
fromString(string $s, int $detectedFormat = null)

Create a new image from the image stream in the string.

static Image
fromBlank(int $width, int $height, array $color = null)

Creates blank image.

__construct(resource|GdImage $image)

Wraps GD image.

int
getWidth()

Returns image width.

int
getHeight()

Returns image height.

Image
setImageResource(resource|GdImage $image)

Sets image resource.

resource|GdImage
getImageResource()

Returns image GD resource.

Image
resize(int|string|null $width, int|string|null $height, int $flags = self::FIT)

Resizes image.

static array
calculateSize(int $srcWidth, int $srcHeight, int|string|null $newWidth, int|string|null $newHeight, int $flags = self::FIT)

Calculates dimensions of resized image.

Image
crop(int|string $left, int|string $top, int|string $width, int|string $height)

Crops image.

static array
calculateCutout(int $srcWidth, int $srcHeight, int|string $left, int|string $top, int|string $newWidth, int|string $newHeight)

Calculates dimensions of cutout in image.

Image
sharpen()

Sharpen image.

Image
place(Image $image, int|string $left = 0, int|string $top = 0, int $opacity = 100)

Puts another image into this image.

void
save(string $file, int $quality = null, int $type = null)

Saves image to the file. Quality is 0..100 for JPEG and WEBP, 0..9 for PNG.

string
toString(int $type = self::JPEG, int $quality = null)

Outputs image to string. Quality is 0..100 for JPEG and WEBP, 0..9 for PNG.

string
__toString()

Outputs image to string.

void
send(int $type = self::JPEG, int $quality = null)

Outputs image to browser. Quality is 0..100 for JPEG and WEBP, 0..9 for PNG.

mixed
__call(string $name, array $args)

Call to undefined method.

__clone()

No description

array
__sleep()

Prevents serialization.

void
alphaBlending(bool $on)

No description

void
antialias(bool $on)

No description

void
arc(mixed $x, mixed $y, mixed $w, mixed $h, mixed $start, mixed $end, mixed $color)

No description

void
char(int $font, mixed $x, mixed $y, string $char, mixed $color)

No description

void
charUp(int $font, mixed $x, mixed $y, string $char, mixed $color)

No description

int
colorAllocate(mixed $red, mixed $green, mixed $blue)

No description

int
colorAllocateAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

int
colorAt(mixed $x, mixed $y)

No description

int
colorClosest(mixed $red, mixed $green, mixed $blue)

No description

int
colorClosestAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

int
colorClosestHWB(mixed $red, mixed $green, mixed $blue)

No description

void
colorDeallocate(mixed $color)

No description

int
colorExact(mixed $red, mixed $green, mixed $blue)

No description

int
colorExactAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

void
colorMatch(Image $image2)

No description

int
colorResolve(mixed $red, mixed $green, mixed $blue)

No description

int
colorResolveAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

void
colorSet(mixed $index, mixed $red, mixed $green, mixed $blue)

No description

array
colorsForIndex(mixed $index)

No description

int
colorsTotal()

No description

int
colorTransparent(mixed $color)

No description

void
convolution(array $matrix, float $div, float $offset)

No description

void
copy(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $srcW, mixed $srcH)

No description

void
copyMerge(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $srcW, mixed $srcH, mixed $opacity)

No description

void
copyMergeGray(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $srcW, mixed $srcH, mixed $opacity)

No description

void
copyResampled(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $dstW, mixed $dstH, mixed $srcW, mixed $srcH)

No description

void
copyResized(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $dstW, mixed $dstH, mixed $srcW, mixed $srcH)

No description

Image
cropAuto(int $mode = -1, float $threshold = .5, int $color = -1)

No description

void
dashedLine(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $color)

No description

void
ellipse(mixed $cx, mixed $cy, mixed $w, mixed $h, mixed $color)

No description

void
fill(mixed $x, mixed $y, mixed $color)

No description

void
filledArc(mixed $cx, mixed $cy, mixed $w, mixed $h, mixed $s, mixed $e, mixed $color, mixed $style)

No description

void
filledEllipse(mixed $cx, mixed $cy, mixed $w, mixed $h, mixed $color)

No description

void
filledPolygon(array $points, mixed $numPoints, mixed $color)

No description

void
filledRectangle(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $color)

No description

void
fillToBorder(mixed $x, mixed $y, mixed $border, mixed $color)

No description

void
filter(mixed $filtertype)

No description

void
flip(int $mode)

No description

array
ftText(mixed $size, mixed $angle, mixed $x, mixed $y, mixed $col, string $fontFile, string $text, array $extrainfo = null)

No description

void
gammaCorrect(float $inputgamma, float $outputgamma)

No description

array
getClip()

No description

int
interlace(mixed $interlace)

No description

bool
isTrueColor()

No description

void
layerEffect(mixed $effect)

No description

void
line(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $color)

No description

void
openPolygon(array $points, int $num_points, int $color)

No description

void
paletteCopy(Image $source)

No description

void
paletteToTrueColor()

No description

void
polygon(array $points, mixed $numPoints, mixed $color)

No description

array
psText(string $text, mixed $font, mixed $size, mixed $color, mixed $backgroundColor, mixed $x, mixed $y, mixed $space, mixed $tightness, float $angle = null, mixed $antialiasSteps)

No description

void
rectangle(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $col)

No description

mixed
resolution(int $res_x = null, int $res_y = null)

No description

Image
rotate(float $angle, mixed $backgroundColor)

No description

void
saveAlpha(bool $saveflag)

No description

Image
scale(int $newWidth, int $newHeight = -1, int $mode = IMG_BILINEAR_FIXED)

No description

void
setBrush(Image $brush)

No description

void
setClip(int $x1, int $y1, int $x2, int $y2)

No description

void
setPixel(mixed $x, mixed $y, mixed $color)

No description

void
setStyle(array $style)

No description

void
setThickness(mixed $thickness)

No description

void
setTile(Image $tile)

No description

void
string(mixed $font, mixed $x, mixed $y, string $s, mixed $col)

No description

void
stringUp(mixed $font, mixed $x, mixed $y, string $s, mixed $col)

No description

void
trueColorToPalette(bool $dither, mixed $ncolors)

No description

array
ttfText(mixed $size, mixed $angle, mixed $x, mixed $y, mixed $color, string $fontfile, string $text)

No description

Details

at line 131
static array rgb(int $red, int $green, int $blue, int $transparency = 0)

Returns RGB color (0..255) and transparency (0..127).

Parameters

int $red
int $green
int $blue
int $transparency

Return Value

array

at line 148
static Image fromFile(string $file, int $detectedFormat = null)

Opens image from file.

Parameters

string $file
int $detectedFormat

Return Value

Image

Exceptions

NotSupportedException
UnknownImageFileException

at line 170
static Image fromString(string $s, int $detectedFormat = null)

Create a new image from the image stream in the string.

Parameters

string $s
int $detectedFormat

Return Value

Image

Exceptions

ImageException

at line 192
static Image fromBlank(int $width, int $height, array $color = null)

Creates blank image.

Parameters

int $width
int $height
array $color

Return Value

Image

at line 218
__construct(resource|GdImage $image)

Wraps GD image.

Parameters

resource|GdImage $image

at line 228
int getWidth()

Returns image width.

Return Value

int

at line 237
int getHeight()

Returns image height.

Return Value

int

at line 248
protected Image setImageResource(resource|GdImage $image)

Sets image resource.

Parameters

resource|GdImage $image

Return Value

Image

at line 262
resource|GdImage getImageResource()

Returns image GD resource.

Return Value

resource|GdImage

at line 274
Image resize(int|string|null $width, int|string|null $height, int $flags = self::FIT)

Resizes image.

Parameters

int|string|null $width

in pixels or percent
int|string|null $height

in pixels or percent
int $flags

Return Value

Image

at line 304
static array calculateSize(int $srcWidth, int $srcHeight, int|string|null $newWidth, int|string|null $newHeight, int $flags = self::FIT)

Calculates dimensions of resized image.

Parameters

int $srcWidth
int $srcHeight
int|string|null $newWidth

in pixels or percent
int|string|null $newHeight

in pixels or percent
int $flags

Return Value

array

at line 371
Image crop(int|string $left, int|string $top, int|string $width, int|string $height)

Crops image.

Parameters

int|string $left

in pixels or percent
int|string $top

in pixels or percent
int|string $width

in pixels or percent
int|string $height

in pixels or percent

Return Value

Image

at line 388
static array calculateCutout(int $srcWidth, int $srcHeight, int|string $left, int|string $top, int|string $newWidth, int|string $newHeight)

Calculates dimensions of cutout in image.

Parameters

int $srcWidth
int $srcHeight
int|string $left

in pixels or percent
int|string $top

in pixels or percent
int|string $newWidth

in pixels or percent
int|string $newHeight

in pixels or percent

Return Value

array

at line 420
Image sharpen()

Sharpen image.

Return Value

Image

at line 438
Image place(Image $image, int|string $left = 0, int|string $top = 0, int $opacity = 100)

Puts another image into this image.

Parameters

Image $image
int|string $left

in pixels or percent
int|string $top

in pixels or percent
int $opacity 0..100

Return Value

Image

at line 492
void save(string $file, int $quality = null, int $type = null)

Saves image to the file. Quality is 0..100 for JPEG and WEBP, 0..9 for PNG.

Parameters

string $file
int $quality
int $type

Return Value

void

Exceptions

ImageException

at line 510
string toString(int $type = self::JPEG, int $quality = null)

Outputs image to string. Quality is 0..100 for JPEG and WEBP, 0..9 for PNG.

Parameters

int $type
int $quality

Return Value

string

at line 521
string __toString()

Outputs image to string.

Return Value

string

at line 539
void send(int $type = self::JPEG, int $quality = null)

Outputs image to browser. Quality is 0..100 for JPEG and WEBP, 0..9 for PNG.

Parameters

int $type
int $quality

Return Value

void

Exceptions

ImageException

at line 589
mixed __call(string $name, array $args)

Call to undefined method.

Parameters

string $name
array $args

Return Value

mixed

Exceptions

MemberAccessException

at line 615
__clone()

No description

at line 642
array __sleep()

Prevents serialization.

Return Value

array

at line 94
void alphaBlending(bool $on)

No description

Parameters

bool $on

Return Value

void

at line 94
void antialias(bool $on)

No description

Parameters

bool $on

Return Value

void

at line 94
void arc(mixed $x, mixed $y, mixed $w, mixed $h, mixed $start, mixed $end, mixed $color)

No description

Parameters

mixed $x
mixed $y
mixed $w
mixed $h
mixed $start
mixed $end
mixed $color

Return Value

void

at line 94
void char(int $font, mixed $x, mixed $y, string $char, mixed $color)

No description

Parameters

int $font
mixed $x
mixed $y
string $char
mixed $color

Return Value

void

at line 94
void charUp(int $font, mixed $x, mixed $y, string $char, mixed $color)

No description

Parameters

int $font
mixed $x
mixed $y
string $char
mixed $color

Return Value

void

at line 94
int colorAllocate(mixed $red, mixed $green, mixed $blue)

No description

Parameters

mixed $red
mixed $green
mixed $blue

Return Value

int

at line 94
int colorAllocateAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

Parameters

mixed $red
mixed $green
mixed $blue
mixed $alpha

Return Value

int

at line 94
int colorAt(mixed $x, mixed $y)

No description

Parameters

mixed $x
mixed $y

Return Value

int

at line 94
int colorClosest(mixed $red, mixed $green, mixed $blue)

No description

Parameters

mixed $red
mixed $green
mixed $blue

Return Value

int

at line 94
int colorClosestAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

Parameters

mixed $red
mixed $green
mixed $blue
mixed $alpha

Return Value

int

at line 94
int colorClosestHWB(mixed $red, mixed $green, mixed $blue)

No description

Parameters

mixed $red
mixed $green
mixed $blue

Return Value

int

at line 94
void colorDeallocate(mixed $color)

No description

Parameters

mixed $color

Return Value

void

at line 94
int colorExact(mixed $red, mixed $green, mixed $blue)

No description

Parameters

mixed $red
mixed $green
mixed $blue

Return Value

int

at line 94
int colorExactAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

Parameters

mixed $red
mixed $green
mixed $blue
mixed $alpha

Return Value

int

at line 94
void colorMatch(Image $image2)

No description

Parameters

Image $image2

Return Value

void

at line 94
int colorResolve(mixed $red, mixed $green, mixed $blue)

No description

Parameters

mixed $red
mixed $green
mixed $blue

Return Value

int

at line 94
int colorResolveAlpha(mixed $red, mixed $green, mixed $blue, mixed $alpha)

No description

Parameters

mixed $red
mixed $green
mixed $blue
mixed $alpha

Return Value

int

at line 94
void colorSet(mixed $index, mixed $red, mixed $green, mixed $blue)

No description

Parameters

mixed $index
mixed $red
mixed $green
mixed $blue

Return Value

void

at line 94
array colorsForIndex(mixed $index)

No description

Parameters

mixed $index

Return Value

array

at line 94
int colorsTotal()

No description

Return Value

int

at line 94
int colorTransparent(mixed $color)

No description

Parameters

mixed $color

Return Value

int

at line 94
void convolution(array $matrix, float $div, float $offset)

No description

Parameters

array $matrix
float $div
float $offset

Return Value

void

at line 94
void copy(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $srcW, mixed $srcH)

No description

Parameters

Image $src
mixed $dstX
mixed $dstY
mixed $srcX
mixed $srcY
mixed $srcW
mixed $srcH

Return Value

void

at line 94
void copyMerge(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $srcW, mixed $srcH, mixed $opacity)

No description

Parameters

Image $src
mixed $dstX
mixed $dstY
mixed $srcX
mixed $srcY
mixed $srcW
mixed $srcH
mixed $opacity

Return Value

void

at line 94
void copyMergeGray(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $srcW, mixed $srcH, mixed $opacity)

No description

Parameters

Image $src
mixed $dstX
mixed $dstY
mixed $srcX
mixed $srcY
mixed $srcW
mixed $srcH
mixed $opacity

Return Value

void

at line 94
void copyResampled(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $dstW, mixed $dstH, mixed $srcW, mixed $srcH)

No description

Parameters

Image $src
mixed $dstX
mixed $dstY
mixed $srcX
mixed $srcY
mixed $dstW
mixed $dstH
mixed $srcW
mixed $srcH

Return Value

void

at line 94
void copyResized(Image $src, mixed $dstX, mixed $dstY, mixed $srcX, mixed $srcY, mixed $dstW, mixed $dstH, mixed $srcW, mixed $srcH)

No description

Parameters

Image $src
mixed $dstX
mixed $dstY
mixed $srcX
mixed $srcY
mixed $dstW
mixed $dstH
mixed $srcW
mixed $srcH

Return Value

void

at line 94
Image cropAuto(int $mode = -1, float $threshold = .5, int $color = -1)

No description

Parameters

int $mode
float $threshold
int $color

Return Value

Image

at line 94
void dashedLine(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $color)

No description

Parameters

mixed $x1
mixed $y1
mixed $x2
mixed $y2
mixed $color

Return Value

void

at line 94
void ellipse(mixed $cx, mixed $cy, mixed $w, mixed $h, mixed $color)

No description

Parameters

mixed $cx
mixed $cy
mixed $w
mixed $h
mixed $color

Return Value

void

at line 94
void fill(mixed $x, mixed $y, mixed $color)

No description

Parameters

mixed $x
mixed $y
mixed $color

Return Value

void

at line 94
void filledArc(mixed $cx, mixed $cy, mixed $w, mixed $h, mixed $s, mixed $e, mixed $color, mixed $style)

No description

Parameters

mixed $cx
mixed $cy
mixed $w
mixed $h
mixed $s
mixed $e
mixed $color
mixed $style

Return Value

void

at line 94
void filledEllipse(mixed $cx, mixed $cy, mixed $w, mixed $h, mixed $color)

No description

Parameters

mixed $cx
mixed $cy
mixed $w
mixed $h
mixed $color

Return Value

void

at line 94
void filledPolygon(array $points, mixed $numPoints, mixed $color)

No description

Parameters

array $points
mixed $numPoints
mixed $color

Return Value

void

at line 94
void filledRectangle(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $color)

No description

Parameters

mixed $x1
mixed $y1
mixed $x2
mixed $y2
mixed $color

Return Value

void

at line 94
void fillToBorder(mixed $x, mixed $y, mixed $border, mixed $color)

No description

Parameters

mixed $x
mixed $y
mixed $border
mixed $color

Return Value

void

at line 94
void filter(mixed $filtertype)

No description

Parameters

mixed $filtertype

Return Value

void

at line 94
void flip(int $mode)

No description

Parameters

int $mode

Return Value

void

at line 94
array ftText(mixed $size, mixed $angle, mixed $x, mixed $y, mixed $col, string $fontFile, string $text, array $extrainfo = null)

No description

Parameters

mixed $size
mixed $angle
mixed $x
mixed $y
mixed $col
string $fontFile
string $text
array $extrainfo

Return Value

array

at line 94
void gammaCorrect(float $inputgamma, float $outputgamma)

No description

Parameters

float $inputgamma
float $outputgamma

Return Value

void

at line 94
array getClip()

No description

Return Value

array

at line 94
int interlace(mixed $interlace)

No description

Parameters

mixed $interlace

Return Value

int

at line 94
bool isTrueColor()

No description

Return Value

bool

at line 94
void layerEffect(mixed $effect)

No description

Parameters

mixed $effect

Return Value

void

at line 94
void line(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $color)

No description

Parameters

mixed $x1
mixed $y1
mixed $x2
mixed $y2
mixed $color

Return Value

void

at line 94
void openPolygon(array $points, int $num_points, int $color)

No description

Parameters

array $points
int $num_points
int $color

Return Value

void

at line 94
void paletteCopy(Image $source)

No description

Parameters

Image $source

Return Value

void

at line 94
void paletteToTrueColor()

No description

Return Value

void

at line 94
void polygon(array $points, mixed $numPoints, mixed $color)

No description

Parameters

array $points
mixed $numPoints
mixed $color

Return Value

void

at line 94
array psText(string $text, mixed $font, mixed $size, mixed $color, mixed $backgroundColor, mixed $x, mixed $y, mixed $space, mixed $tightness, float $angle = null, mixed $antialiasSteps)

No description

Parameters

string $text
mixed $font
mixed $size
mixed $color
mixed $backgroundColor
mixed $x
mixed $y
mixed $space
mixed $tightness
float $angle
mixed $antialiasSteps

Return Value

array

at line 94
void rectangle(mixed $x1, mixed $y1, mixed $x2, mixed $y2, mixed $col)

No description

Parameters

mixed $x1
mixed $y1
mixed $x2
mixed $y2
mixed $col

Return Value

void

at line 94
mixed resolution(int $res_x = null, int $res_y = null)

No description

Parameters

int $res_x
int $res_y

Return Value

mixed

at line 94
Image rotate(float $angle, mixed $backgroundColor)

No description

Parameters

float $angle
mixed $backgroundColor

Return Value

Image

at line 94
void saveAlpha(bool $saveflag)

No description

Parameters

bool $saveflag

Return Value

void

at line 94
Image scale(int $newWidth, int $newHeight = -1, int $mode = IMG_BILINEAR_FIXED)

No description

Parameters

int $newWidth
int $newHeight
int $mode

Return Value

Image

at line 94
void setBrush(Image $brush)

No description

Parameters

Image $brush

Return Value

void

at line 94
void setClip(int $x1, int $y1, int $x2, int $y2)

No description

Parameters

int $x1
int $y1
int $x2
int $y2

Return Value

void

at line 94
void setPixel(mixed $x, mixed $y, mixed $color)

No description

Parameters

mixed $x
mixed $y
mixed $color

Return Value

void

at line 94
void setStyle(array $style)

No description

Parameters

array $style

Return Value

void

at line 94
void setThickness(mixed $thickness)

No description

Parameters

mixed $thickness

Return Value

void

at line 94
void setTile(Image $tile)

No description

Parameters

Image $tile

Return Value

void

at line 94
void string(mixed $font, mixed $x, mixed $y, string $s, mixed $col)

No description

Parameters

mixed $font
mixed $x
mixed $y
string $s
mixed $col

Return Value

void

at line 94
void stringUp(mixed $font, mixed $x, mixed $y, string $s, mixed $col)

No description

Parameters

mixed $font
mixed $x
mixed $y
string $s
mixed $col

Return Value

void

at line 94
void trueColorToPalette(bool $dither, mixed $ncolors)

No description

Parameters

bool $dither
mixed $ncolors

Return Value

void

at line 94
array ttfText(mixed $size, mixed $angle, mixed $x, mixed $y, mixed $color, string $fontfile, string $text)

No description

Parameters

mixed $size
mixed $angle
mixed $x
mixed $y
mixed $color
string $fontfile
string $text

Return Value

array

Traits

SmartObject

Strict class for better experience.