eZPublish  3.8
eZImageType Class Reference

The class eZImageType handles image accounts and association with content objects. More...

+ Inheritance diagram for eZImageType:
+ Collaboration diagram for eZImageType:

Public Member Functions

 customObjectAttributeHTTPAction ($http, $action, &$contentObjectAttribute)
 
 deleteStoredObjectAttribute (&$contentObjectAttribute, $version=null)
 
 eZImageType ()
 
 fetchClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fetchObjectAttributeHTTPInput (&$http, $base, &$contentObjectAttribute)
 
 hasObjectAttributeContent (&$contentObjectAttribute)
 
 hasStoredFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 initializeObjectAttribute (&$contentObjectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 insertHTTPFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, &$httpFile, $mimeData, &$result)
 
 insertRegularFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, $filePath, &$result)
 
 isHTTPFileInsertionSupported ()
 
 isRegularFileInsertionSupported ()
 
 metaData ($contentObjectAttribute)
 
objectAttributeContent (&$contentObjectAttribute)
 
 onPublish (&$contentObjectAttribute, &$contentObject, &$publishedNodes)
 
 repairContentObjectAttribute (&$contentObjectAttribute)
 
 serializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 serializeContentObjectAttribute (&$package, &$objectAttribute)
 
 storedFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 storeObjectAttribute (&$contentObjectAttribute)
 
 title (&$contentObjectAttribute, $name= 'original_filename')
 
 unserializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 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

The class eZImageType handles image accounts and association with content objects.

Note
The method initializeObjectAttribute was removed in 3.8, the new storage technique removes the need to have it.

Member Function Documentation

eZImageType::customObjectAttributeHTTPAction (   $http,
  $action,
$contentObjectAttribute 
)
eZImageType::deleteStoredObjectAttribute ( $contentObjectAttribute,
  $version = null 
)
eZImageType::eZImageType ( )
eZImageType::fetchClassAttributeHTTPInput ( $http,
  $base,
$classAttribute 
)
eZImageType::fetchObjectAttributeHTTPInput ( $http,
  $base,
$contentObjectAttribute 
)
eZImageType::hasObjectAttributeContent ( $contentObjectAttribute)
eZImageType::hasStoredFileInformation ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute 
)

We support file information

eZImageType::initializeObjectAttribute ( $contentObjectAttribute,
  $currentVersion,
$originalContentObjectAttribute 
)
eZImageType::insertHTTPFile ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute,
$httpFile,
  $mimeData,
$result 
)

Inserts the file using the Image Handler eZImageAliasHandler.

eZImageType::insertRegularFile ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute,
  $filePath,
$result 
)

Inserts the file using the Image Handler eZImageAliasHandler.

eZImageType::isHTTPFileInsertionSupported ( )

HTTP file insertion is supported.

eZImageType::isRegularFileInsertionSupported ( )

Regular file insertion is supported.

eZImageType::metaData (   $contentObjectAttribute)
& eZImageType::objectAttributeContent ( $contentObjectAttribute)
eZImageType::onPublish ( $contentObjectAttribute,
$contentObject,
$publishedNodes 
)
eZImageType::repairContentObjectAttribute ( $contentObjectAttribute)
eZImageType::serializeContentClassAttribute ( $classAttribute,
$attributeNode,
$attributeParametersNode 
)
eZImageType::serializeContentObjectAttribute ( $package,
$objectAttribute 
)
Returns
a DOM representation of the content object attribute
eZImageType::storedFileInformation ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute 
)

Extracts file information for the image entry.

eZImageType::storeObjectAttribute ( $contentObjectAttribute)
eZImageType::title ( $contentObjectAttribute,
  $name = 'original_filename' 
)

Will return one of the following items from the original alias.

  • alternative_text - If it's not empty
  • Default paramater in $name if it exists
  • original_filename, this is the default fallback.
eZImageType::unserializeContentClassAttribute ( $classAttribute,
$attributeNode,
$attributeParametersNode 
)
eZImageType::unserializeContentObjectAttribute ( $package,
$objectAttribute,
  $attributeNode 
)
Parameters
package
contentobjectattribute object
ezdomnodeobject
eZImageType::validateObjectAttributeHTTPInput ( $http,
  $base,
$contentObjectAttribute 
)

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