Class: Microsoft_WindowsAzure_Storage

Source Location: /WindowsAzure/Storage.php

Class Overview

Author(s):

Copyright:

Variables

Constants

Methods

Child classes:

Microsoft_WindowsAzure_Storage_BatchStorage

Microsoft_WindowsAzure_Storage_Blob

Microsoft_WindowsAzure_Storage_Queue

Class Details

[line 73]

Tags:

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

[ Top ]

Class Variables

$_accountKey = ''

[line 125]

Account key for Windows Azure

Tags:

access:

protected

Type:

string

[ Top ]

$_accountName = ''

[line 118]

Account name for Windows Azure

Tags:

access:

protected

Type:

string

[ Top ]

$_apiVersion = '2009-04-14'

[line 104]

Current API version

Tags:

access:

protected

Type:

string

[ Top ]

$_credentials = null

[line 139]

Microsoft_WindowsAzure_Credentials instance

Tags:

access:

protected

Type:

Microsoft_WindowsAzure_Credentials

[ Top ]

$_host = ''

[line 111]

Storage host name

Tags:

access:

protected

Type:

string

[ Top ]

$_proxyCredentials = ''

[line 174]

Proxy credentials

Tags:

access:

protected

Type:

string

[ Top ]

$_proxyPort = 80

[line 167]

Proxy port

Tags:

access:

protected

Type:

int

[ Top ]

$_proxyUrl = ''

[line 160]

Proxy url

Tags:

access:

protected

Type:

string

[ Top ]

$_retryPolicy = null

[line 146]

Microsoft_WindowsAzure_RetryPolicy instance

Tags:

access:

protected

Type:

Microsoft_WindowsAzure_RetryPolicy

[ Top ]

$_usePathStyleUri = false

[line 132]

Use path-style URI's

Tags:

access:

protected

Type:

boolean

[ Top ]

$_useProxy = false

[line 153]

Use proxy?

Tags:

access:

protected

Type:

boolean

[ Top ]

Class Methods

static method urlencode [line 382]

static string urlencode(
string
$value)

URL encode function

Tags:

return:	Encoded value
access:	public

Parameters:

string

$value

Value to encode

[ Top ]

constructor __construct [line 185]

Microsoft_WindowsAzure_Storage __construct(
[string
$host = self::URL_DEV_BLOB], [string
$accountName = Microsoft_WindowsAzure_Credentials::DEVSTORE_ACCOUNT], [string
$accountKey = Microsoft_WindowsAzure_Credentials::DEVSTORE_KEY], [boolean
$usePathStyleUri = false], [Microsoft_WindowsAzure_RetryPolicy
$retryPolicy = null])

Creates a new Microsoft_WindowsAzure_Storage instance

Parameters:

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

[ Top ]

method getAccountName [line 237]

string getAccountName(
)

Returns the Windows Azure account name

Tags:

access:

public

[ Top ]

method getBaseUrl [line 247]

string getBaseUrl(
)

Get base URL for creating requests

Tags:

access:

public

[ Top ]

method getCredentials [line 273]

Microsoft_WindowsAzure_Credentials getCredentials(
)

Get Microsoft_WindowsAzure_Credentials instance

Tags:

access:

public

[ Top ]

method isoDate [line 363]

string isoDate(
[int
$timestamp = null])

Generate ISO 8601 compliant date string in UTC time zone

Tags:

access:

public

Parameters:

int

$timestamp

[ Top ]

method parseResponse [line 335]

object parseResponse(
[
$response = null])

Parse result from Microsoft_Http_Response

Tags:

throws:	Microsoft_WindowsAzure_Exception
access:	protected

Parameters:

Microsoft_Http_Response

$response

Response from HTTP call

[ Top ]

method performRequest [line 291]

Microsoft_Http_Response performRequest(
[string
$path = '/'], [string
$queryString = ''], [string
$httpVerb = Microsoft_Http_Transport::VERB_GET], [array
$headers = array()], [boolean
$forTableStorage = false], [mixed
$rawData = null], [string
$resourceType = Microsoft_WindowsAzure_Storage::RESOURCE_UNKNOWN], [string
$requiredPermission = Microsoft_WindowsAzure_Credentials::PERMISSION_READ])

Perform request using Microsoft_Http_Transport channel

Tags:

access:

protected

Parameters:

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

[ Top ]

method setCredentials [line 260]

void setCredentials(
Microsoft_WindowsAzure_Credentials
$credentials)

Set Microsoft_WindowsAzure_Credentials instance

Tags:

access:

public

Parameters:

Microsoft_WindowsAzure_Credentials

$credentials

Microsoft_WindowsAzure_Credentials instance to use for request signing.

[ Top ]

method setProxy [line 224]

void setProxy(
[boolean
$useProxy = false], [string
$proxyUrl = ''], [int
$proxyPort = 80], [string
$proxyCredentials = ''])

Set proxy

Tags:

access:

public

Parameters:

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

[ Top ]

method setRetryPolicy [line 209]

void setRetryPolicy(
[Microsoft_WindowsAzure_RetryPolicy
$retryPolicy = null])

Set retry policy to use when making requests

Tags:

access:

public

Parameters:

Microsoft_WindowsAzure_RetryPolicy

$retryPolicy

Retry policy to use when making requests

[ Top ]

Class Constants

RESOURCE_BLOB = "b"

[line 94]

[ Top ]

RESOURCE_CONTAINER = "c"

[line 93]

[ Top ]

RESOURCE_ENTITY = "e"

[line 96]

[ Top ]

RESOURCE_QUEUE = "q"

[line 97]

[ Top ]

RESOURCE_TABLE = "t"

[line 95]

[ Top ]

RESOURCE_UNKNOWN = "unknown"

[line 92]

Resource types

[ Top ]

URL_CLOUD_BLOB = "blob.core.windows.net"

[line 85]

Live storage URLS

[ Top ]

URL_CLOUD_QUEUE = "queue.core.windows.net"

[line 86]

[ Top ]

URL_CLOUD_TABLE = "table.core.windows.net"

[line 87]

[ Top ]

URL_DEV_BLOB = "127.0.0.1:10000"

[line 78]

Development storage URLS

[ Top ]

URL_DEV_QUEUE = "127.0.0.1:10001"

[line 79]

[ Top ]

URL_DEV_TABLE = "127.0.0.1:10002"

[line 80]

[ Top ]

Documentation generated on Thu, 26 Nov 2009 08:05:24 +0100 by phpDocumentor 1.4.3