Class \Prado\Util\Helpers\TProcessHelper

TProcessHelper class.

This class handles process related functions.

self::isSystemWindows() is used to determine if the PHP system is Windows or not.

self::isForkable() can be used if the system supports forking of the current process. self::fork() is used to fork the current process, where supported. When forking, fxPrepareForFork self::FX_PREPARE_FOR_FORK is raised before forking and fxRestoreAfterFork self::FX_RESTORE_AFTER_FORK is raised after forking. When $captureForkLog (fork parameter) is true, a TCaptureForkLog behavior is attached to the TApplication object. All forked child processes ensure the TSignalsDispatcher behavior is attached to the TApplication object to allow for graceful termination on exiting signals.

When filtering commands for popen and proc_open, self::filterCommand() will replace '@php' with PHP_BINARY and wrap Windows commands with double quotes. Individual arguments can be properly shell escaped with self::escapeShellArg().

Linux Process signals can be sent with self::sendSignal() to the current pid or child pid. To kill a child pid, call self::kill(). self::isRunning can determine if a child process is still running.

System Process priority can be retrieved and set with self::getProcessPriority() and self::setProcessPriority(), respectively.

Class hierarchy

\Prado\Util\Helpers\TProcessHelper

Author: Brad Anderson <belisoful@icloud.com>
Since: 4.3.0

Methods summary
`public static`	`escapeShellArg(string $argument) : string` Escapes a string to be used as a shell argument.
`public static`	`exitStatus(int $exitCode) : int` If the exitCode is an exit code, returns the exit Status.
`public static`	`filterCommand(mixed $command) : mixed` Filters a {@see popen} or {@see proc_open} command. The string "@php" is replaced by PHP_BINARY and in Windows the string is surrounded by double quotes.
`public static`	`fork([bool $captureForkLog = false ]) : int` This forks the current process. When specified, it will install a {@see \Prado\Util\Behaviors\TCaptureForkLog}. Before forking, `fxPrepareForFork` is raised and after forking `fxRestoreAfterFork` is raised. `fxPrepareForFork` handlers should return null or an array of data that it will receive in `fxRestoreAfterFork`. `public function fxPrepareForFork ($sender, $param) { return ['mydata' => 'value']; } public function fxRestoreAfterFork ($sender, $param) { $param['mydata'] === 'value'; $param['pid']; }`
`public static`	`getProcessPriority([int\|null $pid = null ]) : int\|null`
`public static`	`isForkable() : bool`
`public static`	`isRunning(int $pid) : bool`
`public static`	`isSurroundedBy(string $string, string $prefix) : bool` Is the string surrounded by the prefix and reversed in appendix.
`public static`	`isSystemLinux() : bool` Checks if the system that PHP is run on is Linux.
`public static`	`isSystemMacOS() : bool` Checks if the system that PHP is run on is MacOS (Darwin).
`public static`	`isSystemWindows() : bool` Checks if the system that PHP is run on is Windows.
`public static`	`kill(int $pid) : bool` Kills a process.
`public static`	`sendSignal(int $signal[, int\|null $pid = null ]) : bool` Sends a process signal on posix or linux systems.
`public static`	`setProcessPriority(int $priority[, int\|null $pid = null ]) : bool` In linux systems, the priority can only go up (and have less priority).

Inherited methods

Constants summary
`public string`	`FX_PREPARE_FOR_FORK`	`'fxPrepareForFork'`
`public string`	`FX_RESTORE_AFTER_FORK`	`'fxRestoreAfterFork'`
`public string`	`PHP_COMMAND`	`"@php"`
`public mixed`	`WINDOWS_ABOVE_NORMAL_PRIORITY`	`-5`
`public mixed`	`WINDOWS_BELOW_NORMAL_PRIORITY`	`8`
`public mixed`	`WINDOWS_HIGH_PRIORITY`	`-10`
`public mixed`	`WINDOWS_IDLE_PRIORITY` Linux priority is -20 (for "real time") to 19 (for idle).	`19`
`public mixed`	`WINDOWS_NORMAL_PRIORITY`	`0`
`public mixed`	`WINDOWS_REALTIME_PRIORITY`	`-17`

Classes

Interfaces

Traits

Search results

Class \Prado\Util\Helpers\TProcessHelper

Class hierarchy