Service/WindowsAzure/Credentials/CredentialsAbstract.php

Show: PublicProtectedPrivateinherited
Table of Contents
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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_WindowsAzure  
Version
$Id$  

\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Package: Zend_Service_WindowsAzure
Children
\Zend_Service_WindowsAzure_Credentials_SharedKey
\Zend_Service_WindowsAzure_Credentials_SharedAccessSignature
\Zend_Service_WindowsAzure_Credentials_SharedKeyLite
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Constants

>VConstant  DEVSTORE_ACCOUNT = "devstoreaccount1"
Development storage account and key
>VConstant  DEVSTORE_KEY = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
>VConstant  PREFIX_PROPERTIES = "x-ms-prop-"
HTTP header prefixes
>VConstant  PREFIX_METADATA = "x-ms-meta-"
>VConstant  PREFIX_STORAGE_HEADER = "x-ms-"
>VConstant  PERMISSION_READ = "r"
Permissions
>VConstant  PERMISSION_WRITE = "w"
>VConstant  PERMISSION_DELETE = "d"
>VConstant  PERMISSION_LIST = "l"

Properties

>VPropertyprotectedstring $_accountKey = ''
Account key for Windows Azure
Default value''Details
Type
string
>VPropertyprotectedstring $_accountName = ''
Account name for Windows Azure
Default value''Details
Type
string
>VPropertyprotectedboolean $_usePathStyleUri = false
Use path-style URI's
Default valuefalseDetails
Type
boolean

Methods

methodpublic__construct(string $accountName = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, string $accountKey = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, boolean $usePathStyleUri = false) : void

Creates a new Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Parameters
NameTypeDescription
$accountNamestring

Account name for Windows Azure

$accountKeystring

Account key for Windows Azure

$usePathStyleUriboolean

Use path-style URI's

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

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

Parameters
NameTypeDescription
$arrayarray
$keymixed
$valueIfNotSetmixed
Returns
TypeDescription
mixed
methodprotected_makeArrayOfQueryString(string $value) : array

Make array of query string

Parameters
NameTypeDescription
$valuestring

Query string

Returns
TypeDescription
arrayArray of key/value pairs
methodprotected_prepareQueryStringForSigning(string $value) : string

Prepare query string for signing

Parameters
NameTypeDescription
$valuestring

Original query string

Returns
TypeDescription
stringQuery string for signing
methodpublicsetAccountName(string $value = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT) : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Set account name for Windows Azure

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
methodpublicsetAccountkey(string $value = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY) : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Set account key for Windows Azure

Parameters
NameTypeDescription
$valuestring
Returns
TypeDescription
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
methodpublicsetUsePathStyleUri(boolean $value = false) : \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Set use path-style URI's

Parameters
NameTypeDescription
$valueboolean
Returns
TypeDescription
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
methodpublicsignRequestHeaders(string $httpVerb = \Zend_Http_Client::GET, string $path = '/', string $queryString = '', array $headers = null, boolean $forTableStorage = false, string $resourceType = \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ, mixed $rawData = null) : array
abstract

Sign request headers with credentials

Parameters
NameTypeDescription
$httpVerbstring

HTTP verb the request will use

$pathstring

Path for the request

$queryStringstring

Query string for the request

$headersarray

x-ms headers to add

$forTableStorageboolean

Is the request for table storage?

$resourceTypestring

Resource type

$requiredPermissionstring

Required permission

$rawDatamixed

Raw post data

Returns
TypeDescription
arrayArray of headers
methodpublicsignRequestUrl(string $requestUrl = '', string $resourceType = \Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = \Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ) : string
abstract

Sign request URL with credentials

Parameters
NameTypeDescription
$requestUrlstring

Request URL

$resourceTypestring

Resource type

$requiredPermissionstring

Required permission

Returns
TypeDescription
stringSigned request URL
Documentation was generated by phpDocumentor 2.2.0 .