This Field Type represents 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 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 storing legacy document types such as PDF files, Word documents, spreadsheets, etc. The maximum allowed file size is determined by the "Max file size" class attribute edit parameter and the "upload_max_filesize" directive in the main PHP configuration file ("php.ini").
BinaryFile Value Object API
eZ\Publish\Core\FieldType\BinaryFile\Value offers the following properties.
Note that both BinaryFile and Media Value and Type inherit from the BinaryBase abstract Field Type, and share common properties.
Attribute
Type
Description
Example
id
string
Binary file identifier. This ID depends on the IO Handler that is being used. With the native, default handlers (FileSystem and Legacy), the ID is the file path, relative to the binary file storage root dir (var/<vardir>/storage/original by default).
application/63cd472dd7819da7b75e8e2fee507c68.pdf
fileName
string
The human readable file name, as exposed to the outside. Used when sending the file for download in order to name the file.
20130116_whitepaper_ezpublish5 light.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 domain.
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.
