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

Class: Image_Transform_Driver_Imagick3

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

Class Overview

Image_Transform
   |
   --Image_Transform_Driver_Imagick3

imagick PECL extension implementation for Image_Transform package


Author(s):

Version:

  • Release: @package_version@

Copyright:

  • 2007 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 46]
imagick PECL extension implementation for Image_Transform package

For use of version 2+ of the extension. For version 0.9.* use Imagick2 driver instead



[ Top ]


Class Variables

$imagick =  null

[line 52]

Instance of imagick

Type:   Imagick


[ Top ]

$oldImage =

[line 59]

Handler of the image resource before

the last transformation


Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 72]

Image_Transform_Driver_Imagick3 __construct( )


[ Top ]

Image_Transform_Driver_Imagick3 (Constructor)   [line 64]

Image_Transform_Driver_Imagick3 Image_Transform_Driver_Imagick3( )


[ Top ]

addText   [line 196]

bool|PEAR_Error addText( array $params)

Adds text to the image
  • 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     Array contains options:
  • 'text' (string) The string to draw
  • 'x' (integer) Horizontal position
  • 'y' (integer) Vertical Position
  • 'Color' (mixed) Font color
  • 'font' (string) Font to be used
  • 'size' (integer) Size of the fonts in pixel

[ Top ]

crop   [line 340]

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

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

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

Parameters:

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

[ Top ]

display   [line 284]

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

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

void free( )

Destroy image handle
  • Access: public

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

gamma   [line 322]

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 ]

greyscale   [line 368]

bool|PEAR_Error greyscale( )

Converts the image to greyscale
  • Return: TRUE or a PEAR_Error object on error
  • Access: public

Overrides Image_Transform::greyscale() (Converts an image into greyscale colors)
[ Top ]

load   [line 90]

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

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

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

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

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

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

Parameters:

float   $angle     Rotation angle in degree
array   $options     Supported options:
  • 'canvasColor' : array(r ,g, b), named color or #rrggbb

[ Top ]

save   [line 238]

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

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

Resizes the image
  • 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:

integer   $new_x     New width
integer   $new_y     New height
mixed   $options     Optional parameters
  • 'scaleMethod': "pixel" or "smooth"

[ Top ]


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