Symfony\Component\Process\ProcessUtils Class Reference

ProcessUtils is a bunch of utility methods. More...

Collaboration diagram for Symfony\Component\Process\ProcessUtils:

Static Public Member Functions
static	escapeArgument ($argument)
	Escapes a string to be used as a shell argument. More...
static	validateInput ($caller, $input)
	Validates and normalizes a Process input. More...

Private Member Functions
	__construct ()
	This class should not be instantiated. More...

Static Private Member Functions
static	isSurroundedBy ($arg, $char)

Detailed Description

ProcessUtils is a bunch of utility methods.

This class contains static methods only and is not meant to be instantiated.

Author

Martin Hasoň marti.nosp@m.n.ha.nosp@m.son@g.nosp@m.mail.nosp@m..com

Definition at line 23 of file ProcessUtils.php.

Constructor & Destructor Documentation

__construct()

Symfony\Component\Process\ProcessUtils::__construct ( )

private

This class should not be instantiated.

Definition at line 28 of file ProcessUtils.php.

    {
    }

Member Function Documentation

escapeArgument()

static Symfony\Component\Process\ProcessUtils::escapeArgument (   $argument )

static

Escapes a string to be used as a shell argument.

Parameters

string

$argument

The argument that will be escaped

Returns

string The escaped argument

Definition at line 39 of file ProcessUtils.php.

    {
        //Fix for PHP bug #43784 escapeshellarg removes % from given string
        //Fix for PHP bug #49446 escapeshellarg doesn't work on Windows
        //@see https://bugs.php.net/bug.php?id=43784
        //@see https://bugs.php.net/bug.php?id=49446
        if ('\\' === DIRECTORY_SEPARATOR) {
            if ('' === $argument) {
                return escapeshellarg($argument);
            }
 
            $escapedArgument = '';
            $quote = false;
            foreach (preg_split('/(")/', $argument, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE) as $part) {
                if ('"' === $part) {
                    $escapedArgument .= '\\"';
                } elseif (self::isSurroundedBy($part, '%')) {
                    // Avoid environment variable expansion
                    $escapedArgument .= '^%"'.substr($part, 1, -1).'"^%';
                } else {
                    // escape trailing backslash
                    if ('\\' === substr($part, -1)) {
                        $part .= '\\';
                    }
                    $quote = true;
                    $escapedArgument .= $part;
                }
            }
            if ($quote) {
                $escapedArgument = '"'.$escapedArgument.'"';
            }
 
            return $escapedArgument;
        }
 
        return escapeshellarg($argument);
    }

References PREG_SPLIT_DELIM_CAPTURE.

Referenced by Symfony\Component\Process\Process\start(), and Symfony\Component\Process\Tests\ProcessUtilsTest\testEscapeArgument().

Here is the caller graph for this function:

isSurroundedBy()

static Symfony\Component\Process\ProcessUtils::isSurroundedBy (   $arg,   $char  )

staticprivate

Definition at line 115 of file ProcessUtils.php.

    {
        return 2 < strlen($arg) && $char === $arg[0] && $char === $arg[strlen($arg) - 1];
    }

validateInput()

static Symfony\Component\Process\ProcessUtils::validateInput (   $caller,   $input  )

static

Validates and normalizes a Process input.

Parameters

string	$caller	The name of method call that validates the input
mixed	$input	The input to validate

Returns

mixed The validated input

Exceptions

InvalidArgumentException

In case the input is not valid

Definition at line 87 of file ProcessUtils.php.

    {
        if (null !== $input) {
            if (is_resource($input)) {
                return $input;
            }
            if (is_string($input)) {
                return $input;
            }
            if (is_scalar($input)) {
                return (string) $input;
            }
            if ($input instanceof Process) {
                return $input->getIterator($input::ITER_SKIP_ERR);
            }
            if ($input instanceof \Iterator) {
                return $input;
            }
            if ($input instanceof \Traversable) {
                return new \IteratorIterator($input);
            }
 
            throw new InvalidArgumentException(sprintf('%s only accepts strings, Traversable objects or stream resources.', $caller));
        }
 
        return $input;
    }

References sprintf.

Referenced by Symfony\Component\Process\Process\setInput(), Symfony\Component\Process\ProcessBuilder\setInput(), and Symfony\Component\Process\InputStream\write().

Here is the caller graph for this function:

---

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

• libs/composer/vendor/symfony/process/ProcessUtils.php