eZBooleanType Class Reference

Stores a boolean value. More...

Inheritance diagram for eZBooleanType:

Collaboration diagram for eZBooleanType:

List of all members.

Public Member Functions
	batchInitializeObjectAttributeData ($classAttribute)
	eZBooleanType ()
	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 ()
	storeObjectAttribute ($attribute)
	supportsBatchInitializeObjectAttribute ()
	title ($contentObjectAttribute, $name=null)
	toString ($contentObjectAttribute)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = "ezboolean"

---

Detailed Description

Stores a boolean value.

Definition at line 38 of file ezbooleantype.php.

---

Member Function Documentation

eZBooleanType::batchInitializeObjectAttributeData

(

$

classAttribute

)

Reimplemented from eZDataType.

Definition at line 260 of file ezbooleantype.php.

eZBooleanType::eZBooleanType

(

)

Definition at line 42 of file ezbooleantype.php.

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

Fetches the HTTP input for the content class attribute.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 161 of file ezbooleantype.php.

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

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 143 of file ezbooleantype.php.

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

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

Reimplemented from eZDataType.

Definition at line 122 of file ezbooleantype.php.

eZBooleanType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 193 of file ezbooleantype.php.

eZBooleanType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 234 of file ezbooleantype.php.

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

Sets the default value.

Reimplemented from eZDataType.

Definition at line 60 of file ezbooleantype.php.

eZBooleanType::isIndexable

(

)

Returns:

true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 198 of file ezbooleantype.php.

eZBooleanType::isInformationCollector

(

)

Returns:

true if the datatype can be used as an information collector

Reimplemented from eZDataType.

Definition at line 203 of file ezbooleantype.php.

eZBooleanType::metaData

(

$

contentObjectAttribute

)

Returns:

the text which should be indexed in the search engine. An associative array can be returned to enable searching in specific parts of the data. E.g. array( 'first_column' => "foo", 'second_column' => "bar" );

Reimplemented from eZDataType.

Definition at line 180 of file ezbooleantype.php.

eZBooleanType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 221 of file ezbooleantype.php.

eZBooleanType::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 239 of file ezbooleantype.php.

eZBooleanType::sortKey

(

$

objectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 208 of file ezbooleantype.php.

eZBooleanType::sortKeyType

(

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 213 of file ezbooleantype.php.

eZBooleanType::storeObjectAttribute

(

$

attribute

)

Store content

Reimplemented from eZDataType.

Definition at line 52 of file ezbooleantype.php.

eZBooleanType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 255 of file ezbooleantype.php.

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

Returns the integer value.

Reimplemented from eZDataType.

Definition at line 229 of file ezbooleantype.php.

eZBooleanType::toString

(

$

contentObjectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 188 of file ezbooleantype.php.

eZBooleanType::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 248 of file ezbooleantype.php.

eZBooleanType::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 100 of file ezbooleantype.php.

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

Validates the http post var boolean input.

Reimplemented from eZDataType.

Definition at line 78 of file ezbooleantype.php.

---

Member Data Documentation

const eZBooleanType::DATA_TYPE_STRING = "ezboolean"

Definition at line 40 of file ezbooleantype.php.

---

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

• ezbooleantype.php