Improve this Doc

Storage Controller

Todo

UNDER CONSTRUCTION

Todo

UNDER CONSTRUCTION

Todo

UNDER CONSTRUCTION

Binary files such as images are not normally stored inside a regular database. Instead they need to be stored in a 3rd party file storage service such as Amazon S3 or Dropbox. Agile Toolkit supports multiple 3rd party storages:

  • setStorage('Filestore', $dir); - store files on a filesystem
  • setStorage('S3', $bucket); - store files in Amazon S3 (and Cloudfront)
  • setStorage('Dropbox', ...); - store files in Dropbox

Agile Toolkit contains several UI widgets that allow you to operate with files: upload, work with images, categorize or associate files with other data. Those widgets can work with any 3rd party storage system which implements a proper storage controller.

Usage Example

The most basic way to use storage controller is to associate it with Model_File model:

$f = $this->add('Model_File');
$f->setStorage('S3');

$f->upload($my_file_path);

The above code will upload the file located at $my_file_path and store it as object inside Amazon S3. The other information about the file such as filename, type, size and check-sum will be stored in your regular database called my-files.

Once uploaded, the Model_File will represent your actual file inside Agile Toolkit, you can search for files directly by name, type or through associations.

Components of File Storage System

There are 3 parts at play when you operate with the files.

  1. File Model - Either instance of Model_File or descendant.
  2. Controller_Storage - Link between model and the actuall implementation.
  3. 3rd Party add-on. Typically a minimalistic SDK supplied by storage engine vendor.

The #3 is optional and use of existing 3rd party class would greatly simplify implementation of Controller_Storage.

Model_File implementation

class Model_File

Describes a physical file and it’s properties.

The model is defining the following fields:

To access meta properties use:

$file->ref('meta')['size'];

or to perform search by a meta-property:

$file->addCondition('meta.size', '>', 1000000);

Note

Sub-model conditions are only supported for Databases that are capable of storing and indexing hierarchic data, e.g. Clusterpoint, Mongo.

Model_File::import($file)

Import and store specified file.

Model_File::verify()

Will download file from public URL and verify md5.

Model_File::getFile()

Retrive file, store locally in a temproary location and return full path.

class Controller_Storage

Controller for abstraction of 3rd party file storage systems. If you need to store files with another file storage service, you might need to create your own controller. The following methods will have to be implemented.

Controller_Storage::put($model, $source_file)

Store specified file and update $model fields (location, storage, url)

Controller_Storage::get($model)

Load model corresponding to a specified model and return filename.

Controller_Storage::delete($model)

Delete file object corresponding to the model.