brightnucleus / view

src/View/Location/FilesystemLocation.php

Indentation +156 added lines, -156 removed lines

@@ -28,160 +28,160 @@
 class FilesystemLocation implements Location
 {
 
-    /**
-     * 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 Extensions
-     */
-    protected $extensions;
-
-    /**
-     * Instantiate a FilesystemLocation object.
-     *
-     * @since 0.1.0
-     *
-     * @param string                       $path       Path that this location points to.
-     * @param Extensions|array|string|null $extensions Optional. Extensions that this location can accept.
-     */
-    public function __construct(string $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)
-    {
-        $uris = $this->getURIs($criteria);
-
-        return $uris->count() > 0
-            ? $this->getURIs($criteria)->first()
-            : false;
-    }
-
-    /**
-     * Get all URIs that match the given criteria.
-     *
-     * @since 0.1.1
-     *
-     * @param array $criteria Criteria to match.
-     *
-     * @return URIs URIs that match the criteria or an empty collection if none found.
-     */
-    public function getURIs(array $criteria): URIs
-    {
-        $uris = new URIs();
-
-        foreach ($this->extensions as $extension) {
-            $finder = new Finder();
-
-            try {
-                $finder->files()
-                    ->name($this->getNamePattern($criteria, $extension))
-                    ->in($this->getPathPattern());
-                foreach ($finder as $file) {
-                    /** @var SplFileInfo $file */
-                    $uris->add($file->getPathname());
-                }
-            } catch (Exception $exception) {
-                // Fail silently;
-            }
-        }
-
-        return $uris;
-    }
-
-    /**
-     * Get the name pattern to pass to the file finder.
-     *
-     * @since 0.1.3
-     *
-     * @param array  $criteria  Criteria to match.
-     * @param string $extension Extension to match.
-     *
-     * @return string Name pattern to pass to the file finder.
-     */
-    protected function getNamePattern(array $criteria, string $extension): string
-    {
-        $names = [];
-
-        $names[] = array_map(function ($criterion) use ($extension) {
-            $criterion = URIHelper::getFilename($criterion);
-
-            return empty($extension) || URIHelper::hasExtension($criterion, $extension)
-                ? $criterion
-                : $criterion . $extension;
-        }, $criteria)[0];
-
-        return $this->arrayToRegexPattern(array_unique($names));
-    }
-
-    /**
-     * Get the path pattern to pass to the file finder.
-     *
-     * @since 0.1.3
-     *
-     * @return string Path pattern to pass to the file finder.
-     */
-    protected function getPathPattern(): string
-    {
-        return $this->path;
-    }
-
-    /**
-     * Get an array as a regular expression pattern string.
-     *
-     * @since 0.1.3
-     *
-     * @param array $array Array to generate the pattern for.
-     *
-     * @return string Generated regular expression pattern.
-     */
-    protected function arrayToRegexPattern(array $array): string
-    {
-        $array = array_map('preg_quote', $array);
-
-        return '/' . implode('|', $array) . '/';
-    }
-
-    /**
-     * Validate the extensions and return a collection.
-     *
-     * @since 0.1.1
-     *
-     * @param Extensions|array|string|null $extensions Extensions to validate.
-     *
-     * @return Extensions Validated extensions collection.
-     */
-    protected function validateExtensions($extensions): Extensions
-    {
-        if (empty($extensions)) {
-            $extensions = new Extensions(['']);
-        }
-
-        if (! $extensions instanceof Extensions) {
-            $extensions = new Extensions((array)$extensions);
-        }
-
-        return $extensions;
-    }
+	/**
+	 * 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 Extensions
+	 */
+	protected $extensions;
+
+	/**
+	 * Instantiate a FilesystemLocation object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string                       $path       Path that this location points to.
+	 * @param Extensions|array|string|null $extensions Optional. Extensions that this location can accept.
+	 */
+	public function __construct(string $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)
+	{
+		$uris = $this->getURIs($criteria);
+
+		return $uris->count() > 0
+			? $this->getURIs($criteria)->first()
+			: false;
+	}
+
+	/**
+	 * Get all URIs that match the given criteria.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param array $criteria Criteria to match.
+	 *
+	 * @return URIs URIs that match the criteria or an empty collection if none found.
+	 */
+	public function getURIs(array $criteria): URIs
+	{
+		$uris = new URIs();
+
+		foreach ($this->extensions as $extension) {
+			$finder = new Finder();
+
+			try {
+				$finder->files()
+					->name($this->getNamePattern($criteria, $extension))
+					->in($this->getPathPattern());
+				foreach ($finder as $file) {
+					/** @var SplFileInfo $file */
+					$uris->add($file->getPathname());
+				}
+			} catch (Exception $exception) {
+				// Fail silently;
+			}
+		}
+
+		return $uris;
+	}
+
+	/**
+	 * Get the name pattern to pass to the file finder.
+	 *
+	 * @since 0.1.3
+	 *
+	 * @param array  $criteria  Criteria to match.
+	 * @param string $extension Extension to match.
+	 *
+	 * @return string Name pattern to pass to the file finder.
+	 */
+	protected function getNamePattern(array $criteria, string $extension): string
+	{
+		$names = [];
+
+		$names[] = array_map(function ($criterion) use ($extension) {
+			$criterion = URIHelper::getFilename($criterion);
+
+			return empty($extension) || URIHelper::hasExtension($criterion, $extension)
+				? $criterion
+				: $criterion . $extension;
+		}, $criteria)[0];
+
+		return $this->arrayToRegexPattern(array_unique($names));
+	}
+
+	/**
+	 * Get the path pattern to pass to the file finder.
+	 *
+	 * @since 0.1.3
+	 *
+	 * @return string Path pattern to pass to the file finder.
+	 */
+	protected function getPathPattern(): string
+	{
+		return $this->path;
+	}
+
+	/**
+	 * Get an array as a regular expression pattern string.
+	 *
+	 * @since 0.1.3
+	 *
+	 * @param array $array Array to generate the pattern for.
+	 *
+	 * @return string Generated regular expression pattern.
+	 */
+	protected function arrayToRegexPattern(array $array): string
+	{
+		$array = array_map('preg_quote', $array);
+
+		return '/' . implode('|', $array) . '/';
+	}
+
+	/**
+	 * Validate the extensions and return a collection.
+	 *
+	 * @since 0.1.1
+	 *
+	 * @param Extensions|array|string|null $extensions Extensions to validate.
+	 *
+	 * @return Extensions Validated extensions collection.
+	 */
+	protected function validateExtensions($extensions): Extensions
+	{
+		if (empty($extensions)) {
+			$extensions = new Extensions(['']);
+		}
+
+		if (! $extensions instanceof Extensions) {
+			$extensions = new Extensions((array)$extensions);
+		}
+
+		return $extensions;
+	}
 }

src/View/ViewBuilder.php

Indentation +242 added lines, -242 removed lines

@@ -34,273 +34,273 @@
 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';
 
-    /**
-     * BaseViewFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @var ViewFinder
-     */
-    protected $viewFinder;
+	/**
+	 * BaseViewFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var ViewFinder
+	 */
+	protected $viewFinder;
 
-    /**
-     * BaseEngineFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @var BaseEngineFinder
-     */
-    protected $engineFinder;
+	/**
+	 * BaseEngineFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var BaseEngineFinder
+	 */
+	protected $engineFinder;
 
-    /**
-     * Locations to scan for views.
-     *
-     * @since 0.1.0
-     *
-     * @var Locations
-     */
-    protected $locations;
+	/**
+	 * Locations to scan for views.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var Locations
+	 */
+	protected $locations;
 
-    /**
-     * Instantiate a ViewBuilder object.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface       $config       Optional. Configuration settings.
-     * @param ViewFinder|null       $viewFinder   Optional. BaseViewFinder instance.
-     * @param BaseEngineFinder|null $engineFinder Optional. BaseEngineFinder instance.
-     *
-     * @throws FailedToProcessConfigException If the config could not be processed.
-     */
-    public function __construct(
-        ConfigInterface $config = null,
-        ViewFinder $viewFinder = null,
-        BaseEngineFinder $engineFinder = null
-    ) {
-        $this->processConfig($this->getConfig($config));
-        $this->viewFinder   = $viewFinder;
-        $this->engineFinder = $engineFinder;
-        $this->locations    = new Locations();
-    }
+	/**
+	 * Instantiate a ViewBuilder object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface       $config       Optional. Configuration settings.
+	 * @param ViewFinder|null       $viewFinder   Optional. BaseViewFinder instance.
+	 * @param BaseEngineFinder|null $engineFinder Optional. BaseEngineFinder instance.
+	 *
+	 * @throws FailedToProcessConfigException If the config could not be processed.
+	 */
+	public function __construct(
+		ConfigInterface $config = null,
+		ViewFinder $viewFinder = null,
+		BaseEngineFinder $engineFinder = null
+	) {
+		$this->processConfig($this->getConfig($config));
+		$this->viewFinder   = $viewFinder;
+		$this->engineFinder = $engineFinder;
+		$this->locations    = new Locations();
+	}
 
-    /**
-     * 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 View Instance of the requested view.
-     * @throws FailedToInstantiateView If the view could not be instantiated.
-     */
-    public function create(string $view, $type = null): View
-    {
-        $uri    = $this->scanLocations([$view]);
-        $engine = $uri
-            ? $this->getEngine($uri)
-            : false;
+	/**
+	 * 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 View Instance of the requested view.
+	 * @throws FailedToInstantiateView If the view could not be instantiated.
+	 */
+	public function create(string $view, $type = null): View
+	{
+		$uri    = $this->scanLocations([$view]);
+		$engine = $uri
+			? $this->getEngine($uri)
+			: false;
 
-        return ($uri && $engine)
-            ? $this->getView($uri, $engine, $type)
-            : $this->getViewFinder()->getNullObject();
-    }
+		return ($uri && $engine)
+			? $this->getView($uri, $engine, $type)
+			: $this->getViewFinder()->getNullObject();
+	}
 
-    /**
-     * Get an Engine that can deal with the given URI.
-     *
-     * @since 0.1.0
-     *
-     * @param string $uri URI to get an engine for.
-     *
-     * @return Engine Instance of an engine that can deal with the given URI.
-     */
-    public function getEngine(string $uri): Engine
-    {
-        return $this->getEngineFinder()->find([$uri]);
-    }
+	/**
+	 * Get an Engine that can deal with the given URI.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $uri URI to get an engine for.
+	 *
+	 * @return Engine Instance of an engine that can deal with the given URI.
+	 */
+	public function getEngine(string $uri): Engine
+	{
+		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 Engine $engine Engine to use for the view.
-     * @param mixed  $type   Type of view to get.
-     *
-     * @return View View that matches the given requirements.
-     * @throws FailedToInstantiateView If the view could not be instantiated.
-     */
-    public function getView(string $uri, Engine $engine, $type = null): View
-    {
-        $view = (null === $type)
-            ? $this->getViewFinder()->find([$uri], $engine)
-            : $this->resolveType($type, $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 Engine $engine Engine to use for the view.
+	 * @param mixed  $type   Type of view to get.
+	 *
+	 * @return View View that matches the given requirements.
+	 * @throws FailedToInstantiateView If the view could not be instantiated.
+	 */
+	public function getView(string $uri, Engine $engine, $type = null): View
+	{
+		$view = (null === $type)
+			? $this->getViewFinder()->find([$uri], $engine)
+			: $this->resolveType($type, $uri, $engine);
 
-        return $view->setBuilder($this);
-    }
+		return $view->setBuilder($this);
+	}
 
-    /**
-     * Get the ViewFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return ViewFinder Instance of a BaseViewFinder.
-     */
-    public function getViewFinder(): ViewFinder
-    {
-        return $this->getFinder($viewFinder, static::VIEW_FINDER_KEY);
-    }
+	/**
+	 * Get the ViewFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return ViewFinder Instance of a BaseViewFinder.
+	 */
+	public function getViewFinder(): ViewFinder
+	{
+		return $this->getFinder($viewFinder, static::VIEW_FINDER_KEY);
+	}
 
-    /**
-     * Get the EngineFinder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return EngineFinder Instance of a BaseEngineFinder.
-     */
-    public function getEngineFinder(): EngineFinder
-    {
-        return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY);
-    }
+	/**
+	 * Get the EngineFinder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return EngineFinder Instance of a BaseEngineFinder.
+	 */
+	public function getEngineFinder(): EngineFinder
+	{
+		return $this->getFinder($this->engineFinder, static::ENGINE_FINDER_KEY);
+	}
 
-    /**
-     * Add a location to scan with the BaseViewFinder.
-     *
-     * @since 0.1.0
-     *
-     * @param Location $location Location to scan with the BaseViewFinder.
-     */
-    public function addLocation(Location $location)
-    {
-        $this->locations->add($location);
-    }
+	/**
+	 * Add a location to scan with the BaseViewFinder.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param Location $location Location to scan with the BaseViewFinder.
+	 */
+	public function addLocation(Location $location)
+	{
+		$this->locations->add($location);
+	}
 
-    /**
-     * Get the collection of locations registered with this ViewBuilder.
-     *
-     * @since 0.1.3
-     *
-     * @return Locations Collection of locations.
-     */
-    public function getLocations()
-    {
-        return $this->locations;
-    }
+	/**
+	 * Get the collection of locations registered with this ViewBuilder.
+	 *
+	 * @since 0.1.3
+	 *
+	 * @return Locations 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 Location $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 Location $location */
+			return $location->getURI($criteria);
+		})->filter(function ($uri) {
+			return false !== $uri;
+		});
         
-        // Fall back for absolute paths on current filesystem.
-        if ($uris->isEmpty()) {
-            foreach ($criteria as $criterion) {
-                if (file_exists($criterion)) {
-                    return $criterion;
-                }
-            }
-        }
+		// Fall back for absolute paths on current filesystem.
+		if ($uris->isEmpty()) {
+			foreach ($criteria as $criterion) {
+				if (file_exists($criterion)) {
+					return $criterion;
+				}
+			}
+		}
 
-        return $uris->isEmpty() ? false : $uris->first();
-    }
+		return $uris->isEmpty() ? false : $uris->first();
+	}
 
-    /**
-     * Get a finder instance.
-     *
-     * @since 0.1.1
-     *
-     * @param mixed  $property Property to use.
-     * @param string $key      Configuration key to use.
-     *
-     * @return ViewFinder|EngineFinder The requested finder instance.
-     */
-    protected function getFinder(&$property, $key)
-    {
-        if (null === $property) {
-            $finderClass = $this->config->getKey($key, 'ClassName');
-            $property    = new $finderClass($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 ViewFinder|EngineFinder The requested finder instance.
+	 */
+	protected function getFinder(&$property, $key)
+	{
+		if (null === $property) {
+			$finderClass = $this->config->getKey($key, 'ClassName');
+			$property    = new $finderClass($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 Engine|null $engine Engine to use for the view.
-     *
-     * @return View Resolved View object.
-     * @throws FailedToInstantiateView If the view type could not be resolved.
-     */
-    protected function resolveType($type, string $uri, Engine $engine = null): View
-    {
-        $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 Engine|null $engine Engine to use for the view.
+	 *
+	 * @return View Resolved View object.
+	 * @throws FailedToInstantiateView If the view type could not be resolved.
+	 */
+	protected function resolveType($type, string $uri, Engine $engine = null): View
+	{
+		$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 View) {
-            throw new FailedToInstantiateView(
-                sprintf(
-                    _('Could not instantiate view "%s".'),
-                    serialize($type)
-                )
-            );
-        }
+		if (! $type instanceof View) {
+			throw new FailedToInstantiateView(
+				sprintf(
+					_('Could not instantiate view "%s".'),
+					serialize($type)
+				)
+			);
+		}
 
-        return $type;
-    }
+		return $type;
+	}
 
-    /**
-     * Get the configuration to use in the ViewBuilder.
-     *
-     * @since 0.2.0
-     *
-     * @param ConfigInterface|array $config Config to merge with defaults.
-     *
-     * @return ConfigInterface Configuration passed in through the constructor.
-     */
-    protected function getConfig($config = []): ConfigInterface
-    {
-        $defaults = ConfigFactory::create(dirname(__DIR__, 2) . '/config/defaults.php', $config);
-        $config   = $config
-            ? ConfigFactory::createFromArray(array_merge_recursive($defaults->getArrayCopy(), $config->getArrayCopy()))
-            : $defaults;
+	/**
+	 * Get the configuration to use in the ViewBuilder.
+	 *
+	 * @since 0.2.0
+	 *
+	 * @param ConfigInterface|array $config Config to merge with defaults.
+	 *
+	 * @return ConfigInterface Configuration passed in through the constructor.
+	 */
+	protected function getConfig($config = []): ConfigInterface
+	{
+		$defaults = ConfigFactory::create(dirname(__DIR__, 2) . '/config/defaults.php', $config);
+		$config   = $config
+			? ConfigFactory::createFromArray(array_merge_recursive($defaults->getArrayCopy(), $config->getArrayCopy()))
+			: $defaults;
 
-        return $config->getSubConfig('BrightNucleus\View');
-    }
+		return $config->getSubConfig('BrightNucleus\View');
+	}
 }