S3 Class

Properties   Methods   Events   Config Settings   Errors  

The S3 class provides an easy-to-use interface for Amazon S3 and other S3-compatible services.

Class Name

IPWorks_S3

Procedural Interface

 ipworks_s3_open();
 ipworks_s3_close($res);
 ipworks_s3_register_callback($res, $id, $function);
 ipworks_s3_get_last_error($res);
 ipworks_s3_get_last_error_code($res);
 ipworks_s3_set($res, $id, $index, $value);
 ipworks_s3_get($res, $id, $index);
 ipworks_s3_do_abortmultipartupload($res, $objectname, $uploadid);
 ipworks_s3_do_addmetadata($res, $name, $value);
 ipworks_s3_do_addqueryparam($res, $name, $value);
 ipworks_s3_do_appendobject($res, $objectname);
 ipworks_s3_do_bucketexists($res);
 ipworks_s3_do_checkversioningenabled($res);
 ipworks_s3_do_completemultipartupload($res, $objectname, $uploadid);
 ipworks_s3_do_config($res, $configurationstring);
 ipworks_s3_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname);
 ipworks_s3_do_copypart($res, $srcobjectname, $destbucket, $destobjectname, $destpartnumber, $destuploadid);
 ipworks_s3_do_createbucket($res);
 ipworks_s3_do_createobject($res, $objectname);
 ipworks_s3_do_deletebucket($res);
 ipworks_s3_do_deleteobject($res, $objectname);
 ipworks_s3_do_disableversioning($res);
 ipworks_s3_do_doevents($res);
 ipworks_s3_do_enableversioning($res);
 ipworks_s3_do_getbucketlocation($res);
 ipworks_s3_do_getlink($res, $objectname, $expires);
 ipworks_s3_do_getobject($res, $objectname);
 ipworks_s3_do_getobjectinfo($res, $objectname);
 ipworks_s3_do_interrupt($res);
 ipworks_s3_do_listbuckets($res);
 ipworks_s3_do_listmultipartuploads($res);
 ipworks_s3_do_listobjects($res);
 ipworks_s3_do_listparts($res, $objectname, $uploadid);
 ipworks_s3_do_listversions($res);
 ipworks_s3_do_reset($res);
 ipworks_s3_do_resetheaders($res);
 ipworks_s3_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody);
 ipworks_s3_do_startmultipartupload($res, $objectname);
 ipworks_s3_do_updatebucketacl($res);
 ipworks_s3_do_updateobjectacl($res, $objectname);
 ipworks_s3_do_uploadpart($res, $objectname, $partnumber, $uploadid);

Remarks

The S3 class allows you to access Amazon's Simple Storage Service (S3), as well as other S3-compatible services, in a secure manner using Secure Sockets Layer/Transport Layer Security (TLS/SSL). S3-like services allow you to store arbitrary data objects in various buckets and to access them from anywhere with an internet connection.

A brief synopsis follows, but please refer to Amazon's S3 documentation for more information about the general capabilities of S3.

S3 supports the following providers:

• Amazon S3
• Backblaze B2
• Cloudflare R2
• Digital Ocean Spaces
• Google Cloud Storage
• IBM Cloud Object Storage
• Linode Object Storage
• Oort DSS
• Oracle Cloud Object Storage
• Seagate Lyve Cloud
• Wasabi
• And more!

A "custom provider" option also allows you to interact with any S3-compatible API by specifying its base URL.

Getting Started

To begin, use the ServiceProvider property to select the S3 service provider to use. Then, use the AccessKey and SecretKey properties to specify the access key and secret key that the class should use to sign requests. These keys can be obtained after signing up for an account with the selected service provider.

Working with Buckets

S3 services store objects in various buckets. The following methods can be used to interact with the buckets in an S3 account:

• Creating and deleting buckets: CreateBucket and DeleteBucket
• Checking whether a bucket exists, and its location: BucketExists and GetBucketLocation
• Listing buckets: ListBuckets
• Updating a bucket's canned ACL: UpdateBucketACL

Working with Objects

Once the desired buckets are ready, the following methods can be used to interact with objects:

• Creating, downloading, and deleting objects: CreateObject, GetObject, DeleteObject
• Copying objects: CopyObject
• Listing objects, or getting information about a single object: ListObjects, GetObjectInfo
• Updating an object's canned ACL: UpdateObjectACL

Working with Multipart Uploads

For S3 providers that support them, multipart uploads make it possible to upload very large objects in multiple parts.

• Starting, completing, and aborting multipart uploads: StartMultipartUpload, CompleteMultipartUpload, AbortMultipartUpload
• Listing multipart uploads: ListMultipartUploads
• Uploading and copying parts: UploadPart, CopyPart
• Listing parts: ListParts

Cloudflare R2 Notes

The Cloudflare R2 service provider possesses the following unique requirements and characteristics:

• In addition to needing an AccessKey and SecretKey, a CloudflareAccountID is also required to work with this provider.
• The Region property is automatically set to "auto" when this service provider is selected, which is the only valid value.
• ListParts is not supported natively by Cloudflare R2, which means that the behavior of CompleteMultipartUpload changes when using this provider. Instead, calling UploadPart or CopyPart populates the LastPartInfo and PartInfo[i] configuration settings. CompleteMultipartUpload will then use the values in PartInfo[i] to complete the multipart upload.

Other Features

The S3 class also supports a variety of other features, including the following:

• Versioning support
• Object metadata manipulation
• Presigned link generation

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 (IPWorks_S3 Class)

This property includes the access key to use for authentication.

Object Oriented Interface

public function getAccessKey();
public function setAccessKey($value);

Procedural Interface

ipworks_s3_get($res, 1 );
ipworks_s3_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 that connect to the server.

Data Type

String

AccessPolicy Property (IPWorks_S3 Class)

This property includes the canned access policy to apply to a bucket or object.

Object Oriented Interface

public function getAccessPolicy();
public function setAccessPolicy($value);

Procedural Interface

ipworks_s3_get($res, 2 );
ipworks_s3_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

The valid values are as follows:

Note: Most S3-compatible service providers support all of the canned access policies listed above, but some do not, or they have additional restrictions. Refer to the provider's documentation for more information.

Data Type

Integer

Bucket Property (IPWorks_S3 Class)

This property selects a bucket.

Object Oriented Interface

public function getBucket();
public function setBucket($value);

Procedural Interface

ipworks_s3_get($res, 3 );
ipworks_s3_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 (IPWorks_S3 Class)

The number of records in the Buckets arrays.

Object Oriented Interface

public function getBucketsCount();

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

The property includes the creation date of the bucket.

Object Oriented Interface

public function getBucketsCreationDate($bucketsindex);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

The property contains the name of the bucket.

Object Oriented Interface

public function getBucketsName($bucketsindex);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getBucketsOwnerDisplayName($bucketsindex);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getBucketsOwnerId($bucketsindex);

Procedural Interface

ipworks_s3_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

CompressionMethod Property (IPWorks_S3 Class)

Specifies an optional compression method.

Object Oriented Interface

public function getCompressionMethod();
public function setCompressionMethod($value);

Procedural Interface

ipworks_s3_get($res, 9 );
ipworks_s3_set($res, 9, $value );

Default Value

0

Remarks

This property specifies an optional compression method to use when calling CreateObject or GetObject. When set, the object data will be compressed or decompressed using the specified method. Possible values are:

• 0 (cmNone - default)
• 1 (cmDeflate)
• 2 (cmZlib)
• 3 (cmGzip)

Data Type

Integer

ContentDisposition Property (IPWorks_S3 Class)

This property includes content disposition to send for an object.

Object Oriented Interface

public function getContentDisposition();
public function setContentDisposition($value);

Procedural Interface

ipworks_s3_get($res, 10 );
ipworks_s3_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-Disposition header value. This same value will then be returned in the Content-Disposition header by the server any time the object is downloaded.

This property is not available at design time.

Data Type

String

ContentType Property (IPWorks_S3 Class)

This property includes the content type to send for an object.

Object Oriented Interface

public function getContentType();
public function setContentType($value);

Procedural Interface

ipworks_s3_get($res, 11 );
ipworks_s3_set($res, 11, $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 any time the object is downloaded.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (IPWorks_S3 Class)

This property includes the encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

ipworks_s3_get($res, 12 );
ipworks_s3_set($res, 12, $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 as follows:

Data Type

Integer

EncryptionPassword Property (IPWorks_S3 Class)

This property includes the encryption password.

Object Oriented Interface

public function getEncryptionPassword();
public function setEncryptionPassword($value);

Procedural Interface

ipworks_s3_get($res, 13 );
ipworks_s3_set($res, 13, $value );

Default Value

''

Remarks

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

The class uses the specified value 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.

It is also possible, however, to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, for example, the data need to be encrypted or decrypted by another utility that generates Key and IV values differently.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (IPWorks_S3 Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworks_s3_get($res, 14 );
ipworks_s3_set($res, 14, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorks_S3 Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworks_s3_get($res, 15 );
ipworks_s3_set($res, 15, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorks_S3 Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworks_s3_get($res, 16 );
ipworks_s3_set($res, 16, $value );

Default Value

''

Remarks

The name or IP address of the 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 (IPWorks_S3 Class)

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

ipworks_s3_get($res, 17 );
ipworks_s3_set($res, 17, $value );

Default Value

''

Remarks

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 (IPWorks_S3 Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworks_s3_get($res, 18 );
ipworks_s3_set($res, 18, $value );

Default Value

0

Remarks

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 (IPWorks_S3 Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworks_s3_get($res, 19 );
ipworks_s3_set($res, 19, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property 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 (IPWorks_S3 Class)

This property determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();
public function setFollowRedirects($value);

Procedural Interface

ipworks_s3_get($res, 20 );
ipworks_s3_set($res, 20, $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 as follows:

Data Type

Integer

Idle Property (IPWorks_S3 Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

ipworks_s3_get($res, 21 );

Default Value

true

Remarks

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

This property is read-only.

Data Type

Boolean

LocalFile Property (IPWorks_S3 Class)

This property includes the location of the local file.

Object Oriented Interface

public function getLocalFile();
public function setLocalFile($value);

Procedural Interface

ipworks_s3_get($res, 22 );
ipworks_s3_set($res, 22, $value );

Default Value

''

Remarks

This property specifies the location of a file on a 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 (IPWorks_S3 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

ipworks_s3_get($res, 23 );
ipworks_s3_set($res, 23, $value );

Default Value

''

Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

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 multihomed 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 (IPWorks_S3 Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();
public function setMetadataCount($value);

Procedural Interface

ipworks_s3_get($res, 24 );
ipworks_s3_set($res, 24, $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 (IPWorks_S3 Class)

The property contains the name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);
public function setMetadataName($metadataindex, $value);

Procedural Interface

ipworks_s3_get($res, 25 , $metadataindex);
ipworks_s3_set($res, 25, $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 (IPWorks_S3 Class)

This property contains the value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);
public function setMetadataValue($metadataindex, $value);

Procedural Interface

ipworks_s3_get($res, 26 , $metadataindex);
ipworks_s3_set($res, 26, $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 (IPWorks_S3 Class)

This property includes the data that were downloaded or that should be uploaded.

Object Oriented Interface

public function getObjectData();
public function setObjectData($value);

Procedural Interface

ipworks_s3_get($res, 27 );
ipworks_s3_set($res, 27, $value );

Default Value

''

Remarks

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

This property also can 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 (IPWorks_S3 Class)

This property includes the delimiter string to use when listing objects.

Object Oriented Interface

public function getObjectDelimiter();
public function setObjectDelimiter($value);

Procedural Interface

ipworks_s3_get($res, 28 );
ipworks_s3_set($res, 28, $value );

Default Value

''

Remarks

If this property is nonempty 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.

The PrefixList event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class also will 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 (IPWorks_S3 Class)

This property includes a marker indicating what page of objects to return next.

Object Oriented Interface

public function getObjectMarker();
public function setObjectMarker($value);

Procedural Interface

ipworks_s3_get($res, 29 );
ipworks_s3_set($res, 29, $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 an empty string.

Refer to ListObjects for more information.

Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (IPWorks_S3 Class)

This property includes a prefix used to restrict the results returned when listing objects.

Object Oriented Interface

public function getObjectPrefix();
public function setObjectPrefix($value);

Procedural Interface

ipworks_s3_get($res, 30 );
ipworks_s3_set($res, 30, $value );

Default Value

''

Remarks

This property, if nonempty, is used to restrict the results returned by ListObjects (or ListVersions) to only those 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 (IPWorks_S3 Class)

The number of records in the Objects arrays.

Object Oriented Interface

public function getObjectsCount();

Procedural Interface

ipworks_s3_get($res, 31 );

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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getObjectsDeleted($objectsindex);

Procedural Interface

ipworks_s3_get($res, 32 , $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 (IPWorks_S3 Class)

This property contains the ETag of the object.

Object Oriented Interface

public function getObjectsETag($objectsindex);

Procedural Interface

ipworks_s3_get($res, 33 , $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 (IPWorks_S3 Class)

This property contains the last modified time of the object.

Object Oriented Interface

public function getObjectsLastModified($objectsindex);

Procedural Interface

ipworks_s3_get($res, 34 , $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 (IPWorks_S3 Class)

This property specifies whether this is the latest object version.

Object Oriented Interface

public function getObjectsLatestVersion($objectsindex);

Procedural Interface

ipworks_s3_get($res, 35 , $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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getObjectsName($objectsindex);

Procedural Interface

ipworks_s3_get($res, 36 , $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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getObjectsOwnerDisplayName($objectsindex);

Procedural Interface

ipworks_s3_get($res, 37 , $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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getObjectsOwnerId($objectsindex);

Procedural Interface

ipworks_s3_get($res, 38 , $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 (IPWorks_S3 Class)

This property contains the size of the object.

Object Oriented Interface

public function getObjectsSize($objectsindex);

Procedural Interface

ipworks_s3_get($res, 39 , $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 (IPWorks_S3 Class)

This property contains the storage class of the object.

Object Oriented Interface

public function getObjectsStorageClass($objectsindex);

Procedural Interface

ipworks_s3_get($res, 40 , $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 (IPWorks_S3 Class)

This property contains the upload Id of the multipart upload.

Object Oriented Interface

public function getObjectsUploadId($objectsindex);

Procedural Interface

ipworks_s3_get($res, 41 , $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 (IPWorks_S3 Class)

This property contains the Id of the object version.

Object Oriented Interface

public function getObjectsVersionId($objectsindex);

Procedural Interface

ipworks_s3_get($res, 42 , $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 (IPWorks_S3 Class)

Other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();
public function setOtherHeaders($value);

Procedural Interface

ipworks_s3_get($res, 43 );
ipworks_s3_set($res, 43, $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 (IPWorks_S3 Class)

This property determines if local files are overwritten.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworks_s3_get($res, 44 );
ipworks_s3_set($res, 44, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (IPWorks_S3 Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

ipworks_s3_get($res, 45 );

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 (IPWorks_S3 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

ipworks_s3_get($res, 46 , $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 (IPWorks_S3 Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

ipworks_s3_get($res, 47 , $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 (IPWorks_S3 Class)

This property includes a marker indicating what page of parts to return next.

Object Oriented Interface

public function getPartMarker();
public function setPartMarker($value);

Procedural Interface

ipworks_s3_get($res, 48 );
ipworks_s3_set($res, 48, $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.

Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.

This property is not available at design time.

Data Type

String

PartsCount Property (IPWorks_S3 Class)

The number of records in the Parts arrays.

Object Oriented Interface

public function getPartsCount();

Procedural Interface

ipworks_s3_get($res, 49 );

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 (IPWorks_S3 Class)

This property contains the ETag of the part.

Object Oriented Interface

public function getPartsETag($partsindex);

Procedural Interface

ipworks_s3_get($res, 50 , $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 (IPWorks_S3 Class)

This property contains the last modified time of the part.

Object Oriented Interface

public function getPartsLastModified($partsindex);

Procedural Interface

ipworks_s3_get($res, 51 , $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 (IPWorks_S3 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

ipworks_s3_get($res, 52 , $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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getPartsOwnerDisplayName($partsindex);

Procedural Interface

ipworks_s3_get($res, 53 , $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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function getPartsOwnerId($partsindex);

Procedural Interface

ipworks_s3_get($res, 54 , $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 (IPWorks_S3 Class)

This property contains the number of the part.

Object Oriented Interface

public function getPartsNumber($partsindex);

Procedural Interface

ipworks_s3_get($res, 55 , $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 (IPWorks_S3 Class)

This property contains the size of the part.

Object Oriented Interface

public function getPartsSize($partsindex);

Procedural Interface

ipworks_s3_get($res, 56 , $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 (IPWorks_S3 Class)

The type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();
public function setProxyAuthScheme($value);

Procedural Interface

ipworks_s3_get($res, 57 );
ipworks_s3_set($res, 57, $value );

Default Value

0

Remarks

The 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 class 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 (IPWorks_S3 Class)

Whether to automatically detect and use proxy system settings, if available.

Object Oriented Interface

public function getProxyAutoDetect();
public function setProxyAutoDetect($value);

Procedural Interface

ipworks_s3_get($res, 58 );
ipworks_s3_set($res, 58, $value );

Default Value

false

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is false.

Data Type

Boolean

ProxyPassword Property (IPWorks_S3 Class)

A password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();
public function setProxyPassword($value);

Procedural Interface

ipworks_s3_get($res, 59 );
ipworks_s3_set($res, 59, $value );

Default Value

''

Remarks

A password 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

ProxyPort Property (IPWorks_S3 Class)

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();
public function setProxyPort($value);

Procedural Interface

ipworks_s3_get($res, 60 );
ipworks_s3_set($res, 60, $value );

Default Value

80

Remarks

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 (IPWorks_S3 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

ipworks_s3_get($res, 61 );
ipworks_s3_set($res, 61, $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 (IPWorks_S3 Class)

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

ipworks_s3_get($res, 62 );
ipworks_s3_set($res, 62, $value );

Default Value

0

Remarks

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 (IPWorks_S3 Class)

A username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();
public function setProxyUser($value);

Procedural Interface

ipworks_s3_get($res, 63 );
ipworks_s3_set($res, 63, $value );

Default Value

''

Remarks

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 (IPWorks_S3 Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();
public function setQueryParamCount($value);

Procedural Interface

ipworks_s3_get($res, 64 );
ipworks_s3_set($res, 64, $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 (IPWorks_S3 Class)

This property specifies the name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);
public function setQueryParamName($queryparamindex, $value);

Procedural Interface

ipworks_s3_get($res, 65 , $queryparamindex);
ipworks_s3_set($res, 65, $value , $queryparamindex);

Default Value

''

Remarks

This property specifies 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 (IPWorks_S3 Class)

This property contains the value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);
public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

ipworks_s3_get($res, 66 , $queryparamindex);
ipworks_s3_set($res, 66, $value , $queryparamindex);

Default Value

''

Remarks

This property contains 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 (IPWorks_S3 Class)

This property includes the range of bytes to request.

Object Oriented Interface

public function getRange();
public function setRange($value);

Procedural Interface

ipworks_s3_get($res, 67 );
ipworks_s3_set($res, 67, $value );

Default Value

''

Remarks

This property specifies the range of bytes to request from the server. If this property is nonempty 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.

Following are the 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 nonempty, 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 are not downloaded again when the download is resumed.

This property is not available at design time.

Data Type

String

Region Property (IPWorks_S3 Class)

This property includes the region the class will make requests against.

Object Oriented Interface

public function getRegion();
public function setRegion($value);

Procedural Interface

ipworks_s3_get($res, 68 );
ipworks_s3_set($res, 68, $value );

Default Value

'us-east-1'

Remarks

This property controls which region the class will make requests against; it should be changed to create or access resources in other regions.

Each service provider has a different default region, and the class will automatically set this property to the selected service provider's default region anytime ServiceProvider changes. The custom service provider's "default region" is an empty string (i.e., setting ServiceProvider to spCustom (255) will clear this property).

Note: When the custom service provider is selected, the class uses the base URL specified by the ServiceProviderURL configuration setting to generate request URLs. If the base URL contains a %region% token, the class will replace it with this property's value any time it generates a request URL. Refer to the ServiceProviderURL setting's documentation for more information.

Amazon S3 Regions

Alibaba Cloud Object Storage Regions

Backblaze B2 Regions

All Backblaze B2 region strings take the form us-west-###, where ### is a three-digit number. By default, the class uses us-west-000.

To determine the exact region string, log into the Backblaze B2 web console and refer to the "S3 Endpoint" value, which corresponds to the application keypair that will be used for authentication; this endpoint value will include the region string.

Note: The master application key for a Backblaze B2 account cannot be used with Backblaze's S3-compatible API; create a nonmaster application key if necessary.

Cloudflare R2 Regions

By default, the class uses auto. This is the only valid value for this service provider.

Digital Ocean Spaces Regions

Google Cloud Storage Regions

An asterisk (*) denotes a multiregional location.

Huawei Cloud Object Storage Regions

IBM Cloud Object Storage Regions

Note: Optionally, private. or direct. may be prepended to any of the values above; refer to IBM Cloud's Object Storage documentation for information on regions and endpoints.

Linode Object Storage Regions

Important: Each "region" supported by Linode's Object Storage service is actually a completely standalone storage cluster. These clusters do not interact with each other in any way, which causes the following nonstandard behaviors:

• Bucket names may be reused in each region (however, they must still be "globally" unique within each region).
• The ListBuckets method will return only those buckets located in the currently selected region; there is no way to retrieve a list of all regions' buckets.
• Similarly, the BucketExists and GetBucketLocation methods consider only those buckets located in the currently selected region.
• The CopyObject method cannot be used to copy objects to a bucket in another region.

Oracle Cloud Object Storage Regions

Wasabi 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 for the currently selected ServiceProvider.

Data Type

String

SecretKey Property (IPWorks_S3 Class)

This property includes the secret key to use for authentication.

Object Oriented Interface

public function getSecretKey();
public function setSecretKey($value);

Procedural Interface

ipworks_s3_get($res, 69 );
ipworks_s3_set($res, 69, $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 that connect to the server.

Data Type

String

ServiceProvider Property (IPWorks_S3 Class)

This property includes the S3 service provider to use.

Object Oriented Interface

public function getServiceProvider();
public function setServiceProvider($value);

Procedural Interface

ipworks_s3_get($res, 70 );
ipworks_s3_set($res, 70, $value );

Default Value

0

Remarks

This property specifies the S3 service provider that the class should use. Possible values are as follows:

Note: The following providers require additional configuration before requests can be made:

• spOracle (8): An Object Storage Namespace must be specified using the OracleNamespace configuration setting.
• spCloudflareR2 (10): An Account ID must be specified using the CloudflareAccountID configuration setting.
• spCustom (255): A base URL must be specified using the ServiceProviderURL configuration setting.

Changing this property will automatically result in the following actions:

• Set the Region property to the default region for the provider (empty string for spCustom (255)).
• Reset the UseSSL property to true.
• Reset the StartByte property to 0.
• Clear the ObjectMarker, PartMarker, and VersionMarker properties, as well as the StorageClass and ResumableUploadState configuration settings.

This property is not available at design time.

Data Type

Integer

SSLAcceptServerCertEffectiveDate Property (IPWorks_S3 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworks_s3_get($res, 71 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorks_S3 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworks_s3_get($res, 72 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorks_S3 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworks_s3_get($res, 73 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorks_S3 Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworks_s3_get($res, 74 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorks_S3 Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworks_s3_get($res, 75 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorks_S3 Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworks_s3_get($res, 76 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorks_S3 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworks_s3_get($res, 77 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorks_S3 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworks_s3_get($res, 78 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorks_S3 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_s3_get($res, 79 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorks_S3 Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworks_s3_get($res, 80 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorks_S3 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworks_s3_get($res, 81 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorks_S3 Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_s3_get($res, 82 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorks_S3 Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworks_s3_get($res, 83 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorks_S3 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworks_s3_get($res, 84 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorks_S3 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworks_s3_get($res, 85 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorks_S3 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworks_s3_get($res, 86 );
ipworks_s3_set($res, 86, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorks_S3 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 getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworks_s3_get($res, 87 );
ipworks_s3_set($res, 87, $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

SSLAcceptServerCertStoreType Property (IPWorks_S3 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworks_s3_get($res, 88 );
ipworks_s3_set($res, 88, $value );

Default Value

0

Remarks

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

SSLAcceptServerCertSubjectAltNames Property (IPWorks_S3 Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworks_s3_get($res, 89 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorks_S3 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworks_s3_get($res, 90 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorks_S3 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworks_s3_get($res, 91 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorks_S3 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworks_s3_get($res, 92 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorks_S3 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworks_s3_get($res, 93 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorks_S3 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworks_s3_get($res, 94 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorks_S3 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworks_s3_get($res, 95 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorks_S3 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworks_s3_get($res, 96 );
ipworks_s3_set($res, 96, $value );

Default Value

''

Remarks

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

SSLAcceptServerCertEncoded Property (IPWorks_S3 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworks_s3_get($res, 97 );
ipworks_s3_set($res, 97, $value );

Default Value

''

Remarks

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

SSLCertEffectiveDate Property (IPWorks_S3 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworks_s3_get($res, 98 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorks_S3 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworks_s3_get($res, 99 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorks_S3 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworks_s3_get($res, 100 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorks_S3 Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworks_s3_get($res, 101 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorks_S3 Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworks_s3_get($res, 102 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorks_S3 Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworks_s3_get($res, 103 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorks_S3 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworks_s3_get($res, 104 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorks_S3 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworks_s3_get($res, 105 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorks_S3 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworks_s3_get($res, 106 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorks_S3 Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworks_s3_get($res, 107 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorks_S3 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworks_s3_get($res, 108 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorks_S3 Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworks_s3_get($res, 109 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorks_S3 Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworks_s3_get($res, 110 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorks_S3 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworks_s3_get($res, 111 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorks_S3 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworks_s3_get($res, 112 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorks_S3 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworks_s3_get($res, 113 );
ipworks_s3_set($res, 113, $value );

Default Value

'MY'

Remarks

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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, 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 (IPWorks_S3 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

ipworks_s3_get($res, 114 );
ipworks_s3_set($res, 114, $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 (IPWorks_S3 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworks_s3_get($res, 115 );
ipworks_s3_set($res, 115, $value );

Default Value

0

Remarks

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

SSLCertSubjectAltNames Property (IPWorks_S3 Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworks_s3_get($res, 116 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorks_S3 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworks_s3_get($res, 117 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorks_S3 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworks_s3_get($res, 118 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorks_S3 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworks_s3_get($res, 119 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorks_S3 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworks_s3_get($res, 120 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorks_S3 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworks_s3_get($res, 121 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorks_S3 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworks_s3_get($res, 122 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorks_S3 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworks_s3_get($res, 123 );
ipworks_s3_set($res, 123, $value );

Default Value

''

Remarks

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

SSLCertEncoded Property (IPWorks_S3 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworks_s3_get($res, 124 );
ipworks_s3_set($res, 124, $value );

Default Value

''

Remarks

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

SSLProvider Property (IPWorks_S3 Class)

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Object Oriented Interface

public function getSSLProvider();
public function setSSLProvider($value);

Procedural Interface

ipworks_s3_get($res, 125 );
ipworks_s3_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 as follows:

Additional Notes

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

SSLServerCertEffectiveDate Property (IPWorks_S3 Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLServerCertEffectiveDate();

Procedural Interface

ipworks_s3_get($res, 126 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExpirationDate Property (IPWorks_S3 Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLServerCertExpirationDate();

Procedural Interface

ipworks_s3_get($res, 127 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLServerCertExtendedKeyUsage Property (IPWorks_S3 Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLServerCertExtendedKeyUsage();

Procedural Interface

ipworks_s3_get($res, 128 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLServerCertFingerprint Property (IPWorks_S3 Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprint();

Procedural Interface

ipworks_s3_get($res, 129 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA1 Property (IPWorks_S3 Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA1();

Procedural Interface

ipworks_s3_get($res, 130 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLServerCertFingerprintSHA256 Property (IPWorks_S3 Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLServerCertFingerprintSHA256();

Procedural Interface

ipworks_s3_get($res, 131 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLServerCertIssuer Property (IPWorks_S3 Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLServerCertIssuer();

Procedural Interface

ipworks_s3_get($res, 132 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLServerCertPrivateKey Property (IPWorks_S3 Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKey();

Procedural Interface

ipworks_s3_get($res, 133 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLServerCertPrivateKey may be available but not exportable. In this case, SSLServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLServerCertPrivateKeyAvailable Property (IPWorks_S3 Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLServerCertPrivateKeyAvailable();

Procedural Interface

ipworks_s3_get($res, 134 );

Default Value

false

Remarks

Whether a SSLServerCertPrivateKey is available for the selected certificate. If SSLServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLServerCertPrivateKeyContainer Property (IPWorks_S3 Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLServerCertPrivateKeyContainer();

Procedural Interface

ipworks_s3_get($res, 135 );

Default Value

''

Remarks

The name of the SSLServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLServerCertPublicKey Property (IPWorks_S3 Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLServerCertPublicKey();

Procedural Interface

ipworks_s3_get($res, 136 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyAlgorithm Property (IPWorks_S3 Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLServerCertPublicKeyAlgorithm();

Procedural Interface

ipworks_s3_get($res, 137 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertPublicKeyLength Property (IPWorks_S3 Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLServerCertPublicKeyLength();

Procedural Interface

ipworks_s3_get($res, 138 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLServerCertSerialNumber Property (IPWorks_S3 Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLServerCertSerialNumber();

Procedural Interface

ipworks_s3_get($res, 139 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLServerCertSignatureAlgorithm Property (IPWorks_S3 Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLServerCertSignatureAlgorithm();

Procedural Interface

ipworks_s3_get($res, 140 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLServerCertStore Property (IPWorks_S3 Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLServerCertStore();

Procedural Interface

ipworks_s3_get($res, 141 );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLServerCertStoreType property denotes the type of the certificate store specified by SSLServerCertStore. If the store is password-protected, specify the password in SSLServerCertStorePassword.

SSLServerCertStore is used in conjunction with the SSLServerCertSubject property to specify client certificates. If SSLServerCertStore has a value, and SSLServerCertSubject or SSLServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLServerCertSubject 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 cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

Data Type

Binary String

SSLServerCertStorePassword Property (IPWorks_S3 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 getSSLServerCertStorePassword();

Procedural Interface

ipworks_s3_get($res, 142 );

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.

This property is read-only.

Data Type

String

SSLServerCertStoreType Property (IPWorks_S3 Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLServerCertStoreType();

Procedural Interface

ipworks_s3_get($res, 143 );

Default Value

0

Remarks

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:

This property is read-only.

Data Type

Integer

SSLServerCertSubjectAltNames Property (IPWorks_S3 Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLServerCertSubjectAltNames();

Procedural Interface

ipworks_s3_get($res, 144 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLServerCertThumbprintMD5 Property (IPWorks_S3 Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintMD5();

Procedural Interface

ipworks_s3_get($res, 145 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA1 Property (IPWorks_S3 Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA1();

Procedural Interface

ipworks_s3_get($res, 146 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertThumbprintSHA256 Property (IPWorks_S3 Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLServerCertThumbprintSHA256();

Procedural Interface

ipworks_s3_get($res, 147 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLServerCertUsage Property (IPWorks_S3 Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLServerCertUsage();

Procedural Interface

ipworks_s3_get($res, 148 );

Default Value

''

Remarks

The text description of SSLServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLServerCertUsageFlags Property (IPWorks_S3 Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLServerCertUsageFlags();

Procedural Interface

ipworks_s3_get($res, 149 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLServerCertUsageFlags is a combination of the following flags:

Please see the SSLServerCertUsage property for a text representation of SSLServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLServerCertVersion Property (IPWorks_S3 Class)

The certificate's version number.

Object Oriented Interface

public function getSSLServerCertVersion();

Procedural Interface

ipworks_s3_get($res, 150 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLServerCertSubject Property (IPWorks_S3 Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLServerCertSubject();

Procedural Interface

ipworks_s3_get($res, 151 );

Default Value

''

Remarks

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.

This property is read-only.

Data Type

String

SSLServerCertEncoded Property (IPWorks_S3 Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

ipworks_s3_get($res, 152 );

Default Value

''

Remarks

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 (IPWorks_S3 Class)

This property includes the byte offset from which to resume the upload or download.

Object Oriented Interface

public function getStartByte();
public function setStartByte($value);

Procedural Interface

ipworks_s3_get($res, 153 );
ipworks_s3_set($res, 153, $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.

Note: This property is automatically reset to 0 anytime ServiceProvider changes.

This property is not available at design time.

Data Type

Long64

Timeout Property (IPWorks_S3 Class)

The timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworks_s3_get($res, 154 );
ipworks_s3_set($res, 154, $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.

Note: By default, all timeouts are inactivity timeouts, that is, 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 (IPWorks_S3 Class)

This method includes whether to use SSL/TLS when connecting.

Object Oriented Interface

public function getUseSSL();
public function setUseSSL($value);

Procedural Interface

ipworks_s3_get($res, 155 );
ipworks_s3_set($res, 155, $value );

Default Value

true

Remarks

This property specifies whether the class should use Secure Sockets Layer/Transport Layer Security (SSL/TLS) when connecting.

Note: This property is automatically reset to true any time ServiceProvider changes. The class will ignore any attempts to change this property if one of the following providers is selected, because they require SSL/TLS to be used:

• spDigitalOcean (1)
• spBackblazeB2 (4)
• spOracle (8)
• spSeagateLyveCloud (11)

This property is not available at design time.

Data Type

Boolean

UseVirtualHosting Property (IPWorks_S3 Class)

This property determines which URL style to use when making requests.

Object Oriented Interface

public function getUseVirtualHosting();
public function setUseVirtualHosting($value);

Procedural Interface

ipworks_s3_get($res, 156 );
ipworks_s3_set($res, 156, $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: Hosted-style URLs impose more bucket name restrictions because of 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.

Note: When using the spAmazonS3 (0) service provider, keep in mind that 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.

Note: This property is ignored when ServiceProvider is set to one of the following:

• spAlibaba (6) Alibaba does not support path-style URLs, only virtual-hosted-style URLs.
• spOracle (8) Oracle Cloud Object Storage does not support virtual-hosted-style URLs, only path-style URLs.
• spOortDSS (12) Oort DSS does not support virtual-hosted-style URLs, only path-style URLs.

This property is not available at design time.

Data Type

Boolean

VersionId Property (IPWorks_S3 Class)

This property includes the object version to make requests against.

Object Oriented Interface

public function getVersionId();
public function setVersionId($value);

Procedural Interface

ipworks_s3_get($res, 157 );
ipworks_s3_set($res, 157, $value );

Default Value

''

Remarks

This property can be set to the Id of a specific object version before calling the following methods 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

VersionMarker Property (IPWorks_S3 Class)

This property includes a marker indicating what page of object versions to return next.

Object Oriented Interface

public function getVersionMarker();
public function setVersionMarker($value);

Procedural Interface

ipworks_s3_get($res, 158 );
ipworks_s3_set($res, 158, $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.

Note: This property is cleared any time ServiceProvider changes; marker values are valid only when used with the provider that generated them.

This property is not available at design time.

Data Type

String

AbortMultipartUpload Method (IPWorks_S3 Class)

This method aborts a multipart upload.

Object Oriented Interface

public function doAbortMultipartUpload($objectname, $uploadid);

Procedural Interface

ipworks_s3_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: If any part of the upload is currently in progress, it may be necessary to call this method again after the upload is complete.

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

AddMetadata Method (IPWorks_S3 Class)

Adds a metadata item to the Metadata properties.

Object Oriented Interface

public function doAddMetadata($name, $value);

Procedural Interface

ipworks_s3_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. The server stores metadata names in lowercase.

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

AddQueryParam Method (IPWorks_S3 Class)

This method adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

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

Remarks

This method is used to add a query parameter to the QueryParams 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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function doAppendObject($objectname);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method checks whether the bucket exists.

Object Oriented Interface

public function doBucketExists();

Procedural Interface

ipworks_s3_do_bucketexists($res);

Remarks

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

Note: When ServiceProvider is spLinode (9), this method considers only buckets located in the currently selected Region. Refer to the Linode section of the Region property's documentation for more information.

CheckVersioningEnabled Method (IPWorks_S3 Class)

This method checks whether versioning is enabled for the currently selected bucket.

Object Oriented Interface

public function doCheckVersioningEnabled();

Procedural Interface

ipworks_s3_do_checkversioningenabled($res);

Remarks

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

Note: 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. This behavior also occurs if the currently selected service provider does not support versioning at all.

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

Note: When ServiceProvider is spBackblazeB2 (4), this property will always return true (assuming Bucket is nonempty), and any attempt to change it will fail; Backblaze B2 buckets are always versioned.

CompleteMultipartUpload Method (IPWorks_S3 Class)

This method completes a multipart upload by assembling previously uploaded parts.

Object Oriented Interface

public function doCompleteMultipartUpload($objectname, $uploadid);

Procedural Interface

ipworks_s3_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: 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. The spCloudflareR2 (10) ServiceProvider does not support the ListParts S3 operation; thus, when that provider is selected, this method instead relies on the part information contained in the PartInfo[i] configuration setting.

Config Method (IPWorks_S3 Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method copies an object.

Object Oriented Interface

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

Procedural Interface

ipworks_s3_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 nonempty, 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 any metadata items are 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 be copied only to buckets that exist within the same region.
• Objects larger than 5 GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using StartMultipartUpload. Then use the CopyPart method to create parts for that multipart upload using the source object's data.

CopyPart Method (IPWorks_S3 Class)

This method copies the specified object as a part of a multipart upload.

Object Oriented Interface

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

Procedural Interface

ipworks_s3_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.

Note: This method is not supported when ServiceProvider is spGoogleStorage (2).

CreateBucket Method (IPWorks_S3 Class)

This method creates a new bucket.

Object Oriented Interface

public function doCreateBucket();

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method creates a new object in the currently selected bucket.

Object Oriented Interface

public function doCreateObject($objectname);

Procedural Interface

ipworks_s3_do_createobject($res, $objectname);

Remarks

This method creates a new object named Object in the bucket currently selected by Bucket. If any metadata items are present in the Metadata properties, they will be 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 the upload state information using the ResumableUploadState configuration setting; and tracks how much data have 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 (IPWorks_S3 Class)

This method deletes a bucket.

Object Oriented Interface

public function doDeleteBucket();

Procedural Interface

ipworks_s3_do_deletebucket($res);

Remarks

This method deletes the bucket currently selected by Bucket.

Note: For some service providers, 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. Refer to the provider's documentation for more information.

DeleteObject Method (IPWorks_S3 Class)

This method deletes an object.

Object Oriented Interface

public function doDeleteObject($objectname);

Procedural Interface

ipworks_s3_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 nonempty, this method deletes the specified version of the object instead.

Deleting Versioned Objects

If a bucket has versioning enabled (i.e., CheckVersioningEnabled returns true when queried), and this method is called on an object rather than a specific object version, then instead of actually deleting any data, the server will simply create a special object version called a delete marker.

If an object's latest version is a delete marker, then the server treats the object as if it did not exist (i.e., it does not appear when listing objects or it cannot be downloaded). If, however, all of the previous versions of the object (including the one that existed just before the delete marker was created) still exist, then they can be listed using ListVersions and explicitly can be 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 (IPWorks_S3 Class)

This method disables versioning for the currently selected bucket.

Object Oriented Interface

public function doDisableVersioning();

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method enables versioning for the currently selected bucket.

Object Oriented Interface

public function doEnableVersioning();

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method gets a bucket's location.

Object Oriented Interface

public function doGetBucketLocation();

Procedural Interface

ipworks_s3_do_getbucketlocation($res);

Remarks

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

Note: When ServiceProvider is spLinode (9), this method considers only buckets located in the currently selected Region. Refer to the Linode section of the Region property's documentation for more information.

GetLink Method (IPWorks_S3 Class)

This method 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

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

Remarks

This method creates and returns a preauthenticated link that provides access to the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId property is nonempty, 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: This method is an offline method that simply generates a presigned URL; no communication with the server takes place.

Note: This method is not supported when ServiceProvider is set to one of the following:

• spGoogleStorage (2)
• spOracle (8)

GetObject Method (IPWorks_S3 Class)

This method downloads an object.

Object Oriented Interface

public function doGetObject($objectname);

Procedural Interface

ipworks_s3_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 nonempty, 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);

Example 1. 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);

Example 2. Resuming Encrypted File Downloads:

Resuming encrypted file downloads is supported only when LocalFile has been 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 are 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 (IPWorks_S3 Class)

This method gets an object's information and metadata.

Object Oriented Interface

public function doGetObjectInfo($objectname);

Procedural Interface

ipworks_s3_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 nonempty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the ObjectList and MetadataList events and also will repopulate the Objects and Metadata collection properties.

Interrupt Method (IPWorks_S3 Class)

This method interrupts the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworks_s3_do_interrupt($res);

Remarks

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

ListBuckets Method (IPWorks_S3 Class)

This method lists all buckets in the account.

Object Oriented Interface

public function doListBuckets();

Procedural Interface

ipworks_s3_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 also will populate the Buckets properties.

Note: When ServiceProvider is spLinode (9), this method returns only buckets located in the currently selected Region, and it is not possible to retrieve a list of all regions' buckets. Refer to the Linode section of the Region property's documentation for more information.

ListMultipartUploads Method (IPWorks_S3 Class)

This method lists the current multipart uploads.

Object Oriented Interface

public function doListMultipartUploads();

Procedural Interface

ipworks_s3_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 to restrict the results to only the multipart uploads whose names begin with a given string. The ObjectDelimiter property also can 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 also will populate the Objects properties.

If more multipart uploads are still 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 of the pages of results in the Objects properties.

Note: This method is not supported when ServiceProvider is spOortDSS (12).

Note: When the ServiceProvider is spSeagateLyveCloud (11) the ObjectPrefix property must be specified.

ListObjects Method (IPWorks_S3 Class)

This method lists the objects in a bucket.

Object Oriented Interface

public function doListObjects();

Procedural Interface

ipworks_s3_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 to restrict the results to only those objects whose names begin with a given string. The ObjectDelimiter property also can 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 also will populate the Objects properties. It also may fire the PrefixList event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If more objects are still 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 of the 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 (IPWorks_S3 Class)

This method lists the parts in a multipart upload.

Object Oriented Interface

public function doListParts($objectname, $uploadid);

Procedural Interface

ipworks_s3_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 also will populate the Parts properties.

If more parts are still 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 of the pages of results in the Parts properties.

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.

Note: spCloudflareR2 (10) does not support the ListParts S3 operation.

ListVersions Method (IPWorks_S3 Class)

This method lists the object versions in a bucket.

Object Oriented Interface

public function doListVersions();

Procedural Interface

ipworks_s3_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 to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter property also can 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 also will populate the Objects properties. It also may fire the PrefixList event and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If more object versions are still 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 (IPWorks_S3 Class)

This method resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_s3_do_reset($res);

Remarks

This method resets the class to its initial state.

ResetHeaders Method (IPWorks_S3 Class)

This method resets all HTTP headers, cookies, and LocalFile.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

ipworks_s3_do_resetheaders($res);

Remarks

This method resets all HTTP headers as well as LocalFile to "" (empty string), and clears the Metadata and QueryParams collection 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 request.

SendCustomRequest Method (IPWorks_S3 Class)

This method sends a custom request to the server.

Object Oriented Interface

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

Procedural Interface

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

Remarks

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

Valid values for HttpMethod are as follows:

• 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 ServiceProvider is spCustom (255), the custom URL specified using the ServiceProviderURL configuration setting is used directly, and these properties are ignored.
   • Bucket (if nonempty)
   • ObjectName (if nonempty)
   • VersionId (if both it and ObjectName are nonempty)
   • QueryParams
2. Adds request headers from the following:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • SessionToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if nonempty.
5. Stores the response headers in the ParsedHeaders properties; and the response body in the specified LocalFile, or ObjectData (using the same logic as GetObject).

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

StartMultipartUpload Method (IPWorks_S3 Class)

This method starts a new manual multipart upload.

Object Oriented Interface

public function doStartMultipartUpload($objectname);

Procedural Interface

ipworks_s3_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 any metadata items are 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 (IPWorks_S3 Class)

This method updates a bucket's canned access policy.

Object Oriented Interface

public function doUpdateBucketACL();

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This method updates an object's canned access policy.

Object Oriented Interface

public function doUpdateObjectACL($objectname);

Procedural Interface

ipworks_s3_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 nonempty, the canned access policy of the specified version of the object is updated instead.

UploadPart Method (IPWorks_S3 Class)

This method uploads a multipart upload part.

Object Oriented Interface

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

Procedural Interface

ipworks_s3_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 are taken from either LocalFile or ObjectData (whichever data are found first, when checked in that order). Each part must be at least 5 MB 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 then will verify that the data were received without corruption.

BucketList Event (IPWorks_S3 Class)

This event fires once for each bucket returned when listing buckets.

Object Oriented Interface

public function fireBucketList($param);

Procedural Interface

ipworks_s3_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 the name of the bucket's owner, respectively.

EndTransfer Event (IPWorks_S3 Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

This event fires after each part in an automatic multipart upload is complete.

Object Oriented Interface

public function fireFragmentComplete($param);

Procedural Interface

ipworks_s3_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 divide the upload data 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 of the upload that has been 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 (IPWorks_S3 Class)

Fired every time a header line comes in.

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

Fired once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

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

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event is fired 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 (IPWorks_S3 Class)

This event fires once for each metadata item returned when object information and metadata are retrieved.

Object Oriented Interface

public function fireMetadataList($param);

Procedural Interface

ipworks_s3_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-).

Note: The server stores metadata names in lowercase.

Value is the metadata item's value.

ObjectList Event (IPWorks_S3 Class)

This event fires once for each object, object version, or multipart upload returned when listing such items.

Object Oriented Interface

public function fireObjectList($param);

Procedural Interface

ipworks_s3_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. This is not applicable when ListMultipartUploads is called.

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

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

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

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

VersionId reflects the Id of the object version (note that 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.; is empty in all other cases.

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

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

PartList Event (IPWorks_S3 Class)

This event fires once for every part returned when listing a multipart upload's parts.

Object Oriented Interface

public function firePartList($param);

Procedural Interface

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

Parameter List

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

Remarks

This event fires once for each part of a multipart upload that is 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 (IPWorks_S3 Class)

This event fires once for each common prefix returned when listing objects.

Object Oriented Interface

public function firePrefixList($param);

Procedural Interface

ipworks_s3_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 nonempty. 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 (IPWorks_S3 Class)

This event fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworks_s3_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. By default, this event will fire each time PercentDone increases by 1 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 the note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown.

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 were transferred before the interruption.

For example, if 10 MB of data were successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10 MB) when the transfer is first resumed, and then will 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 (IPWorks_S3 Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

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

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworks_s3_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 (IPWorks_S3 Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworks_s3_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 (S3 Class)

The class accepts one or more of the following configuration settings. Configuration 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.

S3 Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

Trappable Errors (S3 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

SSL Errors

TCP/IP Errors