Class

eZImageManager

class eZImageManager

Properties

$ImageHandlers
$OutputMIME
$OutputMIMEMap
$Rules
$DefaultRule
$RuleMap
$MIMETypes
$Types

Methods

__construct()

Initializes the manager by registering a application/octet-stream mimetype which is applied for all unknown files.

setSupportedFormats($mimeList)

appendSupportedFormat($mimeName)

appendImageHandler($handler)

isFilterSupported($filterName)

aliasList()

hasAlias($aliasName)

alias($aliasName)

appendImageAlias($alias)

createImageAliasKey($alias)

isImageAliasValid($alias)

isImageTimestampValid($timestamp)

readImageAliasesFromINI($iniFile = false)

readSupportedFormatsFromINI($iniFile = false)

hasMIMETypeSetting($mimeData)

mimeTypeSetting($mimeData)

mimeTypeOverride($mimeData)

mimeTypeFilters($mimeData)

isFilterAllowed($filterName, $mimeData)

appendQualityValue($mimeType, $qualityValue)

qualityValue($mimeType)

setQualityValueOverride($mimeType, $qualityValue)

resetQualityValueOverride()

appendMIMETypeSetting($settings)

readMIMETypeSettingsFromINI($iniFile = false)

readMIMETypeQualitySettingFromINI($iniFile = false)

readConversionRuleSettingsFromINI($iniFile = false)

readINISettings()

appendConversionRule($conversionRule)

conversionRules()

readMIMETypeSettingFromINI($mimeGroup, $iniFile = false)

readImageHandlersFromINI($iniFile = false)

factoryFor($factoryName, $iniFile = false, $converterName = false)

createFilterDataFromINI($filterText)

createAliasFromINI($iniGroup)

bool createImageAlias(string $aliasName, array $existingAliasList, array $parameters = array())

Creates the image alias $aliasName if it's not already part of the existing aliases

bool convert(mixed $sourceMimeData, mixed $destinationMimeData, mixed $aliasName = false, array $parameters = array())

Converts the source image $sourceMimeData into the destination image $destinationMimeData.

array imageAliasInfo($mimeData, $aliasName, $isAliasNew = false)

Image information for $aliasName.

temporaryImageDirPath()

Details

at line 89
public __construct()

Initializes the manager by registering a application/octet-stream mimetype which is applied for all unknown files.

at line 114
public setSupportedFormats($mimeList)

Parameters

$mimeList

at line 131
public appendSupportedFormat($mimeName)

Parameters

$mimeName

at line 143
public appendImageHandler($handler)

Parameters

$handler

at line 158
public isFilterSupported($filterName)

Parameters

$filterName

at line 173
public aliasList()

at line 192
public hasAlias($aliasName)

Parameters

$aliasName

at line 201
public alias($aliasName)

Parameters

$aliasName

at line 212
public appendImageAlias($alias)

Parameters

$alias

at line 224
public createImageAliasKey($alias)

Parameters

$alias

at line 252
public isImageAliasValid($alias)

Parameters

$alias

at line 277
public isImageTimestampValid($timestamp)

Parameters

$timestamp

at line 293
public readImageAliasesFromINI($iniFile = false)

Parameters

$iniFile

at line 336
public readSupportedFormatsFromINI($iniFile = false)

Parameters

$iniFile

at line 353
public hasMIMETypeSetting($mimeData)

Parameters

$mimeData

at line 361
public mimeTypeSetting($mimeData)

Parameters

$mimeData

at line 405
public mimeTypeOverride($mimeData)

Parameters

$mimeData

at line 422
public mimeTypeFilters($mimeData)

Parameters

$mimeData

at line 438
public isFilterAllowed($filterName, $mimeData)

Parameters

$filterName
$mimeData

at line 477
public appendQualityValue($mimeType, $qualityValue)

Parameters

$mimeType
$qualityValue

at line 488
public qualityValue($mimeType)

Parameters

$mimeType

at line 500
public setQualityValueOverride($mimeType, $qualityValue)

Parameters

$mimeType
$qualityValue

at line 510
public resetQualityValueOverride()

at line 518
public appendMIMETypeSetting($settings)

Parameters

$settings

at line 531
public readMIMETypeSettingsFromINI($iniFile = false)

Parameters

$iniFile

at line 550
public readMIMETypeQualitySettingFromINI($iniFile = false)

Parameters

$iniFile

at line 572
public readConversionRuleSettingsFromINI($iniFile = false)

Parameters

$iniFile

at line 599
public readINISettings()

at line 612
public appendConversionRule($conversionRule)

Parameters

$conversionRule

at line 620
public conversionRules()

at line 632
public readMIMETypeSettingFromINI($mimeGroup, $iniFile = false)

Parameters

$mimeGroup
$iniFile

at line 674
public readImageHandlersFromINI($iniFile = false)

Parameters

$iniFile

at line 713
public factoryFor($factoryName, $iniFile = false, $converterName = false)

Parameters

$factoryName
$iniFile
$converterName

at line 741
public createFilterDataFromINI($filterText)

Parameters

$filterText

at line 761
public createAliasFromINI($iniGroup)

Parameters

$iniGroup

at line 810
public bool createImageAlias(string $aliasName, array $existingAliasList, array $parameters = array())

Creates the image alias $aliasName if it's not already part of the existing aliases

Parameters

string $aliasName Name of the alias to create
array $existingAliasList Reference to the current alias list. The created alias will be added to the list.
array $parameters Optional array that can be used to specify the image's basename

Return Value

bool true if the alias was created, false if it wasn't

at line 1052
public bool convert(mixed $sourceMimeData, mixed $destinationMimeData, mixed $aliasName = false, array $parameters = array())

Converts the source image $sourceMimeData into the destination image $destinationMimeData.

Parameters

mixed $sourceMimeData Source image, either a mimedata array or the source image path
mixed $destinationMimeData Either a mimedata array or the target image path
mixed $aliasName Target alias (small, medium, large...)
array $parameters Optional parameters. Known ones so far: (basename)

Return Value

bool

at line 1340
public array imageAliasInfo($mimeData, $aliasName, $isAliasNew = false)

Image information for $aliasName.

This is the information which normally would be provided during generation of aliasName. This so that requests not holding the lock will provide meaningful information.

Parameters

$mimeData
$aliasName
$isAliasNew

Return Value

array

at line 1371
public temporaryImageDirPath()