eZ Components 1.1

Getting Started

Components

Archive (1.1)
Base (1.1)
Cache (1.1)
Configuration (1.0.2)
ConsoleTools (1.1)
Database (1.1)
DatabaseSchema (1.0)
Debug (1.0)
EventLog (1.0.1)
EventLogDatabaseTiein (1.0)
Execution (1.0)
File (1.0)
ImageAnalysis (1.0.1)
ImageConversion (1.1)
Mail (1.1)
PersistentObject (1.1)
PersistentObjectDatabaseSchemaTiein (1.0)
PhpGenerator (1.0)
SystemInformation (1.0)
Template (1.0)
Translation (1.1)
TranslationCacheTiein (1.1)
UserInput (1.0)

ImageConversion: ezcImageImagemagickHandler

[ Tutorial ] [ Class tree ] [ Element index ] [ ChangeLog ] [ Credits ]

Class: ezcImageImagemagickHandler

ezcImageHandler implementation for ImageMagick. [source]

Implemented Interfaces

Parents

ezcImageMethodcallHandler
   |
   --ezcImageImagemagickBaseHandler
      |
      --ezcImageImagemagickHandler

Method Summary

public void	`border( $width, $color )` Border filter.
public void	`colorspace( $space )` Colorspace filter.
public void	`crop( $x, $y, $width, $height )` Crop filter.
protected string	`getDirectionModifier( $direction )` Returns the ImageMagick direction modifier for a direction constant.
public void	`noise( $value )` Noise filter.
public void	`scale( $width, $height, [$direction = ezcImageGeometryFilters::SCALE_BOTH] )` Scale filter.
public void	`scaleExact( $width, $height )` Scale exact filter.
public void	`scaleHeight( $height, $direction )` Scale after height filter.
public void	`scalePercent( $width, $height )` Scale percent measures filter.
public void	`scaleWidth( $width, $direction )` Scale after width filter.
public void	`swirl( $value )` Swirl filter.

Inherited Methods

From ezcImageImagemagickBaseHandler :

public ezcImageImagemagickBaseHandler	`ezcImageImagemagickBaseHandler::__construct()` Create a new image handler.
protected void	`ezcImageImagemagickBaseHandler::addFilterOption()` Add a filter option to a given reference
public void	`ezcImageImagemagickBaseHandler::close()` Close the file referenced by $image.
public static ezcImageHandlerSettings	`ezcImageImagemagickBaseHandler::defaultSettings()` Creates default settings for the handler and returns it.
public string	`ezcImageImagemagickBaseHandler::load()` Load an image file.
public void	`ezcImageImagemagickBaseHandler::save()` Save an image file.

Methods

border

void border( int $width, $color )

Border filter.

Adds a border to the image. The width is measured in pixel. The color is defined in an array of hex values:

1.  array(
2.       0 => <red value>,
3.       1 => <green value>,
4.       2 => <blue value>,
5.  );

ATTENTION: Using this filter method directly results in the filter being applied to the image which is internally marked as "active" (most commonly this is the last recently loaded one). It is highly recommended to apply filters through the ezcImageImagemagickHandler::applyFilter() method, which enables you to specify the image a filter is applied to.

Parameters

Name	Type	Description
`$width`	int	Width of the border.
`$color`	array(int)	Color.

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference.
`ezcBaseValueException`	If a submitted parameter was out of range or type.

colorspace

void colorspace( int $space )

Colorspace filter.

Transform the color space of the picture. The following color space are supported:

self::COLORSPACE_GREY - 255 grey colors
self::COLORSPACE_SEPIA - Sepia colors
self::COLORSPACE_MONOCHROME - 2 colors black and white

Parameters

Name	Type	Description
`$space`	int	Colorspace, one of self::COLORSPACE_* constants.

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference
`ezcBaseValueException`	If the parameter submitted as the colorspace was not within the self::COLORSPACE_* constants.

crop

void crop( int $x, int $y, int $width, int $height )

Crop filter.

Crop an image to a given size. This takes cartesian coordinates of a rect area to crop from the image. The cropped area will replace the old image resource (not the input image immediately, if you use the ezcImageConverter). Coordinates are given as integer values and are measured from the top left corner.

Parameters

Name	Type	Description
`$x`	int	Start cropping, x coordinate.
`$y`	int	Start cropping, y coordinate.
`$width`	int	Width of cropping area.
`$height`	int	Height of cropping area.

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference.
`ezcBaseValueException`	If a submitted parameter was out of range or type.

getDirectionModifier

string getDirectionModifier( int $direction )

Returns the ImageMagick direction modifier for a direction constant.

ImageMagick supports the following modifiers to determine if an image should be scaled up only, down only or in both directions:

1.   SCALE_UP:   >
2.   SCALE_DOWN: <

This method returns the correct modifier for the internal direction constants.

Parameters

Name	Type	Description
`$direction`	int	One of ezcImageGeometryFilters::SCALE_*

Throws

Class	Description
`ezcBaseValueException`	If a submitted parameter was out of range or type.

noise

void noise( strings $value )

Noise filter.

Apply a noise transformation to the image. Valid values are the following strings:

'Uniform'
'Gaussian'
'Multiplicative'
'Impulse'
'Laplacian'
'Poisson'

Parameters

Name	Type	Description
`$value`	strings	Noise value as described above.

Throws

Class	Description
`ezcBaseValueException`	If the noise value is out of range.
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference.

scale

void scale( int $width, int $height, [int $direction = ezcImageGeometryFilters::SCALE_BOTH] )

Scale filter.

General scale filter. Scales the image to fit into a given box size, determined by a given width and height value, measured in pixel. This method maintains the aspect ratio of the given image. Depending on the given direction value, this method performs the following scales:

ezcImageGeometryFilters::SCALE_BOTH: The image will be scaled to fit exactly into the given box dimensions, no matter if it was smaller or larger as the box before.
ezcImageGeometryFilters::SCALE_DOWN: The image will be scaled to fit exactly into the given box only if it was larger than the given box dimensions before. If it is smaller, the image will not be scaled at all.
ezcImageGeometryFilters::SCALE_UP: The image will be scaled to fit exactly into the given box only if it was smaller than the given box dimensions before. If it is larger, the image will not be scaled at all. ATTENTION: In this case, the image does not necessarily fit into the given box afterwards.

Parameters

Name	Type	Description
`$width`	int	Scale to width
`$height`	int	Scale to height
`$direction`	int	Scale to which direction.

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference.
`ezcBaseValueException`	If a submitted parameter was out of range or type.

scaleExact

void scaleExact( int $width, int $height )

Scale exact filter.

Scale the image to a fixed given pixel size, no matter to which direction.

Parameters

Name	Type	Description
`$width`	int	Scale to width
`$height`	int	Scale to height

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference.
`ezcBaseValueException`	If a submitted parameter was out of range or type.

scaleHeight

void scaleHeight( int $height, int $direction )

Scale after height filter.

Scales the image to a give height, measured in pixel. Scales the width automatically while keeping the ratio. The direction dictates, if an image may only be scaled self::SCALE_UP, self::SCALE_DOWN or if the scale may work in self::SCALE_BOTH directions.

Parameters

Name	Type	Description
`$height`	int	Scale to height
`$direction`	int	Scale to which direction

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference
`ezcBaseValueException`	If a submitted parameter was out of range or type.

scalePercent

void scalePercent( int $width, int $height )

Scale percent measures filter.

Scale an image to a given percentage value size.

Parameters

Name	Type	Description
`$width`	int	Scale to width
`$height`	int	Scale to height

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference
`ezcBaseValueException`	If a submitted parameter was out of range or type.

scaleWidth

void scaleWidth( int $width, int $direction )

Scale after width filter.

Scales the image to a give width, measured in pixel. Scales the height automatically while keeping the ratio. The direction dictates, if an image may only be scaled self::SCALE_UP, self::SCALE_DOWN or if the scale may work in self::SCALE_BOTH directions.

Parameters

Name	Type	Description
`$width`	int	Scale to width
`$direction`	int	Scale to which direction

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference
`ezcBaseValueException`	If a submitted parameter was out of range or type.

swirl

void swirl( int $value )

Swirl filter.

Applies a swirl with the given intense to the image.

Parameters

Name	Type	Description
`$value`	int	Intense of swirl.

Throws

Class	Description
`ezcImageInvalidReferenceException`	No loaded file could be found or an error destroyed a loaded reference.
`ezcBaseValueException`	If the swirl value is out of range.

Last updated: Wed, 28 Nov 2007

eZ Components

User menu

Path

eZ Components 1.1

Getting Started

Components

ImageConversion: ezcImageImagemagickHandler

Class: ezcImageImagemagickHandler

Implemented Interfaces

Parents

Method Summary

Inherited Methods

Methods

border

Parameters

Throws

colorspace

Parameters

Throws

crop

Parameters

Throws

getDirectionModifier

Parameters

Throws

noise

Parameters

Throws

scale

Parameters

Throws

scaleExact

Parameters

Throws

scaleHeight

Parameters

Throws

scalePercent

Parameters

Throws

scaleWidth

Parameters

Throws

swirl

Parameters

Throws