API Documentation

Cloud/StorageService/Adapter/S3.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cloud  
subpackage
StorageService  

\Zend_Cloud_StorageService_Adapter_S3

S3 adapter for unstructured cloud storage.

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

Constants

Constant  BUCKET_NAME = 'bucket_name'
Constant  BUCKET_AS_DOMAIN = 'bucket_as_domain?'
Constant  FETCH_STREAM = 'fetch_stream'
Constant  METADATA = 'metadata'
Constant  AWS_ACCESS_KEY = 'aws_accesskey'

AWS constants

Constant  AWS_SECRET_KEY = 'aws_secretkey'

Properties

Propertyprotected  $_defaultBucketAsDomain= 'false'
Default valuefalseDetails
Type
Propertyprotected  $_defaultBucketName= 'null'
Default valuenullDetails
Type
Propertyprotected\Zend_Service_Amazon_S3  $_s3= ''

S3 service instance.

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
methodprotected_getFullPath( string $path, array $options ) : void

Get full path, including bucket, for an object

Parameters
Name Type Description
$path string
$options array
methodpubliccopyItem( 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  
methodpublicdeleteItem( string $path, array $options = array ) : void

Delete an item in the storage service.

Parameters
Name Type Description
$path string
$options array
methodpublicdeleteMetadata( string $path ) : void

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

Parameters
Name Type Description
$path string
methodpublicfetchItem( 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  
methodpublicfetchMetadata( 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
methodpublicgetClient( ) : \Zend_Service_Amazon_S3

Get the concrete client.

Returns
Type Description
\Zend_Service_Amazon_S3
methodpubliclistItems( 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
methodpublicmoveItem( string $sourcePath,  $destinationPath, array $options = array ) : void

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

The $destinationPath must be a directory.

Parameters
Name Type Description
$sourcePath string
$destinationPath
$options array
Details
TODO
Support streams for those services that don't support natively  
methodpublicrenameItem( 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
methodpublicstoreItem( 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  
methodpublicstoreMetadata( 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
Documentation was generated by DocBlox 0.13.3.