eZPublish  3.9
eZMediaType Class Reference

The class eZMediaType handles storage and playback of media files. More...

+ Inheritance diagram for eZMediaType:
+ Collaboration diagram for eZMediaType:

Public Member Functions

 checkFileUploads ()
 
 customObjectAttributeHTTPAction ($http, $action, &$contentObjectAttribute)
 
 deleteStoredObjectAttribute (&$contentObjectAttribute, $version=null)
 
 eZMediaType ()
 
 fetchClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fetchObjectAttributeHTTPInput (&$http, $base, &$contentObjectAttribute)
 
 fixupClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 fromString (&$objectAttribute, $string)
 
 hasObjectAttributeContent (&$contentObjectAttribute)
 
 hasStoredFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 insertHTTPFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, &$httpFile, $mimeData, &$result)
 
 insertRegularFile (&$object, $objectVersion, $objectLanguage, &$objectAttribute, $filePath, &$result)
 
 isHTTPFileInsertionSupported ()
 
 isRegularFileInsertionSupported ()
 
 metaData ()
 
objectAttributeContent ($contentObjectAttribute)
 
 postInitializeObjectAttribute (&$contentObjectAttribute, $currentVersion, &$originalContentObjectAttribute)
 
 serializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 serializeContentObjectAttribute (&$package, &$objectAttribute)
 
 storeClassAttribute (&$attribute, $version)
 
 storeDefinedClassAttribute (&$attribute)
 
 storedFileInformation (&$object, $objectVersion, $objectLanguage, &$objectAttribute)
 
 storeObjectAttribute (&$contentObjectAttribute)
 
 title (&$contentObjectAttribute, $name="original_filename")
 
 toString ($objectAttribute)
 
 unserializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 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)
 
 fromString (&$objectAttribute, $string)
 
 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)
 
 toString ($objectAttribute)
 
 unserializeContentClassAttribute (&$classAttribute, &$attributeNode, &$attributeParametersNode)
 
 unserializeContentObjectAttribute (&$package, &$objectAttribute, $attributeNode)
 
 validateClassAttributeHTTPInput (&$http, $base, &$classAttribute)
 
 validateCollectionAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
 validateObjectAttributeHTTPInput (&$http, $base, &$objectAttribute)
 
viewTemplate (&$contentobjectAttribute)
 

Static Public Member Functions

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

Detailed Description

The class eZMediaType handles storage and playback of media files.

Member Function Documentation

eZMediaType::checkFileUploads ( )

Checks if file uploads are enabled, if not it gives a warning.

Referenced by fetchObjectAttributeHTTPInput().

eZMediaType::customObjectAttributeHTTPAction (   $http,
  $action,
$contentObjectAttribute 
)
eZMediaType::deleteStoredObjectAttribute ( $contentObjectAttribute,
  $version = null 
)

Delete stored attribute

Referenced by customObjectAttributeHTTPAction().

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

Fetches input and stores it in the data instance.

eZMediaType::fixupClassAttributeHTTPInput ( $http,
  $base,
$classAttribute 
)
eZMediaType::fromString ( $objectAttribute,
  $string 
)
eZMediaType::hasObjectAttributeContent ( $contentObjectAttribute)
eZMediaType::hasStoredFileInformation ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute 
)

We support file information

eZMediaType::insertHTTPFile ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute,
$httpFile,
  $mimeData,
$result 
)

Inserts the file using the eZMedia class.

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

Inserts the file using the eZMedia class.

Referenced by fromString().

eZMediaType::isHTTPFileInsertionSupported ( )

HTTP file insertion is supported.

eZMediaType::isRegularFileInsertionSupported ( )

Regular file insertion is supported.

eZMediaType::metaData ( )
& eZMediaType::objectAttributeContent (   $contentObjectAttribute)
eZMediaType::pluginPage (   $mediaType)
static
eZMediaType::postInitializeObjectAttribute ( $contentObjectAttribute,
  $currentVersion,
$originalContentObjectAttribute 
)

Sets value according to current version

eZMediaType::serializeContentClassAttribute ( $classAttribute,
$attributeNode,
$attributeParametersNode 
)
eZMediaType::serializeContentObjectAttribute ( $package,
$objectAttribute 
)
Parameters
package
contentattribute
Returns
a DOM representation of the content object attribute
eZMediaType::storeClassAttribute ( $attribute,
  $version 
)
eZMediaType::storeDefinedClassAttribute ( $attribute)
eZMediaType::storedFileInformation ( $object,
  $objectVersion,
  $objectLanguage,
$objectAttribute 
)

Extracts file information for the media entry.

eZMediaType::storeObjectAttribute ( $contentObjectAttribute)
eZMediaType::title ( $contentObjectAttribute,
  $name = "original_filename" 
)

Returns the object title.

eZMediaType::toString (   $objectAttribute)
Returns
string representation of an contentobjectattribute data for simplified export
eZMediaType::unserializeContentClassAttribute ( $classAttribute,
$attributeNode,
$attributeParametersNode 
)
eZMediaType::unserializeContentObjectAttribute ( $package,
$objectAttribute,
  $attributeNode 
)
Parameters
package
contentobjectattribute object
ezdomnodeobject
eZMediaType::validateClassAttributeHTTPInput ( $http,
  $base,
$classAttribute 
)
eZMediaType::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: