lib/ezimage/classes/ezimagemanager.php

Show:

inherited

Classes
- \eZImageManager

Table of Contents

File containing the eZImageManager 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

\eZImageManager
jump to top

Package: lib

File containing the eZImageManager class.

Copyright: Copyright (C) 1999-2011 eZ Systems AS. All rights reserved.
License: eZ Business Use License Agreement Version 2.0
Version: 4.6.0

Properties


                 $DefaultRule= ''

Details

Type: n/a


                 $ImageHandlers= ''

Details

Type: n/a


                 $MIMETypes= ''

Details

Type: n/a


                 $OutputMIME= ''

Details

Type: n/a


                 $OutputMIMEMap= ''

Details

Type: n/a


                 $RuleMap= ''

Details

Type: n/a


                 $Rules= ''

Details

Type: n/a


                 $Types= 'array()'

Default valuearray()Details

Type: n/a

bool
                 $factory= 'false'

static

Factory flag as used by {@link eZImageManager::factory()} Reset with {@link eZImageManager::resetInstance()}

Default valuefalseDetails

Type: bool

null|\eZImageManager
                 $instance= ''

static

Singleton instance of eZImageManager used by {@link eZImageManager::instance()} Reset with {@link eZImageManager::resetInstance()}

Details

Type: null | \eZImageManager

Methods

alias(
           $aliasName
          )
        
        :
          void

Parameters

Name	Type	Description
$aliasName

aliasList(
          
          )
        
        :
          void

analyzeImage(
           $mimeData,  $parameters
              =
              array()
          )
        
        :
          void

static

Parameters

Name	Type	Description
$mimeData
$parameters

appendConversionRule(
           $conversionRule
          )
        
        :
          void

Parameters

Name	Type	Description
$conversionRule

appendImageAlias(
           $alias
          )
        
        :
          void

Parameters

Name	Type	Description
$alias

appendImageHandler(
           $handler
          )
        
        :
          void

Parameters

Name	Type	Description
$handler

appendMIMETypeSetting(
           $settings
          )
        
        :
          void

Parameters

Name	Type	Description
$settings

appendQualityValue(
           $mimeType,  $qualityValue
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeType
$qualityValue

appendSupportedFormat(
           $mimeName
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeName

conversionRules(
          
          )
        
        :
          void

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

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

Parameters

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

Returns

Type	Description
bool

createAliasFromINI(
           $iniGroup
          )
        
        :
          void

Parameters

Name	Type	Description
$iniGroup

createFilterDataFromINI(
           $filterText
          )
        
        :
          void

Parameters

Name	Type	Description
$filterText

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

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

Parameters

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

Returns

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

createImageAliasKey(
           $alias
          )
        
        :
          void

Parameters

Name	Type	Description
$alias

eZImageManager(
          
          )
        
        :
          void

factory(
          
          )
        
        :
          \eZImageManager

static

Returns a shared instance of the eZImageManager class and makes it ready for use.

As in calls {@link self::readINISettings()} and {@link eZImageAnalyzer::readAnalyzerSettingsFromINI()}

Returns

Type	Description
\eZImageManager

Details

Since: 4.3

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

Parameters

Name	Type	Description
$factoryName
$iniFile
$converterName

hasAlias(
           $aliasName
          )
        
        :
          void

Parameters

Name	Type	Description
$aliasName

hasMIMETypeSetting(
           $mimeData
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeData

imageAliasInfo(
          mixed $mimeData, string $aliasName,  $isAliasNew
              =
              false
          )
        
        :
          array

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

Name	Type	Description
$mimeData	mixed
$aliasName	string
$isAliasNew

Returns

Type	Description
array

instance(
          
          )
        
        :
          \eZImageManager

static

Returns a shared instance of the eZImageManager class.

Note: In most cases you'd want to use {@link self:factory()} instead.

Returns

Type	Description
\eZImageManager

isFilterAllowed(
           $filterName,  $mimeData
          )
        
        :
          void

Parameters

Name	Type	Description
$filterName
$mimeData

isFilterSupported(
           $filterName
          )
        
        :
          void

Parameters

Name	Type	Description
$filterName

isImageAliasValid(
           $alias
          )
        
        :
          void

Parameters

Name	Type	Description
$alias

isImageTimestampValid(
           $timestamp
          )
        
        :
          void

Parameters

Name	Type	Description
$timestamp

mimeTypeFilters(
           $mimeData
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeData

mimeTypeOverride(
           $mimeData
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeData

mimeTypeSetting(
           $mimeData
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeData

qualityValue(
           $mimeType
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeType

readConversionRuleSettingsFromINI(
           $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$iniFile

readINISettings(
          
          )
        
        :
          void

readImageAliasesFromINI(
           $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$iniFile

readImageHandlersFromINI(
           $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$iniFile

readMIMETypeQualitySettingFromINI(
           $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$iniFile

readMIMETypeSettingFromINI(
           $mimeGroup,  $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeGroup
$iniFile

readMIMETypeSettingsFromINI(
           $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$iniFile

readSupportedFormatsFromINI(
           $iniFile
              =
              false
          )
        
        :
          void

Parameters

Name	Type	Description
$iniFile

resetInstance(
          
          )
        
        :
          void

static

Reset a shared instance of the eZImageManager class and factory variable.

As used by {@link eZImageManager::instance()} and {@link eZImageManager::factory()}

Details

Since: 4.3

setSupportedFormats(
           $mimeList
          )
        
        :
          void

Parameters

Name	Type	Description
$mimeList

temporaryImageDirPath(
          
          )
        
        :
          void

wildcardToRegexp(
           $wildcard,  $separatorCharacter
              =
              false
          )
        
        :
          void

static

Parameters

Name	Type	Description
$wildcard
$separatorCharacter

lib/ezimage/classes/ezimagemanager.php

\eZImageManagerjump to top

Properties

Methods

\eZImageManager
jump to top