eZTimeType Class Reference

Stores a time value. More...

Inheritance diagram for eZTimeType:

Collaboration diagram for eZTimeType:

List of all members.

Public Member Functions
	batchInitializeObjectAttributeData ($classAttribute)
	eZTimeType ()
	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)
	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)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	validateTimeHTTPInput ($hours, $minute, $second, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = "eztime"
const	DEFAULT_CURRENT_DATE = 1
const	DEFAULT_EMTPY = 0
const	DEFAULT_FIELD = 'data_int1'
const	USE_SECONDS_FIELD = 'data_int2'

---

Detailed Description

Stores a time value.

Definition at line 37 of file eztimetype.php.

---

Member Function Documentation

eZTimeType::batchInitializeObjectAttributeData

(

$

classAttribute

)

Reimplemented from eZDataType.

Definition at line 450 of file eztimetype.php.

eZTimeType::eZTimeType

(

)

Definition at line 45 of file eztimetype.php.

eZTimeType::fetchClassAttributeHTTPInput	(	$	http,
		$	base,
		$	classAttribute
	)

Fetches the HTTP input for the content class attribute.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 310 of file eztimetype.php.

eZTimeType::fetchCollectionAttributeHTTPInput	(	$	collection,
		$	collectionAttribute,
		$	http,
		$	base,
		$	contentObjectAttribute
	)

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 173 of file eztimetype.php.

eZTimeType::fetchObjectAttributeHTTPInput	(	$	http,
		$	base,
		$	objectAttribute
	)

Fetches the HTTP input for the content object attribute.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 108 of file eztimetype.php.

eZTimeType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 253 of file eztimetype.php.

eZTimeType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

true if the datatype finds any content in the attribute $contentObjectAttribute.

Reimplemented from eZDataType.

Definition at line 350 of file eztimetype.php.

eZTimeType::initializeClassAttribute

(

$

classAttribute

)

Set class attribute value for template version

Reimplemented from eZDataType.

Definition at line 280 of file eztimetype.php.

eZTimeType::initializeObjectAttribute	(	$	contentObjectAttribute,
		$	currentVersion,
		$	originalContentObjectAttribute
	)

Sets the default value.

Reimplemented from eZDataType.

Definition at line 290 of file eztimetype.php.

eZTimeType::isInformationCollector

(

)

Returns:

true if the datatype can be used as an information collector

Reimplemented from eZDataType.

Definition at line 272 of file eztimetype.php.

eZTimeType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 329 of file eztimetype.php.

eZTimeType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 202 of file eztimetype.php.

eZTimeType::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 355 of file eztimetype.php.

eZTimeType::serializeContentObjectAttribute	(	$	package,
		$	objectAttribute
	)

Parameters:

package
content	attribute

Returns:

a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 408 of file eztimetype.php.

eZTimeType::sortKey

(

$

objectAttribute

)

Returns:

the sort key for the datatype. This is used for sorting on attribute level.

Reimplemented from eZDataType.

Definition at line 221 of file eztimetype.php.

eZTimeType::sortKeyType

(

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 233 of file eztimetype.php.

eZTimeType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 445 of file eztimetype.php.

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

Returns the date.

Reimplemented from eZDataType.

Definition at line 337 of file eztimetype.php.

eZTimeType::toString

(

$

contentObjectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 242 of file eztimetype.php.

eZTimeType::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 379 of file eztimetype.php.

eZTimeType::unserializeContentObjectAttribute	(	$	package,
		$	objectAttribute,
		$	attributeNode
	)

Parameters:

package
contentobject	attribute object
ezdomnode	object

Reimplemented from eZDataType.

Definition at line 429 of file eztimetype.php.

eZTimeType::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 136 of file eztimetype.php.

eZTimeType::validateObjectAttributeHTTPInput	(	$	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 66 of file eztimetype.php.

eZTimeType::validateTimeHTTPInput	(	$	hours,
		$	minute,
		$	second,
		$	contentObjectAttribute
	)

Private method only for use inside this class

Definition at line 54 of file eztimetype.php.

Referenced by validateCollectionAttributeHTTPInput(), and validateObjectAttributeHTTPInput().

---

Member Data Documentation

const eZTimeType::DATA_TYPE_STRING = "eztime"

Definition at line 39 of file eztimetype.php.

const eZTimeType::DEFAULT_CURRENT_DATE = 1

Definition at line 43 of file eztimetype.php.

const eZTimeType::DEFAULT_EMTPY = 0

Definition at line 42 of file eztimetype.php.

const eZTimeType::DEFAULT_FIELD = 'data_int1'

Definition at line 40 of file eztimetype.php.

const eZTimeType::USE_SECONDS_FIELD = 'data_int2'

Definition at line 41 of file eztimetype.php.

---

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

• eztimetype.php