eZ Publish Community Project (Legacy Stack) 2013.4
Class

eZXMLTextType

class eZXMLTextType extends eZDataType

Constants

DATA_TYPE_STRING

COLS_FIELD

COLS_VARIABLE

TAG_PRESET_FIELD

TAG_PRESET_VARIABLE

VERSION_30_TIMESTAMP

VERSION_TIMESTAMP

Properties

$DataTypeString
$Name

Methods

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

from eZDataType
viewTemplate($contentobjectAttribute)

editTemplate($contentobjectAttribute)

informationTemplate($contentobjectAttribute)

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)

from eZDataType
storeObjectAttribute($attribute)

boolean onPublish(eZContentObjectAttribute $contentObjectAttribute, eZContentObject $object, array $publishedNodes)

Method triggered on publish for xml text datatype

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

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

from eZDataType
initializeClassAttribute($classAttribute)

cloneClassAttribute($oldClassAttribute, $newClassAttribute)

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

repairContentObjectAttribute($contentObjectAttribute)

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

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($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, $value = null)

isIndexable()

isAddToBasketValidationRequired()

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

from eZDataType
isClassAttributeRemovable($classAttribute)

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

from eZDataType
isInformationCollector()

sortKey($objectAttribute)

from eZDataType
sortKeyType()

from eZDataType
customSorting()

from eZDataType
customSortingSQL($params)

from eZDataType
metaData($contentObjectAttribute)

toString($contentObjectAttribute)

fromString($contentObjectAttribute, $string)

templateList()

serializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

unserializeContentClassAttribute($classAttribute, $attributeNode, $attributeParametersNode)

serializeContentObjectAttribute($package, $objectAttribute)

unserializeContentObjectAttribute($package, $objectAttribute, $attributeNode)

postUnserializeContentObjectAttribute($package, $objectAttribute)

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)

supportsBatchInitializeObjectAttribute()

eZXMLTextType()

viewTemplateSuffix($contentobjectAttribute)

editTemplateSuffix($contentobjectAttribute)

informationTemplateSuffix($contentobjectAttribute)

Details

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

Parameters

$dataTypeString
$name
$properties

at line 306
public viewTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 317
public editTemplate($contentobjectAttribute)

Parameters

$contentobjectAttribute

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

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

Parameters

$contentObjectAttribute

at line 499
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

in eZDataType at line 594
public classAttributeContent($classAttribute)

Parameters

$classAttribute

at line 301
public storeObjectAttribute($attribute)

Parameters

$attribute

at line 148
public boolean onPublish(eZContentObjectAttribute $contentObjectAttribute, eZContentObject $object, array $publishedNodes)

Method triggered on publish for xml text datatype

This method makes sure that links from all translations of an xml text are registered in the ezurlobjectlink table, and thus retained, if previous versions of an object are removed.

It also checks for embedded objects in other languages xml, and makes sure the matching object relations are stored for the publish version.

Parameters

eZContentObjectAttribute $contentObjectAttribute
eZContentObject $object
array $publishedNodes

Return Value

boolean

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 259
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 248
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 280
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

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

at line 107
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

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

Parameters

$oldClassAttribute
$newClassAttribute

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

Parameters

$contentObjectAttribute
$currentVersion
$originalContentObjectAttribute

in eZDataType at line 887
public repairContentObjectAttribute($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 294
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 775
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 466
public title($contentObjectAttribute, $value = null)

Parameters

$contentObjectAttribute
$value

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

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

Parameters

$contentObjectAttribute

at line 452
public toString($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$contentObjectAttribute
$string

at line 521
public templateList()

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$package
$objectAttribute

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

Parameters

$package
$objectAttribute
$attributeNode

at line 681
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 823
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()

at line 837
public batchInitializeObjectAttributeData($classAttribute)

Parameters

$classAttribute

at line 832
public supportsBatchInitializeObjectAttribute()

at line 98
public eZXMLTextType()

at line 335
public viewTemplateSuffix($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 342
public editTemplateSuffix($contentobjectAttribute)

Parameters

$contentobjectAttribute

at line 349
public informationTemplateSuffix($contentobjectAttribute)

Parameters

$contentobjectAttribute