PHP Class Horde_Image_Imagick, horde

Copyright 2007-2014 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Author: Michael J. Rubinsky ([email protected])
Inheritance: extends Horde_Image_Base
Mostrar archivo Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_capabilities string[] Capabilites of this driver.
$_imagick Imagick The underlaying Imagick object.

Public Methods

Method Description
__construct ( $params, $context = [] ) Constructor.
__get ( $property )
applyEffects ( ) Applies any effects in the effect queue.
arc ( integer $x, integer $y, integer $r, integer $start, integer $end, string $color = 'black', string $fill = 'none' ) Draws an arc.
circle ( integer $x, integer $y, integer $r, string $color, string $fill = 'none' ) Draws a circle.
crop ( integer $x1, integer $y1, integer $x2, integer $y2 ) Crops the current image.
current ( ) : Horde_Image_Imagick Returns the current image from the internal iterator.
dashedLine ( integer $x0, integer $y0, integer $x1, integer $y1, string $color = 'black', string $width = 1, integer $dash_length = 2, integer $dash_space = 2 ) Draws a dashed line.
flip ( ) Flips the current image.
frameImage ( &$image, string $color, integer $width, integer $height ) Utility function to wrap Imagick::borderImage.
getDimensions ( ) : array Returns the height and width of the current image data.
getImageAtIndex ( integer $index ) : Horde_Image_Imagick Returns a specific image from the pages of images.
getImagePageCount ( ) : integer Returns the number of image pages available in the image object.
grayscale ( ) Converts the current image to grayscale.
key ( ) : integer Returns the index of the internal iterator.
line ( integer $x0, integer $y0, integer $x1, integer $y1, string $color = 'black', string $width = 1 ) Draws a line.
loadFile ( string $filename ) Loads the image data from a file.
loadString ( string $image_data ) Loads the image data from a string.
mirror ( ) Mirrors the current image.
next ( ) : Horde_Image_Imagick Advances the iterator.
polygon ( $verts, string $color, string $fill = 'none' ) Draws a polygon based on a set of vertices.
polyline ( $verts, string $color, string $width = 1 ) Draws a polyline (a non-closed, non-filled polygon) based on a set of vertices.
raw ( boolean $convert = false ) : string Returns the raw data for this image.
rectangle ( integer $x, integer $y, integer $width, integer $height, string $color, string $fill = 'none' ) Draws a rectangle.
reset ( ) Resets the image data to defaults.
resize ( integer $width, integer $height, boolean $ratio = true, boolean $keepProfile = false ) Resizes the current image.
rewind ( ) Resets the Imagick iterator to the first image in the set.
rotate ( integer $angle, string $background = 'white' ) Rotates the current image.
roundedRectangle ( integer $x, integer $y, integer $width, integer $height, integer $round, string $color, string $fill ) Draws a rounded rectangle.
sepia ( integer $threshold = 85 ) Applies a sepia filter.
setType ( string $type ) : string Sets the output image type.
text ( $string, integer $x, integer $y, string $font = '', string $color = 'black', integer $direction, string $fontsize = 'small' ) Draws a text string on the image in a specified location, with the specified style information.
valid ( ) : boolean Deterimines if the current iterator item is valid.

Method Details

__construct() public method

Constructor.
See also: Horde_Image_Base::_construct
public __construct ( $params, $context = [] )

__get() public method

public __get ( $property )

applyEffects() public method

Applies any effects in the effect queue.
public applyEffects ( )

arc() public method

Draws an arc.
public arc ( integer $x, integer $y, integer $r, integer $start, integer $end, string $color = 'black', string $fill = 'none' )
$x integer The x coordinate of the centre.
$y integer The y coordinate of the centre.
$r integer The radius of the arc.
$start integer The start angle of the arc.
$end integer The end angle of the arc.
$color string The line color of the arc.
$fill string The fill color of the arc (defaults to none).

circle() public method

Draws a circle.
public circle ( integer $x, integer $y, integer $r, string $color, string $fill = 'none' )
$x integer The x coordinate of the centre.
$y integer The y coordinate of the centre.
$r integer The radius of the circle.
$color string The line color of the circle.
$fill string The color to fill the circle.

crop() public method

Crops the current image.
public crop ( integer $x1, integer $y1, integer $x2, integer $y2 )
$x1 integer x for the top left corner.
$y1 integer y for the top left corner.
$x2 integer x for the bottom right corner.
$y2 integer y for the bottom right corner.

current() public method

Returns the current image from the internal iterator.
public current ( ) : Horde_Image_Imagick
return Horde_Image_Imagick

dashedLine() public method

Draws a dashed line.
public dashedLine ( integer $x0, integer $y0, integer $x1, integer $y1, string $color = 'black', string $width = 1, integer $dash_length = 2, integer $dash_space = 2 )
$x0 integer The x co-ordinate of the start.
$y0 integer The y co-ordinate of the start.
$x1 integer The x co-ordinate of the end.
$y1 integer The y co-ordinate of the end.
$color string The line color.
$width string The width of the line.
$dash_length integer The length of a dash on the dashed line.
$dash_space integer The length of a space in the dashed line.

flip() public method

Flips the current image.
public flip ( )

frameImage() public static method

Use when you don't want to replace all pixels in the clipping area with the border color i.e. you want to "frame" the existing image. Preserves transparency etc.
public static frameImage ( &$image, string $color, integer $width, integer $height )
$color string The border color.
$width integer The image width including the border.
$height integer The image height including the border.

getDimensions() public method

Returns the height and width of the current image data.
public getDimensions ( ) : array
return array An hash with 'width' containing the width, 'height' containing the height of the image.

getImageAtIndex() public method

Returns a specific image from the pages of images.
public getImageAtIndex ( integer $index ) : Horde_Image_Imagick
$index integer The index to return.
return Horde_Image_Imagick The requested image

getImagePageCount() public method

Returns the number of image pages available in the image object.
public getImagePageCount ( ) : integer
return integer The number of images.

grayscale() public method

Converts the current image to grayscale.
public grayscale ( )

key() public method

Returns the index of the internal iterator.
public key ( ) : integer
return integer

line() public method

Draws a line.
public line ( integer $x0, integer $y0, integer $x1, integer $y1, string $color = 'black', string $width = 1 )
$x0 integer The x coordinate of the start.
$y0 integer The y coordinate of the start.
$x1 integer The x coordinate of the end.
$y1 integer The y coordinate of the end.
$color string The line color.
$width string The width of the line.

loadFile() public method

Loads the image data from a file.
public loadFile ( string $filename )
$filename string The full path and filename to the file to load the image data from.

loadString() public method

Loads the image data from a string.
public loadString ( string $image_data )
$image_data string The data to use for the image.

mirror() public method

Mirrors the current image.
public mirror ( )

next() public method

Advances the iterator.
public next ( ) : Horde_Image_Imagick
return Horde_Image_Imagick

polygon() public method

Draws a polygon based on a set of vertices.
public polygon ( $verts, string $color, string $fill = 'none' )
$color string The color you want to draw the polygon with.
$fill string The color to fill the polygon.

polyline() public method

Draws a polyline (a non-closed, non-filled polygon) based on a set of vertices.
public polyline ( $verts, string $color, string $width = 1 )
$color string The color you want to draw the line with.
$width string The width of the line.

raw() public method

Returns the raw data for this image.
public raw ( boolean $convert = false ) : string
$convert boolean Ignored for imagick driver.
return string The raw image data.

rectangle() public method

Draws a rectangle.
public rectangle ( integer $x, integer $y, integer $width, integer $height, string $color, string $fill = 'none' )
$x integer The left x-coordinate of the rectangle.
$y integer The top y-coordinate of the rectangle.
$width integer The width of the rectangle.
$height integer The height of the rectangle.
$color string The line color of the rectangle.
$fill string The color to fill the rectangle.

reset() public method

Resets the image data to defaults.
public reset ( )

resize() public method

Resizes the current image.
public resize ( integer $width, integer $height, boolean $ratio = true, boolean $keepProfile = false )
$width integer The new width.
$height integer The new height.
$ratio boolean Maintain original aspect ratio.
$keepProfile boolean Keep the image meta data.

rewind() public method

Resets the Imagick iterator to the first image in the set.
public rewind ( )

rotate() public method

Rotates the current image.
public rotate ( integer $angle, string $background = 'white' )
$angle integer The angle to rotate the image by, in the clockwise direction.
$background string The background color to fill any triangles.

roundedRectangle() public method

Draws a rounded rectangle.
public roundedRectangle ( integer $x, integer $y, integer $width, integer $height, integer $round, string $color, string $fill )
$x integer The left x-coordinate of the rectangle.
$y integer The top y-coordinate of the rectangle.
$width integer The width of the rectangle.
$height integer The height of the rectangle.
$round integer The width of the corner rounding.
$color string The line color of the rectangle.
$fill string The color to fill the rounded rectangle with.

sepia() public method

Applies a sepia filter.
public sepia ( integer $threshold = 85 )
$threshold integer Extent of sepia effect.

setType() public method

Sets the output image type.
public setType ( string $type ) : string
$type string An image type (png, jpg, etc.)
return string The previous image type.

text() public method

Draws a text string on the image in a specified location, with the specified style information.
public text ( $string, integer $x, integer $y, string $font = '', string $color = 'black', integer $direction, string $fontsize = 'small' )
$x integer The left x coordinate of the start of the text string.
$y integer The top y coordinate of the start of the text string.
$font string The font identifier you want to use for the text.
$color string The color that you want the text displayed in.
$direction integer An integer that specifies the orientation of the text.
$fontsize string Size of the font (small, medium, large, giant)

valid() public method

Deterimines if the current iterator item is valid.
public valid ( ) : boolean
return boolean

Property Details

$_capabilities protected_oe property

Capabilites of this driver.
protected string[] $_capabilities
return string[]

$_imagick protected_oe property

The underlaying Imagick object.
protected Imagick $_imagick
return Imagick