class ScanFileDriver extends AbstractDriver

Properties

protected Channel|null $stopSignal from  AbstractDriver
protected bool $stopping from  AbstractDriver
protected Filesystem $filesystem
protected null|array<string, string> $lastFileHashes

Methods

__construct(Option $option, StdoutLoggerInterface $logger, Filesystem|null $filesystem = null)

No description

bool
isDarwin()

Determine if the current OS is macOS.

void
stop()

Stop the active watch lifecycle.

bool
isStopping()

Determine whether the driver has been stopped.

void
watchAtInterval(float $seconds, callable $scan)

Run a polling scan until the driver is stopped.

array
resolveTargets(array $watchPaths)

Resolve configured watch paths to absolute targets.

array
groupWatchPathsByTarget(array $watchPaths)

Group watch paths by their resolved target.

array
existingTargets(array $targets)

Filter targets that currently exist.

array
exec(string $command)

Execute a shell command using Swoole's coroutine-aware exec.

string
shellArguments(array $arguments)

Escape a list of arguments for interpolation into a shell command.

void
watch(Channel $channel)

Watch for file changes by polling file hashes.

void
processFileHashes(Channel $channel, array $currentFileHashes)

Process a new file hash snapshot.

array
getWatchFileHashes()

Compute hashes for all watched files.

string|null
hashFile(string $path)

Hash a watched file.

Details

at line 22
__construct(Option $option, StdoutLoggerInterface $logger, Filesystem|null $filesystem = null)

No description

Parameters

Option $option
StdoutLoggerInterface $logger
Filesystem|null $filesystem

in AbstractDriver at line 26
bool isDarwin()

Determine if the current OS is macOS.

Return Value

bool

in AbstractDriver at line 34
void stop()

Stop the active watch lifecycle.

Return Value

void

in AbstractDriver at line 51
protected bool isStopping()

Determine whether the driver has been stopped.

The state may change while hooked I/O yields to another coroutine.

Return Value

bool

in AbstractDriver at line 59
protected void watchAtInterval(float $seconds, callable $scan)

Run a polling scan until the driver is stopped.

Parameters

float $seconds
callable $scan

Return Value

void

in AbstractDriver at line 96
protected array resolveTargets(array $watchPaths)

Resolve configured watch paths to absolute targets.

Parameters

array $watchPaths

Return Value

array

in AbstractDriver at line 116
protected array groupWatchPathsByTarget(array $watchPaths)

Group watch paths by their resolved target.

Parameters

array $watchPaths

Return Value

array

in AbstractDriver at line 137
protected array existingTargets(array $targets)

Filter targets that currently exist.

Parameters

array $targets

Return Value

array

in AbstractDriver at line 149
protected array exec(string $command)

Execute a shell command using Swoole's coroutine-aware exec.

Every interpolated argument must be escaped before it reaches this boundary.

Parameters

string $command

Return Value

array

in AbstractDriver at line 165
protected string shellArguments(array $arguments)

Escape a list of arguments for interpolation into a shell command.

Parameters

array $arguments

Return Value

string

at line 35
void watch(Channel $channel)

Watch for file changes by polling file hashes.

Parameters

Channel $channel

Return Value

void

at line 47
protected void processFileHashes(Channel $channel, array $currentFileHashes)

Process a new file hash snapshot.

Parameters

Channel $channel
array $currentFileHashes

Return Value

void

at line 92
protected array getWatchFileHashes()

Compute hashes for all watched files.

Return Value

array

at line 159
protected string|null hashFile(string $path)

Hash a watched file.

Parameters

string $path

Return Value

string|null