A CakePHP Plugin to interact with Amazon Web Services S3 objects. This plugin provides a simple and robust methods that can be added to any CakePHP project to complete the following:
- Retrieve a remote file from an S3 bucket and save locally
- Save a local file in an S3 bucket
- Delete a file in an S3 bucket
- CakePHP 2.x
- An Amazon Web Services account (http://aws.amazon.com/s3/)
- Your AWS access key and secret key
[Composer]
required: "tabenguyen/cakephp-amazon-s3": "dev-master"
Remember to add CakePlugin::load('CakephpAmazonS3');
to your app's bootstrap file.
Then, simply initialise the plugin with your AWS Access key, secret key and the bucket name you wish to work with.
App::uses('AmazonS3', 'CakephpAmazonS3.Lib');
$AmazonS3 = new AmazonS3(array('{access key}', '{secret key}', '{bucket name}'));
The get
method retrieves a remote file and saves it locally. So let's say there is the file foo.jpg
on S3 and you want to save it locally in /home/me/stuff/photos
you'd use the following.
$AmazonS3->get('foo.jpg' , '/home/me/stuff/photos');
The put
method does the reverse of get
, and saves a local file to S3.
$AmazonS3->put('/home/me/stuff/photos/foo.jpg');
You can optionally specifiy a remote directory within the bucket to save the file in.
$AmazonS3->put('/home/me/stuff/photos/foo.jpg' , 'some/folder');
To add any additional AWS headers to a put
, example to set the file as "public", they can be passed as an array to the amazonHeaders
property.
$AmazonS3->amazonHeaders = array(
'x-amz-acl' => 'public-read',
'X-Amz-Meta-ReviewedBy' => 'john.doe@yahoo.biz'
);
$AmazonS3->put('/home/me/stuff/photos/foo.jpg' , 'some/folder');
Deletes a file from S3.
$AmazonS3->delete('foo.jpg');
Or delete from within a directory in the bucket:
$AmazonS3->delete('/some/folder/foo.jpg');