phpDocumentor ImageMagick
Classes
[ class tree: ImageMagick ] [ index: ImageMagick ] [ all elements ]

Class: ImageMagickToolkit

Source Location: /modules/imagemagick/classes/ImageMagickToolkit.class

Class ImageMagickToolkit

Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From GalleryToolkit

GalleryToolkit::applyTransform()
Apply the transform operation to the set of target operations. The transform operation
GalleryToolkit::estimateDimensions()
Estimate the dimensions of a GalleryDerivativeImage from its operations and its source.
GalleryToolkit::getProperty()
Get a certain property of a file
GalleryToolkit::mergeOperations()
Merge two operations together in an intelligent way. The end result of
GalleryToolkit::performOperation()
Perform a certain operation

[ Top ]
Method Summary
void   getProperty()  
void   performOperation()  
void   _addResizeParam()   Add parameters for resizing image.
void   _getColorspace()   Call 'identify' to determine the image colorspace
void   _getImageDimensions()  
void   _getPageCount()   Call 'identify' and count the pages
mixed   _imageMagickCmd()   Return the full path to the ImageMagick command
GalleryStatus   _transformImage()   Do the given transform on the source image

[ Top ]
Methods
getProperty  [line 41]

  void getProperty( $mimeType, $propertyName, $sourceFilename  )

Parameters:
   $mimeType: 
   $propertyName: 
   $sourceFilename: 

API Tags:
See:  GalleryToolkit::getProperty


Redefinition of:
GalleryToolkit::getProperty()
Get a certain property of a file

[ Top ]
performOperation  [line 78]

  void performOperation( $mimeType, $operationName, $sourceFilename, $destFilename, $parameters, [ $context = array()]  )

Parameters:
   $mimeType: 
   $operationName: 
   $sourceFilename: 
   $destFilename: 
   $parameters: 
   $context: 

API Tags:
See:  GalleryToolkit::performOperation


Redefinition of:
GalleryToolkit::performOperation()
Perform a certain operation

[ Top ]
_addResizeParam  [line 686]

  void _addResizeParam( &$transform, int $w, [int $h = null], array $transform  )

Add parameters for resizing image.

-size produces faster results when only resizing; incorrect results when combined with other operations like -crop

Parameters:
array   $transform:  parameters
int   $w:  target size
int   $h:  target height (optional)
   &$transform: 

API Tags:
Access:  private


[ Top ]
_getColorspace  [line 470]

  void _getColorspace( $filename  )

Call 'identify' to determine the image colorspace

Parameters:
   $filename: 

API Tags:
Access:  private


[ Top ]
_getImageDimensions  [line 380]

  void _getImageDimensions( $mimeType, $filename  )

Parameters:
   $mimeType: 
   $filename: 

API Tags:
See:  GalleryToolkit::getImageDimensions


[ Top ]
_getPageCount  [line 421]

  void _getPageCount( $filename, $mimeType  )

Call 'identify' and count the pages

Parameters:
   $filename: 
   $mimeType: 

API Tags:
Access:  private


[ Top ]
_imageMagickCmd  [line 666]

  mixed _imageMagickCmd( string $cmd  )

Return the full path to the ImageMagick command

Parameters:
string   $cmd:  an ImageMagick command (eg. "convert")

API Tags:
Return:  string/error?
Access:  private


[ Top ]
_transformImage  [line 505]

  GalleryStatus _transformImage( string $mimeType, string $cmd, array $args, string $sourceFilename, string $destFilename, string $outputMimeType, [string $jpegQuality = null]  )

Do the given transform on the source image

Parameters:
string   $mimeType:  source mime type
string   $cmd:  the command to execute
array   $args: 
string   $sourceFilename:  the path to a source file
string   $destFilename:  the path to a destination file
string   $outputMimeType: 
string   $jpegQuality:  (optional)

API Tags:
Return:  a status code
Access:  private


[ Top ]

Documentation generated on Fri, 03 Oct 2008 05:20:45 -0700 by phpDocumentor 1.3.0RC6