Storage

Complex applications require complex storage stacks.

For example, you may need to store media uploaded to an S3 instance while fetching data from an SFTP folder or so.

The Storage layer bundled with Aurora helps in these scenarios by bringing a consolidated abstract interface for any storage type through adapters tailored to each service or platform.

Bundled with the base framework is a LocalAdapter class that abstracts the local file system and allows you to read and write files on disk using the native PHP file functions.

You can create any adapter should you need to integrate other platforms and services, like Amazon S3, Dropbox, etc.

Using the storage layer

As easy as creating an adapter instance and then using it to get a Storage object:

use Aurora\Storage\Adapter\LocalAdapter;
use Aurora\Storage\Storage;

...

$adapter = new LocalAdapter( base_dir('/storage') );
$storage = new Storage($adapter);
if ( $storage->exists('quotes.json') ) {
    $quotes = json_decode( $storage->read('quotes.json') );
}

Reading is done with the read method and is straightforward.

If you want to write, use the write method:

$storage->write('file.txt', $data); # Where data would be the file contents

Also you can check is a file exists with the exists method as seen in the example above.

Each storage adapter can have different arguments in its constructor, for example:

use App\Storage\Adapter\S3Adapter;
use Aurora\Storage\Storage;

...

$params = [
    'bucket' = settings()->get('s3.bucket'),
    'region' = settings()->get('s3.region'),
    'access_key' = settings()->get('s3.access_key'),
    'secret_key' = settings()->get('s3.secret_key')
];
$adapter = new S3Adapter($params);
$storage = new Storage($adapter);

Next up, the Events.