Service/Amazon/S3.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: Amazon_S3
version: $Id: S3.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Service_Amazon_S3

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Service_Amazon_S3
jump to top

Extends from: Zend_Service_Amazon_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
see: http://docs.amazonwebservices.com/AmazonS3/2006-03-01/
subpackage: Amazon_S3
Constants: S3_ENDPOINT; S3_ACL_PRIVATE; S3_ACL_PUBLIC_READ; S3_ACL_PUBLIC_WRITE; S3_ACL_AUTH_READ; S3_REQUESTPAY_HEADER; S3_ACL_HEADER; S3_CONTENT_TYPE_HEADER
Properties: $_wrapperClients; $_endpoint
Methods: setEndpoint; getEndpoint; __construct; _validBucketName; createBucket; isBucketAvailable; isObjectAvailable; removeBucket; getInfo; getBuckets; cleanBucket; getObjectsByBucket; _fixupObjectName; getObject; getObjectStream; putObject; putFile; putFileStream; removeObject; _makeRequest; addSignature; getMimeType; registerAsClient; unregisterAsClient; getWrapperClient; registerStreamWrapper; unregisterStreamWrapper

Description

Amazon S3 PHP connection class

Constants

S3_ENDPOINT
jump to class

 S3_ENDPOINT = 's3.amazonaws.com'

Details

value: s3.amazonaws.com

S3_ACL_PRIVATE
jump to class

 S3_ACL_PRIVATE = 'private'

Details

value: private

S3_ACL_PUBLIC_READ
jump to class

 S3_ACL_PUBLIC_READ = 'public-read'

Details

value: public-read

S3_ACL_PUBLIC_WRITE
jump to class

 S3_ACL_PUBLIC_WRITE = 'public-read-write'

Details

value: public-read-write

S3_ACL_AUTH_READ
jump to class

 S3_ACL_AUTH_READ = 'authenticated-read'

Details

value: authenticated-read

S3_REQUESTPAY_HEADER
jump to class

 S3_REQUESTPAY_HEADER = 'x-amz-request-payer'

Details

value: x-amz-request-payer

S3_ACL_HEADER
jump to class

 S3_ACL_HEADER = 'x-amz-acl'

Details

value: x-amz-acl

S3_CONTENT_TYPE_HEADER
jump to class

 S3_CONTENT_TYPE_HEADER = 'Content-Type'

Details

value: Content-Type

Properties

$_endpoint
jump to class

Zend_Uri_Http $_endpoint = 'S3_ENDPOINT'

Endpoint for the service

Details

$_endpoint: Zend_Uri_Http
visibility: protected
default: S3_ENDPOINT
final: false
static: false

$_wrapperClients
jump to class

array $_wrapperClients = 'array'

Store for stream wrapper clients

Details

$_wrapperClients: array
visibility: protected
default: array
final: false
static: true

Methods

__construct
jump to class

__construct(
          string $accessKey
              =
              null, string $secretKey
              =
              null, string $region
              =
              null
          )
        
        :

Constructor

Arguments

$accessKey: string
$secretKey: string
$region: string

Details

visibility: public
final: false
static: false

_fixupObjectName
jump to class

_fixupObjectName(
          string $object
          )
        
        :
        string

Make sure the object name is valid

Arguments

$object: string

Output

string

Details

visibility: protected
final: false
static: false

_makeRequest
jump to class

_makeRequest(
          string $method, string $path, array $params
              =
              null, array $headers
              =
              array, string|resource $data
              =
              null
          )
        
        :
        Zend_Http_Response

Make a request to Amazon S3

Arguments

$method: string
Request method
$path: string
Path to requested object
$params: array
Request parameters
$headers: array
HTTP headers
$data: stringresource
Request data

Output

Zend_Http_Response

Details

visibility: public
final: false
static: false

_validBucketName
jump to class

_validBucketName(
          string $bucket
          )
        
        :
        boolean

Verify if the bucket name is valid

Arguments

$bucket: string

Output

boolean

Details

visibility: public
final: false
static: false

addSignature
jump to class

addSignature(
          string $method, string $path, array $headers
          )
        
        :
        string

Add the S3 Authorization signature to the request headers

Arguments

$method: string
$path: string
$headers: array
&$headers

Output

string

Details

visibility: protected
final: false
static: false

cleanBucket
jump to class

cleanBucket(
          string $bucket
          )
        
        :
        boolean

Remove all objects in the bucket.

Arguments

$bucket: string

Output

boolean

Details

visibility: public
final: false
static: false

createBucket
jump to class

createBucket(
          string $bucket,  $location
              =
              null
          )
        
        :
        boolean

Add a new bucket

Arguments

$bucket: string
$location

Output

boolean

Details

visibility: public
final: false
static: false

getBuckets
jump to class

getBuckets(
          
          )
        
        :
        array|false

List the S3 buckets

Output

array|false

Details

visibility: public
final: false
static: false

getEndpoint
jump to class

getEndpoint(
          
          )
        
        :
        Zend_Uri_Http

Get current S3 endpoint

Output

Zend_Uri_Http

Details

visibility: public
final: false
static: false

getInfo
jump to class

getInfo(
          string $object
          )
        
        :
        array|false

Get metadata information for a given object

Arguments

$object: string

Output

array|false

Details

visibility: public
final: false
static: false

getMimeType
jump to class

getMimeType(
          string $path
          )
        
        :
        string

Attempt to get the content-type of a file based on the extension

Arguments

$path: string

Output

string

Details

visibility: public
final: false
static: true

getObject
jump to class

getObject(
          string $object, bool $paidobject
              =
              false
          )
        
        :
        string|false

Get an object

Arguments

$object: string
$paidobject: bool
This is "requestor pays" object

Output

string|false

Details

visibility: public
final: false
static: false

getObjectStream
jump to class

getObjectStream(
          string $object, string $streamfile
              =
              null, bool $paidobject
              =
              false
          )
        
        :
        Zend_Http_Response_Stream|false

Get an object using streaming

Can use either provided filename for storage or create a temp file if none provided.

Arguments

$object: string
Object path
$streamfile: string
File to write the stream to
$paidobject: bool
This is "requestor pays" object

Output

Zend_Http_Response_Stream|false

Details

visibility: public
final: false
static: false

getObjectsByBucket
jump to class

getObjectsByBucket(
          string $bucket, array $params
              =
              array
          )
        
        :
        array|false

List the objects in a bucket.

Provides the list of object keys that are contained in the bucket. Valid params include the following. prefix - Limits the response to keys which begin with the indicated prefix. You can use prefixes to separate a bucket into different sets of keys in a way similar to how a file system uses folders. marker - Indicates where in the bucket to begin listing. The list will only include keys that occur lexicographically after marker. This is convenient for pagination: To get the next page of results use the last key of the current page as the marker. max-keys - The maximum number of keys you'd like to see in the response body. The server might return fewer than this many keys, but will not return more. delimiter - Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response.

Arguments

$bucket: string
$params: array
S3 GET Bucket Paramater

Output

array|false

Details

visibility: public
final: false
static: false

getWrapperClient
jump to class

getWrapperClient(
          string $name
          )
        
        :
        Zend_Service_Amazon_S3

Get wrapper client for stream type

Arguments

$name: string

Output

Zend_Service_Amazon_S3

Details

visibility: public
final: false
static: true

isBucketAvailable
jump to class

isBucketAvailable(
          string $bucket
          )
        
        :
        boolean

Checks if a given bucket name is available

Arguments

$bucket: string

Output

boolean

Details

visibility: public
final: false
static: false

isObjectAvailable
jump to class

isObjectAvailable(
          string $object
          )
        
        :
        boolean

Checks if a given object exists

Arguments

$object: string

Output

boolean

Details

visibility: public
final: false
static: false

putFile
jump to class

putFile(
          string $path, string $object, array $meta
              =
              null
          )
        
        :
        boolean

Put file to S3 as object

Arguments

$path: string
File name
$object: string
Object name
$meta: array
Metadata

Output

boolean

Details

visibility: public
final: false
static: false

putFileStream
jump to class

putFileStream(
          string $path, string $object, array $meta
              =
              null
          )
        
        :
        boolean

Put file to S3 as object, using streaming

Arguments

$path: string
File name
$object: string
Object name
$meta: array
Metadata

Output

boolean

Details

visibility: public
final: false
static: false

putObject
jump to class

putObject(
          string $object, string|resource $data, array $meta
              =
              null
          )
        
        :
        boolean

Upload an object by a PHP string

Arguments

$object: string
Object name
$data: stringresource
Object data (can be string or stream)
$meta: array
Metadata

Output

boolean

Details

visibility: public
final: false
static: false

registerAsClient
jump to class

registerAsClient(
          string $name
          )
        
        :
        Zend_Service_Amazon_S3

Arguments

$name: string

Output

Zend_Service_Amazon_S3

Details

visibility: public
final: false
static: false

registerStreamWrapper
jump to class

registerStreamWrapper(
          string $name
              =
              s3
          )
        
        :
        Zend_Service_Amazon_S3

Arguments

$name: string

Output

Zend_Service_Amazon_S3

Details

visibility: public
final: false
static: false

removeBucket
jump to class

removeBucket(
          string $bucket
          )
        
        :
        boolean

Remove a given bucket. All objects in the bucket must be removed prior to removing the bucket.

Arguments

$bucket: string

Output

boolean

Details

visibility: public
final: false
static: false

removeObject
jump to class

removeObject(
          string $object
          )
        
        :
        boolean

Remove a given object

Arguments

$object: string

Output

boolean

Details

visibility: public
final: false
static: false

setEndpoint
jump to class

setEndpoint(
          string|Zend_Uri_Http $endpoint
          )
        
        :
        Zend_Service_Amazon_S3

Set S3 endpoint to use

Arguments

$endpoint: stringZend_Uri_Http

Output

Zend_Service_Amazon_S3

Details

visibility: public
final: false
static: false

unregisterAsClient
jump to class

unregisterAsClient(
          string $name
          )
        
        :
        Zend_Service_Amazon_S3

Unregister this object as stream wrapper client

Arguments

$name: string

Output

Zend_Service_Amazon_S3

Details

visibility: public
final: false
static: false

unregisterStreamWrapper
jump to class

unregisterStreamWrapper(
          string $name
              =
              s3
          )
        
        :
        Zend_Service_Amazon_S3

Unregister this object as stream wrapper

Arguments

$name: string

Output

Zend_Service_Amazon_S3

Details

visibility: public
final: false
static: false

API Documentation

Service/Amazon/S3.php

Description

Zend_Service_Amazon_S3jump to top

Description

Constants

S3_ENDPOINTjump to class

Details

S3_ACL_PRIVATEjump to class

Details

S3_ACL_PUBLIC_READjump to class

Details

S3_ACL_PUBLIC_WRITEjump to class

Details

S3_ACL_AUTH_READjump to class

Details

S3_REQUESTPAY_HEADERjump to class

Details

S3_ACL_HEADERjump to class

Details

S3_CONTENT_TYPE_HEADERjump to class

Details

Properties

$_endpointjump to class

Details

$_wrapperClientsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_fixupObjectNamejump to class

Arguments

Output

Details

_makeRequestjump to class

Arguments

Output

Details

_validBucketNamejump to class

Arguments

Output

Details

addSignaturejump to class

Arguments

Output

Details

cleanBucketjump to class

Arguments

Output

Details

createBucketjump to class

Arguments

Output

Details

getBucketsjump to class

Output

Details

getEndpointjump to class

Output

Details

getInfojump to class

Arguments

Output

Details

getMimeTypejump to class

Arguments

Output

Details

getObjectjump to class

Arguments

Output

Details

getObjectStreamjump to class

Arguments

Output

Details

getObjectsByBucketjump to class

Arguments

Output

Zend_Service_Amazon_S3
jump to top

S3_ENDPOINT
jump to class

S3_ACL_PRIVATE
jump to class

S3_ACL_PUBLIC_READ
jump to class

S3_ACL_PUBLIC_WRITE
jump to class

S3_ACL_AUTH_READ
jump to class

S3_REQUESTPAY_HEADER
jump to class

S3_ACL_HEADER
jump to class

S3_CONTENT_TYPE_HEADER
jump to class

$_endpoint
jump to class

$_wrapperClients
jump to class

__construct
jump to class

_fixupObjectName
jump to class

_makeRequest
jump to class

_validBucketName
jump to class

addSignature
jump to class

cleanBucket
jump to class

createBucket
jump to class

getBuckets
jump to class

getEndpoint
jump to class

getInfo
jump to class

getMimeType
jump to class

getObject
jump to class

getObjectStream
jump to class

getObjectsByBucket
jump to class

getWrapperClient
jump to class

isBucketAvailable
jump to class

isObjectAvailable
jump to class

putFile
jump to class

putFileStream
jump to class

putObject
jump to class

registerAsClient
jump to class

registerStreamWrapper
jump to class

removeBucket
jump to class

removeObject
jump to class

setEndpoint
jump to class

unregisterAsClient
jump to class

unregisterStreamWrapper
jump to class