Class

eZDataType

class eZDataType

Properties

$DataTypeString
$Name

Methods

__construct(string $dataTypeString, string $name, array $properties = array())

Initializes the datatype with the string id $dataTypeString and the name $name.

eZDataType(string $dataTypeString, string $name, array $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(eZContentObjectAttribute $objectAttribute, int $currentVersion, eZContentObjectAttribute $originalContentObjectAttribute)

Initializes the object attribute with some data.

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(eZContentObjectAttribute $objectAttribute, int $version = null)

Deletes $objectAttribute datatype data, optionally in version $version.

deleteStoredClassAttribute($classAttribute, $version = null)

deleteNotVersionedStoredClassAttribute(eZContentClassAttribute $classAttribute)

Clean up stored class attribute for content class that is not versioned.

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 54
public __construct(string $dataTypeString, string $name, array $properties = array())

Initializes the datatype with the string id $dataTypeString and the name $name.

Parameters

string $dataTypeString
string $name
array $properties

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

Parameters

string $dataTypeString
string $name
array $properties

at line 100
public viewTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 113
public editTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 126
public informationTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 140
public resultTemplate($collectionAttribute)

Parameters

$collectionAttribute

at line 215
public isA()

at line 225
public bool isTranslatable()

Indicates if datatype supports being translated

Return Value

bool

at line 233
public attributes()

at line 241
public hasAttribute($attr)

Parameters

$attr

at line 249
public attribute($attr)

Parameters

$attr

at line 266
public isHTTPFileInsertionSupported()

at line 276
public isRegularFileInsertionSupported()

at line 286
public isSimpleStringInsertionSupported()

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

Parameters

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

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

Parameters

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

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

Parameters

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

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$objectAttribute
$optionID
$productItem

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

Parameters

$objectAttribute
$mergeInfo

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

Parameters

$classAttribute
$mergeInfo

at line 592
public objectAttributeContent($objectAttribute)

Parameters

$objectAttribute

at line 601
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 609
public classAttributeContent($classAttribute)

Parameters

$classAttribute

at line 623
public storeObjectAttribute($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$contentObjectAttribute
$contentObject
$publishedNodes

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

Parameters

$classAttribute
$version

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

Parameters

$classAttribute
$version

at line 676
public storeDefinedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

at line 685
public storeModifiedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

at line 695
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 712
public preStoreDefinedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

at line 720
public preStoreModifiedClassAttribute(eZContentClassAttribute $classAttribute)

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

at line 732
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 751
public validateClassAttributeHTTPInput($http, $base, $classAttribute)

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$action
$classAttribute

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

Parameters

$action
$actionName
$value

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$collection
$collectionAttribute
$http
$base
$objectAttribute

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

Parameters

$http
$action
$objectAttribute
$parameters

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

Parameters

$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

at line 878
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

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

Parameters

$oldClassAttribute
$newClassAttribute

at line 896
public initializeObjectAttribute(eZContentObjectAttribute $objectAttribute, int $currentVersion, eZContentObjectAttribute $originalContentObjectAttribute)

Initializes the object attribute with some data.

Parameters

eZContentObjectAttribute $objectAttribute
int $currentVersion
eZContentObjectAttribute $originalContentObjectAttribute

at line 904
public repairContentObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$objectAttribute
$currentVersion
$originalContentObjectAttribute

at line 920
public postStore($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$objectAttribute
$version

at line 937
public restoreTrashedObjectAttribute(eZContentObjectAttribute $objectAttribute)

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

Parameters

eZContentObjectAttribute $objectAttribute

at line 947
public deleteStoredObjectAttribute(eZContentObjectAttribute $objectAttribute, int $version = null)

Deletes $objectAttribute datatype data, optionally in version $version.

Parameters

eZContentObjectAttribute $objectAttribute
int $version

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

Parameters

$classAttribute
$version

at line 965
public deleteNotVersionedStoredClassAttribute(eZContentClassAttribute $classAttribute)

Clean up stored class attribute for content class that is not versioned.

Note: Default implementation does nothing

Parameters

eZContentClassAttribute $classAttribute

at line 977
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 998
public hasInformationCollection()

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

Parameters

$objectAttribute
$name

at line 1015
public isIndexable()

at line 1023
public isAddToBasketValidationRequired()

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

Parameters

$objectAttribute
$data
$errors

at line 1051
public isClassAttributeRemovable($classAttribute)

Parameters

$classAttribute

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

Parameters

$classAttribute
$includeAll

at line 1077
public isInformationCollector()

at line 1085
public sortKey($objectAttribute)

Parameters

$objectAttribute

at line 1094
public sortKeyType()

at line 1099
public customSorting()

at line 1104
public customSortingSQL($params)

Parameters

$params

at line 1114
public metaData($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1121
public toString($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$objectAttribute
$string

at line 1141
public templateList()

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$package
$objectAttribute

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

Parameters

$package
$objectAttribute
$attributeNode

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

Parameters

$package
$objectAttribute

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

Parameters

$contentObjectAttribute
$objectID

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

Parameters

$contentObjectAttribute
$objectID
$mode

at line 1362
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 1381
public diff($old, $new, $options = false)

Parameters

$old
$new
$options

at line 1394
public getDBAFileName()

at line 1402
public getDBAFilePath($checkExtensions = true)

Parameters

$checkExtensions

at line 1416
public getDBAExtensionFilePath()

at line 1441
public importDBDataFromDBAFile($dbaFilePath = false)

Parameters

$dbaFilePath

at line 1489
public cleanDBDataBeforeImport()

at line 1494
public batchInitializeObjectAttributeData($classAttribute)

Parameters

$classAttribute

at line 1499
public supportsBatchInitializeObjectAttribute()