brightnucleus / view

src/View/ViewBuilder.php

Indentation +205 added lines, -205 removed lines

@@ -32,209 +32,209 @@
 class ViewBuilder
 {
 
-    use ConfigTrait;
-
-    const ENGINE_FINDER_KEY = 'EngineFinder';
-    const VIEW_FINDER_KEY   = 'ViewFinder';
-
-    /**
-     * ViewFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @var ViewFinderInterface
-     */
-    protected $viewFinder;
-
-    /**
-     * EngineFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @var EngineFinderInterface
-     */
-    protected $engineFinder;
-
-    /**
-     * Locations to scan for views.
-     *
-     * @since 0.1.0
-     *
-     * @var LocationInterface[]
-     */
-    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;
-    }
-
-    /**
-     * Create a new view for a given URI.
-     *
-     * @since 0.1.0
-     *
-     * @param string      $view View identifier to create a view for.
-     * @param string|null $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 $this->getView($uri, $engine, $type);
-    }
-
-    /**
-     * 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);
-        }
-
-        return $this->resolveType($type, $uri, $engine);
-    }
-
-    /**
-     * Get the ViewFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return ViewFinderInterface Instance of a ViewFinder.
-     */
-    public function getViewFinder()
-    {
-        if (null === $this->viewFinder) {
-            $viewFinderClass  = $this->config->getKey(static::VIEW_FINDER_KEY, 'ClassName');
-            $this->viewFinder = new $viewFinderClass($this->config->getSubConfig(static::VIEW_FINDER_KEY));
-        }
-
-        return $this->viewFinder;
-    }
-
-    /**
-     * Get the EngineFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return EngineFinderInterface Instance of a EngineFinder.
-     */
-    public function getEngineFinder()
-    {
-        if (null === $this->engineFinder) {
-            $engineFinderClass  = $this->config->getKey(static::ENGINE_FINDER_KEY, 'ClassName');
-            $this->engineFinder = new $engineFinderClass($this->config->getSubConfig(static::ENGINE_FINDER_KEY));
-        }
-
-        return $this->engineFinder;
-    }
-
-    /**
-     * 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[] = $location;
-    }
-
-    /**
-     * Scan Locations for an URI that matches the specified criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array $criteria Criteria to match.
-     *
-     * @return string|bool URI of the requested view, or false if not found.
-     */
-    public function scanLocations(array $criteria)
-    {
-        /** @var LocationInterface $location */
-        foreach ($this->locations as $location) {
-            if ($uri = $location->getURI($criteria)) {
-                return $uri;
-            }
-        }
-
-        return false;
-    }
-
-    /**
-     * 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 $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)
-    {
-        if (is_string($type) && $this->config->hasKey(static::VIEW_FINDER_KEY)) {
-            $type = new $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)
-                )
-            );
-        }
-
-        return $type;
-    }
+	use ConfigTrait;
+
+	const ENGINE_FINDER_KEY = 'EngineFinder';
+	const VIEW_FINDER_KEY   = 'ViewFinder';
+
+	/**
+	 * ViewFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var ViewFinderInterface
+	 */
+	protected $viewFinder;
+
+	/**
+	 * EngineFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var EngineFinderInterface
+	 */
+	protected $engineFinder;
+
+	/**
+	 * Locations to scan for views.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var LocationInterface[]
+	 */
+	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;
+	}
+
+	/**
+	 * Create a new view for a given URI.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string      $view View identifier to create a view for.
+	 * @param string|null $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 $this->getView($uri, $engine, $type);
+	}
+
+	/**
+	 * 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);
+		}
+
+		return $this->resolveType($type, $uri, $engine);
+	}
+
+	/**
+	 * Get the ViewFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return ViewFinderInterface Instance of a ViewFinder.
+	 */
+	public function getViewFinder()
+	{
+		if (null === $this->viewFinder) {
+			$viewFinderClass  = $this->config->getKey(static::VIEW_FINDER_KEY, 'ClassName');
+			$this->viewFinder = new $viewFinderClass($this->config->getSubConfig(static::VIEW_FINDER_KEY));
+		}
+
+		return $this->viewFinder;
+	}
+
+	/**
+	 * Get the EngineFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return EngineFinderInterface Instance of a EngineFinder.
+	 */
+	public function getEngineFinder()
+	{
+		if (null === $this->engineFinder) {
+			$engineFinderClass  = $this->config->getKey(static::ENGINE_FINDER_KEY, 'ClassName');
+			$this->engineFinder = new $engineFinderClass($this->config->getSubConfig(static::ENGINE_FINDER_KEY));
+		}
+
+		return $this->engineFinder;
+	}
+
+	/**
+	 * 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[] = $location;
+	}
+
+	/**
+	 * Scan Locations for an URI that matches the specified criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $criteria Criteria to match.
+	 *
+	 * @return string|bool URI of the requested view, or false if not found.
+	 */
+	public function scanLocations(array $criteria)
+	{
+		/** @var LocationInterface $location */
+		foreach ($this->locations as $location) {
+			if ($uri = $location->getURI($criteria)) {
+				return $uri;
+			}
+		}
+
+		return false;
+	}
+
+	/**
+	 * 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 $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)
+	{
+		if (is_string($type) && $this->config->hasKey(static::VIEW_FINDER_KEY)) {
+			$type = new $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)
+				)
+			);
+		}
+
+		return $type;
+	}
 }