eZPublishCommunityProject(LegacyStack)  2013.6
eZIdentifierType Class Reference

The class eZIdentifierType does. More...

+ Inheritance diagram for eZIdentifierType:
+ Collaboration diagram for eZIdentifierType:

Public Member Functions

 customClassAttributeHTTPAction ($http, $action, $contentClassAttribute)
 
 eZIdentifierType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 generateIdentifierString ($contentClassAttribute, $identifierValue=false)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeClassAttribute ($classAttribute)
 
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 isIndexable ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 onPublish ($contentObjectAttribute, $contentObject, $publishedNodes)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 preStoreDefinedClassAttribute ($classAttribute)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 sortKey ($contentObjectAttribute)
 
 sortKeyType ()
 
 storeObjectAttribute ($contentObjectattribute)
 
 title ($contentObjectAttribute, $name=null)
 
 toString ($contentObjectAttribute)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
- 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

 $IntegerValidator
 
const DATA_TYPE_STRING = "ezidentifier"
 
const DIGITS_FIELD = "data_int2"
 
const DIGITS_VARIABLE = "_ezidentifier_digits_integer_value_"
 
const IDENTIFIER_FIELD = "data_int3"
 
const IDENTIFIER_VARIABLE = "_ezidentifier_identifier_value_"
 
const POSTTEXT_FIELD = "data_text2"
 
const POSTTEXT_VARIABLE = "_ezidentifier_posttext_value_"
 
const PRETEXT_FIELD = "data_text1"
 
const PRETEXT_VARIABLE = "_ezidentifier_pretext_value_"
 
const START_VALUE_FIELD = "data_int1"
 
const START_VALUE_VARIABLE = "_ezidentifier_start_integer_value_"
 
- 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...
 

Private Member Functions

 assignValue ($contentClassAttribute, $contentObjectAttribute)
 
 storeIdentifierValue ($contentClassAttribute, $contentObjectAttribute, $identifierValue)
 

Additional Inherited Members

- Static Public Member Functions inherited from eZDataType
static allowedTypes ()
 Returns allowed datatypes. More...
 
static create ($dataTypeString)
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($type)
 Load and register the datatype $type. More...
 
static register ($dataTypeString, $className)
 
static registeredDataTypes ()
 

Detailed Description

The class eZIdentifierType does.

Member Function Documentation

eZIdentifierType::assignValue (   $contentClassAttribute,
  $contentObjectAttribute 
)
private

Assigns the identifiervalue for the first version of the current attribute.

Referenced by initializeObjectAttribute(), and onPublish().

eZIdentifierType::customClassAttributeHTTPAction (   $http,
  $action,
  $contentClassAttribute 
)
eZIdentifierType::eZIdentifierType ( )

Constructor

eZIdentifierType::fetchClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZIdentifierType::fetchObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)
eZIdentifierType::fromString (   $contentObjectAttribute,
  $string 
)
eZIdentifierType::generateIdentifierString (   $contentClassAttribute,
  $identifierValue = false 
)
eZIdentifierType::hasObjectAttributeContent (   $contentObjectAttribute)
eZIdentifierType::initializeClassAttribute (   $classAttribute)
eZIdentifierType::initializeObjectAttribute (   $contentObjectAttribute,
  $currentVersion,
  $originalContentObjectAttribute 
)
eZIdentifierType::isIndexable ( )
eZIdentifierType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indices.

eZIdentifierType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

eZIdentifierType::onPublish (   $contentObjectAttribute,
  $contentObject,
  $publishedNodes 
)

When published it will check if it needs to aquire a new unique identifier, if so it updates all existing versions with this new identifier.

eZIdentifierType::preStoreClassAttribute (   $classAttribute,
  $version 
)
eZIdentifierType::preStoreDefinedClassAttribute (   $classAttribute)
eZIdentifierType::serializeContentClassAttribute (   $classAttribute,
  $attributeNode,
  $attributeParametersNode 
)
eZIdentifierType::sortKey (   $contentObjectAttribute)
eZIdentifierType::sortKeyType ( )
eZIdentifierType::storeIdentifierValue (   $contentClassAttribute,
  $contentObjectAttribute,
  $identifierValue 
)
private

Store the new value to the attribute.

Referenced by assignValue().

eZIdentifierType::storeObjectAttribute (   $contentObjectattribute)

Store the content. Since the content has been stored in function fetchObjectAttributeHTTPInput(), this function is with empty code.

eZIdentifierType::title (   $contentObjectAttribute,
  $name = null 
)

Returns the text.

eZIdentifierType::toString (   $contentObjectAttribute)
eZIdentifierType::unserializeContentClassAttribute (   $classAttribute,
  $attributeNode,
  $attributeParametersNode 
)
eZIdentifierType::validateClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)

Validates the input and returns true if the input was valid for this datatype.

eZIdentifierType::validateObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

Validates the input and returns true if the input was valid for this datatype.

Member Data Documentation

eZIdentifierType::$IntegerValidator
const eZIdentifierType::DATA_TYPE_STRING = "ezidentifier"
const eZIdentifierType::DIGITS_FIELD = "data_int2"
const eZIdentifierType::DIGITS_VARIABLE = "_ezidentifier_digits_integer_value_"
const eZIdentifierType::IDENTIFIER_FIELD = "data_int3"
const eZIdentifierType::IDENTIFIER_VARIABLE = "_ezidentifier_identifier_value_"
const eZIdentifierType::POSTTEXT_FIELD = "data_text2"
const eZIdentifierType::POSTTEXT_VARIABLE = "_ezidentifier_posttext_value_"
const eZIdentifierType::PRETEXT_FIELD = "data_text1"
const eZIdentifierType::PRETEXT_VARIABLE = "_ezidentifier_pretext_value_"
const eZIdentifierType::START_VALUE_FIELD = "data_int1"
const eZIdentifierType::START_VALUE_VARIABLE = "_ezidentifier_start_integer_value_"

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