DirectoryTransferProgressSnapshot
in package
FinalYes
Table of Contents
Methods
- __construct() : mixed
- fromArray() : DirectoryTransferProgressSnapshot
- getIdentifier() : string
- getReason() : Throwable|string|null
- getResponse() : array<string|int, mixed>|null
- getTotalBytes() : int
- getTotalFiles() : int
- getTransferredBytes() : int
- getTransferredFiles() : int
- ratioTransferred() : float
- toArray() : array<string|int, mixed>
- withProgress() : DirectoryTransferProgressSnapshot
- withResponse() : DirectoryTransferProgressSnapshot
- withTotals() : DirectoryTransferProgressSnapshot
Methods
__construct()
public
__construct(string $identifier, int $transferredBytes, int $totalBytes, int $transferredFiles, int $totalFiles[, array<string|int, mixed>|null $response = null ][, Throwable|string|null $reason = null ]) : mixed
Parameters
- $identifier : string
- $transferredBytes : int
- $totalBytes : int
- $transferredFiles : int
- $totalFiles : int
- $response : array<string|int, mixed>|null = null
- $reason : Throwable|string|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : DirectoryTransferProgressSnapshot
Parameters
- $data : array<string|int, mixed>
Return values
DirectoryTransferProgressSnapshotgetIdentifier()
public
getIdentifier() : string
Return values
stringgetReason()
public
getReason() : Throwable|string|null
Return values
Throwable|string|nullgetResponse()
public
getResponse() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetTotalBytes()
public
getTotalBytes() : int
Return values
intgetTotalFiles()
public
getTotalFiles() : int
Return values
intgetTransferredBytes()
public
getTransferredBytes() : int
Return values
intgetTransferredFiles()
public
getTransferredFiles() : int
Return values
intratioTransferred()
public
ratioTransferred() : float
Return values
floattoArray()
public
toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>withProgress()
public
withProgress(int $transferredBytes, int $transferredFiles) : DirectoryTransferProgressSnapshot
Parameters
- $transferredBytes : int
- $transferredFiles : int
Return values
DirectoryTransferProgressSnapshotwithResponse()
public
withResponse(array<string|int, mixed> $response) : DirectoryTransferProgressSnapshot
Parameters
- $response : array<string|int, mixed>
Return values
DirectoryTransferProgressSnapshotwithTotals()
public
withTotals(int $totalBytes, int $totalFiles) : DirectoryTransferProgressSnapshot
Parameters
- $totalBytes : int
- $totalFiles : int