Process

class Process extends Facade (View source)

Properties

static protected Application	$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

spy()

Convert the facade into a Mockery spy.

from Facade

static MockInterface

partialMock()

Initiate a partial mock on the facade.

from Facade

static Expectation

shouldReceive()

Initiate a mock expectation on the facade.

from Facade

static Expectation

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 $name)

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 Application

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $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(Closure|array $callback = null)

Indicate that the process factory should fake processes.

static PendingProcess

command(array|string $command)

No description

static PendingProcess

path(string $path)

No description

static PendingProcess

timeout(int $timeout)

No description

static PendingProcess

idleTimeout(int $timeout)

No description

static PendingProcess

forever()

No description

static PendingProcess

env(array $environment)

No description

static PendingProcess

No description

static PendingProcess

quietly()

No description

static PendingProcess

tty(bool $tty = true)

No description

static PendingProcess

options(array $options)

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 $output = null)

No description

static PendingProcess

withFakeHandlers(array $fakeHandlers)

No description

static PendingProcess|mixed

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

No description

static PendingProcess|mixed

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

No description

static FakeProcessResult

result(array|string $output = '', array|string $errorOutput = '', int $exitCode)

No description

static FakeProcessDescription

describe()

No description

static FakeProcessSequence

sequence(array $processes = [])

No description

static bool

isRecording()

No description

static Factory

recordIfRecording(PendingProcess $process, ProcessResult $result)

No description

static Factory

record(PendingProcess $process, ProcessResult $result)

No description

static Factory

preventStrayProcesses(bool $prevent = true)

No description

static bool

preventingStrayProcesses()

No description

static Factory

assertRan(Closure|string $callback)

No description

static Factory

assertRanTimes(Closure|string $callback, int $times = 1)

No description

static Factory

assertNotRan(Closure|string $callback)

No description

static Factory

assertDidntRun(Closure|string $callback)

No description

static Factory

assertNothingRan()

No description

static Pool

pool(callable $callback)

No description

static ProcessResult

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

No description

static ProcessPoolResults

concurrently(callable $callback, callable|null $output = null)

No description

static PendingProcess

newPendingProcess()

No description

static void

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

No description

static void

mixin(object $mixin, bool $replace = true)

No description

static bool

hasMacro(string $name)

No description

static void

flushMacros()

No description

static mixed

macroCall(string $method, array $parameters)

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure

$callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

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

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed

$instance

Return Value

void

static protected bool isFake()

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

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string

$name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string

$name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$app

Return Value

void

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

Handle dynamic, static calls to the object.

Parameters

string	$method
array	$args

Return Value

mixed

Exceptions

RuntimeException

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

Indicate that the process factory should fake processes.

Parameters

Closure|array

$callback

Return Value

Factory

static PendingProcess command(array|string $command)

No description

Parameters

array|string

$command

Return Value

PendingProcess

static PendingProcess path(string $path)

No description

Parameters

string

$path

Return Value

PendingProcess

static PendingProcess timeout(int $timeout)

No description

Parameters

int

$timeout

Return Value

PendingProcess

static PendingProcess idleTimeout(int $timeout)

No description

Parameters

int

$timeout

Return Value

PendingProcess

static PendingProcess forever()

No description

Return Value

PendingProcess

static PendingProcess env(array $environment)

No description

Parameters

array

$environment

Return Value

PendingProcess

static PendingProcess input(Traversable|resource|string|int|float|bool|null $input)

No description

Parameters

$input

Return Value

PendingProcess

static PendingProcess quietly()

No description

Return Value

PendingProcess

static PendingProcess tty(bool $tty = true)

No description

Parameters

bool

$tty

Return Value

PendingProcess

static PendingProcess options(array $options)

No description

Parameters

array

$options

Return Value

PendingProcess

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

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

No description

Parameters

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

Return Value

InvokedProcess

static PendingProcess withFakeHandlers(array $fakeHandlers)

No description

Parameters

array

$fakeHandlers

Return Value

PendingProcess

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

No description

Parameters

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

Return Value

PendingProcess|mixed

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

No description

Parameters

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

Return Value

PendingProcess|mixed

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

No description

Parameters

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

Return Value

FakeProcessResult

static FakeProcessDescription describe()

No description

Return Value

FakeProcessDescription

static FakeProcessSequence sequence(array $processes = [])

No description

Parameters

array

$processes

Return Value

FakeProcessSequence

static bool isRecording()

No description

Return Value

bool

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

No description

Parameters

PendingProcess	$process
ProcessResult	$result

Return Value

Factory

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

No description

Parameters

PendingProcess	$process
ProcessResult	$result

Return Value

Factory

static Factory preventStrayProcesses(bool $prevent = true)

No description

Parameters

bool

$prevent

Return Value

Factory

static bool preventingStrayProcesses()

No description

Return Value

bool

static Factory assertRan(Closure|string $callback)

No description

Parameters

Closure|string

$callback

Return Value

Factory

static Factory assertRanTimes(Closure|string $callback, int $times = 1)

No description

Parameters

Closure\|string	$callback
int	$times

Return Value

Factory

static Factory assertNotRan(Closure|string $callback)

No description

Parameters

Closure|string

$callback

Return Value

Factory

static Factory assertDidntRun(Closure|string $callback)

No description

Parameters

Closure|string

$callback

Return Value

Factory

static Factory assertNothingRan()

No description

Return Value

Factory

static Pool pool(callable $callback)

No description

Parameters

callable

$callback

Return Value

Pool

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

No description

Parameters

callable\|array	$callback
callable\|null	$output

Return Value

ProcessResult

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

No description

Parameters

callable	$callback
callable\|null	$output

Return Value

ProcessPoolResults

static PendingProcess newPendingProcess()

No description

Return Value

PendingProcess

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

No description

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

No description

Parameters

object	$mixin
bool	$replace

Return Value

void

static bool hasMacro(string $name)

No description

Parameters

string

$name

Return Value

bool

static void flushMacros()

No description

Return Value

void

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

No description

Parameters

string	$method
array	$parameters

Return Value

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Process.html