eZPublish  3.8
eZKeywordType Class Reference

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

+ Inheritance diagram for eZKeywordType:
+ Collaboration diagram for eZKeywordType:

Public Member Functions

 contentActionList (&$classAttribute)
 
 deleteStoredObjectAttribute (&$contentObjectAttribute, $version=null)
 
 eZKeywordType ()
 
 fetchClassAttributeHTTPInput (&$http, $base, &$attribute)
 
 fetchObjectAttributeHTTPInput (&$http, $base, &$contentObjectAttribute)
 
 fixupClassAttributeHTTPInput (&$http, $base, &$attribute)
 
 hasObjectAttributeContent (&$contentObjectAttribute)
 
 initializeObjectAttribute (&$contentObjectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 isIndexable ()
 
 metaData (&$attribute)
 
objectAttributeContent (&$attribute)
 
 serializeContentObjectAttribute (&$package, &$objectAttribute)
 
 storeClassAttribute (&$attribute, $version)
 
 storeDefinedClassAttribute (&$attribute)
 
 storeObjectAttribute (&$attribute)
 
 title (&$attribute)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput (&$http, $base, &$attribute)
 
 validateObjectAttributeHTTPInput (&$http, $base, &$contentObjectAttribute)
 
- Public Member Functions inherited from eZDataType
 allowedTypes ()
 
attribute ($attr)
 
 attributes ()
 
classAttributeContent (&$classAttribute)
 
 classAttributeRemovableInformation (&$classAttribute, $includeAll=true)
 
classDisplayInformation (&$classAttribute, $mergeInfo=false)
 
 cloneClassAttribute (&$oldClassAttribute, &$newClassAttribute)
 
 contentActionList (&$classAttribute)
 
 createContentObjectAttributeDOMNode ($objectAttribute)
 Create empty content object attribute DOM node. More...
 
 customClassAttributeHTTPAction (&$http, $action, &$classAttribute)
 
 customObjectAttributeHTTPAction (&$http, $action, &$objectAttribute)
 
 customSorting ()
 
 customSortingSQL ($params)
 
 deleteStoredClassAttribute (&$classAttribute, $version=null)
 
 deleteStoredObjectAttribute (&$objectAttribute, $version=null)
 
 diff ($old, $new, $options=false)
 
editTemplate (&$contentobjectAttribute)
 
 eZDataType ($dataTypeString, $name, $properties=array())
 
 fetchActionValue ($action, $actionName, &$value)
 
 fetchClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fetchCollectionAttributeHTTPInput (&$collection, &$collectionAttribute, &$http, $base, &$objectAttribute)
 
 fetchObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 fixRelatedObjectItem (&$contentObjectAttribute, $objectID, $mode)
 
 fixupClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fixupCollectionAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 fixupObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 handleCustomObjectHTTPActions (&$http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 handleDownload (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 hasAttribute ($attr)
 
 hasInformationCollection ()
 
 hasObjectAttributeContent (&$contentObjectAttribute)
 
 hasStoredFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
informationTemplate (&$contentobjectAttribute)
 
 initializeClassAttribute (&$classAttribute)
 
 initializeObjectAttribute (&$objectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 insertHTTPFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, &$httpFile, $mimeData, &$result)
 
 insertRegularFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, $filePath, &$result)
 
 insertSimpleString (&$object, $objectVersion, $objectLanguage, &$objectAttribute, $string, &$result)
 
 isA ()
 
 isClassAttributeRemovable (&$classAttribute)
 
 isHTTPFileInsertionSupported ()
 
 isIndexable ()
 
 isInformationCollector ()
 
 isRegularFileInsertionSupported ()
 
 isSimpleStringInsertionSupported ()
 
 loadAndRegisterAllTypes ()
 
 loadAndRegisterType ($type)
 
 metaData ()
 
objectAttributeContent (&$objectAttribute)
 
 objectDisplayInformation (&$objectAttribute, $mergeInfo=false)
 
 onPublish (&$contentObjectAttribute, &$contentObject, &$publishedNodes)
 
 postInitializeObjectAttribute (&$objectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 postStore (&$objectAttribute)
 
 postUnserializeContentObjectAttribute (&$package, &$objectAttribute)
 
 preStoreClassAttribute (&$classAttribute, $version)
 
 preStoreDefinedClassAttribute (&$classAttribute)
 
 productOptionInformation (&$objectAttribute, $optionID, &$productItem)
 
 removeRelatedObjectItem (&$contentObjectAttribute, $objectID)
 
 repairContentObjectAttribute (&$contentObjectAttribute)
 
resultTemplate (&$collectionAttribute)
 
 serializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 serializeContentObjectAttribute (&$package, &$objectAttribute)
 
 sortKey (&$objectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute (&$classAttribute, $version)
 
 storeDefinedClassAttribute (&$classAttribute)
 
 storedFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 storeObjectAttribute (&$objectAttribute)
 
 templateList ()
 
 title (&$objectAttribute, $name=null)
 
 unserializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 validateCollectionAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 validateObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
viewTemplate (&$contentobjectAttribute)
 

Additional Inherited Members

- Static Public Member Functions inherited from eZDataType
 create ($dataTypeString)
 
 register ($dataTypeString, $className)
 
registeredDataTypes ()
 

Detailed Description

A content datatype which handles keyword indexes.

Member Function Documentation

eZKeywordType::contentActionList ( $classAttribute)

the collect information action if enabled

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

Delete stored object attribute

eZKeywordType::eZKeywordType ( )

Initializes with a keyword id and a description.

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

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

eZKeywordType::fixupClassAttributeHTTPInput ( $http,
  $base,
$attribute 
)
eZKeywordType::hasObjectAttributeContent ( $contentObjectAttribute)
eZKeywordType::initializeObjectAttribute ( $contentObjectAttribute,
  $currentVersion,
$originalContentObjectAttribute 
)

Sets the default value.

eZKeywordType::isIndexable ( )
eZKeywordType::metaData ( $attribute)

Returns the meta data used for storing search indeces.

& eZKeywordType::objectAttributeContent ( $attribute)

Returns the content.

eZKeywordType::serializeContentObjectAttribute ( $package,
$objectAttribute 
)
Parameters
package
contentattribute
Returns
a DOM representation of the content object attribute
eZKeywordType::storeClassAttribute ( $attribute,
  $version 
)
eZKeywordType::storeDefinedClassAttribute ( $attribute)
eZKeywordType::storeObjectAttribute ( $attribute)

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

eZKeywordType::title ( $attribute)

Returns the content of the keyword for use as a title

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

Unserailize contentobject attribute

Parameters
package
contentobjectattribute object
ezdomnodeobject
eZKeywordType::validateClassAttributeHTTPInput ( $http,
  $base,
$attribute 
)
eZKeywordType::validateObjectAttributeHTTPInput ( $http,
  $base,
$contentObjectAttribute 
)

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


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