azure-storage-file\src\File\FileRestProxy.php

Show:

inherited

Classes
- \MicrosoftAzure\Storage\File\FileRestProxy

Table of Contents

LICENSE: The MIT License (the "License") you may not use this file except in compliance with the License.

You may obtain a copy of the License at https://github.com/azure/azure-storage-php/LICENSE

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

PHP version 5

Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2017 Microsoft Corporation
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php
Package: MicrosoftAzure\Storage\File

\MicrosoftAzure\Storage\File\FileRestProxy
jump to top

Package: MicrosoftAzure\Storage\File

This class constructs HTTP requests and receive HTTP responses for File service layer.

Implements
Parent(s): \MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
Author: Azure Storage PHP SDK
Category: Microsoft
Copyright: 2017 Microsoft Corporation
Inherited_from: \MicrosoftAzure\Storage\Common\Internal\ServiceRestProxy
License: https://github.com/azure/azure-storage-php/LICENSE
Link: https://github.com/azure/azure-storage-php

Properties

\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer

Details

Type: \MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer

Methods

__construct(\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer $dataSerializer = null) : void

inherited

Initializes new RestProxy object.

Inherited from:

Parameters

Name	Type	Description
$dataSerializer	\MicrosoftAzure\Storage\Common\Internal\Serialization\ISerializer	The data serializer.

abortCopy(string $share, string $path, string $copyID, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Abort a file copy operation

Parameters

Name	Type	Description
$share	string	name of the share
$path	string	path of the file
$copyID	string	copy operation identifier.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

abortCopyAsync(string $share, string $path, string $copyID, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Creates promise to abort a file copy operation

Parameters

Name	Type	Description
$share	string	name of the share
$path	string	path of the file
$copyID	string	copy operation identifier.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

addMetadataHeaders(array $headers, array $metadata = null) : array

inherited

Adds metadata elements to headers array

Inherited from:

Parameters

Name	Type	Description
$headers	array	HTTP request headers
$metadata	array	user specified metadata

Returns

Type	Description
array

addOptionalHeader(array $headers, string $key, string $value) : void

inherited

Adds optional header.

Inherited from:

Doesn't add the value if it satisfies empty().

Parameters

Name	Type	Description
$headers	array	&$headers The HTTP header parameters.
$key	string	The HTTP header name.
$value	string	The HTTP header value.

addOptionalQueryParam(array $queryParameters, string $key, string $value) : void

inherited

Adds optional query parameter.

Inherited from:

Doesn't add the value if it satisfies empty().

Parameters

Name	Type	Description
$queryParameters	array	&$queryParameters The query parameters.
$key	string	The query variable name.
$value	string	The query variable value.

addPostParameter(array $postParameters, string $key, string $value) : array

inherited

Adds HTTP POST parameter to the specified

Inherited from:

Parameters

Name	Type	Description
$postParameters	array	An array of HTTP POST parameters.
$key	string	The key of a HTTP POST parameter.
$value	string	the value of a HTTP POST parameter.

Returns

Type	Description
array

clearFileRange(string $share, string $path, \MicrosoftAzure\Storage\Common\Models\Range $range, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Clears range of bytes of a file. If the specified range is not 512-byte aligned, the operation will write zeros to the start or end of the range that is not 512-byte aligned and free the rest of the range inside that is 512-byte aligned.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$range	\MicrosoftAzure\Storage\Common\Models\Range	The range in the file to be cleared.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Details

See

clearFileRangeAsync(string $share, string $path, \MicrosoftAzure\Storage\Common\Models\Range $range, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to clear range of bytes of a file. If the specified range is not 512-byte aligned, the operation will write zeros to the start or end of the range that is not 512-byte aligned and free the rest of the range inside that is 512-byte aligned.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$range	\MicrosoftAzure\Storage\Common\Models\Range	The range in the file to be cleared.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

copyFile(string $share, string $path, string $sourcePath, array $metadata = array(), \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\CopyFileResult

Informs server to copy file from $sourcePath to $path.

To copy a file to another file within the same storage account, you may use Shared Key to authenticate the source file. If you are copying a file from another storage account, or if you are copying a blob from the same storage account or another storage account, then you must authenticate the source file or blob using a shared access signature. If the source is a public blob, no authentication is required to perform the copy operation. Here are some examples of source object URLs: https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile https://myaccount.blob.core.windows.net/mycontainer/myblob?sastoken

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$sourcePath	string	The path of the source.
$metadata	array	The metadata of the file. If specified, source metadata will not be copied.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\CopyFileResult

Details

See

copyFileAsync(string $share, string $path, string $sourcePath, array $metadata = array(), \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to inform server to copy file from $sourcePath to $path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$sourcePath	string	The path of the source.
$metadata	array	The metadata of the file. If specified, source metadata will not be copied.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

createDirectory(string $share, string $path, \MicrosoftAzure\Storage\File\Models\CreateDirectoryOptions | null $options = null) : void

Creates a new directory in the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to create the directory.
$options	\MicrosoftAzure\Storage\File\Models\CreateDirectoryOptions \| null	The optional parameters.

Details

See

createDirectoryAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\CreateDirectoryOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates a promise to create a new directory in the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to create the directory.
$options	\MicrosoftAzure\Storage\File\Models\CreateDirectoryOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

createFile(string $share, string $path, integer $size, \MicrosoftAzure\Storage\File\Models\CreateFileOptions | null $options = null) : void

Create a new file.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path and name of the file.
$size	integer	The size of the file.
$options	\MicrosoftAzure\Storage\File\Models\CreateFileOptions \| null	The optional parameters.

Details

See

createFileAsync(string $share, string $path, integer $size, \MicrosoftAzure\Storage\File\Models\CreateFileOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to create a new file.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path and name of the file.
$size	integer	The size of the file.
$options	\MicrosoftAzure\Storage\File\Models\CreateFileOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

createFileFromContent(string $share, string $path, \Psr\Http\Message\StreamInterface | resource | string $content, \MicrosoftAzure\Storage\File\Models\CreateFileFromContentOptions | null $options = null) : void

Creates a file from a provided content.

Parameters

Name	Type	Description
$share	string	the share name
$path	string	the path of the file
$content	\Psr\Http\Message\StreamInterface \| resource \| string	the content used to create the file
$options	\MicrosoftAzure\Storage\File\Models\CreateFileFromContentOptions \| null	optional parameters

createFileFromContentAsync(string $share, string $path, \Psr\Http\Message\StreamInterface | resource | string $content, \MicrosoftAzure\Storage\File\Models\CreateFileFromContentOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates a promise to create a file from a provided content.

Parameters

Name	Type	Description
$share	string	the share name
$path	string	the path of the file
$content	\Psr\Http\Message\StreamInterface \| resource \| string	the content used to create the file
$options	\MicrosoftAzure\Storage\File\Models\CreateFileFromContentOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

createFileService(string $connectionString, array $options = array()) : \MicrosoftAzure\Storage\File\FileRestProxy

static

Builds a file service object, it accepts the following options:

http: (array) the underlying guzzle options. refer to http://docs.guzzlephp.org/en/latest/request-options.html for detailed available options
middlewares: (mixed) the middleware should be either an instance of a sub-class that implements \MicrosoftAzure\Storage\File\MicrosoftAzure\Storage\Common\Middlewares\IMiddleware, or a callable that follows the Guzzle middleware implementation convention

Please refer to https://azure.microsoft.com/en-us/documentation/articles/storage-configure-connection-string for how to construct a connection string with storage account name/key, or with a shared access signature (SAS Token).

Parameters

Name	Type	Description
$connectionString	string	The configuration connection string.
$options	array	Array of options to pass to the service

Returns

Type	Description
\MicrosoftAzure\Storage\File\FileRestProxy

createMiddlewareStack(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions) : \MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

inherited

Create a middleware stack with given middleware.

Inherited from:

Parameters

Name	Type	Description
$serviceOptions	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The options user passed in.

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Middlewares\MiddlewareStack

createRequest(string $method, array $headers, array $queryParams, array $postParameters, string $path,  $locationMode, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING) : \GuzzleHttp\Psr7\Request

inherited

Create the request to be sent.

Inherited from:

Parameters

Name	Type	Description
$method	string	The method of the HTTP request
$headers	array	The header field of the request
$queryParams	array	The query parameter of the request
$postParameters	array	The HTTP POST parameters
$path	string	URL path
$locationMode
$body	string	Request body

Returns

Type	Description
\GuzzleHttp\Psr7\Request

createShare(string $share, \MicrosoftAzure\Storage\File\Models\CreateShareOptions | null $options = null) : void

Creates a new share in the given storage account.

Parameters

Name	Type	Description
$share	string	The share name.
$options	\MicrosoftAzure\Storage\File\Models\CreateShareOptions \| null	The optional parameters.

Details

See

createShareAsync(string $share, \MicrosoftAzure\Storage\File\Models\CreateShareOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to create a new share in the given storage account.

Parameters

Name	Type	Description
$share	string	The share name.
$options	\MicrosoftAzure\Storage\File\Models\CreateShareOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

deleteDirectory(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Deletes a directory in the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the directory.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Details

See

deleteDirectoryAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates a promise to delete a new directory in the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the directory.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

deleteFile(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Deletes a file in the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the file.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Details

See

deleteFileAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates a promise to delete a new file in the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the file.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

deleteShare(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Deletes a share in the given storage account.

Parameters

Name	Type	Description
$share	string	name of the share
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

deleteShareAsync(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Create a promise for deleting a share.

Parameters

Name	Type	Description
$share	string	name of the share
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

generateMetadataHeaders(array $metadata = null) : array

inherited

Generates metadata headers by prefixing each element with 'x-ms-meta'.

Inherited from:

Parameters

Name	Type	Description
$metadata	array	user defined metadata.

Returns

Type	Description
array

generateRequestOptions(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions, callable $handler) : array

inherited

Generate the request options using the given service options and stored information.

Inherited from:

Parameters

Name	Type	Description
$serviceOptions	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The service options used to generate request options.
$handler	callable	The handler used to send the request.

Returns

Type	Description
array

getAccountName() : string

inherited

Gets the account name.

Inherited from:

Returns

Type	Description
string

getDirectoryMetadata(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetDirectoryMetadataResult

Gets a directory's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the directory.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetDirectoryMetadataResult

Details

See

getDirectoryMetadataAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to get a directory's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the directory.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getDirectoryProperties(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetDirectoryPropertiesResult

Gets a directory's properties from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the directory.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetDirectoryPropertiesResult

Details

See

getDirectoryPropertiesAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to get a directory's properties from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the directory.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getFile(string $share, string $path, \MicrosoftAzure\Storage\File\Models\GetFileOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetFileResult

Reads or downloads a file from the server, including its metadata and properties.

Parameters

Name	Type	Description
$share	string	name of the share
$path	string	path of the file to be get
$options	\MicrosoftAzure\Storage\File\Models\GetFileOptions \| null	optional parameters

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetFileResult

Details

See

getFileAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\GetFileOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to read or download a file from the server, including its metadata and properties.

Parameters

Name	Type	Description
$share	string	name of the share
$path	string	path of the file to be get
$options	\MicrosoftAzure\Storage\File\Models\GetFileOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getFileMetadata(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetFileMetadataResult

Gets a file's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetFileMetadataResult

Details

See

getFileMetadataAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to get a file's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getFileProperties(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\FileProperties

Gets a file's properties from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the file.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\FileProperties

Details

See

getFilePropertiesAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to get a file's properties from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the file.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getMiddlewares() : array

inherited

Gets middlewares that will be handling the request and response.

Inherited from:

Returns

Type	Description
array

getPsrPrimaryUri() : \GuzzleHttp\Psr7\Uri

inherited

Get the primary URI in PSR form.

Inherited from:

Returns

Type	Description
\GuzzleHttp\Psr7\Uri

getPsrSecondaryUri() : \GuzzleHttp\Psr7\Uri

inherited

Get the secondary URI in PSR form.

Inherited from:

Returns

Type	Description
\GuzzleHttp\Psr7\Uri

getServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult

inherited

Gets the properties of the service.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Models\GetServicePropertiesResult

Details

See

getServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates promise to get the properties of the service.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getServiceStats(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult

inherited

Retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions \| null	The options this operation sends with.

Returns

Type	Description
\MicrosoftAzure\Storage\Common\Models\GetServiceStatsResult

getServiceStatsAsync(\MicrosoftAzure\Storage\Common\Models\ServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates promise that retrieves statistics related to replication for the service. The operation will only be sent to secondary location endpoint.

Inherited from:

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions \| null	The options this operation sends with.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

getShareAcl(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetShareACLResult

Gets the access control list (ACL) for the share.

Parameters

Name	Type	Description
$share	string	The share name.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetShareACLResult

Details

See

getShareAclAsync(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates the promise to get the access control list (ACL) for the share.

Parameters

Name	Type	Description
$share	string	The share name.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getShareMetadata(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetSharePropertiesResult

Returns only user-defined metadata for the specified share.

Parameters

Name	Type	Description
$share	string	name
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetSharePropertiesResult

Details

See

getShareMetadataAsync(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Create promise to return only user-defined metadata for the specified share.

Parameters

Name	Type	Description
$share	string	name
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getShareProperties(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetSharePropertiesResult

Returns all properties and metadata on the share.

Parameters

Name	Type	Description
$share	string	name
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetSharePropertiesResult

Details

See

getSharePropertiesAsync(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Create promise to return all properties and metadata on the share.

Parameters

Name	Type	Description
$share	string	name
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

getShareStats(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\GetShareStatsResult

Get the statistics related to the share.

Parameters

Name	Type	Description
$share	string	The name of the share.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The request options.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\GetShareStatsResult

Details

See

getShareStatsAsync(string $share, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Get the statistics related to the share.

Parameters

Name	Type	Description
$share	string	The name of the share.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The request options.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

groupQueryValues(array $values) : string

staticinherited

Groups set of values into one value separated with Resources::SEPARATOR

Inherited from:

Parameters

Name	Type	Description
$values	array	array of values to be grouped.

Returns

Type	Description
string

listDirectoriesAndFiles(string $share, string $path = '', \MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesResult

List directories and files under specified path.

Parameters

Name	Type	Description
$share	string	The share that contains all the files and directories.
$path	string	The path to be listed.
$options	\MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions \| null	Optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesResult

Details

See

listDirectoriesAndFilesAsync(string $share, string $path = '', \MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to list directories and files under specified path.

Parameters

Name	Type	Description
$share	string	The share that contains all the files and directories.
$path	string	The path to be listed.
$options	\MicrosoftAzure\Storage\File\Models\ListDirectoriesAndFilesOptions \| null	Optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

listFileRange(string $share, string $path, \MicrosoftAzure\Storage\Common\Models\Range $range = null, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\ListFileRangesResult

Lists range of bytes of a file.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$range	\MicrosoftAzure\Storage\Common\Models\Range	The range in the file to be listed.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\ListFileRangesResult

Details

See

listFileRangeAsync(string $share, string $path, \MicrosoftAzure\Storage\Common\Models\Range $range = null, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to list range of bytes of a file.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$range	\MicrosoftAzure\Storage\Common\Models\Range	The range in the file to be listed.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

listShares(\MicrosoftAzure\Storage\File\Models\ListSharesOptions | null $options = null) : \MicrosoftAzure\Storage\File\Models\ListSharesResult

Returns a list of the shares under the specified account

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\File\Models\ListSharesOptions \| null	The optional parameters

Returns

Type	Description
\MicrosoftAzure\Storage\File\Models\ListSharesResult

Details

See

listSharesAsync(\MicrosoftAzure\Storage\File\Models\ListSharesOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Create a promise to return a list of the shares under the specified account

Parameters

Name	Type	Description
$options	\MicrosoftAzure\Storage\File\Models\ListSharesOptions \| null	The optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

onRejected(string | \Exception $reason, array | integer $expected) : \Psr\Http\Message\ResponseInterface

inherited

Inherited from:

Parameters

Name	Type	Description
$reason	string \| \Exception	Rejection reason.
$expected	array \| integer	Expected Status Codes.

Returns

Type	Description
\Psr\Http\Message\ResponseInterface

pushMiddleware(callable | \MicrosoftAzure\Storage\Common\Internal\IMiddleware $middleware) : void

inherited

Push a new middleware into the middlewares array. The newly added middleware will be the most inner middleware when executed.

Inherited from:

Parameters

Name	Type	Description
$middleware	callable \| \MicrosoftAzure\Storage\Common\Internal\IMiddleware	the middleware to be added.

putFileRange(string $share, string $path, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Common\Models\Range $range, \MicrosoftAzure\Storage\File\Models\PutFileRangeOptions | null $options = null) : void

Writes range of bytes to a file. Range can be at most 4MB in length.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$content	string \| resource \| \Psr\Http\Message\StreamInterface	The content to be uploaded.
$range	\MicrosoftAzure\Storage\Common\Models\Range	The range in the file to be put.
$options	\MicrosoftAzure\Storage\File\Models\PutFileRangeOptions \| null	The optional parameters.

Details

See

putFileRangeAsync(string $share, string $path, string | resource | \Psr\Http\Message\StreamInterface $content, \MicrosoftAzure\Storage\Common\Models\Range $range, \MicrosoftAzure\Storage\File\Models\PutFileRangeOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to write range of bytes to a file. Range can be at most 4MB in length.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path of the file.
$content	string \| resource \| \Psr\Http\Message\StreamInterface	The content to be uploaded.
$range	\MicrosoftAzure\Storage\Common\Models\Range	The range in the file to be put.
$options	\MicrosoftAzure\Storage\File\Models\PutFileRangeOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

sendAsync(string $method, array $headers, array $queryParams, array $postParameters, string $path, array | integer $expected = \MicrosoftAzure\Storage\Common\Internal\Resources::STATUS_OK, string $body = \MicrosoftAzure\Storage\Common\Internal\Resources::EMPTY_STRING, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $serviceOptions = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Create promise of sending HTTP request with the specified parameters.

Inherited from:

Parameters

Name	Type	Description
$method	string	HTTP method used in the request
$headers	array	HTTP headers.
$queryParams	array	URL query parameters.
$postParameters	array	The HTTP POST parameters.
$path	string	URL path
$expected	array \| integer	Expected Status Codes.
$body	string	Request body
$serviceOptions	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	Service options

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

sendConcurrentAsync(callable $generator, integer $statusCode, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options) : \GuzzleHttp\Promise\Promise | \GuzzleHttp\Promise\PromiseInterface

inherited

Send the requests concurrently. Number of concurrency can be modified by inserting a new key/value pair with the key 'number_of_concurrency' into the $requestOptions of $serviceOptions. Return only the promise.

Inherited from:

Parameters

Name	Type	Description
$generator	callable	the generator function to generate request upon fulfillment
$statusCode	integer	The expected status code for each of the request generated by generator.
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The service options for the concurrent requests.

Returns

Type	Description
\GuzzleHttp\Promise\Promise \| \GuzzleHttp\Promise\PromiseInterface

sendContext(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Psr7\Response

inherited

Sends the context.

Inherited from:

Parameters

Name	Type	Description
$context	\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext	The context of the request.

Returns

Type	Description
\GuzzleHttp\Psr7\Response

sendContextAsync(\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext $context) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates the promise to send the context.

Inherited from:

Parameters

Name	Type	Description
$context	\MicrosoftAzure\Storage\Common\Internal\Http\HttpCallContext	The context of the request.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

setDirectoryMetadata(string $share, string $path, array $metadata, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Sets a directory's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the directory.
$metadata	array	The metadata to be set.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Details

See

setDirectoryMetadataAsync(string $share, string $path, array $metadata, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set a directory's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the directory.
$metadata	array	The metadata to be set.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setFileMetadata(string $share, string $path, array $metadata, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Sets a file's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the file.
$metadata	array	The metadata to be set.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Details

See

setFileMetadataAsync(string $share, string $path, array $metadata, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set a file's metadata from the given share and path.

Parameters

Name	Type	Description
$share	string	The share name.
$path	string	The path to delete the file.
$metadata	array	The metadata to be set.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setFileProperties(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileProperties $properties, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Sets properties on the file.

Parameters

Name	Type	Description
$share	string	share name
$path	string	path of the file
$properties	\MicrosoftAzure\Storage\File\Models\FileProperties	file properties.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

setFilePropertiesAsync(string $share, string $path, \MicrosoftAzure\Storage\File\Models\FileProperties $properties, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set properties on the file.

Parameters

Name	Type	Description
$share	string	share name
$path	string	path of the file
$properties	\MicrosoftAzure\Storage\File\Models\FileProperties	file properties.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setServiceProperties(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : void

inherited

Sets the properties of the service.

Inherited from:

It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.

Parameters

Name	Type	Description
$serviceProperties	\MicrosoftAzure\Storage\Common\Models\ServiceProperties	The service properties.
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Details

See

setServicePropertiesAsync(\MicrosoftAzure\Storage\Common\Models\ServiceProperties $serviceProperties, \MicrosoftAzure\Storage\Common\Models\ServiceOptions $options = null) : \GuzzleHttp\Promise\PromiseInterface

inherited

Creates the promise to set the properties of the service.

Inherited from:

It's recommended to use getServiceProperties, alter the returned object and then use setServiceProperties with this altered object.

Parameters

Name	Type	Description
$serviceProperties	\MicrosoftAzure\Storage\Common\Models\ServiceProperties	The service properties.
$options	\MicrosoftAzure\Storage\Common\Models\ServiceOptions	The optional parameters.

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setShareAcl(string $share, \MicrosoftAzure\Storage\File\Models\ShareACL $acl, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Sets the ACL and any share-level access policies for the share.

Parameters

Name	Type	Description
$share	string	name
$acl	\MicrosoftAzure\Storage\File\Models\ShareACL	access control list for share
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

setShareAclAsync(string $share, \MicrosoftAzure\Storage\File\Models\ShareACL $acl, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set the ACL and any share-level access policies for the share.

Parameters

Name	Type	Description
$share	string	name
$acl	\MicrosoftAzure\Storage\File\Models\ShareACL	access control list for share
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setShareMetadata(string $share, array $metadata, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Updates metadata of the share.

Parameters

Name	Type	Description
$share	string	name
$metadata	array	metadata key/value pair.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

setShareMetadataAsync(string $share, array $metadata, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to update metadata headers on the share.

Parameters

Name	Type	Description
$share	string	name
$metadata	array	metadata key/value pair.
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

setShareProperties(string $share, integer $quota, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : void

Sets quota of the share.

Parameters

Name	Type	Description
$share	string	name
$quota	integer	quota of the share
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Details

See

setSharePropertiesAsync(string $share, integer $quota, \MicrosoftAzure\Storage\File\Models\FileServiceOptions | null $options = null) : \GuzzleHttp\Promise\PromiseInterface

Creates promise to set quota the share.

Parameters

Name	Type	Description
$share	string	name
$quota	integer	quota of the share
$options	\MicrosoftAzure\Storage\File\Models\FileServiceOptions \| null	optional parameters

Returns

Type	Description
\GuzzleHttp\Promise\PromiseInterface

Details

See

throwIfError(\Psr\Http\Message\ResponseInterface $response, array | integer $expected) : void

staticinherited

Throws ServiceException if the received status code is not expected.

Inherited from:

Parameters

Name	Type	Description
$response	\Psr\Http\Message\ResponseInterface	The response received
$expected	array \| integer	The expected status codes.

Throws

Exception	Description
\MicrosoftAzure\Storage\Common\Exceptions\ServiceException

azure-storage-file\src\File\FileRestProxy.php

\MicrosoftAzure\Storage\File\FileRestProxyjump to top

Properties

Methods

\MicrosoftAzure\Storage\File\FileRestProxy
jump to top