Deletes an Amazon S3 object from the specified bucket.
Access
public
Parameters
Parameter |
Type |
Required |
Description |
---|---|---|---|
|
Required |
The name of the bucket to use. |
|
|
Required |
The file name for the object. |
|
|
Optional |
An associative array of parameters that can have the following keys:
|
Returns
Type |
Description |
---|---|
A |
Examples
Delete an object.
// Instantiate the class $s3 = new AmazonS3(); $bucket = 'my-bucket' . strtolower($s3->key); $response = $s3->delete_object($bucket, 'prefix with spaces/åéîøü/åéîøü/åéîøü with spaces.txt'); // Success? var_dump($response->isOK());Result:
bool(true)
Delete a specific version of an object.
// Instantiate the class $s3 = new AmazonS3(); $bucket = 'my-bucket' . strtolower($s3->key); // Delete a specific version $response = $s3->delete_object($bucket, 'test1.txt', array( 'versionId' => '0NNAq8PwvXvg8EfAYG9sSmwKTZeixZgZNE6PbodG8td0DJ3gVOmjI2Gh/oFnb0Ie=' )); // Success? var_dump($response->isOK()); var_dump(strpos((string) $response->header['_info']['url'], 'versionId=' . $version_id) !== false);Result:
bool(true) bool(true)
Delete a specific version of an object from an MFA-protected bucket.
// Instantiate the class $s3 = new AmazonS3(); $response = $s3->delete_object('my-bucket', 'test1.txt', array( 'versionId' => '0NNAq8PwvXvg8EfAYG9sSmwKTZeixZgZNE6PbodG8td0DJ3gVOmjI2Gh/oFnb0Ie=', 'MFASerial' => CFCredentials::get()->mfa_serial, // Custom property in the config file. 'MFAToken' => '12345678' )); // Success? var_dump($response->isOK()); var_dump(strpos((string) $response->header['_info']['url'], 'versionId=' . $version_id) !== false);Result:
bool(true) bool(true)
See Also
Source
Method defined in services/s3.class.php | Toggle source view (20 lines) | View on GitHub