eZKeywordType Class Reference

A content datatype which handles keyword indexes. More...

Inheritance diagram for eZKeywordType:

Collaboration diagram for eZKeywordType:

List of all members.

Public Member Functions
	contentActionList ($classAttribute)
	deleteStoredObjectAttribute ($contentObjectAttribute, $version=null)
	eZKeywordType ()
	fetchClassAttributeHTTPInput ($http, $base, $attribute)
	fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
	fixupClassAttributeHTTPInput ($http, $base, $attribute)
	fromString ($contentObjectAttribute, $string)
	hasObjectAttributeContent ($contentObjectAttribute)
	initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
	isIndexable ()
	metaData ($attribute)
	objectAttributeContent ($attribute)
	serializeContentObjectAttribute ($package, $objectAttribute)
	storeClassAttribute ($attribute, $version)
	storeDefinedClassAttribute ($attribute)
	storeObjectAttribute ($attribute)
	supportsBatchInitializeObjectAttribute ()
	title ($attribute, $name=null)
	toString ($contentObjectAttribute)
	unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
	validateClassAttributeHTTPInput ($http, $base, $attribute)
	validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
Public Attributes
const	DATA_TYPE_STRING = 'ezkeyword'

---

Detailed Description

A content datatype which handles keyword indexes.

Definition at line 40 of file ezkeywordtype.php.

---

Member Function Documentation

eZKeywordType::contentActionList

(

$

classAttribute

)

Returns:

the collect information action if enabled

Reimplemented from eZDataType.

Definition at line 184 of file ezkeywordtype.php.

eZKeywordType::deleteStoredObjectAttribute	(	$	contentObjectAttribute,
		$	version = null
	)

Delete stored object attribute

Reimplemented from eZDataType.

Definition at line 192 of file ezkeywordtype.php.

eZKeywordType::eZKeywordType

(

)

Initializes with a keyword id and a description.

Definition at line 47 of file ezkeywordtype.php.

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

Fetches the HTTP input for the content class attribute.

Note:

Default implementation does nothing.

Reimplemented from eZDataType.

Definition at line 153 of file ezkeywordtype.php.

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

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

Reimplemented from eZDataType.

Definition at line 109 of file ezkeywordtype.php.

eZKeywordType::fixupClassAttributeHTTPInput	(	$	http,
		$	base,
		$	classAttribute
	)

Tries to do a fixup on the input text so that it's acceptable as class attribute input.

Note:

Default implementation does nothing and returns accepted.

Reimplemented from eZDataType.

Definition at line 149 of file ezkeywordtype.php.

eZKeywordType::fromString	(	$	contentObjectAttribute,
		$	string
	)

Reimplemented from eZDataType.

Definition at line 277 of file ezkeywordtype.php.

eZKeywordType::hasObjectAttributeContent

(

$

contentObjectAttribute

)

Returns:

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

Reimplemented from eZDataType.

Definition at line 252 of file ezkeywordtype.php.

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

Sets the default value.

Reimplemented from eZDataType.

Definition at line 56 of file ezkeywordtype.php.

eZKeywordType::isIndexable

(

)

Returns:

true if the datatype can be indexed

Reimplemented from eZDataType.

Definition at line 261 of file ezkeywordtype.php.

eZKeywordType::metaData

(

$

attribute

)

Returns the meta data used for storing search indeces.

Reimplemented from eZDataType.

Definition at line 172 of file ezkeywordtype.php.

eZKeywordType::objectAttributeContent

(

$

attribute

)

Returns the content.

Reimplemented from eZDataType.

Definition at line 161 of file ezkeywordtype.php.

eZKeywordType::serializeContentObjectAttribute	(	$	package,
		$	objectAttribute
	)

Parameters:

package
objectAttribute	content attribute

Returns:

a DOM representation of the content object attribute

Reimplemented from eZDataType.

Definition at line 288 of file ezkeywordtype.php.

eZKeywordType::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 136 of file ezkeywordtype.php.

eZKeywordType::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.

Reimplemented from eZDataType.

Definition at line 140 of file ezkeywordtype.php.

eZKeywordType::storeObjectAttribute

(

$

attribute

)

Does nothing since it uses the data_text field in the content object attribute. See fetchObjectAttributeHTTPInput for the actual storing.

Reimplemented from eZDataType.

Definition at line 126 of file ezkeywordtype.php.

eZKeywordType::supportsBatchInitializeObjectAttribute

(

)

Reimplemented from eZDataType.

Definition at line 311 of file ezkeywordtype.php.

eZKeywordType::title	(	$	attribute,
		$	name = null
	)

Returns the content of the keyword for use as a title

Reimplemented from eZDataType.

Definition at line 243 of file ezkeywordtype.php.

eZKeywordType::toString

(

$

contentObjectAttribute

)

Returns:

string representation of an contentobjectattribute data for simplified export

Reimplemented from eZDataType.

Definition at line 270 of file ezkeywordtype.php.

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

Unserialize contentobject attribute

Parameters:

package
objectAttribute	contentobject attribute object
attributeNode	ezdomnode object

Reimplemented from eZDataType.

Definition at line 303 of file ezkeywordtype.php.

eZKeywordType::validateClassAttributeHTTPInput	(	$	http,
		$	base,
		$	classAttribute
	)

Validates the input for a class attribute and returns a validation state as defined in eZInputValidator.

Note:

Default implementation does nothing and returns accepted.

Reimplemented from eZDataType.

Definition at line 144 of file ezkeywordtype.php.

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

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

Reimplemented from eZDataType.

Definition at line 80 of file ezkeywordtype.php.

---

Member Data Documentation

const eZKeywordType::DATA_TYPE_STRING = 'ezkeyword'

Definition at line 42 of file ezkeywordtype.php.

---

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

• ezkeywordtype.php