eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZEnumType

class eZEnumType extends eZDataType

Constants

DATA_TYPE_STRING

IS_MULTIPLE_FIELD

IS_MULTIPLE_VARIABLE

IS_OPTION_FIELD

IS_OPTION_VARIABLE

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

from eZDataType
isRegularFileInsertionSupported()

from eZDataType
isSimpleStringInsertionSupported()

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

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

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

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

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

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

from eZDataType
productOptionInformation($objectAttribute, $optionID, $productItem)

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

classDisplayInformation($classAttribute, $mergeInfo = false)

from eZDataType
objectAttributeContent($contentObjectAttribute)

hasObjectAttributeContent($contentObjectAttribute)

classAttributeContent($contentClassAttribute)

storeObjectAttribute($contentObjectAttribute)

onPublish($contentObjectAttribute, $contentObject, $publishedNodes)

from eZDataType
preStoreClassAttribute($classAttribute, $version)

from eZDataType
storeClassAttribute($contentClassAttribute, $version)

storeDefinedClassAttribute($contentClassAttribute)

storeModifiedClassAttribute($contentClassAttribute)

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, $contentClassAttribute)

fixupClassAttributeHTTPInput($http, $base, $classAttribute)

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

customClassAttributeHTTPAction($http, $action, $contentClassAttribute)

fetchActionValue($action, $actionName, $value)

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

fixupObjectAttributeHTTPInput($http, $base, $objectAttribute)

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

validateCollectionAttributeHTTPInput($http, $base, $objectAttribute)

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

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

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

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

from eZDataType
initializeClassAttribute($classAttribute)

cloneClassAttribute($oldClassAttribute, $newClassAttribute)

initializeObjectAttribute($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)

repairContentObjectAttribute($contentObjectAttribute)

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

from eZDataType
postStore($objectAttribute)

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

from eZDataType
restoreTrashedObjectAttribute(eZContentObjectAttribute $objectAttribute)

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

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

deleteStoredClassAttribute($contentClassAttribute, $version = null)

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 = null)

isIndexable()

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)

from eZDataType
fromString($objectAttribute, $string)

from eZDataType
templateList()

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

unserializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

serializeContentObjectAttribute($package, $contentObjectAttribute)

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)

getDBAFileName()

from eZDataType
getDBAFilePath($checkExtensions = true)

from eZDataType
getDBAExtensionFilePath()

from eZDataType
importDBDataFromDBAFile($dbaFilePath = false)

from eZDataType
cleanDBDataBeforeImport()

from eZDataType
batchInitializeObjectAttributeData($classAttribute)

from eZDataType
supportsBatchInitializeObjectAttribute()

from eZDataType
eZEnumType()

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

in eZDataType at line 251
public isHTTPFileInsertionSupported()

in eZDataType at line 261
public isRegularFileInsertionSupported()

in eZDataType at line 271
public isSimpleStringInsertionSupported()

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

Parameters

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

in eZDataType at line 324
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

in eZDataType at line 370
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

in eZDataType at line 415
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

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

Parameters

$objectAttribute
$mergeInfo

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

Parameters

$classAttribute
$mergeInfo

at line 214
public objectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 459
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 293
public classAttributeContent($contentClassAttribute)

Parameters

$contentClassAttribute

at line 207
public storeObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$contentObjectAttribute
$contentObject
$publishedNodes

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

Parameters

$classAttribute
$version

at line 275
public storeClassAttribute($contentClassAttribute, $version)

Parameters

$contentClassAttribute
$version

at line 280
public storeDefinedClassAttribute($contentClassAttribute)

Parameters

$contentClassAttribute

at line 285
public storeModifiedClassAttribute($contentClassAttribute)

Parameters

$contentClassAttribute

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

at line 234
public validateClassAttributeHTTPInput($http, $base, $contentClassAttribute)

Parameters

$http
$base
$contentClassAttribute

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

Parameters

$http
$base
$classAttribute

at line 242
public fetchClassAttributeHTTPInput($http, $base, $contentClassAttribute)

Parameters

$http
$base
$contentClassAttribute

at line 301
public customClassAttributeHTTPAction($http, $action, $contentClassAttribute)

Parameters

$http
$action
$contentClassAttribute

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

Parameters

$action
$actionName
$value

at line 183
public validateObjectAttributeHTTPInput($http, $base, $contentObjectAttribute)

Parameters

$http
$base
$contentObjectAttribute

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

Parameters

$http
$base
$objectAttribute

at line 130
public fetchObjectAttributeHTTPInput($http, $base, $contentObjectAttribute)

Parameters

$http
$base
$contentObjectAttribute

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

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

Parameters

$http
$action
$objectAttribute
$parameters

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

Parameters

$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

at line 88
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

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

Parameters

$oldClassAttribute
$newClassAttribute

at line 37
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

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

Parameters

$objectAttribute
$version

in eZDataType at line 920
public restoreTrashedObjectAttribute(eZContentObjectAttribute $objectAttribute)

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

Parameters

eZContentObjectAttribute $objectAttribute

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

Parameters

$contentObjectAttribute
$version

at line 120
public deleteStoredClassAttribute($contentClassAttribute, $version = null)

Parameters

$contentClassAttribute
$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 333
public title($contentObjectAttribute, $name = null)

Parameters

$contentObjectAttribute
$name

at line 392
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 354
public metaData($contentObjectAttribute)

Parameters

$contentObjectAttribute

in eZDataType at line 1092
public toString($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$objectAttribute
$string

in eZDataType at line 1112
public templateList()

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

at line 401
public serializeContentObjectAttribute($package, $contentObjectAttribute)

Parameters

$package
$contentObjectAttribute

at line 431
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

at line 512
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

in eZDataType at line 1470
public supportsBatchInitializeObjectAttribute()

at line 28
public eZEnumType()