eZTextType Class Reference

Stores a text area value. More...

Inheritance diagram for eZTextType:

Collaboration diagram for eZTextType:

List of all members.

Public Member Functions
	diff ($old, $new, $options=false)
	eZTextType ()
	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)
	insertSimpleString ($object, $objectVersion, $objectLanguage, $objectAttribute, $string, &$result)
	isIndexable ()
	isInformationCollector ()
	isSimpleStringInsertionSupported ()
	metaData ($contentObjectAttribute)
	objectAttributeContent ($contentObjectAttribute)
	serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	storeObjectAttribute ($attribute)
	supportsBatchInitializeObjectAttribute ()
	title ($data_instance, $name=null)
	toString ($contentObjectAttribute)
	unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
	validateCollectionAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	COLS_FIELD = 'data_int1'
const	COLS_VARIABLE = '_eztext_cols_'
const	DATA_TYPE_STRING = "eztext"

---

Detailed Description

Stores a text area value.

Definition at line 38 of file eztexttype.php.

---

Member Function Documentation

eZTextType::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 270 of file eztexttype.php.

eZTextType::eZTextType

(

)

Definition at line 44 of file eztexttype.php.

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

Fetches the HTTP input for the content class attribute.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 197 of file eztexttype.php.

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

Fetches the http post variables for collected information

Reimplemented from eZDataType.

Definition at line 149 of file eztexttype.php.

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

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

Reimplemented from eZDataType.

Definition at line 135 of file eztexttype.php.

eZTextType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 226 of file eztexttype.php.

eZTextType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 231 of file eztexttype.php.

eZTextType::initializeClassAttribute

(

$

classAttribute

)

Set class attribute value for template version

Reimplemented from eZDataType.

Definition at line 54 of file eztexttype.php.

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

Sets the default value.

Reimplemented from eZDataType.

Definition at line 64 of file eztexttype.php.

eZTextType::insertSimpleString	(	$	object,
		$	objectVersion,
		$	objectLanguage,
		$	objectAttribute,
		$	string,
		&$	result
	)

Inserts the string $string in the 'data_text' database field.

Reimplemented from eZDataType.

Definition at line 178 of file eztexttype.php.

eZTextType::isIndexable

(

)

Returns:

true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 244 of file eztexttype.php.

eZTextType::isInformationCollector

(

)

Returns:

true if the datatype can be used as an information collector

Reimplemented from eZDataType.

Definition at line 249 of file eztexttype.php.

eZTextType::isSimpleStringInsertionSupported

(

)

Simple string insertion is supported.

Reimplemented from eZDataType.

Definition at line 170 of file eztexttype.php.

eZTextType::metaData

(

$

contentObjectAttribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 212 of file eztexttype.php.

eZTextType::objectAttributeContent

(

$

contentObjectAttribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 192 of file eztexttype.php.

eZTextType::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 254 of file eztexttype.php.

eZTextType::storeObjectAttribute

(

$

attribute

)

Store the content.

Reimplemented from eZDataType.

Definition at line 163 of file eztexttype.php.

eZTextType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 279 of file eztexttype.php.

eZTextType::title	(	$	data_instance,
		$	name = null
	)

Returns the text.

Reimplemented from eZDataType.

Definition at line 239 of file eztexttype.php.

eZTextType::toString

(

$

contentObjectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 221 of file eztexttype.php.

eZTextType::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 264 of file eztexttype.php.

eZTextType::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 110 of file eztexttype.php.

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

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

Reimplemented from eZDataType.

Definition at line 83 of file eztexttype.php.

---

Member Data Documentation

const eZTextType::COLS_FIELD = 'data_int1'

Definition at line 41 of file eztexttype.php.

const eZTextType::COLS_VARIABLE = '_eztext_cols_'

Definition at line 42 of file eztexttype.php.

const eZTextType::DATA_TYPE_STRING = "eztext"

Definition at line 40 of file eztexttype.php.

---

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

• eztexttype.php