Overview

Packages

  • Image
  • None

Classes

  • Horde_Image
  • Horde_Image_Base
  • Horde_Image_Effect
  • Horde_Image_Effect_Border
  • Horde_Image_Effect_Gd_DropShadow
  • Horde_Image_Effect_Gd_RoundCorners
  • Horde_Image_Effect_Gd_TextWatermark
  • Horde_Image_Effect_Gd_Unsharpmask
  • Horde_Image_Effect_Im_Border
  • Horde_Image_Effect_Im_CenterCrop
  • Horde_Image_Effect_Im_Composite
  • Horde_Image_Effect_Im_DropShadow
  • Horde_Image_Effect_Im_LiquidResize
  • Horde_Image_Effect_Im_PhotoStack
  • Horde_Image_Effect_Im_PolaroidImage
  • Horde_Image_Effect_Im_RoundCorners
  • Horde_Image_Effect_Im_TextWatermark
  • Horde_Image_Effect_Im_Unsharpmask
  • Horde_Image_Effect_Imagick_Border
  • Horde_Image_Effect_Imagick_CenterCrop
  • Horde_Image_Effect_Imagick_Composite
  • Horde_Image_Effect_Imagick_DropShadow
  • Horde_Image_Effect_Imagick_LiquidResize
  • Horde_Image_Effect_Imagick_PhotoStack
  • Horde_Image_Effect_Imagick_PolaroidImage
  • Horde_Image_Effect_Imagick_RoundCorners
  • Horde_Image_Effect_Imagick_SmartCrop
  • Horde_Image_Effect_Imagick_TextWatermark
  • Horde_Image_Effect_Imagick_Unsharpmask
  • Horde_Image_Exception
  • Horde_Image_Exif
  • Horde_Image_Exif_Base
  • Horde_Image_Exif_Bundled
  • Horde_Image_Exif_Exiftool
  • Horde_Image_Exif_Parser_Base
  • Horde_Image_Exif_Php
  • Horde_Image_Gd
  • Horde_Image_Im
  • Horde_Image_Imagick
  • Horde_Image_Png
  • Horde_Image_Svg
  • Horde_Image_Swf
  • Horde_Image_Translation
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Image_Im

This class implements the Horde_Image:: API for ImageMagick.

Copyright 2002-2012 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.

EmptyIterator implements Iterator, Traversable
Extended by Horde_Image_Base
Extended by Horde_Image_Im
Package: Image
Author: Chuck Hagenbuch chuck@horde.org
Author: Mike Cochrane mike@graftonhall.co.nz
Author: Michael J. Rubinsky mrubinsk@horde.org
Located at Horde/Image/Im.php
Methods summary
public
# __construct( array $params, array $context = array() )

Constructor.

Constructor.

Parameters

$params
The image object parameters. Values include: <pre>(optional)width - The desired image width (optional)height - The desired image height (optional)type - The image type (png, jpeg etc...) <span class="php-keyword1">If</span> not provided, <span class="php-keyword1">or</span> set by the <span class="php-keyword2">setType</span> method, any image output will be converted to the <span class="php-keyword1">default</span> image type of png. (optional)data - The image binary data.</pre>
$context
The object context - configuration, injected objects <pre>(required)tmpdir - Temporary directory (optional)logger - The logger</pre>

Throws

InvalidArgumentException

See

Horde_Image_Base::_construct
public string
# raw( boolean $convert = false )

Publically visible raw method.

Publically visible raw method.

Parameters

$convert
<p>If true, the image data will be returned in the target format, independently from any image operations.</p>

Returns

string
The raw image data.

See

self::_raw

Overrides

Horde_Image_Base::raw()
public
# reset( )

Reset the image data.

Reset the image data.

Overrides

Horde_Image_Base::reset()
public
# resize( integer $width, integer $height, boolean $ratio = true, boolean $keepProfile = false )

Resize the current image. This operation takes place immediately.

Resize the current image. This operation takes place immediately.

Parameters

$width
The new width.
$height
The new height.
$ratio
Maintain original aspect ratio.
$keepProfile
Keep the image meta data.
public
# crop( integer $x1, integer $y1, integer $x2, integer $y2 )

Crop the current image.

Crop the current image.

Parameters

$x1
x for the top left corner
$y1
y for the top left corner
$x2
x for the bottom right corner of the cropped image.
$y2
y for the bottom right corner of the cropped image.
public
# rotate( integer $angle, integer $background = 'white' )

Rotate the current image. This is an atomic operation.

Rotate the current image. This is an atomic operation.

Parameters

$angle
<p>The angle to rotate the image by, in the clockwise direction.</p>
$background
The background color to fill any triangles.
public
# flip( )

Flip the current image.

Flip the current image.
public
# mirror( )

Mirror the current image.

Mirror the current image.
public
# grayscale( )

Convert the current image to grayscale.

Convert the current image to grayscale.
public
# sepia( integer $threshold = 85 )

Sepia filter.

Sepia filter.

Parameters

$threshold
Extent of sepia effect.
public
# text( string $string, integer $x, integer $y, string $font = '', string $color = 'black', integer $direction = 0, string $fontsize = 'small' )

Draws a text string on the image in a specified location, with the specified style information.

Draws a text string on the image in a specified location, with the specified style information.

Parameters

$string
$text The text to draw.
$x
The left x coordinate of the start of the text string.
$y
The top y coordinate of the start of the text string.
$font
The font identifier you want to use for the text.
$color
The color that you want the text displayed in.
$direction
An integer that specifies the orientation of the text.
$fontsize
Size of the font (small, medium, large, giant)

Todo:

Need to differentiate between the stroke (border) and the fill color, but this is a BC break, since we were just not providing a border.
public
# circle( integer $x, integer $y, integer $r, string $color, string $fill = 'none' )

Draw a circle.

Draw a circle.

Parameters

$x
The x coordinate of the centre.
$y
The y coordinate of the centre.
$r
The radius of the circle.
$color
The line color of the circle.
$fill
The color to fill the circle.
public
# polygon( array $verts, string $color, string $fill = 'none' )

Draw a polygon based on a set of vertices.

Draw a polygon based on a set of vertices.

Parameters

$verts
<p>$vertices An array of x and y labeled arrays (eg. $vertices[0]['x'], $vertices[0]['y'], ...).</p>
$color
The color you want to draw the polygon with.
$fill
The color to fill the polygon.
public
# rectangle( integer $x, integer $y, integer $width, integer $height, string $color, string $fill = 'none' )

Draw a rectangle.

Draw a rectangle.

Parameters

$x
The left x-coordinate of the rectangle.
$y
The top y-coordinate of the rectangle.
$width
The width of the rectangle.
$height
The height of the rectangle.
$color
The line color of the rectangle.
$fill
The color to fill the rectangle.
public
# roundedRectangle( integer $x, integer $y, integer $width, integer $height, integer $round, string $color, string $fill )

Draw a rounded rectangle.

Draw a rounded rectangle.

Parameters

$x
The left x-coordinate of the rectangle.
$y
The top y-coordinate of the rectangle.
$width
The width of the rectangle.
$height
The height of the rectangle.
$round
The width of the corner rounding.
$color
The line color of the rectangle.
$fill
The color to fill the rounded rectangle with.
public
# line( integer $x0, integer $y0, integer $x1, integer $y1, string $color = 'black', string $width = 1 )

Draw a line.

Draw a line.

Parameters

$x0
The x coordinate of the start.
$y0
The y coordinate of the start.
$x1
The x coordinate of the end.
$y1
The y coordinate of the end.
$color
The line color.
$width
The width of the 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 )

Draw a dashed line.

Draw a dashed line.

Parameters

$x0
The x co-ordinate of the start.
$y0
The y co-ordinate of the start.
$x1
The x co-ordinate of the end.
$y1
The y co-ordinate of the end.
$color
The line color.
$width
The width of the line.
$dash_length
The length of a dash on the dashed line
$dash_space
The length of a space in the dashed line
public
# polyline( array $verts, string $color, string $width = 1 )

Draw a polyline (a non-closed, non-filled polygon) based on a set of vertices.

Draw a polyline (a non-closed, non-filled polygon) based on a set of vertices.

Parameters

$verts
<p>$vertices An array of x and y labeled arrays (eg. $vertices[0]['x'], $vertices[0]['y'], ...).</p>
$color
The color you want to draw the line with.
$width
The width of the line.
public
# arc( integer $x, integer $y, integer $r, integer $start, integer $end, string $color = 'black', string $fill = 'none' )

Draw an arc.

Draw an arc.

Parameters

$x
The x coordinate of the centre.
$y
The y coordinate of the centre.
$r
The radius of the arc.
$start
The start angle of the arc.
$end
The end angle of the arc.
$color
The line color of the arc.
$fill
The fill color of the arc (defaults to none).
public
# applyEffects( )

Apply any effects in the effect queue.

Apply any effects in the effect queue.

Overrides

Horde_Image_Base::applyEffects()
public mixed
# executeConvertCmd( string $cmd, array $values = array() )

Method to execute a raw command directly in convert. 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..

Method to execute a raw command directly in convert. 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).

Parameters

$cmd
The command string, with substitutable tokens
$values
Any values that should be substituted for tokens.

Returns

mixed
public A
# getIMVersion( )

Get the version of the convert command available. This needs to be publicly visable since it's used by various Effects.

Get the version of the convert command available. This needs to be publicly visable since it's used by various Effects.

Returns

A
version string suitable for using in version_compare()
public
# addPostSrcOperation( mixed $operation )
public
# addOperation( mixed $operation )
public
# addFileToClean( mixed $filename )
public
# getConvertPath( )
public
# rewind( )

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

Reset the imagick iterator to the first image in the set.
public Horde_Image_Imagick
# current( )

Return the current image from the internal iterator.

Return the current image from the internal iterator.

Returns

Horde_Image_Imagick
public integer
# key( )

Get the index of the internal iterator.

Get the index of the internal iterator.

Returns

integer
public Horde_Image_Im
# next( )

Advance the iterator

Advance the iterator

Returns

Horde_Image_Im
public boolean
# valid( )

Deterimines if the current iterator item is valid.

Deterimines if the current iterator item is valid.

Returns

boolean
public Horde_Image_Base
# getImageAtIndex( integer $index )

Request a specific image from the collection of images.

Request a specific image from the collection of images.

Parameters

$index
The index to return

Returns

Horde_Image_Base
public integer
# getImagePageCount( )

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

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

Returns

integer
Methods inherited from Horde_Image_Base
addEffect(), brush(), clearGeometry(), display(), getCapabilities(), getContentType(), getDimensions(), getLoadedEffects(), getTmpDir(), getType(), hasCapability(), headers(), loadFile(), loadString(), setType(), toFile()
API documentation generated by ApiGen