eZ Publish  [trunk]
eZDateTimeType Class Reference

Stores a date and time value. More...

+ Inheritance diagram for eZDateTimeType:
+ Collaboration diagram for eZDateTimeType:

List of all members.

Public Member Functions

 batchInitializeObjectAttributeData ($classAttribute)
 classAttributeContent ($classAttribute)
 contentObjectArrayXMLMap ()
 defaultClassAttributeContent ()
 eZDateTimeType ()
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 fromString ($contentObjectAttribute, $string)
 hasObjectAttributeContent ($contentObjectAttribute)
 initializeClassAttribute ($classAttribute)
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 isIndexable ()
 isInformationCollector ()
 metaData ($contentObjectAttribute)
 objectAttributeContent ($contentObjectAttribute)
 parseXML ($xmlText)
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 serializeContentObjectAttribute ($package, $objectAttribute)
 sortKey ($contentObjectAttribute)
 sortKeyType ()
 supportsBatchInitializeObjectAttribute ()
 title ($contentObjectAttribute, $name=null)
 toString ($contentObjectAttribute)
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
 validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 validateDateTimeHTTPInput ($day, $month, $year, $hour, $minute, $second, $contentObjectAttribute)
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)

Public Attributes

const ADJUSTMENT_FIELD = 'data_text5'
const DATA_TYPE_STRING = 'ezdatetime'
const DEFAULT_ADJUSTMENT = 2
const DEFAULT_CURRENT_DATE = 1
const DEFAULT_EMTPY = 0
const DEFAULT_FIELD = 'data_int1'
const USE_SECONDS_FIELD = 'data_int2'

Detailed Description

Stores a date and time value.

Definition at line 18 of file ezdatetimetype.php.


Member Function Documentation

Reimplemented from eZDataType.

Definition at line 598 of file ezdatetimetype.php.

Returns the content data for the given content class attribute.

Reimplemented from eZDataType.

Definition at line 316 of file ezdatetimetype.php.

Referenced by batchInitializeObjectAttributeData(), and initializeObjectAttribute().

Definition at line 34 of file ezdatetimetype.php.

eZDateTimeType::fetchClassAttributeHTTPInput ( http,
base,
classAttribute 
)

Fetches the HTTP input for the content class attribute.

Note:
Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 400 of file ezdatetimetype.php.

eZDateTimeType::fetchCollectionAttributeHTTPInput ( collection,
collectionAttribute,
http,
base,
contentObjectAttribute 
)

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 219 of file ezdatetimetype.php.

eZDateTimeType::fetchObjectAttributeHTTPInput ( http,
base,
contentObjectAttribute 
)

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

Reimplemented from eZDataType.

Definition at line 127 of file ezdatetimetype.php.

eZDateTimeType::fromString ( contentObjectAttribute,
string 
)

Reimplemented from eZDataType.

Definition at line 294 of file ezdatetimetype.php.

eZDateTimeType::hasObjectAttributeContent ( contentObjectAttribute)
Returns:
true if the datatype finds any content in the attribute $contentObjectAttribute.

Reimplemented from eZDataType.

Definition at line 453 of file ezdatetimetype.php.

Set class attribute value for template version

Reimplemented from eZDataType.

Definition at line 302 of file ezdatetimetype.php.

eZDateTimeType::initializeObjectAttribute ( contentObjectAttribute,
currentVersion,
originalContentObjectAttribute 
)

Sets the default value.

Reimplemented from eZDataType.

Definition at line 372 of file ezdatetimetype.php.

Returns:
true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 268 of file ezdatetimetype.php.

Returns:
true if the datatype can be used as an information collector

Reimplemented from eZDataType.

Definition at line 273 of file ezdatetimetype.php.

eZDateTimeType::metaData ( contentObjectAttribute)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 281 of file ezdatetimetype.php.

eZDateTimeType::objectAttributeContent ( contentObjectAttribute)

Returns the content.

Reimplemented from eZDataType.

Definition at line 260 of file ezdatetimetype.php.

eZDateTimeType::parseXML ( xmlText)

Definition at line 309 of file ezdatetimetype.php.

Referenced by classAttributeContent().

eZDateTimeType::serializeContentClassAttribute ( classAttribute,
attributeNode,
attributeParametersNode 
)

Adds the necessary dom structure to the attribute parameters.

Note:
The default is to add unsupported='true' to the attribute node, meaning that the datatype does not support serializing.

Reimplemented from eZDataType.

Definition at line 468 of file ezdatetimetype.php.

eZDateTimeType::serializeContentObjectAttribute ( package,
objectAttribute 
)
Returns:
a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 567 of file ezdatetimetype.php.

eZDateTimeType::sortKey ( objectAttribute)
Returns:
the sort key for the datatype. This is used for sorting on attribute level.

Reimplemented from eZDataType.

Definition at line 458 of file ezdatetimetype.php.

Returns:
the type of the sort key int|string False is returned if sorting is not supported

Reimplemented from eZDataType.

Definition at line 463 of file ezdatetimetype.php.

Reimplemented from eZDataType.

Definition at line 593 of file ezdatetimetype.php.

eZDateTimeType::title ( contentObjectAttribute,
name = null 
)

Returns the date.

Reimplemented from eZDataType.

Definition at line 446 of file ezdatetimetype.php.

eZDateTimeType::toString ( contentObjectAttribute)
Returns:
string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 289 of file ezdatetimetype.php.

eZDateTimeType::unserializeContentClassAttribute ( classAttribute,
attributeNode,
attributeParametersNode 
)

Extracts values from the attribute parameters and sets it in the class attribute.

Note:
This function is called after the attribute has been stored and a second store is called after this function is done.

Reimplemented from eZDataType.

Definition at line 517 of file ezdatetimetype.php.

eZDateTimeType::unserializeContentObjectAttribute ( package,
objectAttribute,
attributeNode 
)

Unserialize contentobject attribute

Parameters:
package
objectAttributecontentobject attribute object
attributeNodeezdomnode object

Reimplemented from eZDataType.

Definition at line 583 of file ezdatetimetype.php.

eZDateTimeType::validateCollectionAttributeHTTPInput ( http,
base,
objectAttribute 
)

Validates the input for an object attribute and returns a validation state as defined in eZInputValidator.

Note:
Default implementation does nothing and returns accepted.

Reimplemented from eZDataType.

Definition at line 165 of file ezdatetimetype.php.

eZDateTimeType::validateDateTimeHTTPInput ( day,
month,
year,
hour,
minute,
second,
contentObjectAttribute 
)

Private method only for use inside this class

Definition at line 43 of file ezdatetimetype.php.

Referenced by validateCollectionAttributeHTTPInput(), and validateObjectAttributeHTTPInput().

eZDateTimeType::validateObjectAttributeHTTPInput ( http,
base,
contentObjectAttribute 
)

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

Reimplemented from eZDataType.

Definition at line 68 of file ezdatetimetype.php.


Member Data Documentation

const eZDateTimeType::ADJUSTMENT_FIELD = 'data_text5'

Definition at line 26 of file ezdatetimetype.php.

const eZDateTimeType::DATA_TYPE_STRING = 'ezdatetime'

Definition at line 20 of file ezdatetimetype.php.

Definition at line 32 of file ezdatetimetype.php.

Definition at line 30 of file ezdatetimetype.php.

Definition at line 28 of file ezdatetimetype.php.

const eZDateTimeType::DEFAULT_FIELD = 'data_int1'

Definition at line 22 of file ezdatetimetype.php.

const eZDateTimeType::USE_SECONDS_FIELD = 'data_int2'

Definition at line 24 of file ezdatetimetype.php.


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