Cloud/StorageService/Adapter/S3.php

Show:

inherited

Classes
- \Zend_Cloud_StorageService_Adapter_S3

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Cloud
Subpackage: StorageService

\Zend_Cloud_StorageService_Adapter_S3
jump to top

Package: Zend_Cloud\StorageService

S3 adapter for unstructured cloud storage.

Implements
Category: Zend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                BUCKET_NAME
                = 'bucket_name'

 
                BUCKET_AS_DOMAIN
                = 'bucket_as_domain?'

 
                FETCH_STREAM
                = 'fetch_stream'

 
                METADATA
                = 'metadata'

 
                AWS_ACCESS_KEY
                = 'aws_accesskey'

AWS constants

 
                AWS_SECRET_KEY
                = 'aws_secretkey'

Properties

$_defaultBucketAsDomain = false

Default valuefalseDetails

Type: n/a

$_defaultBucketName = null

Default valuenullDetails

Type: n/a

\Zend_Service_Amazon_S3 $_s3

S3 service instance.

Details

Type: \Zend_Service_Amazon_S3

Methods

__construct(array | \Zend_Config $options = array()) : void

Constructor

Parameters

Name	Type	Description
$options	array \| \Zend_Config

_getFullPath(string $path, array $options) : void

Get full path, including bucket, for an object

Parameters

Name	Type	Description
$path	string
$options	array

copyItem(string $sourcePath, $destinationPath, array $options = array()) : void

Copy an item in the storage service to a given path.

WARNING: This operation is *very* expensive for services that do not support copying an item natively.

Parameters

Name	Type	Description
$sourcePath	string
$destinationPath
$options	array

Details

TODO: Support streams for those services that don't support natively

deleteItem(string $path, array $options = array()) : void

Delete an item in the storage service.

Parameters

Name	Type	Description
$path	string
$options	array

deleteMetadata(string $path) : void

Delete a key/value array of metadata at the given path.

Parameters

Name	Type	Description
$path	string

fetchItem(string $path, array $options = array()) : string

Get an item from the storage service.

Parameters

Name	Type	Description
$path	string
$options	array

Returns

Type	Description
string

Details

TODO: Support streams

fetchMetadata(string $path, array $options = array()) : array

Get a key/value array of metadata for the given path.

Parameters

Name	Type	Description
$path	string
$options	array

Returns

Type	Description
array

getClient() : \Zend_Service_Amazon_S3

Get the concrete client.

Returns

Type	Description
\Zend_Service_Amazon_S3

listItems(string $path, array $options = null) : array

List items in the given directory in the storage service

The $path must be a directory

Parameters

Name	Type	Description
$path	string	Must be a directory
$options	array

Returns

Type	Description
array	A list of item names

moveItem(string $sourcePath, $destinationPath, array $options = array()) : void

Move an item in the storage service to a given path.

Parameters

Name	Type	Description
$sourcePath	string
$destinationPath
$options	array

Details

TODO: Support streams for those services that don't support natively

renameItem(string $path, string $name, array $options = null) : void

Rename an item in the storage service to a given name.

Parameters

Name	Type	Description
$path	string
$name	string
$options	array

storeItem(string $destinationPath, string | resource $data, array $options = array()) : void

Store an item in the storage service.

WARNING: This operation overwrites any item that is located at $destinationPath.

Parameters

Name	Type	Description
$destinationPath	string
$data	string \| resource
$options	array

Details

TODO: Support streams

storeMetadata(string $destinationPath, $metadata, array $options = array()) : void

Store a key/value array of metadata at the given path.

WARNING: This operation overwrites any metadata that is located at $destinationPath.

Parameters

Name	Type	Description
$destinationPath	string
$metadata
$options	array

Cloud/StorageService/Adapter/S3.php

\Zend_Cloud_StorageService_Adapter_S3jump to top

Constants

Properties

Methods

\Zend_Cloud_StorageService_Adapter_S3
jump to top