eZBinaryFile Class Reference

The class eZBinaryFile handles registered binaryfiles. More...

Inheritance diagram for eZBinaryFile:

Collaboration diagram for eZBinaryFile:

List of all members.

Public Member Functions
	eZBinaryFile ($row)
	filePath ()
	fileSize ()
	metaData ()
	mimeTypeCategory ()
	mimeTypePart ()
	storedFileInfo ()
Static Public Member Functions
static	create ($contentObjectAttributeID, $version)
static	definition ()
static	fetch ($id, $version=null, $asObject=true)
static	fetchByFileName ($filename, $version=null, $asObject=true)
static	removeByID ($id, $version)
Public Attributes
	$ContentObjectAttributeID
	$Filename
	$MimeType
	$OriginalFilename

---

Detailed Description

The class eZBinaryFile handles registered binaryfiles.

Definition at line 38 of file ezbinaryfile.php.

---

Member Function Documentation

static eZBinaryFile::create	(	$	contentObjectAttributeID,
		$	version
	)		[static]

Definition at line 119 of file ezbinaryfile.php.

static eZBinaryFile::definition

(

)

[static]

Returns:

the definition for the object, the default implementation is to return an empty array. It's upto each inheriting class to return a proper definition array.

The definition array is an associative array consists of these keys:

• fields - an associative array of fields which defines which database field (the key) is to fetched and how they map to object member variables (the value).
• keys - an array of fields which is used for uniquely identifying the object in the table.
• function_attributes - an associative array of attributes which maps to member functions, used for fetching data with functions.
• set_functions - an associative array of attributes which maps to member functions, used for setting data with functions.
• increment_key - the field which is incremented on table inserts.
• class_name - the classname which is used for instantiating new objecs when fetching from the database.
• sort - an associative array which defines the default sorting of lists, the key is the table field while the value is the sorting method which is either asc or desc.
• name - the name of the database table

Example:

static function definition()
{
    return array( "fields" => array( "id" => "ID",
                                     "version" => "Version",
                                     "name" => "Name" ),
                  "keys" => array( "id", "version" ),
                  "function_attributes" => array( "current" => "currentVersion",
                                                  "class_name" => "className" ),
                  "increment_key" => "id",
                  "class_name" => "eZContentClass",
                  "sort" => array( "id" => "asc" ),
                  "name" => "ezcontentclass" );
}

Reimplemented from eZPersistentObject.

Definition at line 45 of file ezbinaryfile.php.

Referenced by fetch(), fetchByFileName(), and removeByID().

eZBinaryFile::eZBinaryFile

(

$

row

)

Definition at line 40 of file ezbinaryfile.php.

Referenced by create().

static eZBinaryFile::fetch	(	$	id,
		$	version = null,
		$	asObject = true
	)		[static]

Definition at line 130 of file ezbinaryfile.php.

Referenced by eZBinaryFileType\deleteStoredObjectAttribute(), eZBinaryFileHandler\downloadFileObject(), eZBinaryFileHandler\downloadType(), eZBinaryFileType\fetchObjectAttributeHTTPInput(), eZBinaryFileType\handleDownload(), eZBinaryFileType\hasObjectAttributeContent(), eZBinaryFileType\initializeObjectAttribute(), eZBinaryFileType\insertHTTPFile(), eZBinaryFileType\insertRegularFile(), eZBinaryFileType\objectAttributeContent(), eZBinaryFileType\storedFileInformation(), eZBinaryFileType\title(), eZBinaryFileType\trashStoredObjectAttribute(), and eZBinaryFileType\validateObjectAttributeHTTPInput().

static eZBinaryFile::fetchByFileName	(	$	filename,
		$	version = null,
		$	asObject = true
	)		[static]

Definition at line 151 of file ezbinaryfile.php.

Referenced by eZBinaryFileType\deleteStoredObjectAttribute(), and eZBinaryFileType\trashStoredObjectAttribute().

eZBinaryFile::filePath

(

)

Definition at line 101 of file ezbinaryfile.php.

eZBinaryFile::fileSize

(

)

Definition at line 87 of file ezbinaryfile.php.

eZBinaryFile::metaData

(

)

Returns:

the medatata from the binary file, if extraction is supported for the current mimetype.

Definition at line 192 of file ezbinaryfile.php.

eZBinaryFile::mimeTypeCategory

(

)

Definition at line 107 of file ezbinaryfile.php.

eZBinaryFile::mimeTypePart

(

)

Definition at line 113 of file ezbinaryfile.php.

static eZBinaryFile::removeByID	(	$	id,
		$	version
	)		[static]

Definition at line 172 of file ezbinaryfile.php.

Referenced by eZBinaryFileType\deleteStoredObjectAttribute().

eZBinaryFile::storedFileInfo

(

)

Definition at line 242 of file ezbinaryfile.php.

Referenced by filePath(), fileSize(), and metaData().

---

Member Data Documentation

eZBinaryFile::$ContentObjectAttributeID

Definition at line 256 of file ezbinaryfile.php.

eZBinaryFile::$Filename

Definition at line 257 of file ezbinaryfile.php.

eZBinaryFile::$MimeType

Definition at line 259 of file ezbinaryfile.php.

eZBinaryFile::$OriginalFilename

Definition at line 258 of file ezbinaryfile.php.

---

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

• ezbinaryfile.php