eZPublish  4.5
eZObjectRelationListType Class Reference

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

+ Inheritance diagram for eZObjectRelationListType:
+ Collaboration diagram for eZObjectRelationListType:

Public Member Functions

 appendObject ($objectID, $priority, $contentObjectAttribute)
 
 classAttributeContent ($classAttribute)
 
 createClassContentStructure ($doc)
 
 createInstance ($class, $priority, $contentObjectAttribute, $nodePlacement=false)
 
 createNewObject ($contentObjectAttribute, $name)
 
 createObjectContentStructure ($doc)
 
 customClassAttributeHTTPAction ($http, $action, $classAttribute)
 
 customObjectAttributeHTTPAction ($http, $action, $contentObjectAttribute, $parameters)
 
 defaultClassAttributeContent ()
 
 defaultObjectAttributeContent ()
 
 deleteStoredObjectAttribute ($objectAttribute, $version=null)
 
 eZObjectRelationListType ()
 
 fetchClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fetchObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fixRelatedObjectItem ($contentObjectAttribute, $objectID, $mode)
 
 fixRelationsMove ($objectID, $contentObjectAttribute)
 
 fixRelationsRemove ($objectID, $contentObjectAttribute)
 
 fixRelationsRestore ($objectID, $contentObjectAttribute)
 
 fixRelationsSwap ($objectID, $contentObjectAttribute)
 
 fixRelationsTrash ($objectID, $contentObjectAttribute)
 
 fixupClassAttributeHTTPInput ($http, $base, $classAttribute)
 
 fixupObjectAttributeHTTPInput ($http, $base, $contentObjectAttribute)
 
 fromString ($contentObjectAttribute, $string)
 
 handleCustomObjectHTTPActions ($http, $attributeDataBaseName, $customActionAttributeArray, $customActionParameters)
 
 hasObjectAttributeContent ($contentObjectAttribute)
 
 initializeClassAttribute ($classAttribute)
 
 initializeObjectAttribute ($contentObjectAttribute, $currentVersion, $originalContentObjectAttribute)
 
 isIndexable ()
 
 metaData ($contentObjectAttribute)
 
 objectAttributeContent ($contentObjectAttribute)
 
 onPublish ($contentObjectAttribute, $contentObject, $publishedNodes)
 
 postUnserializeContentObjectAttribute ($package, $objectAttribute)
 
 preStoreClassAttribute ($classAttribute, $version)
 
 removeRelatedObjectItem ($contentObjectAttribute, $objectID)
 
 serializeContentClassAttribute ($classAttribute, $attributeNode, $attributeParametersNode)
 
 serializeContentObjectAttribute ($package, $objectAttribute)
 
 storeClassAttributeContent ($classAttribute, $content)
 
 storeObjectAttribute ($attribute)
 
 storeObjectAttributeContent ($objectAttribute, $content)
 
 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)
 
 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)
 

Static Public Member Functions

static contentObjectArrayXMLMap ()
 
static createClassDOMDocument ($content)
 
static createObjectDOMDocument ($content)
 
static domString ($domDocument)
 
static isItemPublished ($relationItem)
 
static parseXML ($xmlText)
 
static storeClassDOMDocument ($doc, $classAttribute)
 
static storeObjectDOMDocument ($doc, $objectAttribute)
 
- Static Public Member Functions inherited from eZDataType
static allowedTypes ()
 
static create ($dataTypeString)
 
static loadAndRegisterAllTypes ()
 
static loadAndRegisterType ($type)
 
static register ($dataTypeString, $className)
 
static registeredDataTypes ()
 

Public Attributes

const DATA_TYPE_STRING = "ezobjectrelationlist"
 
- 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...
 

Static Private Member Functions

static removeRelationObject ($contentObjectAttribute, $deletionItem)
 

Detailed Description

A content datatype which handles object relations.

Bugs/missing/deprecated features:

  • No identifier support yet
  • Validation and fixup for "Add new object" functionality
  • Proper embed views for admin classes
  • No translation page support yet (maybe?)
  • is_modified is deprecated and is used for BC only.

Member Function Documentation

eZObjectRelationListType::appendObject (   $objectID,
  $priority,
  $contentObjectAttribute 
)
eZObjectRelationListType::classAttributeContent (   $classAttribute)
static eZObjectRelationListType::contentObjectArrayXMLMap ( )
static
eZObjectRelationListType::createClassContentStructure (   $doc)

Referenced by classAttributeContent().

static eZObjectRelationListType::createClassDOMDocument (   $content)
static
eZObjectRelationListType::createInstance (   $class,
  $priority,
  $contentObjectAttribute,
  $nodePlacement = false 
)
eZObjectRelationListType::createNewObject (   $contentObjectAttribute,
  $name 
)

Referenced by storeObjectAttribute().

eZObjectRelationListType::createObjectContentStructure (   $doc)

Referenced by objectAttributeContent().

static eZObjectRelationListType::createObjectDOMDocument (   $content)
static
eZObjectRelationListType::customClassAttributeHTTPAction (   $http,
  $action,
  $classAttribute 
)
eZObjectRelationListType::customObjectAttributeHTTPAction (   $http,
  $action,
  $contentObjectAttribute,
  $parameters 
)
eZObjectRelationListType::defaultClassAttributeContent ( )
eZObjectRelationListType::defaultObjectAttributeContent ( )
eZObjectRelationListType::deleteStoredObjectAttribute (   $objectAttribute,
  $version = null 
)
static eZObjectRelationListType::domString (   $domDocument)
static
Returns
the XML structure in $domDocument as text. It will take of care of the necessary charset conversions for content storage.

Referenced by copySubtree().

eZObjectRelationListType::eZObjectRelationListType ( )

Initializes with a string id and a description.

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

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

eZObjectRelationListType::fixRelatedObjectItem (   $contentObjectAttribute,
  $objectID,
  $mode 
)
eZObjectRelationListType::fixRelationsMove (   $objectID,
  $contentObjectAttribute 
)

Referenced by fixRelatedObjectItem().

eZObjectRelationListType::fixRelationsRemove (   $objectID,
  $contentObjectAttribute 
)

Referenced by fixRelatedObjectItem().

eZObjectRelationListType::fixRelationsRestore (   $objectID,
  $contentObjectAttribute 
)

Referenced by fixRelatedObjectItem().

eZObjectRelationListType::fixRelationsSwap (   $objectID,
  $contentObjectAttribute 
)
eZObjectRelationListType::fixRelationsTrash (   $objectID,
  $contentObjectAttribute 
)

Referenced by fixRelatedObjectItem().

eZObjectRelationListType::fixupClassAttributeHTTPInput (   $http,
  $base,
  $classAttribute 
)
eZObjectRelationListType::fixupObjectAttributeHTTPInput (   $http,
  $base,
  $contentObjectAttribute 
)

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

eZObjectRelationListType::fromString (   $contentObjectAttribute,
  $string 
)
eZObjectRelationListType::handleCustomObjectHTTPActions (   $http,
  $attributeDataBaseName,
  $customActionAttributeArray,
  $customActionParameters 
)
eZObjectRelationListType::hasObjectAttributeContent (   $contentObjectAttribute)
eZObjectRelationListType::initializeClassAttribute (   $classAttribute)
eZObjectRelationListType::initializeObjectAttribute (   $contentObjectAttribute,
  $currentVersion,
  $originalContentObjectAttribute 
)
eZObjectRelationListType::isIndexable ( )
static eZObjectRelationListType::isItemPublished (   $relationItem)
static
Returns
true if the relation item $relationItem exist in the content tree.
eZObjectRelationListType::metaData (   $contentObjectAttribute)

Returns the meta data used for storing search indexes.

eZObjectRelationListType::objectAttributeContent (   $contentObjectAttribute)

Returns the content.

Referenced by title().

eZObjectRelationListType::onPublish (   $contentObjectAttribute,
  $contentObject,
  $publishedNodes 
)
static eZObjectRelationListType::parseXML (   $xmlText)
static
eZObjectRelationListType::postUnserializeContentObjectAttribute (   $package,
  $objectAttribute 
)
eZObjectRelationListType::preStoreClassAttribute (   $classAttribute,
  $version 
)
eZObjectRelationListType::removeRelatedObjectItem (   $contentObjectAttribute,
  $objectID 
)

Removes objects with given ID from the relations list

Referenced by fixRelationsRemove().

static eZObjectRelationListType::removeRelationObject (   $contentObjectAttribute,
  $deletionItem 
)
staticprivate

Removes the relation object $deletionItem if the item is owned solely by this version and is not published in the content tree.

Referenced by customObjectAttributeHTTPAction(), and deleteStoredObjectAttribute().

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

For each relation export its priority and content object remote_id, like this: <related-objects> <relation-list> <relation-item priority="1" contentobject-remote-id="faaeb9be3bd98ed09f606fc16d144eca" /> <relation-item priority="2" contentobject-remote-id="1bb4fe25487f05527efa8bfd394cecc7" /> </relation-list> To do this we fetch content XML and strip all the relation attributes except of "priority" from there, and add "contentobject-remote-id" attribute.

eZObjectRelationListType::storeClassAttributeContent (   $classAttribute,
  $content 
)
static eZObjectRelationListType::storeClassDOMDocument (   $doc,
  $classAttribute 
)
static
eZObjectRelationListType::storeObjectAttribute (   $attribute)
eZObjectRelationListType::storeObjectAttributeContent (   $objectAttribute,
  $content 
)
static eZObjectRelationListType::storeObjectDOMDocument (   $doc,
  $objectAttribute 
)
static
eZObjectRelationListType::supportsBatchInitializeObjectAttribute ( )
eZObjectRelationListType::title (   $contentObjectAttribute,
  $name = null 
)

Returns the content of the string for use as a title, for simplicity this is the name of the first object referenced or false.

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

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

Member Data Documentation

const eZObjectRelationListType::DATA_TYPE_STRING = "ezobjectrelationlist"

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