API Documentation

Zend/Service/WindowsAzure/Credentials/SharedAccessSignature.php

Show: inherited
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 license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_WindowsAzure  
Version
$Id: SharedAccessSignature.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_WindowsAzure_Credentials_SharedAccessSignature

Package: Zend\Service\WindowsAzure

Parent(s)
\Zend_Service_WindowsAzure_Credentials_CredentialsAbstract
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_permissionSet= 'array()'

Permission set

Default valuearray()Details
Type
array

Methods

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

Creates a new Zend_Service_WindowsAzure_Credentials_SharedAccessSignature instance

Parameters
Name Type Description
$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

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

Create signature

Parameters
Name Type Description
$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

Returns
Type Description
string
methodpubliccreateSignedQueryString( string $path = '/', string $queryString = '', string $resource = 'b', string $permissions = 'r', string $start = '', string $expiry = '', string $identifier = '' ) : string

Create signed query string

Parameters
Name Type Description
$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

Returns
Type Description
string
methodpublicgetPermissionSet( ) : array

Get permission set

Returns
Type Description
array
methodpublicpermissionMatchesRequest( string $permissionUrl = '', string $requestUrl = '', string $resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ ) : string

Permission matches request?

Parameters
Name Type Description
$permissionUrl string

Permission URL

$requestUrl string

Request URL

$resourceType string

Resource type

$requiredPermission string

Required permission

Returns
Type Description
string Signed request URL
methodpublicsetPermissionSet( 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

Parameters
Name Type Description
$value array

Permission set

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

Sign request with credentials

Parameters
Name Type Description
$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

Returns
Type Description
array Array of headers
methodpublicsignRequestUrl( string $requestUrl = '', string $resourceType = Zend_Service_WindowsAzure_Storage::RESOURCE_UNKNOWN, string $requiredPermission = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::PERMISSION_READ ) : string

Sign request URL with credentials

Parameters
Name Type Description
$requestUrl string

Request URL

$resourceType string

Resource type

$requiredPermission string

Required permission

Returns
Type Description
string Signed request URL
Documentation was generated by DocBlox 0.15.1.