Process is a thin wrapper around proc_* functions to easily start independent PHP processes. More...

Inheritance diagram for Symfony\Component\Process\Process:

Collaboration diagram for Symfony\Component\Process\Process:

Public Member Functions
	__construct ($commandline, $cwd=null, array $env=null, $input=null, $timeout=60, array $options=array())
	Constructor. More...

	__destruct ()

	__clone ()

	run ($callback=null)
	Runs the process. More...

	mustRun (callable $callback=null)
	Runs the process. More...

	start (callable $callback=null)
	Starts the process and returns after writing the input to STDIN. More...

	restart (callable $callback=null)
	Restarts the process. More...

	wait (callable $callback=null)
	Waits for the process to terminate. More...

	getPid ()
	Returns the Pid (process identifier), if applicable. More...

	signal ($signal)
	Sends a POSIX signal to the process. More...

	disableOutput ()
	Disables fetching output and error output from the underlying process. More...

	enableOutput ()
	Enables fetching output and error output from the underlying process. More...

	isOutputDisabled ()
	Returns true in case the output is disabled, false otherwise. More...

	getOutput ()
	Returns the current output of the process (STDOUT). More...

	getIncrementalOutput ()
	Returns the output incrementally. More...

	getIterator ($flags=0)
	Returns an iterator to the output of the process, with the output type as keys (Process::OUT/ERR). More...

	clearOutput ()
	Clears the process output. More...

	getErrorOutput ()
	Returns the current error output of the process (STDERR). More...

	getIncrementalErrorOutput ()
	Returns the errorOutput incrementally. More...

	clearErrorOutput ()
	Clears the process output. More...

	getExitCode ()
	Returns the exit code returned by the process. More...

	getExitCodeText ()
	Returns a string representation for the exit code returned by the process. More...

	isSuccessful ()
	Checks if the process ended successfully. More...

	hasBeenSignaled ()
	Returns true if the child process has been terminated by an uncaught signal. More...

	getTermSignal ()
	Returns the number of the signal that caused the child process to terminate its execution. More...

	hasBeenStopped ()
	Returns true if the child process has been stopped by a signal. More...

	getStopSignal ()
	Returns the number of the signal that caused the child process to stop its execution. More...

	isRunning ()
	Checks if the process is currently running. More...

	isStarted ()
	Checks if the process has been started with no regard to the current state. More...

	isTerminated ()
	Checks if the process is terminated. More...

	getStatus ()
	Gets the process status. More...

	stop ($timeout=10, $signal=null)
	Stops the process. More...

	addOutput ($line)
	Adds a line to the STDOUT stream. More...

	addErrorOutput ($line)
	Adds a line to the STDERR stream. More...

	getCommandLine ()
	Gets the command line to be executed. More...

	setCommandLine ($commandline)
	Sets the command line to be executed. More...

	getTimeout ()
	Gets the process timeout (max. More...

	getIdleTimeout ()
	Gets the process idle timeout (max. More...

	setTimeout ($timeout)
	Sets the process timeout (max. More...

	setIdleTimeout ($timeout)
	Sets the process idle timeout (max. More...

	setTty ($tty)
	Enables or disables the TTY mode. More...

	isTty ()
	Checks if the TTY mode is enabled. More...

	setPty ($bool)
	Sets PTY mode. More...

	isPty ()
	Returns PTY state. More...

	getWorkingDirectory ()
	Gets the working directory. More...

	setWorkingDirectory ($cwd)
	Sets the current working directory. More...

	getEnv ()
	Gets the environment variables. More...

	setEnv (array $env)
	Sets the environment variables. More...

	getInput ()
	Gets the Process input. More...

	setInput ($input)
	Sets the input. More...

	getOptions ()
	Gets the options for proc_open. More...

	setOptions (array $options)
	Sets the options for proc_open. More...

	getEnhanceWindowsCompatibility ()
	Gets whether or not Windows compatibility is enabled. More...

	setEnhanceWindowsCompatibility ($enhance)
	Sets whether or not Windows compatibility is enabled. More...

	getEnhanceSigchildCompatibility ()
	Returns whether sigchild compatibility mode is activated or not. More...

	setEnhanceSigchildCompatibility ($enhance)
	Activates sigchild compatibility mode. More...

	checkTimeout ()
	Performs a check between the timeout definition and the time the process started. More...

Static Public Member Functions
static	isPtySupported ()
	Returns whether PTY is supported on the current operating system. More...

Data Fields
const	ERR = 'err'

const	OUT = 'out'

const	STATUS_READY = 'ready'

const	STATUS_STARTED = 'started'

const	STATUS_TERMINATED = 'terminated'

const	STDIN = 0

const	STDOUT = 1

const	STDERR = 2

const	TIMEOUT_PRECISION = 0.2

const	ITER_NON_BLOCKING = 1

const	ITER_KEEP_OUTPUT = 2

const	ITER_SKIP_OUT = 4

const	ITER_SKIP_ERR = 8

Static Public Attributes
static	$exitCodes

Protected Member Functions
	buildCallback (callable $callback=null)
	Builds up the callback used by wait(). More...

	updateStatus ($blocking)
	Updates the status of the process, reads pipes. More...

	isSigchildEnabled ()
	Returns whether PHP has been compiled with the '–enable-sigchild' option or not. More...

Private Member Functions
	getDescriptors ()
	Creates the descriptors needed by the proc_open. More...

	readPipesForOutput ($caller, $blocking=false)
	Reads pipes for the freshest output. More...

	validateTimeout ($timeout)
	Validates and returns the filtered timeout. More...

	readPipes ($blocking, $close)
	Reads pipes, executes callback. More...

	close ()
	Closes process resource, closes file handles, sets the exitcode. More...

	resetProcessData ()
	Resets data related to the latest run of the process. More...

	doSignal ($signal, $throwException)
	Sends a POSIX signal to the process. More...

	requireProcessIsStarted ($functionName)
	Ensures the process is running or terminated, throws a LogicException if the process has a not started. More...

	requireProcessIsTerminated ($functionName)
	Ensures the process is terminated, throws a LogicException if the process has a status different than `terminated`. More...

Private Attributes
	$callback

	$hasCallback = false

	$commandline

	$cwd

	$env

	$input

	$starttime

	$lastOutputTime

	$timeout

	$idleTimeout

	$options

	$exitcode

	$fallbackStatus = array()

	$processInformation

	$outputDisabled = false

	$stdout

	$stderr

	$enhanceWindowsCompatibility = true

	$enhanceSigchildCompatibility

	$process

	$status = self::STATUS_READY

	$incrementalOutputOffset = 0

	$incrementalErrorOutputOffset = 0

	$tty

	$pty

	$useFileHandles = false

	$processPipes

	$latestSignal

Static Private Attributes
static	$sigchild

Detailed Description

Process is a thin wrapper around proc_* functions to easily start independent PHP processes.

Author: Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com; Romain Neutron impre.nosp@m.c@gm.nosp@m.ail.c.nosp@m.om

Definition at line 30 of file Process.php.

Constructor & Destructor Documentation

◆ __construct()

Symfony\Component\Process\Process::__construct	(		$commandline,
			$cwd = `null`,
		array	$env = `null`,
			$input = `null`,
			$timeout = `60`,
		array	$options = `array()`
	)

Constructor.

Parameters

string	$commandline	The command line to run
string \| null	$cwd	The working directory or null to use the working dir of the current PHP process
array \| null	$env	The environment variables or null to use the same environment as the current PHP process
mixed \| null	$input	The input as stream resource, scalar or \Traversable, or null for no input
int \| float \| null	$timeout	The timeout in seconds or null to disable
array	$options	An array of options for proc_open

Exceptions

RuntimeException When proc_open is not installed

Definition at line 147 of file Process.php.

    {
        if (!function_exists('proc_open')) {
            throw new RuntimeException('The Process class relies on proc_open, which is not available on your PHP installation.');
        }
 
        $this->commandline = $commandline;
        $this->cwd = $cwd;
 
        // on Windows, if the cwd changed via chdir(), proc_open defaults to the dir where PHP was started
        // on Gnu/Linux, PHP builds with --enable-maintainer-zts are also affected
        // @see : https://bugs.php.net/bug.php?id=51800
        // @see : https://bugs.php.net/bug.php?id=50524
        if (null === $this->cwd && (defined('ZEND_THREAD_SAFE') || '\\' === DIRECTORY_SEPARATOR)) {
            $this->cwd = getcwd();
        }
        if (null !== $env) {
            $this->setEnv($env);
        }
 
        $this->setInput($input);
        $this->setTimeout($timeout);
        $this->useFileHandles = '\\' === DIRECTORY_SEPARATOR;
        $this->pty = false;
        $this->enhanceWindowsCompatibility = true;
        $this->enhanceSigchildCompatibility = '\\' !== DIRECTORY_SEPARATOR && $this->isSigchildEnabled();
        $this->options = array_replace(array('suppress_errors' => true, 'binary_pipes' => true), $options);
    }

References Symfony\Component\Process\Process\$commandline, Symfony\Component\Process\Process\$cwd, Symfony\Component\Process\Process\$env, Symfony\Component\Process\Process\$input, Symfony\Component\Process\Process\$options, Symfony\Component\Process\Process\$timeout, defined, Symfony\Component\Process\Process\isSigchildEnabled(), Symfony\Component\Process\Process\setEnv(), Symfony\Component\Process\Process\setInput(), and Symfony\Component\Process\Process\setTimeout().

Here is the call graph for this function:

◆ __destruct()

Symfony\Component\Process\Process::__destruct ( )

Definition at line 176 of file Process.php.

    {
        $this->stop(0);
    }

References Symfony\Component\Process\Process\stop().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

Symfony\Component\Process\Process::__clone ( )

Definition at line 181 of file Process.php.

    {
        $this->resetProcessData();
    }

References Symfony\Component\Process\Process\resetProcessData().

Here is the call graph for this function:

◆ addErrorOutput()

Symfony\Component\Process\Process::addErrorOutput ( $line )

Adds a line to the STDERR stream.

Definition at line 871 of file Process.php.

    {
        $this->lastOutputTime = microtime(true);
 
        fseek($this->stderr, 0, SEEK_END);
        fwrite($this->stderr, $line);
        fseek($this->stderr, $this->incrementalErrorOutputOffset);
    }

Referenced by Symfony\Component\Process\Process\buildCallback().

Here is the caller graph for this function:

◆ addOutput()

Symfony\Component\Process\Process::addOutput ( $line )

Adds a line to the STDOUT stream.

Definition at line 855 of file Process.php.

    {
        $this->lastOutputTime = microtime(true);
 
        fseek($this->stdout, 0, SEEK_END);
        fwrite($this->stdout, $line);
        fseek($this->stdout, $this->incrementalOutputOffset);
    }

Referenced by Symfony\Component\Process\Process\buildCallback().

Here is the caller graph for this function:

◆ buildCallback()

Symfony\Component\Process\Process::buildCallback ( callable $callback = null )

protected

Builds up the callback used by wait().

The callbacks adds all occurred output to the specific buffer and calls the user callback (if present) with the received output.

Parameters

callable | null $callback The user defined PHP callback

Returns: \Closure A PHP closure

Definition at line 1276 of file Process.php.

    {
        if ($this->outputDisabled) {
            return function ($type, $data) use ($callback) {
                if (null !== $callback) {
                    call_user_func($callback, $type, $data);
                }
            };
        }
 
        $out = self::OUT;
 
        return function ($type, $data) use ($callback, $out) {
            if ($out == $type) {
                $this->addOutput($data);
            } else {
                $this->addErrorOutput($data);
            }
 
            if (null !== $callback) {
                call_user_func($callback, $type, $data);
            }
        };
    }

References Symfony\Component\Process\Process\$callback, $data, $out, Symfony\Component\Process\Process\addErrorOutput(), Symfony\Component\Process\Process\addOutput(), and Symfony\Component\Process\Process\OUT.

Referenced by Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Process\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkTimeout()

Symfony\Component\Process\Process::checkTimeout ( )

Performs a check between the timeout definition and the time the process started.

In case you run a background process (with the start method), you should trigger this method regularly to ensure the process timeout

Exceptions

ProcessTimedOutException In case the timeout was reached

Definition at line 1208 of file Process.php.

    {
        if ($this->status !== self::STATUS_STARTED) {
            return;
        }
 
        if (null !== $this->timeout && $this->timeout < microtime(true) - $this->starttime) {
            $this->stop(0);
 
            throw new ProcessTimedOutException($this, ProcessTimedOutException::TYPE_GENERAL);
        }
 
        if (null !== $this->idleTimeout && $this->idleTimeout < microtime(true) - $this->lastOutputTime) {
            $this->stop(0);
 
            throw new ProcessTimedOutException($this, ProcessTimedOutException::TYPE_IDLE);
        }
    }

References Symfony\Component\Process\Process\stop(), Symfony\Component\Process\Exception\ProcessTimedOutException\TYPE_GENERAL, and Symfony\Component\Process\Exception\ProcessTimedOutException\TYPE_IDLE.

Referenced by Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Process\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearErrorOutput()

Symfony\Component\Process\Process::clearErrorOutput ( )

Clears the process output.

Returns: Process

Definition at line 628 of file Process.php.

    {
        ftruncate($this->stderr, 0);
        fseek($this->stderr, 0);
        $this->incrementalErrorOutputOffset = 0;
 
        return $this;
    }

Referenced by Symfony\Component\Process\Process\getIterator().

Here is the caller graph for this function:

◆ clearOutput()

Symfony\Component\Process\Process::clearOutput ( )

Clears the process output.

Returns: Process

Definition at line 569 of file Process.php.

    {
        ftruncate($this->stdout, 0);
        fseek($this->stdout, 0);
        $this->incrementalOutputOffset = 0;
 
        return $this;
    }

Referenced by Symfony\Component\Process\Process\getIterator().

Here is the caller graph for this function:

◆ close()

Symfony\Component\Process\Process::close ( )

private

Closes process resource, closes file handles, sets the exitcode.

Returns: int The exitcode

Definition at line 1413 of file Process.php.

    {
        $this->processPipes->close();
        if (is_resource($this->process)) {
            proc_close($this->process);
        }
        $this->exitcode = $this->processInformation['exitcode'];
        $this->status = self::STATUS_TERMINATED;
 
        if (-1 === $this->exitcode) {
            if ($this->processInformation['signaled'] && 0 < $this->processInformation['termsig']) {
                // if process has been signaled, no exitcode but a valid termsig, apply Unix convention
                $this->exitcode = 128 + $this->processInformation['termsig'];
            } elseif ($this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
                $this->processInformation['signaled'] = true;
                $this->processInformation['termsig'] = -1;
            }
        }
 
        // Free memory from self-reference callback created by buildCallback
        // Doing so in other contexts like __destruct or by garbage collector is ineffective
        // Now pipes are closed, so the callback is no longer necessary
        $this->callback = null;
 
        return $this->exitcode;
    }

References Symfony\Component\Process\Process\$exitcode, Symfony\Component\Process\Process\isSigchildEnabled(), and Symfony\Component\Process\Process\STATUS_TERMINATED.

Referenced by Symfony\Component\Process\Process\stop(), and Symfony\Component\Process\Process\updateStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableOutput()

Symfony\Component\Process\Process::disableOutput ( )

Disables fetching output and error output from the underlying process.

Returns: Process

Exceptions

RuntimeException	In case the process is already running
LogicException	if an idle timeout is set

Definition at line 422 of file Process.php.

    {
        if ($this->isRunning()) {
            throw new RuntimeException('Disabling output while the process is running is not possible.');
        }
        if (null !== $this->idleTimeout) {
            throw new LogicException('Output can not be disabled while an idle timeout is set.');
        }
 
        $this->outputDisabled = true;
 
        return $this;
    }

References Symfony\Component\Process\Process\isRunning().

Here is the call graph for this function:

◆ doSignal()

Symfony\Component\Process\Process::doSignal	(	$signal,
		$throwException
	)

private

Sends a POSIX signal to the process.

Parameters

int	$signal	A valid POSIX signal (see http://www.php.net/manual/en/pcntl.constants.php)
bool	$throwException	Whether to throw exception in case signal failed

Returns: bool True if the signal was sent successfully, false otherwise

Exceptions

LogicException	In case the process is not running
RuntimeException	In case –enable-sigchild is activated and the process can't be killed
RuntimeException	In case of failure

Definition at line 1471 of file Process.php.

    {
        if (null === $pid = $this->getPid()) {
            if ($throwException) {
                throw new LogicException('Can not send signal on a non running process.');
            }
 
            return false;
        }
 
        if ('\\' === DIRECTORY_SEPARATOR) {
            exec(sprintf('taskkill /F /T /PID %d 2>&1', $pid), $output, $exitCode);
            if ($exitCode && $this->isRunning()) {
                if ($throwException) {
                    throw new RuntimeException(sprintf('Unable to kill the process (%s).', implode(' ', $output)));
                }
 
                return false;
            }
        } else {
            if (!$this->enhanceSigchildCompatibility || !$this->isSigchildEnabled()) {
                $ok = @proc_terminate($this->process, $signal);
            } elseif (function_exists('posix_kill')) {
                $ok = @posix_kill($pid, $signal);
            } elseif ($ok = proc_open(sprintf('kill -%d %d', $signal, $pid), array(2 => array('pipe', 'w')), $pipes)) {
                $ok = false === fgets($pipes[2]);
            }
            if (!$ok) {
                if ($throwException) {
                    throw new RuntimeException(sprintf('Error while sending signal `%s`.', $signal));
                }
 
                return false;
            }
        }
 
        $this->latestSignal = (int) $signal;
        $this->fallbackStatus['signaled'] = true;
        $this->fallbackStatus['exitcode'] = -1;
        $this->fallbackStatus['termsig'] = $this->latestSignal;
 
        return true;
    }

References Symfony\Component\Process\Process\$latestSignal, $ok, $output, Symfony\Component\Process\Process\getPid(), Symfony\Component\Process\Process\isRunning(), Symfony\Component\Process\Process\isSigchildEnabled(), and sprintf.

Referenced by Symfony\Component\Process\Process\signal(), and Symfony\Component\Process\Process\stop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enableOutput()

Symfony\Component\Process\Process::enableOutput ( )

Enables fetching output and error output from the underlying process.

Returns: Process

Exceptions

RuntimeException In case the process is already running

Definition at line 443 of file Process.php.

    {
        if ($this->isRunning()) {
            throw new RuntimeException('Enabling output while the process is running is not possible.');
        }
 
        $this->outputDisabled = false;
 
        return $this;
    }

References Symfony\Component\Process\Process\isRunning().

Here is the call graph for this function:

◆ getCommandLine()

Symfony\Component\Process\Process::getCommandLine ( )

Gets the command line to be executed.

Returns: string The command to execute

Definition at line 885 of file Process.php.

    {
        return $this->commandline;
    }

References Symfony\Component\Process\Process\$commandline.

Referenced by Assetic\Exception\FilterException\fromProcess(), Symfony\Component\Process\PhpProcess\start(), and Symfony\Component\Process\Tests\PhpProcessTest\testCommandLine().

Here is the caller graph for this function:

◆ getDescriptors()

Symfony\Component\Process\Process::getDescriptors ( )

private

Creates the descriptors needed by the proc_open.

Returns: array

Definition at line 1252 of file Process.php.

    {
        if ($this->input instanceof \Iterator) {
            $this->input->rewind();
        }
        if ('\\' === DIRECTORY_SEPARATOR) {
            $this->processPipes = new WindowsPipes($this->input, !$this->outputDisabled || $this->hasCallback);
        } else {
            $this->processPipes = new UnixPipes($this->isTty(), $this->isPty(), $this->input, !$this->outputDisabled || $this->hasCallback);
        }
 
        return $this->processPipes->getDescriptors();
    }

References input, Symfony\Component\Process\Process\isPty(), and Symfony\Component\Process\Process\isTty().

Referenced by Symfony\Component\Process\Process\start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEnhanceSigchildCompatibility()

Symfony\Component\Process\Process::getEnhanceSigchildCompatibility ( )

Returns whether sigchild compatibility mode is activated or not.

Returns: bool

Definition at line 1177 of file Process.php.

    {
        return $this->enhanceSigchildCompatibility;
    }

References Symfony\Component\Process\Process\$enhanceSigchildCompatibility.

◆ getEnhanceWindowsCompatibility()

Symfony\Component\Process\Process::getEnhanceWindowsCompatibility ( )

Gets whether or not Windows compatibility is enabled.

This is true by default.

Returns: bool

Definition at line 1153 of file Process.php.

    {
        return $this->enhanceWindowsCompatibility;
    }

References Symfony\Component\Process\Process\$enhanceWindowsCompatibility.

◆ getEnv()

Symfony\Component\Process\Process::getEnv ( )

Gets the environment variables.

Returns: array The current environment variables

Definition at line 1057 of file Process.php.

    {
        return $this->env;
    }

References Symfony\Component\Process\Process\$env.

◆ getErrorOutput()

Symfony\Component\Process\Process::getErrorOutput ( )

Returns the current error output of the process (STDERR).

Returns: string The process error output

Exceptions

LogicException	in case the output has been disabled
LogicException	In case the process is not started

Definition at line 586 of file Process.php.

    {
        $this->readPipesForOutput(__FUNCTION__);
 
        if (false === $ret = stream_get_contents($this->stderr, -1, 0)) {
            return '';
        }
 
        return $ret;
    }

References $ret, and Symfony\Component\Process\Process\readPipesForOutput().

Referenced by Assetic\Exception\FilterException\fromProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExitCode()

Symfony\Component\Process\Process::getExitCode ( )

Returns the exit code returned by the process.

Returns: null|int The exit status code, null if the Process is not terminated

Exceptions

RuntimeException In case –enable-sigchild is activated and the sigchild compatibility mode is disabled

Definition at line 644 of file Process.php.

    {
        if (!$this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
            throw new RuntimeException('This PHP has been compiled with --enable-sigchild. You must use setEnhanceSigchildCompatibility() to use this method.');
        }
 
        $this->updateStatus(false);
 
        return $this->exitcode;
    }

References Symfony\Component\Process\Process\$exitcode, Symfony\Component\Process\Process\isSigchildEnabled(), and Symfony\Component\Process\Process\updateStatus().

Referenced by Symfony\Component\Process\Process\getExitCodeText(), and Symfony\Component\Process\Process\isSuccessful().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExitCodeText()

Symfony\Component\Process\Process::getExitCodeText ( )

Returns a string representation for the exit code returned by the process.

This method relies on the Unix exit code status standardization and might not be relevant for other operating systems.

Returns: null|string A string representation for the exit status code, null if the Process is not terminated

See also: http://tldp.org/LDP/abs/html/exitcodes.html; http://en.wikipedia.org/wiki/Unix_signal

Definition at line 666 of file Process.php.

    {
        if (null === $exitcode = $this->getExitCode()) {
            return;
        }
 
        return isset(self::$exitCodes[$exitcode]) ? self::$exitCodes[$exitcode] : 'Unknown error';
    }

References Symfony\Component\Process\Process\$exitcode, and Symfony\Component\Process\Process\getExitCode().

Here is the call graph for this function:

◆ getIdleTimeout()

Symfony\Component\Process\Process::getIdleTimeout ( )

Gets the process idle timeout (max.

time since last output).

Returns: float|null The timeout in seconds or null if it's disabled

Definition at line 919 of file Process.php.

    {
        return $this->idleTimeout;
    }

References Symfony\Component\Process\Process\$idleTimeout.

◆ getIncrementalErrorOutput()

Symfony\Component\Process\Process::getIncrementalErrorOutput ( )

Returns the errorOutput incrementally.

In comparison with the getErrorOutput method which always return the whole error output, this one returns the new error output since the last call.

Returns: string The process error output since the last call

Exceptions

LogicException	in case the output has been disabled
LogicException	In case the process is not started

Definition at line 609 of file Process.php.

    {
        $this->readPipesForOutput(__FUNCTION__);
 
        $latest = stream_get_contents($this->stderr, -1, $this->incrementalErrorOutputOffset);
        $this->incrementalErrorOutputOffset = ftell($this->stderr);
 
        if (false === $latest) {
            return '';
        }
 
        return $latest;
    }

References Symfony\Component\Process\Process\readPipesForOutput().

Here is the call graph for this function:

◆ getIncrementalOutput()

Symfony\Component\Process\Process::getIncrementalOutput ( )

Returns the output incrementally.

In comparison with the getOutput method which always return the whole output, this one returns the new output since the last call.

Returns: string The process output since the last call

Exceptions

LogicException	in case the output has been disabled
LogicException	In case the process is not started

Definition at line 494 of file Process.php.

    {
        $this->readPipesForOutput(__FUNCTION__);
 
        $latest = stream_get_contents($this->stdout, -1, $this->incrementalOutputOffset);
        $this->incrementalOutputOffset = ftell($this->stdout);
 
        if (false === $latest) {
            return '';
        }
 
        return $latest;
    }

References Symfony\Component\Process\Process\readPipesForOutput().

Here is the call graph for this function:

◆ getInput()

Symfony\Component\Process\Process::getInput ( )

Gets the Process input.

Returns: resource|string|\Iterator|null The Process input

Definition at line 1095 of file Process.php.

    {
        return $this->input;
    }

References Symfony\Component\Process\Process\$input.

◆ getIterator()

Symfony\Component\Process\Process::getIterator ( $flags = 0 )

Returns an iterator to the output of the process, with the output type as keys (Process::OUT/ERR).

Parameters

int $flags A bit field of Process::ITER_* flags

Exceptions

LogicException	in case the output has been disabled
LogicException	In case the process is not started

Returns: \Generator

Definition at line 518 of file Process.php.

    {
        $this->readPipesForOutput(__FUNCTION__, false);
 
        $clearOutput = !(self::ITER_KEEP_OUTPUT & $flags);
        $blocking = !(self::ITER_NON_BLOCKING & $flags);
        $yieldOut = !(self::ITER_SKIP_OUT & $flags);
        $yieldErr = !(self::ITER_SKIP_ERR & $flags);
 
        while (null !== $this->callback || ($yieldOut && !feof($this->stdout)) || ($yieldErr && !feof($this->stderr))) {
            if ($yieldOut) {
                $out = stream_get_contents($this->stdout, -1, $this->incrementalOutputOffset);
 
                if (isset($out[0])) {
                    if ($clearOutput) {
                        $this->clearOutput();
                    } else {
                        $this->incrementalOutputOffset = ftell($this->stdout);
                    }
 
                    yield self::OUT => $out;
                }
            }
 
            if ($yieldErr) {
                $err = stream_get_contents($this->stderr, -1, $this->incrementalErrorOutputOffset);
 
                if (isset($err[0])) {
                    if ($clearOutput) {
                        $this->clearErrorOutput();
                    } else {
                        $this->incrementalErrorOutputOffset = ftell($this->stderr);
                    }
 
                    yield self::ERR => $err;
                }
            }
 
            if (!$blocking && !isset($out[0]) && !isset($err[0])) {
                yield self::OUT => '';
            }
 
            $this->readPipesForOutput(__FUNCTION__, $blocking);
        }
    }

References $out, Symfony\Component\Process\Process\clearErrorOutput(), Symfony\Component\Process\Process\clearOutput(), and Symfony\Component\Process\Process\readPipesForOutput().

Here is the call graph for this function:

◆ getOptions()

Symfony\Component\Process\Process::getOptions ( )

Gets the options for proc_open.

Returns: array The current options

Definition at line 1127 of file Process.php.

    {
        return $this->options;
    }

References Symfony\Component\Process\Process\$options.

◆ getOutput()

Symfony\Component\Process\Process::getOutput ( )

Returns the current output of the process (STDOUT).

Returns: string The process output

Exceptions

LogicException	in case the output has been disabled
LogicException	In case the process is not started

Definition at line 472 of file Process.php.

    {
        $this->readPipesForOutput(__FUNCTION__);
 
        if (false === $ret = stream_get_contents($this->stdout, -1, 0)) {
            return '';
        }
 
        return $ret;
    }

References $ret, and Symfony\Component\Process\Process\readPipesForOutput().

Referenced by Assetic\Exception\FilterException\fromProcess().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPid()

Symfony\Component\Process\Process::getPid ( )

Returns the Pid (process identifier), if applicable.

Returns: int|null The process id if running, null otherwise

Definition at line 391 of file Process.php.

    {
        return $this->isRunning() ? $this->processInformation['pid'] : null;
    }

References Symfony\Component\Process\Process\isRunning().

Referenced by Symfony\Component\Process\Process\doSignal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStatus()

Symfony\Component\Process\Process::getStatus ( )

Gets the process status.

The status is one of: ready, started, terminated.

Returns: string The current process status

Definition at line 804 of file Process.php.

    {
        $this->updateStatus(false);
 
        return $this->status;
    }

References Symfony\Component\Process\Process\$status, and Symfony\Component\Process\Process\updateStatus().

Here is the call graph for this function:

◆ getStopSignal()

Symfony\Component\Process\Process::getStopSignal ( )

Returns the number of the signal that caused the child process to stop its execution.

It is only meaningful if hasBeenStopped() returns true.

Returns: int

Exceptions

LogicException In case the process is not terminated

Definition at line 752 of file Process.php.

    {
        $this->requireProcessIsTerminated(__FUNCTION__);
 
        return $this->processInformation['stopsig'];
    }

References Symfony\Component\Process\Process\requireProcessIsTerminated().

Here is the call graph for this function:

◆ getTermSignal()

Symfony\Component\Process\Process::getTermSignal ( )

Returns the number of the signal that caused the child process to terminate its execution.

It is only meaningful if hasBeenSignaled() returns true.

Returns: int

Exceptions

RuntimeException	In case –enable-sigchild is activated
LogicException	In case the process is not terminated

Definition at line 716 of file Process.php.

    {
        $this->requireProcessIsTerminated(__FUNCTION__);
 
        if ($this->isSigchildEnabled() && (!$this->enhanceSigchildCompatibility || -1 === $this->processInformation['termsig'])) {
            throw new RuntimeException('This PHP has been compiled with --enable-sigchild. Term signal can not be retrieved.');
        }
 
        return $this->processInformation['termsig'];
    }

References Symfony\Component\Process\Process\isSigchildEnabled(), and Symfony\Component\Process\Process\requireProcessIsTerminated().

Here is the call graph for this function:

◆ getTimeout()

Symfony\Component\Process\Process::getTimeout ( )

Gets the process timeout (max.

runtime).

Returns: float|null The timeout in seconds or null if it's disabled

Definition at line 909 of file Process.php.

    {
        return $this->timeout;
    }

References Symfony\Component\Process\Process\$timeout.

◆ getWorkingDirectory()

Symfony\Component\Process\Process::getWorkingDirectory ( )

Gets the working directory.

Returns: string|null The current working directory or null on failure

Definition at line 1027 of file Process.php.

    {
        if (null === $this->cwd) {
            // getcwd() will return false if any one of the parent directories does not have
            // the readable or search mode set, even if the current directory does
            return getcwd() ?: null;
        }
 
        return $this->cwd;
    }

References Symfony\Component\Process\Process\$cwd.

◆ hasBeenSignaled()

Symfony\Component\Process\Process::hasBeenSignaled ( )

Returns true if the child process has been terminated by an uncaught signal.

It always returns false on Windows.

Returns: bool

Exceptions

RuntimeException	In case –enable-sigchild is activated
LogicException	In case the process is not terminated

Definition at line 695 of file Process.php.

    {
        $this->requireProcessIsTerminated(__FUNCTION__);
 
        if (!$this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
            throw new RuntimeException('This PHP has been compiled with --enable-sigchild. Term signal can not be retrieved.');
        }
 
        return $this->processInformation['signaled'];
    }

References Symfony\Component\Process\Process\isSigchildEnabled(), and Symfony\Component\Process\Process\requireProcessIsTerminated().

Here is the call graph for this function:

◆ hasBeenStopped()

Symfony\Component\Process\Process::hasBeenStopped ( )

Returns true if the child process has been stopped by a signal.

It always returns false on Windows.

Returns: bool

Exceptions

LogicException In case the process is not terminated

Definition at line 736 of file Process.php.

    {
        $this->requireProcessIsTerminated(__FUNCTION__);
 
        return $this->processInformation['stopped'];
    }

References Symfony\Component\Process\Process\requireProcessIsTerminated().

Here is the call graph for this function:

◆ isOutputDisabled()

Symfony\Component\Process\Process::isOutputDisabled ( )

Returns true in case the output is disabled, false otherwise.

Returns: bool

Definition at line 459 of file Process.php.

    {
        return $this->outputDisabled;
    }

References Symfony\Component\Process\Process\$outputDisabled.

◆ isPty()

Symfony\Component\Process\Process::isPty ( )

Returns PTY state.

Returns: bool

Definition at line 1017 of file Process.php.

    {
        return $this->pty;
    }

References Symfony\Component\Process\Process\$pty.

Referenced by Symfony\Component\Process\Process\getDescriptors().

Here is the caller graph for this function:

◆ isPtySupported()

static Symfony\Component\Process\Process::isPtySupported ( )

static

Returns whether PTY is supported on the current operating system.

Returns: bool

Definition at line 1232 of file Process.php.

    {
        static $result;
 
        if (null !== $result) {
            return $result;
        }
 
        if ('\\' === DIRECTORY_SEPARATOR) {
            return $result = false;
        }
 
        return $result = (bool) @proc_open('echo 1', array(array('pty'), array('pty'), array('pty')), $pipes);
    }

References $result.

Referenced by Symfony\Component\Process\Pipes\UnixPipes\getDescriptors(), and Symfony\Component\Process\Tests\ProcessTest\testPTYCommand().

Here is the caller graph for this function:

◆ isRunning()

Symfony\Component\Process\Process::isRunning ( )

Checks if the process is currently running.

Returns: bool true if the process is currently running, false otherwise

Definition at line 764 of file Process.php.

    {
        if (self::STATUS_STARTED !== $this->status) {
            return false;
        }
 
        $this->updateStatus(false);
 
        return $this->processInformation['running'];
    }

References Symfony\Component\Process\Process\updateStatus().

Referenced by Symfony\Component\Process\Process\disableOutput(), Symfony\Component\Process\Process\doSignal(), Symfony\Component\Process\Process\enableOutput(), Symfony\Component\Process\Process\getPid(), Symfony\Component\Process\Process\restart(), Symfony\Component\Process\Process\setInput(), Symfony\Component\Process\Process\start(), Symfony\Component\Process\Process\stop(), and Symfony\Component\Process\Process\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSigchildEnabled()

Symfony\Component\Process\Process::isSigchildEnabled ( )

protected

Returns whether PHP has been compiled with the '–enable-sigchild' option or not.

Returns: bool

Definition at line 1331 of file Process.php.

    {
        if (null !== self::$sigchild) {
            return self::$sigchild;
        }
 
        if (!function_exists('phpinfo') || defined('HHVM_VERSION')) {
            return self::$sigchild = false;
        }
 
        ob_start();
        phpinfo(INFO_GENERAL);
 
        return self::$sigchild = false !== strpos(ob_get_clean(), '--enable-sigchild');
    }

References Symfony\Component\Process\Process\$sigchild, and defined.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\Process\close(), Symfony\Component\Process\Process\doSignal(), Symfony\Component\Process\Process\getExitCode(), Symfony\Component\Process\Process\getTermSignal(), Symfony\Component\Process\Process\hasBeenSignaled(), Symfony\Component\Process\Process\mustRun(), Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Process\updateStatus().

Here is the caller graph for this function:

◆ isStarted()

Symfony\Component\Process\Process::isStarted ( )

Checks if the process has been started with no regard to the current state.

Returns: bool true if status is ready, false otherwise

Definition at line 780 of file Process.php.

    {
        return $this->status != self::STATUS_READY;
    }

References Symfony\Component\Process\Process\STATUS_READY.

Referenced by Symfony\Component\Process\Process\requireProcessIsStarted().

Here is the caller graph for this function:

◆ isSuccessful()

Symfony\Component\Process\Process::isSuccessful ( )

Checks if the process ended successfully.

Returns: bool true if the process ended successfully, false otherwise

Definition at line 680 of file Process.php.

    {
        return 0 === $this->getExitCode();
    }

References Symfony\Component\Process\Process\getExitCode().

Here is the call graph for this function:

◆ isTerminated()

Symfony\Component\Process\Process::isTerminated ( )

Checks if the process is terminated.

Returns: bool true if process is terminated, false otherwise

Definition at line 790 of file Process.php.

    {
        $this->updateStatus(false);
 
        return $this->status == self::STATUS_TERMINATED;
    }

References Symfony\Component\Process\Process\STATUS_TERMINATED, and Symfony\Component\Process\Process\updateStatus().

Referenced by Symfony\Component\Process\Process\requireProcessIsTerminated().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTty()

Symfony\Component\Process\Process::isTty ( )

Checks if the TTY mode is enabled.

Returns: bool true if the TTY mode is enabled, false otherwise

Definition at line 993 of file Process.php.

    {
        return $this->tty;
    }

References Symfony\Component\Process\Process\$tty.

Referenced by Symfony\Component\Process\Process\getDescriptors().

Here is the caller graph for this function:

◆ mustRun()

Symfony\Component\Process\Process::mustRun ( callable $callback = null )

Runs the process.

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

Parameters

callable | null $callback

Returns: self

Exceptions

RuntimeException	if PHP was compiled with –enable-sigchild and the enhanced sigchild compatibility mode is not enabled
ProcessFailedException	if the process didn't terminate successfully

Definition at line 225 of file Process.php.

    {
        if (!$this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
            throw new RuntimeException('This PHP has been compiled with --enable-sigchild. You must use setEnhanceSigchildCompatibility() to use this method.');
        }
 
        if (0 !== $this->run($callback)) {
            throw new ProcessFailedException($this);
        }
 
        return $this;
    }

References Symfony\Component\Process\Process\$callback, Symfony\Component\Process\Process\isSigchildEnabled(), and Symfony\Component\Process\Process\run().

Here is the call graph for this function:

◆ readPipes()

Symfony\Component\Process\Process::readPipes	(	$blocking,
		$close
	)

private

Reads pipes, executes callback.

Parameters

bool	$blocking	Whether to use blocking calls or not
bool	$close	Whether to close file handles or not

Definition at line 1394 of file Process.php.

    {
        $result = $this->processPipes->readAndWrite($blocking, $close);
 
        $callback = $this->callback;
        foreach ($result as $type => $data) {
            if (3 !== $type) {
                $callback($type === self::STDOUT ? self::OUT : self::ERR, $data);
            } elseif (!isset($this->fallbackStatus['signaled'])) {
                $this->fallbackStatus['exitcode'] = (int) $data;
            }
        }
    }

References Symfony\Component\Process\Process\$callback, $data, and $result.

Referenced by Symfony\Component\Process\Process\updateStatus(), and Symfony\Component\Process\Process\wait().

Here is the caller graph for this function:

◆ readPipesForOutput()

Symfony\Component\Process\Process::readPipesForOutput	(	$caller,
		$blocking = `false`
	)

private

Reads pipes for the freshest output.

Parameters

string	$caller	The name of the method that needs fresh outputs
bool	$blocking	Whether to use blocking calls or not

Exceptions

LogicException in case output has been disabled or process is not started

Definition at line 1355 of file Process.php.

    {
        if ($this->outputDisabled) {
            throw new LogicException('Output has been disabled.');
        }
 
        $this->requireProcessIsStarted($caller);
 
        $this->updateStatus($blocking);
    }

References Symfony\Component\Process\Process\requireProcessIsStarted(), and Symfony\Component\Process\Process\updateStatus().

Referenced by Symfony\Component\Process\Process\getErrorOutput(), Symfony\Component\Process\Process\getIncrementalErrorOutput(), Symfony\Component\Process\Process\getIncrementalOutput(), Symfony\Component\Process\Process\getIterator(), and Symfony\Component\Process\Process\getOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requireProcessIsStarted()

Symfony\Component\Process\Process::requireProcessIsStarted ( $functionName )

private

Ensures the process is running or terminated, throws a LogicException if the process has a not started.

Parameters

string $functionName The function name that was called

Exceptions

LogicException If the process has not run.

Definition at line 1522 of file Process.php.

    {
        if (!$this->isStarted()) {
            throw new LogicException(sprintf('Process must be started before calling %s.', $functionName));
        }
    }

References Symfony\Component\Process\Process\isStarted(), and sprintf.

Referenced by Symfony\Component\Process\Process\readPipesForOutput(), and Symfony\Component\Process\Process\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requireProcessIsTerminated()

Symfony\Component\Process\Process::requireProcessIsTerminated ( $functionName )

private

Ensures the process is terminated, throws a LogicException if the process has a status different than terminated.

Parameters

string $functionName The function name that was called

Exceptions

LogicException If the process is not yet terminated.

Definition at line 1536 of file Process.php.

    {
        if (!$this->isTerminated()) {
            throw new LogicException(sprintf('Process must be terminated before calling %s.', $functionName));
        }
    }

References Symfony\Component\Process\Process\isTerminated(), and sprintf.

Referenced by Symfony\Component\Process\Process\getStopSignal(), Symfony\Component\Process\Process\getTermSignal(), Symfony\Component\Process\Process\hasBeenSignaled(), and Symfony\Component\Process\Process\hasBeenStopped().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetProcessData()

Symfony\Component\Process\Process::resetProcessData ( )

private

Resets data related to the latest run of the process.

Definition at line 1443 of file Process.php.

    {
        $this->starttime = null;
        $this->callback = null;
        $this->exitcode = null;
        $this->fallbackStatus = array();
        $this->processInformation = null;
        $this->stdout = fopen('php://temp/maxmemory:'.(1024 * 1024), 'wb+');
        $this->stderr = fopen('php://temp/maxmemory:'.(1024 * 1024), 'wb+');
        $this->process = null;
        $this->latestSignal = null;
        $this->status = self::STATUS_READY;
        $this->incrementalOutputOffset = 0;
        $this->incrementalErrorOutputOffset = 0;
    }

References Symfony\Component\Process\Process\STATUS_READY.

Referenced by Symfony\Component\Process\Process\__clone(), and Symfony\Component\Process\Process\start().

Here is the caller graph for this function:

◆ restart()

Symfony\Component\Process\Process::restart ( callable $callback = null )

Restarts the process.

Be warned that the process is cloned before being started.

Parameters

callable | null $callback A PHP callback to run whenever there is some output available on STDOUT or STDERR

Returns: Process The new process

Exceptions

RuntimeException	When process can't be launched
RuntimeException	When process is already running

See also: start()

Definition at line 328 of file Process.php.

    {
        if ($this->isRunning()) {
            throw new RuntimeException('Process is already running');
        }
 
        $process = clone $this;
        $process->start($callback);
 
        return $process;
    }

References Symfony\Component\Process\Process\$callback, Symfony\Component\Process\Process\$process, and Symfony\Component\Process\Process\isRunning().

Here is the call graph for this function:

◆ run()

Symfony\Component\Process\Process::run ( $callback = null )

Runs the process.

The callback receives the type of output (out or err) and some bytes from the output in real-time. It allows to have feedback from the independent process during execution.

The STDOUT and STDERR are also available after the process is finished via the getOutput() and getErrorOutput() methods.

Parameters

callable | null $callback A PHP callback to run whenever there is some output available on STDOUT or STDERR

Returns: int The exit status code

Exceptions

RuntimeException	When process can't be launched
RuntimeException	When process stopped after receiving signal
LogicException	In case a callback is provided and output has been disabled

Definition at line 205 of file Process.php.

    {
        $this->start($callback);
 
        return $this->wait();
    }

References Symfony\Component\Process\Process\$callback, Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Process\wait().

Referenced by Symfony\Component\Process\Process\mustRun().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCommandLine()

Symfony\Component\Process\Process::setCommandLine ( $commandline )

Sets the command line to be executed.

Parameters

string $commandline The command to execute

Returns: self The current Process instance

Definition at line 897 of file Process.php.

    {
        $this->commandline = $commandline;
 
        return $this;
    }

References Symfony\Component\Process\Process\$commandline.

Referenced by Symfony\Component\Process\PhpProcess\setPhpBinary().

Here is the caller graph for this function:

◆ setEnhanceSigchildCompatibility()

Symfony\Component\Process\Process::setEnhanceSigchildCompatibility ( $enhance )

Activates sigchild compatibility mode.

Sigchild compatibility mode is required to get the exit code and determine the success of a process when PHP has been compiled with the –enable-sigchild option

Parameters

bool $enhance

Returns: self The current Process instance

Definition at line 1193 of file Process.php.

    {
        $this->enhanceSigchildCompatibility = (bool) $enhance;
 
        return $this;
    }

◆ setEnhanceWindowsCompatibility()

Symfony\Component\Process\Process::setEnhanceWindowsCompatibility ( $enhance )

Sets whether or not Windows compatibility is enabled.

Parameters

bool $enhance

Returns: self The current Process instance

Definition at line 1165 of file Process.php.

    {
        $this->enhanceWindowsCompatibility = (bool) $enhance;
 
        return $this;
    }

◆ setEnv()

Symfony\Component\Process\Process::setEnv ( array $env )

Sets the environment variables.

An environment variable value should be a string. If it is an array, the variable is ignored.

That happens in PHP when 'argv' is registered into the $_ENV array for instance.

Parameters

array $env The new environment variables

Returns: self The current Process instance

Definition at line 1075 of file Process.php.

    {
        // Process can not handle env values that are arrays
        $env = array_filter($env, function ($value) {
            return !is_array($value);
        });
 
        $this->env = array();
        foreach ($env as $key => $value) {
            $this->env[$key] = (string) $value;
        }
 
        return $this;
    }

References Symfony\Component\Process\Process\$env.

Referenced by Symfony\Component\Process\Process\__construct().

Here is the caller graph for this function:

◆ setIdleTimeout()

Symfony\Component\Process\Process::setIdleTimeout ( $timeout )

Sets the process idle timeout (max.

time since last output).

To disable the timeout, set this value to null.

Parameters

int | float | null $timeout The timeout in seconds

Returns: self The current Process instance

Exceptions

LogicException	if the output is disabled
InvalidArgumentException	if the timeout is negative

Definition at line 954 of file Process.php.

    {
        if (null !== $timeout && $this->outputDisabled) {
            throw new LogicException('Idle timeout can not be set while the output is disabled.');
        }
 
        $this->idleTimeout = $this->validateTimeout($timeout);
 
        return $this;
    }

References Symfony\Component\Process\Process\$timeout, and Symfony\Component\Process\Process\validateTimeout().

Here is the call graph for this function:

◆ setInput()

Symfony\Component\Process\Process::setInput ( $input )

Sets the input.

This content will be passed to the underlying process standard input.

Parameters

resource | scalar | \Traversable | null $input The content

Returns: self The current Process instance

Exceptions

LogicException In case the process is running

Definition at line 1111 of file Process.php.

    {
        if ($this->isRunning()) {
            throw new LogicException('Input can not be set while the process is running.');
        }
 
        $this->input = ProcessUtils::validateInput(__METHOD__, $input);
 
        return $this;
    }

References Symfony\Component\Process\Process\$input, input, Symfony\Component\Process\Process\isRunning(), and Symfony\Component\Process\ProcessUtils\validateInput().

Referenced by Symfony\Component\Process\Process\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOptions()

Symfony\Component\Process\Process::setOptions ( array $options )

Sets the options for proc_open.

Parameters

array $options The new options

Returns: self The current Process instance

Definition at line 1139 of file Process.php.

    {
        $this->options = $options;
 
        return $this;
    }

References Symfony\Component\Process\Process\$options.

◆ setPty()

Symfony\Component\Process\Process::setPty ( $bool )

Sets PTY mode.

Parameters

bool $bool

Returns: self

Definition at line 1005 of file Process.php.

    {
        $this->pty = (bool) $bool;
 
        return $this;
    }

◆ setTimeout()

Symfony\Component\Process\Process::setTimeout ( $timeout )

Sets the process timeout (max.

runtime).

To disable the timeout, set this value to null.

Parameters

int | float | null $timeout The timeout in seconds

Returns: self The current Process instance

Exceptions

InvalidArgumentException if the timeout is negative

Definition at line 935 of file Process.php.

    {
        $this->timeout = $this->validateTimeout($timeout);
 
        return $this;
    }

References Symfony\Component\Process\Process\$timeout, and Symfony\Component\Process\Process\validateTimeout().

Referenced by Symfony\Component\Process\Process\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTty()

Symfony\Component\Process\Process::setTty ( $tty )

Enables or disables the TTY mode.

Parameters

bool $tty True to enabled and false to disable

Returns: self The current Process instance

Exceptions

RuntimeException In case the TTY mode is not supported

Definition at line 974 of file Process.php.

    {
        if ('\\' === DIRECTORY_SEPARATOR && $tty) {
            throw new RuntimeException('TTY mode is not supported on Windows platform.');
        }
        if ($tty && (!file_exists('/dev/tty') || !is_readable('/dev/tty'))) {
            throw new RuntimeException('TTY mode requires /dev/tty to be readable.');
        }
 
        $this->tty = (bool) $tty;
 
        return $this;
    }

References Symfony\Component\Process\Process\$tty.

◆ setWorkingDirectory()

Symfony\Component\Process\Process::setWorkingDirectory ( $cwd )

Sets the current working directory.

Parameters

string $cwd The new working directory

Returns: self The current Process instance

Definition at line 1045 of file Process.php.

    {
        $this->cwd = $cwd;
 
        return $this;
    }

References Symfony\Component\Process\Process\$cwd.

◆ signal()

Symfony\Component\Process\Process::signal ( $signal )

Sends a POSIX signal to the process.

Parameters

int $signal A valid POSIX signal (see http://www.php.net/manual/en/pcntl.constants.php)

Returns: Process

Exceptions

LogicException	In case the process is not running
RuntimeException	In case –enable-sigchild is activated and the process can't be killed
RuntimeException	In case of failure

Definition at line 407 of file Process.php.

    {
        $this->doSignal($signal, true);
 
        return $this;
    }

References Symfony\Component\Process\Process\doSignal().

Here is the call graph for this function:

◆ start()

Symfony\Component\Process\Process::start ( callable $callback = null )

Starts the process and returns after writing the input to STDIN.

This method blocks until all STDIN data is sent to the process then it returns while the process runs in the background.

The termination of the process can be awaited with wait().

The callback receives the type of output (out or err) and some bytes from the output in real-time while writing the standard input to the process. It allows to have feedback from the independent process during execution.

Parameters

callable | null $callback A PHP callback to run whenever there is some output available on STDOUT or STDERR

Exceptions

RuntimeException	When process can't be launched
RuntimeException	When process is already running
LogicException	In case a callback is provided and output has been disabled

Reimplemented in Symfony\Component\Process\PhpProcess.

Definition at line 257 of file Process.php.

    {
        if ($this->isRunning()) {
            throw new RuntimeException('Process is already running');
        }
 
        $this->resetProcessData();
        $this->starttime = $this->lastOutputTime = microtime(true);
        $this->callback = $this->buildCallback($callback);
        $this->hasCallback = null !== $callback;
        $descriptors = $this->getDescriptors();
 
        $commandline = $this->commandline;
 
        if ('\\' === DIRECTORY_SEPARATOR && $this->enhanceWindowsCompatibility) {
            $commandline = 'cmd /V:ON /E:ON /D /C "('.$commandline.')';
            foreach ($this->processPipes->getFiles() as $offset => $filename) {
                $commandline .= ' '.$offset.'>'.ProcessUtils::escapeArgument($filename);
            }
            $commandline .= '"';
 
            if (!isset($this->options['bypass_shell'])) {
                $this->options['bypass_shell'] = true;
            }
        } elseif (!$this->useFileHandles && $this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
            // last exit code is output on the fourth pipe and caught to work around --enable-sigchild
            $descriptors[3] = array('pipe', 'w');
 
            // See https://unix.stackexchange.com/questions/71205/background-process-pipe-input
            $commandline = '{ ('.$this->commandline.') <&3 3<&- 3>/dev/null & } 3<&0;';
            $commandline .= 'pid=$!; echo $pid >&3; wait $pid; code=$?; echo $code >&3; exit $code';
 
            // Workaround for the bug, when PTS functionality is enabled.
            // @see : https://bugs.php.net/69442
            $ptsWorkaround = fopen(__FILE__, 'r');
        }
 
        $this->process = proc_open($commandline, $descriptors, $this->processPipes->pipes, $this->cwd, $this->env, $this->options);
 
        if (!is_resource($this->process)) {
            throw new RuntimeException('Unable to launch a new process.');
        }
        $this->status = self::STATUS_STARTED;
 
        if (isset($descriptors[3])) {
            $this->fallbackStatus['pid'] = (int) fgets($this->processPipes->pipes[3]);
        }
 
        if ($this->tty) {
            return;
        }
 
        $this->updateStatus(false);
        $this->checkTimeout();
    }

Referenced by Symfony\Component\Process\Process\run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ stop()

Symfony\Component\Process\Process::stop	(	$timeout = `10`,
		$signal = `null`
	)

Stops the process.

Parameters

int \| float	$timeout	The timeout in seconds
int	$signal	A POSIX signal to send in case the process has not stop at timeout, default is SIGKILL (9)

Returns: int The exit-code of the process

Definition at line 819 of file Process.php.

    {
        $timeoutMicro = microtime(true) + $timeout;
        if ($this->isRunning()) {
            // given `SIGTERM` may not be defined and that `proc_terminate` uses the constant value and not the constant itself, we use the same here
            $this->doSignal(15, false);
            do {
                usleep(1000);
            } while ($this->isRunning() && microtime(true) < $timeoutMicro);
 
            if ($this->isRunning()) {
                // Avoid exception here: process is supposed to be running, but it might have stopped just
                // after this line. In any case, let's silently discard the error, we cannot do anything.
                $this->doSignal($signal ?: 9, false);
            }
        }
 
        if ($this->isRunning()) {
            if (isset($this->fallbackStatus['pid'])) {
                unset($this->fallbackStatus['pid']);
 
                return $this->stop(0, $signal);
            }
            $this->close();
        }
 
        return $this->exitcode;
    }

References Symfony\Component\Process\Process\$exitcode, Symfony\Component\Process\Process\$timeout, Symfony\Component\Process\Process\close(), Symfony\Component\Process\Process\doSignal(), Symfony\Component\Process\Process\isRunning(), and Symfony\Component\Process\Process\stop().

Referenced by Symfony\Component\Process\Process\__destruct(), Symfony\Component\Process\Process\checkTimeout(), Symfony\Component\Process\Process\stop(), and Symfony\Component\Process\Process\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateStatus()

Symfony\Component\Process\Process::updateStatus ( $blocking )

protected

Updates the status of the process, reads pipes.

Parameters

bool $blocking Whether to use a blocking read call

Definition at line 1306 of file Process.php.

    {
        if (self::STATUS_STARTED !== $this->status) {
            return;
        }
 
        $this->processInformation = proc_get_status($this->process);
        $running = $this->processInformation['running'];
 
        $this->readPipes($running && $blocking, '\\' !== DIRECTORY_SEPARATOR || !$running);
 
        if ($this->fallbackStatus && $this->enhanceSigchildCompatibility && $this->isSigchildEnabled()) {
            $this->processInformation = $this->fallbackStatus + $this->processInformation;
        }
 
        if (!$running) {
            $this->close();
        }
    }

References Symfony\Component\Process\Process\$processInformation, Symfony\Component\Process\Process\close(), Symfony\Component\Process\Process\isSigchildEnabled(), and Symfony\Component\Process\Process\readPipes().

Referenced by Symfony\Component\Process\Process\getExitCode(), Symfony\Component\Process\Process\getStatus(), Symfony\Component\Process\Process\isRunning(), Symfony\Component\Process\Process\isTerminated(), Symfony\Component\Process\Process\readPipesForOutput(), Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Process\wait().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateTimeout()

Symfony\Component\Process\Process::validateTimeout ( $timeout )

private

Validates and returns the filtered timeout.

Parameters

int | float | null $timeout

Returns: float|null

Exceptions

InvalidArgumentException if the given timeout is a negative number

Definition at line 1375 of file Process.php.

    {
        $timeout = (float) $timeout;
 
        if (0.0 === $timeout) {
            $timeout = null;
        } elseif ($timeout < 0) {
            throw new InvalidArgumentException('The timeout value must be a valid positive integer or float number.');
        }
 
        return $timeout;
    }

References Symfony\Component\Process\Process\$timeout.

Referenced by Symfony\Component\Process\Process\setIdleTimeout(), and Symfony\Component\Process\Process\setTimeout().

Here is the caller graph for this function:

◆ wait()

Symfony\Component\Process\Process::wait ( callable $callback = null )

Waits for the process to terminate.

The callback receives the type of output (out or err) and some bytes from the output in real-time while writing the standard input to the process. It allows to have feedback from the independent process during execution.

Parameters

callable | null $callback A valid PHP callback

Returns: int The exitcode of the process

Exceptions

RuntimeException	When process timed out
RuntimeException	When process stopped after receiving signal
LogicException	When process is not yet started

Definition at line 355 of file Process.php.

    {
        $this->requireProcessIsStarted(__FUNCTION__);
 
        $this->updateStatus(false);
 
        if (null !== $callback) {
            if (!$this->processPipes->haveReadSupport()) {
                $this->stop(0);
                throw new \LogicException('Pass the callback to the Process:start method or enableOutput to use a callback with Process::wait');
            }
            $this->callback = $this->buildCallback($callback);
        }
 
        do {
            $this->checkTimeout();
            $running = '\\' === DIRECTORY_SEPARATOR ? $this->isRunning() : $this->processPipes->areOpen();
            $this->readPipes($running, '\\' !== DIRECTORY_SEPARATOR || !$running);
        } while ($running);
 
        while ($this->isRunning()) {
            usleep(1000);
        }
 
        if ($this->processInformation['signaled'] && $this->processInformation['termsig'] !== $this->latestSignal) {
            throw new RuntimeException(sprintf('The process has been signaled with signal "%s".', $this->processInformation['termsig']));
        }
 
        return $this->exitcode;
    }

References Symfony\Component\Process\Process\$callback, Symfony\Component\Process\Process\$exitcode, Symfony\Component\Process\Process\buildCallback(), Symfony\Component\Process\Process\checkTimeout(), Symfony\Component\Process\Process\isRunning(), Symfony\Component\Process\Process\readPipes(), Symfony\Component\Process\Process\requireProcessIsStarted(), sprintf, Symfony\Component\Process\Process\stop(), and Symfony\Component\Process\Process\updateStatus().

Referenced by Symfony\Component\Process\Process\run().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $callback

Symfony\Component\Process\Process::$callback

private

Definition at line 51 of file Process.php.

Referenced by Symfony\Component\Process\Process\buildCallback(), Symfony\Component\Process\Process\mustRun(), Symfony\Component\Process\Process\readPipes(), Symfony\Component\Process\Process\restart(), Symfony\Component\Process\Process\run(), Symfony\Component\Process\PhpProcess\start(), Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Process\wait().

◆ $commandline

Symfony\Component\Process\Process::$commandline

private

Definition at line 53 of file Process.php.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\Process\getCommandLine(), Symfony\Component\Process\Process\setCommandLine(), and Symfony\Component\Process\Process\start().

◆ $cwd

Symfony\Component\Process\Process::$cwd

private

Definition at line 54 of file Process.php.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\PhpProcess\__construct(), Symfony\Component\Process\Process\getWorkingDirectory(), and Symfony\Component\Process\Process\setWorkingDirectory().

◆ $enhanceSigchildCompatibility

Symfony\Component\Process\Process::$enhanceSigchildCompatibility

private

Definition at line 69 of file Process.php.

Referenced by Symfony\Component\Process\Process\getEnhanceSigchildCompatibility().

◆ $enhanceWindowsCompatibility

Symfony\Component\Process\Process::$enhanceWindowsCompatibility = true

private

Definition at line 68 of file Process.php.

Referenced by Symfony\Component\Process\Process\getEnhanceWindowsCompatibility().

◆ $env

Symfony\Component\Process\Process::$env

private

Definition at line 55 of file Process.php.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\PhpProcess\__construct(), Symfony\Component\Process\Process\getEnv(), and Symfony\Component\Process\Process\setEnv().

◆ $exitcode

Symfony\Component\Process\Process::$exitcode

private

Definition at line 62 of file Process.php.

Referenced by Symfony\Component\Process\Process\close(), Symfony\Component\Process\Process\getExitCode(), Symfony\Component\Process\Process\getExitCodeText(), Symfony\Component\Process\Process\stop(), and Symfony\Component\Process\Process\wait().

◆ $exitCodes

Symfony\Component\Process\Process::$exitCodes

static

Definition at line 92 of file Process.php.

◆ $fallbackStatus

Symfony\Component\Process\Process::$fallbackStatus = array()

private

Definition at line 63 of file Process.php.

◆ $hasCallback

Symfony\Component\Process\Process::$hasCallback = false

private

Definition at line 52 of file Process.php.

◆ $idleTimeout

Symfony\Component\Process\Process::$idleTimeout

private

Definition at line 60 of file Process.php.

Referenced by Symfony\Component\Process\Process\getIdleTimeout().

◆ $incrementalErrorOutputOffset

Symfony\Component\Process\Process::$incrementalErrorOutputOffset = 0

private

Definition at line 73 of file Process.php.

◆ $incrementalOutputOffset

Symfony\Component\Process\Process::$incrementalOutputOffset = 0

private

Definition at line 72 of file Process.php.

◆ $input

Symfony\Component\Process\Process::$input

private

Definition at line 56 of file Process.php.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\Process\getInput(), and Symfony\Component\Process\Process\setInput().

◆ $lastOutputTime

Symfony\Component\Process\Process::$lastOutputTime

private

Definition at line 58 of file Process.php.

◆ $latestSignal

Symfony\Component\Process\Process::$latestSignal

private

Definition at line 81 of file Process.php.

Referenced by Symfony\Component\Process\Process\doSignal().

◆ $options

Symfony\Component\Process\Process::$options

private

Definition at line 61 of file Process.php.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\PhpProcess\__construct(), Symfony\Component\Process\Process\getOptions(), and Symfony\Component\Process\Process\setOptions().

◆ $outputDisabled

Symfony\Component\Process\Process::$outputDisabled = false

private

Definition at line 65 of file Process.php.

Referenced by Symfony\Component\Process\Process\isOutputDisabled().

◆ $process

Symfony\Component\Process\Process::$process

private

Definition at line 70 of file Process.php.

Referenced by Symfony\Component\Process\Process\restart().

◆ $processInformation

Symfony\Component\Process\Process::$processInformation

private

Definition at line 64 of file Process.php.

Referenced by Symfony\Component\Process\Process\updateStatus().

◆ $processPipes

Symfony\Component\Process\Process::$processPipes

private

Definition at line 79 of file Process.php.

◆ $pty

Symfony\Component\Process\Process::$pty

private

Definition at line 75 of file Process.php.

Referenced by Symfony\Component\Process\Process\isPty().

◆ $sigchild

Symfony\Component\Process\Process::$sigchild

staticprivate

Definition at line 83 of file Process.php.

Referenced by Symfony\Component\Process\Process\isSigchildEnabled().

◆ $starttime

Symfony\Component\Process\Process::$starttime

private

Definition at line 57 of file Process.php.

◆ $status

Symfony\Component\Process\Process::$status = self::STATUS_READY

private

Definition at line 71 of file Process.php.

Referenced by Symfony\Component\Process\Process\getStatus().

◆ $stderr

Symfony\Component\Process\Process::$stderr

private

Definition at line 67 of file Process.php.

◆ $stdout

Symfony\Component\Process\Process::$stdout

private

Definition at line 66 of file Process.php.

◆ $timeout

Symfony\Component\Process\Process::$timeout

private

Definition at line 59 of file Process.php.

Referenced by Symfony\Component\Process\Process\__construct(), Symfony\Component\Process\PhpProcess\__construct(), Symfony\Component\Process\Process\getTimeout(), Symfony\Component\Process\Process\setIdleTimeout(), Symfony\Component\Process\Process\setTimeout(), Symfony\Component\Process\Process\stop(), and Symfony\Component\Process\Process\validateTimeout().

◆ $tty

Symfony\Component\Process\Process::$tty

private

Definition at line 74 of file Process.php.

Referenced by Symfony\Component\Process\Process\isTty(), and Symfony\Component\Process\Process\setTty().

◆ $useFileHandles

Symfony\Component\Process\Process::$useFileHandles = false

private

Definition at line 77 of file Process.php.

◆ ERR

const Symfony\Component\Process\Process::ERR = 'err'

Definition at line 32 of file Process.php.

Referenced by Symfony\Component\Process\Pipes\WindowsPipes\__construct(), and cweagans\Composer\Patches\executeCommand().

◆ ITER_KEEP_OUTPUT

const Symfony\Component\Process\Process::ITER_KEEP_OUTPUT = 2

Definition at line 47 of file Process.php.

◆ ITER_NON_BLOCKING

const Symfony\Component\Process\Process::ITER_NON_BLOCKING = 1

Definition at line 46 of file Process.php.

◆ ITER_SKIP_ERR

const Symfony\Component\Process\Process::ITER_SKIP_ERR = 8

Definition at line 49 of file Process.php.

◆ ITER_SKIP_OUT

const Symfony\Component\Process\Process::ITER_SKIP_OUT = 4

Definition at line 48 of file Process.php.

◆ OUT

const Symfony\Component\Process\Process::OUT = 'out'

Definition at line 33 of file Process.php.

Referenced by Symfony\Component\Process\Pipes\WindowsPipes\__construct(), and Symfony\Component\Process\Process\buildCallback().

◆ STATUS_READY

const Symfony\Component\Process\Process::STATUS_READY = 'ready'

Definition at line 35 of file Process.php.

Referenced by Symfony\Component\Process\Process\isStarted(), Symfony\Component\Process\Process\resetProcessData(), and Symfony\Component\Process\Tests\ProcessTest\testStatus().

◆ STATUS_STARTED

const Symfony\Component\Process\Process::STATUS_STARTED = 'started'

Definition at line 36 of file Process.php.

Referenced by Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Tests\ProcessTest\testStatus().

◆ STATUS_TERMINATED

const Symfony\Component\Process\Process::STATUS_TERMINATED = 'terminated'

Definition at line 37 of file Process.php.

Referenced by Symfony\Component\Process\Process\close(), Symfony\Component\Process\Process\isTerminated(), Symfony\Component\Process\Tests\ProcessTest\testPTYCommand(), Symfony\Component\Process\Tests\ProcessTest\testStatus(), and Symfony\Component\Process\Tests\ProcessTest\testTTYCommand().

◆ STDERR

const Symfony\Component\Process\Process::STDERR = 2

Definition at line 41 of file Process.php.

Referenced by Symfony\Component\Process\Pipes\WindowsPipes\__construct().

◆ STDIN

const Symfony\Component\Process\Process::STDIN = 0

Definition at line 39 of file Process.php.

◆ STDOUT

const Symfony\Component\Process\Process::STDOUT = 1

Definition at line 40 of file Process.php.

Referenced by Symfony\Component\Process\Pipes\WindowsPipes\__construct().

◆ TIMEOUT_PRECISION

const Symfony\Component\Process\Process::TIMEOUT_PRECISION = 0.2

Definition at line 44 of file Process.php.

Referenced by Symfony\Component\Process\Pipes\UnixPipes\readAndWrite(), and Symfony\Component\Process\Pipes\WindowsPipes\readAndWrite().

The documentation for this class was generated from the following file:

libs/composer/vendor/symfony/process/Process.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

◆ __destruct()

Member Function Documentation

◆ __clone()

◆ addErrorOutput()

◆ addOutput()

◆ buildCallback()

◆ checkTimeout()

◆ clearErrorOutput()

◆ clearOutput()

◆ close()

◆ disableOutput()

◆ doSignal()

◆ enableOutput()

◆ getCommandLine()

◆ getDescriptors()

◆ getEnhanceSigchildCompatibility()

◆ getEnhanceWindowsCompatibility()

◆ getEnv()

◆ getErrorOutput()

◆ getExitCode()

◆ getExitCodeText()

◆ getIdleTimeout()

◆ getIncrementalErrorOutput()

◆ getIncrementalOutput()

◆ getInput()

◆ getIterator()

◆ getOptions()

◆ getOutput()

◆ getPid()

◆ getStatus()

◆ getStopSignal()

◆ getTermSignal()

◆ getTimeout()

◆ getWorkingDirectory()

◆ hasBeenSignaled()

◆ hasBeenStopped()

◆ isOutputDisabled()

◆ isPty()

◆ isPtySupported()

◆ isRunning()

◆ isSigchildEnabled()

◆ isStarted()

◆ isSuccessful()

◆ isTerminated()

◆ isTty()

◆ mustRun()

◆ readPipes()

◆ readPipesForOutput()

◆ requireProcessIsStarted()

◆ requireProcessIsTerminated()

◆ resetProcessData()

◆ restart()

◆ run()

◆ setCommandLine()

◆ setEnhanceSigchildCompatibility()

◆ setEnhanceWindowsCompatibility()

◆ setEnv()

◆ setIdleTimeout()

◆ setInput()

◆ setOptions()

◆ setPty()

◆ setTimeout()

◆ setTty()

◆ setWorkingDirectory()

◆ signal()

◆ start()

◆ stop()

◆ updateStatus()

◆ validateTimeout()