Image
class Image extends AbstractImage
Image implementation using the GD library.
Properties
protected MetadataBag | $metadata | from AbstractImage |
Methods
Generates a thumbnail from a current image Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.
Updates a given array of save options for backward compatibility with legacy names.
Clones all the resources associated to this instance.
Get the class factory instance to be used.
Constructs a new Image instance.
Makes sure the current image resource is destroyed.
Returns Gd resource.
Copies current source image into a new ImageInterface instance.
Crops a specified box out of the source image (modifies the source image) Returns cropped self.
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails.
Resizes current image and returns self.
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are supported.
Outputs the image content.
Returns the image content as a binary string.
Returns the image content as a PNG binary string.
Flips current image using vertical axis.
Flips current image using horizontal axis.
Remove all profiles and comments.
Instantiates and returns a DrawerInterface instance for image drawing.
No description
Returns current image size.
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image.
Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified.
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.
Returns the image layers when applicable.
Enables or disables interlacing.
Return the current color palette.
Details
in AbstractImage at line 36
ManipulatorInterface
thumbnail(BoxInterface $size, int|string $settings = ImageInterface::THUMBNAIL_INSET, string $filter = ImageInterface::FILTER_UNDEFINED)
Generates a thumbnail from a current image Returns it as a new image without modifying the current image unless the THUMBNAIL_FLAG_NOCLONE flag is specified.
in AbstractImage at line 146
protected int[]
getAllThumbnailModes()
Get all the available thumbnail modes.
in AbstractImage at line 161
protected array
updateSaveOptions(array $options)
Updates a given array of save options for backward compatibility with legacy names.
in AbstractImage at line 176
MetadataBag
metadata()
Returns the Image's meta data.
at line 81
__clone()
Clones all the resources associated to this instance.
in AbstractImage at line 196
ClassFactoryInterface
getClassFactory()
Get the class factory instance to be used.
in AbstractImage at line 210
$this
setClassFactory(ClassFactoryInterface $classFactory)
Set the class factory instance to be used.
at line 59
__construct(resource|GdImage $resource, PaletteInterface $palette, MetadataBag $metadata)
Constructs a new Image instance.
at line 69
__destruct()
Makes sure the current image resource is destroyed.
at line 102
resource
getGdResource()
Returns Gd resource.
at line 112
final ManipulatorInterface
copy()
Copies current source image into a new ImageInterface instance.
at line 122
final $this
crop(PointInterface $start, BoxInterface $size)
Crops a specified box out of the source image (modifies the source image) Returns cropped self.
at line 150
final $this
paste(ImageInterface $image, PointInterface $start, int $alpha = 100)
Pastes an image into a parent image Throws exceptions if image exceeds parent image borders or if paste operation fails.
Returns source image
at line 189
final $this
resize(BoxInterface $size, string $filter = ImageInterface::FILTER_UNDEFINED)
Resizes current image and returns self.
at line 225
final $this
rotate(int $angle, ColorInterface $background = null)
Rotates an image at the given angle.
Optional $background can be used to specify the fill color of the empty area of rotated image.
at line 248
final $this
save(string $path = null, array $options = array())
Saves the image at a specified path, the target file extension is used to determine file format, only jpg, jpeg, gif, png, wbmp, xbm, webp and bmp are supported.
Please remark that bmp is supported by the GD driver only since PHP 7.2.
at line 275
$this
show(string $format, array $options = array())
Outputs the image content.
at line 289
string
get(string $format, array $options = array())
Returns the image content as a binary string.
at line 302
string
__toString()
Returns the image content as a PNG binary string.
at line 312
final $this
flipHorizontally()
Flips current image using vertical axis.
at line 342
final $this
flipVertically()
Flips current image using horizontal axis.
at line 372
final $this
strip()
Remove all profiles and comments.
at line 383
DrawerInterface
draw()
Instantiates and returns a DrawerInterface instance for image drawing.
at line 393
EffectsInterface
effects()
at line 403
BoxInterface
getSize()
Returns current image size.
at line 413
$this
applyMask(ImageInterface $mask)
Applies a given mask to current image's alpha channel.
at line 447
$this
fill(FillInterface $fill)
Fills image with provided filling, by replacing each pixel's color in the current image with corresponding color from FillInterface, and returns modified image.
at line 467
ImageInterface
mask()
Transforms creates a grayscale mask from current image, returns a new image, while keeping the existing image unmodified.
at line 483
ColorInterface[]
histogram()
Returns array of image colors as Imagine\Image\Palette\Color\ColorInterface instances.
at line 502
ColorInterface
getColorAt(PointInterface $point)
Returns color at specified positions of current image.
at line 519
LayersInterface
layers()
Returns the image layers when applicable.
at line 533
$this
interlace(string $scheme)
Enables or disables interlacing.
at line 556
PaletteInterface
palette()
Return the current color palette.
at line 566
$this
profile(ProfileInterface $profile)
Applies a color profile on the Image.
at line 576
$this
usePalette(PaletteInterface $palette)
Set a palette for the image. Useful to change colorspace.