eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZImageAliasHandler

class eZImageAliasHandler

Properties

$ContentObjectAttributeData
$ContentObjectAttribute

Methods

eZImageAliasHandler($contentObjectAttribute)

attributes()

hasAttribute($attributeName)

attribute($attributeName)

attributeFromOriginal($attributeName)

setAttribute($attributeName, $attributeValue)

isImageOwner()

imageSerialNumber()

increaseImageSerialNumber()

resetImageSerialNumber()

displayText($alternativeText = null)

directoryPath()

imageName($contentObjectAttribute, $contentVersion, $language = false)

imageNameByNode($contentObjectAttribute, $mainNode, $language = false)

imagePath($contentObjectAttribute, $contentVersion, $isImageOwner = null)

imagePathByNode($contentObjectAttribute, $mainNode)

imageAlias($aliasName)

aliasList($checkValidity = true)

purgeAllAliases(eZContentObjectAttribute $contentObjectAttribute)

Removes the images alias while keeping the original image.

void removeAliases(eZContentObjectAttribute $contentObjectAttribute)

Removes all the image aliases and their information.

updateAliasPath($dirpath, $name)

createOriginalAttributeXMLData($originalNode, $originalData)

recreateDOMTree()

domTree()

parseInformationNode($imageInfoNode)

normalizeImageName($imageName)

setHTTPFile(mixed $httpFile)

Sets the uploaded HTTP file object to $httpFile.

httpFile(bool $release = false)

Returns the stored HTTP file object or false if no object is stored.

TODO: initializeFromHTTPFile(eZHTTPFile $httpFile, string $imageAltText = false)

Initializes the content object attribute with the uploaded HTTP file

initializeFromFile($filename, $imageAltText = false, $originalFilename = false)

initialize($mimeData, $originalFilename, $imageAltText = false)

createImageInformationNode($imageNode, $mimeData)

addImageAliases($imageAliasList)

addImageAlias($imageAlias)

addImageAliasToXML($domTree, $imageAlias)

setDOMTree($domTree)

storeDOMTree($domTree, $storeAttribute, $contentObjectAttributeRef)

store($contentObjectAttribute)

isStorageRequired()

setStorageRequired($require = true)

originalAttributeData()

setOriginalAttributeData($originalData)

setOriginalAttributeDataFromAttribute($contentObjectAttribute)

setOriginalAttributeDataValues($attributeID, $attributeVersion, $attributeLanguage)

setImageSerialNumber($val)

generateXMLData()

Details

at line 32
public eZImageAliasHandler($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 61
public attributes()

at line 75
public hasAttribute($attributeName)

Parameters

$attributeName

at line 93
public attribute($attributeName)

Parameters

$attributeName

at line 111
public attributeFromOriginal($attributeName)

Parameters

$attributeName

at line 127
public setAttribute($attributeName, $attributeValue)

Parameters

$attributeName
$attributeValue

at line 160
public isImageOwner()

at line 180
public imageSerialNumber()

at line 193
public increaseImageSerialNumber()

at line 201
public resetImageSerialNumber()

at line 212
public displayText($alternativeText = null)

Parameters

$alternativeText

at line 225
public directoryPath()

at line 245
public imageName($contentObjectAttribute, $contentVersion, $language = false)

Parameters

$contentObjectAttribute
$contentVersion
$language

at line 284
public imageNameByNode($contentObjectAttribute, $mainNode, $language = false)

Parameters

$contentObjectAttribute
$mainNode
$language

at line 317
public imagePath($contentObjectAttribute, $contentVersion, $isImageOwner = null)

Parameters

$contentObjectAttribute
$contentVersion
$isImageOwner

at line 367
public imagePathByNode($contentObjectAttribute, $mainNode)

Parameters

$contentObjectAttribute
$mainNode

at line 394
public imageAlias($aliasName)

Parameters

$aliasName

at line 482
public aliasList($checkValidity = true)

Parameters

$checkValidity

at line 682
public purgeAllAliases(eZContentObjectAttribute $contentObjectAttribute)

Removes the images alias while keeping the original image.

Parameters

eZContentObjectAttribute $contentObjectAttribute

See also

eZCache::purgeAllAliases()

at line 729
public void removeAliases(eZContentObjectAttribute $contentObjectAttribute)

Removes all the image aliases and their information.

The stored images will also be removed if the attribute is the owner of the images.

After the images are removed the attribute will containe an internal structure with empty data

Parameters

eZContentObjectAttribute $contentObjectAttribute Content object attribute to remove aliases for

Return Value

void

at line 833
public updateAliasPath($dirpath, $name)

Parameters

$dirpath
$name

at line 886
public createOriginalAttributeXMLData($originalNode, $originalData)

Parameters

$originalNode
$originalData

at line 898
public recreateDOMTree()

at line 965
public domTree()

at line 999
public parseInformationNode($imageInfoNode)

Parameters

$imageInfoNode

at line 1060
public normalizeImageName($imageName)

Parameters

$imageName

at line 1079
public setHTTPFile(mixed $httpFile)

Sets the uploaded HTTP file object to $httpFile.

This object is used to store information about the image file until the content object attribute is to be stored.

Parameters

mixed $httpFile

See also

httpFile

at line 1091
public httpFile(bool $release = false)

Returns the stored HTTP file object or false if no object is stored.

Parameters

bool $release Erase the content of the stored HTTP file

See also

setHTTPFile

at line 1114
public TODO: initializeFromHTTPFile(eZHTTPFile $httpFile, string $imageAltText = false)

Initializes the content object attribute with the uploaded HTTP file

Parameters

eZHTTPFile $httpFile
string $imageAltText Optional image ALT text

Return Value

TODO: FIXME

at line 1151
public initializeFromFile($filename, $imageAltText = false, $originalFilename = false)

Parameters

$filename
$imageAltText
$originalFilename

at line 1213
public initialize($mimeData, $originalFilename, $imageAltText = false)

Parameters

$mimeData
$originalFilename
$imageAltText

at line 1294
public createImageInformationNode($imageNode, $mimeData)

Parameters

$imageNode
$mimeData

at line 1375
public addImageAliases($imageAliasList)

Parameters

$imageAliasList

at line 1393
public addImageAlias($imageAlias)

Parameters

$imageAlias

at line 1405
public addImageAliasToXML($domTree, $imageAlias)

Parameters

$domTree
$imageAlias

at line 1455
public setDOMTree($domTree)

Parameters

$domTree

at line 1464
public storeDOMTree($domTree, $storeAttribute, $contentObjectAttributeRef)

Parameters

$domTree
$storeAttribute
$contentObjectAttributeRef

at line 1505
public store($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1531
public isStorageRequired()

at line 1542
public setStorageRequired($require = true)

Parameters

$require

at line 1554
public originalAttributeData()

at line 1571
public setOriginalAttributeData($originalData)

Parameters

$originalData

at line 1590
public setOriginalAttributeDataFromAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1613
public setOriginalAttributeDataValues($attributeID, $attributeVersion, $attributeLanguage)

Parameters

$attributeID
$attributeVersion
$attributeLanguage

at line 1625
public setImageSerialNumber($val)

Parameters

$val

at line 1646
public generateXMLData()