Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]

Class: Microsoft_WindowsAzure_Credentials_CredentialsAbstract

Source Location: /WindowsAzure/Credentials/CredentialsAbstract.php

Class Overview




Author(s):

Copyright:

  • Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)

Variables

Constants

Methods


Child classes:


Class Details

[line 46]


Tags:

copyright:  Copyright (c) 2009 - 2011, RealDolmen (http://www.realdolmen.com)
abstract:  
license:  http://phpazure.codeplex.com/license


[ Top ]


Class Variables

$_accountKey =  ''

[line 81]

Account key for Windows Azure



Tags:

access:  protected

Type:   string


[ Top ]

$_accountName =  ''

[line 74]

Account name for Windows Azure



Tags:

access:  protected

Type:   string


[ Top ]

$_usePathStyleUri =  false

[line 88]

Use path-style URI's



Tags:

access:  protected

Type:   boolean


[ Top ]



Class Methods


constructor __construct [line 97]

Microsoft_WindowsAzure_Credentials_CredentialsAbstract __construct( [string $accountName = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT], [string $accountKey = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY], [boolean $usePathStyleUri = false])

Creates a new Microsoft_WindowsAzure_Credentials_CredentialsAbstract instance



Tags:

access:  public


Overridden in child classes as:

Microsoft_WindowsAzure_Credentials_SharedAccessSignature::__construct()
Creates a new Microsoft_WindowsAzure_Credentials_SharedAccessSignature instance

Parameters:

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

[ Top ]

method setAccountkey [line 125]

Microsoft_WindowsAzure_Credentials_CredentialsAbstract setAccountkey( [string $value = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY])

Set account key for Windows Azure



Tags:

access:  public


Parameters:

string   $value  

[ Top ]

method setAccountName [line 113]

Microsoft_WindowsAzure_Credentials_CredentialsAbstract setAccountName( [string $value = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT])

Set account name for Windows Azure



Tags:

access:  public


Parameters:

string   $value  

[ Top ]

method setUsePathStyleUri [line 137]

Microsoft_WindowsAzure_Credentials_CredentialsAbstract setUsePathStyleUri( [boolean $value = false])

Set use path-style URI's



Tags:

access:  public


Parameters:

boolean   $value  

[ Top ]

method signRequestHeaders [line 170]

array signRequestHeaders( [string $httpVerb = Microsoft_Http_Client::GET], [string $path = '/'], [string $queryString = ''], [array $headers = null], [boolean $forTableStorage = false], [string $resourceType = Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN], [string $requiredPermission = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ], [mixed $rawData = null])

Sign request headers with credentials



Tags:

return:  Array of headers
abstract:  
access:  public


Overridden in child classes as:

Microsoft_WindowsAzure_Credentials_SharedAccessSignature::signRequestHeaders()
Sign request with credentials
Microsoft_WindowsAzure_Credentials_SharedKey::signRequestHeaders()
Sign request headers with credentials
Microsoft_WindowsAzure_Credentials_SharedKeyLite::signRequestHeaders()
Sign request headers with credentials

Parameters:

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

[ Top ]

method signRequestUrl [line 151]

string signRequestUrl( [string $requestUrl = ''], [string $resourceType = Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN], [string $requiredPermission = Microsoft_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ])

Sign request URL with credentials



Tags:

return:  Signed request URL
abstract:  
access:  public


Overridden in child classes as:

Microsoft_WindowsAzure_Credentials_SharedAccessSignature::signRequestUrl()
Sign request URL with credentials
Microsoft_WindowsAzure_Credentials_SharedKey::signRequestUrl()
Sign request URL with credentials
Microsoft_WindowsAzure_Credentials_SharedKeyLite::signRequestUrl()
Sign request URL with credentials

Parameters:

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

[ Top ]

method _issetOr [line 248]

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

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



Tags:

access:  protected


Parameters:

array   $array  
mixed   $key  
mixed   $valueIfNotSet  

[ Top ]

method _makeArrayOfQueryString [line 213]

array _makeArrayOfQueryString( string $value)

Make array of query string



Tags:

return:  Array of key/value pairs
access:  protected


Parameters:

string   $value   Query string

[ Top ]

method _prepareQueryStringForSigning [line 188]

string _prepareQueryStringForSigning( string $value)

Prepare query string for signing



Tags:

return:  Query string for signing
access:  protected


Overridden in child classes as:

Microsoft_WindowsAzure_Credentials_SharedKeyLite::_prepareQueryStringForSigning()
Prepare query string for signing

Parameters:

string   $value   Original query string

[ Top ]


Class Constants

DEVSTORE_ACCOUNT =  "devstoreaccount1"

[line 51]

Development storage account and key


[ Top ]

DEVSTORE_KEY =  "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="

[line 52]


[ Top ]

PERMISSION_DELETE =  "d"

[line 66]


[ Top ]

PERMISSION_LIST =  "l"

[line 67]


[ Top ]

PERMISSION_READ =  "r"

[line 64]

Permissions


[ Top ]

PERMISSION_WRITE =  "w"

[line 65]


[ Top ]

PREFIX_METADATA =  "x-ms-meta-"

[line 58]


[ Top ]

PREFIX_PROPERTIES =  "x-ms-prop-"

[line 57]

HTTP header prefixes


[ Top ]

PREFIX_STORAGE_HEADER =  "x-ms-"

[line 59]


[ Top ]



Documentation generated on Wed, 18 May 2011 12:06:28 +0200 by phpDocumentor 1.4.3