Symfony\Component\Process\ExecutableFinder Class Reference

Generic executable finder. More...

Collaboration diagram for Symfony\Component\Process\ExecutableFinder:

Public Member Functions
	setSuffixes (array $suffixes)
	Replaces default suffixes of executable. More...
	addSuffix ($suffix)
	Adds new possible suffix to check for executable. More...
	find ($name, $default=null, array $extraDirs=array())
	Finds an executable by name. More...

Private Attributes
	$suffixes = array('.exe', '.bat', '.cmd', '.com')

Detailed Description

Generic executable finder.

Author

Fabien Potencier fabie.nosp@m.n@sy.nosp@m.mfony.nosp@m..com

Johannes M. Schmitt schmi.nosp@m.ttjo.nosp@m.h@gma.nosp@m.il.c.nosp@m.om

Definition at line 20 of file ExecutableFinder.php.

Member Function Documentation

addSuffix()

Symfony\Component\Process\ExecutableFinder::addSuffix

(

$suffix

)

Adds new possible suffix to check for executable.

Parameters

string

$suffix

Definition at line 39 of file ExecutableFinder.php.

    {
        $this->suffixes[] = $suffix;
    }

find()

Symfony\Component\Process\ExecutableFinder::find	(		$name,
			$default = null,
		array	$extraDirs = array()
	)

Finds an executable by name.

Parameters

string	$name	The executable name (without the extension)
string	$default	The default to return if no executable is found
array	$extraDirs	Additional dirs to check into

Returns

string The executable path or default value

Definition at line 53 of file ExecutableFinder.php.

References $file, $path, Symfony\Component\Process\ExecutableFinder\$suffixes, and array.

    {
        if (ini_get('open_basedir')) {
            $searchPath = explode(PATH_SEPARATOR, ini_get('open_basedir'));
            $dirs = array();
            foreach ($searchPath as $path) {
                // Silencing against https://bugs.php.net/69240
                if (@is_dir($path)) {
                    $dirs[] = $path;
                } else {
                    if (basename($path) == $name && is_executable($path)) {
                        return $path;
                    }
                }
            }
        } else {
            $dirs = array_merge(
                explode(PATH_SEPARATOR, getenv('PATH') ?: getenv('Path')),
                $extraDirs
            );
        }

        $suffixes = array('');
        if ('\\' === DIRECTORY_SEPARATOR) {
            $pathExt = getenv('PATHEXT');
            $suffixes = $pathExt ? explode(PATH_SEPARATOR, $pathExt) : $this->suffixes;
        }
        foreach ($suffixes as $suffix) {
            foreach ($dirs as $dir) {
                if (is_file($file = $dir.DIRECTORY_SEPARATOR.$name.$suffix) && ('\\' === DIRECTORY_SEPARATOR || is_executable($file))) {
                    return $file;
                }
            }
        }

        return $default;
    }

setSuffixes()

Symfony\Component\Process\ExecutableFinder::setSuffixes

(

array

$suffixes

)

Replaces default suffixes of executable.

Parameters

array

$suffixes

Definition at line 29 of file ExecutableFinder.php.

References Symfony\Component\Process\ExecutableFinder\$suffixes.

    {
        $this->suffixes = $suffixes;
    }

Field Documentation

$suffixes

Symfony\Component\Process\ExecutableFinder::$suffixes = array('.exe', '.bat', '.cmd', '.com')

private

Definition at line 22 of file ExecutableFinder.php.

Referenced by Symfony\Component\Process\ExecutableFinder\find(), and Symfony\Component\Process\ExecutableFinder\setSuffixes().

---

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

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