Inheritance diagram for eZEnumType:

Collaboration diagram for eZEnumType:

Public Member Functions
	classAttributeContent ($contentClassAttribute)
	cloneClassAttribute ($oldClassAttribute, $newClassAttribute)
	customClassAttributeHTTPAction ($http, $action, $contentClassAttribute)
	deleteStoredClassAttribute ($contentClassAttribute, $version=null)
	deleteStoredObjectAttribute ($contentObjectAttribute, $version=null)
	diff ($old, $new, $options=false)
	eZEnumType ()
	fetchClassAttributeHTTPInput ($http, $base, $contentClassAttribute)
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeClassAttribute ($classAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	isIndexable ()
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	objectDisplayInformation ($objectAttribute, $mergeInfo=false)
	serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	serializeContentObjectAttribute ($package, $contentObjectAttribute)
	storeClassAttribute ($contentClassAttribute, $version)
	storeDefinedClassAttribute ($contentClassAttribute)
	storeModifiedClassAttribute ($contentClassAttribute)
	storeObjectAttribute ($contentObjectAttribute)
	title ($contentObjectAttribute, $name=null)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
	validateClassAttributeHTTPInput ($http, $base, $contentClassAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = 'ezenum'
const	IS_MULTIPLE_FIELD = 'data_int1'
const	IS_MULTIPLE_VARIABLE = '_ezenum_ismultiple_value_'
const	IS_OPTION_FIELD = 'data_int2'
const	IS_OPTION_VARIABLE = '_ezenum_isoption_value_'

Detailed Description

Definition at line 17 of file ezenumtype.php.

Member Function Documentation

eZEnumType::classAttributeContent ( $ contentClassAttribute )

Returns the content.

Reimplemented from eZDataType.

Definition at line 293 of file ezenumtype.php.

eZEnumType::cloneClassAttribute	(	$	oldClassAttribute,
		$	newClassAttribute
	)

Clones the date from the old class attribute to the new one.

Note:: Default implementation does nothing which is good enough for datatypes which does not use external tables.

Reimplemented from eZDataType.

Definition at line 66 of file ezenumtype.php.

eZEnumType::customClassAttributeHTTPAction	(	$	http,
		$	action,
		$	classAttribute
	)

Executes a custom action for a class attribute which was defined on the web page.

Note:: Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 301 of file ezenumtype.php.

eZEnumType::deleteStoredClassAttribute	(	$	contentClassAttribute,
		$	version = `null`
	)

Delete stored class attribute

Reimplemented from eZDataType.

Definition at line 120 of file ezenumtype.php.

eZEnumType::deleteStoredObjectAttribute	(	$	contentObjectAttribute,
		$	version = `null`
	)

Delete stored object attribute

Reimplemented from eZDataType.

Definition at line 110 of file ezenumtype.php.

Referenced by initializeObjectAttribute().

eZEnumType::diff	(	$	old,
		$	new,
		$	options = `false`
	)

Method used by content diff system to retrieve changes in attributes. This method implements the default behaviour, which is to show old and new version values of the object.

Reimplemented from eZDataType.

Definition at line 512 of file ezenumtype.php.

eZEnumType::eZEnumType ( )

Constructor

Definition at line 28 of file ezenumtype.php.

eZEnumType::fetchClassAttributeHTTPInput	(	$	http,
		$	base,
		$	contentClassAttribute
	)

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

Reimplemented from eZDataType.

Definition at line 242 of file ezenumtype.php.

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

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

Reimplemented from eZDataType.

Definition at line 130 of file ezenumtype.php.

eZEnumType::hasObjectAttributeContent ( $ contentObjectAttribute )

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

Reimplemented from eZDataType.

Definition at line 459 of file ezenumtype.php.

eZEnumType::initializeClassAttribute ( $ classAttribute )

Set class attribute value for template version

Reimplemented from eZDataType.

Definition at line 88 of file ezenumtype.php.

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

Sets value according to current version

Reimplemented from eZDataType.

Definition at line 37 of file ezenumtype.php.

eZEnumType::isIndexable ( )

Returns:: true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 392 of file ezenumtype.php.

eZEnumType::metaData ( $ contentObjectAttribute )

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 354 of file ezenumtype.php.

eZEnumType::objectAttributeContent ( $ contentObjectAttribute )

Returns actual the class attribute content.

Reimplemented from eZDataType.

Definition at line 214 of file ezenumtype.php.

Referenced by title().

eZEnumType::objectDisplayInformation	(	$	objectAttribute,
		$	mergeInfo = `false`
	)

Sets grouped_input to true when checkboxes or radiobuttons are used.

Reimplemented from eZDataType.

Definition at line 381 of file ezenumtype.php.

eZEnumType::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 464 of file ezenumtype.php.

eZEnumType::serializeContentObjectAttribute	(	$	package,
		$	contentObjectAttribute
	)

Returns:: a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 401 of file ezenumtype.php.

eZEnumType::storeClassAttribute	(	$	classAttribute,
		$	version
	)

Stores the datatype data to the database which is related to the class attribute. The $version parameter determines which version is currently being stored, 0 is the real version while 1 is the temporary version.

Returns:: True if the value was stored correctly.

Note:: The method is entirely up to the datatype, for instance it could reuse the available types in the the attribute or store in a separate object.; This function is called after the attribute data has been stored. If you need to alter attribute data use preStoreClassAttribute instead.

See also:: fetchClassAttributeHTTPInput

Reimplemented from eZDataType.

Definition at line 275 of file ezenumtype.php.

eZEnumType::storeDefinedClassAttribute ( $ classAttribute )

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Parameters:

eZContentClassAttribute $classAttribute Content class attribute of the datatype

Reimplemented from eZDataType.

Definition at line 280 of file ezenumtype.php.

eZEnumType::storeModifiedClassAttribute ( $ classAttribute )

Note:: Transaction unsafe. If you call several transaction unsafe methods you must enclose the calls within a db transaction; thus within db->begin and db->commit.

Parameters:

eZContentClassAttribute $classAttribute Content class attribute of the datatype

Reimplemented from eZDataType.

Definition at line 285 of file ezenumtype.php.

eZEnumType::storeObjectAttribute ( $ contentObjectAttribute )

Does nothing since it has been stored. See fetchObjectAttributeHTTPInput for the actual storing.

Reimplemented from eZDataType.

Definition at line 207 of file ezenumtype.php.

eZEnumType::title	(	$	contentObjectAttribute,
		$	name = `null`
	)

Returns the object attribute title.

Reimplemented from eZDataType.

Definition at line 333 of file ezenumtype.php.

eZEnumType::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 485 of file ezenumtype.php.

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

Unserialize contentobject attribute

Parameters:

package
contentobject	attribute object
ezdomnode	object

Reimplemented from eZDataType.

Definition at line 431 of file ezenumtype.php.

eZEnumType::validateClassAttributeHTTPInput	(	$	http,
		$	base,
		$	contentClassAttribute
	)

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

Reimplemented from eZDataType.

Definition at line 234 of file ezenumtype.php.

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

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

Reimplemented from eZDataType.

Definition at line 183 of file ezenumtype.php.

Member Data Documentation

const eZEnumType::DATA_TYPE_STRING = 'ezenum'

Definition at line 19 of file ezenumtype.php.

const eZEnumType::IS_MULTIPLE_FIELD = 'data_int1'

Definition at line 20 of file ezenumtype.php.

const eZEnumType::IS_MULTIPLE_VARIABLE = '_ezenum_ismultiple_value_'

Definition at line 21 of file ezenumtype.php.

const eZEnumType::IS_OPTION_FIELD = 'data_int2'

Definition at line 22 of file ezenumtype.php.

const eZEnumType::IS_OPTION_VARIABLE = '_ezenum_isoption_value_'

Definition at line 23 of file ezenumtype.php.

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

ezenumtype.php

Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation