Abstract file storage and upload plugin for CakePHP. Write to local disk, FTP, S3, Dropbox and more through a single interface. It's not just yet another uploader but a complete storage solution.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
docs minor typo May 18, 2018
src Fixed deprecations Jul 27, 2018
tests Marked tests without assertion as incomplete Jul 27, 2018
.editorconfig
.gitignore
.scrutinizer.yml CI config Nov 24, 2017
.travis.yml Stop testing on PHP 5.6 as we bumped the minimum version to 7.0.0 Sep 6, 2018
LICENSE.txt
README.md
composer.json Update knplabs/gaufrette from v0.6.0 to v0.7.0 Sep 6, 2018
composer.lock Update composer.lock Sep 6, 2018
phpcs.xml phpcs fixes Jul 31, 2017
phpunit.xml.dist Working on the tests Dec 15, 2016

README.md

FileStorage Plugin for CakePHP

Software License Build Status Coverage Status Code Quality

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

Requirements

  • PHP 7.0+
  • CakePHP 3.6
  • Gaufrette Storage Library 0.7.x

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

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.

License

Copyright 2012 - 2018, Florian Krämer

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