When you are using the class as an object, you will need to supply your authentication parameters to the constructor
Example:
<?php
$s3 = new S3("awsAccessKey", "awsSecretKey");
print_r($s3->listBuckets());
?>When you are not using the class as an object, you will need to set your authentication parameters with setAuth()
This can also be useful when you are accessing multiple Amazon S3 accounts in an instance
Example:
<?php
// Probably only used when using the class statically or using multiple accounts
S3::setAuth("awsAccessKey", "awsSecretKey");
print_r(S3::listBuckets());
?>Copy an existing object in a bucket to a new destination
Example:
<?php
// Simple copy:
if (S3::copyObject($sourceBucket, $sourceFile, $destinationBucket, $destinationFile, S3::ACL_PRIVATE)) {
echo "Copied file";
} else {
echo "Failed to copy file";
}
?>You can also replace headers when copying an object
Example:
<?php
if (S3::copyObject($sourceBucket, $sourceFile, $destinationBucket, $destinationFile, S3::ACL_PRIVATE,
array("uid" => 1), // AMZ header; x-amz-uid
array("Content-Type" => "text/plain") // New content type
)) {
echo "Copied file";
} else {
echo "Failed to copy file";
}
?>Delete an object from a bucket
Example:
<?php
if (S3::deleteObject($bucket, $uri)) {
echo "Deleted file.";
}
?>Get an object
Example:
<?php
// Return an entire object buffer:
$object = S3::getObject($bucket, $uri));
var_dump($object);
?>Usually, the most efficient way to do this is to save the object to a file or resource
Example:
<?php
// To save it to a file (unbuffered write stream):
if (($object = S3::getObject($bucket, $uri, "/tmp/savefile.txt")) !== false) {
print_r($object);
}
// To write it to a resource (unbuffered write stream):
$fp = fopen("/tmp/savefile.txt", "wb");
if (($object = S3::getObject($bucket, $uri, $fp)) !== false) {
print_r($object);
}
?>Example:
<?php
if (($info = $s3->getObjectInfo($bucket, $uri)) !== false) {
print_r($info);
}
?>Create an input array for pubObject() with a file
Example:
<?php
$input = S3::inputFile($file);
if (S3::putObject($input, $bucket, $uri, S3::ACL_PUBLIC_READ)) {
echo "File uploaded.";
} else {
echo "Failed to upload file.";
}
?>Create an input array for pubObject() with a resource
Example:
<?php
$file = "file.txt";
$input = $s3->inputResource(fopen($file, "rb"), filesize($file));
if (S3::putObject($input, $bucket, $uri, S3::ACL_PUBLIC_READ)) {
echo "File uploaded.";
} else {
echo "Failed to upload file.";
}
?>Put an object
The $input parameter can either be a string, or an array of input info from S3::inputFile() or S3::inputResource()
Example:
<?php
// Simple PUT:
if (S3::putObject(S3::inputFile($file), $bucket, $uri, S3::ACL_PRIVATE)) {
echo "File uploaded.";
} else {
echo "Failed to upload file.";
}
?>Example:
<?php
// PUT with custom headers:
$put = S3::putObject(
S3::inputFile($file),
$bucket,
$uri,
S3::ACL_PUBLIC_READ,
array(),
array( // Custom $requestHeaders
"Cache-Control" => "max-age=315360000",
"Expires" => gmdate("D, d M Y H:i:s T", strtotime("+5 years"))
)
);
var_dump($put);
?>Create an authenticated URL to a private object
It can also be used to generate links containing a bucket CNAME host
Example:
<?php
// Simple authenticated URL:
echo S3::getAuthenticatedURL($bucket, $uri, 3600);
// HTTPS authenticated URL:
echo S3::getAuthenticatedURL($bucket, $uri, 3600, false, true);
// Using your own bucket CNAME:
echo S3::getAuthenticatedURL("s3bucket.mydomain.com", $uri, 3600, true);
?>Retrieve a list of buckets for the AWS account
Example:
<?php
// Standard list:
print_r(S3::listBuckets());
// Detailed list:
print_r(S3::listBuckets(true));
?>Retrieve the contents for a bucket
Example:
<?php
if (($contents = $s3->getBucket($bucketName)) !== false) {
foreach ($contents as $object) {
print_r($object);
}
}
?>Create a bucket
Example:
<?php
// Create a bucket
if (S3::putBucket($bucket, S3::ACL_PRIVATE)) {
echo "Created bucket.";
}
// Create an EU-hosted bucket:
var_dump(S3::putBucket($bucket, S3::ACL_PUBLIC_READ, "EU"));
?>Delete an empty bucket
If a bucket is not empty, the request will return false
Example:
<?php
if (S3::deleteBucket("bucket")) {
echo "Deleted bucket";
}
?>Get a bucket's location
Returns 'EU' or 'US' depending on where the bucket is hosted
Example:
<?php
if (($location = S3::getBucketLocation($bucket)) !== false) {
echo "Bucket location: {$location}";
}
?>Get logging information for a bucket
Returns false if logging is not enabled
Example:
<?php
if (($logging = S3::getBucketLogging($bucket)) !== false) {
echo "Logging enabled!";
print_r($logging);
} else {
echo "Logging is not enabled for this bucket.";
}
?>Set logging for a bucket with target log bucket
Example:
<?php
S3::setBucketLogging($bucket, "mylogbucket", "prefix");
?>Disable bucket logging
Example:
<?php
S3::disableBucketLogging($bucket);
?>Generate upload parameters for browser-based HTTP POST uploads - read more about it here
Example:
<?php
S3::setAuth(awsAccessKey, awsSecretKey);
$bucket = "upload-bucket";
$path = "myfiles/"; // Can be empty ""
$lifetime = 3600; // Period for which the parameters are valid
$maxFileSize = (1024 * 1024 * 50); // 50 MB
$metaHeaders = array("uid" => 123);
$requestHeaders = array(
"Content-Type" => "application/octet-stream",
"Content-Disposition" => 'attachment; filename=${filename}'
);
$params = S3::getHttpUploadPostParams(
$bucket,
$path,
S3::ACL_PUBLIC_READ,
$lifetime,
$maxFileSize,
201, // Or a URL to redirect to on success
$metaHeaders,
$requestHeaders,
false // False since we're not using flash
);
$uploadURL = "https://{$bucket}.s3.amazonaws.com/";
?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>S3 Form Upload</title>
</head>
<body>
<form method="post" action="<?php echo $uploadURL; ?>" enctype="multipart/form-data">
<?php
foreach ($params as $p => $v)
echo " <input type=\"hidden\" name=\"{$p}\" value=\"{$v}\" />\n";
?>
<input type="file" name="file" /> <input type="submit" value="Upload" />
</form>
</body>
</html>Get the access control policy for an object or a bucket when $uri = ''
Returns an array with an access control list
Example:
<?php
if (($acp = S3::getAccessControlPolicy($bucket, $uri)) !== false) {
print_r($acp);
}
?>Set the access control policy for an object or a bucket when $uri = ''
Example:
<?php
if (($acp = S3::getAccessControlPolicy($bucket, $uri)) !== false) {
// Here you would modify the $acp array...
// For example, grant access to the S3 LogDelivery system:
$acp["acl"][] = array(
"type" => "Group", "uri" => "http://acs.amazonaws.com/groups/s3/LogDelivery", "permission" => "WRITE"
);
$acp["acl"][] = array(
"type" => "Group", "uri" => "http://acs.amazonaws.com/groups/s3/LogDelivery", "permission" => "READ_ACP"
);
// Then update the policy using the modified $acp array:
if (S3::setAccessControlPolicy($bucket, $uri, $acp)) {
echo "Policy updated";
}
}
?>Get a list of CloudFront distributions
Example:
<?php
if (($dists = S3::listDistributions()) !== false) {
if (sizeof($dists) == 0) echo "There are no distributions";
foreach ($dists as $dist) {
print_r($dist);
}
} else {
echo "Failed to get distribution list";
}
?>Create a CloudFront distribution from a bucket
Example:
<?php
$cnames = array("cdn.mysite.com"); // Array of CNAMES for the distribution
if (($dist = S3::createDistribution($bucket, true, $cnames, "New distribution created")) !== false) {
echo "Distribution created";
print_r($dist);
} else {
echo "Failed to create distribution";
}
?>Get information for a CloudFront distribution
Example:
<?php
$distributionId = "E4S5USZY109S8"; // Obtained from listDistributions
if (($dist = S3::getDistribution($distributionId)) !== false) {
print_r($dist);
} else {
echo "Failed to get distribution information";
}
?>Update a CloudFront distribution
Example:
<?php
$distributionId = "E4S5USZY109S8"; // Obtained from listDistributions
$cnames = array("cdn.mysite.com"); // Array of CNAMES for the distribution
// To enable/disable a distribution configuration:
if (($dist = S3::getDistribution($distributionId)) !== false) {
$dist["enabled"] = $enabled;
$dist["comment"] = $enabled ? "Enabled" : "Disabled";
if (!isset($dist["cnames"])) $dist["cnames"] = array();
foreach ($cnames as $cname) $dist["cnames"][$cname] = $cname;
var_dump(S3::updateDistribution($dist));
} else {
echo "Failed to get distribution information for update";
}
?>Delete a CloudFront distribution
Example:
<?php
$distributionId = "E4S5USZY109S8"; // Obtained from listDistributions
// To delete a distribution configuration you must first set enable=false with
// the updateDistrubution() method and wait for status=Deployed:
if (($dist = S3::getDistribution($distributionId)) !== false) {
if ($dist["status"] == "Deployed") {
var_dump(S3::deleteDistribution($dist));
} else {
echo "Distribution not ready for deletion (status is not 'Deployed')";
var_dump($dist);
}
}
?>For assistance with this class, visit the project homepage
If you think you have found a bug, please create a ticket
If you feel like supporting free app development, give a gift or make a donation with PayPal:
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.