1. class
  2. Hypervel
  3. \
  4. Support
  5. \
  6. Facades
  7. \
  8. Process

Process

class Process extends Facade

Properties

static protected Container|null $app

The application instance being facaded.

 from  Facade
static protected array $resolvedInstance

The resolved object instances.

 from  Facade
static protected bool $cached

Indicates if the resolved instance should be cached.

 from  Facade

Methods

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static Factory
fake(array|Closure|null $callback = null)

Indicate that the process factory should fake processes.

static PendingProcess
command(array|string $command)

No description

static PendingProcess
env(array<string $, Stringable> $environment)

No description

static PendingProcess
forever()

No description

static PendingProcess
idleTimeout(CarbonInterval|int $timeout)

No description

static PendingProcess
input(Traversable $input)

No description

static PendingProcess
options(array<string $, mixed> $options)

No description

static PendingProcess
path(string $path)

No description

static PendingProcess
quietly()

No description

static ProcessResult
run(array|string|null $command = 'null', callable|null $output = 'null')

No description

static InvokedProcess
start(array|string|null $command = 'null', callable|null $output = 'null')

No description

static bool
supportsTty()

No description

static PendingProcess
timeout(CarbonInterval|int $timeout)

No description

static PendingProcess
tty(bool $tty = 'true')

No description

static mixed
unless(mixed $value = 'null', null|callable $callback = 'null', null|callable $default = 'null')

No description

static mixed
when(mixed $value = 'null', null|callable $callback = 'null', null|callable $default = 'null')

No description

static PendingProcess
withFakeHandlers(array<string $, callable> $fakeHandlers)

No description

static Factory
assertDidntRun(array<array-key $, Closure|string $callback)

No description

static Factory
assertNothingRan()

No description

static Factory
assertNotRan(array<array-key $, Closure|string $callback)

No description

static Factory
assertRan(array<array-key $, Closure|string $callback)

No description

static Factory
assertRanInOrder(array<array-key $, Closure|string> $callbacks)

No description

static Factory
assertRanTimes(array<array-key $, Closure|string $callback, int $times = '1')

No description

static ProcessPoolResults
concurrently(callable $callback, callable|null $output = 'null')

No description

static FakeProcessDescription
describe()

No description

static void
flushMacros()

No description

static void
flushState()

No description

static bool
hasMacro(string $name)

No description

static bool
isRecording()

No description

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

No description

static mixed
macroCall(string $method, array $parameters)

No description

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

No description

static PendingProcess
newPendingProcess()

No description

static ProcessResult
pipe(callable|array $callback, callable|null $output = 'null')

No description

static Pool
pool(callable $callback)

No description

static bool
preventingStrayProcesses()

No description

static Factory
preventStrayProcesses(bool $prevent = 'true')

No description

static Factory
record(PendingProcess $process, ProcessResult $result)

No description

static Factory
recordIfRecording(PendingProcess $process, ProcessResult $result)

No description

static FakeProcessResult
result(array|string $output = '\'\'', array|string $errorOutput = '\'\'', int $exitCode = '0')

No description

static FakeProcessSequence
sequence(array<int $, ProcessResult|string> $processes = '[]')

No description

Details

in Facade at line 61
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 81
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 99
static MockInterface partialMock()

Initiate a partial mock on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Tests only. Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

in Facade at line 178
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 194
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 206
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 60
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 233
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 256
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.

Parameters

string|null $name

Return Value

void

in Facade at line 267
static void clearResolvedInstances()

Clear all of the resolved instances.

Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.

Return Value

void

in Facade at line 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 346
static void setFacadeApplication(Container|null $app)

Set the application instance.

Boot or tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 356
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 70
static Factory fake(array|Closure|null $callback = null)

Indicate that the process factory should fake processes.

Tests only. Fake handlers and recordings persist on the container-resolved factory for the worker lifetime and affect later calls.

Parameters

array|Closure|null $callback

Return Value

Factory

at line 55
static PendingProcess command(array|string $command)

No description

Parameters

array|string $command

Return Value

PendingProcess

at line 55
static PendingProcess env(array<string $, Stringable> $environment)

No description

Parameters

array<string $
Stringable> $environment

Return Value

PendingProcess

at line 55
static PendingProcess forever()

No description

Return Value

PendingProcess

at line 55
static PendingProcess idleTimeout(CarbonInterval|int $timeout)

No description

Parameters

CarbonInterval|int $timeout

Return Value

PendingProcess

at line 55
static PendingProcess input(Traversable $input)

No description

Parameters

Traversable $input

Return Value

PendingProcess

at line 55
static PendingProcess options(array<string $, mixed> $options)

No description

Parameters

array<string $
mixed> $options

Return Value

PendingProcess

at line 55
static PendingProcess path(string $path)

No description

Parameters

string $path

Return Value

PendingProcess

at line 55
static PendingProcess quietly()

No description

Return Value

PendingProcess

at line 55
static ProcessResult run(array|string|null $command = 'null', callable|null $output = 'null')

No description

Parameters

array|string|null $command
callable|null $output

Return Value

ProcessResult

at line 55
static InvokedProcess start(array|string|null $command = 'null', callable|null $output = 'null')

No description

Parameters

array|string|null $command
callable|null $output

Return Value

InvokedProcess

at line 55
static bool supportsTty()

No description

Return Value

bool

at line 55
static PendingProcess timeout(CarbonInterval|int $timeout)

No description

Parameters

CarbonInterval|int $timeout

Return Value

PendingProcess

at line 55
static PendingProcess tty(bool $tty = 'true')

No description

Parameters

bool $tty

Return Value

PendingProcess

at line 55
static mixed unless(mixed $value = 'null', null|callable $callback = 'null', null|callable $default = 'null')

No description

Parameters

mixed $value
null|callable $callback
null|callable $default

Return Value

mixed

at line 55
static mixed when(mixed $value = 'null', null|callable $callback = 'null', null|callable $default = 'null')

No description

Parameters

mixed $value
null|callable $callback
null|callable $default

Return Value

mixed

at line 55
static PendingProcess withFakeHandlers(array<string $, callable> $fakeHandlers)

No description

Parameters

array<string $
callable> $fakeHandlers

Return Value

PendingProcess

at line 55
static Factory assertDidntRun(array<array-key $, Closure|string $callback)

No description

Parameters

array<array-key $
Closure|string $callback

Return Value

Factory

at line 55
static Factory assertNothingRan()

No description

Return Value

Factory

at line 55
static Factory assertNotRan(array<array-key $, Closure|string $callback)

No description

Parameters

array<array-key $
Closure|string $callback

Return Value

Factory

at line 55
static Factory assertRan(array<array-key $, Closure|string $callback)

No description

Parameters

array<array-key $
Closure|string $callback

Return Value

Factory

at line 55
static Factory assertRanInOrder(array<array-key $, Closure|string> $callbacks)

No description

Parameters

array<array-key $
Closure|string> $callbacks

Return Value

Factory

at line 55
static Factory assertRanTimes(array<array-key $, Closure|string $callback, int $times = '1')

No description

Parameters

array<array-key $
Closure|string $callback
int $times

Return Value

Factory

at line 55
static ProcessPoolResults concurrently(callable $callback, callable|null $output = 'null')

No description

Parameters

callable $callback
callable|null $output

Return Value

ProcessPoolResults

at line 55
static FakeProcessDescription describe()

No description

Return Value

FakeProcessDescription

at line 55
static void flushMacros()

No description

Return Value

void

at line 55
static void flushState()

No description

Return Value

void

at line 55
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 55
static bool isRecording()

No description

Return Value

bool

at line 55
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 55
static mixed macroCall(string $method, array $parameters)

No description

Parameters

string $method
array $parameters

Return Value

mixed

at line 55
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 55
static PendingProcess newPendingProcess()

No description

Return Value

PendingProcess

at line 55
static ProcessResult pipe(callable|array $callback, callable|null $output = 'null')

No description

Parameters

callable|array $callback
callable|null $output

Return Value

ProcessResult

at line 55
static Pool pool(callable $callback)

No description

Parameters

callable $callback

Return Value

Pool

at line 55
static bool preventingStrayProcesses()

No description

Return Value

bool

at line 55
static Factory preventStrayProcesses(bool $prevent = 'true')

No description

Parameters

bool $prevent

Return Value

Factory

at line 55
static Factory record(PendingProcess $process, ProcessResult $result)

No description

Parameters

PendingProcess $process
ProcessResult $result

Return Value

Factory

at line 55
static Factory recordIfRecording(PendingProcess $process, ProcessResult $result)

No description

Parameters

PendingProcess $process
ProcessResult $result

Return Value

Factory

at line 55
static FakeProcessResult result(array|string $output = '\'\'', array|string $errorOutput = '\'\'', int $exitCode = '0')

No description

Parameters

array|string $output
array|string $errorOutput
int $exitCode

Return Value

FakeProcessResult

at line 55
static FakeProcessSequence sequence(array<int $, ProcessResult|string> $processes = '[]')

No description

Parameters

array<int $
ProcessResult|string> $processes

Return Value

FakeProcessSequence