brightnucleus / view

src/View/Support/AbstractFinder.php

Indentation +205 added lines, -205 removed lines

@@ -27,209 +27,209 @@
 abstract class AbstractFinder implements FinderInterface
 {
 
-    use ConfigTrait;
-
-    /**
-     * Findable collection that the Finder can iterate through to find a match.
-     *
-     * @since 0.1.0
-     *
-     * @var FindableCollection
-     */
-    protected $findables;
-
-    /**
-     * NullObject that is returned if the Finder could not find a match.
-     *
-     * @since 0.1.0
-     *
-     * @var NullFindable
-     */
-    protected $nullObject;
-
-    /**
-     * Instantiate an AbstractFinder object.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface $config Configuration of the AbstractFinder.
-     *
-     * @throws FailedToProcessConfigException If the config could not be processed.
-     */
-    public function __construct(ConfigInterface $config)
-    {
-        $this->processConfig($config);
-        $this->findables = new FindableCollection();
-        $this->registerFindables($this->config);
-        $this->registerNullObject($this->config);
-    }
-
-    /**
-     * Register the Findables defined in the given configuration.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface $config Configuration to register the Findables from.
-     */
-    public function registerFindables(ConfigInterface $config)
-    {
-        foreach ($config->getKey($this->getFindablesConfigKey()) as $findableKey => $findableObject) {
-            $this->findables->set($findableKey, $findableObject);
-        }
-    }
-
-    /**
-     * Register the NullObject defined in the given configuration.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface $config Configuration to register the NullObject from.
-     */
-    public function registerNullObject(ConfigInterface $config)
-    {
-        $this->nullObject = $config->getKey($this->getNullObjectConfigKey());
-    }
-
-    /**
-     * Get the NullObject.
-     *
-     * @since 0.1.1
-     *
-     * @return NullFindable NullObject for the current Finder.
-     */
-    public function getNullObject()
-    {
-        $this->initializeNullObject();
-
-        return $this->nullObject;
-    }
-
-    /**
-     * Get the config key for the Findables definitions.
-     *
-     * @since 0.1.0
-     *
-     * @return string Config key use to define the Findables.
-     */
-    protected function getFindablesConfigKey()
-    {
-        return 'Findables';
-    }
-
-    /**
-     * Get the config key for the NullObject definitions.
-     *
-     * @since 0.1.0
-     *
-     * @return string Config key use to define the NullObject.
-     */
-    protected function getNullObjectConfigKey()
-    {
-        return 'NullObject';
-    }
-
-    /**
-     * Initialize the NullObject.
-     *
-     * @since 0.1.1
-     *
-     * @param mixed $arguments Optional. Arguments to use.
-     */
-    protected function initializeNullObject($arguments = null)
-    {
-        $this->nullObject = $this->maybeInstantiateFindable($this->nullObject, $arguments);
-    }
-
-    /**
-     * Initialize the Findables that can be iterated.
-     *
-     * @param mixed $arguments Optional. Arguments to use.
-     *
-     * @since 0.1.0
-     *
-     */
-    protected function initializeFindables($arguments = null)
-    {
-        $this->findables = $this->findables->map(function ($findable) use ($arguments) {
-            return $this->initializeFindable($findable, $arguments);
-        });
-    }
-
-    /**
-     * Initialize a single findable by instantiating class name strings and calling closures.
-     *
-     * @since 0.1.0
-     *
-     * @param mixed $findable  Findable to instantiate.
-     * @param mixed $arguments Optional. Arguments to use.
-     *
-     * @return Findable Instantiated findable.
-     */
-    protected function initializeFindable($findable, $arguments = null)
-    {
-        return $this->maybeInstantiateFindable($findable, $arguments);
-    }
-
-    /**
-     * Maybe instantiate a Findable if it is not yet an object.
-     *
-     * @since 0.1.1
-     *
-     * @param mixed $findable  Findable to instantiate.
-     * @param mixed $arguments Optional. Arguments to use.
-     *
-     * @return Findable Instantiated findable.
-     * @throws FailedToInstantiateFindableException If the findable could not be instantiated.
-     */
-    protected function maybeInstantiateFindable($findable, $arguments = null)
-    {
-        if (is_string($findable)) {
-            $findable = $this->instantiateFindableFromString($findable, $arguments);
-        }
-
-        if (is_callable($findable)) {
-            $findable = $this->instantiateFindableFromCallable($findable, $arguments);
-        }
-
-        if (! $findable instanceof Findable) {
-            throw new FailedToInstantiateFindableException(
-                sprintf(
-                    _('Could not instantiate Findable "%s".'),
-                    serialize($findable)
-                )
-            );
-        }
-
-        return $findable;
-    }
-
-    /**
-     * Instantiate a Findable from a string.
-     *
-     * @since 0.1.1
-     *
-     * @param string $string    String to use for instantiation.
-     * @param mixed  $arguments Optional. Arguments to use for instantiation.
-     *
-     * @return Findable Instantiated Findable.
-     */
-    protected function instantiateFindableFromString($string, $arguments = null)
-    {
-        return new $string(...$arguments);
-    }
-
-    /**
-     * Instantiate a Findable from a callable.
-     *
-     * @since 0.1.1
-     *
-     * @param callable $callable  Callable to use for instantiation.
-     * @param mixed    $arguments Optional. Arguments to use for instantiation.
-     *
-     * @return Findable Instantiated Findable.
-     */
-    protected function instantiateFindableFromCallable($callable, $arguments = null)
-    {
-        return $callable(...$arguments);
-    }
+	use ConfigTrait;
+
+	/**
+	 * Findable collection that the Finder can iterate through to find a match.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var FindableCollection
+	 */
+	protected $findables;
+
+	/**
+	 * NullObject that is returned if the Finder could not find a match.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var NullFindable
+	 */
+	protected $nullObject;
+
+	/**
+	 * Instantiate an AbstractFinder object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface $config Configuration of the AbstractFinder.
+	 *
+	 * @throws FailedToProcessConfigException If the config could not be processed.
+	 */
+	public function __construct(ConfigInterface $config)
+	{
+		$this->processConfig($config);
+		$this->findables = new FindableCollection();
+		$this->registerFindables($this->config);
+		$this->registerNullObject($this->config);
+	}
+
+	/**
+	 * Register the Findables defined in the given configuration.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface $config Configuration to register the Findables from.
+	 */
+	public function registerFindables(ConfigInterface $config)
+	{
+		foreach ($config->getKey($this->getFindablesConfigKey()) as $findableKey => $findableObject) {
+			$this->findables->set($findableKey, $findableObject);
+		}
+	}
+
+	/**
+	 * Register the NullObject defined in the given configuration.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface $config Configuration to register the NullObject from.
+	 */
+	public function registerNullObject(ConfigInterface $config)
+	{
+		$this->nullObject = $config->getKey($this->getNullObjectConfigKey());
+	}
+
+	/**
+	 * Get the NullObject.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @return NullFindable NullObject for the current Finder.
+	 */
+	public function getNullObject()
+	{
+		$this->initializeNullObject();
+
+		return $this->nullObject;
+	}
+
+	/**
+	 * Get the config key for the Findables definitions.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return string Config key use to define the Findables.
+	 */
+	protected function getFindablesConfigKey()
+	{
+		return 'Findables';
+	}
+
+	/**
+	 * Get the config key for the NullObject definitions.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return string Config key use to define the NullObject.
+	 */
+	protected function getNullObjectConfigKey()
+	{
+		return 'NullObject';
+	}
+
+	/**
+	 * Initialize the NullObject.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param mixed $arguments Optional. Arguments to use.
+	 */
+	protected function initializeNullObject($arguments = null)
+	{
+		$this->nullObject = $this->maybeInstantiateFindable($this->nullObject, $arguments);
+	}
+
+	/**
+	 * Initialize the Findables that can be iterated.
+	 *
+	 * @param mixed $arguments Optional. Arguments to use.
+	 *
+	 * @since 0.1.0
+	 *
+	 */
+	protected function initializeFindables($arguments = null)
+	{
+		$this->findables = $this->findables->map(function ($findable) use ($arguments) {
+			return $this->initializeFindable($findable, $arguments);
+		});
+	}
+
+	/**
+	 * Initialize a single findable by instantiating class name strings and calling closures.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed $findable  Findable to instantiate.
+	 * @param mixed $arguments Optional. Arguments to use.
+	 *
+	 * @return Findable Instantiated findable.
+	 */
+	protected function initializeFindable($findable, $arguments = null)
+	{
+		return $this->maybeInstantiateFindable($findable, $arguments);
+	}
+
+	/**
+	 * Maybe instantiate a Findable if it is not yet an object.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param mixed $findable  Findable to instantiate.
+	 * @param mixed $arguments Optional. Arguments to use.
+	 *
+	 * @return Findable Instantiated findable.
+	 * @throws FailedToInstantiateFindableException If the findable could not be instantiated.
+	 */
+	protected function maybeInstantiateFindable($findable, $arguments = null)
+	{
+		if (is_string($findable)) {
+			$findable = $this->instantiateFindableFromString($findable, $arguments);
+		}
+
+		if (is_callable($findable)) {
+			$findable = $this->instantiateFindableFromCallable($findable, $arguments);
+		}
+
+		if (! $findable instanceof Findable) {
+			throw new FailedToInstantiateFindableException(
+				sprintf(
+					_('Could not instantiate Findable "%s".'),
+					serialize($findable)
+				)
+			);
+		}
+
+		return $findable;
+	}
+
+	/**
+	 * Instantiate a Findable from a string.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param string $string    String to use for instantiation.
+	 * @param mixed  $arguments Optional. Arguments to use for instantiation.
+	 *
+	 * @return Findable Instantiated Findable.
+	 */
+	protected function instantiateFindableFromString($string, $arguments = null)
+	{
+		return new $string(...$arguments);
+	}
+
+	/**
+	 * Instantiate a Findable from a callable.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param callable $callable  Callable to use for instantiation.
+	 * @param mixed    $arguments Optional. Arguments to use for instantiation.
+	 *
+	 * @return Findable Instantiated Findable.
+	 */
+	protected function instantiateFindableFromCallable($callable, $arguments = null)
+	{
+		return $callable(...$arguments);
+	}
 }

src/View/Location/FilesystemLocation.php

Indentation +146 added lines, -146 removed lines

@@ -25,150 +25,150 @@
 class FilesystemLocation implements LocationInterface
 {
 
-    /**
-     * Path that this location points to.
-     *
-     * @since 0.1.0
-     *
-     * @var string
-     */
-    protected $path;
-
-    /**
-     * Extensions that this location can accept.
-     *
-     * @since 0.1.0
-     *
-     * @var ExtensionCollection
-     */
-    protected $extensions;
-
-    /**
-     * Instantiate a FilesystemLocation object.
-     *
-     * @since 0.1.0
-     *
-     * @param string                                $path       Path that this location points to.
-     * @param ExtensionCollection|array|string|null $extensions Optional. Extensions that this location can accept.
-     */
-    public function __construct($path, $extensions = null)
-    {
-        $this->path       = $path;
-        $this->extensions = $this->validateExtensions($extensions);
-    }
-
-    /**
-     * Get the first URI that matches the given criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array $criteria Criteria to match.
-     *
-     * @return string|false URI that matches the criteria or false if none found.
-     */
-    public function getURI(array $criteria)
-    {
-        foreach ($criteria as $entry) {
-            if ($uri = $this->transform($entry, true)) {
-                return $uri;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * Get all URIs that match the given criteria.
-     *
-     * @since 0.1.1
-     *
-     * @param array $criteria Criteria to match.
-     *
-     * @return array URIs that match the criteria or empty array if none found.
-     */
-    public function getURIs(array $criteria)
-    {
-        $uris = [];
-
-        foreach ($criteria as $entry) {
-            if ($uri = $this->transform($entry, false)) {
-                $uris = array_merge($uris, (array)$uri);
-            }
-        }
-
-        return $uris;
-    }
-
-    /**
-     * Validate the extensions and return a collection.
-     *
-     * @since 0.1.1
-     *
-     * @param ExtensionCollection|array|string|null $extensions Extensions to validate.
-     *
-     * @return ExtensionCollection Validated extensions collection.
-     */
-    protected function validateExtensions($extensions)
-    {
-        if (! $extensions instanceof ExtensionCollection) {
-            $extensions = new ExtensionCollection((array)$extensions);
-        }
-        $extensions->add('');
-
-        return $extensions;
-    }
-
-    /**
-     * Try to transform the entry into possible URIs.
-     *
-     * @since 0.1.0
-     *
-     * @param string $entry     Entry to transform.
-     * @param bool   $firstOnly Return the first result only.
-     *
-     * @return array|string|false If $firstOnly is true, returns a string with the URI of the view, or false if none
-     *                            found.
-     *                            If $firstOnly is false, returns an array with all matching URIs, or an empty array if
-     *                            none found.
-     */
-    protected function transform($entry, $firstOnly = true)
-    {
-        $uris = [];
-
-        try {
-            foreach ($this->getVariants($entry) as $uri) {
-                if (is_readable($uri)) {
-                    if ($firstOnly) {
-                        return $uri;
-                    }
-                    $uris [] = $uri;
-                }
-            }
-        } catch (Exception $exception) {
-            // Fail silently.
-        }
-
-        return $firstOnly ? false : $uris;
-    }
-
-    /**
-     * Get the individual variants that could be matched for the location.
-     *
-     * @since 0.1.1
-     *
-     * @param string $entry Entry to get the variants for.
-     *
-     * @return array Array of variants to check.
-     */
-    protected function getVariants($entry)
-    {
-        $variants = [];
-
-        $this->extensions->map(function ($extension) use ($entry, &$variants) {
-            $variants[] = $entry . $extension;
-            $variants[] = $this->path . DIRECTORY_SEPARATOR . $entry . $extension;
-        });
-
-        return $variants;
-    }
+	/**
+	 * Path that this location points to.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var string
+	 */
+	protected $path;
+
+	/**
+	 * Extensions that this location can accept.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var ExtensionCollection
+	 */
+	protected $extensions;
+
+	/**
+	 * Instantiate a FilesystemLocation object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string                                $path       Path that this location points to.
+	 * @param ExtensionCollection|array|string|null $extensions Optional. Extensions that this location can accept.
+	 */
+	public function __construct($path, $extensions = null)
+	{
+		$this->path       = $path;
+		$this->extensions = $this->validateExtensions($extensions);
+	}
+
+	/**
+	 * Get the first URI that matches the given criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $criteria Criteria to match.
+	 *
+	 * @return string|false URI that matches the criteria or false if none found.
+	 */
+	public function getURI(array $criteria)
+	{
+		foreach ($criteria as $entry) {
+			if ($uri = $this->transform($entry, true)) {
+				return $uri;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * Get all URIs that match the given criteria.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param array $criteria Criteria to match.
+	 *
+	 * @return array URIs that match the criteria or empty array if none found.
+	 */
+	public function getURIs(array $criteria)
+	{
+		$uris = [];
+
+		foreach ($criteria as $entry) {
+			if ($uri = $this->transform($entry, false)) {
+				$uris = array_merge($uris, (array)$uri);
+			}
+		}
+
+		return $uris;
+	}
+
+	/**
+	 * Validate the extensions and return a collection.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param ExtensionCollection|array|string|null $extensions Extensions to validate.
+	 *
+	 * @return ExtensionCollection Validated extensions collection.
+	 */
+	protected function validateExtensions($extensions)
+	{
+		if (! $extensions instanceof ExtensionCollection) {
+			$extensions = new ExtensionCollection((array)$extensions);
+		}
+		$extensions->add('');
+
+		return $extensions;
+	}
+
+	/**
+	 * Try to transform the entry into possible URIs.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $entry     Entry to transform.
+	 * @param bool   $firstOnly Return the first result only.
+	 *
+	 * @return array|string|false If $firstOnly is true, returns a string with the URI of the view, or false if none
+	 *                            found.
+	 *                            If $firstOnly is false, returns an array with all matching URIs, or an empty array if
+	 *                            none found.
+	 */
+	protected function transform($entry, $firstOnly = true)
+	{
+		$uris = [];
+
+		try {
+			foreach ($this->getVariants($entry) as $uri) {
+				if (is_readable($uri)) {
+					if ($firstOnly) {
+						return $uri;
+					}
+					$uris [] = $uri;
+				}
+			}
+		} catch (Exception $exception) {
+			// Fail silently.
+		}
+
+		return $firstOnly ? false : $uris;
+	}
+
+	/**
+	 * Get the individual variants that could be matched for the location.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param string $entry Entry to get the variants for.
+	 *
+	 * @return array Array of variants to check.
+	 */
+	protected function getVariants($entry)
+	{
+		$variants = [];
+
+		$this->extensions->map(function ($extension) use ($entry, &$variants) {
+			$variants[] = $entry . $extension;
+			$variants[] = $this->path . DIRECTORY_SEPARATOR . $entry . $extension;
+		});
+
+		return $variants;
+	}
 }