File management¶
Access binary files¶
To access binary files from the PHP API, use the Ibexa\Core\IO\IOServiceInterface::loadBinaryFile() method:
1 2 3 4 5 6 | |
Handling binary files¶
Ibexa DXP supports multiple binary file handling mechanisms by means of an IOHandler interface. This feature is used by the BinaryFile field types.
Native IO handler¶
The IO API is organized around two types of handlers, both used by the IOService:
Ibexa\Core\IO\IOMetadataHandler: stores and reads metadata (such as validity or size)Ibexa\Core\IO\IOBinarydataHandler: stores and reads the actual binary data
You can configure IO handlers using semantic configuration. IO handlers are configurable per SiteAccess. See the default configuration:
1 2 3 4 5 6 | |
The adapter is the driver used by Flysystem to read/write files.
You declare adapters with oneup_flysystem.
Metadata and binary data handlers are configured under ibexa_io.
For the configuration of the default handlers, see below.
The configuration declares a metadata handler and a binary data handler, both labeled default.
Both handlers are of type flysystem, and use the same Flysystem adapter, labeled default as well.
Flysystem version
Ibexa DXP 5.0 requires PHP 8.3 or later, therefore, as of v.5.0.11, league/flysystem installs as 3.36 or later by default.
However, Flysystem 2.5 is also supported to provide backward compatibility.
Take the following into account:
-
If you use a custom adapter, make sure that the class that implements
League\Flysystem\FilesystemAdapteralso implementsdirectoryExists(string $path): bool, which Flysystem 3.x requires. Otherwise, Flysystem throws a fatal error. -
If you use Flysystem's
localadapter type as an IO handler, it only acceptsmimeTypeDetectoras a string, so a detector service can't be configured through it directly. Flysystem 3.x's default detector returns no MIME type for ambiguous files, such as extensionless text or empty files, which can cause downloads to fail. To preserve the previous behavior, define your own service forLeague\Flysystem\Local\LocalFilesystemAdapterwith$mimeTypeDetectorset toLeague\MimeTypeDetection\FinfoMimeTypeDetector, then configure it as acustomadapter pointing to that service instead oflocal. Ibexa DXP's own adapters already do this.
1 2 3 4 5 6 7 8 9 | |
The nfs_adapter's directory is based on your site settings, and is automatically set to $var_dir$/$storage_dir$ (for example, /path/to/ibexa/public/var/site/storage).
Permissions of generated files¶
You can configure permissions of generated files under the ibexa.system.<scope>.io.permissions configuration key.
1 2 3 4 5 6 7 | |
Both files and directories are optional.
Default values:
- 0644 for files
- 0755 for directories
Note
Make sure to configure permissions using a number and not a string. "0644" is not interpreted by PHP as an octal number, and unexpected permissions can be applied.
Note
As SiteAccess configuration Flysystem's v2 native Local NFS adapter isn't supported, the following configuration should be used:
1 2 3 4 5 | |
Native Flysystem handler¶
Ibexa DXP uses it as the default way to read and write content in form of binary files.
Flysystem can use the local filesystem, but is also able to read/write to sftp, zip or cloud filesystems (azure, rackspace, S3).
league/flysystem (along with FlysystemBundle) is an abstract file handling library.
Handler options¶
Adapter¶
To be able to rely on dynamic SiteAccess-aware paths, you need to use Ibexa custom nfs_adapter.
A basic configuration might look like the following:
1 2 3 4 5 | |
To learn how to configure other adapters, see the bundle's online documentation.
Note
Only the adapters are used here, not the filesystem configuration described in this documentation.
DFS Cluster handler¶
For clustering, the platform provides a custom metadata handler that stores metadata about your assets in the database. This is faster than accessing the remote NFS or S3 instance to read metadata.
For more information, see Clustering.