AmazonS3 Class

Properties   Methods   Events   Config Settings   Errors  

The AmazonS3 class provides an easy way to interface with Amazon's Simple Storage Service (S3).

Class Name

CloudStorage_AmazonS3

Procedural Interface

 cloudstorage_amazons3_open();
 cloudstorage_amazons3_close($res);
 cloudstorage_amazons3_register_callback($res, $id, $function);
 cloudstorage_amazons3_get_last_error($res);
 cloudstorage_amazons3_get_last_error_code($res);
 cloudstorage_amazons3_set($res, $id, $index, $value);
 cloudstorage_amazons3_get($res, $id, $index);
 cloudstorage_amazons3_do_abortmultipartupload($res, $objectname, $uploadid);
 cloudstorage_amazons3_do_addmetadata($res, $name, $value);
 cloudstorage_amazons3_do_addqueryparam($res, $name, $value);
 cloudstorage_amazons3_do_appendobject($res, $objectname);
 cloudstorage_amazons3_do_bucketexists($res);
 cloudstorage_amazons3_do_checkversioningenabled($res);
 cloudstorage_amazons3_do_completemultipartupload($res, $objectname, $uploadid);
 cloudstorage_amazons3_do_config($res, $configurationstring);
 cloudstorage_amazons3_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname);
 cloudstorage_amazons3_do_copypart($res, $srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid);
 cloudstorage_amazons3_do_createbucket($res);
 cloudstorage_amazons3_do_createobject($res, $objectname);
 cloudstorage_amazons3_do_deletebucket($res);
 cloudstorage_amazons3_do_deleteobject($res, $objectname);
 cloudstorage_amazons3_do_disableversioning($res);
 cloudstorage_amazons3_do_doevents($res);
 cloudstorage_amazons3_do_enableversioning($res);
 cloudstorage_amazons3_do_getbucketlocation($res);
 cloudstorage_amazons3_do_getlink($res, $objectname, $expires);
 cloudstorage_amazons3_do_getobject($res, $objectname);
 cloudstorage_amazons3_do_getobjectinfo($res, $objectname);
 cloudstorage_amazons3_do_gettorrent($res, $objectname);
 cloudstorage_amazons3_do_interrupt($res);
 cloudstorage_amazons3_do_listbuckets($res);
 cloudstorage_amazons3_do_listmultipartuploads($res);
 cloudstorage_amazons3_do_listobjects($res);
 cloudstorage_amazons3_do_listparts($res, $objectname, $uploadid);
 cloudstorage_amazons3_do_listversions($res);
 cloudstorage_amazons3_do_reset($res);
 cloudstorage_amazons3_do_resetheaders($res);
 cloudstorage_amazons3_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody);
 cloudstorage_amazons3_do_startmultipartupload($res, $objectname);
 cloudstorage_amazons3_do_updatebucketacl($res);
 cloudstorage_amazons3_do_updateobjectacl($res, $objectname);
 cloudstorage_amazons3_do_uploadpart($res, $objectname, $partnumber, $uploadid);

Remarks

The AmazonS3 class allows you to access Amazon's Simple Storage Service (S3) in a secure manner using TLS/SSL. S3 allows you to store arbitrary data objects on Amazon's server and access them from anywhere using an Internet connection. There are features available to authenticate access to private objects, share objects as public, distribute an object using Bittorrent etc. A brief synopsis follows but please refer to Amazon S3 documentation for details.

You will first need to sign up for the S3 service and obtain the AccessKey and SecretKey from Amazon. Then you can start creating buckets in your account using CreateBucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using CreateObject.

There are other methods such as ListBuckets, ListObjects, GetObject, GetLink, DeleteObject etc. that further enable you to manage your S3 data store.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

AccessKey Property (CloudStorage_AmazonS3 Class)

The access key to use for authentication.

Object Oriented Interface

public function getAccessKey();


public function setAccessKey($value);

Procedural Interface

cloudstorage_amazons3_get($res, 1 );


cloudstorage_amazons3_set($res, 1, $value );

Default Value

''

Remarks

This property specifies the access key that should be used for authentication. Both this property and SecretKey must be set before attempting any operations which connect to the server.

Data Type

String

AccessPolicy Property (CloudStorage_AmazonS3 Class)

The canned access policy to apply to a bucket or object.

Object Oriented Interface

public function getAccessPolicy();


public function setAccessPolicy($value);

Procedural Interface

cloudstorage_amazons3_get($res, 2 );


cloudstorage_amazons3_set($res, 2, $value );

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• CopyObject (for the destination object)
• CreateBucket
• CreateObject
• StartMultipartUpload
• UpdateBucketACL
• UpdateObjectACL

Valid values are:

Data Type

Integer

Bucket Property (CloudStorage_AmazonS3 Class)

Selects a bucket.

Object Oriented Interface

public function getBucket();


public function setBucket($value);

Procedural Interface

cloudstorage_amazons3_get($res, 3 );


cloudstorage_amazons3_set($res, 3, $value );

Default Value

''

Remarks

This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.

Data Type

String

BucketsCount Property (CloudStorage_AmazonS3 Class)

The number of records in the Buckets arrays.

Object Oriented Interface

public function getBucketsCount();

Procedural Interface

cloudstorage_amazons3_get($res, 4 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BucketsCreationDate
• BucketsName
• BucketsOwnerDisplayName
• BucketsOwnerId

The array indices start at 0 and end at BucketsCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

BucketsCreationDate Property (CloudStorage_AmazonS3 Class)

The property includes the creation date of the bucket.

Object Oriented Interface

public function getBucketsCreationDate($bucketsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 5 , $bucketsindex);

Default Value

''

Remarks

The property includes the creation date of the bucket.

This property reflects the creation date of the bucket.

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

BucketsName Property (CloudStorage_AmazonS3 Class)

The property contains the name of the bucket.

Object Oriented Interface

public function getBucketsName($bucketsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 6 , $bucketsindex);

Default Value

''

Remarks

The property contains the name of the bucket.

This property reflects the name of the bucket.

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

BucketsOwnerDisplayName Property (CloudStorage_AmazonS3 Class)

The property contains the display name of the bucket's owner.

Object Oriented Interface

public function getBucketsOwnerDisplayName($bucketsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 7 , $bucketsindex);

Default Value

''

Remarks

The property contains the display name of the bucket's owner.

This property reflects the display name of the bucket's owner.

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

BucketsOwnerId Property (CloudStorage_AmazonS3 Class)

The property contains the Id of the bucket's owner.

Object Oriented Interface

public function getBucketsOwnerId($bucketsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 8 , $bucketsindex);

Default Value

''

Remarks

The property contains the Id of the bucket's owner.

This property reflects the Id of the bucket's owner.

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

ContentDisposition Property (CloudStorage_AmazonS3 Class)

Content disposition to send for an object.

Object Oriented Interface

public function getContentDisposition();


public function setContentDisposition($value);

Procedural Interface

cloudstorage_amazons3_get($res, 9 );


cloudstorage_amazons3_set($res, 9, $value );

Default Value

''

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.

This property is not available at design time.

Data Type

String

ContentType Property (CloudStorage_AmazonS3 Class)

Content type to send for an object.

Object Oriented Interface

public function getContentType();


public function setContentType($value);

Procedural Interface

cloudstorage_amazons3_get($res, 10 );


cloudstorage_amazons3_set($res, 10, $value );

Default Value

''

Remarks

This property can be set before calling CreateObject to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (CloudStorage_AmazonS3 Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_amazons3_get($res, 11 );


cloudstorage_amazons3_set($res, 11, $value );

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

Data Type

Integer

EncryptionPassword Property (CloudStorage_AmazonS3 Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();


public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_amazons3_get($res, 12 );


cloudstorage_amazons3_set($res, 12, $value );

Default Value

''

Remarks

If this property is populated when UploadFile or DownloadFile is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudStorage_AmazonS3 Class)

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_amazons3_get($res, 13 );


cloudstorage_amazons3_set($res, 13, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (CloudStorage_AmazonS3 Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

cloudstorage_amazons3_get($res, 14 );


cloudstorage_amazons3_set($res, 14, $value );

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (CloudStorage_AmazonS3 Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

cloudstorage_amazons3_get($res, 15 );


cloudstorage_amazons3_set($res, 15, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (CloudStorage_AmazonS3 Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

cloudstorage_amazons3_get($res, 16 );


cloudstorage_amazons3_set($res, 16, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_AmazonS3 Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

cloudstorage_amazons3_get($res, 17 );


cloudstorage_amazons3_set($res, 17, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (CloudStorage_AmazonS3 Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

cloudstorage_amazons3_get($res, 18 );


cloudstorage_amazons3_set($res, 18, $value );

Default Value

''

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

FollowRedirects Property (CloudStorage_AmazonS3 Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();


public function setFollowRedirects($value);

Procedural Interface

cloudstorage_amazons3_get($res, 19 );


cloudstorage_amazons3_set($res, 19, $value );

Default Value

0

Remarks

This property specifies how the class should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:

Data Type

Integer

Idle Property (CloudStorage_AmazonS3 Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_amazons3_get($res, 20 );

Default Value

true

Remarks

Idle will be False if the component is currently busy (communicating and/or waiting for an answer), and True at all other times.

This property is read-only.

Data Type

Boolean

LocalFile Property (CloudStorage_AmazonS3 Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

cloudstorage_amazons3_get($res, 21 );


cloudstorage_amazons3_set($res, 21, $value );

Default Value

''

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

Data Type

String

LocalHost Property (CloudStorage_AmazonS3 Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

cloudstorage_amazons3_get($res, 22 );


cloudstorage_amazons3_set($res, 22, $value );

Default Value

''

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MetadataCount Property (CloudStorage_AmazonS3 Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();


public function setMetadataCount($value);

Procedural Interface

cloudstorage_amazons3_get($res, 23 );


cloudstorage_amazons3_set($res, 23, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

The array indices start at 0 and end at MetadataCount - 1.

This property is not available at design time.

Data Type

Integer

MetadataName Property (CloudStorage_AmazonS3 Class)

The property contains the name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);


public function setMetadataName($metadataindex, $value);

Procedural Interface

cloudstorage_amazons3_get($res, 24 , $metadataindex);


cloudstorage_amazons3_set($res, 24, $value , $metadataindex);

Default Value

''

Remarks

The property contains the name of the metadata item.

This property specifies the name of the metadata item. The server stores metadata names in lowercase.

Note: The class will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated.

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

MetadataValue Property (CloudStorage_AmazonS3 Class)

This property contains the value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);


public function setMetadataValue($metadataindex, $value);

Procedural Interface

cloudstorage_amazons3_get($res, 25 , $metadataindex);


cloudstorage_amazons3_set($res, 25, $value , $metadataindex);

Default Value

''

Remarks

This property contains the value of the metadata item.

This property specifies the value of the metadata item.

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

ObjectData Property (CloudStorage_AmazonS3 Class)

The data that was downloaded, or that should be uploaded.

Object Oriented Interface

public function getObjectData();


public function setObjectData($value);

Procedural Interface

cloudstorage_amazons3_get($res, 26 );


cloudstorage_amazons3_set($res, 26, $value );

Default Value

''

Remarks

This property is populated with object data after calling GetObject if LocalFile is not set.

This property can also be set before calling CreateObject or UploadPart; its data will be uploaded if LocalFile is not set.

This property is not available at design time.

Data Type

Binary String

ObjectDelimiter Property (CloudStorage_AmazonS3 Class)

The delimiter string to use when listing objects.

Object Oriented Interface

public function getObjectDelimiter();


public function setObjectDelimiter($value);

Procedural Interface

cloudstorage_amazons3_get($res, 27 );


cloudstorage_amazons3_set($res, 27, $value );

Default Value

''

Remarks

If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class will also populate the PrefixCount and Prefix[i] configuration settings

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectMarker Property (CloudStorage_AmazonS3 Class)

A marker indicating what page of objects to return next.

Object Oriented Interface

public function getObjectMarker();


public function setObjectMarker($value);

Procedural Interface

cloudstorage_amazons3_get($res, 28 );


cloudstorage_amazons3_set($res, 28, $value );

Default Value

''

Remarks

This property will be populated when ListObjects is called if the results are paged and there are more pages. To list all objects, continue to call ListObjects until this property returns empty string.

Refer to ListObjects for more information.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (CloudStorage_AmazonS3 Class)

A prefix used to restrict the results returned when listing objects.

Object Oriented Interface

public function getObjectPrefix();


public function setObjectPrefix($value);

Procedural Interface

cloudstorage_amazons3_get($res, 29 );


cloudstorage_amazons3_set($res, 29, $value );

Default Value

''

Remarks

This property, if non-empty, is used to restrict the results returned by ListObjects (or ListVersions) to only the objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectsCount Property (CloudStorage_AmazonS3 Class)

The number of records in the Objects arrays.

Object Oriented Interface

public function getObjectsCount();

Procedural Interface

cloudstorage_amazons3_get($res, 30 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjectsDeleted
• ObjectsETag
• ObjectsLastModified
• ObjectsLatestVersion
• ObjectsName
• ObjectsOwnerDisplayName
• ObjectsOwnerId
• ObjectsSize
• ObjectsStorageClass
• ObjectsUploadId
• ObjectsVersionId

The array indices start at 0 and end at ObjectsCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ObjectsDeleted Property (CloudStorage_AmazonS3 Class)

This property specifies whether this object version is a delete marker.

Object Oriented Interface

public function getObjectsDeleted($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 31 , $objectsindex);

Default Value

false

Remarks

This property specifies whether this object version is a delete marker.

This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to DeleteObject for more information.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; false in all other cases.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectsETag Property (CloudStorage_AmazonS3 Class)

This property contains the ETag of the object.

Object Oriented Interface

public function getObjectsETag($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 32 , $objectsindex);

Default Value

''

Remarks

This property contains the ETag of the object.

This property reflects the ETag of the object.

An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified.

This is not applicable when ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsLastModified Property (CloudStorage_AmazonS3 Class)

This property contains the last modified time of the object.

Object Oriented Interface

public function getObjectsLastModified($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 33 , $objectsindex);

Default Value

''

Remarks

This property contains the last modified time of the object.

This property reflects the last modified time of the object.

This is not applicable when ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsLatestVersion Property (CloudStorage_AmazonS3 Class)

This property specifies whether this is the latest object version.

Object Oriented Interface

public function getObjectsLatestVersion($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 34 , $objectsindex);

Default Value

true

Remarks

This property specifies whether this is the latest object version.

This property indicates whether this object version is the latest version available.

This is applicable only when ListVersions is called.; true in all other cases.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectsName Property (CloudStorage_AmazonS3 Class)

This property contains the name (key) of the object.

Object Oriented Interface

public function getObjectsName($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 35 , $objectsindex);

Default Value

''

Remarks

This property contains the name (key) of the object.

This property reflects the name (key) of the object.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsOwnerDisplayName Property (CloudStorage_AmazonS3 Class)

This property contains the display name of the object's owner.

Object Oriented Interface

public function getObjectsOwnerDisplayName($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 36 , $objectsindex);

Default Value

''

Remarks

This property contains the display name of the object's owner.

This property reflects the display name of the object's owner.

This is not applicable when GetObjectInfo is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsOwnerId Property (CloudStorage_AmazonS3 Class)

This property contains the Id of the object's owner.

Object Oriented Interface

public function getObjectsOwnerId($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 37 , $objectsindex);

Default Value

''

Remarks

This property contains the Id of the object's owner.

This property reflects the Id of the object's owner.

This is not applicable when GetObjectInfo is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsSize Property (CloudStorage_AmazonS3 Class)

This property contains the size of the object.

Object Oriented Interface

public function getObjectsSize($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 38 , $objectsindex);

Default Value

0

Remarks

This property contains the size of the object.

This property reflects the size of the object in bytes.

This is not applicable when ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Long64

ObjectsStorageClass Property (CloudStorage_AmazonS3 Class)

This property contains the storage class of the object.

Object Oriented Interface

public function getObjectsStorageClass($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 39 , $objectsindex);

Default Value

''

Remarks

This property contains the storage class of the object.

This property reflects the storage class of the object.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsUploadId Property (CloudStorage_AmazonS3 Class)

This property contains the upload Id of the multipart upload.

Object Oriented Interface

public function getObjectsUploadId($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 40 , $objectsindex);

Default Value

''

Remarks

This property contains the upload Id of the multipart upload.

This property reflects the upload Id of the multipart upload.

It is applicable only when ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsVersionId Property (CloudStorage_AmazonS3 Class)

This property contains the Id of the object version.

Object Oriented Interface

public function getObjectsVersionId($objectsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 41 , $objectsindex);

Default Value

''

Remarks

This property contains the Id of the object version.

This property reflects the Id of the object version.

Note: The string null is a valid version Id.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

OtherHeaders Property (CloudStorage_AmazonS3 Class)

This property includes other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

cloudstorage_amazons3_get($res, 42 );


cloudstorage_amazons3_set($res, 42, $value );

Default Value

''

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like ContentType and From.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_AmazonS3 Class)

Determines if local files are overwritten.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

cloudstorage_amazons3_get($res, 43 );


cloudstorage_amazons3_set($res, 43, $value );

Default Value

false

Remarks

This property controls whether local files are overwritten when calling GetObject. It is only applicable to local files. The default value is false.

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_AmazonS3 Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_amazons3_get($res, 44 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

The array indices start at 0 and end at ParsedHeaderCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (CloudStorage_AmazonS3 Class)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_amazons3_get($res, 45 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (CloudStorage_AmazonS3 Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_amazons3_get($res, 46 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

PartMarker Property (CloudStorage_AmazonS3 Class)

A marker indicating what page of parts to return next.

Object Oriented Interface

public function getPartMarker();


public function setPartMarker($value);

Procedural Interface

cloudstorage_amazons3_get($res, 47 );


cloudstorage_amazons3_set($res, 47, $value );

Default Value

''

Remarks

This property will be populated when ListParts is called if the results are paged and there are more pages. To list all parts, continue to call ListParts until this property returns empty string.

Refer to ListParts for more information.

This property is not available at design time.

Data Type

String

PartsCount Property (CloudStorage_AmazonS3 Class)

The number of records in the Parts arrays.

Object Oriented Interface

public function getPartsCount();

Procedural Interface

cloudstorage_amazons3_get($res, 48 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• PartsETag
• PartsLastModified
• PartsNumber
• PartsObjectName
• PartsOwnerDisplayName
• PartsOwnerId
• PartsSize

The array indices start at 0 and end at PartsCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PartsETag Property (CloudStorage_AmazonS3 Class)

This property contains the ETag of the part.

Object Oriented Interface

public function getPartsETag($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 49 , $partsindex);

Default Value

''

Remarks

This property contains the ETag of the part.

This property reflects the ETag of the part.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

String

PartsLastModified Property (CloudStorage_AmazonS3 Class)

This property contains the last modified time of the part.

Object Oriented Interface

public function getPartsLastModified($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 50 , $partsindex);

Default Value

''

Remarks

This property contains the last modified time of the part.

This property reflects the last modified time of the part.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

String

PartsObjectName Property (CloudStorage_AmazonS3 Class)

This property contains the name (key) of the object that the part was uploaded for.

Object Oriented Interface

public function getPartsObjectName($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 51 , $partsindex);

Default Value

''

Remarks

This property contains the name (key) of the object that the part was uploaded for.

This property reflects the name (key) of the object that the part was uploaded for.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

String

PartsOwnerDisplayName Property (CloudStorage_AmazonS3 Class)

This property contains the display name of the part's owner.

Object Oriented Interface

public function getPartsOwnerDisplayName($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 52 , $partsindex);

Default Value

''

Remarks

This property contains the display name of the part's owner.

This property reflects the display name of the part's owner.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

String

PartsOwnerId Property (CloudStorage_AmazonS3 Class)

This property contains the Id of the part's owner.

Object Oriented Interface

public function getPartsOwnerId($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 53 , $partsindex);

Default Value

''

Remarks

This property contains the Id of the part's owner.

This property reflects the Id of the part's owner.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

String

PartsNumber Property (CloudStorage_AmazonS3 Class)

This property contains the number of the part.

Object Oriented Interface

public function getPartsNumber($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 54 , $partsindex);

Default Value

0

Remarks

This property contains the number of the part.

This property reflects the number of the part.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

Integer

PartsSize Property (CloudStorage_AmazonS3 Class)

This property contains the size of the part.

Object Oriented Interface

public function getPartsSize($partsindex);

Procedural Interface

cloudstorage_amazons3_get($res, 55 , $partsindex);

Default Value

0

Remarks

This property contains the size of the part.

This property reflects the size of the part in bytes.

The $partsindex parameter specifies the index of the item in the array. The size of the array is controlled by the PartsCount property.

This property is read-only and not available at design time.

Data Type

Long64

ProxyAuthScheme Property (CloudStorage_AmazonS3 Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_amazons3_get($res, 56 );


cloudstorage_amazons3_set($res, 56, $value );

Default Value

0

Remarks

This property is used to tell the class which type of authorization to perform when connecting to the proxy. This is used only when the ProxyUser and ProxyPassword properties are set.

ProxyAuthScheme should be set to authNone (3) when no authentication is expected.

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

If ProxyAuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If ProxyAuthScheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_AmazonS3 Class)

This property tells the class whether or not to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_amazons3_get($res, 57 );


cloudstorage_amazons3_set($res, 57, $value );

Default Value

false

Remarks

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (CloudStorage_AmazonS3 Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

cloudstorage_amazons3_get($res, 58 );


cloudstorage_amazons3_set($res, 58, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_AmazonS3 Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

cloudstorage_amazons3_get($res, 59 );


cloudstorage_amazons3_set($res, 59, $value );

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_AmazonS3 Class)

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

cloudstorage_amazons3_get($res, 60 );


cloudstorage_amazons3_set($res, 60, $value );

Default Value

''

Remarks

If a proxy ProxyServer is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the ProxyServer property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the ProxyServer property is set to the corresponding address. If the search is not successful, an error is returned.

Data Type

String

ProxySSL Property (CloudStorage_AmazonS3 Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

cloudstorage_amazons3_get($res, 61 );


cloudstorage_amazons3_set($res, 61, $value );

Default Value

0

Remarks

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

Data Type

Integer

ProxyUser Property (CloudStorage_AmazonS3 Class)

This property contains a username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

cloudstorage_amazons3_get($res, 62 );


cloudstorage_amazons3_set($res, 62, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (CloudStorage_AmazonS3 Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();


public function setQueryParamCount($value);

Procedural Interface

cloudstorage_amazons3_get($res, 63 );


cloudstorage_amazons3_set($res, 63, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

The array indices start at 0 and end at QueryParamCount - 1.

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_AmazonS3 Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);


public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_amazons3_get($res, 64 , $queryparamindex);


cloudstorage_amazons3_set($res, 64, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_AmazonS3 Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);


public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_amazons3_get($res, 65 , $queryparamindex);


cloudstorage_amazons3_set($res, 65, $value , $queryparamindex);

Default Value

''

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

Range Property (CloudStorage_AmazonS3 Class)

The range of bytes to request.

Object Oriented Interface

public function getRange();


public function setRange($value);

Procedural Interface

cloudstorage_amazons3_get($res, 66 );


cloudstorage_amazons3_set($res, 66, $value );

Default Value

''

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the StartByte property is greater than zero when GetObject is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by StartByte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

Region Property (CloudStorage_AmazonS3 Class)

The region the class will make requests against.

Object Oriented Interface

public function getRegion();


public function setRegion($value);

Procedural Interface

cloudstorage_amazons3_get($res, 67 );


cloudstorage_amazons3_set($res, 67, $value );

Default Value

'us-east-1'

Remarks

This property controls which region the class will make requests against. By default the class uses us-east-1, the US East (N. Virginia) region. This property should be changed to create or access resources in other regions.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

Data Type

String

SecretKey Property (CloudStorage_AmazonS3 Class)

The secret key to use for authentication.

Object Oriented Interface

public function getSecretKey();


public function setSecretKey($value);

Procedural Interface

cloudstorage_amazons3_get($res, 68 );


cloudstorage_amazons3_set($res, 68, $value );

Default Value

''

Remarks

This property specifies the secret key that should be used for authentication. Both this property and AccessKey must be set before attempting any operations which connect to the server.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_AmazonS3 Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_amazons3_get($res, 70 );


cloudstorage_amazons3_set($res, 70, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CloudStorage_AmazonS3 Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_amazons3_get($res, 98 );


cloudstorage_amazons3_set($res, 98, $value );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CloudStorage_AmazonS3 Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

cloudstorage_amazons3_get($res, 114 );


cloudstorage_amazons3_set($res, 114, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_AmazonS3 Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_amazons3_get($res, 115 );


cloudstorage_amazons3_set($res, 115, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (CloudStorage_AmazonS3 Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_amazons3_get($res, 116 );


cloudstorage_amazons3_set($res, 116, $value );

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubject Property (CloudStorage_AmazonS3 Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_amazons3_get($res, 117 );


cloudstorage_amazons3_set($res, 117, $value );

Default Value

''

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLProvider Property (CloudStorage_AmazonS3 Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

cloudstorage_amazons3_get($res, 125 );


cloudstorage_amazons3_set($res, 125, $value );

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows the class will use the platform implementation. On Linux/macOS the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols the internal implementation is used on all platforms.

Data Type

Integer

SSLServerCertEncoded Property (CloudStorage_AmazonS3 Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_amazons3_get($res, 127 );

Default Value

''

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLServerCertStore and SSLServerCertSubject properties also may be used to specify a certificate.

When SSLServerCertEncoded is set, a search is initiated in the current SSLServerCertStore for the private key of the certificate. If the key is found, SSLServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLServerCertSubject is set to an empty string.

This property is read-only and not available at design time.

Data Type

Binary String

StartByte Property (CloudStorage_AmazonS3 Class)

The byte offset from which to resume the upload or download.

Object Oriented Interface

public function getStartByte();


public function setStartByte($value);

Procedural Interface

cloudstorage_amazons3_get($res, 154 );


cloudstorage_amazons3_set($res, 154, $value );

Default Value

0

Remarks

This property specifies the byte offset from which to resume an automatic multipart upload initiated by CreateObject, or a download initiated by GetObject. Refer to those methods' documentation for more information about resuming uploads and downloads.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_AmazonS3 Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

cloudstorage_amazons3_get($res, 155 );


cloudstorage_amazons3_set($res, 155, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If Timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not "freeze" and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

UseSSL Property (CloudStorage_AmazonS3 Class)

Whether to use SSL/TLS when connecting.

Object Oriented Interface

public function getUseSSL();


public function setUseSSL($value);

Procedural Interface

cloudstorage_amazons3_get($res, 156 );


cloudstorage_amazons3_set($res, 156, $value );

Default Value

true

Remarks

This property specifies whether the class should use SSL/TLS when connecting.

This property is not available at design time.

Data Type

Boolean

UseVirtualHosting Property (CloudStorage_AmazonS3 Class)

Determines which URL style to use when making requests.

Object Oriented Interface

public function getUseVirtualHosting();


public function setUseVirtualHosting($value);

Procedural Interface

cloudstorage_amazons3_get($res, 157 );


cloudstorage_amazons3_set($res, 157, $value );

Default Value

true

Remarks

If true (default), virtual-hosted-style URLs will be used to make requests: http://yourbucket.s3.amazonaws.com/yourobject. Note that hosted-style URLs impose more bucket name restrictions due to DNS server naming restrictions. Refer to Amazon's documentation for more information.

If false, path-style URLs will be used to make requests: http://s3.amazonaws.com/yourbucket/yourobject.

Important: Amazon has publicly announced that buckets created after September 30, 2020 will only support virtual-hosted-style URLs. Buckets created on or before September 30, 2020 will continue to support both URL styles.

This property is not available at design time.

Data Type

Boolean

VersionId Property (CloudStorage_AmazonS3 Class)

The object version to make requests against.

Object Oriented Interface

public function getVersionId();


public function setVersionId($value);

Procedural Interface

cloudstorage_amazons3_get($res, 158 );


cloudstorage_amazons3_set($res, 158, $value );

Default Value

''

Remarks

This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• CopyObject (to copy from a specific object version)
• DeleteObject
• GetLink (to build a link for a specific object version)
• GetObject
• GetObjectInfo
• SendCustomRequest
• UpdateObjectACL

Refer to Amazon's Versioning documentation for more information about versioning.

This property is not available at design time.

Data Type

String

VersioningEnabled Property (CloudStorage_AmazonS3 Class)

Controls whether versioning is enabled for the currently selected bucket.

Object Oriented Interface

public function getVersioningEnabled();


public function setVersioningEnabled($value);

Procedural Interface

cloudstorage_amazons3_get($res, 159 );


cloudstorage_amazons3_set($res, 159, $value );

Default Value

false

Remarks

This property can be used to query and control whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this property will always return false when queried, and any attempts to set it will fail.

Refer to Amazon's Versioning documentation for more information about versioning.

This property is not available at design time.

Data Type

Boolean

VersionMarker Property (CloudStorage_AmazonS3 Class)

A marker indicating what page of object versions to return next.

Object Oriented Interface

public function getVersionMarker();


public function setVersionMarker($value);

Procedural Interface

cloudstorage_amazons3_get($res, 160 );


cloudstorage_amazons3_set($res, 160, $value );

Default Value

''

Remarks

This property will be populated when ListVersions is called if the results are paged and there are more pages. To list all object versions, continue to call ListVersions until this property returns empty string.

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AbortMultipartUpload Method (CloudStorage_AmazonS3 Class)

Aborts a multipart upload.

Object Oriented Interface

public function doAbortMultipartUpload($objectname, $uploadid);

Procedural Interface

cloudstorage_amazons3_do_abortmultipartupload($res, $objectname, $uploadid);

Remarks

This method aborts the multipart upload of the object named ObjectName specified by UploadId.

When this method is called, all parts that have been uploaded for the multipart upload are deleted from the server. (Note that if any part uploads are currently in progress, it may be necessary to call this method again after they complete.)

If this method is called successfully, the specified UploadId will no longer be valid.

AddMetadata Method (CloudStorage_AmazonS3 Class)

Adds a metadata item to the Metadata properties.

Object Oriented Interface

public function doAddMetadata($name, $value);

Procedural Interface

cloudstorage_amazons3_do_addmetadata($res, $name, $value);

Remarks

This method adds a metadata item to the Metadata* properties. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The class will take care of prepending it when sending metadata to the server.

AddQueryParam Method (CloudStorage_AmazonS3 Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_amazons3_do_addqueryparam($res, $name, $value);

Remarks

This method is used to add a query parameter to the QueryaParam* properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

AppendObject Method (CloudStorage_AmazonS3 Class)

This method appends data to the end of the existing object specified by ObjectName .

Object Oriented Interface

public function doAppendObject($objectname);

Procedural Interface

cloudstorage_amazons3_do_appendobject($res, $objectname);

Remarks

The data to upload are taken from either or ObjectData (whichever data are found first, when checked in that order).

BucketExists Method (CloudStorage_AmazonS3 Class)

Checks whether the bucket exists.

Object Oriented Interface

public function doBucketExists();

Procedural Interface

cloudstorage_amazons3_do_bucketexists($res);

Remarks

This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.

CheckVersioningEnabled Method (CloudStorage_AmazonS3 Class)

Checks whether versioning is enabled for the currently selected bucket.

Object Oriented Interface

public function doCheckVersioningEnabled();

Procedural Interface

cloudstorage_amazons3_do_checkversioningenabled($res);

Remarks

This method can be used to check whether the bucket currently selected by Bucket has versioning enabled.

Note that if Bucket is empty, or refers to a bucket that does not exist, this method will always return false when queried.

Refer to Amazon's Versioning documentation for more information about versioning.

CompleteMultipartUpload Method (CloudStorage_AmazonS3 Class)

Completes a multipart upload by assembling previously uploaded parts.

Object Oriented Interface

public function doCompleteMultipartUpload($objectname, $uploadid);

Procedural Interface

cloudstorage_amazons3_do_completemultipartupload($res, $objectname, $uploadid);

Remarks

This method completes the multipart upload specified by UploadId. The server will assemble all of the parts that have been uploaded into an object named ObjectName.

Note that this method automatically calls ListParts internally to obtain the information needed to complete the multipart upload. This process does not alter the Parts* properties, nor does it cause the PartList event to fire.

Config Method (CloudStorage_AmazonS3 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_amazons3_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CopyObject Method (CloudStorage_AmazonS3 Class)

Copies an object.

Object Oriented Interface

public function doCopyObject($srcobjectname, $destbucket, $destobjectname);

Procedural Interface

cloudstorage_amazons3_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname);

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by Bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by Bucket is used as the destination bucket.

If the VersionId property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If there are any metadata items present in the Metadata* properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may only be copied to buckets that exist within the same region.
• Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.

CopyPart Method (CloudStorage_AmazonS3 Class)

Copies the specified object as a part of a multipart upload.

Object Oriented Interface

public function doCopyPart($srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid);

Procedural Interface

cloudstorage_amazons3_do_copypart($res, $srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid);

Remarks

This method copies data from the object specified by SrcObjectName (in the bucket currently selected by Bucket) to a new multipart upload part for DestObjectName in DestBucket.

The DestPartNumber and DestUploadId parameters should be used in the same manner as the UploadPart method's PartNumber and UploadId parameters.

To copy a specific range of bytes from the source object, set the CopyPartRange configuration setting before calling this method.

CreateBucket Method (CloudStorage_AmazonS3 Class)

Creates a new bucket.

Object Oriented Interface

public function doCreateBucket();

Procedural Interface

cloudstorage_amazons3_do_createbucket($res);

Remarks

This method creates a new bucket using the name specified by the Bucket property. The bucket is created in the region specified by the Region property.

CreateObject Method (CloudStorage_AmazonS3 Class)

Creates a new object in the currently selected bucket.

Object Oriented Interface

public function doCreateObject($objectname);

Procedural Interface

cloudstorage_amazons3_do_createobject($res, $objectname);

Remarks

This method creates a new object named Object in the bucket currently selected by Bucket. If there are any metadata items present in the Metadata* properties, they will included in the creation request.

If LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see StartMultipartUpload.

Automatic Multipart Uploads

If more than SimpleUploadLimit bytes of data are provided, the class will automatically perform a multipart upload by splitting the data up into parts (sized according to the FragmentSize configuration setting) and uploading them individually. To accomplish this, the class automatically makes calls to StartMultipartUpload, UploadPart, and CompleteMultipartUpload internally; tracks upload state information using the ResumableUploadState configuration setting; and tracks how much data has been uploaded using the StartByte property. The FragmentComplete event will fire after each part is uploaded.

If, during an automatic multipart upload, any individual request fails, the upload can be resumed be calling this method again with the same parameters, so long as ResumableUploadState and StartByte contain the same values as they did when the upload was interrupted.

When an automatic multipart upload completes successfully, ResumableUploadState is cleared and StartByte is reset to 0.

DeleteBucket Method (CloudStorage_AmazonS3 Class)

Deletes a bucket.

Object Oriented Interface

public function doDeleteBucket();

Procedural Interface

cloudstorage_amazons3_do_deletebucket($res);

Remarks

This method deletes the bucket currently selected by Bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.

DeleteObject Method (CloudStorage_AmazonS3 Class)

Deletes an object.

Object Oriented Interface

public function doDeleteObject($objectname);

Procedural Interface

cloudstorage_amazons3_do_deleteobject($res, $objectname);

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by Bucket.

If the VersionId property is non-empty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If an object's latest version is a delete marker, then the server treats the object as if it didn't exist (i.e., it doesn't appear when listing objects, cannot be downloaded, etc.). However, all of the previous versions of the object (including one that existed just before the delete marker was created) still exist; they can be listed using ListVersions, and explicitly interacted with by setting VersionId and calling an appropriate method.

To permanently delete objects in a versioning-enabled bucket, each version of the object must be explicitly deleted by setting VersionId before calling this method. This includes any delete marker versions, which can be deleted like any other version.

Refer to Amazon's Deleting Object Versions, Working with Delete Markers, and Removing Delete Markers articles for more information.

DisableVersioning Method (CloudStorage_AmazonS3 Class)

Disables versioning for the currently selected bucket.

Object Oriented Interface

public function doDisableVersioning();

Procedural Interface

cloudstorage_amazons3_do_disableversioning($res);

Remarks

This method can be used to disable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

DoEvents Method (CloudStorage_AmazonS3 Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudstorage_amazons3_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

EnableVersioning Method (CloudStorage_AmazonS3 Class)

Enables versioning for the currently selected bucket.

Object Oriented Interface

public function doEnableVersioning();

Procedural Interface

cloudstorage_amazons3_do_enableversioning($res);

Remarks

This method can be used to enable versioning for the bucket currently selected by Bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

GetBucketLocation Method (CloudStorage_AmazonS3 Class)

Gets a bucket's location.

Object Oriented Interface

public function doGetBucketLocation();

Procedural Interface

cloudstorage_amazons3_do_getbucketlocation($res);

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by Bucket.

GetLink Method (CloudStorage_AmazonS3 Class)

Creates a link that provides access to an object for a specified amount of time.

Object Oriented Interface

public function doGetLink($objectname, $expires);

Procedural Interface

cloudstorage_amazons3_do_getlink($res, $objectname, $expires);

Remarks

This method creates and returns a pre-authenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, a link is created for the specified version of the object.

The Expires parameter specifies how many seconds the link should be valid for. The maximum validity period is seven days.

Note that this method is an offline method that simply generates a pre-signed URL; no communication with the server takes place.

GetObject Method (CloudStorage_AmazonS3 Class)

Downloads an object.

Object Oriented Interface

public function doGetObject($objectname);

Procedural Interface

cloudstorage_amazons3_do_getobject($res, $objectname);

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is non-empty, the specified version of the object is downloaded instead. The Range property can be used to download a specific range of bytes from the object.

If LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.

To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword before calling this method.

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

Resuming Downloads

The class also supports resuming failed downloads by using the StartByte property. If a download is interrupted, set StartByte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when LocalFile was set in the initial download attempt.

If LocalFile is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

GetObjectInfo Method (CloudStorage_AmazonS3 Class)

Gets an object's information and metadata.

Object Oriented Interface

public function doGetObjectInfo($objectname);

Procedural Interface

cloudstorage_amazons3_do_getobjectinfo($res, $objectname);

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by Bucket. If the VersionId property is non-empty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the ObjectList and MetadataList events, and will re-populate the Objects* and Metadata* properties.

GetTorrent Method (CloudStorage_AmazonS3 Class)

Gets a torrent file that can be used to download an object.

Object Oriented Interface

public function doGetTorrent($objectname);

Procedural Interface

cloudstorage_amazons3_do_gettorrent($res, $objectname);

Remarks

This method gets a torrent file for the object specified by ObjectName in the bucket currently selected by Bucket.

If LocalFile is set, the torrent file will be saved to the specified location; otherwise, the torrent file will be held by ObjectData.

Note that, according to Amazon's documentation:

• Torrent files are only available for publicly-accessible objects less than 5GB in size.
• Torrent files cannot be requested for objects located in AWS regions that launched after May 30, 2016.

Interrupt Method (CloudStorage_AmazonS3 Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_amazons3_do_interrupt($res);

Remarks

If there is no method in progress, Interrupt simply returns, doing nothing.

ListBuckets Method (CloudStorage_AmazonS3 Class)

Lists all buckets in the account.

Object Oriented Interface

public function doListBuckets();

Procedural Interface

cloudstorage_amazons3_do_listbuckets($res);

Remarks

This method lists all buckets in the account.

Calling this method will fire the BucketList event once for each bucket, and will also populate the Buckets* properties.

ListMultipartUploads Method (CloudStorage_AmazonS3 Class)

Lists the current multipart uploads.

Object Oriented Interface

public function doListMultipartUploads();

Procedural Interface

cloudstorage_amazons3_do_listmultipartuploads($res);

Remarks

This method lists the current multipart uploads in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each multipart upload, and will also populate the Objects* properties.

If there are still more multipart uploads available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

ListObjects Method (CloudStorage_AmazonS3 Class)

Lists the objects in a bucket.

Object Oriented Interface

public function doListObjects();

Procedural Interface

cloudstorage_amazons3_do_listobjects($res);

Remarks

This method lists the objects in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object, and will also populate the Objects* properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more objects available to list when this method returns, the ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ListParts Method (CloudStorage_AmazonS3 Class)

Lists the parts in a multipart upload.

Object Oriented Interface

public function doListParts($objectname, $uploadid);

Procedural Interface

cloudstorage_amazons3_do_listparts($res, $objectname, $uploadid);

Remarks

This method lists the parts in the multipart upload of ObjectName specified by UploadId. The MaxParts configuration setting may be used to limit the number of results returned.

Calling this method will fire the PartList event once for each part, and will also populate the Parts* properties.

If there are still more parts available to list when this method returns, the PartMarker property will be populated. Continue to call this method until PartMarker is empty to accumulate all pages of results in the Parts* properties.

Note that this method does not need to be called before attempting to complete a multipart upload with CompleteMultipartUpload; the class will automatically collect the necessary information internally. Refer to CompleteMultipartUpload for more information.

ListVersions Method (CloudStorage_AmazonS3 Class)

Lists the object versions in a bucket.

Object Oriented Interface

public function doListVersions();

Procedural Interface

cloudstorage_amazons3_do_listversions($res);

Remarks

This method lists the object versions in the bucket currently selected by Bucket.

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the ObjectList event once for each object version, and will also populate the Objects* properties. It may also fire the PrefixList event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more object versions available to list when this method returns, the VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Reset Method (CloudStorage_AmazonS3 Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_amazons3_do_reset($res);

Remarks

This method resets the class to its initial state.

ResetHeaders Method (CloudStorage_AmazonS3 Class)

Resets all HTTP headers, cookies, and LocalFile.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

cloudstorage_amazons3_do_resetheaders($res);

Remarks

Resets all the HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata* and QueryParam* properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

SendCustomRequest Method (CloudStorage_AmazonS3 Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $objectname, $requestbody);

Procedural Interface

cloudstorage_amazons3_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody);

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• DELETE

The ObjectName and RequestBody parameters may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, based on the following:
   • UseSSL, Region, and UseVirtualHosting for the base URL.
     • Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
   • Bucket (if non-empty)
   • ObjectName (if non-empty)
   • VersionId (if both it and ObjectName are non-empty)
   • QueryParam*
2. Adds request headers from:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • ProductToken
   • SessionToken
   • UserToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).

If the response body is XML data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

StartMultipartUpload Method (CloudStorage_AmazonS3 Class)

Starts a new manual multipart upload.

Object Oriented Interface

public function doStartMultipartUpload($objectname);

Procedural Interface

cloudstorage_amazons3_do_startmultipartupload($res, $objectname);

Remarks

This method starts a new "manual" multipart upload for an object named ObjectName, in the bucket currently selected by Bucket, and returns the upload Id that the server associates with it. For an "automatic" multipart upload see the CreateObject method. This upload Id can then be used to call the following methods:

• UploadPart
• CopyPart
• ListParts
• CompleteMultipartUpload
• AbortMultipartUpload

If there are any metadata items present in the Metadata* properties, they will be included in the creation request, and will be applied to the final object after the multipart upload is completed with CompleteMultipartUpload.

Multipart uploads never expire, they must be explicitly completed or aborted using CompleteMultipartUpload or AbortMultipartUpload. The ListMultipartUploads method can be used to retrieve a list of current multipart uploads.

UpdateBucketACL Method (CloudStorage_AmazonS3 Class)

Updates a bucket's canned access policy.

Object Oriented Interface

public function doUpdateBucketACL();

Procedural Interface

cloudstorage_amazons3_do_updatebucketacl($res);

Remarks

This method updates the canned access policy of the bucket selected by Bucket to the value specified by AccessPolicy

UpdateObjectACL Method (CloudStorage_AmazonS3 Class)

Updates an object's canned access policy.

Object Oriented Interface

public function doUpdateObjectACL($objectname);

Procedural Interface

cloudstorage_amazons3_do_updateobjectacl($res, $objectname);

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by Bucket, to the value specified by AccessPolicy.

If the VersionId property is non-empty, the canned access policy of the specified version of the object is updated instead.

UploadPart Method (CloudStorage_AmazonS3 Class)

Uploads a multipart upload part.

Object Oriented Interface

public function doUploadPart($objectname, $partnumber, $uploadid);

Procedural Interface

cloudstorage_amazons3_do_uploadpart($res, $objectname, $partnumber, $uploadid);

Remarks

This method uploads a part for the multipart upload of the object named ObjectName specified by UploadId.

PartNumber specifies the part's number; it must be a value in the range 1 to 10000, inclusive. If a part with the given number already exists in the specified multipart upload, it is replaced with the newly-uploaded part.

The data to upload is taken from either LocalFile or ObjectData (whichever data is found in first, when checked in that order). Each part must be at least 5MB in size, except for the last part in the overall multipart upload, which can be any non-zero size.

If the IncludePartMD5 configuration setting is true, the class will include an MD5 digest of its data when sending it to the server. The server will then verify that the data was received without corruption.

BucketList Event (CloudStorage_AmazonS3 Class)

Fires once for each bucket returned when listing buckets.

Object Oriented Interface

public function fireBucketList($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 1, array($this, 'fireBucketList'));

Parameter List

 'bucketname'
 'creationdate'
 'ownerid'
 'ownername'

Remarks

This event fires once for each bucket returned when ListBuckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.

EndTransfer Event (CloudStorage_AmazonS3 Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 2, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Error Event (CloudStorage_AmazonS3 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

FragmentComplete Event (CloudStorage_AmazonS3 Class)

Fires after each part in an automatic multipart upload is complete.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 4, array($this, 'fireFragmentComplete'));

Parameter List

 'fragmentnumber'
 'fragmentcount'
 'interrupt'

Remarks

If, when CreateObject is called, more than SimpleUploadLimit bytes of upload data are present, the class will automatically split the upload data up into parts and perform a multipart upload. During the overall upload process, this event will fire after each part is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current part that has completed. This value starts at 1.

FragmentCount is the total number of parts that will be uploaded.

Interrupt can be set to true to interrupt the upload. The upload may be resumed later.

Refer to CreateObject for more information.

Header Event (CloudStorage_AmazonS3 Class)

This event is fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 5, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

Log Event (CloudStorage_AmazonS3 Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

MetadataList Event (CloudStorage_AmazonS3 Class)

Fires once for each metadata item returned when object information and metadata is retrieved.

Object Oriented Interface

public function fireMetadataList($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 7, array($this, 'fireMetadataList'));

Parameter List

 'name'
 'value'

Remarks

This event fires once for each metadata item returned when GetObjectInfo is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (CloudStorage_AmazonS3 Class)

Fires once for each object, object version, or multipart upload returned when listing such items.

Object Oriented Interface

public function fireObjectList($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 8, array($this, 'fireObjectList'));

Parameter List

 'bucketname'
 'objectname'
 'lastmodified'
 'size'
 'etag'
 'ownerid'
 'ownername'
 'uploadid'
 'versionid'
 'latestversion'
 'deleted'

Remarks

This event fires once for each object, object version, or multipart upload returned when GetObjectInfo, ListObjects, ListVersions, or ListMultipartUploads is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object. Not applicable when ListMultipartUploads is called.

Size reflects the size, in bytes, of the object. Not applicable when ListMultipartUploads is called.

ETag reflects the object's ETag. Not applicable when ListMultipartUploads is called.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when GetObjectInfo is called.

UploadId reflects the Id of the multipart upload. Only applicable when ListMultipartUploads is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; empty in all other cases.

LatestVersion indicates whether this is the latest object version. Only applicable when ListVersions is called; true in all other cases.

Deleted indicates whether this object version is a delete marker (refer to DeleteObject for more information). Only applicable when ListVersions is called, or when GetObjectInfo is called while VersionId is non-empty; false in all other cases.

PartList Event (CloudStorage_AmazonS3 Class)

Fires once for every part returned when listing a multipart upload's parts.

Object Oriented Interface

public function firePartList($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 9, array($this, 'firePartList'));

Parameter List

 'partnumber'
 'objectname'
 'lastmodified'
 'size'
 'etag'
 'ownerid'
 'ownername'

Remarks

This event fires once for each multipart upload part returned when ListParts is called.

PartNumber reflects the part's number.

ObjectName reflects the name of the object the multipart upload is for.

LastModified reflects the last modified time of the part.

Size reflects the size, in bytes, of the part.

ETag reflects the part's ETag of the part.

OwnerId and OwnerName reflect the Id and display name of the part's owner, respectively.

PrefixList Event (CloudStorage_AmazonS3 Class)

Fires once for each common prefix returned when listing objects.

Object Oriented Interface

public function firePrefixList($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 10, array($this, 'firePrefixList'));

Parameter List

 'bucketname'
 'prefix'

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

Progress Event (CloudStorage_AmazonS3 Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 11, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

SSLServerAuthentication Event (CloudStorage_AmazonS3 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 12, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (CloudStorage_AmazonS3 Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 13, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (CloudStorage_AmazonS3 Class)

This event fires when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 14, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

Transfer Event (CloudStorage_AmazonS3 Class)

This event is fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_amazons3_register_callback($res, 15, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Config Settings (AmazonS3 Class)

S3 Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AmazonS3 Class)

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors