Service/WindowsAzure/Credentials/CredentialsAbstract.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
version: $Id$
Classes: Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

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_Credentials_CredentialsAbstract
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
Constants: DEVSTORE_ACCOUNT; DEVSTORE_KEY; PREFIX_PROPERTIES; PREFIX_METADATA; PREFIX_STORAGE_HEADER; PERMISSION_READ; PERMISSION_WRITE; PERMISSION_DELETE; PERMISSION_LIST
Properties: $_accountName; $_accountKey; $_usePathStyleUri
Methods: __construct; setAccountName; setAccountkey; setUsePathStyleUri; signRequestUrl; signRequestHeaders; _prepareQueryStringForSigning; _makeArrayOfQueryString; _issetOr

Description

Constants

DEVSTORE_ACCOUNT
jump to class

 DEVSTORE_ACCOUNT = 'devstoreaccount1'

Development storage account and key

Details

value: devstoreaccount1

DEVSTORE_KEY
jump to class

 DEVSTORE_KEY = 'Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=='

Details

value: Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==

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-

PERMISSION_READ
jump to class

 PERMISSION_READ = 'r'

Permissions

Details

value: r

PERMISSION_WRITE
jump to class

 PERMISSION_WRITE = 'w'

Details

value: w

PERMISSION_DELETE
jump to class

 PERMISSION_DELETE = 'd'

Details

value: d

PERMISSION_LIST
jump to class

 PERMISSION_LIST = 'l'

Details

value: l

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

$_usePathStyleUri
jump to class

boolean $_usePathStyleUri = 'false'

Use path-style URI's

Details

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

Methods

__construct
jump to class

__construct(
          string $accountName
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, string $accountKey
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract, boolean $usePathStyleUri
              =
              false
          )
        
        :

Creates a new Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Arguments

$accountName: string
Account name for Windows Azure
$accountKey: string
Account key for Windows Azure
$usePathStyleUri: boolean
Use path-style URI's

Details

visibility: public
final: false
static: false

_issetOr
jump to class

_issetOr(
          array $array, mixed $key, mixed $valueIfNotSet
          )
        
        :
        mixed

Returns an array value if the key is set, otherwide returns $valueIfNotSet

Arguments

$array: array
$key: mixed
$valueIfNotSet: mixed

Output

mixed

Details

visibility: protected
final: false
static: false

_makeArrayOfQueryString
jump to class

_makeArrayOfQueryString(
          string $value
          )
        
        :
        array

Make array of query string

Arguments

$value: string
Query string

Output

array: Array of key/value pairs

Details

visibility: protected
final: false
static: false

_prepareQueryStringForSigning
jump to class

_prepareQueryStringForSigning(
          string $value
          )
        
        :
        string

Prepare query string for signing

Arguments

$value: string
Original query string

Output

string: Query string for signing

Details

visibility: protected
final: false
static: false

setAccountName
jump to class

setAccountName(
          string $value
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
          )
        
        :
        Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Set account name for Windows Azure

Arguments

$value: string

Output

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Details

visibility: public
final: false
static: false

setAccountkey
jump to class

setAccountkey(
          string $value
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
          )
        
        :
        Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Set account key for Windows Azure

Arguments

$value: string

Output

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Details

visibility: public
final: false
static: false

setUsePathStyleUri
jump to class

setUsePathStyleUri(
          boolean $value
              =
              false
          )
        
        :
        Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Set use path-style URI's

Arguments

$value: boolean

Output

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Details

visibility: public
final: false
static: false

signRequestHeaders
jump to class

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

Sign request headers with credentials

Arguments

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

Output

array: Array of headers

Details

visibility: public
final: false
static: false

signRequestUrl
jump to class

signRequestUrl(
          string $requestUrl, string $resourceType
              =
              Zend_Service_WindowsAzure_Storage, string $requiredPermission
              =
              Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
          )
        
        :
        string

Sign request URL with credentials

Arguments

$requestUrl: string
Request URL
$resourceType: string
Resource type
$requiredPermission: string
Required permission

Output

string: Signed request URL

Details

visibility: public
final: false
static: false

API Documentation

Service/WindowsAzure/Credentials/CredentialsAbstract.php

Description

Zend_Service_WindowsAzure_Credentials_CredentialsAbstractjump to top

Description

Constants

DEVSTORE_ACCOUNTjump to class

Details

DEVSTORE_KEYjump to class

Details

PREFIX_PROPERTIESjump to class

Details

PREFIX_METADATAjump to class

Details

PREFIX_STORAGE_HEADERjump to class

Details

PERMISSION_READjump to class

Details

PERMISSION_WRITEjump to class

Details

PERMISSION_DELETEjump to class

Details

PERMISSION_LISTjump to class

Details

Properties

$_accountKeyjump to class

Details

$_accountNamejump to class

Details

$_usePathStyleUrijump to class

Details

Methods

__constructjump to class

Arguments

Details

_issetOrjump to class

Arguments

Output

Details

_makeArrayOfQueryStringjump to class

Arguments

Output

Details

_prepareQueryStringForSigningjump to class

Arguments

Output

Details

setAccountNamejump to class

Arguments

Output

Details

setAccountkeyjump to class

Arguments

Output

Details

setUsePathStyleUrijump to class

Arguments

Output

Details

signRequestHeadersjump to class

Arguments

Output

Details

signRequestUrljump to class

Arguments

Output

Details

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
jump to top

DEVSTORE_ACCOUNT
jump to class

DEVSTORE_KEY
jump to class

PREFIX_PROPERTIES
jump to class

PREFIX_METADATA
jump to class

PREFIX_STORAGE_HEADER
jump to class

PERMISSION_READ
jump to class

PERMISSION_WRITE
jump to class

PERMISSION_DELETE
jump to class

PERMISSION_LIST
jump to class

$_accountKey
jump to class

$_accountName
jump to class

$_usePathStyleUri
jump to class

__construct
jump to class

_issetOr
jump to class

_makeArrayOfQueryString
jump to class

_prepareQueryStringForSigning
jump to class

setAccountName
jump to class

setAccountkey
jump to class

setUsePathStyleUri
jump to class

signRequestHeaders
jump to class

signRequestUrl
jump to class