PHP Class Horde_Image_Im, horde

Author: Chuck Hagenbuch ([email protected])

Author: Mike Cochrane ([email protected])

Author: Michael J. Rubinsky ([email protected])

Inheritance: extends Horde_Image_Base

显示文件 Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_capabilities	string[]	Capabilites of this driver.
$_convert	string	Path to the convert binary.
$_identify	string	Path to the identify binary.
$_operations	array	Operations to be performed before the source filename is specified on the command line.
$_postSrcOperations	array	Operations to be added after the source filename is specified on the command line.
$_toClean	array	Use addFileToClean() from client code (effects) to add files to this array.

Public Methods

Method	Description
__construct ( $params, $context = [] )	Constructor.
addFileToClean ( $filename )
addOperation ( $operation )
addPostSrcOperation ( $operation )
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	Return 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.
executeConvertCmd ( string $cmd, array $values = [] )	Method to execute a raw command directly in convert.
flip ( )	Flips the current image.
getConvertPath ( )
getIMVersion ( ) : string	Returns the version of the convert command available.
getImageAtIndex ( integer $index ) : Horde_Image_Base	Request a specific image from the collection of images.
getImagePageCount ( ) : integer	Return the number of image pages available in the image object.
grayscale ( )	Converts the current image to grayscale.
key ( ) : integer	Get the index of the internal iterator.
line ( integer $x0, integer $y0, integer $x1, integer $y1, string $color = 'black', string $width = 1 )	Draws a line.
mirror ( )	Mirrors the current image.
next ( ) : Horde_Image_Im	Advance 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.
resize ( integer $width, integer $height, boolean $ratio = true, boolean $keepProfile = false )	Resizes the current image.
rewind ( ) : void	Reset the imagick iterator to the first image in the set.
rotate ( integer $angle, integer $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.
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.

Private Methods

Method	Description
_getImagePages ( )
_raw ( boolean $convert = false, integer $index, $preserve_data = false ) : string	Returns the raw data for this image.

Method Details

__construct() public method

Constructor.

addFileToClean() public method

public addFileToClean ( $filename )

addOperation() public method

public addOperation ( $operation )

addPostSrcOperation() public method

public addPostSrcOperation ( $operation )

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

Return 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

executeConvertCmd() public method

Useful for executing more involved operations that may require multiple convert commands piped into each other for example. Really designed for use by Im based Horde_Image_Effect objects. The input and output files are quoted and substituted for __FILEIN__ and __FILEOUT__ respectfully. In order to support piped convert commands, the path to the convert command is substitued for __CONVERT__ (but the initial convert command is added automatically).

public executeConvertCmd ( string $cmd, array $values = [] )
$cmd	string	The command string, with substitutable tokens
$values	array	Any values that should be substituted for tokens.

flip() public method

Flips the current image.

public flip ( )

getConvertPath() public method

public getConvertPath ( )

getIMVersion() public method

This needs to be publicly visable since it's used by various effects.

public getIMVersion ( ) : string
return	string	A version string suitable for using in version_compare().

getImageAtIndex() public method

Request a specific image from the collection of images.

public getImageAtIndex ( integer $index ) : Horde_Image_Base
$index	integer	The index to return
return	Horde_Image_Base

getImagePageCount() public method

Return the number of image pages available in the image object.

public getImagePageCount ( ) : integer
return	integer

grayscale() public method

Converts the current image to grayscale.

public grayscale ( )

key() public method

Get 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.

mirror() public method

Mirrors the current image.

public mirror ( )

next() public method

Advance the iterator

public next ( ) : Horde_Image_Im
return	Horde_Image_Im

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	If true, the image data will be returned in the target format, independently from any image operations.
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.

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

Reset the imagick iterator to the first image in the set.

public rewind ( ) : void
return	void

rotate() public method

Rotates the current image.

public rotate ( integer $angle, integer $background = 'white' )
$angle	integer	The angle to rotate the image by, in the clockwise direction.
$background	integer	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.

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[]

$_convert protected_oe property

Path to the convert binary.

protected string $_convert
return	string

$_identify protected_oe property

Path to the identify binary.

protected string $_identify
return	string

$_operations protected_oe property

Operations to be performed before the source filename is specified on the command line.

protected array $_operations
return	array

$_postSrcOperations protected_oe property

Operations to be added after the source filename is specified on the command line.

protected array $_postSrcOperations
return	array

$_toClean protected_oe property

Use addFileToClean() from client code (effects) to add files to this array.

protected array $_toClean
return	array