Crop
extends AbstractImagickCommand
in package
uses
CalculationTrait, ImagickTrait
Crop
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- execute() : bool
- Execute the command.
- calculateCounterClockwise() : int
- Calculate counter clockwise degree.
- calculateStartXOfCenter() : int
- Calculate startX position of center.
- calculateWatermarkImageStartXY() : array<string|int, mixed>
- Calculate watermark start X and Y from specified text position (left, right, bottom, top, middle, center).
- convertAlpha127ToRgba() : string
- Convert alpha number (0 - 127) to rgba value (1.00 - 0.00).
- fillWhiteToImage() : mixed
- Fill white to the image.
- getFirstFrame() : mixed
- Get animated picture's first frame.
- setErrorMessage() : mixed
- Set error message and code. This will be set statusXxx properties.
- setStatusSuccess() : mixed
- Set status as success and remove error message, error code.
- getImageColorAlpha() : mixed
- Get image color with alpha value (transparency).
Properties
$ImagickD
protected
Imagick
$ImagickD
The Imagick driver class.
Methods
__construct()
public
__construct(Imagick $Imagick) : mixed
Parameters
- $Imagick : Imagick
execute()
Execute the command.
public
execute(mixed $width, mixed $height[, mixed $start_x = '0' ][, mixed $start_y = '0' ][, mixed $fill = 'transparent' ]) : bool
Parameters
- $width : mixed
- $height : mixed
- $start_x : mixed = '0'
- $start_y : mixed = '0'
- $fill : mixed = 'transparent'
Return values
boolcalculateCounterClockwise()
Calculate counter clockwise degree.
protected
calculateCounterClockwise(int $value) : int
Calculate input degree for use with Imagick.
In GD 90 degrees is 270 in Imagick. This function help to make it working together very well.
So it will be...
input = output
0 = 0
1 = 359
10 = 350
90 = 270
180 = 180
270 = 90
360 = 0
Parameters
- $value : int
-
Input degrees.
Return values
int —Return opposite degrees for use with Imagick.
calculateStartXOfCenter()
Calculate startX position of center.
protected
calculateStartXOfCenter(int $objWidth, int $canvasWidth) : int
With this method, you can calculate the start x position of center (horizontal) or middle (vertical).
The purpose of this method is for internal use, do not call this method from image's driver class directly due to it can be changed in the future.
Formular: round((half of canvas) - (half of object))
Parameters
- $objWidth : int
-
Destination image object size.
- $canvasWidth : int
-
Canvas size.
Return values
int —Calculated size.
calculateWatermarkImageStartXY()
Calculate watermark start X and Y from specified text position (left, right, bottom, top, middle, center).
protected
calculateWatermarkImageStartXY(string $wmStartX, string $wmStartY, int $imgWidth, int $imgHeight, int $wmWidth, int $wmHeight[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>
The purpose of this method is for internal use, do not call this method from image's driver class directly due to it can be changed in the future.
Parameters
- $wmStartX : string
-
Position to begin in x axis. The value is 'left', 'center', 'right'.
- $wmStartY : string
-
Position to begin in y axis. The value is 'top', 'middle', 'bottom'.
- $imgWidth : int
-
Latest image width. Get the dimension from latest modified image only.
- $imgHeight : int
-
Latest image height. Get the dimension from latest modified image only.
- $wmWidth : int
-
Latest watermark image width. Get the dimension from latest modified image only.
- $wmHeight : int
-
Latest watermark image height. Get the dimension from latest modified image only.
- $options : array<string|int, mixed> = []
-
The watermark options. This argument must be normalized before calling this method. Value is associative array.
padding(int) Padding around watermark object. Use with left, right, bottom, top but not middle, center.
Tags
Return values
array<string|int, mixed> —Return array with width as index 0, height as index 1.
convertAlpha127ToRgba()
Convert alpha number (0 - 127) to rgba value (1.00 - 0.00).
protected
convertAlpha127ToRgba(int $number) : string
The purpose of this method is for internal use, do not call this method from image's driver class directly due to it can be changed in the future.
Parameters
- $number : int
-
Alpha number (0 to 127). 127 is completely transparent.
Return values
string —Return RGBA value (1.00 to 0.00). 0.00 is completely transparent.
fillWhiteToImage()
Fill white to the image.
protected
fillWhiteToImage() : mixed
getFirstFrame()
Get animated picture's first frame.
protected
getFirstFrame() : mixed
setErrorMessage()
Set error message and code. This will be set statusXxx properties.
protected
setErrorMessage(string $errorMessage, int $errorCode) : mixed
Parameters
- $errorMessage : string
-
The error message.
- $errorCode : int
-
The error code, usually it is class's constant.
Tags
setStatusSuccess()
Set status as success and remove error message, error code.
protected
setStatusSuccess() : mixed
Tags
getImageColorAlpha()
Get image color with alpha value (transparency).
private
getImageColorAlpha(string $colorName, int $alpha) : mixed
Parameters
- $colorName : string
-
The color name. Supported 'black', 'white', 'red', 'green', 'blue', 'yellow', 'cyan', 'magenta'.
- $alpha : int
-
The alpha value for use with
\ImagickPixel('rgba()'). The value should be 0.0 to 1.0.