Service/WindowsAzure/Credentials/SharedAccessSignature.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_SharedAccessSignature

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_SharedAccessSignature
jump to top

Extends from: Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
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
Properties: $_permissionSet
Methods: __construct; getPermissionSet; setPermissionSet; createSignature; createSignedQueryString; permissionMatchesRequest; signRequestUrl; signRequestHeaders

Description

Properties

$_permissionSet
jump to class

array $_permissionSet = 'array'

Permission set

Details

$_permissionSet: array
visibility: protected
default: array
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, array $permissionSet
              =
              array
          )
        
        :

Creates a new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance

Arguments

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

Details

visibility: public
final: false
static: false

createSignature
jump to class

createSignature(
          string $path
              =
              /, string $resource
              =
              b, string $permissions
              =
              r, string $start, string $expiry, string $identifier
          )
        
        :
        string

Create signature

Arguments

$path: string
Path for the request
$resource: string
Signed resource - container (c) - blob (b)
$permissions: string
Signed permissions - read (r), write (w), delete (d) and list (l)
$start: string
The time at which the Shared Access Signature becomes valid.
$expiry: string
The time at which the Shared Access Signature becomes invalid.
$identifier: string
Signed identifier

Output

string

Details

visibility: public
final: false
static: false

createSignedQueryString
jump to class

createSignedQueryString(
          string $path
              =
              /, string $queryString, string $resource
              =
              b, string $permissions
              =
              r, string $start, string $expiry, string $identifier
          )
        
        :
        string

Create signed query string

Arguments

$path: string
Path for the request
$queryString: string
Query string for the request
$resource: string
Signed resource - container (c) - blob (b)
$permissions: string
Signed permissions - read (r), write (w), delete (d) and list (l)
$start: string
The time at which the Shared Access Signature becomes valid.
$expiry: string
The time at which the Shared Access Signature becomes invalid.
$identifier: string
Signed identifier

Output

string

Details

visibility: public
final: false
static: false

getPermissionSet
jump to class

getPermissionSet(
          
          )
        
        :
        array

Get permission set

Output

array

Details

visibility: public
final: false
static: false

permissionMatchesRequest
jump to class

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

Permission matches request?

Arguments

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

Output

string: Signed request URL

Details

visibility: public
final: false
static: false

setPermissionSet
jump to class

setPermissionSet(
          array $value
              =
              array
          )
        
        :
        void

Set permisison set

Warning: fine-grained permissions should be added prior to coarse-grained permissions. For example: first add blob permissions, end with container-wide permissions.

Warning: the signed access signature URL must match the account name of the Zend_Service_WindowsAzure_Credentials_Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance

Arguments

$value: array
Permission set

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 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/SharedAccessSignature.php

Description

Zend_Service_WindowsAzure_Credentials_SharedAccessSignaturejump to top

Description

Properties

$_permissionSetjump to class

Details

Methods

__constructjump to class

Arguments

Details

createSignaturejump to class

Arguments

Output

Details

createSignedQueryStringjump to class

Arguments

Output

Details

getPermissionSetjump to class

Output

Details

permissionMatchesRequestjump to class

Arguments

Output

Details

setPermissionSetjump to class

Arguments

Details

signRequestHeadersjump to class

Arguments

Output

Details

signRequestUrljump to class

Arguments

Output

Details

Zend_Service_WindowsAzure_Credentials_SharedAccessSignature
jump to top

$_permissionSet
jump to class

__construct
jump to class

createSignature
jump to class

createSignedQueryString
jump to class

getPermissionSet
jump to class

permissionMatchesRequest
jump to class

setPermissionSet
jump to class

signRequestHeaders
jump to class

signRequestUrl
jump to class