Flow PHP

Options

FinalYes
Tags
type

SFTPOptions = array{block_location: string, block_permissions: null|PermissionsShape, block_size: int, read_chunk_size: int, tmp_dir: PathData}

import-type

PermissionsShape from Permissions

PathData from Path

Constants

DEFAULT_BLOCK_SIZE  : int = 16 * \Flow\Filesystem\SizeUnits::MiB_SIZE
DEFAULT_READ_CHUNK_SIZE  : int = \Flow\Filesystem\SizeUnits::MiB_SIZE

Methods

__construct()  : mixed
blockFactory()  : BlockFactory
blockSize()  : int<1, max>
fromArray()  : self
normalize()  : null|SFTPOptions
readChunkSize()  : int<1, max>
tmpDir()  : Path
withBlockFactory()  : self
withBlockSize()  : self
withReadChunkSize()  : self
withTmpDir()  : self

Constants

DEFAULT_BLOCK_SIZE

public int DEFAULT_BLOCK_SIZE = 16 * \Flow\Filesystem\SizeUnits::MiB_SIZE

DEFAULT_READ_CHUNK_SIZE

public int DEFAULT_READ_CHUNK_SIZE = \Flow\Filesystem\SizeUnits::MiB_SIZE

Methods

__construct()

public __construct() : mixed

blockFactory()

public blockFactory() : BlockFactory
Return values
BlockFactory

blockSize()

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

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|SFTPOptions
Return values
null|SFTPOptions —

null when the block factory is not the native local one

readChunkSize()

public readChunkSize() : 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

withReadChunkSize()

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

withTmpDir()

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

Search results