Zend Framework API Documentation » \Zend_Cloud_StorageService_Adapter

Constants

S3 adapter for unstructured cloud storage.

category	Zend
package	Zend_Cloud
subpackage	StorageService
copyright	Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license	New BSD License

Methods

Constructor

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

Parameters

$options

array\Zend_Config

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

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

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

TODO	Support streams for those services that don't support natively
inherited_from	\Zend_Cloud_StorageService_Adapter::copyItem()

Parameters

$sourcePath

string

$destinationPath

$options

array

Delete an item in the storage service.

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

inherited_from	\Zend_Cloud_StorageService_Adapter::deleteItem()

Parameters

$path

string

$options

array

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

deleteMetadata(string $path) : void

inherited_from	\Zend_Cloud_StorageService_Adapter::deleteMetadata()

Parameters

$path

string

Get an item from the storage service.

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

TODO	Support streams
inherited_from	\Zend_Cloud_StorageService_Adapter::fetchItem()

Parameters

$path

string

$options

array

Returns

string

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

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

inherited_from	\Zend_Cloud_StorageService_Adapter::fetchMetadata()

Parameters

$path

string

$options

array

Returns

array

Get the concrete client.

getClient() : \Zend_Service_Amazon_S3

inherited_from	\Zend_Cloud_StorageService_Adapter::getClient()

Returns

\Zend_Service_Amazon_S3

List items in the given directory in the storage service

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

The $path must be a directory

inherited_from	\Zend_Cloud_StorageService_Adapter::listItems()

Parameters

$path

string

Must be a directory

$options

array

Returns

arrayA list of item names

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

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

The $destinationPath must be a directory.

TODO	Support streams for those services that don't support natively
inherited_from	\Zend_Cloud_StorageService_Adapter::moveItem()

Parameters

$sourcePath

string

$destinationPath

$options

array

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

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

inherited_from	\Zend_Cloud_StorageService_Adapter::renameItem()

Parameters

$path

string

$name

string

$options

array

Store an item in the storage service.

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

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

TODO	Support streams
inherited_from	\Zend_Cloud_StorageService_Adapter::storeItem()

Parameters

$destinationPath

string

$data

stringresource

$options

array

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

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

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

inherited_from	\Zend_Cloud_StorageService_Adapter::storeMetadata()

Parameters

$destinationPath

string

$metadata

$options

array

Get full path, including bucket, for an object

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

Parameters

$path

string

$options

array

Properties

$_defaultBucketAsDomain

$_defaultBucketAsDomain

Default

false

$_defaultBucketName

$_defaultBucketName

Default

null

S3 service instance.

$_s3 : \Zend_Service_Amazon_S3

Default

Constants

AWS constants

AWS_ACCESS_KEY = 'aws_accesskey'

AWS_SECRET_KEY

AWS_SECRET_KEY = 'aws_secretkey'

BUCKET_AS_DOMAIN

BUCKET_AS_DOMAIN = 'bucket_as_domain?'

BUCKET_NAME

BUCKET_NAME = 'bucket_name'

FETCH_STREAM

FETCH_STREAM = 'fetch_stream'

METADATA

METADATA = 'metadata'