Documentation

ZendService\Amazon

Amazon S3 provides a simple web services interface that can be used to store and retrieve any amount of data, at
any time, from anywhere on the web. It gives any developer access to the same highly scalable, reliable, fast,
inexpensive data storage infrastructure that Amazon uses to run its own global network of web sites. The service
aims to maximize benefits of scale and to pass those benefits on to developers.

The ZendService\Amazon\S3 class provides the PHP wrapper to the Amazon S3 REST interface. Please consult the
Amazon S3 documentation for detailed description of the service. You will need to be familiar with basic
concepts in order to use this service.

Once you have registered with Amazon S3, you’re ready to store your first data object on the S3. The objects on S3
are stored in containers, called “buckets”. Bucket names are unique on S3, and each user can have no more than 100
buckets simultaneously. Each bucket can contain unlimited amount of objects, identified by name.

The following example demonstrates creating a bucket, storing and retrieving the data.

Since ZendService\Amazon\S3 service requires authentication, you should pass your credentials (AWS key and
secret key) to the constructor. If you only use one account, you can set default credentials for the service:

All objects in S3 system are stored in buckets. Bucket has to be created before any storage operation. Bucket name
is unique in the system, so you can not have bucket named the same as someone else’s bucket.

Bucket name can contain lowercase letters, digits, periods (.), underscores (_), and dashes (-). No other symbols
allowed. Bucket name should start with letter or digit, and be 3 to 255 characters long. Names looking like an IP
address (e.g. “192.168.16.255”) are not allowed.

createBucket() creates a new bucket.

cleanBucket() removes all objects that are contained in a bucket.

removeBucket() removes the bucket from the system. The bucket should be empty to be removed.

The object is the basic storage unit in S3. Object stores unstructured data, which can be any size up to 4
gigabytes. There’s no limit on how many objects can be stored on the system.

The object are contained in buckets. Object is identified by name, which can be any utf-8 string. It is common to
use hierarchical names (such as Pictures/Myself/CodingInPHP.jpg) to organise object names. Object name is
prefixed with bucket name when using object functions, so for object “mydata” in bucket “my-own-bucket” the name
would be my-own-bucket/mydata.

Objects can be replaced (by rewriting new data with the same key) or deleted, but not modified, appended, etc.
Object is always stored whole.

By default, all objects are private and can be accessed only by their owner. However, it is possible to specify
object with public access, in which case it will be available through the URL:
http://s3.amazonaws.com/[bucket-name]/[object-name].

putObject($object,$data,$meta) created an object with name $object (should contain the bucket name as
prefix!) having $data as its content.

Optional $meta parameter is the array of metadata, which currently supports the following parameters as keys:

S3_CONTENT_TYPE_HEADER

MIME content type of the data. If not specified, the type will be guessed according to the file extension of
the object name.

S3_ACL_HEADER

The access to the item. Following access constants can be used:

S3_ACL_PRIVATE

Only the owner has access to the item.

S3_ACL_PUBLIC_READ

Anybody can read the object, but only owner can write. This is setting may be used to store publicly
accessible content.

S3_ACL_PUBLIC_WRITE

Anybody can read or write the object. This policy is rarely useful.

S3_ACL_AUTH_READ

Only the owner has write access to the item, and other authenticated S3 users have read access. This is
useful for sharing data between S3 accounts without exposing them to the public.

By default, all the items are private.

ZendServiceAmazonS3 Public Object Example

1
2
3
4
5
6
7
8
9
10

$s3=newZendService\Amazon\S3($my_aws_key,$my_aws_secret_key);$s3->putObject("my-own-bucket/Pictures/Me.png",file_get_contents("me.png"),array(ZendService\Amazon\S3::S3_ACL_HEADER=>ZendService\Amazon\S3::S3_ACL_PUBLIC_READ));// or:$s3->putFile("me.png","my-own-bucket/Pictures/Me.png",array(ZendService\Amazon\S3::S3_ACL_HEADER=>ZendService\Amazon\S3::S3_ACL_PUBLIC_READ));echo"Go to http://s3.amazonaws.com/my-own-bucket/Pictures/Me.png to see me!\n";

getObject($object) retrieves object data from the storage by name.

removeObject($object) removes the object from the storage.

getInfo($object) retrieves the metadata information about the object. The function will return array with
metadata information. Some of the useful keys are:

type

The MIME type of the item.

size

The size of the object data.

mtime

UNIX-type timestamp of the last modification for the object.

etag

The ETag of the data, which is the MD5 hash of the data, surrounded by quotes (”).

The function will return FALSE if the key does not correspond to any existing object.

getObjectsByBucket($bucket) returns the list of the object keys, contained in the bucket.

It is possible to get and put objects using not stream data held in memory but files or PHP streams. This is
especially useful when file sizes are large in order not to overcome memory limits.

To receive object using streaming, use method getObjectStream($object,$filename). This method will return
Zend\Http\Response\Stream, which can be used as described in HTTP Client Data Streaming section.

Directory operations (mkdir, rmdir, opendir, etc.) will operate on buckets and thus their arguments should be
of the form of s3://bucketname. File operations operate on objects. Object creation, reading, writing, deletion,
stat and directory listing is supported.