Class

eZObjectRelationListType

class eZObjectRelationListType extends eZDataType

Constants

DATA_TYPE_STRING

Properties

$DataTypeString
$Name

Methods

__construct()

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

eZDataType(string $dataTypeString, string $name, array $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)

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

from eZDataType
objectAttributeContent($contentObjectAttribute)

hasObjectAttributeContent($contentObjectAttribute)

classAttributeContent($classAttribute)

storeObjectAttribute($contentObjectAttribute)

onPublish($contentObjectAttribute, $contentObject, $publishedNodes)

preStoreClassAttribute($classAttribute, $version)

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)

fixupClassAttributeHTTPInput($http, $base, $classAttribute)

fetchClassAttributeHTTPInput($http, $base, $classAttribute)

customClassAttributeHTTPAction($http, $action, $classAttribute)

fetchActionValue($action, $actionName, $value)

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

fixupObjectAttributeHTTPInput($http, $base, $contentObjectAttribute)

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, $contentObjectAttribute, $parameters)

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

initializeClassAttribute($classAttribute)

cloneClassAttribute($oldClassAttribute, $newClassAttribute)

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

Initializes the object attribute with some data.

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

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

deleteStoredClassAttribute($classAttribute, $version = null)

from eZDataType
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.

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

fromString($contentObjectAttribute, $string)

templateList()

from eZDataType
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.

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

createNewObject($contentObjectAttribute, $name)

storeClassAttributeContent($classAttribute, $content)

storeObjectAttributeContent($objectAttribute, $content)

createInstance($class, $priority, $contentObjectAttribute, $nodePlacement = false)

array|null appendObject(integer $objectID, integer $priority, eZContentObjectAttribute $contentObjectAttribute)

Generate array with object relation info

fixRelationsMove($objectID, $contentObjectAttribute)

fixRelationsTrash($objectID, $contentObjectAttribute)

fixRelationsRestore($objectID, $contentObjectAttribute)

fixRelationsRemove($objectID, $contentObjectAttribute)

fixRelationsSwap($objectID, $contentObjectAttribute)

defaultClassAttributeContent()

defaultObjectAttributeContent()

createClassContentStructure($doc)

createObjectContentStructure($doc)

Details

at line 29
public __construct()

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

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

Parameters

string $dataTypeString
string $name
array $properties

in eZDataType at line 100
public viewTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

in eZDataType at line 113
public editTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

in eZDataType at line 126
public informationTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

in eZDataType at line 140
public resultTemplate($collectionAttribute)

Parameters

$collectionAttribute

in eZDataType at line 215
public isA()

in eZDataType at line 225
public bool isTranslatable()

Indicates if datatype supports being translated

Return Value

bool

in eZDataType at line 233
public attributes()

in eZDataType at line 241
public hasAttribute($attr)

Parameters

$attr

in eZDataType at line 249
public attribute($attr)

Parameters

$attr

in eZDataType at line 266
public isHTTPFileInsertionSupported()

in eZDataType at line 276
public isRegularFileInsertionSupported()

in eZDataType at line 286
public isSimpleStringInsertionSupported()

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

Parameters

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

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

Parameters

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

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

Parameters

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

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$object
$objectVersion
$objectLanguage
$objectAttribute

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

Parameters

$objectAttribute
$optionID
$productItem

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

Parameters

$objectAttribute
$mergeInfo

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

Parameters

$classAttribute
$mergeInfo

at line 1439
public objectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1674
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1453
public classAttributeContent($classAttribute)

Parameters

$classAttribute

at line 386
public storeObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$contentObjectAttribute
$contentObject
$publishedNodes

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

Parameters

$classAttribute
$version

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

Parameters

$classAttribute
$version

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

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

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

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

in eZDataType 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

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

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

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

Parameters

eZContentClassAttribute $classAttribute Content class attribute of the datatype

in eZDataType 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 660
public validateClassAttributeHTTPInput($http, $base, $classAttribute)

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$action
$classAttribute

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

Parameters

$action
$actionName
$value

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

Parameters

$http
$base
$contentObjectAttribute

at line 159
public fixupObjectAttributeHTTPInput($http, $base, $contentObjectAttribute)

Parameters

$http
$base
$contentObjectAttribute

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

Parameters

$http
$base
$contentObjectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$collection
$collectionAttribute
$http
$base
$objectAttribute

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

Parameters

$http
$action
$contentObjectAttribute
$parameters

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

Parameters

$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

at line 707
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

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

Parameters

$oldClassAttribute
$newClassAttribute

at line 571
public initializeObjectAttribute($contentObjectAttribute, int $currentVersion, eZContentObjectAttribute $originalContentObjectAttribute)

Initializes the object attribute with some data.

Parameters

$contentObjectAttribute
int $currentVersion
eZContentObjectAttribute $originalContentObjectAttribute

in eZDataType at line 904
public repairContentObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$objectAttribute
$currentVersion
$originalContentObjectAttribute

in eZDataType at line 920
public postStore($objectAttribute)

Parameters

$objectAttribute

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

Parameters

$objectAttribute
$version

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

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

Parameters

eZContentObjectAttribute $objectAttribute

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

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

Parameters

eZContentObjectAttribute $objectAttribute
int $version

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

Parameters

$classAttribute
$version

at line 890
public deleteNotVersionedStoredClassAttribute(eZContentClassAttribute $classAttribute)

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

Note: Default implementation does nothing

Parameters

eZContentClassAttribute $classAttribute

in eZDataType 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

in eZDataType at line 998
public hasInformationCollection()

at line 1689
public title($contentObjectAttribute, $name = null)

Parameters

$contentObjectAttribute
$name

at line 1680
public isIndexable()

in eZDataType at line 1023
public isAddToBasketValidationRequired()

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

Parameters

$objectAttribute
$data
$errors

in eZDataType at line 1051
public isClassAttributeRemovable($classAttribute)

Parameters

$classAttribute

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

Parameters

$classAttribute
$includeAll

in eZDataType at line 1077
public isInformationCollector()

in eZDataType at line 1085
public sortKey($objectAttribute)

Parameters

$objectAttribute

in eZDataType at line 1094
public sortKeyType()

in eZDataType at line 1099
public customSorting()

in eZDataType at line 1104
public customSortingSQL($params)

Parameters

$params

at line 1594
public metaData($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1640
public toString($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 1651
public fromString($contentObjectAttribute, $string)

Parameters

$contentObjectAttribute
$string

in eZDataType at line 1141
public templateList()

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$package
$objectAttribute

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

Parameters

$package
$objectAttribute
$attributeNode

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

Parameters

$package
$objectAttribute

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

Parameters

$contentObjectAttribute
$objectID

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

Parameters

$contentObjectAttribute
$objectID
$mode

in eZDataType 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

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

Parameters

$old
$new
$options

in eZDataType at line 1394
public getDBAFileName()

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

Parameters

$checkExtensions

in eZDataType at line 1416
public getDBAExtensionFilePath()

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

Parameters

$dbaFilePath

in eZDataType at line 1489
public cleanDBDataBeforeImport()

in eZDataType at line 1494
public batchInitializeObjectAttributeData($classAttribute)

Parameters

$classAttribute

at line 1931
public supportsBatchInitializeObjectAttribute()

at line 328
public createNewObject($contentObjectAttribute, $name)

Parameters

$contentObjectAttribute
$name

at line 723
public storeClassAttributeContent($classAttribute, $content)

Parameters

$classAttribute
$content

at line 734
public storeObjectAttributeContent($objectAttribute, $content)

Parameters

$objectAttribute
$content

at line 1277
public createInstance($class, $priority, $contentObjectAttribute, $nodePlacement = false)

Parameters

$class
$priority
$contentObjectAttribute
$nodePlacement

at line 1308
public array|null appendObject(integer $objectID, integer $priority, eZContentObjectAttribute $contentObjectAttribute)

Generate array with object relation info

Parameters

integer $objectID The id of the object to add as relation
integer $priority The priortity of the relation
eZContentObjectAttribute $contentObjectAttribute Not used

Return Value

array|null A array containing relation information or null if object does not exist

at line 1371
public fixRelationsMove($objectID, $contentObjectAttribute)

Parameters

$objectID
$contentObjectAttribute

at line 1376
public fixRelationsTrash($objectID, $contentObjectAttribute)

Parameters

$objectID
$contentObjectAttribute

at line 1393
public fixRelationsRestore($objectID, $contentObjectAttribute)

Parameters

$objectID
$contentObjectAttribute

at line 1410
public fixRelationsRemove($objectID, $contentObjectAttribute)

Parameters

$objectID
$contentObjectAttribute

at line 1416
public fixRelationsSwap($objectID, $contentObjectAttribute)

Parameters

$objectID
$contentObjectAttribute

at line 1471
public defaultClassAttributeContent()

at line 1480
public defaultObjectAttributeContent()

at line 1485
public createClassContentStructure($doc)

Parameters

$doc

at line 1524
public createObjectContentStructure($doc)

Parameters

$doc