lib/ezimage/classes/ezimagegdhandler.php
File containing the eZImageGDHandler class.
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Package
- lib
- Version
- 4.6.0
\eZImageGDHandler
Package: lib
File containing the eZImageGDHandler class.
- Parent(s)
- \eZImageHandler
- Copyright
- Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
- License
- eZ Business Use License Agreement Version 2.0
- Version
- 4.6.0
Constants
KEEP_SUFFIX
= 1
inheritedInherited from:
\eZImageHandler::KEEP_SUFFIX
- Inherited_from
- \eZImageHandler::KEEP_SUFFIX
REPLACE_SUFFIX
= 2
inheritedInherited from:
\eZImageHandler::REPLACE_SUFFIX
- Inherited_from
- \eZImageHandler::REPLACE_SUFFIX
PREPEND_TAG_REPLACE_SUFFIX
= 3
inheritedInherited from:
\eZImageHandler::PREPEND_TAG_REPLACE_SUFFIX
- Inherited_from
- \eZImageHandler::PREPEND_TAG_REPLACE_SUFFIX
Properties
Methods

calculateFixedHeightAspectGeometry(
$sourceWidth, $sourceHeight, $destinationHeight, $allowUpScale
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceWidth | ||
| $sourceHeight | ||
| $destinationHeight | ||
| $allowUpScale |

calculateFixedWidthAspectGeometry(
$sourceWidth, $sourceHeight, $destinationWidth, $allowUpScale
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceWidth | ||
| $sourceHeight | ||
| $destinationWidth | ||
| $allowUpScale |

calculateScaledAspectGeometry(
$sourceWidth, $sourceHeight, $destinationWidth, $destinationHeight, $allowUpScale
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceWidth | ||
| $sourceHeight | ||
| $destinationWidth | ||
| $destinationHeight | ||
| $allowUpScale |

calculateScaledPercentAspectGeometry(
$sourceWidth, $sourceHeight, $destinationWidthPercent, $destinationHeightPercent, $allowUpScale
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $sourceWidth | ||
| $sourceHeight | ||
| $destinationWidthPercent | ||
| $destinationHeightPercent | ||
| $allowUpScale |

convert(
$manager, $sourceMimeData, $destinationMimeData, $filters
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $manager | ||
| $sourceMimeData | ||
| $destinationMimeData | ||
| $filters |

convertFilterToText(
$filterDefinition, $filterData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $filterDefinition | ||
| $filterData |

createFromINI(
$iniGroup, $iniFilename
=
false
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $iniGroup | ||
| $iniFilename |

createGeometry(
$width, $height, $x
=
0, $y
=
0
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $width | ||
| $height | ||
| $x | ||
| $y |

createImageBorder(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

cropImage(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

eZImageGDHandler(
$handlerName, $isGloballyEnabled, $outputRewriteType
=
self::REPLACE_SUFFIX, $conversionRules
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $handlerName | ||
| $isGloballyEnabled | ||
| $outputRewriteType | ||
| $conversionRules |

eZImageHandler(
$handlerName, $isEnabled
=
true, $outputRewriteType
=
self::REPLACE_SUFFIX, $supportedInputMIMETypes
=
false, $supportedOutputMIMETypes, $conversionRules
=
false, $filters
=
false, $mimeTagMap
=
false
)
:
void
inherited
Inherited from:
\eZImageHandler::eZImageHandler()
Parameters
| Name | Type | Description |
|---|---|---|
| $handlerName | ||
| $isEnabled | ||
| $outputRewriteType | ||
| $supportedInputMIMETypes | ||
| $supportedOutputMIMETypes | ||
| $conversionRules | ||
| $filters | ||
| $mimeTagMap |

imageCopy(
$imageObject, $destinationGeometry, $sourceGeometry, $sourceMimeData, $destinationMimeData
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $destinationGeometry | ||
| $sourceGeometry | ||
| $sourceMimeData | ||
| $destinationMimeData |

imageCreate(
$width, $height, $isTrueColor
=
true
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $width | ||
| $height | ||
| $isTrueColor |

isFilterSupported(
$filter
)
:
void
inherited
Inherited from:
\eZImageHandler::isFilterSupported()
Parameters
| Name | Type | Description |
|---|---|---|
| $filter |

isImageTrueColor(
$imageObject, $mimeData
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $mimeData |

isInputMIMETypeSupported(
$mimeData
)
:
void
inherited
Inherited from:
\eZImageHandler::isInputMIMETypeSupported()
Parameters
| Name | Type | Description |
|---|---|---|
| $mimeData |

isOutputMIMETypeSupported(
$mimeData
)
:
void
inherited
Inherited from:
\eZImageHandler::isOutputMIMETypeSupported()
Parameters
| Name | Type | Description |
|---|---|---|
| $mimeData |

outputMIMEType(
$manager, $currentMimeData, $wantedMimeData, $supportedFormatsOriginal, $aliasName
=
false
)
:
void
inherited
Inherited from:
\eZImageHandler::outputMIMEType()
Parameters
| Name | Type | Description |
|---|---|---|
| $manager | ||
| $currentMimeData | ||
| $wantedMimeData | ||
| $supportedFormatsOriginal | ||
| $aliasName |

rewriteURL(
$originalMimeData, $destinationMimeData, $rewriteType, $aliasName
=
false
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $originalMimeData | ||
| $destinationMimeData | ||
| $rewriteType | ||
| $aliasName |

scaleImage(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageCopy(
$imageObject, $geometry, $sourceMimeData, $destinationMimeData
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $geometry | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageDownOnly(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageExact(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageHeight(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageHeightDownOnly(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImagePercent(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageWidth(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

scaleImageWidthDownOnly(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageBorder(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageBorderColor(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageBorderWidth(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageColorThreshold(
$imageObject, $filterData, $sourceMimeData, $destinationMimeData, $thresholdList
)
:
void
static
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $sourceMimeData | ||
| $destinationMimeData | ||
| $thresholdList |

setImageColorThresholdName(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageColorspaceGray(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageLuminance(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

setImageLuminanceColorScale(
$imageObject, $filterData, $sourceMimeData, $destinationMimeData, $colorScale
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $sourceMimeData | ||
| $destinationMimeData | ||
| $colorScale |

setImageLuminanceNamed(
$imageObject, $filterData, $filterVariables, $sourceMimeData, $destinationMimeData
)
:
void
Parameters
| Name | Type | Description |
|---|---|---|
| $imageObject | ||
| $filterData | ||
| $filterVariables | ||
| $sourceMimeData | ||
| $destinationMimeData |

supportedInputMIMETypes(
)
:
void
inherited
Inherited from:
\eZImageHandler::supportedInputMIMETypes()

supportedOutputMIMETypes(
)
:
void
inherited
Inherited from:
\eZImageHandler::supportedOutputMIMETypes()

tagForMIMEType(
$mimeData
)
:
void
inherited
Inherited from:
\eZImageHandler::tagForMIMEType()
Parameters
| Name | Type | Description |
|---|---|---|
| $mimeData |

textForFilter(
$filterData
)
:
void
inherited
Inherited from:
\eZImageHandler::textForFilter()
Parameters
| Name | Type | Description |
|---|---|---|
| $filterData |