eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZDataType

class eZDataType

Properties

$DataTypeString
$Name

Methods

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

viewTemplate($contentobjectAttribute)

editTemplate($contentobjectAttribute)

informationTemplate($contentobjectAttribute)

resultTemplate($collectionAttribute)

isA()

bool isTranslatable()

Indicates if datatype supports being translated

attributes()

hasAttribute($attr)

attribute($attr)

isHTTPFileInsertionSupported()

isRegularFileInsertionSupported()

isSimpleStringInsertionSupported()

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

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

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

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

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

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

productOptionInformation($objectAttribute, $optionID, $productItem)

objectDisplayInformation($objectAttribute, $mergeInfo = false)

classDisplayInformation($classAttribute, $mergeInfo = false)

objectAttributeContent($objectAttribute)

hasObjectAttributeContent($contentObjectAttribute)

classAttributeContent($classAttribute)

storeObjectAttribute($objectAttribute)

onPublish($contentObjectAttribute, $contentObject, $publishedNodes)

preStoreClassAttribute($classAttribute, $version)

storeClassAttribute($classAttribute, $version)

storeDefinedClassAttribute(eZContentClassAttribute $classAttribute)

storeModifiedClassAttribute(eZContentClassAttribute $classAttribute)

storeVersionedClassAttribute(eZContentClassAttribute $classAttribute, int $version)

preStoreDefinedClassAttribute(eZContentClassAttribute $classAttribute)

preStoreModifiedClassAttribute(eZContentClassAttribute $classAttribute)

preStoreVersionedClassAttribute(eZContentClassAttribute $classAttribute, int $version)

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

validateClassAttributeHTTPInput($http, $base, $classAttribute)

fixupClassAttributeHTTPInput($http, $base, $classAttribute)

fetchClassAttributeHTTPInput($http, $base, $classAttribute)

customClassAttributeHTTPAction($http, $action, $classAttribute)

fetchActionValue($action, $actionName, $value)

validateObjectAttributeHTTPInput($http, $base, $objectAttribute)

fixupObjectAttributeHTTPInput($http, $base, $objectAttribute)

fetchObjectAttributeHTTPInput($http, $base, $objectAttribute)

validateCollectionAttributeHTTPInput($http, $base, $objectAttribute)

fixupCollectionAttributeHTTPInput($http, $base, $objectAttribute)

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

customObjectAttributeHTTPAction($http, $action, $objectAttribute, $parameters)

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

initializeClassAttribute($classAttribute)

cloneClassAttribute($oldClassAttribute, $newClassAttribute)

initializeObjectAttribute($objectAttribute, $currentVersion, $originalContentObjectAttribute)

repairContentObjectAttribute($contentObjectAttribute)

postInitializeObjectAttribute($objectAttribute, $currentVersion, $originalContentObjectAttribute)

postStore($objectAttribute)

trashStoredObjectAttribute($objectAttribute, $version = null)

restoreTrashedObjectAttribute(eZContentObjectAttribute $objectAttribute)

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

deleteStoredObjectAttribute($objectAttribute, $version = null)

deleteStoredClassAttribute($classAttribute, $version = null)

array contentActionList(eZContentClassAttribute $classAttribute)

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

hasInformationCollection()

title($objectAttribute, $name = null)

isIndexable()

isAddToBasketValidationRequired()

validateAddToBasket($objectAttribute, $data, $errors)

isClassAttributeRemovable($classAttribute)

classAttributeRemovableInformation($classAttribute, $includeAll = true)

isInformationCollector()

sortKey($objectAttribute)

sortKeyType()

customSorting()

customSortingSQL($params)

metaData($contentObjectAttribute)

toString($objectAttribute)

fromString($objectAttribute, $string)

templateList()

serializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

unserializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

serializeContentObjectAttribute($package, $objectAttribute)

unserializeContentObjectAttribute($package, $objectAttribute, $attributeNode)

postUnserializeContentObjectAttribute($package, $objectAttribute)

removeRelatedObjectItem($contentObjectAttribute, $objectID)

fixRelatedObjectItem($contentObjectAttribute, $objectID, $mode)

createContentObjectAttributeDOMNode($objectAttribute)

Create empty content object attribute DOM node.

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

getDBAFileName()

getDBAFilePath($checkExtensions = true)

getDBAExtensionFilePath()

importDBDataFromDBAFile($dbaFilePath = false)

cleanDBDataBeforeImport()

batchInitializeObjectAttributeData($classAttribute)

supportsBatchInitializeObjectAttribute()

Details

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

Parameters

$dataTypeString
$name
$properties

at line 85
public viewTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 98
public editTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 111
public informationTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 125
public resultTemplate($collectionAttribute)

Parameters

$collectionAttribute

at line 200
public isA()

at line 210
public bool isTranslatable()

Indicates if datatype supports being translated

Return Value

bool

at line 218
public attributes()

at line 226
public hasAttribute($attr)

Parameters

$attr

at line 234
public attribute($attr)

Parameters

$attr

at line 251
public isHTTPFileInsertionSupported()

at line 261
public isRegularFileInsertionSupported()

at line 271
public isSimpleStringInsertionSupported()

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

Parameters

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

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

Parameters

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

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

Parameters

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

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$objectAttribute
$optionID
$productItem

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

Parameters

$objectAttribute
$mergeInfo

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

Parameters

$classAttribute
$mergeInfo

at line 577
public objectAttributeContent($objectAttribute)

Parameters

$objectAttribute

at line 586
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 594
public classAttributeContent($classAttribute)

Parameters

$classAttribute

at line 608
public storeObjectAttribute($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$contentObjectAttribute
$contentObject
$publishedNodes

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

Parameters

$classAttribute
$version

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

Parameters

$classAttribute
$version

at line 661
public storeDefinedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

at line 670
public storeModifiedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

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

at line 697
public preStoreDefinedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

at line 705
public preStoreModifiedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

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()

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$action
$classAttribute

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

Parameters

$action
$actionName
$value

at line 789
public validateObjectAttributeHTTPInput($http, $base, $objectAttribute)

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

at line 807
public fetchObjectAttributeHTTPInput($http, $base, $objectAttribute)

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$collection
$collectionAttribute
$http
$base
$objectAttribute

at line 844
public customObjectAttributeHTTPAction($http, $action, $objectAttribute, $parameters)

Parameters

$http
$action
$objectAttribute
$parameters

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

Parameters

$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

at line 863
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

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

Parameters

$oldClassAttribute
$newClassAttribute

at line 879
public initializeObjectAttribute($objectAttribute, $currentVersion, $originalContentObjectAttribute)

Parameters

$objectAttribute
$currentVersion
$originalContentObjectAttribute

at line 887
public repairContentObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$objectAttribute
$currentVersion
$originalContentObjectAttribute

at line 903
public postStore($objectAttribute)

Parameters

$objectAttribute

at line 911
public trashStoredObjectAttribute($objectAttribute, $version = null)

Parameters

$objectAttribute
$version

at line 920
public restoreTrashedObjectAttribute(eZContentObjectAttribute $objectAttribute)

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

Parameters

eZContentObjectAttribute $objectAttribute

at line 928
public deleteStoredObjectAttribute($objectAttribute, $version = null)

Parameters

$objectAttribute
$version

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

Parameters

$classAttribute
$version

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

at line 969
public hasInformationCollection()

at line 978
public title($objectAttribute, $name = null)

Parameters

$objectAttribute
$name

at line 986
public isIndexable()

at line 994
public isAddToBasketValidationRequired()

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

Parameters

$objectAttribute
$data
$errors

at line 1022
public isClassAttributeRemovable($classAttribute)

Parameters

$classAttribute

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

Parameters

$classAttribute
$includeAll

at line 1048
public isInformationCollector()

at line 1056
public sortKey($objectAttribute)

Parameters

$objectAttribute

at line 1065
public sortKeyType()

at line 1070
public customSorting()

at line 1075
public customSortingSQL($params)

Parameters

$params

at line 1085
public metaData($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1092
public toString($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$objectAttribute
$string

at line 1112
public templateList()

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$package
$objectAttribute

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

Parameters

$package
$objectAttribute
$attributeNode

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

Parameters

$package
$objectAttribute

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

Parameters

$contentObjectAttribute
$objectID

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

Parameters

$contentObjectAttribute
$objectID
$mode

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

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

Parameters

$old
$new
$options

at line 1365
public getDBAFileName()

at line 1373
public getDBAFilePath($checkExtensions = true)

Parameters

$checkExtensions

at line 1387
public getDBAExtensionFilePath()

at line 1412
public importDBDataFromDBAFile($dbaFilePath = false)

Parameters

$dbaFilePath

at line 1460
public cleanDBDataBeforeImport()

at line 1465
public batchInitializeObjectAttributeData($classAttribute)

Parameters

$classAttribute

at line 1470
public supportsBatchInitializeObjectAttribute()