eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZImageType

class eZImageType extends eZDataType

Constants

FILESIZE_FIELD

FILESIZE_VARIABLE

DATA_TYPE_STRING

Properties

$DataTypeString
$Name

Methods

eZDataType($dataTypeString, $name, $properties = array())

from eZDataType
viewTemplate($contentobjectAttribute)

from eZDataType
editTemplate($contentobjectAttribute)

from eZDataType
informationTemplate($contentobjectAttribute)

from eZDataType
resultTemplate($collectionAttribute)

from eZDataType
isA()

from eZDataType
bool isTranslatable()

Indicates if datatype supports being translated

from eZDataType
attributes()

from eZDataType
hasAttribute($attr)

from eZDataType
attribute($attr)

from eZDataType
isHTTPFileInsertionSupported()

isRegularFileInsertionSupported()

isSimpleStringInsertionSupported()

from eZDataType
insertHTTPFile($object, $objectVersion, $objectLanguage, $objectAttribute, $httpFile, $mimeData, $result)

insertRegularFile($object, $objectVersion, $objectLanguage, $objectAttribute, $filePath, $result)

insertSimpleString($object, $objectVersion, $objectLanguage, $objectAttribute, $string, $result)

from eZDataType
hasStoredFileInformation($object, $objectVersion, $objectLanguage, $objectAttribute)

handleDownload($object, $objectVersion, $objectLanguage, $objectAttribute)

from eZDataType
storedFileInformation($object, $objectVersion, $objectLanguage, $objectAttribute)

productOptionInformation($objectAttribute, $optionID, $productItem)

from eZDataType
objectDisplayInformation($objectAttribute, $mergeInfo = false)

from eZDataType
classDisplayInformation($classAttribute, $mergeInfo = false)

from eZDataType
objectAttributeContent($contentObjectAttribute)

hasObjectAttributeContent($contentObjectAttribute)

classAttributeContent($classAttribute)

from eZDataType
storeObjectAttribute($contentObjectAttribute)

onPublish($contentObjectAttribute, $contentObject, $publishedNodes)

preStoreClassAttribute($classAttribute, $version)

from eZDataType
storeClassAttribute($classAttribute, $version)

from eZDataType
storeDefinedClassAttribute(eZContentClassAttribute $classAttribute)

from eZDataType
storeModifiedClassAttribute(eZContentClassAttribute $classAttribute)

from eZDataType
storeVersionedClassAttribute(eZContentClassAttribute $classAttribute, int $version)

from eZDataType
preStoreDefinedClassAttribute(eZContentClassAttribute $classAttribute)

from eZDataType
preStoreModifiedClassAttribute(eZContentClassAttribute $classAttribute)

from eZDataType
preStoreVersionedClassAttribute(eZContentClassAttribute $classAttribute, int $version)

Hook function which is called before an content class attribute is stored

from eZDataType
validateClassAttributeHTTPInput($http, $base, $classAttribute)

from eZDataType
fixupClassAttributeHTTPInput($http, $base, $classAttribute)

from eZDataType
fetchClassAttributeHTTPInput($http, $base, $classAttribute)

customClassAttributeHTTPAction($http, $action, $classAttribute)

from eZDataType
fetchActionValue($action, $actionName, $value)

from eZDataType
validation validateObjectAttributeHTTPInput($http: $http, $base: $base, $contentObjectAttribute: $contentObjectAttribute)

Validate the object attribute input in http.

fixupObjectAttributeHTTPInput($http, $base, $objectAttribute)

from eZDataType
true fetchObjectAttributeHTTPInput($http $http, $base $base, $contentObjectAttribute $contentObjectAttribute)

Fetch object attribute http input, override the ezDataType method This method is triggered when submiting a http form which includes Image class Image is stored into file system every time there is a file input and validation result is valid.

validateCollectionAttributeHTTPInput($http, $base, $objectAttribute)

from eZDataType
fixupCollectionAttributeHTTPInput($http, $base, $objectAttribute)

from eZDataType
fetchCollectionAttributeHTTPInput($collection, $collectionAttribute, $http, $base, $objectAttribute)

from eZDataType
customObjectAttributeHTTPAction($http, $action, $contentObjectAttribute, $parameters)

handleCustomObjectHTTPActions($http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)

from eZDataType
initializeClassAttribute($classAttribute)

from eZDataType
cloneClassAttribute($oldClassAttribute, $newClassAttribute)

from eZDataType
initializeObjectAttribute($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)

repairContentObjectAttribute($contentObjectAttribute)

from eZDataType
postInitializeObjectAttribute($objectAttribute, $currentVersion, $originalContentObjectAttribute)

from eZDataType
postStore($objectAttribute)

from eZDataType
trashStoredObjectAttribute($contentObjectAttribute, $version = null)

restoreTrashedObjectAttribute($contentObjectAttribute)

Restores the content object attribute $objectAttribute from trash Default implementation does nothing

deleteStoredObjectAttribute($contentObjectAttribute, $version = null)

deleteStoredClassAttribute($classAttribute, $version = null)

from eZDataType
array contentActionList(eZContentClassAttribute $classAttribute)

Return content action(s) which can be performed on object containing the current datatype.

from eZDataType
hasInformationCollection()

from eZDataType
title($contentObjectAttribute, $name = 'original_filename')

isIndexable()

from eZDataType
isAddToBasketValidationRequired()

from eZDataType
validateAddToBasket($objectAttribute, $data, $errors)

from eZDataType
isClassAttributeRemovable($classAttribute)

from eZDataType
classAttributeRemovableInformation($classAttribute, $includeAll = true)

from eZDataType
isInformationCollector()

from eZDataType
sortKey($objectAttribute)

from eZDataType
sortKeyType()

from eZDataType
customSorting()

from eZDataType
customSortingSQL($params)

from eZDataType
metaData($contentObjectAttribute)

toString($objectAttribute)

fromString($objectAttribute, $string)

templateList()

from eZDataType
serializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

unserializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

serializeContentObjectAttribute($package, $objectAttribute)

unserializeContentObjectAttribute($package, $objectAttribute, $attributeNode)

postUnserializeContentObjectAttribute($package, $objectAttribute)

from eZDataType
removeRelatedObjectItem($contentObjectAttribute, $objectID)

from eZDataType
fixRelatedObjectItem($contentObjectAttribute, $objectID, $mode)

from eZDataType
createContentObjectAttributeDOMNode($objectAttribute)

Create empty content object attribute DOM node.

from eZDataType
diff($old, $new, $options = false)

from eZDataType
getDBAFileName()

from eZDataType
getDBAFilePath($checkExtensions = true)

from eZDataType
getDBAExtensionFilePath()

from eZDataType
importDBDataFromDBAFile($dbaFilePath = false)

from eZDataType
cleanDBDataBeforeImport()

from eZDataType
batchInitializeObjectAttributeData($classAttribute)

from eZDataType
supportsBatchInitializeObjectAttribute()

eZImageType()

Details

in eZDataType at line 51
public eZDataType($dataTypeString, $name, $properties = array())

Parameters

$dataTypeString
$name
$properties

in eZDataType at line 85
public viewTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

in eZDataType at line 98
public editTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

in eZDataType at line 111
public informationTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

in eZDataType at line 125
public resultTemplate($collectionAttribute)

Parameters

$collectionAttribute

in eZDataType at line 200
public isA()

in eZDataType at line 210
public bool isTranslatable()

Indicates if datatype supports being translated

Return Value

bool

in eZDataType at line 218
public attributes()

in eZDataType at line 226
public hasAttribute($attr)

Parameters

$attr

in eZDataType at line 234
public attribute($attr)

Parameters

$attr

at line 339
public isHTTPFileInsertionSupported()

at line 347
public isRegularFileInsertionSupported()

in eZDataType at line 271
public isSimpleStringInsertionSupported()

at line 355
public insertHTTPFile($object, $objectVersion, $objectLanguage, $objectAttribute, $httpFile, $mimeData, $result)

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute
$httpFile
$mimeData
$result

at line 378
public insertRegularFile($object, $objectVersion, $objectLanguage, $objectAttribute, $filePath, $result)

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute
$filePath
$result

in eZDataType at line 351
public insertSimpleString($object, $objectVersion, $objectLanguage, $objectAttribute, $string, $result)

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute
$string
$result

at line 401
public hasStoredFileInformation($object, $objectVersion, $objectLanguage, $objectAttribute)

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

in eZDataType at line 387
public handleDownload($object, $objectVersion, $objectLanguage, $objectAttribute)

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

at line 410
public storedFileInformation($object, $objectVersion, $objectLanguage, $objectAttribute)

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

in eZDataType at line 438
public productOptionInformation($objectAttribute, $optionID, $productItem)

Parameters

$objectAttribute
$optionID
$productItem

in eZDataType at line 472
public objectDisplayInformation($objectAttribute, $mergeInfo = false)

Parameters

$objectAttribute
$mergeInfo

in eZDataType at line 539
public classDisplayInformation($classAttribute, $mergeInfo = false)

Parameters

$classAttribute
$mergeInfo

at line 518
public objectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 510
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

in eZDataType at line 594
public classAttributeContent($classAttribute)

Parameters

$classAttribute

at line 317
public storeObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 430
public onPublish($contentObjectAttribute, $contentObject, $publishedNodes)

Parameters

$contentObjectAttribute
$contentObject
$publishedNodes

in eZDataType at line 633
public preStoreClassAttribute($classAttribute, $version)

Parameters

$classAttribute
$version

in eZDataType at line 650
public storeClassAttribute($classAttribute, $version)

Parameters

$classAttribute
$version

in eZDataType at line 661
public storeDefinedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

in eZDataType at line 670
public storeModifiedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

in eZDataType at line 680
public storeVersionedClassAttribute(eZContentClassAttribute $classAttribute, int $version)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype
int $version Version of the attribute to be stored

in eZDataType at line 697
public preStoreDefinedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

in eZDataType at line 705
public preStoreModifiedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

in eZDataType at line 717
public preStoreVersionedClassAttribute(eZContentClassAttribute $classAttribute, int $version)

Hook function which is called before an content class attribute is stored

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype
int $version Version of the attribute to be stored

See also

eZContentClassAttribute::storeVersioned()

in eZDataType at line 736
public validateClassAttributeHTTPInput($http, $base, $classAttribute)

Parameters

$http
$base
$classAttribute

in eZDataType at line 746
public fixupClassAttributeHTTPInput($http, $base, $classAttribute)

Parameters

$http
$base
$classAttribute

at line 464
public fetchClassAttributeHTTPInput($http, $base, $classAttribute)

Parameters

$http
$base
$classAttribute

in eZDataType at line 763
public customClassAttributeHTTPAction($http, $action, $classAttribute)

Parameters

$http
$action
$classAttribute

in eZDataType at line 774
public fetchActionValue($action, $actionName, $value)

Parameters

$action
$actionName
$value

at line 199
public validation validateObjectAttributeHTTPInput($http: $http, $base: $base, $contentObjectAttribute: $contentObjectAttribute)

Validate the object attribute input in http.

If there is validation failure, there failure message will be put into $contentObjectAttribute->ValidationError

Parameters

$http: $http http object
$base: $base
$contentObjectAttribute: $contentObjectAttribute content object attribute being validated

Return Value

validation result- eZInputValidator::STATEINVALID or eZInputValidator::STATEACCEPTED

See also

kernel/classes/eZDataType#validateObjectAttributeHTTPInput($http, $base, $objectAttribute)

in eZDataType at line 799
public fixupObjectAttributeHTTPInput($http, $base, $objectAttribute)

Parameters

$http
$base
$objectAttribute

at line 279
public true fetchObjectAttributeHTTPInput($http $http, $base $base, $contentObjectAttribute $contentObjectAttribute)

Fetch object attribute http input, override the ezDataType method This method is triggered when submiting a http form which includes Image class Image is stored into file system every time there is a file input and validation result is valid.

Parameters

$http $http http object
$base $base
$contentObjectAttribute $contentObjectAttribute : the content object attribute being handled

Return Value

true if content object is not null, false if content object is null

in eZDataType at line 816
public validateCollectionAttributeHTTPInput($http, $base, $objectAttribute)

Parameters

$http
$base
$objectAttribute

in eZDataType at line 826
public fixupCollectionAttributeHTTPInput($http, $base, $objectAttribute)

Parameters

$http
$base
$objectAttribute

in eZDataType at line 836
public fetchCollectionAttributeHTTPInput($collection, $collectionAttribute, $http, $base, $objectAttribute)

Parameters

$collection
$collectionAttribute
$http
$base
$objectAttribute

at line 476
public customObjectAttributeHTTPAction($http, $action, $contentObjectAttribute, $parameters)

Parameters

$http
$action
$contentObjectAttribute
$parameters

in eZDataType at line 854
public handleCustomObjectHTTPActions($http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)

Parameters

$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

in eZDataType at line 863
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

in eZDataType at line 871
public cloneClassAttribute($oldClassAttribute, $newClassAttribute)

Parameters

$oldClassAttribute
$newClassAttribute

at line 32
public initializeObjectAttribute($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)

Parameters

$contentObjectAttribute
$currentVersion
$originalContentObjectAttribute

in eZDataType at line 887
public repairContentObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

in eZDataType at line 896
public postInitializeObjectAttribute($objectAttribute, $currentVersion, $originalContentObjectAttribute)

Parameters

$objectAttribute
$currentVersion
$originalContentObjectAttribute

in eZDataType at line 903
public postStore($objectAttribute)

Parameters

$objectAttribute

at line 45
public trashStoredObjectAttribute($contentObjectAttribute, $version = null)

Parameters

$contentObjectAttribute
$version

at line 110
public restoreTrashedObjectAttribute($contentObjectAttribute)

Restores the content object attribute $objectAttribute from trash Default implementation does nothing

Parameters

$contentObjectAttribute

at line 176
public deleteStoredObjectAttribute($contentObjectAttribute, $version = null)

Parameters

$contentObjectAttribute
$version

in eZDataType at line 936
public deleteStoredClassAttribute($classAttribute, $version = null)

Parameters

$classAttribute
$version

in eZDataType at line 948
public array contentActionList(eZContentClassAttribute $classAttribute)

Return content action(s) which can be performed on object containing the current datatype.

Return format is array of arrays with key 'name' and 'action'. 'action' can be mapped to url in datatype.ini

Parameters

eZContentClassAttribute $classAttribute

Return Value

array

in eZDataType at line 969
public hasInformationCollection()

at line 494
public title($contentObjectAttribute, $name = 'original_filename')

Parameters

$contentObjectAttribute
$name

in eZDataType at line 986
public isIndexable()

in eZDataType at line 994
public isAddToBasketValidationRequired()

in eZDataType at line 1003
public validateAddToBasket($objectAttribute, $data, $errors)

Parameters

$objectAttribute
$data
$errors

in eZDataType at line 1022
public isClassAttributeRemovable($classAttribute)

Parameters

$classAttribute

in eZDataType at line 1040
public classAttributeRemovableInformation($classAttribute, $includeAll = true)

Parameters

$classAttribute
$includeAll

in eZDataType at line 1048
public isInformationCollector()

in eZDataType at line 1056
public sortKey($objectAttribute)

Parameters

$objectAttribute

in eZDataType at line 1065
public sortKeyType()

in eZDataType at line 1070
public customSorting()

in eZDataType at line 1075
public customSortingSQL($params)

Parameters

$params

at line 525
public metaData($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 603
public toString($objectAttribute)

Parameters

$objectAttribute

at line 611
public fromString($objectAttribute, $string)

Parameters

$objectAttribute
$string

in eZDataType at line 1112
public templateList()

at line 533
public serializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

at line 544
public unserializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

at line 556
public serializeContentObjectAttribute($package, $objectAttribute)

Parameters

$package
$objectAttribute

at line 576
public unserializeContentObjectAttribute($package, $objectAttribute, $attributeNode)

Parameters

$package
$objectAttribute
$attributeNode

in eZDataType at line 1233
public postUnserializeContentObjectAttribute($package, $objectAttribute)

Parameters

$package
$objectAttribute

in eZDataType at line 1314
public removeRelatedObjectItem($contentObjectAttribute, $objectID)

Parameters

$contentObjectAttribute
$objectID

in eZDataType at line 1322
public fixRelatedObjectItem($contentObjectAttribute, $objectID, $mode)

Parameters

$contentObjectAttribute
$objectID
$mode

in eZDataType at line 1333
public createContentObjectAttributeDOMNode($objectAttribute)

Create empty content object attribute DOM node.

The result is intended to be used in a datatype's serializeContentObjectAttribute() method.

\return "Empty" DOM node

Parameters

$objectAttribute

in eZDataType at line 1352
public diff($old, $new, $options = false)

Parameters

$old
$new
$options

in eZDataType at line 1365
public getDBAFileName()

in eZDataType at line 1373
public getDBAFilePath($checkExtensions = true)

Parameters

$checkExtensions

in eZDataType at line 1387
public getDBAExtensionFilePath()

in eZDataType at line 1412
public importDBDataFromDBAFile($dbaFilePath = false)

Parameters

$dbaFilePath

in eZDataType at line 1460
public cleanDBDataBeforeImport()

in eZDataType at line 1465
public batchInitializeObjectAttributeData($classAttribute)

Parameters

$classAttribute

at line 629
public supportsBatchInitializeObjectAttribute()

at line 26
public eZImageType()