eZPublishCommunityProject(LegacyStack)  2013.5
eZStringType Class Reference

A content datatype which handles text lines. More...

+ Inheritance diagram for eZStringType:
+ Collaboration diagram for eZStringType:

Public Member Functions

 batchInitializeObjectAttributeData ($classAttribute)
 
 diff ($old, $new, $options=false)
 
 eZStringType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fixupClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 insertSimpleString ($object, $objectVersion, $objectLanguage, $objectAttribute, $string, &$result)
 
 isIndexable ()
 
 isInformationCollector ()
 
 isSimpleStringInsertionSupported ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 sortKey ($contentObjectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute ($attribute, $version)
 
 storeDefinedClassAttribute ($attribute)
 
 storeObjectAttribute ($attribute)
 
 supportsBatchInitializeObjectAttribute ()
 
 title ($contentObjectAttribute, $name=null)
 
 toString ($contentObjectAttribute)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 validateStringHTTPInput ($data, $contentObjectAttribute, $classAttribute)
 
- Public Member Functions inherited from eZDataType
 attribute ($attr)
 
 attributes ()
 
 batchInitializeObjectAttributeData ($classAttribute)
 
 classAttributeContent ($classAttribute)
 
 classAttributeRemovableInformation ($classAttribute, $includeAll=true)
 
 classDisplayInformation ($classAttribute, $mergeInfo=false)
 
 cloneClassAttribute ($oldClassAttribute, $newClassAttribute)
 
 contentActionList ($classAttribute)
 Return content action(s) which can be performed on object containing the current datatype. More...
 
 createContentObjectAttributeDOMNode ($objectAttribute)
 Create empty content object attribute DOM node. More...
 
 customClassAttributeHTTPAction ($http, $action, $classAttribute)
 
 customObjectAttributeHTTPAction ($http, $action, $objectAttribute, $parameters)
 
 customSorting ()
 
 customSortingSQL ($params)
 
 deleteStoredClassAttribute ($classAttribute, $version=null)
 
 deleteStoredObjectAttribute ($objectAttribute, $version=null)
 
 diff ($old, $new, $options=false)
 
 editTemplate ($contentobjectAttribute)
 
 eZDataType ($dataTypeString, $name, $properties=array())
 
 fetchActionValue ($action, $actionName, &$value)
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $objectAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $objectAttribute)
 
 fixRelatedObjectItem ($contentObjectAttribute, $objectID, $mode)
 
 fixupClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fixupCollectionAttributeHTTPInput ($http, $base, $objectAttribute)
 
 fixupObjectAttributeHTTPInput ($http, $base, $objectAttribute)
 
 fromString ($objectAttribute, $string)
 
 getDBAExtensionFilePath ()
 
 getDBAFileName ()
 
 getDBAFilePath ($checkExtensions=true)
 
 handleCustomObjectHTTPActions ($http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 handleDownload ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 hasAttribute ($attr)
 
 hasInformationCollection ()
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 hasStoredFileInformation ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 importDBDataFromDBAFile ($dbaFilePath=false)
 
 informationTemplate ($contentobjectAttribute)
 
 initializeClassAttribute ($classAttribute)
 
 initializeObjectAttribute ($objectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 insertHTTPFile ($object, $objectVersion, $objectLanguage, $objectAttribute, $httpFile, $mimeData, &$result)
 
 insertRegularFile ($object, $objectVersion, $objectLanguage, $objectAttribute, $filePath, &$result)
 
 insertSimpleString ($object, $objectVersion, $objectLanguage, $objectAttribute, $string, &$result)
 
 isA ()
 
 isAddToBasketValidationRequired ()
 
 isClassAttributeRemovable ($classAttribute)
 
 isHTTPFileInsertionSupported ()
 
 isIndexable ()
 
 isInformationCollector ()
 
 isRegularFileInsertionSupported ()
 
 isSimpleStringInsertionSupported ()
 
 isTranslatable ()
 Indicates if datatype supports being translated. More...
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($objectAttribute)
 
 objectDisplayInformation ($objectAttribute, $mergeInfo=false)
 
 onPublish ($contentObjectAttribute, $contentObject, $publishedNodes)
 
 postInitializeObjectAttribute ($objectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 postStore ($objectAttribute)
 
 postUnserializeContentObjectAttribute ($package, $objectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 preStoreDefinedClassAttribute ($classAttribute)
 
 preStoreModifiedClassAttribute ($classAttribute)
 
 preStoreVersionedClassAttribute ($classAttribute, $version)
 Hook function which is called before an content class attribute is stored. More...
 
 productOptionInformation ($objectAttribute, $optionID, $productItem)
 
 removeRelatedObjectItem ($contentObjectAttribute, $objectID)
 
 repairContentObjectAttribute ($contentObjectAttribute)
 
 restoreTrashedObjectAttribute ($objectAttribute)
 Restores the content object attribute $objectAttribute from trash Default implementation does nothing. More...
 
 resultTemplate (&$collectionAttribute)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 serializeContentObjectAttribute ($package, $objectAttribute)
 
 sortKey ($objectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute ($classAttribute, $version)
 
 storeDefinedClassAttribute ($classAttribute)
 
 storedFileInformation ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 storeModifiedClassAttribute ($classAttribute)
 
 storeObjectAttribute ($objectAttribute)
 
 storeVersionedClassAttribute ($classAttribute, $version)
 
 supportsBatchInitializeObjectAttribute ()
 
 templateList ()
 
 title ($objectAttribute, $name=null)
 
 toString ($objectAttribute)
 
 trashStoredObjectAttribute ($objectAttribute, $version=null)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
 
 validateAddToBasket ($objectAttribute, $data, &$errors)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateCollectionAttributeHTTPInput ($http, $base, $objectAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $objectAttribute)
 
 viewTemplate ($contentobjectAttribute)
 

Public Attributes

 $MaxLenValidator
 The max len validator. More...
 
const DATA_TYPE_STRING = 'ezstring'
 
const DEFAULT_STRING_FIELD = "data_text1"
 
const DEFAULT_STRING_VARIABLE = "_ezstring_default_value_"
 
const MAX_LEN_FIELD = 'data_int1'
 
const MAX_LEN_VARIABLE = '_ezstring_max_string_length_'
 
- Public Attributes inherited from eZDataType
 $DataTypeString
 The datatype string ID, used for uniquely identifying a datatype. More...
 
 $Name
 The descriptive name of the datatype, usually used for displaying to the user. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from eZDataType
static allowedTypes ()
 
static create ($dataTypeString)
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($type)
 
static register ($dataTypeString, $className)
 
static registeredDataTypes ()
 

Detailed Description

A content datatype which handles text lines.

It provides the functionality to work as a text line and handles class definition input, object definition input and object viewing.

It uses the spare field data_text in a content object attribute for storing the attribute data.

Member Function Documentation

eZStringType::batchInitializeObjectAttributeData (   $classAttribute)
eZStringType::diff (   $old,
  $new,
  $options = false 
)
eZStringType::eZStringType ( )

Initializes with a string id and a description.

eZStringType::fetchClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZStringType::fetchCollectionAttributeHTTPInput (   $collection,
  $collectionAttribute,
  $http,
  $base,
  $contentObjectAttribute 
)

Fetches the http post variables for collected information

eZStringType::fetchObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

Fetches the http post var string input and stores it in the data instance.

eZStringType::fixupClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZStringType::fromString (   $contentObjectAttribute,
  $string 
)
eZStringType::hasObjectAttributeContent (   $contentObjectAttribute)
eZStringType::initializeObjectAttribute (   $contentObjectAttribute,
  $currentVersion,
  $originalContentObjectAttribute 
)

Sets the default value.

eZStringType::insertSimpleString (   $object,
  $objectVersion,
  $objectLanguage,
  $objectAttribute,
  $string,
$result 
)

Inserts the string $string in the 'data_text' database field.

eZStringType::isIndexable ( )
eZStringType::isInformationCollector ( )
eZStringType::isSimpleStringInsertionSupported ( )

Simple string insertion is supported.

eZStringType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indeces.

eZStringType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

eZStringType::serializeContentClassAttribute (   $classAttribute,
  $attributeNode,
  $attributeParametersNode 
)
eZStringType::sortKey (   $contentObjectAttribute)
eZStringType::sortKeyType ( )
eZStringType::storeClassAttribute (   $attribute,
  $version 
)
eZStringType::storeDefinedClassAttribute (   $attribute)
eZStringType::storeObjectAttribute (   $attribute)

Does nothing since it uses the data_text field in the content object attribute. See fetchObjectAttributeHTTPInput for the actual storing.

eZStringType::supportsBatchInitializeObjectAttribute ( )
eZStringType::title (   $contentObjectAttribute,
  $name = null 
)

Returns the content of the string for use as a title

eZStringType::toString (   $contentObjectAttribute)
Returns
string representation of an contentobjectattribute data for simplified export
eZStringType::unserializeContentClassAttribute (   $classAttribute,
  $attributeNode,
  $attributeParametersNode 
)
eZStringType::validateClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZStringType::validateCollectionAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)
eZStringType::validateObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)
eZStringType::validateStringHTTPInput (   $data,
  $contentObjectAttribute,
  $classAttribute 
)

Member Data Documentation

eZStringType::$MaxLenValidator

The max len validator.

const eZStringType::DATA_TYPE_STRING = 'ezstring'
const eZStringType::DEFAULT_STRING_FIELD = "data_text1"
const eZStringType::DEFAULT_STRING_VARIABLE = "_ezstring_default_value_"
const eZStringType::MAX_LEN_FIELD = 'data_int1'
const eZStringType::MAX_LEN_VARIABLE = '_ezstring_max_string_length_'

The documentation for this class was generated from the following file: