Nubs\Which\Locator

Complexity

Total Complexity

5

Size/Duplication

Total Lines	52
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	2
A	locate()	0	6	2
A	locateAll()	0	4	1

<?php
namespace Nubs\Which;

use Nubs\Which\PathBuilder\PathBuilderInterface;

/**
 * Provides the ability to locate commands in the user's PATH.
 */
class Locator
{
    /** @type \Nubs\Which\PathBuilder\PathBuilderInterface The path builder. */
    private $_pathBuilder;

    /** @type callable The executable tester. */
    private $_executableTester;

    /**
     * Initialize the locator.
     *
     * @api
     * @param \Nubs\Which\PathBuilder\PathBuilderInterface $pathBuilder The path
     *     builder.
     * @param callable $executableTester The executable tester, a callable that
     *     is passed a file path and should return true for an executable
     *     command, false otherwise.  Defaults to the invokable
     *     \Nubs\Which\ExecutableTester.
     */
    public function __construct(PathBuilderInterface $pathBuilder, callable $executableTester = null)
    {
        $this->_pathBuilder = $pathBuilder;
        $this->_executableTester = $executableTester ?: new ExecutableTester();
    }

    /**
     * Locates the given command in the user's path.
     *
     * @api
     * @param string $command The command to locate.
     * @return string|null The full path to the command or null if not path
     *     found.
     */
    public function locate($command)
    {
        $paths = $this->locateAll($command);

        return empty($paths) ? null : $paths[0];
    }

    /**
     * Locates all versions of the given command in the user's path.
     *
     * @api
     * @param string $command The command to locate.
     * @return array The locations where the command exists.
     */
    public function locateAll($command)
    {
        return array_values(array_filter($this->_pathBuilder->getPermutations($command), $this->_executableTester));
    }
}