eZPublishCommunityProject(LegacyStack)  2013.5
eZIntegerType Class Reference

A content datatype which handles integers. More...

+ Inheritance diagram for eZIntegerType:
+ Collaboration diagram for eZIntegerType:

Public Member Functions

 batchInitializeObjectAttributeData ($classAttribute)
 
 eZIntegerType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fixupClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fixupObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 isIndexable ()
 
 isInformationCollector ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 sortKey ($contentObjectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute ($attribute, $version)
 
 storeObjectAttribute ($object_attribute)
 
 supportsBatchInitializeObjectAttribute ()
 
 title ($contentObjectAttribute, $name=null)
 
 toString ($contentObjectAttribute)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 validateIntegerHTTPInput ($data, $contentObjectAttribute, $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
 The integer value validator. More...
 
const DATA_TYPE_STRING = "ezinteger"
 
const DEFAULT_VALUE_FIELD = "data_int3"
 
const DEFAULT_VALUE_VARIABLE = "_ezinteger_default_value_"
 
const HAS_MAX_VALUE = 2
 
const HAS_MIN_MAX_VALUE = 3
 
const HAS_MIN_VALUE = 1
 
const INPUT_STATE_FIELD = "data_int4"
 
const MAX_VALUE_FIELD = "data_int2"
 
const MAX_VALUE_VARIABLE = "_ezinteger_max_integer_value_"
 
const MIN_VALUE_FIELD = "data_int1"
 
const MIN_VALUE_VARIABLE = "_ezinteger_min_integer_value_"
 
const NO_MIN_MAX_VALUE = 0
 
- 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 integers.

It provides the functionality to work as an integer and handles class definition input, object definition input and object viewing.

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

Member Function Documentation

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

Fetches the http post variables for collected information

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

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

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

Sets the default value.

eZIntegerType::isIndexable ( )
Returns
true if the datatype can be indexed
eZIntegerType::isInformationCollector ( )
eZIntegerType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indeces.

eZIntegerType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

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

Does nothing, the data is already present in the attribute.

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

Returns the integer value.

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

Private method, only for using inside this class.

Referenced by validateCollectionAttributeHTTPInput(), and validateObjectAttributeHTTPInput().

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

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

Member Data Documentation

eZIntegerType::$IntegerValidator

The integer value validator.

const eZIntegerType::DATA_TYPE_STRING = "ezinteger"
const eZIntegerType::DEFAULT_VALUE_FIELD = "data_int3"
const eZIntegerType::DEFAULT_VALUE_VARIABLE = "_ezinteger_default_value_"
const eZIntegerType::HAS_MAX_VALUE = 2
const eZIntegerType::HAS_MIN_MAX_VALUE = 3
const eZIntegerType::HAS_MIN_VALUE = 1
const eZIntegerType::INPUT_STATE_FIELD = "data_int4"
const eZIntegerType::MAX_VALUE_FIELD = "data_int2"
const eZIntegerType::MAX_VALUE_VARIABLE = "_ezinteger_max_integer_value_"
const eZIntegerType::MIN_VALUE_FIELD = "data_int1"
const eZIntegerType::MIN_VALUE_VARIABLE = "_ezinteger_min_integer_value_"
const eZIntegerType::NO_MIN_MAX_VALUE = 0

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