eZPublish  4.5
eZBinaryFileHandler Class Reference

Interface for all binary file handlers. More...

+ Inheritance diagram for eZBinaryFileHandler:

Public Member Functions

 attribute ($attribute)
 
 attributes ()
 
 downloadFileObject ($contentObject, $contentObjectAttribute)
 
 downloadType ($contentObject, $contentObjectAttribute)
 
 downloadURL ($contentObject, $contentObjectAttribute)
 
 editTemplate ($contentobjectAttribute)
 
 eZBinaryFileHandler ($identifier, $name, $handleType)
 
 handleDownload ($contentObject, $contentObjectAttribute, $type)
 
 handleFileDownload ($contentObject, $contentObjectAttribute, $type, $mimeData)
 
 handleUpload ()
 
 hasAttribute ($attribute)
 
 informationTemplate ($contentobjectAttribute)
 
 repositories ()
 
 storedFilename (&$binary, $returnMimeData=false)
 
 viewTemplate ($contentobjectAttribute)
 

Static Public Member Functions

static instance ($identifier=false)
 Returns a shared instance of the eZBinaryFileHandler class pr $handlerName as defined in file.ini[BinaryFileSettings]Handler. More...
 

Public Attributes

 $Info
 
const HANDLE_ALL = 0x3
 
const HANDLE_DOWNLOAD = 0x2
 
const HANDLE_UPLOAD = 0x1
 
const RESULT_OK = 1
 
const RESULT_UNAVAILABLE = 2
 
const TYPE_FILE = 'file'
 
const TYPE_MEDIA = 'media'
 

Detailed Description

Interface for all binary file handlers.

Member Function Documentation

eZBinaryFileHandler::attribute (   $attribute)
eZBinaryFileHandler::attributes ( )
eZBinaryFileHandler::downloadFileObject (   $contentObject,
  $contentObjectAttribute 
)
Returns
the file object which corresponds to $contentObject and $contentObjectAttribute.

Referenced by downloadURL().

eZBinaryFileHandler::downloadType (   $contentObject,
  $contentObjectAttribute 
)
Returns
the file object type which corresponds to $contentObject and $contentObjectAttribute.
Deprecated:

Referenced by downloadURL().

eZBinaryFileHandler::downloadURL (   $contentObject,
  $contentObjectAttribute 
)
Returns
the download url for the file object which corresponds to $contentObject and $contentObjectAttribute.
Deprecated:
eZBinaryFileHandler::editTemplate (   $contentobjectAttribute)
Returns
the suffix for the template name which will be used for attribute viewing.
Note
Default returns false which means no special template.
eZBinaryFileHandler::eZBinaryFileHandler (   $identifier,
  $name,
  $handleType 
)
eZBinaryFileHandler::handleDownload (   $contentObject,
  $contentObjectAttribute,
  $type 
)
eZBinaryFileHandler::handleFileDownload (   $contentObject,
  $contentObjectAttribute,
  $type,
  $mimeData 
)

Referenced by handleDownload().

eZBinaryFileHandler::handleUpload ( )
eZBinaryFileHandler::hasAttribute (   $attribute)
eZBinaryFileHandler::informationTemplate (   $contentobjectAttribute)
Returns
the suffix for the template name which will be used for attribute viewing.
Note
Default returns false which means no special template.
static eZBinaryFileHandler::instance (   $identifier = false)
static

Returns a shared instance of the eZBinaryFileHandler class pr $handlerName as defined in file.ini[BinaryFileSettings]Handler.

Parameters
string | false$identifierUses file.ini[BinaryFileSettings]Handler if false
Returns
eZBinaryFileHandler

Referenced by eZBinaryFileType\fileHandler().

eZBinaryFileHandler::repositories ( )
eZBinaryFileHandler::storedFilename ( $binary,
  $returnMimeData = false 
)

Figures out the filename from the binary object $binary. Currently supports eZBinaryFile, eZMedia and eZImageAliasHandler.

Returns
false if no file was found.
Parameters
$returnMimeDataIf this is set to true then it will return a mime structure, otherwise it returns the filename.
Deprecated:
eZBinaryFileHandler::viewTemplate (   $contentobjectAttribute)
Returns
the suffix for the template name which will be used for attribute viewing.
Note
Default returns false which means no special template.

Member Data Documentation

eZBinaryFileHandler::$Info
const eZBinaryFileHandler::HANDLE_ALL = 0x3
const eZBinaryFileHandler::HANDLE_DOWNLOAD = 0x2
const eZBinaryFileHandler::HANDLE_UPLOAD = 0x1
const eZBinaryFileHandler::RESULT_OK = 1
const eZBinaryFileHandler::RESULT_UNAVAILABLE = 2
const eZBinaryFileHandler::TYPE_FILE = 'file'
const eZBinaryFileHandler::TYPE_MEDIA = 'media'

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