## Apache Zeta Components Manual :: Package ImageConversion Element Index

## Element index for package ImageConversion

#### Package indexes

- Document
- NoPackageName
- SystemInformation
- File
- UserInput
- PersistentObjectDatabaseSchemaTiein
- ConsoleTools
- Cache
- Database
- UnitTest
- Feed
- Base
- AuthenticationDatabaseTiein
- TemplateTranslationTiein
- MvcMailTiein
- MvcTools
- MvcTemplateTiein
- Reflection
- Authentication
- Execution
- TranslationCacheTiein
- Archive
- Url
- PhpGenerator
- WorkflowDatabaseTiein
- SignalSlot
- DatabaseSchema
- TreePersistentObjectTiein
- EventLog
- Tree
- Workflow
- PersistentObject
- Graph
- EventLogDatabaseTiein
- Translation
- WorkflowSignalSlotTiein
- Template
- Webdav
- Debug
- GraphDatabaseTiein
- MvcAuthenticationTiein
- MvcFeedTiein
- Mail
- TreeDatabaseTiein
- ImageAnalysis
- Search
- Configuration
- WorkflowEventLogTiein

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ l ] [ m ] [ n ] [ o ] [ p ] [ r ] [ s ] [ t ] [ w ] [ _ ]

### Letter '_'

__construct
  in file mime_type_unsupported.php, method ezcImageMimeTypeUnsupportedException::__construct()
  Creates a new ezcImageMimeTypeUnsupportedException.
__construct
  in file invalid_reference.php, method ezcImageInvalidReferenceException::__construct()
  Creates a new ezcImageInvalidReferenceException.
__construct
  in file invalid_filter_parameter.php, method ezcImageInvalidFilterParameterException::__construct()
  Creates a new ezcImageInvalidFilterParameterException.
__construct
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::__construct()
  Create a new image handler.
__construct
  in file missing_filter_parameter.php, method ezcImageMissingFilterParameterException::__construct()
  Creates a new ezcImageMissingFilterParameterException.
__construct
  in file transformation.php, method ezcImageTransformation::__construct()
  Initialize transformation.
__construct
  in file transformation_not_available.php, method ezcImageTransformationNotAvailableException::__construct()
  Creates a new ezcImageTransformationNotAvailableException.
__construct
  in file transformation_already_exists.php, method ezcImageTransformationAlreadyExistsException::__construct()
  Creates a new ezcImageTransformationAlreadyExistsException.
__construct
  in file transformation.php, method ezcImageTransformationException::__construct()
  Creates a new ezcImageTransformationException using a parent exception.
__construct
  in file handler_settings_invalid.php, method ezcImageHandlerSettingsInvalidException::__construct()
  Creates a new ezcImageHandlerSettingsInvalidException.
__construct
  in file handler_settings.php, method ezcImageHandlerSettings::__construct()
  Initialize settings to be used by image handler.
__construct
  in file filter.php, method ezcImageFilter::__construct()
  Initialize with the filter name and options.
__construct
  in file file_not_processable.php, method ezcImageFileNotProcessableException::__construct()
  Creates a new ezcImageFileNotProcessableException.
__construct
  in file file_name_invalid.php, method ezcImageFileNameInvalidException::__construct()
  Creates a new ezcImageFileNameInvalidException.
__construct
  in file converter_settings.php, method ezcImageConverterSettings::__construct()
  Create a new instance of ezcImageConverterSettings.
__construct
  in file filter_failed.php, method ezcImageFilterFailedException::__construct()
  Creates a new ezcImageFilterFailedException.
__construct
  in file filter_not_available.php, method ezcImageFilterNotAvailableException::__construct()
  Creates a new ezcImageFilterNotAvailableException.
__construct
  in file handler_not_available.php, method ezcImageHandlerNotAvailableException::__construct()
  Creates a new ezcImageHandlerNotAvailableException.
__construct
  in file handler.php, method ezcImageHandler::__construct()
  Create a new image handler.
__construct
  in file gd_base.php, method ezcImageGdBaseHandler::__construct()
  Create a new image handler.
__construct
  in file converter.php, method ezcImageConverter::__construct()
  Initialize converter with settings object.

### Letter 'a'

addCompositeImage
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::addCompositeImage()
  Add an image to composite with the given reference.
addFilter
  in file transformation.php, method ezcImageTransformation::addFilter()
  Add a filter to the conversion.
addFilterOption
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::addFilterOption()
  Add a filter option to a given reference
allowsInput
  in file converter.php, method ezcImageConverter::allowsInput()
  Returns if a handler is found, supporting the given MIME type for output.
allowsInput
  in file handler.php, method ezcImageHandler::allowsInput()
  Check wether a specific MIME type is allowed as input for this handler.
allowsOutput
  in file handler.php, method ezcImageHandler::allowsOutput()
  Checks wether a specific MIME type is allowed as output for this handler.
allowsOutput
  in file converter.php, method ezcImageConverter::allowsOutput()
  Returns if a handler is found, supporting the given MIME type for output.
applyFilter
  in file converter.php, method ezcImageConverter::applyFilter()
  Apply a single filter to an image.
applyFilter
  in file handler.php, method ezcImageHandler::applyFilter()
  Applies a filter to a given image.

### Letter 'b'

border
  in file imagemagick.php, method ezcImageImagemagickHandler::border()
  Border filter.
border
  in file effect.php, method ezcImageEffectFilters::border()
  Border filter.

### Letter 'c'

$className
  in file handler_settings.php, variable ezcImageHandlerSettings::$className
  Name of the class to instantiate as image handler.
$conversions
  in file converter_settings.php, variable ezcImageConverterSettings::$conversions
  Map of automatic MIME type conversions. The converter will automatically perform the defined conversions when a transformation is applied through it and the specific MIME type is recognized.
$converter
  in file transformation.php, variable ezcImageTransformation::$converter
  The ezcImageConverter
checkFileName
  in file handler.php, method ezcImageHandler::checkFileName()
  Checks a file name for illegal characters.
close
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::close()
  Close the file referenced by $image.
close
  in file handler.php, method ezcImageHandler::close()
  Close the file referenced by $image.
close
  in file gd_base.php, method ezcImageGdBaseHandler::close()
  Close the file referenced by $image.
colorArrayToString
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::colorArrayToString()
  Returns a string representation of the given color array.
colorspace
  in file imagemagick.php, method ezcImageImagemagickHandler::colorspace()
  Colorspace filter.
colorspace
  in file gd.php, method ezcImageGdHandler::colorspace()
  Colorspace filter.
colorspace
  in file colorspace.php, method ezcImageColorspaceFilters::colorspace()
  Colorspace filter.
COLORSPACE_GREY
  in file colorspace.php, class constant ezcImageColorspaceFilters::COLORSPACE_GREY
  Grey color space.
COLORSPACE_MONOCHROME
  in file colorspace.php, class constant ezcImageColorspaceFilters::COLORSPACE_MONOCHROME
  Monochrome color space.
COLORSPACE_SEPIA
  in file colorspace.php, class constant ezcImageColorspaceFilters::COLORSPACE_SEPIA
  Sepia color space.
convert
  in file handler.php, method ezcImageHandler::convert()
  Converts an image to another MIME type.
createTransformation
  in file converter.php, method ezcImageConverter::createTransformation()
  Create a transformation in the manager.
crop
  in file gd.php, method ezcImageGdHandler::crop()
  Crop filter.
crop
  in file imagemagick.php, method ezcImageImagemagickHandler::crop()
  Crop filter.
crop
  in file geometry.php, method ezcImageGeometryFilters::crop()
  Crop filter.
croppedThumbnail
  in file thumbnail.php, method ezcImageThumbnailFilters::croppedThumbnail()
  Creates a thumbnail, and crops parts of the given image to fit the range best.
croppedThumbnail
  in file gd.php, method ezcImageGdHandler::croppedThumbnail()
  Creates a thumbnail, and crops parts of the given image to fit the range best.
croppedThumbnail
  in file imagemagick.php, method ezcImageImagemagickHandler::croppedThumbnail()
  Creates a thumbnail, and crops parts of the given image to fit the range best.
converter.php
  procedural page converter.php
colorspace.php
  procedural page colorspace.php
converter_settings.php
  procedural page converter_settings.php

### Letter 'd'

defaultSettings
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::defaultSettings()
  Creates default settings for the handler and returns it.
defaultSettings
  in file gd_base.php, method ezcImageGdBaseHandler::defaultSettings()
  Creates default settings for the handler and returns it.

### Letter 'e'

ezcImageColorspaceFilters
  in file colorspace.php, class ezcImageColorspaceFilters
  This interface has to implemented by ezcImageFilters classes to support colorspace filters.
ezcImageConverter
  in file converter.php, class ezcImageConverter
  Class to manage conversion and filtering of image files.
ezcImageConverterSettings
  in file converter_settings.php, class ezcImageConverterSettings
  Struct to store the settings for objects of ezcImageConverter.
ezcImageEffectFilters
  in file effect.php, class ezcImageEffectFilters
  This interface has to be implemented by ezcImageFilters classes to support effect filters.
ezcImageException
  in file exception.php, class ezcImageException
  General exception container for the ImageConversion component.
ezcImageFileNameInvalidException
  in file file_name_invalid.php, class ezcImageFileNameInvalidException
  Thrown if a given file name contains illegal characters (', ", $).
ezcImageFileNotProcessableException
  in file file_not_processable.php, class ezcImageFileNotProcessableException
  Thrown if a file could not be processed by a handler.
ezcImageFilter
  in file filter.php, class ezcImageFilter
  Struct to store information about a filter operation.
ezcImageFilterFailedException
  in file filter_failed.php, class ezcImageFilterFailedException
  Thrown if the given filter failed.
ezcImageFilterNotAvailableException
  in file filter_not_available.php, class ezcImageFilterNotAvailableException
  Thrown if the given filter is not available.
ezcImageGdBaseHandler
  in file gd_base.php, class ezcImageGdBaseHandler
  ezcImageHandler implementation for the GD2 extension of PHP.
ezcImageGdHandler
  in file gd.php, class ezcImageGdHandler
  ezcImageHandler implementation for the GD2 extension of PHP, including filters.
ezcImageGeometryFilters
  in file geometry.php, class ezcImageGeometryFilters
  This interface has to implemented by ezcImageFilters classes to support geometry filters.
ezcImageHandler
  in file handler.php, class ezcImageHandler
  Driver interface to access different image manipulation backends of PHP.
ezcImageHandlerNotAvailableException
  in file handler_not_available.php, class ezcImageHandlerNotAvailableException
  Thrown if a specified handler class is not available.
ezcImageHandlerSettings
  in file handler_settings.php, class ezcImageHandlerSettings
  Struct to store the settings for objects of ezcImageHandler.
ezcImageHandlerSettingsInvalidException
  in file handler_settings_invalid.php, class ezcImageHandlerSettingsInvalidException
  Thrown if invalid handler settings are submitted when creating an ezcImageConverter.
ezcImageImagemagickBaseHandler
  in file imagemagick_base.php, class ezcImageImagemagickBaseHandler
  ezcImageHandler implementation for ImageMagick.
ezcImageImagemagickHandler
  in file imagemagick.php, class ezcImageImagemagickHandler
  ezcImageHandler implementation for ImageMagick.
ezcImageInvalidFilterParameterException
  in file invalid_filter_parameter.php, class ezcImageInvalidFilterParameterException
  Thrown if the given filter failed.
ezcImageInvalidReferenceException
  in file invalid_reference.php, class ezcImageInvalidReferenceException
  Thrown if no valid image reference could be found for an action (conversion, filter, load, save,...).
ezcImageMimeTypeUnsupportedException
  in file mime_type_unsupported.php, class ezcImageMimeTypeUnsupportedException
  Thrown if a requested MIME type is not supported for input, output or input/output.
ezcImageMissingFilterParameterException
  in file missing_filter_parameter.php, class ezcImageMissingFilterParameterException
  Thrown if an expected parameter for a filter was not submitted.
ezcImageSaveOptions
  in file save_options.php, class ezcImageSaveOptions
  Options class for ezcImageHandler->save() methods.
ezcImageThumbnailFilters
  in file thumbnail.php, class ezcImageThumbnailFilters
  This interface has to implemented by ezcImageFilters classes to support thumbnail filters.
ezcImageTransformation
  in file transformation.php, class ezcImageTransformation
  Provides transformations on images using filters and MIME conversions.
ezcImageTransformationAlreadyExistsException
  in file transformation_already_exists.php, class ezcImageTransformationAlreadyExistsException
  Thrown if a transformation with the given name already exists.
ezcImageTransformationException
  in file transformation.php, class ezcImageTransformationException
  Exception to be thrown be ezcImageTransformation classes.
ezcImageTransformationNotAvailableException
  in file transformation_not_available.php, class ezcImageTransformationNotAvailableException
  Thrown if a transformation with the given name does not exists.
ezcImageWatermarkFilters
  in file watermark.php, class ezcImageWatermarkFilters
  This interface has to implemented by ezcImageFilters classes to support watermark filters.
exception.php
  procedural page exception.php
effect.php
  procedural page effect.php

### Letter 'f'

$filters
  in file transformation.php, variable ezcImageTransformation::$filters
  Stores the filters utilized by a transformation.
filledThumbnail
  in file gd.php, method ezcImageGdHandler::filledThumbnail()
  Creates a thumbnail, and fills up the image to fit the given range.
filledThumbnail
  in file thumbnail.php, method ezcImageThumbnailFilters::filledThumbnail()
  Creates a thumbnail, and fills up the image to fit the given range.
filledThumbnail
  in file imagemagick.php, method ezcImageImagemagickHandler::filledThumbnail()
  Creates a thumbnail, and fills up the image to fit the given range.
file_name_invalid.php
  procedural page file_name_invalid.php
file_not_processable.php
  procedural page file_not_processable.php
filter_failed.php
  procedural page filter_failed.php
filter_not_available.php
  procedural page filter_not_available.php
filter.php
  procedural page filter.php

### Letter 'g'

getColor
  in file gd.php, method ezcImageGdHandler::getColor()
  Common color determination method.
getDirectionModifier
  in file imagemagick.php, method ezcImageImagemagickHandler::getDirectionModifier()
  Returns the ImageMagick direction modifier for a direction constant.
getFilterNames
  in file handler.php, method ezcImageHandler::getFilterNames()
  Returns a list of filters this handler provides.
getFilterNames
  in file converter.php, method ezcImageConverter::getFilterNames()
  Returns a list of enabled filters.
getHandler
  in file converter.php, method ezcImageConverter::getHandler()
  Returns a handler object for direct use.
getMimeOut
  in file converter.php, method ezcImageConverter::getMimeOut()
  Returns the MIME type that will be outputted for a given input type.
getOutMime
  in file transformation.php, method ezcImageTransformation::getOutMime()
  Determine output MIME type Returns the MIME type that the transformation will output.
gd.php
  procedural page gd.php
gd_base.php
  procedural page gd_base.php
geometry.php
  procedural page geometry.php

### Letter 'h'

$handlers
  in file converter.php, variable ezcImageConverter::$handlers
  Keeps the handlers used by the converter.
$handlers
  in file converter_settings.php, variable ezcImageConverterSettings::$handlers
  Array with handler settings objects.
hasFilter
  in file handler.php, method ezcImageHandler::hasFilter()
  Checks if a given filter is available in this handler.
hasFilter
  in file converter.php, method ezcImageConverter::hasFilter()
  Returns if a given filter is available.
handler_not_available.php
  procedural page handler_not_available.php
handler_settings_invalid.php
  procedural page handler_settings_invalid.php
handler.php
  procedural page handler.php
handler_settings.php
  procedural page handler_settings.php

### Letter 'i'

invalid_filter_parameter.php
  procedural page invalid_filter_parameter.php
invalid_reference.php
  procedural page invalid_reference.php
imagemagick.php
  procedural page imagemagick.php
imagemagick_base.php
  procedural page imagemagick_base.php

### Letter 'l'

$lastHandler
  in file transformation.php, variable ezcImageTransformation::$lastHandler
  The handler last used for filtering.
load
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::load()
  Load an image file.
load
  in file handler.php, method ezcImageHandler::load()
  Load an image file.
load
  in file gd_base.php, method ezcImageGdBaseHandler::load()
  Load an image file.
luminanceColorScale
  in file gd.php, method ezcImageGdHandler::luminanceColorScale()
  Perform luminance color scale.

### Letter 'm'

$mimeOut
  in file transformation.php, variable ezcImageTransformation::$mimeOut
  Array of MIME types allowed as output for this transformation.
mime_type_unsupported.php
  procedural page mime_type_unsupported.php
missing_filter_parameter.php
  procedural page missing_filter_parameter.php

### Letter 'n'

$name
  in file filter.php, variable ezcImageFilter::$name
  Name of filter operation to use.
$name
  in file transformation.php, variable ezcImageTransformation::$name
  Stores the name of this transformation.
needsTransparencyConversion
  in file handler.php, method ezcImageHandler::needsTransparencyConversion()
  Returns if a MIME conversion needs transparent color replacement.
noise
  in file effect.php, method ezcImageEffectFilters::noise()
  Noise filter.
noise
  in file imagemagick.php, method ezcImageImagemagickHandler::noise()
  Noise filter.

### Letter 'o'

$options
  in file handler_settings.php, variable ezcImageHandlerSettings::$options
  Associative array of misc options for the handler.
$options
  in file filter.php, variable ezcImageFilter::$options
  Associative array of options for the filter operation.

### Letter 'p'

$parent
  in file transformation.php, variable ezcImageTransformationException::$parent
  Stores the parent exception.
$properties
  in file save_options.php, variable ezcImageSaveOptions::$properties
  Properties.
$properties
  in file handler.php, variable ezcImageHandler::$properties
  Container to hold the properties
paletteToTruecolor
  in file gd.php, method ezcImageGdHandler::paletteToTruecolor()
  Convert a palette based image resource to a true color one.
performScale
  in file gd.php, method ezcImageGdHandler::performScale()
  General scaling method to perform actual scale to new dimensions.

### Letter 'r'

$referenceName
  in file handler_settings.php, variable ezcImageHandlerSettings::$referenceName
  The reference name for the handler.
removeTransformation
  in file converter.php, method ezcImageConverter::removeTransformation()
  Removes a transformation from the manager.
replaceTransparency
  in file gd_base.php, method ezcImageGdBaseHandler::replaceTransparency()
  Replaces a transparent background with the given color.

### Letter 's'

$saveOptions
  in file transformation.php, variable ezcImageTransformation::$saveOptions
  Options for the final save step.
$settings
  in file handler.php, variable ezcImageHandler::$settings
  Settings of the handlers
$settings
  in file converter.php, variable ezcImageConverter::$settings
  Manager settings Settings basis for all image manipulations.
save_options.php
  procedural page save_options.php
save
  in file imagemagick_base.php, method ezcImageImagemagickBaseHandler::save()
  Save an image file.
save
  in file handler.php, method ezcImageHandler::save()
  Save an image file.
save
  in file gd_base.php, method ezcImageGdBaseHandler::save()
  Save an image file.
scale
  in file imagemagick.php, method ezcImageImagemagickHandler::scale()
  Scale filter.
scale
  in file geometry.php, method ezcImageGeometryFilters::scale()
  Scale filter.
scale
  in file gd.php, method ezcImageGdHandler::scale()
  Scale filter.
scaleExact
  in file gd.php, method ezcImageGdHandler::scaleExact()
  Scale exact filter.
scaleExact
  in file geometry.php, method ezcImageGeometryFilters::scaleExact()
  Scale exact filter.
scaleExact
  in file imagemagick.php, method ezcImageImagemagickHandler::scaleExact()
  Scale exact filter.
scaleHeight
  in file geometry.php, method ezcImageGeometryFilters::scaleHeight()
  Scale after height filter.
scaleHeight
  in file imagemagick.php, method ezcImageImagemagickHandler::scaleHeight()
  Scale after height filter.
scaleHeight
  in file gd.php, method ezcImageGdHandler::scaleHeight()
  Scale after height filter.
scalePercent
  in file imagemagick.php, method ezcImageImagemagickHandler::scalePercent()
  Scale percent measures filter.
scalePercent
  in file geometry.php, method ezcImageGeometryFilters::scalePercent()
  Scale percent measures filter.
scalePercent
  in file gd.php, method ezcImageGdHandler::scalePercent()
  Scale percent measures filter.
scaleWidth
  in file imagemagick.php, method ezcImageImagemagickHandler::scaleWidth()
  Scale after width filter.
scaleWidth
  in file gd.php, method ezcImageGdHandler::scaleWidth()
  Scale after width filter.
scaleWidth
  in file geometry.php, method ezcImageGeometryFilters::scaleWidth()
  Scale after width filter.
SCALE_BOTH
  in file geometry.php, class constant ezcImageGeometryFilters::SCALE_BOTH
  Scale up and down, as fits
SCALE_DOWN
  in file geometry.php, class constant ezcImageGeometryFilters::SCALE_DOWN
  Scale down only
SCALE_UP
  in file geometry.php, class constant ezcImageGeometryFilters::SCALE_UP
  Scale up only
setFilters
  in file transformation.php, method ezcImageTransformation::setFilters()
  Set the filters for this transformation.
setMimeOut
  in file transformation.php, method ezcImageTransformation::setMimeOut()
  Sets the MIME types which are allowed for output.
setSaveOptions
  in file transformation.php, method ezcImageTransformation::setSaveOptions()
  Sets the save options.
swirl
  in file effect.php, method ezcImageEffectFilters::swirl()
  Swirl filter.
swirl
  in file imagemagick.php, method ezcImageImagemagickHandler::swirl()
  Swirl filter.

### Letter 't'

$transformations
  in file converter.php, variable ezcImageConverter::$transformations
  Stores transformation registered with this converter.
transformation.php
  procedural page transformation.php
transformation_already_exists.php
  procedural page transformation_already_exists.php
transformation_not_available.php
  procedural page transformation_not_available.php
thumbnail.php
  procedural page thumbnail.php
transformation.php
  procedural page transformation.php
thresholdColorScale
  in file gd.php, method ezcImageGdHandler::thresholdColorScale()
  Scale colors by threshold values.
transform
  in file converter.php, method ezcImageConverter::transform()
  Apply transformation on a file.
transform
  in file transformation.php, method ezcImageTransformation::transform()
  Apply the given filters for the transformation.

### Letter 'w'

watermark.php
  procedural page watermark.php
watermarkAbsolute
  in file gd.php, method ezcImageGdHandler::watermarkAbsolute()
  Watermark filter.
watermarkAbsolute
  in file imagemagick.php, method ezcImageImagemagickHandler::watermarkAbsolute()
  Watermark filter.
watermarkAbsolute
  in file watermark.php, method ezcImageWatermarkFilters::watermarkAbsolute()
  Watermark filter.
watermarkPercent
  in file watermark.php, method ezcImageWatermarkFilters::watermarkPercent()
  Watermark filter.
watermarkPercent
  in file imagemagick.php, method ezcImageImagemagickHandler::watermarkPercent()
  Watermark filter.
watermarkPercent
  in file gd.php, method ezcImageGdHandler::watermarkPercent()
  Watermark filter.

Documentation generated by phpDocumentor 1.4.3