1. class
  2. Hypervel
  3. \
  4. Process
  5. \
  6. InvokedProcess

InvokedProcess

class InvokedProcess implements InvokedProcess

Traits

GuardsProcessOutput
Macroable

Properties

static protected array $macros

The registered string macros.

 from  Macroable

Methods

Closure|null
guardProcessOutput(Process $process, callable|null $output)

Stop the process if its output callback fails.

from  GuardsProcessOutput
static void
macro(string $name, callable|object $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Check if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
__construct(Process $process)

Create a new invoked process instance.

int|null
id()

Get the process ID if the process is still running.

string
command()

Get the command line for the process.

InvokedProcess
signal(int $signal)

Send a signal to the process.

int|null
stop(float $timeout = 10, int|null $signal = null)

Stop the process if it is still running.

bool
running()

Determine if the process is still running.

string
output()

Get the standard output for the process.

string
errorOutput()

Get the error output for the process.

string
latestOutput()

Get the latest standard output for the process.

string
latestErrorOutput()

Get the latest error output for the process.

void
ensureNotTimedOut()

Ensure that the process has not timed out.

ProcessResult
wait(callable|null $output = null)

Wait for the process to finish.

ProcessResult
waitUntil(callable|null $output = null)

Wait until the given callback returns true.

static void
flushState()

Flush all static state.

Details

in GuardsProcessOutput at line 17
protected Closure|null guardProcessOutput(Process $process, callable|null $output)

Stop the process if its output callback fails.

Parameters

Process $process
callable|null $output

Return Value

Closure|null

in Macroable at line 30
static void macro(string $name, callable|object $macro)

Register a custom macro.

Macros persist in a static property for the worker lifetime and apply to every subsequent call on the macroable class.

Parameters

string $name
callable|object $macro

Return Value

void

in Macroable at line 44
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Delegates to macro() for each method; registered macros persist in a static property for the worker lifetime.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 61
static bool hasMacro(string $name)

Check if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Clears worker-wide macros; concurrent coroutines may resolve different methods depending on timing.

Return Value

void

in Macroable at line 83
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 108
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line 28
__construct(Process $process)

Create a new invoked process instance.

Parameters

Process $process

the underlying process instance

at line 35
int|null id()

Get the process ID if the process is still running.

Return Value

int|null

at line 43
string command()

Get the command line for the process.

Return Value

string

at line 53
InvokedProcess signal(int $signal)

Send a signal to the process.

Parameters

int $signal

Return Value

InvokedProcess

at line 63
int|null stop(float $timeout = 10, int|null $signal = null)

Stop the process if it is still running.

Parameters

float $timeout
int|null $signal

Return Value

int|null

at line 86
bool running()

Determine if the process is still running.

Return Value

bool

at line 94
string output()

Get the standard output for the process.

Return Value

string

at line 102
string errorOutput()

Get the error output for the process.

Return Value

string

at line 110
string latestOutput()

Get the latest standard output for the process.

Return Value

string

at line 118
string latestErrorOutput()

Get the latest error output for the process.

Return Value

string

at line 128
void ensureNotTimedOut()

Ensure that the process has not timed out.

Return Value

void

Exceptions

ProcessTimedOutException

at line 142
ProcessResult wait(callable|null $output = null)

Wait for the process to finish.

Parameters

callable|null $output

Return Value

ProcessResult

Exceptions

ProcessTimedOutException

at line 160
ProcessResult waitUntil(callable|null $output = null)

Wait until the given callback returns true.

Parameters

callable|null $output

Return Value

ProcessResult

Exceptions

ProcessTimedOutException

at line 180
static void flushState()

Flush all static state.

Return Value

void