eZ Publish  [trunk]
eZDateType Class Reference

Stores a date value. More...

+ Inheritance diagram for eZDateType:
+ Collaboration diagram for eZDateType:

List of all members.

Public Member Functions

 batchInitializeObjectAttributeData ($classAttribute)
 eZDateType ()
 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)
 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, $contentObjectAttribute)
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)

Public Attributes

const DATA_TYPE_STRING = "ezdate"
const DEFAULT_CURRENT_DATE = 1
const DEFAULT_EMTPY = 0
const DEFAULT_FIELD = 'data_int1'

Detailed Description

Stores a date value.

Definition at line 18 of file ezdatetype.php.


Member Function Documentation

Reimplemented from eZDataType.

Definition at line 362 of file ezdatetype.php.

Definition at line 28 of file ezdatetype.php.

eZDateType::fetchClassAttributeHTTPInput ( http,
base,
classAttribute 
)

Fetches the HTTP input for the content class attribute.

Note:
Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 227 of file ezdatetype.php.

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

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 157 of file ezdatetype.php.

eZDateType::fetchObjectAttributeHTTPInput ( http,
base,
contentObjectAttribute 
)

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

Reimplemented from eZDataType.

Definition at line 92 of file ezdatetype.php.

eZDateType::fromString ( contentObjectAttribute,
string 
)

Reimplemented from eZDataType.

Definition at line 265 of file ezdatetype.php.

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

Reimplemented from eZDataType.

Definition at line 280 of file ezdatetype.php.

eZDateType::initializeClassAttribute ( classAttribute)

Set class attribute value for template version

Reimplemented from eZDataType.

Definition at line 201 of file ezdatetype.php.

eZDateType::initializeObjectAttribute ( contentObjectAttribute,
currentVersion,
originalContentObjectAttribute 
)

Sets the default value.

Reimplemented from eZDataType.

Definition at line 211 of file ezdatetype.php.

Returns:
true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 238 of file ezdatetype.php.

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

Reimplemented from eZDataType.

Definition at line 243 of file ezdatetype.php.

eZDateType::metaData ( contentObjectAttribute)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 251 of file ezdatetype.php.

eZDateType::objectAttributeContent ( contentObjectAttribute)

Returns the content.

Reimplemented from eZDataType.

Definition at line 190 of file ezdatetype.php.

eZDateType::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 295 of file ezdatetype.php.

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

Reimplemented from eZDataType.

Definition at line 331 of file ezdatetype.php.

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

Reimplemented from eZDataType.

Definition at line 285 of file ezdatetype.php.

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

Reimplemented from eZDataType.

Definition at line 290 of file ezdatetype.php.

Reimplemented from eZDataType.

Definition at line 357 of file ezdatetype.php.

eZDateType::title ( contentObjectAttribute,
name = null 
)

Returns the date.

Reimplemented from eZDataType.

Definition at line 273 of file ezdatetype.php.

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

Reimplemented from eZDataType.

Definition at line 260 of file ezdatetype.php.

eZDateType::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 314 of file ezdatetype.php.

eZDateType::unserializeContentObjectAttribute ( package,
objectAttribute,
attributeNode 
)

Unserialize contentobject attribute

Parameters:
package
objectAttributecontentobject attribute object
attributeNodeezdomnode object

Reimplemented from eZDataType.

Definition at line 347 of file ezdatetype.php.

eZDateType::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 122 of file ezdatetype.php.

eZDateType::validateDateTimeHTTPInput ( day,
month,
year,
contentObjectAttribute 
)
eZDateType::validateObjectAttributeHTTPInput ( http,
base,
contentObjectAttribute 
)

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

Reimplemented from eZDataType.

Definition at line 50 of file ezdatetype.php.


Member Data Documentation

const eZDateType::DATA_TYPE_STRING = "ezdate"

Definition at line 20 of file ezdatetype.php.

Definition at line 26 of file ezdatetype.php.

Definition at line 24 of file ezdatetype.php.

const eZDateType::DEFAULT_FIELD = 'data_int1'

Definition at line 22 of file ezdatetype.php.


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