eZ Publish  [trunk]
Public Member Functions | Public Attributes
eZKeyword Class Reference

A content datatype which handles keyword index instances. More...

List of all members.

Public Member Functions

 attribute ($name)
 attributes ()
 eZKeyword ()
 fetch (&$attribute)
 hasAttribute ($name)
 initializeKeyword ($keywordString)
 keywordArray ()
 keywordString ()
 relatedObjects ()
 setKeywordArray ($keywords)
 store ($attribute)

Public Attributes

 $KeywordArray = array()
 Contains the keywords.
 $ObjectAttributeID = false
 Contains the ID attribute if fetched.

Detailed Description

A content datatype which handles keyword index instances.

Definition at line 18 of file ezkeyword.php.

Member Function Documentation

eZKeyword::attribute ( $  name)

Definition at line 40 of file ezkeyword.php.

eZKeyword::attributes ( )

Definition at line 27 of file ezkeyword.php.

Referenced by hasAttribute().

eZKeyword::eZKeyword ( )

Construct a new keyword instance

Definition at line 23 of file ezkeyword.php.

eZKeyword::fetch ( &$  attribute)

Fetches the keywords for the given attribute.

Definition at line 236 of file ezkeyword.php.

eZKeyword::hasAttribute ( $  name)

Definition at line 35 of file ezkeyword.php.

eZKeyword::initializeKeyword ( $  keywordString)

Initialze the keyword index

Definition at line 70 of file ezkeyword.php.

eZKeyword::keywordArray ( )

Returns the keyword index

Definition at line 265 of file ezkeyword.php.

eZKeyword::keywordString ( )

Returns the keywords as a string

Definition at line 273 of file ezkeyword.php.

Referenced by attribute().

eZKeyword::relatedObjects ( )

Returns the objects which have at least one keyword in common

Returns:
an array of eZContentObjectTreeNode instances, or null if the attribute is not stored yet

Definition at line 283 of file ezkeyword.php.

Referenced by attribute().

eZKeyword::setKeywordArray ( $  keywords)

Sets the keyword index

Definition at line 257 of file ezkeyword.php.

eZKeyword::store ( $  attribute)

Stores the keyword index to database

Definition at line 89 of file ezkeyword.php.

Member Data Documentation

eZKeyword::$KeywordArray = array()

Contains the keywords.

Definition at line 337 of file ezkeyword.php.

eZKeyword::$ObjectAttributeID = false

Contains the ID attribute if fetched.

Definition at line 340 of file ezkeyword.php.

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