brightnucleus / view

src/View/ViewBuilder.php

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      * @since 0.1.0
      *
      * @param string $view View identifier to create a view for.
-     * @param mixed  $type Type of view to create.
+     * @param string|null  $type Type of view to create.
      *
      * @return ViewInterface Instance of the requested view.
      */
@@ -190,7 +190,7 @@ 
      *
      * @since 0.1.0
      *
-     * @param array $criteria Criteria to match.
+     * @param string[] $criteria Criteria to match.
      *
      * @return string|false URI of the requested view, or false if not found.
      */

Indentation +213 added lines, -213 removed lines

@@ -34,241 +34,241 @@
 class ViewBuilder
 {
 
-    use ConfigTrait;
+	use ConfigTrait;
 
-    const ENGINE_FINDER_KEY = 'EngineFinder';
-    const VIEW_FINDER_KEY   = 'ViewFinder';
+	const ENGINE_FINDER_KEY = 'EngineFinder';
+	const VIEW_FINDER_KEY   = 'ViewFinder';
 
-    /**
-     * ViewFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @var ViewFinderInterface
-     */
-    protected $viewFinder;
+	/**
+	 * ViewFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var ViewFinderInterface
+	 */
+	protected $viewFinder;
 
-    /**
-     * EngineFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @var EngineFinderInterface
-     */
-    protected $engineFinder;
+	/**
+	 * EngineFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var EngineFinderInterface
+	 */
+	protected $engineFinder;
 
-    /**
-     * Locations to scan for views.
-     *
-     * @since 0.1.0
-     *
-     * @var LocationCollection
-     */
-    protected $locations;
+	/**
+	 * Locations to scan for views.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var LocationCollection
+	 */
+	protected $locations;
 
-    /**
-     * Instantiate a ViewBuilder object.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface            $config       Configuration settings.
-     * @param ViewFinderInterface|null   $viewFinder   ViewFinder instance.
-     * @param EngineFinderInterface|null $engineFinder EngineFinder instance.
-     *
-     * @throws FailedToProcessConfigException If the config could not be processed.
-     */
-    public function __construct(
-        ConfigInterface $config,
-        ViewFinderInterface $viewFinder = null,
-        EngineFinderInterface $engineFinder = null
-    ) {
-        $this->processConfig($config);
-        $this->viewFinder   = $viewFinder;
-        $this->engineFinder = $engineFinder;
-        $this->locations    = new LocationCollection();
-    }
+	/**
+	 * Instantiate a ViewBuilder object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface            $config       Configuration settings.
+	 * @param ViewFinderInterface|null   $viewFinder   ViewFinder instance.
+	 * @param EngineFinderInterface|null $engineFinder EngineFinder instance.
+	 *
+	 * @throws FailedToProcessConfigException If the config could not be processed.
+	 */
+	public function __construct(
+		ConfigInterface $config,
+		ViewFinderInterface $viewFinder = null,
+		EngineFinderInterface $engineFinder = null
+	) {
+		$this->processConfig($config);
+		$this->viewFinder   = $viewFinder;
+		$this->engineFinder = $engineFinder;
+		$this->locations    = new LocationCollection();
+	}
 
-    /**
-     * Create a new view for a given URI.
-     *
-     * @since 0.1.0
-     *
-     * @param string $view View identifier to create a view for.
-     * @param mixed  $type Type of view to create.
-     *
-     * @return ViewInterface Instance of the requested view.
-     */
-    public function create($view, $type = null)
-    {
-        $uri    = $this->scanLocations([$view]);
-        $engine = $this->getEngine($uri);
+	/**
+	 * Create a new view for a given URI.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $view View identifier to create a view for.
+	 * @param mixed  $type Type of view to create.
+	 *
+	 * @return ViewInterface Instance of the requested view.
+	 */
+	public function create($view, $type = null)
+	{
+		$uri    = $this->scanLocations([$view]);
+		$engine = $this->getEngine($uri);
 
-        return $uri
-            ? $this->getView($uri, $engine, $type)
-            : $this->getViewFinder()->getNullObject();
-    }
+		return $uri
+			? $this->getView($uri, $engine, $type)
+			: $this->getViewFinder()->getNullObject();
+	}
 
-    /**
-     * Get an Engine that can deal with the given URI.
-     *
-     * @since 0.1.0
-     *
-     * @param string|false $uri URI to get an engine for.
-     *
-     * @return EngineInterface Instance of an engine that can deal with the given URI.
-     */
-    public function getEngine($uri)
-    {
-        return $this->getEngineFinder()->find([$uri]);
-    }
+	/**
+	 * Get an Engine that can deal with the given URI.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string|false $uri URI to get an engine for.
+	 *
+	 * @return EngineInterface Instance of an engine that can deal with the given URI.
+	 */
+	public function getEngine($uri)
+	{
+		return $this->getEngineFinder()->find([$uri]);
+	}
 
-    /**
-     * Get a view for a given URI, engine and type.
-     *
-     * @since 0.1.0
-     *
-     * @param string          $uri    URI to get a view for.
-     * @param EngineInterface $engine Engine to use for the view.
-     * @param mixed           $type   Type of view to get.
-     *
-     * @return ViewInterface View that matches the given requirements.
-     */
-    public function getView($uri, EngineInterface $engine, $type = null)
-    {
-        if (null === $type) {
-            return $this->getViewFinder()->find([$uri], $engine);
-        }
+	/**
+	 * Get a view for a given URI, engine and type.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string          $uri    URI to get a view for.
+	 * @param EngineInterface $engine Engine to use for the view.
+	 * @param mixed           $type   Type of view to get.
+	 *
+	 * @return ViewInterface View that matches the given requirements.
+	 */
+	public function getView($uri, EngineInterface $engine, $type = null)
+	{
+		if (null === $type) {
+			return $this->getViewFinder()->find([$uri], $engine);
+		}
 
-        return $this->resolveType($type, $uri, $engine);
-    }
+		return $this->resolveType($type, $uri, $engine);
+	}
 
-    /**
-     * Get the ViewFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return ViewFinderInterface Instance of a ViewFinder.
-     */
-    public function getViewFinder()
-    {
-        return $this->getFinder($this->viewFinder, static::VIEW_FINDER_KEY);
-    }
+	/**
+	 * Get the ViewFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return ViewFinderInterface Instance of a ViewFinder.
+	 */
+	public function getViewFinder()
+	{
+		return $this->getFinder($this->viewFinder, static::VIEW_FINDER_KEY);
+	}
 
-    /**
-     * Get the EngineFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return EngineFinderInterface Instance of a EngineFinder.
-     */
-    public function getEngineFinder()
-    {
-        return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY);
-    }
+	/**
+	 * Get the EngineFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return EngineFinderInterface Instance of a EngineFinder.
+	 */
+	public function getEngineFinder()
+	{
+		return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY);
+	}
 
-    /**
-     * Add a location to scan with the ViewFinder.
-     *
-     * @since 0.1.0
-     *
-     * @param LocationInterface $location Location to scan with the ViewFinder.
-     */
-    public function addLocation(LocationInterface $location)
-    {
-        $this->locations->add($location);
-    }
+	/**
+	 * Add a location to scan with the ViewFinder.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param LocationInterface $location Location to scan with the ViewFinder.
+	 */
+	public function addLocation(LocationInterface $location)
+	{
+		$this->locations->add($location);
+	}
 
-    /**
-     * Get the collection of locations registered with this ViewBuilder.
-     *
-     * @since 0.1.3
-     *
-     * @return LocationCollection Collection of locations.
-     */
-    public function getLocations()
-    {
-        return $this->locations;
-    }
+	/**
+	 * Get the collection of locations registered with this ViewBuilder.
+	 *
+	 * @since 0.1.3
+	 *
+	 * @return LocationCollection Collection of locations.
+	 */
+	public function getLocations()
+	{
+		return $this->locations;
+	}
 
-    /**
-     * Scan Locations for an URI that matches the specified criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array $criteria Criteria to match.
-     *
-     * @return string|false URI of the requested view, or false if not found.
-     */
-    public function scanLocations(array $criteria)
-    {
-        $uris = $this->locations->map(function ($location) use ($criteria) {
-            /** @var LocationInterface $location */
-            return $location->getURI($criteria);
-        })->filter(function ($uri) {
-            return false !== $uri;
-        });
+	/**
+	 * Scan Locations for an URI that matches the specified criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $criteria Criteria to match.
+	 *
+	 * @return string|false URI of the requested view, or false if not found.
+	 */
+	public function scanLocations(array $criteria)
+	{
+		$uris = $this->locations->map(function ($location) use ($criteria) {
+			/** @var LocationInterface $location */
+			return $location->getURI($criteria);
+		})->filter(function ($uri) {
+			return false !== $uri;
+		});
 
-        return $uris->count() > 0 ? $uris->first() : false;
-    }
+		return $uris->count() > 0 ? $uris->first() : false;
+	}
 
-    /**
-     * Get a finder instance.
-     *
-     * @since 0.1.1
-     *
-     * @param mixed  $property Property to use.
-     * @param string $key      Configuration key to use.
-     *
-     * @return FinderInterface The requested finder instance.
-     */
-    protected function getFinder(&$property, $key)
-    {
-        if (null === $property) {
-            $engineFinderClass = $this->config->getKey($key, 'ClassName');
-            $property          = new $engineFinderClass($this->config->getSubConfig($key));
-        }
+	/**
+	 * Get a finder instance.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param mixed  $property Property to use.
+	 * @param string $key      Configuration key to use.
+	 *
+	 * @return FinderInterface The requested finder instance.
+	 */
+	protected function getFinder(&$property, $key)
+	{
+		if (null === $property) {
+			$engineFinderClass = $this->config->getKey($key, 'ClassName');
+			$property          = new $engineFinderClass($this->config->getSubConfig($key));
+		}
 
-        return $property;
-    }
+		return $property;
+	}
 
-    /**
-     * Resolve the view type.
-     *
-     * @since 0.1.0
-     *
-     * @param mixed                $type   Type of view that was requested.
-     * @param string               $uri    URI to get a view for.
-     * @param EngineInterface|null $engine Engine to use for the view.
-     *
-     * @return ViewInterface Resolved View object.
-     * @throws FailedToInstantiateViewException If the view type could not be resolved.
-     */
-    protected function resolveType($type, $uri, EngineInterface $engine = null)
-    {
-        $configKey = [static::VIEW_FINDER_KEY, 'Views', $type];
+	/**
+	 * Resolve the view type.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed                $type   Type of view that was requested.
+	 * @param string               $uri    URI to get a view for.
+	 * @param EngineInterface|null $engine Engine to use for the view.
+	 *
+	 * @return ViewInterface Resolved View object.
+	 * @throws FailedToInstantiateViewException If the view type could not be resolved.
+	 */
+	protected function resolveType($type, $uri, EngineInterface $engine = null)
+	{
+		$configKey = [static::VIEW_FINDER_KEY, 'Views', $type];
 
-        if (is_string($type) && $this->config->hasKey($configKey)) {
-            $className = $this->config->getKey($configKey);
-            $type      = new $className($uri, $engine);
-        }
+		if (is_string($type) && $this->config->hasKey($configKey)) {
+			$className = $this->config->getKey($configKey);
+			$type      = new $className($uri, $engine);
+		}
 
-        if (is_string($type)) {
-            $type = new $type($uri, $engine);
-        }
+		if (is_string($type)) {
+			$type = new $type($uri, $engine);
+		}
 
-        if (is_callable($type)) {
-            $type = $type($uri, $engine);
-        }
+		if (is_callable($type)) {
+			$type = $type($uri, $engine);
+		}
 
-        if (! $type instanceof ViewInterface) {
-            throw new FailedToInstantiateViewException(
-                sprintf(
-                    _('Could not instantiate view "%s".'),
-                    serialize($type)
-                )
-            );
-        }
+		if (! $type instanceof ViewInterface) {
+			throw new FailedToInstantiateViewException(
+				sprintf(
+					_('Could not instantiate view "%s".'),
+					serialize($type)
+				)
+			);
+		}
 
-        return $type;
-    }
+		return $type;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -201,10 +201,10 @@ 
      */
     public function scanLocations(array $criteria)
     {
-        $uris = $this->locations->map(function ($location) use ($criteria) {
+        $uris = $this->locations->map(function($location) use ($criteria) {
             /** @var LocationInterface $location */
             return $location->getURI($criteria);
-        })->filter(function ($uri) {
+        })->filter(function($uri) {
             return false !== $uri;
         });
 
@@ -260,7 +260,7 @@ 
             $type = $type($uri, $engine);
         }
 
-        if (! $type instanceof ViewInterface) {
+        if ( ! $type instanceof ViewInterface) {
             throw new FailedToInstantiateViewException(
                 sprintf(
                     _('Could not instantiate view "%s".'),

src/View/View/NullView.php

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
      */
     public function render(array $context = [], $echo = false)
     {
-        if (! $echo) {
+        if ( ! $echo) {
             return '';
         }
     }

Indentation +29 added lines, -29 removed lines

@@ -25,34 +25,34 @@
 class NullView implements ViewInterface, NullObject, Findable
 {
 
-    /**
-     * Check whether the Findable can handle an individual criterion.
-     *
-     * @since 0.1.0
-     *
-     * @param mixed $criterion Criterion to check.
-     *
-     * @return bool Whether the Findable can handle the criterion.
-     */
-    public function canHandle($criterion)
-    {
-        return true;
-    }
+	/**
+	 * Check whether the Findable can handle an individual criterion.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param mixed $criterion Criterion to check.
+	 *
+	 * @return bool Whether the Findable can handle the criterion.
+	 */
+	public function canHandle($criterion)
+	{
+		return true;
+	}
 
-    /**
-     * Render the view.
-     *
-     * @since 0.1.0
-     *
-     * @param array $context Optional. The context in which to render the view.
-     * @param bool  $echo    Optional. Whether to echo the output immediately. Defaults to false.
-     *
-     * @return string|void Rendered HTML or nothing, depending on $echo argument.
-     */
-    public function render(array $context = [], $echo = false)
-    {
-        if (! $echo) {
-            return '';
-        }
-    }
+	/**
+	 * Render the view.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $context Optional. The context in which to render the view.
+	 * @param bool  $echo    Optional. Whether to echo the output immediately. Defaults to false.
+	 *
+	 * @return string|void Rendered HTML or nothing, depending on $echo argument.
+	 */
+	public function render(array $context = [], $echo = false)
+	{
+		if (! $echo) {
+			return '';
+		}
+	}
 }

src/View/View/ViewFinderInterface.php

Indentation +11 added lines, -11 removed lines

@@ -25,15 +25,15 @@
 interface ViewFinderInterface extends FinderInterface
 {
 
-    /**
-     * Find a result based on a specific criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array                $criteria Criteria to search for.
-     * @param EngineInterface|null $engine   Optional. Engine to use with the view.
-     *
-     * @return ViewInterface View that was found.
-     */
-    public function find(array $criteria, EngineInterface $engine = null);
+	/**
+	 * Find a result based on a specific criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array                $criteria Criteria to search for.
+	 * @param EngineInterface|null $engine   Optional. Engine to use with the view.
+	 *
+	 * @return ViewInterface View that was found.
+	 */
+	public function find(array $criteria, EngineInterface $engine = null);
 }

src/View/Engine/EngineFinder.php

Indentation +32 added lines, -32 removed lines

@@ -24,39 +24,39 @@
 class EngineFinder extends AbstractFinder
 {
 
-    /**
-     * Find a result based on a specific criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array $criteria Criteria to search for.
-     *
-     * @return EngineInterface Result of the search.
-     */
-    public function find(array $criteria)
-    {
-        $this->initializeFindables();
+	/**
+	 * Find a result based on a specific criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $criteria Criteria to search for.
+	 *
+	 * @return EngineInterface Result of the search.
+	 */
+	public function find(array $criteria)
+	{
+		$this->initializeFindables();
 
-        foreach ($criteria as $entry) {
-            foreach ($this->findables as $engine) {
-                if ($engine->canHandle($entry)) {
-                    return $engine;
-                }
-            }
-        }
+		foreach ($criteria as $entry) {
+			foreach ($this->findables as $engine) {
+				if ($engine->canHandle($entry)) {
+					return $engine;
+				}
+			}
+		}
 
-        return $this->getNullObject();
-    }
+		return $this->getNullObject();
+	}
 
-    /**
-     * 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 'Engines';
-    }
+	/**
+	 * 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 'Engines';
+	}
 }

src/View/View/ViewFinder.php

Indentation +34 added lines, -34 removed lines

@@ -25,42 +25,42 @@
 class ViewFinder extends AbstractFinder
 {
 
-    /**
-     * Find a result based on a specific criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array                $criteria Criteria to search for.
-     * @param EngineInterface|null $engine   Optional. Engine to use with the view.
-     *
-     * @return ViewInterface View that was found.
-     */
-    public function find(array $criteria, EngineInterface $engine = null)
-    {
-        $uri = $criteria[0];
+	/**
+	 * Find a result based on a specific criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array                $criteria Criteria to search for.
+	 * @param EngineInterface|null $engine   Optional. Engine to use with the view.
+	 *
+	 * @return ViewInterface View that was found.
+	 */
+	public function find(array $criteria, EngineInterface $engine = null)
+	{
+		$uri = $criteria[0];
 
-        $this->initializeFindables([$uri, $engine]);
+		$this->initializeFindables([$uri, $engine]);
 
-        foreach ($criteria as $entry) {
-            foreach ($this->findables as $viewObject) {
-                if ($viewObject->canHandle($entry)) {
-                    return $viewObject;
-                }
-            }
-        }
+		foreach ($criteria as $entry) {
+			foreach ($this->findables as $viewObject) {
+				if ($viewObject->canHandle($entry)) {
+					return $viewObject;
+				}
+			}
+		}
 
-        return $this->getNullObject();
-    }
+		return $this->getNullObject();
+	}
 
-    /**
-     * 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 'Views';
-    }
+	/**
+	 * 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 'Views';
+	}
 }

src/View/Support/AbstractFinder.php

Spacing +2 added lines, -2 removed lines

@@ -150,7 +150,7 @@ 
      */
     protected function initializeFindables($arguments = null)
     {
-        $this->findables = $this->findables->map(function ($findable) use ($arguments) {
+        $this->findables = $this->findables->map(function($findable) use ($arguments) {
             return $this->initializeFindable($findable, $arguments);
         });
     }
@@ -191,7 +191,7 @@ 
             $findable = $this->instantiateFindableFromCallable($findable, $arguments);
         }
 
-        if (! $findable instanceof Findable) {
+        if ( ! $findable instanceof Findable) {
             throw new FailedToInstantiateFindableException(
                 sprintf(
                     _('Could not instantiate Findable "%s".'),

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/LocationCollection.php

Indentation +41 added lines, -41 removed lines

@@ -25,48 +25,48 @@
 class LocationCollection extends ArrayCollection
 {
 
-    /**
-     * Adds a location at the end of the collection if it does not already exist.
-     *
-     * @param mixed $location The location to add.
-     *
-     * @return boolean Whether the location was added or not.
-     */
-    public function add($location)
-    {
-        if ($this->hasLocation($location)) {
-            return false;
-        }
+	/**
+	 * Adds a location at the end of the collection if it does not already exist.
+	 *
+	 * @param mixed $location The location to add.
+	 *
+	 * @return boolean Whether the location was added or not.
+	 */
+	public function add($location)
+	{
+		if ($this->hasLocation($location)) {
+			return false;
+		}
 
-        return parent::add($location);
-    }
+		return parent::add($location);
+	}
 
-    /**
-     * Check whether a given location is already registered.
-     *
-     * For two locations to be equal, both their path and their extensions must be the same.
-     *
-     * @since 0.1.1
-     *
-     * @param LocationInterface $location Location to check the existence of.
-     *
-     * @return bool Whether the location is already registered or not.
-     *
-     * @throws InvalidLocationException If the location is not valid.
-     */
-    public function hasLocation($location)
-    {
-        if (! $location instanceof LocationInterface) {
-            throw new InvalidLocationException(
-                sprintf(
-                    _('Invalid location to check existence for: "%s".'),
-                    serialize($location)
-                )
-            );
-        }
+	/**
+	 * Check whether a given location is already registered.
+	 *
+	 * For two locations to be equal, both their path and their extensions must be the same.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param LocationInterface $location Location to check the existence of.
+	 *
+	 * @return bool Whether the location is already registered or not.
+	 *
+	 * @throws InvalidLocationException If the location is not valid.
+	 */
+	public function hasLocation($location)
+	{
+		if (! $location instanceof LocationInterface) {
+			throw new InvalidLocationException(
+				sprintf(
+					_('Invalid location to check existence for: "%s".'),
+					serialize($location)
+				)
+			);
+		}
 
-        return $this->exists(function ($key, $element) use ($location) {
-            return $location == $element;
-        });
-    }
+		return $this->exists(function ($key, $element) use ($location) {
+			return $location == $element;
+		});
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -56,7 +56,7 @@ 
      */
     public function hasLocation($location)
     {
-        if (! $location instanceof LocationInterface) {
+        if ( ! $location instanceof LocationInterface) {
             throw new InvalidLocationException(
                 sprintf(
                     _('Invalid location to check existence for: "%s".'),
@@ -65,7 +65,7 @@ 
             );
         }
 
-        return $this->exists(function ($key, $element) use ($location) {
+        return $this->exists(function($key, $element) use ($location) {
             return $location == $element;
         });
     }

src/View/Location/LocationInterface.php

Indentation +20 added lines, -20 removed lines

@@ -22,25 +22,25 @@
 interface LocationInterface
 {
 
-    /**
-     * 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);
+	/**
+	 * 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);
 
-    /**
-     * Get all URIs that match the given criteria.
-     *
-     * @since 0.1.1
-     *
-     * @param array $criteria Criteria to match.
-     *
-     * @return URICollection Collection of URIs that matches the criteria or an empty collection if none found.
-     */
-    public function getURIs(array $criteria);
+	/**
+	 * Get all URIs that match the given criteria.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param array $criteria Criteria to match.
+	 *
+	 * @return URICollection Collection of URIs that matches the criteria or an empty collection if none found.
+	 */
+	public function getURIs(array $criteria);
 }

src/View/Location/URICollection.php

Indentation +14 added lines, -14 removed lines

@@ -25,19 +25,19 @@
 class URICollection extends ArrayCollection
 {
 
-    /**
-     * Create a new URICollection from a Symfony Finder instance.
-     *
-     * @since 0.1.3
-     *
-     * @param Finder $finder The Finder instance to create the URI collection from.
-     *
-     * @return static New URICollection instance.
-     */
-    public static function fromFinder(Finder $finder)
-    {
-        $elements = array_keys(iterator_to_array($finder));
+	/**
+	 * Create a new URICollection from a Symfony Finder instance.
+	 *
+	 * @since 0.1.3
+	 *
+	 * @param Finder $finder The Finder instance to create the URI collection from.
+	 *
+	 * @return static New URICollection instance.
+	 */
+	public static function fromFinder(Finder $finder)
+	{
+		$elements = array_keys(iterator_to_array($finder));
 
-        return new static($elements);
-    }
+		return new static($elements);
+	}
 }