Flow PHP

Options

FinalYes
Tags
type

S3Options = array{block_location: string, block_permissions: null|PermissionsShape, file_fast_path: bool, part_size: int}

import-type

PermissionsShape from Permissions

Methods

__construct()  : mixed
blockFactory()  : BlockFactory
fileFastPath()  : bool
fromArray()  : self
normalize()  : null|S3Options
partSize()  : int<1, max>
tmpDir()  : Path
withBlockFactory()  : self
withBlockSize()  : self
withFileFastPath()  : self
When enabled (default), list() on a single-file path will first attempt a HEAD on the object.

Methods

__construct()

public __construct() : mixed

blockFactory()

public blockFactory() : BlockFactory
Return values
BlockFactory

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

normalize()

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

null when the block factory is not the native local one

partSize()

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

tmpDir()

public tmpDir() : Path
Return values
Path

withBlockFactory()

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

withBlockSize()

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

withFileFastPath()

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

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

If the object exists, list() yields just that single FileStatus and never issues listObjectsV2. This avoids the s3:ListBucket 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) HEAD.

Parameters
$enabled : bool = true
Return values
self
On this page

Search results