eZBinaryFileHandler Class Reference

Interface for all binary file handlers. More...

Inheritance diagram for eZBinaryFileHandler:

List of all members.

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.
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.

Definition at line 42 of file ezbinaryfilehandler.php.

---

Member Function Documentation

eZBinaryFileHandler::attribute

(

$

attribute

)

Definition at line 73 of file ezbinaryfilehandler.php.

eZBinaryFileHandler::attributes

(

)

Definition at line 63 of file ezbinaryfilehandler.php.

eZBinaryFileHandler::downloadFileObject	(	$	contentObject,
		$	contentObjectAttribute
	)

Returns:

the file object which corresponds to $contentObject and $contentObjectAttribute.

Definition at line 165 of file ezbinaryfilehandler.php.

Referenced by downloadURL().

eZBinaryFileHandler::downloadType	(	$	contentObject,
		$	contentObjectAttribute
	)

Returns:

the file object type which corresponds to $contentObject and $contentObjectAttribute.

Deprecated:

Definition at line 180 of file ezbinaryfilehandler.php.

Referenced by downloadURL().

eZBinaryFileHandler::downloadURL	(	$	contentObject,
		$	contentObjectAttribute
	)

Returns:

the download url for the file object which corresponds to $contentObject and $contentObjectAttribute.

Deprecated:

Definition at line 197 of file ezbinaryfilehandler.php.

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.

Definition at line 98 of file ezbinaryfilehandler.php.

eZBinaryFileHandler::eZBinaryFileHandler	(	$	identifier,
		$	name,
		$	handleType
	)

Definition at line 55 of file ezbinaryfilehandler.php.

Referenced by eZFileDirectHandler\eZFileDirectHandler(), and eZFilePassthroughHandler\eZFilePassthroughHandler().

eZBinaryFileHandler::handleDownload	(	$	contentObject,
		$	contentObjectAttribute,
		$	type
	)

Definition at line 223 of file ezbinaryfilehandler.php.

eZBinaryFileHandler::handleFileDownload	(	$	contentObject,
		$	contentObjectAttribute,
		$	type,
		$	mimeData
	)

Reimplemented in eZFilePassthroughHandler, and eZFileDirectHandler.

Definition at line 247 of file ezbinaryfilehandler.php.

Referenced by handleDownload().

eZBinaryFileHandler::handleUpload

(

)

Definition at line 157 of file ezbinaryfilehandler.php.

eZBinaryFileHandler::hasAttribute

(

$

attribute

)

Definition at line 68 of file ezbinaryfilehandler.php.

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.

Definition at line 108 of file ezbinaryfilehandler.php.

static eZBinaryFileHandler::instance

(

$

identifier = false

)

[static]

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

Parameters:

$identifier

string|false Uses file.ini[BinaryFileSettings]Handler if false

Returns:

eZBinaryFileHandler

Definition at line 264 of file ezbinaryfilehandler.php.

Referenced by eZFilePassthroughHandler\dispositionType(), eZBinaryFileType\fileHandler(), and eZFilePassthroughHandler\handleFileDownload().

eZBinaryFileHandler::repositories

(

)

Definition at line 252 of file ezbinaryfilehandler.php.

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:

$returnMimeData

If this is set to true then it will return a mime structure, otherwise it returns the filename.

Deprecated:

Definition at line 121 of file ezbinaryfilehandler.php.

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.

Reimplemented in eZFileDirectHandler.

Definition at line 88 of file ezbinaryfilehandler.php.

---

Member Data Documentation

eZBinaryFileHandler::$Info

Definition at line 291 of file ezbinaryfilehandler.php.

const eZBinaryFileHandler::HANDLE_ALL = 0x3

Definition at line 47 of file ezbinaryfilehandler.php.

const eZBinaryFileHandler::HANDLE_DOWNLOAD = 0x2

Definition at line 45 of file ezbinaryfilehandler.php.

Referenced by eZFileDirectHandler\eZFileDirectHandler(), and eZFilePassthroughHandler\eZFilePassthroughHandler().

const eZBinaryFileHandler::HANDLE_UPLOAD = 0x1

Definition at line 44 of file ezbinaryfilehandler.php.

const eZBinaryFileHandler::RESULT_OK = 1

Definition at line 52 of file ezbinaryfilehandler.php.

Referenced by eZFileDirectHandler\handleFileDownload().

const eZBinaryFileHandler::RESULT_UNAVAILABLE = 2

Definition at line 53 of file ezbinaryfilehandler.php.

Referenced by handleDownload(), and eZFilePassthroughHandler\handleFileDownload().

const eZBinaryFileHandler::TYPE_FILE = 'file'

Definition at line 49 of file ezbinaryfilehandler.php.

Referenced by downloadType().

const eZBinaryFileHandler::TYPE_MEDIA = 'media'

Definition at line 50 of file ezbinaryfilehandler.php.

Referenced by downloadType().

---

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

• ezbinaryfilehandler.php