API Documentation

Cloud/StorageService/Adapter/WindowsAzure.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_WindowsAzure

Windows Azure Blob Service abstraction

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  ACCOUNT_NAME = 'storage_accountname'
Constant  ACCOUNT_KEY = 'storage_accountkey'
Constant  HOST = 'storage_host'
Constant  PROXY_HOST = 'storage_proxy_host'
Constant  PROXY_PORT = 'storage_proxy_port'
Constant  PROXY_CREDENTIALS = 'storage_proxy_credentials'
Constant  CONTAINER = 'storage_container'
Constant  RETURN_TYPE = 'return_type'
Constant  RETURN_PATHNAME = 'return_path'
Constant  RETURN_OPENMODE = 'return_openmode'
Constant  RETURN_PATH = '1'

return types for fetch

Constant  RETURN_STRING = '2'
Constant  RETURN_STREAM = '3'
Constant  RETURN_LIST = '1'

return types for list

Constant  RETURN_NAMES = '2'
Constant  DEFAULT_HOST = 'Zend_Service_WindowsAzure_Storage'

Properties

Propertyprotectedstring  $_container= ''

Storage container to operate on

Details
Type
string
Propertyprotected\Zend_Service_WindowsAzure_Storage_Blob  $_storageClient= 'null'

Storage client

Default valuenullDetails
Type
\Zend_Service_WindowsAzure_Storage_Blob

Methods

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

Creates a new Zend_Cloud_Storage_WindowsAzure instance

Parameters
Name Type Description
$options array|\Zend_Config Options for the Zend_Cloud_Storage_WindowsAzure instance
methodpubliccopyItem( string $sourcePath, string $destinationPath, array $options = null ) : void

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

The $destinationPath must be a directory.

Parameters
Name Type Description
$sourcePath string
$destinationPath string
$options array
methodpublicdeleteContainer( ) : void

Delete container

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

Delete an item in the storage service.

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

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

Parameters
Name Type Description
$path string
$options array
methodpublicfetchItem( string $path, array $options = null ) : mixed

Get an item from the storage service.

Parameters
Name Type Description
$path string
$options array
Returns
Type Description
mixed
methodpublicfetchMetadata( string $path, array $options = null ) : 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_Azure_Storage_Blob

Get the concrete adapter.

Returns
Type Description
\Zend_Service_Azure_Storage_Blob
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, string $destinationPath, array $options = null ) : 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 string
$options array
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, mixed $data, array $options = null ) : boolean

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 mixed
$options array
Returns
Type Description
boolean
methodpublicstoreMetadata( string $destinationPath,  $metadata, array $options = null ) : 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.