Flow PHP

Options

FinalYes
Tags
type

AzureOptions = array{block_location: string, block_permissions: null|PermissionsShape, block_size: int, file_fast_path: bool, list_blob_include: null|list, list_blob_max_results: null|int, list_blob_show_only: null|string, tmp_dir: PathData}

import-type

PathData from Path

PermissionsShape from Permissions

Methods

__construct()  : mixed
blockFactory()  : BlockFactory
blockSize()  : int<1, max>
fileFastPath()  : bool
fromArray()  : self
listBlobOptions()  : ListBlobOptions
normalize()  : null|AzureOptions
tmpDir()  : Path
withBlockFactory()  : self
withBlockSize()  : self
withFileFastPath()  : self
When enabled (default), list() on a single-file path will first attempt getBlobProperties on the blob.
withListBlobInclude()  : self
withListBlobMaxResults()  : self
withListBlobShowOnly()  : self
withTmpDir()  : self

Methods

__construct()

public __construct() : mixed

blockFactory()

public blockFactory() : BlockFactory
Return values
BlockFactory

blockSize()

public blockSize() : int<1, max>
Return values
int<1, max>

fileFastPath()

public fileFastPath() : bool
Return values
bool

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>

the shape of normalize()

Tags
throws
InvalidArgumentException
Return values
self

listBlobOptions()

public listBlobOptions() : ListBlobOptions
Return values
ListBlobOptions

normalize()

public normalize() : null|AzureOptions
Return values
null|AzureOptions —

null when the block factory is not the native local one

tmpDir()

public tmpDir() : Path
Return values
Path

withBlockFactory()

public withBlockFactory(BlockFactory $blockFactory) : self
Parameters
$blockFactory : BlockFactory
Return values
self

withBlockSize()

public withBlockSize(int $blockSize) : self
Parameters
$blockSize : int
Return values
self

withFileFastPath()

When enabled (default), list() on a single-file path will first attempt getBlobProperties on the blob.

public withFileFastPath([bool $enabled = true ]) : self

If it exists, list() yields just that single FileStatus and never issues listBlobs. This avoids the container-list permission requirement and an extra round-trip when reading single files. Disable if your workloads typically pass folder/prefix paths to list(), to skip the (failing) properties call.

Parameters
$enabled : bool = true
Return values
self

withListBlobInclude()

public withListBlobInclude(OptionInclude ...$listBlobInclude) : self
Parameters
$listBlobInclude : OptionInclude
Return values
self

withListBlobMaxResults()

public withListBlobMaxResults(int $listBlobMaxResults) : self
Parameters
$listBlobMaxResults : int
Return values
self

withListBlobShowOnly()

public withListBlobShowOnly(OptionShowOnly $listBlobShowOnly) : self
Parameters
$listBlobShowOnly : OptionShowOnly
Return values
self

withTmpDir()

public withTmpDir(Path $tmpDir) : self
Parameters
$tmpDir : Path
Return values
self
On this page

Search results