Class

eZStringType

class eZStringType extends eZDataType

Constants

DATA_TYPE_STRING

MAX_LEN_FIELD

MAX_LEN_VARIABLE

DEFAULT_STRING_FIELD

DEFAULT_STRING_VARIABLE

Properties

$DataTypeString
$Name
$MaxLenValidator

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

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)

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)

onPublish($contentObjectAttribute, $contentObject, $publishedNodes)

from eZDataType
preStoreClassAttribute($classAttribute, $version)

from eZDataType
storeClassAttribute($attribute, $version)

storeDefinedClassAttribute($attribute)

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)

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

fixupCollectionAttributeHTTPInput($http, $base, $objectAttribute)

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

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

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

from eZDataType
initializeClassAttribute($classAttribute)

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

from eZDataType
deleteStoredClassAttribute($classAttribute, $version = null)

from eZDataType
deleteNotVersionedStoredClassAttribute(eZContentClassAttribute $classAttribute)

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

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

isIndexable()

isAddToBasketValidationRequired()

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

from eZDataType
isClassAttributeRemovable($classAttribute)

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

from eZDataType
isInformationCollector()

sortKey($contentObjectAttribute)

sortKeyType()

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)

from eZDataType
unserializeContentObjectAttribute($package, $objectAttribute, $attributeNode)

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

supportsBatchInitializeObjectAttribute()

int validateStringHTTPInput($data $data, eZContentObjectAttribute $contentObjectAttribute, eZContentClassAttribute $classAttribute)

Validates $data with the constraints defined on the class attribute

Details

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

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

at line 199
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 273
public objectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 308
public hasObjectAttributeContent($contentObjectAttribute)

Parameters

$contentObjectAttribute

in eZDataType at line 609
public classAttributeContent($classAttribute)

Parameters

$classAttribute

at line 184
public storeObjectAttribute($attribute)

Parameters

$attribute

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

Parameters

$contentObjectAttribute
$contentObject
$publishedNodes

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

Parameters

$classAttribute
$version

at line 210
public storeClassAttribute($attribute, $version)

Parameters

$attribute
$version

at line 214
public storeDefinedClassAttribute($attribute)

Parameters

$attribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

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

Parameters

$http
$base
$classAttribute

in eZDataType at line 778
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 94
public validateObjectAttributeHTTPInput($http, $base, $contentObjectAttribute)

Parameters

$http
$base
$contentObjectAttribute

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

Parameters

$http
$base
$objectAttribute

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

Parameters

$http
$base
$contentObjectAttribute

at line 125
public validateCollectionAttributeHTTPInput($http, $base, $contentObjectAttribute)

Parameters

$http
$base
$contentObjectAttribute

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

Parameters

$http
$base
$objectAttribute

at line 169
public fetchCollectionAttributeHTTPInput($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)

Parameters

$collection
$collectionAttribute
$http
$base
$contentObjectAttribute

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

Parameters

$http
$action
$objectAttribute
$parameters

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

Parameters

$http
$attributeDataBaseName
$customActionAttributeArray
$customActionParameters

in eZDataType at line 878
public initializeClassAttribute($classAttribute)

Parameters

$classAttribute

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

Parameters

$oldClassAttribute
$newClassAttribute

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

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

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

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

Parameters

$contentObjectAttribute
$name

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

at line 318
public isInformationCollector()

at line 323
public sortKey($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 329
public sortKeyType()

in eZDataType at line 1099
public customSorting()

in eZDataType at line 1104
public customSortingSQL($params)

Parameters

$params

at line 281
public metaData($contentObjectAttribute)

Parameters

$contentObjectAttribute

at line 289
public toString($contentObjectAttribute)

Parameters

$contentObjectAttribute

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

Parameters

$contentObjectAttribute
$string

in eZDataType at line 1141
public templateList()

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$classAttribute
$attributeNode
$attributeParametersNode

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

Parameters

$package
$objectAttribute

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

Parameters

$package
$objectAttribute
$attributeNode

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

Parameters

$package
$objectAttribute

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

Parameters

$contentObjectAttribute
$objectID

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

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

at line 372
public batchInitializeObjectAttributeData($classAttribute)

Parameters

$classAttribute

at line 367
public supportsBatchInitializeObjectAttribute()

at line 78
public int validateStringHTTPInput($data $data, eZContentObjectAttribute $contentObjectAttribute, eZContentClassAttribute $classAttribute)

Validates $data with the constraints defined on the class attribute

Parameters

$data $data
eZContentObjectAttribute $contentObjectAttribute
eZContentClassAttribute $classAttribute

Return Value

int