dereuromark/cakephp-file-storage

This plugin is giving you the possibility to store files in virtually any kind of storage backend. This plugin is wrapping the Gaufrette library (https://github.com/KnpLabs/Gaufrette) library in a CakePHP fashion and provides a simple way to use the storage adapters through the StorageManager class.

4.0.0-RC 2024-03-11 16:16 UTC

Requires

• php: >=8.1
• brick/varexporter: ^0.3.5 || ^0.4.0
• cakephp/cakephp: ^5.0.1
• php-collective/file-storage: dev-master as 1.0.0

Requires (Dev)

• php-collective/code-sniffer: ^0.2.1
• php-collective/file-storage-image-processor: dev-master as 1.0.0
• phpunit/phpunit: ^10.2

Suggests

• php-collective/file-storage-image-processor: Required if you want to use the image processing feature of FileStorage

MIT

• Mark Scherer
• Other contributors

• media
• file
• filesystem
• abstraction
• storage
• upload
• cakephp

README

The FileStorage plugin is giving you the possibility to upload and store files in virtually any kind of storage backend. The plugin features the FlySystem library in a CakePHP fashion and provides a simple way to use the storage adapters.

Storage adapters are a unified interface that allow you to store file data to your local file system, in memory, in a database or into a zip file and remote systems. There is a database table keeping track of what you stored where. You can always write your own adapter or extend and overload existing ones.

This branch is for use with CakePHP 5.0+. See version map for details.

How it works

The whole plugin is build with clear Separation of Concerns (SoC) in mind: A file is always an entry in the file_storage table from the app perspective. The table is the reference to the real place of where the file is stored and keeps some meta information like mime type, filename, file hash (optional) and size as well. Storing the path to a file inside an arbitrary table along other data is considered as bad practice because it doesn't respect SoC from an architecture perspective but many people do it this way for some reason.

You associate the file_storage table with your model using the FileStorage model from the plugin via hasOne, hasMany or HABTM. When you upload a file you save it to the FileStorage model through the associations, Documents.file for example. The FileStorage model dispatches then file storage specific events, the listeners listening to these events process the file and put it in the configured storage backend using adapters for different backends and build the storage path using a path builder class.

Documentation

For documentation, as well as tutorials, see the docs directory of this repository.

Support

For bugs and feature requests, please use the issues section of this repository.

Contributing

To contribute to this plugin please follow a few basic rules.

• Pull requests must be sent to the branch that reflects the version you want to contribute to.
• Unit tests are required.