Zend_Cloud_StorageService_Adapter Interface Reference

Public Member Functions
	fetchItem ($path, $options=null)
	Get an item from the storage service.
	storeItem ($destinationPath, $data, $options=null)
	Store an item in the storage service.
	deleteItem ($path, $options=null)
	Delete an item in the storage service.
	copyItem ($sourcePath, $destinationPath, $options=null)
	Copy an item in the storage service to a given path.
	moveItem ($sourcePath, $destinationPath, $options=null)
	Move an item in the storage service to a given path.
	renameItem ($path, $name, $options=null)
	Rename an item in the storage service to a given name.
	listItems ($path, $options=null)
	List items in the given directory in the storage service.
	fetchMetadata ($path, $options=null)
	Get a key/value array of metadata for the given path.
	storeMetadata ($destinationPath, $metadata, $options=null)
	Store a key/value array of metadata at the given path.
	deleteMetadata ($path)
	Delete a key/value array of metadata at the given path.
	getClient ()
	Get the concrete client.

Public Attributes
const	HTTP_ADAPTER = 'http_adapter'

Member Function Documentation

copyItem	(		$sourcePath,
			$destinationPath,
			$options = null
	)

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

The $destinationPath must be a directory.

Parameters

string	$sourcePath
string	$destination	path
array	$options

Returns

void

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_Rackspace, and Zend_Cloud_StorageService_Adapter_FileSystem.

deleteItem	(		$path,
			$options = null
	)

Delete an item in the storage service.

Parameters

string	$path
array	$options

Returns

void

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_Rackspace, and Zend_Cloud_StorageService_Adapter_FileSystem.

deleteMetadata

(

$path

)

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

Parameters

string	$path
array	$options

Returns

void

Implemented in Zend_Cloud_StorageService_Adapter_S3, and Zend_Cloud_StorageService_Adapter_FileSystem.

fetchItem	(		$path,
			$options = null
	)

Get an item from the storage service.

Parameters

string	$path
array	$options

Returns

mixed

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_Rackspace, and Zend_Cloud_StorageService_Adapter_FileSystem.

fetchMetadata	(		$path,
			$options = null
	)

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

Parameters

string	$path
array	$options

Returns

array

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_FileSystem, and Zend_Cloud_StorageService_Adapter_Rackspace.

getClient

(

)

Get the concrete client.

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_Rackspace, Zend_Cloud_StorageService_Adapter_S3, and Zend_Cloud_StorageService_Adapter_FileSystem.

listItems	(		$path,
			$options = null
	)

List items in the given directory in the storage service.

The $path must be a directory

Parameters

string	$path	Must be a directory
array	$options

Returns

array A list of item names

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_Rackspace, Zend_Cloud_StorageService_Adapter_S3, and Zend_Cloud_StorageService_Adapter_FileSystem.

moveItem	(		$sourcePath,
			$destinationPath,
			$options = null
	)

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

The $destinationPath must be a directory.

Parameters

string	$sourcePath
string	$destination	path
array	$options

Returns

void

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_Rackspace, and Zend_Cloud_StorageService_Adapter_FileSystem.

renameItem	(		$path,
			$name,
			$options = null
	)

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

Parameters

string	$path
string	$name
array	$options

Returns

void

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_Rackspace, and Zend_Cloud_StorageService_Adapter_FileSystem.

storeItem	(		$destinationPath,
			$data,
			$options = null
	)

Store an item in the storage service.

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

Parameters

string	$destinationPath
mixed	$data
array	$options

Returns

boolean

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_Rackspace, and Zend_Cloud_StorageService_Adapter_FileSystem.

storeMetadata	(		$destinationPath,
			$metadata,
			$options = null
	)

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

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

Parameters

string	$destinationPath
array	$options

Returns

void

Implemented in Zend_Cloud_StorageService_Adapter_WindowsAzure, Zend_Cloud_StorageService_Adapter_S3, Zend_Cloud_StorageService_Adapter_FileSystem, and Zend_Cloud_StorageService_Adapter_Rackspace.

Member Data Documentation

const HTTP_ADAPTER = 'http_adapter'