Index of all elements
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ g ]
[ h ]
[ i ]
[ k ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ v ]
[ _ ]
top
top
top
d
- $data
- in file Object.php, variable Services_Amazon_S3_Resource_Object::$data
The object data.
- $delimiter
- in file Prefix.php, variable Services_Amazon_S3_Prefix::$delimiter
This delimiter used when listing objects, or false if no delimiter is used.
- $delimiter
- in file ObjectIterator.php, variable Services_Amazon_S3_ObjectIterator::$delimiter
If specified, keys that contain this string after the prefix are rolled up into a single Services_Amazon_S3_Prefix instance.
- $dnsStrict
- in file Bucket.php, variable Services_Amazon_S3_Resource_Bucket::$dnsStrict
Whether or not DNS strict mode is enabled
- delete
- in file Resource.php, method Services_Amazon_S3_Resource::delete()
Deletes this resource from the server.
- dir_closedir
- in file Stream.php, method Services_Amazon_S3_Stream::dir_closedir()
Support for closedir().
- dir_opendir
- in file Stream.php, method Services_Amazon_S3_Stream::dir_opendir()
Support for opendir().
- dir_readdir
- in file Stream.php, method Services_Amazon_S3_Stream::dir_readdir()
Support for readdir().
- dir_rewinddir
- in file Stream.php, method Services_Amazon_S3_Stream::dir_rewinddir()
Support for rewinddir().
top
e
- $endpoint
- in file S3.php, variable Services_Amazon_S3::$endpoint
The hostname of the endpoint used for requests done by this class and requests for buckets done with REQUEST_STYLE_VIRTUAL_HOST and REQUEST_STYLE_PATH. This value may be specified per bucket using $bucket->endpoint.
- $endpoint
- in file Bucket.php, variable Services_Amazon_S3_Resource_Bucket::$endpoint
The hostname of the endpoint used for requests done with REQUEST_STYLE_PATH and REQUEST_STYLE_VIRTUAL_HOST. This value is initialized from $this->s3->endpoint.
- $eTag
- in file Object.php, variable Services_Amazon_S3_Resource_Object::$eTag
The ETag of the resource. This property is read-only.
- $exists
- in file Resource.php, variable Services_Amazon_S3_Resource::$exists
Whether this object is known to exist or the server. This is updated in self::load().
- Exception.php
- procedural page Exception.php
top
g
- getAccount
- in file S3.php, method Services_Amazon_S3::getAccount()
Returns an account instance with the specified credentials. This may be used to access resources owned by this account as well as resources owned by other accounts that have permissions granted to this account or to the authenticated users group.
- getAmazonErrorCode
- in file Exception.php, method Services_Amazon_S3_Exception::getAmazonErrorCode()
The Amazon S3 error code.
- getAnonymousAccount
- in file S3.php, method Services_Amazon_S3::getAnonymousAccount()
Returns an unauthorized account instance. This can be used to access resources that have permissions granted to anonymous users.
- getBucket
- in file S3.php, method Services_Amazon_S3::getBucket()
Returns the buckets with the specified name.
- getBuckets
- in file S3.php, method Services_Amazon_S3::getBuckets()
Returns the buckets owned by the current user.
- getChildren
- in file ObjectIterator.php, method Services_Amazon_S3_ObjectIterator::getChildren()
Returns an iterator over objects whose key starting with the common prefix represented by this iterator's current key.
- getDOMXPath
- in file S3.php, method Services_Amazon_S3::getDOMXPath()
Returns a DOMXPath object for the XML document in the body of the specified HTTP response. This method is for internal use only.
- getGrantees
- in file AccessControlList.php, method Services_Amazon_S3_AccessControlList::getGrantees()
Returns an array of grantee arrays.
- getGrantees
- in file LoggingStatus.php, method Services_Amazon_S3_LoggingStatus::getGrantees()
Returns an array of grantee arrays.
- getLogging
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::getLogging()
Get the logging information of this Bucket
- getObject
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::getObject()
Returns the object with the specified key. The object may or may not exist on the server. Use {@see Services_Amazon_S3_Resource_Object::load()} to query the server.
- getObjects
- in file Prefix.php, method Services_Amazon_S3_Prefix::getObjects()
Returns an iterator over objects whose key starting with this common prefix.
- getObjects
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::getObjects()
Returns an iterator over Services_Amazon_S3_Resource_Object and Services_Amazon_S3_Prefix instances in this bucket.
- getPermissions
- in file LoggingStatus.php, method Services_Amazon_S3_LoggingStatus::getPermissions()
Returns the permissions for the specified grantee.
- getPermissions
- in file AccessControlList.php, method Services_Amazon_S3_AccessControlList::getPermissions()
Returns the permissions for the specified grantee.
- getRequestSignature
- in file S3.php, method Services_Amazon_S3::getRequestSignature()
Signs the specified request with the secret key and returns the request signature used by Services_Amazon_S3::sendRequest and Services_Amazon_S3_Resource_Bucket::getSignedUrl().
- getSignedUrl
- in file Resource.php, method Services_Amazon_S3_Resource::getSignedUrl()
Returns an URL with credentials included in the query string. This will allow access to private resources without further authentication, e.g.
- getTorrentURL
- in file Object.php, method Services_Amazon_S3_Resource_Object::getTorrentURL()
Returns a URL of a .torrent file for this object.
- getURL
- in file S3.php, method Services_Amazon_S3::getURL()
Returns the base URL of this resource.
- getURL
- in file Object.php, method Services_Amazon_S3_Resource_Object::getURL()
Returns the URL of this object.
- getURL
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::getURL()
Returns the URL of this bucket.
- getURL
- in file Resource.php, method Services_Amazon_S3_Resource::getURL()
Returns the URL of this resource.
top
h
- $httpConfig
- in file S3.php, variable Services_Amazon_S3::$httpConfig
Configuration parameters for HTTP_Request2, e.g. proxy server, timeout etc. NOTE: Some options may interfere with this service.
- $httpHeaders
- in file Object.php, variable Services_Amazon_S3_Resource_Object::$httpHeaders
Additional HTTP headers that are returned when resource is fetching using the rest API. Only the field names listed self::$allowedHeaders are allowed. Field names are transferred and returned in lowercase for easier comparison.
- hasChildren
- in file ObjectIterator.php, method Services_Amazon_S3_ObjectIterator::hasChildren()
Returns whether the current key represents a common prefix.
top
top
top
l
- $lastModified
- in file Object.php, variable Services_Amazon_S3_Resource_Object::$lastModified
The last modified timestamp of the file. This property is read-only.
- $locationConstraint
- in file Bucket.php, variable Services_Amazon_S3_Resource_Bucket::$locationConstraint
The geographical location constraint of this bucket.
- $loggingStatus
- in file Bucket.php, variable Services_Amazon_S3_Resource_Bucket::$loggingStatus
The logging status of this bucket
- load
- in file LoggingStatus.php, method Services_Amazon_S3_LoggingStatus::load()
Loads this ACL from the server.
- load
- in file Object.php, method Services_Amazon_S3_Resource_Object::load()
Loads this object from the server.
- load
- in file Resource.php, method Services_Amazon_S3_Resource::load()
Loads this resource from the server and propagates relevant properties.
- load
- in file AccessControlList.php, method Services_Amazon_S3_AccessControlList::load()
Loads this ACL from the server.
- load
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::load()
Loads this resource from the server and propagates relevant properties.
- loadACL
- in file Resource.php, method Services_Amazon_S3_Resource::loadACL()
Loads this resource's access control list from the server and propagates the acl property.
- loadLocationConstraint
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::loadLocationConstraint()
Queries the server for the location constraint for this bucket and propagates the locationConstraint property.
- loadLoggingStatus
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::loadLoggingStatus()
Loads this bucket's logging status from the server
- LOAD_DATA
- in file Object.php, class constant Services_Amazon_S3_Resource_Object::LOAD_DATA
Load both data and metadata.
- LOAD_METADATA_ONLY
- in file Object.php, class constant Services_Amazon_S3_Resource_Object::LOAD_METADATA_ONLY
Load only metadata, not data.
- LoggingStatus.php
- procedural page LoggingStatus.php
top
m
- $maxKeys
- in file S3.php, variable Services_Amazon_S3::$maxKeys
Maximum number of keys to fetch per request when iterating over the objects of a bucket. A low value will result in more requests to the serve. This value may be specified on the iterator using $iterator->maxKeys.
- $maxKeys
- in file ObjectIterator.php, variable Services_Amazon_S3_ObjectIterator::$maxKeys
Maximum number of keys to fetch per request. A low value will result in more requests to the server. This value is initialized from $this->s3->maxKeys.
- $maxRetries
- in file S3.php, variable Services_Amazon_S3::$maxRetries
Maximum number of retries to make if a request fails with a 500 Internal server error, or if a transport-level error occurs.
- mkdir
- in file Stream.php, method Services_Amazon_S3_Stream::mkdir()
Support for mkdir().
- MODE_DIRECTORY
- in file Stream.php, class constant Services_Amazon_S3_Stream::MODE_DIRECTORY
Directory with 0777 access - see "man 2 stat".
- MODE_FILE
- in file Stream.php, class constant Services_Amazon_S3_Stream::MODE_FILE
Regular file with 0777 access - see "man 2 stat".
top
top
top
p
- $prefix
- in file Prefix.php, variable Services_Amazon_S3_Prefix::$prefix
This common prefix used by this
- $prefix
- in file ObjectIterator.php, variable Services_Amazon_S3_ObjectIterator::$prefix
If specified, only objects whose keys begin with this string are returned.
- PERMISSION_FULL_CONTROL
- in file AccessControlList.php, class constant Services_Amazon_S3_AccessControlList::PERMISSION_FULL_CONTROL
Permission to read and write the resource and its access control policy.
- PERMISSION_NONE
- in file LoggingStatus.php, class constant Services_Amazon_S3_LoggingStatus::PERMISSION_NONE
No permissions - may be used to remove a grantee from the ACL.
- PERMISSION_NONE
- in file AccessControlList.php, class constant Services_Amazon_S3_AccessControlList::PERMISSION_NONE
No permissions - may be used to remove a grantee from the ACL.
- PERMISSION_READ
- in file LoggingStatus.php, class constant Services_Amazon_S3_LoggingStatus::PERMISSION_READ
Permission to read the resource.
- PERMISSION_READ
- in file AccessControlList.php, class constant Services_Amazon_S3_AccessControlList::PERMISSION_READ
Permission to read the resource.
- PERMISSION_READ_ACP
- in file AccessControlList.php, class constant Services_Amazon_S3_AccessControlList::PERMISSION_READ_ACP
Permission to read the access control policy of a resource.
- PERMISSION_WRITE
- in file AccessControlList.php, class constant Services_Amazon_S3_AccessControlList::PERMISSION_WRITE
Permission to write the resource.
- PERMISSION_WRITE_ACP
- in file AccessControlList.php, class constant Services_Amazon_S3_AccessControlList::PERMISSION_WRITE_ACP
Permission to change the access control policy of a resource.
- Prefix.php
- procedural page Prefix.php
top
r
- $request
- in file S3.php, variable Services_Amazon_S3::$request
Object used to make HTTP requests for the S3 REST API.
- $requestStyle
- in file S3.php, variable Services_Amazon_S3::$requestStyle
The default method for accessing buckets. This value may be specified per bucket using $bucket->requestStyle.
- $requestStyle
- in file Bucket.php, variable Services_Amazon_S3_Resource_Bucket::$requestStyle
Method for accessing this bucket. This value is initialized from $this->s3->requestStyle.
- $resource
- in file AccessControlList.php, variable Services_Amazon_S3_AccessControlList::$resource
The resource this ACL applies to.
- $response
- in file Exception.php, variable Services_Amazon_S3_Exception::$response
The unexpected HTTP response.
- register
- in file Stream.php, method Services_Amazon_S3_Stream::register()
Register this stream wrapper with the specified prefix and options.
- rename
- in file Stream.php, method Services_Amazon_S3_Stream::rename()
Support for rename(). The renaming isn't atomic as rename() usually is, but the write part is.
- REQUEST_STYLE_CNAME
- in file Bucket.php, class constant Services_Amazon_S3_Resource_Bucket::REQUEST_STYLE_CNAME
Access bucket using http://mybucket.example.com/ (the name of the bucket is "mybucket.example.tld"). The hostname mybucket.example.com should be defined as a CNAME record pointing to mybucket.example.tld.s3.amazonaws.com.
- REQUEST_STYLE_PATH
- in file Bucket.php, class constant Services_Amazon_S3_Resource_Bucket::REQUEST_STYLE_PATH
Access bucket using http://s3.amazonaws.com/mybucket. Will not work for buckets with location constraints, e.g. a bucket hosted at Amazon's facility in Europe.
- REQUEST_STYLE_VIRTUAL_HOST
- in file Bucket.php, class constant Services_Amazon_S3_Resource_Bucket::REQUEST_STYLE_VIRTUAL_HOST
Access bucket using http://mybucket.s3.amazonaws.com. This will not work for bucket names that are not "DNS-friendly".
- rewind
- in file ObjectIterator.php, method Services_Amazon_S3_ObjectIterator::rewind()
Resets the internal iterator pointer.
- rmdir
- in file Stream.php, method Services_Amazon_S3_Stream::rmdir()
Support for rmdir().
- Resource.php
- procedural page Resource.php
top
s
- $s3
- in file Resource.php, variable Services_Amazon_S3_Resource::$s3
The service instance this resource belongs to.
- $secretAccessKey
- in file S3.php, variable Services_Amazon_S3::$secretAccessKey
Amazon Web Services Secret Access Key.
- $size
- in file Object.php, variable Services_Amazon_S3_Resource_Object::$size
The size of the object (excluding metadata) in bytes. This is property is read-only.
- save
- in file LoggingStatus.php, method Services_Amazon_S3_LoggingStatus::save()
Saves this ACL to the server.
- save
- in file Object.php, method Services_Amazon_S3_Resource_Object::save()
Saves this object to the server.
- save
- in file Resource.php, method Services_Amazon_S3_Resource::save()
Saves this resource to the server (including its access control list).
- save
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::save()
Saves this bucket to the server
- save
- in file AccessControlList.php, method Services_Amazon_S3_AccessControlList::save()
Saves this ACL to the server.
- sendRequest
- in file S3.php, method Services_Amazon_S3::sendRequest()
Sends the specified request to the server. This method is for internal use only.
- Services_Amazon_S3
- in file S3.php, class Services_Amazon_S3
The main S3 class contains the credentials used for accessing the S3 service and is a starting point for accessing the storage service.
- ServerErrorException.php
- procedural page ServerErrorException.php
- Stream.php
- procedural page Stream.php
- S3.php
- procedural page S3.php
- Services_Amazon_S3_AccessControlList
- in file AccessControlList.php, class Services_Amazon_S3_AccessControlList
This class represents an access control list for a bucket or an object.
- Services_Amazon_S3_AccessDeniedException
- in file AccessDeniedException.php, class Services_Amazon_S3_AccessDeniedException
Services_Amazon_S3_AccessDeniedException is an exception class representing 403 Forbidden errors, i.e. when access to buckets and objects is denied due to insufficient permissions.
- Services_Amazon_S3_Exception
- in file Exception.php, class Services_Amazon_S3_Exception
Services_Amazon_S3_Exception is a general exception class that is used for unexpected responses from the server (possibly caused by invalid data supplied by the user) or invalid data supplied by the user.
- Services_Amazon_S3_LoggingStatus
- in file LoggingStatus.php, class Services_Amazon_S3_LoggingStatus
This class represents logging status for a bucket
- Services_Amazon_S3_NotFoundException
- in file NotFoundException.php, class Services_Amazon_S3_NotFoundException
Services_Amazon_S3_NotFoundException is an exception class representing 404 Not Found errors, i.e. when trying to access non-existing buckets and objects.
- Services_Amazon_S3_ObjectIterator
- in file ObjectIterator.php, class Services_Amazon_S3_ObjectIterator
Services_Amazon_S3_ObjectIterator is used for iterating over objects in a bucket. It implements Iterator and can thus be used in a foreach loop: foreach ($bucket->getObjects() as $object) {
- Services_Amazon_S3_Prefix
- in file Prefix.php, class Services_Amazon_S3_Prefix
Services_Amazon_S3_Prefix represents a key prefix used for listing a subset of objects in a bucket.
- Services_Amazon_S3_Resource
- in file Resource.php, class Services_Amazon_S3_Resource
Services_Amazon_S3_Resource is the base class for Services_Amazon_S3_Resource_Bucket and Services_Amazon_S3_Resource_Object.
- Services_Amazon_S3_Resource_Bucket
- in file Bucket.php, class Services_Amazon_S3_Resource_Bucket
Services_Amazon_S3_Resource_Bucket represents an Amazon S3 bucket, i.e. a container for objects.
- Services_Amazon_S3_Resource_Object
- in file Object.php, class Services_Amazon_S3_Resource_Object
Services_Amazon_S3_Resource_Object represents an Amazon S3 object, i.e. a file stored in the S3 storage service.
- Services_Amazon_S3_ServerErrorException
- in file ServerErrorException.php, class Services_Amazon_S3_ServerErrorException
Services_Amazon_S3_ServerErrorException is an exception class representing problems with the server or the communication with the server.
- Services_Amazon_S3_Stream
- in file Stream.php, class Services_Amazon_S3_Stream
Services_Amazon_S3_Stream is a stream wrapper for Amazon S3. With this, buckets and objects can be manipulated using the PHP filesystem functions, e.g. fopen(), file_put_contents(), file_exists() etc.
- setDNSStrict
- in file Bucket.php, method Services_Amazon_S3_Resource_Bucket::setDNSStrict()
Sets the DNS strict mode for this bucket
- setPermissions
- in file LoggingStatus.php, method Services_Amazon_S3_LoggingStatus::setPermissions()
Returns the permissions for the specified grantee.
- setPermissions
- in file AccessControlList.php, method Services_Amazon_S3_AccessControlList::setPermissions()
Returns the permissions for the specified grantee.
- setRequest
- in file S3.php, method Services_Amazon_S3::setRequest()
Sets the HTTP request object to use
- signString
- in file S3.php, method Services_Amazon_S3::signString()
Signs the specified string with the secret key.
- stream_close
- in file Stream.php, method Services_Amazon_S3_Stream::stream_close()
Support for fclose().
- stream_eof
- in file Stream.php, method Services_Amazon_S3_Stream::stream_eof()
Support for feof().
- stream_flush
- in file Stream.php, method Services_Amazon_S3_Stream::stream_flush()
Support for fflush().
- stream_open
- in file Stream.php, method Services_Amazon_S3_Stream::stream_open()
Support for fopen(). Also used by file_get_contents() and file_put_contents().
- stream_read
- in file Stream.php, method Services_Amazon_S3_Stream::stream_read()
Support for fread(), file_get_contents() etc.
- stream_seek
- in file Stream.php, method Services_Amazon_S3_Stream::stream_seek()
Support for fseek().
- stream_stat
- in file Stream.php, method Services_Amazon_S3_Stream::stream_stat()
Support for fstat().
- stream_tell
- in file Stream.php, method Services_Amazon_S3_Stream::stream_tell()
Support for ftell().
- stream_write
- in file Stream.php, method Services_Amazon_S3_Stream::stream_write()
Support for fwrite(), file_put_contents() etc.
top
top
top
top
top
Documentation generated on Mon, 11 Mar 2019 15:49:38 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|