Zend Framework API Documentation
Back to top  

Windows Azure Blob Service abstraction

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

Creates a new Zend_Cloud_Storage_WindowsAzure instance

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

Parameters

$options

array\Zend_Config

Options for the Zend_Cloud_Storage_WindowsAzure instance

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

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

The $destinationPath must be a directory.

inherited_from \Zend_Cloud_StorageService_Adapter::copyItem()

Parameters

$sourcePath

string

$destinationPath

string

$options

array

Delete container

deleteContainer() : void

Delete an item in the storage service.

deleteItem(string $path, array $options = null) : 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, array $options = null) : void
inherited_from \Zend_Cloud_StorageService_Adapter::deleteMetadata()

Parameters

$path

string

$options

array

Get an item from the storage service.

fetchItem(string $path, array $options = null) : mixed
inherited_from \Zend_Cloud_StorageService_Adapter::fetchItem()

Parameters

$path

string

$options

array

Returns

mixed

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

fetchMetadata(string $path, array $options = null) : array
inherited_from \Zend_Cloud_StorageService_Adapter::fetchMetadata()

Parameters

$path

string

$options

array

Returns

array

Get the concrete adapter.

getClient() : \Zend_Service_Azure_Storage_Blob
inherited_from \Zend_Cloud_StorageService_Adapter::getClient()

Returns

\Zend_Service_Azure_Storage_Blob

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, string $destinationPath, array $options = null) : void

The $destinationPath must be a directory.

inherited_from \Zend_Cloud_StorageService_Adapter::moveItem()

Parameters

$sourcePath

string

$destinationPath

string

$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, mixed $data, array $options = null) : boolean

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

inherited_from \Zend_Cloud_StorageService_Adapter::storeItem()

Parameters

$destinationPath

string

$data

mixed

$options

array

Returns

boolean

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

storeMetadata(string $destinationPath, $metadata, array $options = null) : 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

 Properties

 

Storage container to operate on

$_container : string

Default

 

Storage client

$_storageClient : \Zend_Service_WindowsAzure_Storage_Blob

Default

null

 Constants

     

CONTAINER

CONTAINER = "storage_container" 
 

DEFAULT_HOST

DEFAULT_HOST = \Zend_Service_WindowsAzure_Storage::URL_CLOUD_BLOB 
 

HOST

HOST = "storage_host" 
 

PROXY_CREDENTIALS

PROXY_CREDENTIALS = "storage_proxy_credentials" 
 

PROXY_HOST

PROXY_HOST = "storage_proxy_host" 
 

PROXY_PORT

PROXY_PORT = "storage_proxy_port" 
 

return types for list

RETURN_LIST = 1 
 

RETURN_NAMES

RETURN_NAMES = 2 
 

RETURN_OPENMODE

RETURN_OPENMODE = 'return_openmode' 
 

return types for fetch

RETURN_PATH = 1 
 

RETURN_PATHNAME

RETURN_PATHNAME = 'return_path' 
 

RETURN_STREAM

RETURN_STREAM = 3 
 

RETURN_STRING

RETURN_STRING = 2 
 

RETURN_TYPE

RETURN_TYPE = 'return_type'