class ExecutableFinder

Generic executable finder.

@author Fabien Potencier <fabien@symfony.com> @author Johannes M. Schmitt <schmittjoh@gmail.com>

Hierarchy

Expanded class hierarchy of ExecutableFinder

File

drupal/core/vendor/symfony/process/Symfony/Component/Process/ExecutableFinder.php, line 20

Namespace

Symfony\Component\Process
View source
class ExecutableFinder {
  private $suffixes = array(
    '.exe',
    '.bat',
    '.cmd',
    '.com',
  );

  /**
   * Replaces default suffixes of executable.
   *
   * @param array $suffixes
   */
  public function setSuffixes(array $suffixes) {
    $this->suffixes = $suffixes;
  }

  /**
   * Adds new possible suffix to check for executable.
   *
   * @param string $suffix
   */
  public function addSuffix($suffix) {
    $this->suffixes[] = $suffix;
  }

  /**
   * Finds an executable by name.
   *
   * @param string $name      The executable name (without the extension)
   * @param string $default   The default to return if no executable is found
   * @param array  $extraDirs Additional dirs to check into
   *
   * @return string The executable path or default value
   */
  public function find($name, $default = null, array $extraDirs = array()) {
    if (ini_get('open_basedir')) {
      $searchPath = explode(PATH_SEPARATOR, getenv('open_basedir'));
      $dirs = array();
      foreach ($searchPath as $path) {
        if (is_dir($path)) {
          $dirs[] = $path;
        }
        else {
          $file = str_replace(dirname($path), '', $path);
          if ($file == $name && is_executable($path)) {
            return $path;
          }
        }
      }
    }
    else {
      $dirs = array_merge(explode(PATH_SEPARATOR, getenv('PATH') ?: getenv('Path')), $extraDirs);
    }
    $suffixes = array(
      '',
    );
    if (defined('PHP_WINDOWS_VERSION_BUILD')) {
      $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) && (defined('PHP_WINDOWS_VERSION_BUILD') || is_executable($file))) {
          return $file;
        }
      }
    }
    return $default;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ExecutableFinder::$suffixes private property
ExecutableFinder::addSuffix public function Adds new possible suffix to check for executable.
ExecutableFinder::find public function Finds an executable by name.
ExecutableFinder::setSuffixes public function Replaces default suffixes of executable.