PHPXRef 0.7.1 : moodle-2.8 : Detail view of Blob.php

Class: Zend_Service_WindowsAzure_Storage_Blob - X-Ref

__construct($host = Zend_Service_WindowsAzure_Storage::URL_DEV_BLOB, $accountName = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_ACCOUNT, $accountKey = Zend_Service_WindowsAzure_Credentials_CredentialsAbstract::DEVSTORE_KEY, $usePathStyleUri = false, Zend_Service_WindowsAzure_RetryPolicy_RetryPolicyAbstract $retryPolicy = null) X-Ref

Creates a new Zend_Service_WindowsAzure_Storage_Blob instance

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

blobExists($containerName = '', $blobName = '') X-Ref

Check if a blob exists

param: string $containerName Container name
param: string $blobName Blob name
return: boolean

containerExists($containerName = '') X-Ref

Check if a container exists

param: string $containerName Container name
return: boolean

createContainer($containerName = '', $metadata = array() X-Ref

Create container

param: string $containerName Container name
param: array $metadata Key/value pairs of meta data
return: object Container properties

getContainerAcl($containerName = '', $signedIdentifiers = false) X-Ref

Get container ACL

param: string $containerName Container name
param: bool $signedIdentifiers Display only public/private or display signed identifiers?
return: bool Acl, to be compared with Zend_Service_WindowsAzure_Storage_Blob::ACL_*

setContainerAcl($containerName = '', $acl = self::ACL_PRIVATE, $signedIdentifiers = array() X-Ref

Set container ACL

param: string $containerName Container name
param: bool $acl Zend_Service_WindowsAzure_Storage_Blob::ACL_*
param: array $signedIdentifiers Signed identifiers

getContainer($containerName = '') X-Ref

Get container

param: string $containerName Container name
return: Zend_Service_WindowsAzure_Storage_BlobContainer

getContainerMetadata($containerName = '') X-Ref

Get container metadata

param: string $containerName Container name
return: array Key/value pairs of meta data

setContainerMetadata($containerName = '', $metadata = array() X-Ref

Set container metadata

Calling the Set Container Metadata operation overwrites all existing metadata that is associated with the container. It's not possible to modify an individual name/value pair.

param: string $containerName      Container name
param: array  $metadata           Key/value pairs of meta data
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.

deleteContainer($containerName = '', $additionalHeaders = array() X-Ref

Delete container

param: string $containerName Container name
param: array $additionalHeaders Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.

listContainers($prefix = null, $maxResults = null, $marker = null, $currentResultCount = 0) X-Ref

List containers

param: string $prefix     Optional. Filters the results to return only containers whose name begins with the specified prefix.
param: int    $maxResults Optional. Specifies the maximum number of containers to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)
param: string $marker     Optional string value that identifies the portion of the list to be returned with the next list operation.
param: int    $currentResultCount Current result count (internal use)
return: array

putBlob($containerName = '', $blobName = '', $localFileName = '', $metadata = array() X-Ref

Put blob

param: string $containerName      Container name
param: string $blobName           Blob name
param: string $localFileName      Local file name to be uploaded
param: array  $metadata           Key/value pairs of meta data
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
return: object Partial blob properties

putLargeBlob($containerName = '', $blobName = '', $localFileName = '', $metadata = array() X-Ref

Put large blob (> 64 MB)

param: string $containerName Container name
param: string $blobName Blob name
param: string $localFileName Local file name to be uploaded
param: array $metadata Key/value pairs of meta data
return: object Partial blob properties

putBlock($containerName = '', $blobName = '', $identifier = '', $contents = '') X-Ref

Put large blob block

param: string $containerName Container name
param: string $blobName      Blob name
param: string $identifier    Block ID
param: array  $contents      Contents of the block

putBlockList($containerName = '', $blobName = '', $blockList = array() X-Ref

Put block list

param: string $containerName      Container name
param: string $blobName           Blob name
param: array $blockList           Array of block identifiers
param: array  $metadata           Key/value pairs of meta data
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.

getBlockList($containerName = '', $blobName = '', $type = 0) X-Ref

Get block list

param: string $containerName Container name
param: string $blobName Blob name
param: integer $type Type of block list to retrieve. 0 = all, 1 = committed, 2 = uncommitted
return: array

copyBlob($sourceContainerName = '', $sourceBlobName = '', $destinationContainerName = '', $destinationBlobName = '', $metadata = array() X-Ref

Copy blob

param: string $sourceContainerName       Source container name
param: string $sourceBlobName            Source blob name
param: string $destinationContainerName  Destination container name
param: string $destinationBlobName       Destination blob name
param: array  $metadata                  Key/value pairs of meta data
param: array  $additionalHeaders         Additional headers. See http://msdn.microsoft.com/en-us/library/dd894037.aspx for more information.
return: object Partial blob properties

getBlob($containerName = '', $blobName = '', $localFileName = '', $additionalHeaders = array() X-Ref

Get blob

param: string $containerName      Container name
param: string $blobName           Blob name
param: string $localFileName      Local file name to store downloaded blob
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.

getBlobInstance($containerName = '', $blobName = '', $additionalHeaders = array() X-Ref

Get container

param: string $containerName      Container name
param: string $blobName           Blob name
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.
return: Zend_Service_WindowsAzure_Storage_BlobInstance

getBlobMetadata($containerName = '', $blobName = '') X-Ref

Get blob metadata

param: string $containerName Container name
param: string $blobName Blob name
return: array Key/value pairs of meta data

setBlobMetadata($containerName = '', $blobName = '', $metadata = array() X-Ref

Set blob metadata

Calling the Set Blob Metadata operation overwrites all existing metadata that is associated with the blob. It's not possible to modify an individual name/value pair.

param: string $containerName      Container name
param: string $blobName           Blob name
param: array  $metadata           Key/value pairs of meta data
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.

deleteBlob($containerName = '', $blobName = '', $additionalHeaders = array() X-Ref

Delete blob

param: string $containerName      Container name
param: string $blobName           Blob name
param: array  $additionalHeaders  Additional headers. See http://msdn.microsoft.com/en-us/library/dd179371.aspx for more information.

listBlobs($containerName = '', $prefix = '', $delimiter = '', $maxResults = null, $marker = null, $currentResultCount = 0) X-Ref

List blobs

param: string $containerName Container name
param: string $prefix     Optional. Filters the results to return only blobs whose name begins with the specified prefix.
param: string $delimiter  Optional. Delimiter, i.e. '/', for specifying folder hierarchy
param: int    $maxResults Optional. Specifies the maximum number of blobs to return per call to Azure storage. This does NOT affect list size returned by this function. (maximum: 5000)
param: string $marker     Optional string value that identifies the portion of the list to be returned with the next list operation.
param: int    $currentResultCount Current result count (internal use)
return: array

generateSharedAccessUrl($containerName = '', $blobName = '', $resource = 'b', $permissions = 'r', $start = '', $expiry = '', $identifier = '') X-Ref

Generate shared access URL

param: string $containerName  Container name
param: string $blobName       Blob name
param: string $resource       Signed resource - container (c) - blob (b)
param: string $permissions    Signed permissions - read (r), write (w), delete (d) and list (l)
param: string $start          The time at which the Shared Access Signature becomes valid.
param: string $expiry         The time at which the Shared Access Signature becomes invalid.
param: string $identifier     Signed identifier
return: string

registerAsClient($name) X-Ref

Register this object as stream wrapper client

param: string $name Protocol name
return: Zend_Service_WindowsAzure_Storage_Blob

unregisterAsClient($name) X-Ref

Unregister this object as stream wrapper client

param: string $name Protocol name
return: Zend_Service_WindowsAzure_Storage_Blob

getWrapperClient($name) X-Ref

Get wrapper client for stream type

param: string $name Protocol name
return: Zend_Service_WindowsAzure_Storage_Blob

registerStreamWrapper($name = 'azure') X-Ref

Register this object as stream wrapper

param: string $name Protocol name

unregisterStreamWrapper($name = 'azure') X-Ref

Unregister this object as stream wrapper

param: string $name Protocol name
return: Zend_Service_WindowsAzure_Storage_Blob

createResourceName($containerName = '', $blobName = '') X-Ref

Create resource name

param: string $containerName Container name
param: string $blobName Blob name
return: string

isValidContainerName($containerName = '') X-Ref

Is valid container name?

param: string $containerName Container name
return: boolean

_getErrorMessage(Zend_Http_Response $response, $alternativeError = 'Unknown error.') X-Ref

Get error message from Zend_Http_Response

param: Zend_Http_Response $response Repsonse
param: string $alternativeError Alternative error message
return: string

_generateBlockId($part = 0) X-Ref

Generate block id

param: int $part Block number
return: string Windows Azure Blob Storage block number

Copyright:	Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License:	http://todo name_todo
Version:	$Id$
File Size:	1401 lines (55 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

PHP Cross Reference of moodle-2.8

/lib/zend/Zend/Service/WindowsAzure/Storage/ -> Blob.php (summary)

Defines 1 class