README

If you're upgrading from CakePHP 2.x please read the migration guide.

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

Storage adapters are an 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.

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 or ImageStorage 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.

List of supported Adapters

Apc
Amazon S3
ACL Aware Amazon S3
Azure
Doctrine DBAL
Dropbox
Ftp
Grid FS
In Memory
Local File System
MogileFS
Open Cloud
Rackspace Cloudfiles
Sftp
Zip File

Supported CakePHP Versions

CakePHP 4.x -> 3.0 Branch
CakePHP 3.x -> 2.0 Branch
CakePHP 2.x -> 1.0 Branch

Requirements

PHP 7.2+
CakePHP 4.x
Gaufrette Storage Library 0.7.x

Optional but required if you want image processing out of the box:

The Imagine Image processing plugin if you want to process and store images.
FlySystem as alternative library over Gaufrette

You can still implement whatever file processing you want very easy. It's not tied to Imagine.

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 send to the branch that reflects the version you want to contribute to.
Unit tests are required.

License

Licensed under The MIT License Redistributions of files must retain the above copyright notice.

burzum / file-storage

Maintainers

Details