eZSelectionType Class Reference

Inheritance diagram for eZSelectionType:

Collaboration diagram for eZSelectionType:

List of all members.

Public Member Functions
	classAttributeContent ($classAttribute)
	eZSelectionType ()
	fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
	fetchCollectionAttributeHTTPInput ($collection, $collectionAttribute, $http, $base, $contentObjectAttribute)
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	fromString ($contentObjectAttribute, $string)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	isIndexable ()
	isInformationCollector ()
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	sortKey ($contentObjectAttribute)
	sortKeyType ()
	supportsBatchInitializeObjectAttribute ()
	title ($contentObjectAttribute, $name=null)
	toString ($contentObjectAttribute)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	validateClassAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = "ezselection"

---

Detailed Description

Definition at line 40 of file ezselectiontype.php.

---

Member Function Documentation

eZSelectionType::classAttributeContent

(

$

classAttribute

)

Returns the content data for the given content class attribute.

Reimplemented from eZDataType.

Definition at line 269 of file ezselectiontype.php.

Referenced by fetchClassAttributeHTTPInput(), fromString(), metaData(), title(), and toString().

eZSelectionType::eZSelectionType

(

)

Constructor

Definition at line 47 of file ezselectiontype.php.

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

Fetches all variables inputed on content class level

Returns:

true if fetching of class attributes are successfull, false if not

Reimplemented from eZDataType.

Definition at line 67 of file ezselectiontype.php.

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

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 232 of file ezselectiontype.php.

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

Fetches all variables from the object

Returns:

true if fetching of class attributes are successfull, false if not

Reimplemented from eZDataType.

Definition at line 195 of file ezselectiontype.php.

eZSelectionType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 351 of file ezselectiontype.php.

eZSelectionType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 394 of file ezselectiontype.php.

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

Sets the default value.

Reimplemented from eZDataType.

Definition at line 247 of file ezselectiontype.php.

eZSelectionType::isIndexable

(

)

Returns:

true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 412 of file ezselectiontype.php.

eZSelectionType::isInformationCollector

(

)

Returns:

true if the datatype can be used as an information collector

Reimplemented from eZDataType.

Definition at line 417 of file ezselectiontype.php.

eZSelectionType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 302 of file ezselectiontype.php.

eZSelectionType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the selected options by id.

Reimplemented from eZDataType.

Definition at line 260 of file ezselectiontype.php.

Referenced by metaData(), title(), and toString().

eZSelectionType::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 422 of file ezselectiontype.php.

eZSelectionType::sortKey

(

$

objectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 399 of file ezselectiontype.php.

eZSelectionType::sortKeyType

(

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 404 of file ezselectiontype.php.

eZSelectionType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 461 of file ezselectiontype.php.

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

Returns the value as it will be shown if this attribute is used in the object name pattern.

Reimplemented from eZDataType.

Definition at line 376 of file ezselectiontype.php.

eZSelectionType::toString

(

$

objectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 328 of file ezselectiontype.php.

eZSelectionType::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 441 of file ezselectiontype.php.

eZSelectionType::validateClassAttributeHTTPInput	(	$	http,
		$	base,
		$	contentObjectAttribute
	)

Validates all variables given on content class level

Returns:

eZInputValidator::STATE_ACCEPTED or eZInputValidator::STATE_INVALID if the values are accepted or not

Reimplemented from eZDataType.

Definition at line 58 of file ezselectiontype.php.

eZSelectionType::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 207 of file ezselectiontype.php.

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

Validates input on content object level

Returns:

eZInputValidator::STATE_ACCEPTED or eZInputValidator::STATE_INVALID if the values are accepted or not

Reimplemented from eZDataType.

Definition at line 164 of file ezselectiontype.php.

---

Member Data Documentation

const eZSelectionType::DATA_TYPE_STRING = "ezselection"

Definition at line 42 of file ezselectiontype.php.

---

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

• ezselectiontype.php