SugiPHP\Config\FileLocator

Complexity

Total Complexity

17

Size/Duplication

Total Lines	130
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	8
Bugs	1	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
B	locate()	0	19	6
A	addPath()	0	7	2
A	popPath()	0	4	1
A	prependPath()	0	4	1
A	unshiftPath()	0	4	1
A	shiftPath()	0	4	1
A	getPaths()	0	4	1
A	isFullPath()	0	14	3

<?php
/**
 * File locater
 *
 * @package SugiPHP.Config
 * @author  Plamen Popov <tzappa@gmail.com>
 * @license http://opensource.org/licenses/mit-license.php (MIT License)
 */

namespace SugiPHP\Config;

/**
 * File Locator searches for a file in registered search paths.
 */
class FileLocator implements LocatorInterface
{
    /**
     * Search for a file in one or more directories.
     * @var array
     */
    protected $paths;

    /**
     * File Locator creator.
     *
     * @param array|string $paths
     *
     * @return void

Adding a @return annotation to constructors is generally not recommended as a constructor does not have a meaningful return value.

     */
    public function __construct($paths)
    {
        $this->addPath($paths);
    }

    /**
     * {@inheritdoc}
     */
    public function locate($resource)
    {
        // empty string
        if (empty($resource)) {
            return ;
        }
        if ($this->isFullPath($resource)) {
            if (is_file($resource)) {
                return $resource;
            }
        } else {
            foreach ($this->paths as $path) {
                $file = "{$path}{$resource}";
                if (is_file($file)) {
                    return $file;
                }
            }
        }
    }

    /**
     * Adds a search paths.
     *
     * @param string|array $path or several paths
     *
     * @return void
     */
    public function addPath($path)
    {
        $paths = (array) $path;
        foreach ($paths as $path) {
            $this->paths[] = rtrim($path, "\\/") . DIRECTORY_SEPARATOR;
        }
    }

    /**
     * Remove last search path.
     *
     * @return void
     */
    public function popPath()
    {
        array_pop($this->paths);
    }

    /**
     * @deprecated Use unshiftPath() method
     */
    public function prependPath($path)
    {
        return $this->unshiftPath($path);
    }

    /**
     * Prepends one path to the beginning of the search paths.
     *
     * @param string $path
     *
     * @return void
     */
    public function unshiftPath($path)
    {
        array_unshift($this->paths, rtrim($path, "\\/") . DIRECTORY_SEPARATOR);
    }

    /**
     * Remove first path from the search paths.
     *
     * @return void
     */
    public function shiftPath()
    {
        array_shift($this->paths);
    }

    /**
     * Returns all registered search paths.
     *
     * @return array
     */
    public function getPaths()
    {
        return $this->paths;
    }

    /**
     * Check if the file/path is given with absolute path.
     *
     * @param string $path
     *
     * @return bool
     */
    protected function isFullPath($path)
    {
        // *nix style
        if ($path[0] == "/") {
            return true;
        }

        // windows style
        if (preg_match("#[A-Z]:\\.+#U", $path)) {
            return true;
        }

        return false;
    }
}