Zend_Service_WindowsAzure_Credentials_CredentialsAbstract Class Reference

Inheritance diagram for Zend_Service_WindowsAzure_Credentials_CredentialsAbstract:

Public Member Functions
	__construct ($accountName=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri=false)
	setAccountName ($value=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT)
	setAccountkey ($value=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY)
	setUsePathStyleUri ($value=false)
	signRequestUrl ($requestUrl= '', $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ)
	signRequestHeaders ($httpVerb=Zend_Http_Client::GET, $path= '/', $queryString= '', $headers=null, $forTableStorage=false, $resourceType=Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, $requiredPermission=Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ)
Data Fields
const	DEVSTORE_ACCOUNT = "devstoreaccount1"
const	DEVSTORE_KEY = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="
const	PREFIX_PROPERTIES = "x-ms-prop-"
const	PREFIX_METADATA = "x-ms-meta-"
const	PREFIX_STORAGE_HEADER = "x-ms-"
const	PERMISSION_READ = "r"
const	PERMISSION_WRITE = "w"
const	PERMISSION_DELETE = "d"
const	PERMISSION_LIST = "l"
Protected Member Functions
	_prepareQueryStringForSigning ($value)
Protected Attributes
	$_accountName = ''
	$_accountKey = ''
	$_usePathStyleUri = false

---

Detailed Description

Definition at line 33 of file CredentialsAbstract.php.

---

Constructor & Destructor Documentation

__construct	(	$	accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT,
		$	accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY,
		$	usePathStyleUri = false
	)

Creates a new Zend_Service_WindowsAzure_Credentials_CredentialsAbstract instance

Parameters:

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

Definition at line 84 of file CredentialsAbstract.php.

---

Member Function Documentation

_prepareQueryStringForSigning

(

$

value

)

[protected]

Prepare query string for signing

Parameters:

string

$value

Original query string

Returns:

string Query string for signing

Definition at line 173 of file CredentialsAbstract.php.

Here is the caller graph for this function:

setAccountkey

(

$

value = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY

)

Set account key for Windows Azure

Parameters:

string

$value

Returns:

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Definition at line 112 of file CredentialsAbstract.php.

setAccountName

(

$

value = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT

)

Set account name for Windows Azure

Parameters:

string

$value

Returns:

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Definition at line 100 of file CredentialsAbstract.php.

Here is the caller graph for this function:

setUsePathStyleUri

(

$

value = false

)

Set use path-style URI's

Parameters:

boolean

$value

Returns:

Zend_Service_WindowsAzure_Credentials_CredentialsAbstract

Definition at line 124 of file CredentialsAbstract.php.

signRequestHeaders	(	$	httpVerb = Zend_Http_Client::GET,
		$	path = '/',
		$	queryString = '',
		$	headers = null,
		$	forTableStorage = false,
		$	resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
		$	requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ
	)		[abstract]

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

Returns:

array Array of headers

Reimplemented in Zend_Service_WindowsAzure_Credentials_SharedAccessSignature, Zend_Service_WindowsAzure_Credentials_SharedKey, and Zend_Service_WindowsAzure_Credentials_SharedKeyLite.

signRequestUrl	(	$	requestUrl = '',
		$	resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN,
		$	requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ
	)		[abstract]

Sign request URL with credentials

Parameters:

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

Returns:

string Signed request URL

Reimplemented in Zend_Service_WindowsAzure_Credentials_SharedAccessSignature, Zend_Service_WindowsAzure_Credentials_SharedKey, and Zend_Service_WindowsAzure_Credentials_SharedKeyLite.

---

Field Documentation

$_accountKey = '' [protected]

Definition at line 68 of file CredentialsAbstract.php.

$_accountName = '' [protected]

Definition at line 61 of file CredentialsAbstract.php.

$_usePathStyleUri = false [protected]

Definition at line 75 of file CredentialsAbstract.php.

const DEVSTORE_ACCOUNT = "devstoreaccount1"

Development storage account and key

Definition at line 38 of file CredentialsAbstract.php.

const DEVSTORE_KEY = "Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw=="

Definition at line 39 of file CredentialsAbstract.php.

const PERMISSION_DELETE = "d"

Definition at line 53 of file CredentialsAbstract.php.

const PERMISSION_LIST = "l"

Definition at line 54 of file CredentialsAbstract.php.

const PERMISSION_READ = "r"

Permissions

Definition at line 51 of file CredentialsAbstract.php.

const PERMISSION_WRITE = "w"

Definition at line 52 of file CredentialsAbstract.php.

const PREFIX_METADATA = "x-ms-meta-"

Definition at line 45 of file CredentialsAbstract.php.

const PREFIX_PROPERTIES = "x-ms-prop-"

HTTP header prefixes

Definition at line 44 of file CredentialsAbstract.php.

const PREFIX_STORAGE_HEADER = "x-ms-"

Definition at line 46 of file CredentialsAbstract.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/zend/Zend/Service/WindowsAzure/Credentials/CredentialsAbstract.php