eZOptionType Class Reference

Stores option values. More...

Inheritance diagram for eZOptionType:

Collaboration diagram for eZOptionType:

List of all members.

Public Member Functions
	batchInitializeObjectAttributeData ($classAttribute)
	customObjectAttributeHTTPAction ($http, $action, $contentObjectAttribute, $parameters)
	eZOptionType ()
	fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
	fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	fromString ($contentObjectAttribute, $string)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	isInformationCollector ()
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	productOptionInformation ($objectAttribute, $optionID, $productItem)
	serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	serializeContentObjectAttribute ($package, $objectAttribute)
	storeObjectAttribute ($contentObjectAttribute)
	supportsBatchInitializeObjectAttribute ()
	title ($contentObjectAttribute, $name="name")
	toString ($contentObjectAttribute)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
	validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = "ezoption"
const	DEFAULT_NAME_VARIABLE = "_ezoption_default_name_"

---

Detailed Description

Stores option values.

Definition at line 18 of file ezoptiontype.php.

---

Member Function Documentation

eZOptionType::batchInitializeObjectAttributeData

(

$

classAttribute

)

Reimplemented from eZDataType.

Definition at line 437 of file ezoptiontype.php.

eZOptionType::customObjectAttributeHTTPAction	(	$	http,
		$	action,
		$	objectAttribute,
		$	parameters
	)

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

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 197 of file ezoptiontype.php.

eZOptionType::eZOptionType

(

)

Definition at line 24 of file ezoptiontype.php.

eZOptionType::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 ezoptiontype.php.

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

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 183 of file ezoptiontype.php.

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

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

Reimplemented from eZDataType.

Definition at line 150 of file ezoptiontype.php.

eZOptionType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 345 of file ezoptiontype.php.

eZOptionType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 276 of file ezoptiontype.php.

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

Sets the default value.

Reimplemented from eZDataType.

Definition at line 286 of file ezoptiontype.php.

eZOptionType::isInformationCollector

(

)

Returns:

true if the datatype can be used as an information collector

Reimplemented from eZDataType.

Definition at line 427 of file ezoptiontype.php.

eZOptionType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 142 of file ezoptiontype.php.

eZOptionType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 130 of file ezoptiontype.php.

eZOptionType::productOptionInformation	(	$	objectAttribute,
		$	optionID,
		$	productItem
	)

Finds the option which has the ID that matches $optionID, if found it returns an option structure.

Reimplemented from eZDataType.

Definition at line 248 of file ezoptiontype.php.

eZOptionType::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 371 of file ezoptiontype.php.

eZOptionType::serializeContentObjectAttribute	(	$	package,
		$	objectAttribute
	)

Parameters:

package
objectAttribute	content attribute

Returns:

a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 386 of file ezoptiontype.php.

eZOptionType::storeObjectAttribute

(

$

contentObjectAttribute

)

Store content

Reimplemented from eZDataType.

Definition at line 121 of file ezoptiontype.php.

eZOptionType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 432 of file ezoptiontype.php.

eZOptionType::title	(	$	contentObjectAttribute,
		$	name = "name"
	)

Returns the integer value.

Reimplemented from eZDataType.

Definition at line 267 of file ezoptiontype.php.

eZOptionType::toString

(

$

objectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 327 of file ezoptiontype.php.

eZOptionType::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 380 of file ezoptiontype.php.

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

Unserialize contentobject attribute

Parameters:

package
objectAttribute	contentobject attribute object
attributeNode	ezdomnode object

Reimplemented from eZDataType.

Definition at line 399 of file ezoptiontype.php.

eZOptionType::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 30 of file ezoptiontype.php.

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

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

Reimplemented from eZDataType.

Definition at line 56 of file ezoptiontype.php.

---

Member Data Documentation

const eZOptionType::DATA_TYPE_STRING = "ezoption"

Definition at line 22 of file ezoptiontype.php.

const eZOptionType::DEFAULT_NAME_VARIABLE = "_ezoption_default_name_"

Definition at line 20 of file ezoptiontype.php.

---

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

• ezoptiontype.php