The BinaryFile FieldType

This FieldType repres= ents and handles a binary file. It also counts the number of times the file= has been downloaded from the content/download module.

Name	Internal name	Expected input	Output
`BinaryFile`	`ezbinaryfile`	`Mixed`	`Mixed`

Description

This FieldType allows the storage and retrieval of a single= file. It is capable of handling virtually any file type and is typically u= sed for storing legacy document types such as PDF files, Word documents, sp= readsheets, etc. The maximum allowed file size is determined by the "Max fi= le size" class attribute edit parameter and the "upload_max_filesize<= /code>" directive in the main PHP configuration file ("php.ini").


BinaryFile Value=
 Object API
eZ\Publish\Core\FieldType\BinaryFile\Value offers the follo=
wing properties.



Note that both BinaryFile and Media Value and Type inherit =
from the BinaryBase abstract field type, and share common prop=
erties.






Attribute
Type
Description
Example


path
string
The path to a b=
inary file. This path depends on the IO Handler that is bei=
ng used. With the native, default handlers (FileSystem and Legacy), which i=
s the file path, relative to the binary file storage root dir =
(var/<vardir>/storage/original by default).
application/63cd472dd7819da7b75e8e=
2fee507c68.pdf


fileName
string
The human readable file name, as e=
xposed to the outside. Used when sending the file for download in order to =
name the file.
20130116_whitepaper_ezpublish5 lig=
ht.pdf


fileSize
int
File size, in bytes
1077923


mimeType
string
The file's mime type.
application/pdf


downloadCount
integer
Number of times the file was downl=
oaded
0




BinaryFile hash form=
at
The hash format mostly matches the value object. It has the following ke=
ys:

path
fileName
fileSize
mimeType
downloadCount

REST API specifics
Used in the REST API, a BinaryFile field will mostly serialize the hash =
described above. However there are a couple specifics worth mentioning.
Reading conten=
t: url property
When reading the contents of a field of this type, an extra key is added=
: url. This key gives you the absolute file URL, protocol and host included=
.
Example: http://example.com/var/ezdemo_site/storage/original/ap=
plication/63cd472dd7819da7b75e8e2fee507c68.pdf
Creating con=
tent: data property
When creating BinaryFile content with the REST API, it is possible to pr=
ovide data as a base64 encoded string, using the "data" fieldV=
alue key:

=20
<field>
    <fieldDefinitionIdentifier>file</fieldDefinitionIdentifier>
    <languageCode>eng-GB</languageCode>
    <fieldValue>
        <value key=3D"fileName">My file.pdf</value>
        <value key=3D"fileSize">17589</value>
        <value key=3D"data"><![CDATA[/9j/4AAQSkZJRgABAQEAZABkAAD/2=
wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcG
...
...]]></value>
    </fieldValue>
</field>=20

Attribute	Type	Description	Example
`path`	string	The `path` to a b= inary file. This `path` depends on the IO Handler that is bei= ng used. With the native, default handlers (FileSystem and Legacy), which i= s the file `path`, relative to the binary file storage root dir = (`var/<vardir>/storage/original` by default).	application/63cd472dd7819da7b75e8e= 2fee507c68.pdf
`fileName`	string	The human readable file name, as e= xposed to the outside. Used when sending the file for download in order to = name the file.	20130116_whitepaper_ezpublish5 lig= ht.pdf
`fileSize`	int	File size, in bytes	1077923
`mimeType`	string	The file's mime type.	application/pdf
`downloadCount`	integer	Number of times the file was downl= oaded	0

The BinaryFile FieldType

Description

BinaryFile Value= Object API

BinaryFile hash form= at

REST API specifics

Reading conten= t: url property

Creating con= tent: data property