The BinaryFile Field Type

This Field Type represents and handles a binary file. It al= so counts the number of times the file has been downloaded from the c= ontent/download module.

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

Table of contents:

=20

Description
BinaryFile= Value Object API
BinaryFile has= h format
REST API specifics= =20
- Reading = content: url property
- Creati= ng content: data property

=20

Description

This Field Type allows the storage and retrieval of a single file. It is= capable of handling virtually any file type and is typically used for stor= ing legacy document types such as PDF files, Word documents, spreadsheets, = etc. The maximum allowed file size is determined by the "Max file size" cla= ss attribute edit parameter and the "upload_max_filesize" dire= ctive 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
`id`	string	Binary file identifier. This= ID depends on the IO Handler that is being used. With the native, def= ault handlers (FileSystem and Legacy), the ID is the file path, relative to= the binary file storage root dir (`var/<vardir>/storage/origina= l` 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
`uri`	string	The binary file's HTTP URI. If = the URI doesn't include a host or protocol, it applies to the request domai= n. The URI is not publicly readable, and must NOT be used to = link to the file for download. Use `ez_render_field` to= generate a valid link to the download controller.	/var/ezdemo_site/storage/original/= application/63cd472dd7819da7b75e8e2fee507c68.pdf
`downloadCount`	integer	Number of times the file was downl= oaded	0
`path`	string	deprecated Renamed to `id` starting from eZ Publish 5.2. Can still = be used, but it is recommended not to use it anymore as it will be removed.=

BinaryFile hash form= at

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

id
path (for backwards compatibility)
fileName
fileSize
mimeType
uri
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