Nowadays developers are preferring Amazon S3 for file storage and there are various libraries available in PHP to facilitate the file transfer to S3. This behavior uses Amazon S3 class by Donovan Schonknecht. Before using this behavior make sure you place the S3.php file in your vendors directory.
This behavior is very similar to normal upload behavior except that the uploaded file is not kept on the server but transferred to the specified S3 bucket.
Note: This behavior requires PHP > 5.2 and cURL. Actually this is the requirement of the S3 class which this behavior uses.
Usage:
Get the behavior from Github (Direct link).
Place the s3_upload.php file in app/models/behaviors/ directory and edit the file to put your AWS access key and secret key
-
// File: s3_upload.php
-
var $__accessKey = 'set your aws access key here';
-
-
var $__secretKey = 'set your aws secret key here';
Alternately you can pass the credentials in settings when you attach the behavior to the model or use the behavior's setS3Credentials method.
-
// In Controller before calling MyModel::save()
-
$this->MyModel->setS3Credentials('access key', 'secret key');
Then to attach the behavior to your model
-
// In your model attach the S3Upload behavior
-
's3_bucket' => 'my-bucket',
-
// Acces and secret key are required if you have not put it in behavior itself
-
// or if you need different access credentials for different fields
-
's3_access_key' => 'your access key',
-
's3_secret_key' => 'your secret key',
-
// Other options as explained below
-
),
-
),
-
);
Above, only one option i.e. s3_bucket is compulsory. The other two options i.e. s3_access_key and s3_secret_key are required only if you have not set the global S3 credentials in S3UploadBehavior class. There are many other optional settings as explained below...
- formfield (string) : If the name of your form field which uploads the file is different from db fieldname
- s3_path (string): If you want your file to be placed in a (virtual) sub directory in S3 bucket
- s3_acl (string): S3 permissions - private, public-read, public-read-write or authenticated-read. Defaults to public-read
- s3_request_headers (array): Headers to be sent along with the file
- s3_meta_headers (array): Metadata to be sent
- allowed_ext (array): File extensions to be allowed.
- append_salt (bool): True to append a random salt to the filename to make it unique. Defaults to false.
- required (bool): True to make the file upload compulsory. Defaults to false.
- unique (bool): True to create unique filenames. Defaults to true.
The uploaded file will be transferred to S3 in all save operations. If updating then the old file will be deleted from S3 and new file will be uploaded.
The behavior class is simple and self explanatory. Explore the code to learn more.
I look forward to using this behavior. I have attached it to my model but when I attempt to process the form with the file the behavior returns the following:
Warning (512): S3::putObject(): [NoSuchBucket] The specified bucket does not exist [APP/vendors/S3.php, line 358]Array
(
[] => s3_upload_error
)
Any help would thrill me.
Regards,
Josey
@Josey: The error suggests that you have not specified the correct bucket name in
s3_bucketoption of$actsAsin your model. Make sure the bucket name you have specified exists.The bucket does exist, here is my call to the behavior:
var $actsAs = array(
'S3Upload' => array(
'location' => array(
's3_bucket' => 'development',
'allowed_ext' => array('rtf')
)
)
);
I created the development bucket before I attempted to use this behavior
@Josey: Try to browse the bucket using some other tool and see if it works.
@abbas: When I browse to my account using S3 Browser for Mac OSX I can view the contents without any problem but when I try to use this behavior I'm told the bucket doesn't exist.
Let me know the URL of any of the public files in your bucket.
here's a small image: https://s3.amazonaws.com/Mort_Development/OTV/cover.jpg
it should be know that i have renamed the bucket to Mort_Development and have changed the actAs accordingly.
@Josey: Don't know what's wrong with S3 but if "Mort_Development" is the bucket name then https://Mort_Development.s3.amazonaws.com/OTV/cover.jpg should work. But it gives 'No such bucket' error.
Hello
This behaviour looks great and I really want to use it. I'm getting it uploading ok and its saving but its throwing the following error:
Fatal error: Existing data passed is not an array
Called set_existing in /Users/jono/Dev/Netmums/bake/website/application/models/user.php on line 351
Called afterSave in /Users/jono/Dev/Cake/1.3.x.x/cake/libs/model/model.php on line 1364
Called save in /Users/jono/Dev/Netmums/bake/website/application/plugins/cms/controllers/users_controller.php on line 77
Called edit in on line
Called call_user_func_array in /Users/jono/Dev/Cake/1.3.x.x/cake/dispatcher.php on line 204
Called _invoke in /Users/jono/Dev/Cake/1.3.x.x/cake/dispatcher.php on line 171
Called dispatch in /Users/jono/Dev/Netmums/bake/website/application/webroot/index.php on line 83
in [path]/includes/class_dm.php on line 265
This is a CakePHP 1.3 app.
Thanks for the code.
I couldn't get it to work out the box as is on CakePHP 1.3 . I had to make quite a few modifications, would you like me to send you the code? Or should I fork it on github?
Warren, you can do either. Looking forward to it!!
Does this behavior work for CakePHP 1.3, I am really interested in using it.