eZPublishCommunityProject(LegacyStack)  2013.9
eZObjectRelationType Class Reference

A content datatype which handles object relations. More...

+ Inheritance diagram for eZObjectRelationType:
+ Collaboration diagram for eZObjectRelationType:

Public Member Functions

 classAttributeContent ($classObjectAttribute)
 
 customClassAttributeHTTPAction ($http, $action, $classAttribute)
 
 customObjectAttributeHTTPAction ($http, $action, $contentObjectAttribute, $parameters)
 
 eZObjectRelationType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fixupClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 isIndexable ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 objectDisplayInformation ($objectAttribute, $mergeInfo=false)
 
 postUnserializeContentObjectAttribute ($package, $objectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 removeRelatedObjectItem ($contentObjectAttribute, $objectID)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 serializeContentObjectAttribute ($package, $objectAttribute)
 
 sortKey ($contentObjectAttribute)
 
 sortKeyType ()
 
 storeObjectAttribute ($contentObjectAttribute)
 
 supportsBatchInitializeObjectAttribute ()
 
 title ($contentObjectAttribute, $name=null)
 
 toString ($contentObjectAttribute)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
- Public Member Functions inherited from eZDataType
 attribute ($attr)
 
 attributes ()
 
 batchInitializeObjectAttributeData ($classAttribute)
 
 classAttributeContent ($classAttribute)
 
 classAttributeRemovableInformation ($classAttribute, $includeAll=true)
 
 classDisplayInformation ($classAttribute, $mergeInfo=false)
 
 cloneClassAttribute ($oldClassAttribute, $newClassAttribute)
 
 contentActionList ($classAttribute)
 Return content action(s) which can be performed on object containing the current datatype. More...
 
 createContentObjectAttributeDOMNode ($objectAttribute)
 Create empty content object attribute DOM node. More...
 
 customClassAttributeHTTPAction ($http, $action, $classAttribute)
 
 customObjectAttributeHTTPAction ($http, $action, $objectAttribute, $parameters)
 
 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)
 
 fromString ($objectAttribute, $string)
 
 getDBAExtensionFilePath ()
 
 getDBAFileName ()
 
 getDBAFilePath ($checkExtensions=true)
 
 handleCustomObjectHTTPActions ($http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 handleDownload ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 hasAttribute ($attr)
 
 hasInformationCollection ()
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 hasStoredFileInformation ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 importDBDataFromDBAFile ($dbaFilePath=false)
 
 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 ()
 
 isAddToBasketValidationRequired ()
 
 isClassAttributeRemovable ($classAttribute)
 
 isHTTPFileInsertionSupported ()
 
 isIndexable ()
 
 isInformationCollector ()
 
 isRegularFileInsertionSupported ()
 
 isSimpleStringInsertionSupported ()
 
 isTranslatable ()
 Indicates if datatype supports being translated. More...
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($objectAttribute)
 
 objectDisplayInformation ($objectAttribute, $mergeInfo=false)
 
 onPublish ($contentObjectAttribute, $contentObject, $publishedNodes)
 
 postInitializeObjectAttribute ($objectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 postStore ($objectAttribute)
 
 postUnserializeContentObjectAttribute ($package, $objectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 preStoreDefinedClassAttribute ($classAttribute)
 
 preStoreModifiedClassAttribute ($classAttribute)
 
 preStoreVersionedClassAttribute ($classAttribute, $version)
 Hook function which is called before an content class attribute is stored. More...
 
 productOptionInformation ($objectAttribute, $optionID, $productItem)
 
 removeRelatedObjectItem ($contentObjectAttribute, $objectID)
 
 repairContentObjectAttribute ($contentObjectAttribute)
 
 restoreTrashedObjectAttribute ($objectAttribute)
 Restores the content object attribute $objectAttribute from trash Default implementation does nothing. More...
 
 resultTemplate (&$collectionAttribute)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 serializeContentObjectAttribute ($package, $objectAttribute)
 
 sortKey ($objectAttribute)
 
 sortKeyType ()
 
 storeClassAttribute ($classAttribute, $version)
 
 storeDefinedClassAttribute ($classAttribute)
 
 storedFileInformation ($object, $objectVersion, $objectLanguage, $objectAttribute)
 
 storeModifiedClassAttribute ($classAttribute)
 
 storeObjectAttribute ($objectAttribute)
 
 storeVersionedClassAttribute ($classAttribute, $version)
 
 supportsBatchInitializeObjectAttribute ()
 
 templateList ()
 
 title ($objectAttribute, $name=null)
 
 toString ($objectAttribute)
 
 trashStoredObjectAttribute ($objectAttribute, $version=null)
 
 unserializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 unserializeContentObjectAttribute ($package, $objectAttribute, $attributeNode)
 
 validateAddToBasket ($objectAttribute, $data, &$errors)
 
 validateClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 validateCollectionAttributeHTTPInput ($http, $base, $objectAttribute)
 
 validateObjectAttributeHTTPInput ($http, $base, $objectAttribute)
 
 viewTemplate ($contentobjectAttribute)
 

Public Attributes

const DATA_TYPE_STRING = "ezobjectrelation"
 
- Public Attributes inherited from eZDataType
 $DataTypeString
 The datatype string ID, used for uniquely identifying a datatype. More...
 
 $Name
 The descriptive name of the datatype, usually used for displaying to the user. More...
 

Private Member Functions

 fuzzyTextMatch ($text, $match)
 
 removeContentObjectRelation ($contentObjectAttribute)
 

Additional Inherited Members

- Static Public Member Functions inherited from eZDataType
static allowedTypes ()
 
static create ($dataTypeString)
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($type)
 
static register ($dataTypeString, $className)
 
static registeredDataTypes ()
 

Detailed Description

A content datatype which handles object relations.

Member Function Documentation

eZObjectRelationType::classAttributeContent (   $classObjectAttribute)
eZObjectRelationType::customClassAttributeHTTPAction (   $http,
  $action,
  $classAttribute 
)
eZObjectRelationType::customObjectAttributeHTTPAction (   $http,
  $action,
  $contentObjectAttribute,
  $parameters 
)
eZObjectRelationType::eZObjectRelationType ( )

Initializes with a string id and a description.

eZObjectRelationType::fetchClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZObjectRelationType::fetchObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

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

eZObjectRelationType::fixupClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZObjectRelationType::fromString (   $contentObjectAttribute,
  $string 
)
eZObjectRelationType::fuzzyTextMatch (   $text,
  $match 
)
private
Returns
a number of how near $match is to $text, the lower the better and 0 is a perfect match.
false if it does not match

Referenced by fetchObjectAttributeHTTPInput().

eZObjectRelationType::hasObjectAttributeContent (   $contentObjectAttribute)
eZObjectRelationType::initializeObjectAttribute (   $contentObjectAttribute,
  $currentVersion,
  $originalContentObjectAttribute 
)

Initializes the class attribute with some data.

eZObjectRelationType::isIndexable ( )
eZObjectRelationType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indeces.

eZObjectRelationType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

Referenced by hasObjectAttributeContent(), metaData(), and title().

eZObjectRelationType::objectDisplayInformation (   $objectAttribute,
  $mergeInfo = false 
)

Sets grouped_input to true when browse mode is active or a dropdown with a fuzzy match is used.

eZObjectRelationType::postUnserializeContentObjectAttribute (   $package,
  $objectAttribute 
)
eZObjectRelationType::preStoreClassAttribute (   $classAttribute,
  $version 
)
eZObjectRelationType::removeContentObjectRelation (   $contentObjectAttribute)
private

Delete the old version from ezcontentobject_link if count of translations > 1

Referenced by customObjectAttributeHTTPAction().

eZObjectRelationType::removeRelatedObjectItem (   $contentObjectAttribute,
  $objectID 
)

Removes objects with given ID from the relations list

eZObjectRelationType::serializeContentClassAttribute (   $classAttribute,
  $attributeNode,
  $attributeParametersNode 
)
eZObjectRelationType::serializeContentObjectAttribute (   $package,
  $objectAttribute 
)

Export related object's remote_id.

eZObjectRelationType::sortKey (   $contentObjectAttribute)
eZObjectRelationType::sortKeyType ( )
eZObjectRelationType::storeObjectAttribute (   $contentObjectAttribute)

Stores relation to the ezcontentobject_link table

eZObjectRelationType::supportsBatchInitializeObjectAttribute ( )
eZObjectRelationType::title (   $contentObjectAttribute,
  $name = null 
)

Returns the content of the string for use as a title

eZObjectRelationType::toString (   $contentObjectAttribute)
Returns
string representation of an contentobjectattribute data for simplified export
eZObjectRelationType::unserializeContentClassAttribute (   $classAttribute,
  $attributeNode,
  $attributeParametersNode 
)
eZObjectRelationType::unserializeContentObjectAttribute (   $package,
  $objectAttribute,
  $attributeNode 
)
eZObjectRelationType::validateClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZObjectRelationType::validateObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

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

Member Data Documentation

const eZObjectRelationType::DATA_TYPE_STRING = "ezobjectrelation"

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