Image_Transform
[ class tree: Image_Transform ] [ index: Image_Transform ] [ all elements ]

Class: Image_Transform_Driver_Imagick2

Source Location: /Image_Transform-0.9.5/Image/Transform/Driver/Imagick2.php

Class Overview

Image_Transform
   |
   --Image_Transform_Driver_Imagick2

imagick PECL extension implementation for Image_Transform package


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2002-2005 The PHP Group

Variables

Methods


Inherited Variables

Inherited Methods

Class: Image_Transform

Image_Transform::addBorder()
Image_Transform::addDropShadow()
Image_Transform::addText()
Methods to add to the driver classes in the future
Image_Transform::canvasResize()
Image_Transform::colorarray2colorhex()
Converts an array of RGB value into a #FFFFFF format color.
Image_Transform::colorhex2colorarray()
Converts a color string into an array of RGB values
Image_Transform::crop()
Crops an image
Image_Transform::display()
Outputs the image to standard output
Image_Transform::factory()
Creates a new Image_Transform object
Image_Transform::fit()
Fits the image in the specified box size
Image_Transform::fitOnCanvas()
This works as per fit, but creates the canvas of size $width x $height and positions the resized image on it, by default in the centre.
Image_Transform::fitX()
Fits the image in the specified width
Image_Transform::fitY()
Fits the image in the specified height
Image_Transform::flip()
Vertical mirroring
Image_Transform::free()
Releases resource
Image_Transform::gamma()
Corrects the gamma of an image
Image_Transform::getHandle()
Returns the image handle so that one can further try to manipulate the image
Image_Transform::getImageHeight()
Returns the image height
Image_Transform::getImageSize()
Returns the image size and extra format information
Image_Transform::getImageType()
Returns the type of the image being manipulated
Image_Transform::getImageWidth()
Returns the image width
Image_Transform::getMimeType()
Returns the MIME type of the image being manipulated
Image_Transform::getNewImageHeight()
Return new image Y
Image_Transform::getNewImageWidth()
Returns the new image width
Image_Transform::getTempDir()
Returns the temp directory according to either the TMP, TMPDIR, or TEMP env variables. If these are not set it will also check for the existence of /tmp, %WINDIR%\temp
Image_Transform::getTempFile()
Returns a temporary filename using tempnam() and the above getTmpDir() function.
Image_Transform::getWebSafeFormat()
This looks at the current image type and attempts to determine which
Image_Transform::grayscale()
Converts an image into greyscale colors
Image_Transform::greyscale()
Converts an image into greyscale colors
Image_Transform::intersects()
Checks if the rectangle passed intersects with the current image
Image_Transform::isError()
Returns/sets an error when the instance couldn't initialize properly
Image_Transform::keepSettingsOnSave()
Image_Transform::load()
Loads an image file to work with
Image_Transform::mirror()
Horizontal mirroring
Image_Transform::normalize()
Normalizes the colors, gamma and other properties of an image (this should give a result equivalent to a Photoshop autolevels)
Image_Transform::resize()
Resizes the image in the X and/or Y direction(s)
Image_Transform::rotate()
Rotates the image clockwise
Image_Transform::save()
Saves image to file
Image_Transform::scale()
Scales an image by a percentage, factor or a given length
Image_Transform::scaleByFactor()
Scales an image to a factor of its original size. For example, if my image was 640x480 and I called scaleByFactor(0.5) then the image would be resized to 320x240.
Image_Transform::scaleByLength()
Alias for scaleMaxLength
Image_Transform::scaleByPercentage()
Scales an image to a percentage of its original size. For example, if my image was 640x480 and I called scaleByPercentage(10) then the image would be resized to 64x48
Image_Transform::scaleByX()
Scales the image to the specified width
Image_Transform::scaleByXY()
Alias for resize()
Image_Transform::scaleByY()
Scales the image to the specified height.
Image_Transform::scaleMaxLength()
Scales an image so that the longest side has the specified dimension.
Image_Transform::setOption()
Sets one options
Image_Transform::setOptions()
Sets multiple options at once
Image_Transform::supportsType()
Returns if the driver supports a given image type
Image_Transform::_convert_image_type()
Returns the matching IMAGETYPE_* constant for a given image type
Image_Transform::_getColor()
Returns a color option
Image_Transform::_getOption()
Returns an option
Image_Transform::_get_default_text_params()
Returns the current value of $this->default_text_params.
Image_Transform::_get_image_details()
Sets the image type (in lowercase letters), the image height and width.
Image_Transform::_parse_size()
Parses input for number format and convert
Image_Transform::_prepare_cmd()
Handles space in path and Windows/UNIX difference
Image_Transform::_resize()
Place holder for the real resize method used by extended methods to do the resizing
Image_Transform::_rotation_angle()
Returns an angle between 0 and 360 from any angle value
Image_Transform::_set_img_x()
Sets the image width
Image_Transform::_set_img_y()
Sets the image height
Image_Transform::_set_new_x()
Sets the new image width
Image_Transform::_set_new_y()
Sets the new image height

Class Details

[line 48]
imagick PECL extension implementation for Image_Transform package

WARNING: For version < 2.0 of the extension. For version 2.0 and up use Imagick3 driver instead



[ Top ]


Class Variables

$imageHandle =  null

[line 54]

Handler of the imagick image ressource

Type:   array


[ Top ]

$oldImage =

[line 61]

Handler of the image ressource before

the last transformation


Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 74]

Image_Transform_Driver_Imagick2 __construct( )


[ Top ]

Image_Transform_Driver_Imagick2 (Constructor)   [line 66]

Image_Transform_Driver_Imagick2 Image_Transform_Driver_Imagick2( )


[ Top ]

addText   [line 179]

bool|PEAR_Error addText( array $params)

addText
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::addText() (Methods to add to the driver classes in the future)

Parameters:

array   $params     options Array contains options array( 'text' The string to draw 'x' Horizontal position 'y' Vertical Position 'Color' Font color 'font' Font to be used 'size' Size of the fonts in pixel 'resize_first' Tell if the image has to be resized before drawing the text )

[ Top ]

crop   [line 308]

bool|PEAR_Error crop( int $width, int $height, [int $x = 0], [int $y = 0])

Crops the image
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::crop() (Crops an image)

Parameters:

int   $width     width Cropped image width
int   $height     height Cropped image height
int   $x     x X-coordinate to crop at
int   $y     y Y-coordinate to crop at

[ Top ]

display   [line 259]

bool|PEAR_Error display( [string $type = ''], [int $quality = null])

Displays image without saving and lose changes

This method adds the Content-type HTTP header

  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::display() (Outputs the image to standard output)

Parameters:

string   $type     type (JPG,PNG...);
int   $quality     quality 75

[ Top ]

flip   [line 348]

bool|PEAR_Error flip( )

Vertical mirroring
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::flip() (Vertical mirroring)
[ Top ]

free   [line 362]

void free( )

Destroy image handle
  • Access: public

Overrides Image_Transform::free() (Releases resource)
[ Top ]

gamma   [line 290]

bool|PEAR_Error gamma( [float $outputgamma = 1.0])

Adjusts the image gamma
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::gamma() (Corrects the gamma of an image)

Parameters:

float   $outputgamma     

[ Top ]

load   [line 91]

bool|PEAR_Error load( string $image)

Loads an image
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::load() (Loads an image file to work with)

Parameters:

string   $image     filename

[ Top ]

mirror   [line 333]

bool|PEAR_Error mirror( )

Horizontal mirroring
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::mirror() (Horizontal mirroring)
[ Top ]

raiseError   [line 378]

PEAR raiseError( string $message, [int $code = 0])

RaiseError Method - shows imagick Raw errors.
  • Return: error object
  • Access: protected

Parameters:

string   $message     message = prefixed message..
int   $code     error code

[ Top ]

rotate   [line 145]

bool|PEAR_Error rotate( int $angle, [array $options = null])

Rotates the current image Note: color mask are currently not supported
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::rotate() (Rotates the image clockwise)

Parameters:

int   $angle     Rotation angle in degree
array   $options     No options are currently supported

[ Top ]

save   [line 220]

bool|PEAR_Error save( $filename $filename, [ $type = ''], [ $quality = null])

Saves the image to a file
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::save() (Saves image to file)

Parameters:

$filename   $filename     string the name of the file to write to
   $type     
   $quality     

[ Top ]

_resize   [line 122]

bool|PEAR_Error _resize( int $new_x, int $new_y, [mixed $options = null])

Resize Action
  • Return: TRUE or PEAR_Error object on error
  • Access: protected

Overrides Image_Transform::_resize() (Place holder for the real resize method used by extended methods to do the resizing)

Parameters:

int   $new_x     New width
int   $new_y     New height
mixed   $options     Optional parameters

[ Top ]


Documentation generated on Wed, 04 Apr 2012 00:30:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.