Documentation

ProcessHelper extends Helper
in package

The ProcessHelper class provides helpers to run external processes.

Tags
author

Fabien Potencier fabien@symfony.com

final

Table of Contents

$helperSet  : mixed
formatMemory()  : mixed
formatTime()  : mixed
getHelperSet()  : HelperSet
Gets the helper set associated with this helper.
getName()  : string
{@inheritdoc}
length()  : int
Returns the length of a string, using mb_strlen if it is available.
mustRun()  : Process
Runs the process.
removeDecoration()  : mixed
run()  : Process
Runs an external process.
setHelperSet()  : mixed
Sets the helper set associated with this helper.
strlen()  : int
Returns the length of a string, using mb_strwidth if it is available.
strlenWithoutDecoration()  : mixed
substr()  : string
Returns the subset of a string, using mb_substr if it is available.
width()  : int
Returns the width of a string, using mb_strwidth if it is available.
wrapCallback()  : callable
Wraps a Process callback to add debugging output.
escapeString()  : string

Properties

$helperSet

protected mixed $helperSet = null

Methods

formatMemory()

public static formatMemory(int $memory) : mixed
Parameters
$memory : int
Return values
mixed

formatTime()

public static formatTime(mixed $secs) : mixed
Parameters
$secs : mixed
Return values
mixed

getHelperSet()

Gets the helper set associated with this helper.

public getHelperSet() : HelperSet
Return values
HelperSet

A HelperSet instance

getName()

{@inheritdoc}

public getName() : string
Return values
string

length()

Returns the length of a string, using mb_strlen if it is available.

public static length(string|null $string) : int

The length is related to how many bytes the string will use.

Parameters
$string : string|null
Return values
int

mustRun()

Runs the process.

public mustRun(OutputInterface $output, string|Process $cmd[, string $error = null ][, callable|null $callback = null ]) : Process

This is identical to run() except that an exception is thrown if the process exits with a non-zero exit code.

Parameters
$output : OutputInterface
$cmd : string|Process

An instance of Process or a command to run

$error : string = null
$callback : callable|null = null

A PHP callback to run whenever there is some output available on STDOUT or STDERR

Tags
throws
ProcessFailedException
see
run()
Return values
Process

The process that ran

run()

Runs an external process.

public run(OutputInterface $output, array<string|int, mixed>|Process $cmd[, string $error = null ][, callable|null $callback = null ][, int $verbosity = OutputInterface::VERBOSITY_VERY_VERBOSE ]) : Process
Parameters
$output : OutputInterface
$cmd : array<string|int, mixed>|Process

An instance of Process or an array of the command and arguments

$error : string = null
$callback : callable|null = null

A PHP callback to run whenever there is some output available on STDOUT or STDERR

$verbosity : int = OutputInterface::VERBOSITY_VERY_VERBOSE
Return values
Process

The process that ran

setHelperSet()

Sets the helper set associated with this helper.

public setHelperSet([HelperSet $helperSet = null ]) : mixed
Parameters
$helperSet : HelperSet = null
Return values
mixed

strlen()

Returns the length of a string, using mb_strwidth if it is available.

public static strlen(string|null $string) : int
Parameters
$string : string|null
Tags
deprecated

since 5.3

Return values
int

The length of the string

substr()

Returns the subset of a string, using mb_substr if it is available.

public static substr(string|null $string, int $from[, int $length = null ]) : string
Parameters
$string : string|null
$from : int
$length : int = null
Return values
string

The string subset

width()

Returns the width of a string, using mb_strwidth if it is available.

public static width(string|null $string) : int

The width is how many characters positions the string will use.

Parameters
$string : string|null
Return values
int

wrapCallback()

Wraps a Process callback to add debugging output.

public wrapCallback(OutputInterface $output, Process $process[, callable $callback = null ]) : callable
Parameters
$output : OutputInterface
$process : Process
$callback : callable = null
Return values
callable

escapeString()

private escapeString(string $str) : string
Parameters
$str : string
Return values
string

Search results