Service/WindowsAzure/Storage.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_WindowsAzure
subpackage: Storage
version: $Id$
Classes: Zend_Service_WindowsAzure_Storage

Description

Zend Framework

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.

Zend_Service_WindowsAzure_Storage
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service_WindowsAzure
subpackage: Storage
Constants: URL_DEV_BLOB; URL_DEV_QUEUE; URL_DEV_TABLE; URL_CLOUD_BLOB; URL_CLOUD_QUEUE; URL_CLOUD_TABLE; RESOURCE_UNKNOWN; RESOURCE_CONTAINER; RESOURCE_BLOB; RESOURCE_TABLE; RESOURCE_ENTITY; RESOURCE_QUEUE; PREFIX_PROPERTIES; PREFIX_METADATA; PREFIX_STORAGE_HEADER
Properties: $_apiVersion; $_host; $_accountName; $_accountKey; $_usePathStyleUri; $_credentials; $_retryPolicy; $_httpClientChannel; $_useProxy; $_proxyUrl; $_proxyPort; $_proxyCredentials
Methods: __construct; setHttpClientChannel; setRetryPolicy; setProxy; getAccountName; getBaseUrl; setCredentials; getCredentials; _performRequest; _parseResponse; _generateMetadataHeaders; _parseMetadataHeaders; _parseMetadataElement; isoDate; urlencode; isValidMetadataName; createQueryStringFromArray

Description

Constants

URL_DEV_BLOB
jump to class

 URL_DEV_BLOB = '127.0.0.1:10000'

Development storage URLS

Details

value: 127.0.0.1:10000

URL_DEV_QUEUE
jump to class

 URL_DEV_QUEUE = '127.0.0.1:10001'

Details

value: 127.0.0.1:10001

URL_DEV_TABLE
jump to class

 URL_DEV_TABLE = '127.0.0.1:10002'

Details

value: 127.0.0.1:10002

URL_CLOUD_BLOB
jump to class

 URL_CLOUD_BLOB = 'blob.core.windows.net'

Live storage URLS

Details

value: blob.core.windows.net

URL_CLOUD_QUEUE
jump to class

 URL_CLOUD_QUEUE = 'queue.core.windows.net'

Details

value: queue.core.windows.net

URL_CLOUD_TABLE
jump to class

 URL_CLOUD_TABLE = 'table.core.windows.net'

Details

value: table.core.windows.net

RESOURCE_UNKNOWN
jump to class

 RESOURCE_UNKNOWN = 'unknown'

Resource types

Details

value: unknown

RESOURCE_CONTAINER
jump to class

 RESOURCE_CONTAINER = 'c'

Details

value: c

RESOURCE_BLOB
jump to class

 RESOURCE_BLOB = 'b'

Details

value: b

RESOURCE_TABLE
jump to class

 RESOURCE_TABLE = 't'

Details

value: t

RESOURCE_ENTITY
jump to class

 RESOURCE_ENTITY = 'e'

Details

value: e

RESOURCE_QUEUE
jump to class

 RESOURCE_QUEUE = 'q'

Details

value: q

PREFIX_PROPERTIES
jump to class

 PREFIX_PROPERTIES = 'x-ms-prop-'

HTTP header prefixes

Details

value: x-ms-prop-

PREFIX_METADATA
jump to class

 PREFIX_METADATA = 'x-ms-meta-'

Details

value: x-ms-meta-

PREFIX_STORAGE_HEADER
jump to class

 PREFIX_STORAGE_HEADER = 'x-ms-'

Details

value: x-ms-

Properties

$_accountKey
jump to class

string $_accountKey = ''

Account key for Windows Azure

Details

$_accountKey: string
visibility: protected
default
final: false
static: false

$_accountName
jump to class

string $_accountName = ''

Account name for Windows Azure

Details

$_accountName: string
visibility: protected
default
final: false
static: false

$_apiVersion
jump to class

string $_apiVersion = '2009-09-19'

Current API version

Details

$_apiVersion: string
visibility: protected
default: 2009-09-19
final: false
static: false

$_credentials
jump to class

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $_credentials = 'null'

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Details

$_credentials: Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
visibility: protected
default: null
final: false
static: false

$_host
jump to class

string $_host = ''

Storage host name

Details

$_host: string
visibility: protected
default
final: false
static: false

$_httpClientChannel
jump to class

Zend_Http_Client $_httpClientChannel = 'null'

Zend_Http_Client channel used for communication with REST services

Details

$_httpClientChannel: Zend_Http_Client
visibility: protected
default: null
final: false
static: false

$_proxyCredentials
jump to class

string $_proxyCredentials = ''

Proxy credentials

Details

$_proxyCredentials: string
visibility: protected
default
final: false
static: false

$_proxyPort
jump to class

int $_proxyPort = '80'

Proxy port

Details

$_proxyPort: int
visibility: protected
default: 80
final: false
static: false

$_proxyUrl
jump to class

string $_proxyUrl = ''

Proxy url

Details

$_proxyUrl: string
visibility: protected
default
final: false
static: false

$_retryPolicy
jump to class

Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $_retryPolicy = 'null'

Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract instance

Details

$_retryPolicy: Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
visibility: protected
default: null
final: false
static: false

$_usePathStyleUri
jump to class

boolean $_usePathStyleUri = 'false'

Use path-style URI's

Details

$_usePathStyleUri: boolean
visibility: protected
default: false
final: false
static: false

$_useProxy
jump to class

boolean $_useProxy = 'false'

Use proxy?

Details

$_useProxy: boolean
visibility: protected
default: false
final: false
static: false

Methods

__construct
jump to class

__construct(
          string $host
              =
              self, string $accountName
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, string $accountKey
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, boolean $usePathStyleUri
              =
              false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy
              =
              null
          )
        
        :

Creates a new Zend_Service_WindowsAzure_Storage instance

Arguments

$host: string
Storage host name
$accountName: string
Account name for Windows Azure
$accountKey: string
Account key for Windows Azure
$usePathStyleUri: boolean
Use path-style URI's
$retryPolicy: Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests

Details

visibility: public
final: false
static: false

_generateMetadataHeaders
jump to class

_generateMetadataHeaders(
          array $metadata
              =
              array
          )
        
        :
        HTTP

Generate metadata headers

Arguments

$metadata: array

Output

HTTP: headers containing metadata

Details

visibility: protected
final: false
static: false

_parseMetadataElement
jump to class

_parseMetadataElement(
           $element
              =
              null
          )
        
        :
        array

Parse metadata XML

Arguments

$element

Output

array

Details

visibility: protected
final: false
static: false

_parseMetadataHeaders
jump to class

_parseMetadataHeaders(
          array $headers
              =
              array
          )
        
        :
        array

Parse metadata headers

Arguments

$headers: array
HTTP headers containing metadata

Output

array

Details

visibility: protected
final: false
static: false

_parseResponse
jump to class

_parseResponse(
          Zend_Http_Response $response
              =
              null
          )
        
        :
        object

Parse result from Zend_Http_Response

Arguments

$response: Zend_Http_Response
Response from HTTP call

Output

object

Details

visibility: protected
final: false
static: false
throws

_performRequest
jump to class

_performRequest(
          string $path
              =
              /, string $queryString, string $httpVerb
              =
              Zend_Http_Client, array $headers
              =
              array, boolean $forTableStorage
              =
              false, mixed $rawData
              =
              null, string $resourceType
              =
              Zend_Service_WindowsAzure_Storage, string $requiredPermission
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
          )
        
        :
        Zend_Http_Response

Perform request using Zend_Http_Client channel

Arguments

$path: string
Path
$queryString: string
Query string
$httpVerb: string
HTTP verb the request will use
$headers: array
x-ms headers to add
$forTableStorage: boolean
Is the request for table storage?
$rawData: mixed
Optional RAW HTTP data to be sent over the wire
$resourceType: string
Resource type
$requiredPermission: string
Required permission

Output

Zend_Http_Response

Details

visibility: protected
final: false
static: false

createQueryStringFromArray
jump to class

createQueryStringFromArray(
          array $queryString
          )
        
        :
        string

Builds a query string from an array of elements

Arguments

$queryString: array
Array of elements

Output

string: Assembled query string

Details

visibility: public
final: false
static: true

getAccountName
jump to class

getAccountName(
          
          )
        
        :
        string

Returns the Windows Azure account name

Output

string

Details

visibility: public
final: false
static: false

getBaseUrl
jump to class

getBaseUrl(
          
          )
        
        :
        string

Get base URL for creating requests

Output

string

Details

visibility: public
final: false
static: false

getCredentials
jump to class

getCredentials(
          
          )
        
        :
        Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Get Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Output

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Details

visibility: public
final: false
static: false

isValidMetadataName
jump to class

isValidMetadataName(
          string $metadataName
          )
        
        :
        boolean

Is valid metadata name?

Arguments

$metadataName: string
Metadata name

Output

boolean

Details

visibility: public
final: false
static: true

isoDate
jump to class

isoDate(
          int $timestamp
              =
              null
          )
        
        :
        string

Generate ISO 8601 compliant date string in UTC time zone

Arguments

$timestamp: int

Output

string

Details

visibility: public
final: false
static: false

setCredentials
jump to class

setCredentials(
          Zend_Service_WindowsAzure_Credentials_CredentialsAbstract $credentials
          )
        
        :

Set Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Arguments

$credentials: Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance to use for request signing.

Details

visibility: public
final: false
static: false

setHttpClientChannel
jump to class

setHttpClientChannel(
          Zend_Http_Client_Adapter_Interface|string $adapterInstance
              =
              Zend_Http_Client_Adapter_Proxy
          )
        
        :

Set the HTTP client channel to use

Arguments

$adapterInstance: Zend_Http_Client_Adapter_Interfacestring
Adapter instance or adapter class name.

Details

visibility: public
final: false
static: false

setProxy
jump to class

setProxy(
          boolean $useProxy
              =
              false, string $proxyUrl, int $proxyPort
              =
              80, string $proxyCredentials
          )
        
        :

Set proxy

Arguments

$useProxy: boolean
Use proxy?
$proxyUrl: string
Proxy URL
$proxyPort: int
Proxy port
$proxyCredentials: string
Proxy credentials

Details

visibility: public
final: false
static: false

setRetryPolicy
jump to class

setRetryPolicy(
          Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy
              =
              null
          )
        
        :

Set retry policy to use when making requests

Arguments

$retryPolicy: Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract
Retry policy to use when making requests

Details

visibility: public
final: false
static: false

urlencode
jump to class

urlencode(
          string $value
          )
        
        :
        string

URL encode function

Arguments

$value: string
Value to encode

Output

string: Encoded value

Details

visibility: public
final: false
static: true

API Documentation

Service/WindowsAzure/Storage.php

Description

Zend_Service_WindowsAzure_Storagejump to top

Description

Constants

URL_DEV_BLOBjump to class

Details

URL_DEV_QUEUEjump to class

Details

URL_DEV_TABLEjump to class

Details

URL_CLOUD_BLOBjump to class

Details

URL_CLOUD_QUEUEjump to class

Details

URL_CLOUD_TABLEjump to class

Details

RESOURCE_UNKNOWNjump to class

Details

RESOURCE_CONTAINERjump to class

Details

RESOURCE_BLOBjump to class

Details

RESOURCE_TABLEjump to class

Details

RESOURCE_ENTITYjump to class

Details

RESOURCE_QUEUEjump to class

Details

PREFIX_PROPERTIESjump to class

Details

PREFIX_METADATAjump to class

Details

PREFIX_STORAGE_HEADERjump to class

Details

Properties

$_accountKeyjump to class

Details

$_accountNamejump to class

Details

$_apiVersionjump to class

Details

$_credentialsjump to class

Details

$_hostjump to class

Details

$_httpClientChanneljump to class

Details

$_proxyCredentialsjump to class

Details

$_proxyPortjump to class

Details

$_proxyUrljump to class

Details

$_retryPolicyjump to class

Details

$_usePathStyleUrijump to class

Details

$_useProxyjump to class

Details

Methods

__constructjump to class

Arguments

Details

_generateMetadataHeadersjump to class

Arguments

Output

Details

_parseMetadataElementjump to class

Arguments

Output

Details

_parseMetadataHeadersjump to class

Arguments

Output

Details

_parseResponsejump to class

Arguments

Output

Zend_Service_WindowsAzure_Storage
jump to top

URL_DEV_BLOB
jump to class

URL_DEV_QUEUE
jump to class

URL_DEV_TABLE
jump to class

URL_CLOUD_BLOB
jump to class

URL_CLOUD_QUEUE
jump to class

URL_CLOUD_TABLE
jump to class

RESOURCE_UNKNOWN
jump to class

RESOURCE_CONTAINER
jump to class

RESOURCE_BLOB
jump to class

RESOURCE_TABLE
jump to class

RESOURCE_ENTITY
jump to class

RESOURCE_QUEUE
jump to class

PREFIX_PROPERTIES
jump to class

PREFIX_METADATA
jump to class

PREFIX_STORAGE_HEADER
jump to class

$_accountKey
jump to class

$_accountName
jump to class

$_apiVersion
jump to class

$_credentials
jump to class

$_host
jump to class

$_httpClientChannel
jump to class

$_proxyCredentials
jump to class

$_proxyPort
jump to class

$_proxyUrl
jump to class

$_retryPolicy
jump to class

$_usePathStyleUri
jump to class

$_useProxy
jump to class

__construct
jump to class

_generateMetadataHeaders
jump to class

_parseMetadataElement
jump to class

_parseMetadataHeaders
jump to class

_parseResponse
jump to class

_performRequest
jump to class

createQueryStringFromArray
jump to class

getAccountName
jump to class

getBaseUrl
jump to class

getCredentials
jump to class

isValidMetadataName
jump to class

isoDate
jump to class

setCredentials
jump to class

setHttpClientChannel
jump to class

setProxy
jump to class

setRetryPolicy
jump to class

urlencode
jump to class