Microsoft_WindowsAzure
[ class tree: Microsoft_WindowsAzure ] [ index: Microsoft_WindowsAzure ] [ all elements ]
Packages:
Microsoft_WindowsAzure
Microsoft
Microsoft_Http
Microsoft_WindowsAzure_Storage


Files:
Credentials.php
SharedAccessSignatureCredentials.php
SharedKeyCredentials.php
SharedKeyLiteCredentials.php

subpackage Exception
Exception.php

subpackage RetryPolicy
Exception.php
NoRetry.php
RetryN.php
RetryPolicy.php

subpackage Session
SessionHandler.php

subpackage Storage
Batch.php
BatchStorage.php
Blob.php
BlobContainer.php
BlobInstance.php
DynamicTableEntity.php
Queue.php
QueueInstance.php
QueueMessage.php
SignedIdentifier.php
Storage.php
Table.php
TableEntity.php
TableEntityQuery.php
TableInstance.php

Classes:
Storage
   Microsoft_WindowsAzure_Storage
   Microsoft_WindowsAzure_Storage_Batch
   Microsoft_WindowsAzure_Storage_BatchStorage
   Microsoft_WindowsAzure_Storage_Blob
   Microsoft_WindowsAzure_Storage_BlobContainer
   Microsoft_WindowsAzure_Storage_BlobInstance
   Microsoft_WindowsAzure_Storage_DynamicTableEntity
   Microsoft_WindowsAzure_Storage_Queue
   Microsoft_WindowsAzure_Storage_QueueInstance
   Microsoft_WindowsAzure_Storage_QueueMessage
   Microsoft_WindowsAzure_Storage_SignedIdentifier
   Microsoft_WindowsAzure_Storage_Table
   Microsoft_WindowsAzure_Storage_TableEntity
   Microsoft_WindowsAzure_Storage_TableEntityQuery
   Microsoft_WindowsAzure_Storage_TableInstance
Microsoft_WindowsAzure_Credentials
Microsoft_WindowsAzure_SharedAccessSignatureCredentials
Microsoft_WindowsAzure_SharedKeyCredentials
Microsoft_WindowsAzure_SharedKeyLiteCredentials
Exception
   Microsoft_WindowsAzure_Exception
RetryPolicy
   Microsoft_WindowsAzure_RetryPolicy
   Microsoft_WindowsAzure_RetryPolicy_Exception
   Microsoft_WindowsAzure_RetryPolicy_NoRetry
   Microsoft_WindowsAzure_RetryPolicy_RetryN
Session
   Microsoft_WindowsAzure_SessionHandler

Class: Microsoft_WindowsAzure_Credentials

Source Location: /WindowsAzure/Credentials.php

Class Overview








Author(s):


    
                    





      
          


Copyright:


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


        




Variables






Constants






Methods















Child classes:






Microsoft_WindowsAzure_SharedAccessSignatureCredentials

	






Microsoft_WindowsAzure_SharedKeyCredentials

	






Microsoft_WindowsAzure_SharedKeyLiteCredentials

	

















Class Details



[line 46]





Tags:





  

    copyright:  Copyright (c) 2009, 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 __construct(
[string
$accountName = Microsoft_WindowsAzure_Credentials::DEVSTORE_ACCOUNT], [string
$accountKey = Microsoft_WindowsAzure_Credentials::DEVSTORE_KEY], [boolean
$usePathStyleUri = false])
    

    


	
		Creates a new Microsoft_WindowsAzure_Credentials instance





Tags:





  

    access:  public
  









	
Overridden in child classes as:

		

	
Microsoft_WindowsAzure_SharedAccessSignatureCredentials::__construct()

		
Creates a new Microsoft_WindowsAzure_SharedAccessSignatureCredentials 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 prepareQueryStringForSigning [line 165]

	

    

    

		string prepareQueryStringForSigning(
string
$value)
    

    


	
		Prepare query string for signing





Tags:





  

    return:  Query string for signing
  

  

    access:  protected
  









	
        
Parameters:

    

    

          

        string  
        $value  
        Original query string
      

        

    


        
[ Top ]

  

  

	
	
method setAccountkey [line 119]

	

    

    

		void setAccountkey(
[string
$value = Microsoft_WindowsAzure_Credentials::DEVSTORE_KEY])
    

    


	
		Set account key for Windows Azure





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setAccountName [line 109]

	

    

    

		void setAccountName(
[string
$value = Microsoft_WindowsAzure_Credentials::DEVSTORE_ACCOUNT])
    

    


	
		Set account name for Windows Azure





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        string  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method setUsePathStyleUri [line 129]

	

    

    

		void setUsePathStyleUri(
[boolean
$value = false])
    

    


	
		Set use path-style URI's





Tags:





  

    access:  public
  









	
        
Parameters:

    

    

          

        boolean  
        $value  
        
      

        

    


        
[ Top ]

  

  

	
	
method signRequestHeaders [line 156]

	

    

    

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

    


	
		Sign request headers with credentials





Tags:





  

    return:  Array of headers
  

  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
Microsoft_WindowsAzure_SharedAccessSignatureCredentials::signRequestHeaders()

		
Sign request with credentials

	

		

	
Microsoft_WindowsAzure_SharedKeyCredentials::signRequestHeaders()

		
Sign request headers with credentials

	

		

	
Microsoft_WindowsAzure_SharedKeyLiteCredentials::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
      

        

    


        
[ Top ]

  

  

	
	
method signRequestUrl [line 142]

	

    

    

		string signRequestUrl(
[string
$requestUrl = ''], string
$resourceType, string
$requiredPermission)
    

    


	
		Sign request URL with credentials





Tags:





  

    return:  Signed request URL
  

  

    abstract:  
  

  

    access:  public
  









	
Overridden in child classes as:

		

	
Microsoft_WindowsAzure_SharedAccessSignatureCredentials::signRequestUrl()

		
Sign request URL with credentials

	

		

	
Microsoft_WindowsAzure_SharedKeyCredentials::signRequestUrl()

		
Sign request URL with credentials

	

		

	
Microsoft_WindowsAzure_SharedKeyLiteCredentials::signRequestUrl()

		
Sign request URL with credentials

	

	

	
        
Parameters:

    

    

          

        string  
        $requestUrl  
        Request URL
      

          

        string  
        $resourceType  
        Resource type
      

          

        string  
        $requiredPermission  
        Required permission
      

        

    


        
[ 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 Thu, 26 Nov 2009 08:04:49 +0100 by phpDocumentor 1.4.3