brightnucleus / view

src/View.php

Doc Comments +1 added lines, -1 removed lines

@@ -119,7 +119,7 @@
      * @param array       $context Optional. The context in which to render the view.
      * @param string|null $type    Type of view to create.
      *
-     * @return ViewInterface Instance of the requested view.
+     * @return string Instance of the requested view.
      */
     public static function render($view, array $context = [], $type = null)
     {

Indentation +91 added lines, -91 removed lines

@@ -28,104 +28,104 @@
 class View
 {
 
-    /**
-     * ViewBuilder Instance.
-     *
-     * @since 0.1.0
-     *
-     * @var ViewBuilder
-     */
-    protected static $viewBuilder;
+	/**
+	 * ViewBuilder Instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var ViewBuilder
+	 */
+	protected static $viewBuilder;
 
-    /**
-     * Add a location to the ViewBuilder.
-     *
-     * @since 0.1.0
-     *
-     * @param LocationInterface $location Location to add.
-     */
-    public static function addLocation(LocationInterface $location)
-    {
-        $viewBuilder = static::getViewBuilder();
-        $viewBuilder->addLocation($location);
-    }
+	/**
+	 * Add a location to the ViewBuilder.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param LocationInterface $location Location to add.
+	 */
+	public static function addLocation(LocationInterface $location)
+	{
+		$viewBuilder = static::getViewBuilder();
+		$viewBuilder->addLocation($location);
+	}
 
-    /**
-     * Get the ViewBuilder instance.
-     *
-     * @since 0.1.0
-     *
-     * @return ViewBuilder
-     */
-    public static function getViewBuilder()
-    {
-        if (null === static::$viewBuilder) {
-            static::$viewBuilder = static::instantiateViewBuilder();
-        }
+	/**
+	 * Get the ViewBuilder instance.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return ViewBuilder
+	 */
+	public static function getViewBuilder()
+	{
+		if (null === static::$viewBuilder) {
+			static::$viewBuilder = static::instantiateViewBuilder();
+		}
 
-        return static::$viewBuilder;
-    }
+		return static::$viewBuilder;
+	}
 
-    /**
-     * Instantiate the ViewBuilder.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface|null $config Optional. Configuration to pass into the ViewBuilder.
-     *
-     * @return ViewBuilder Instance of the ViewBuilder.
-     */
-    public static function instantiateViewBuilder(ConfigInterface $config = null)
-    {
-        return static::$viewBuilder = new ViewBuilder($config ?: static::getDefaultConfig());
-    }
+	/**
+	 * Instantiate the ViewBuilder.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface|null $config Optional. Configuration to pass into the ViewBuilder.
+	 *
+	 * @return ViewBuilder Instance of the ViewBuilder.
+	 */
+	public static function instantiateViewBuilder(ConfigInterface $config = null)
+	{
+		return static::$viewBuilder = new ViewBuilder($config ?: static::getDefaultConfig());
+	}
 
-    /**
-     * Get the default configuration to inject into the ViewBuilder.
-     *
-     * @since 0.1.0
-     *
-     * @return ConfigInterface Default configuration.
-     */
-    public static function getDefaultConfig()
-    {
-        return ConfigFactory::create(__DIR__ . '/../config/defaults.php')
-                            ->getSubConfig('BrightNucleus\View');
-    }
+	/**
+	 * Get the default configuration to inject into the ViewBuilder.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @return ConfigInterface Default configuration.
+	 */
+	public static function getDefaultConfig()
+	{
+		return ConfigFactory::create(__DIR__ . '/../config/defaults.php')
+							->getSubConfig('BrightNucleus\View');
+	}
 
-    /**
-     * 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 static function create($view, $type = null)
-    {
-        $viewBuilder = static::getViewBuilder();
+	/**
+	 * 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 static function create($view, $type = null)
+	{
+		$viewBuilder = static::getViewBuilder();
 
-        return $viewBuilder->create($view, $type);
-    }
+		return $viewBuilder->create($view, $type);
+	}
 
-    /**
-     * Render a view for a given URI.
-     *
-     * @since 0.1.0
-     *
-     * @param string      $view    View identifier to create a view for.
-     * @param array       $context Optional. The context in which to render the view.
-     * @param string|null $type    Type of view to create.
-     *
-     * @return ViewInterface Instance of the requested view.
-     */
-    public static function render($view, array $context = [], $type = null)
-    {
-        $viewBuilder = static::getViewBuilder();
-        $viewObject  = $viewBuilder->create($view, $type);
+	/**
+	 * Render a view for a given URI.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string      $view    View identifier to create a view for.
+	 * @param array       $context Optional. The context in which to render the view.
+	 * @param string|null $type    Type of view to create.
+	 *
+	 * @return ViewInterface Instance of the requested view.
+	 */
+	public static function render($view, array $context = [], $type = null)
+	{
+		$viewBuilder = static::getViewBuilder();
+		$viewObject  = $viewBuilder->create($view, $type);
 
-        return $viewObject->render($context);
-    }
+		return $viewObject->render($context);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
      */
     public static function getDefaultConfig()
     {
-        return ConfigFactory::create(__DIR__ . '/../config/defaults.php')
+        return ConfigFactory::create(__DIR__.'/../config/defaults.php')
                             ->getSubConfig('BrightNucleus\View');
     }
 

src/View/Location/FilesystemLocation.php

Doc Comments +1 added lines, -1 removed lines

@@ -83,7 +83,7 @@
      *
      * @param string $entry Entry to transform.
      *
-     * @return string|bool URI of the view, or false if none found.
+     * @return string|false URI of the view, or false if none found.
      */
     protected function transform($entry)
     {

Indentation +74 added lines, -74 removed lines

@@ -24,86 +24,86 @@
 class FilesystemLocation implements LocationInterface
 {
 
-    /**
-     * Path that this location points to.
-     *
-     * @since 0.1.0
-     *
-     * @var string
-     */
-    protected $path;
+	/**
+	 * 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 array<string>
-     */
-    protected $extensions;
+	/**
+	 * Extensions that this location can accept.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var array<string>
+	 */
+	protected $extensions;
 
-    /**
-     * Instantiate a FilesystemLocation object.
-     *
-     * @since 0.1.0
-     *
-     * @param string $path       Path that this location points to.
-     * @param array  $extensions Array of extensions that this location can accept.
-     */
-    public function __construct($path, array $extensions = [])
-    {
-        $this->path       = $path;
-        $this->extensions = array_merge($extensions, ['']);
-    }
+	/**
+	 * Instantiate a FilesystemLocation object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $path       Path that this location points to.
+	 * @param array  $extensions Array of extensions that this location can accept.
+	 */
+	public function __construct($path, array $extensions = [])
+	{
+		$this->path       = $path;
+		$this->extensions = array_merge($extensions, ['']);
+	}
 
-    /**
-     * Get an 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)) {
-                return $uri;
-            }
-        }
+	/**
+	 * Get an 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)) {
+				return $uri;
+			}
+		}
 
-        return false;
-    }
+		return false;
+	}
 
-    /**
-     * Try to transform the entry into possible URIs.
-     *
-     * @since 0.1.0
-     *
-     * @param string $entry Entry to transform.
-     *
-     * @return string|bool URI of the view, or false if none found.
-     */
-    protected function transform($entry)
-    {
-        try {
-            foreach ($this->extensions as $extension) {
+	/**
+	 * Try to transform the entry into possible URIs.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $entry Entry to transform.
+	 *
+	 * @return string|bool URI of the view, or false if none found.
+	 */
+	protected function transform($entry)
+	{
+		try {
+			foreach ($this->extensions as $extension) {
 
-                $uri = $entry . $extension;
-                if (is_readable($uri)) {
-                    return $uri;
-                }
+				$uri = $entry . $extension;
+				if (is_readable($uri)) {
+					return $uri;
+				}
 
-                $uri = $this->path . DIRECTORY_SEPARATOR . $uri;
-                if (is_readable($uri)) {
-                    return $uri;
-                }
-            }
-        } catch (Exception $exception) {
-            // Fail silently.
-        }
+				$uri = $this->path . DIRECTORY_SEPARATOR . $uri;
+				if (is_readable($uri)) {
+					return $uri;
+				}
+			}
+		} catch (Exception $exception) {
+			// Fail silently.
+		}
 
-        return false;
-    }
+		return false;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -90,12 +90,12 @@
         try {
             foreach ($this->extensions as $extension) {
 
-                $uri = $entry . $extension;
+                $uri = $entry.$extension;
                 if (is_readable($uri)) {
                     return $uri;
                 }
 
-                $uri = $this->path . DIRECTORY_SEPARATOR . $uri;
+                $uri = $this->path.DIRECTORY_SEPARATOR.$uri;
                 if (is_readable($uri)) {
                     return $uri;
                 }

src/View/View/ViewFinderInterface.php

Doc Comments +1 added lines, -1 removed lines

@@ -30,7 +30,7 @@
      *
      * @since 0.1.0
      *
-     * @param array           $criteria Criteria to search for.
+     * @param string[]           $criteria Criteria to search for.
      * @param EngineInterface $engine   Optional. Engine to use with the view.
      *
      * @return ViewInterface View that was found.

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 $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 $engine   Optional. Engine to use with the view.
+	 *
+	 * @return ViewInterface View that was found.
+	 */
+	public function find(array $criteria, EngineInterface $engine = null);
 }

config/defaults.php

Indentation +16 added lines, -16 removed lines

@@ -12,26 +12,26 @@
 namespace BrightNucleus\View;
 
 $engineFinder = [
-    'ClassName'  => 'BrightNucleus\View\Engine\EngineFinder',
-    'Engines'    => [
-        'PHPEngine' => 'BrightNucleus\View\Engine\PHPEngine',
-    ],
-    'NullObject' => 'BrightNucleus\View\Engine\NullEngine',
+	'ClassName'  => 'BrightNucleus\View\Engine\EngineFinder',
+	'Engines'    => [
+		'PHPEngine' => 'BrightNucleus\View\Engine\PHPEngine',
+	],
+	'NullObject' => 'BrightNucleus\View\Engine\NullEngine',
 ];
 
 $viewFinder = [
-    'ClassName'  => 'BrightNucleus\View\View\ViewFinder',
-    'Views'      => [
-        'BaseView' => 'BrightNucleus\View\View\BaseView',
-    ],
-    'NullObject' => 'BrightNucleus\View\View\NullView',
+	'ClassName'  => 'BrightNucleus\View\View\ViewFinder',
+	'Views'      => [
+		'BaseView' => 'BrightNucleus\View\View\BaseView',
+	],
+	'NullObject' => 'BrightNucleus\View\View\NullView',
 ];
 
 return [
-    'BrightNucleus' => [
-        'View' => [
-            'EngineFinder' => $engineFinder,
-            'ViewFinder'   => $viewFinder,
-        ],
-    ],
+	'BrightNucleus' => [
+		'View' => [
+			'EngineFinder' => $engineFinder,
+			'ViewFinder'   => $viewFinder,
+		],
+	],
 ];

src/View/Support/FinderInterface.php

Indentation +10 added lines, -10 removed lines

@@ -22,14 +22,14 @@
 interface FinderInterface
 {
 
-    /**
-     * Find a result based on a specific criteria.
-     *
-     * @since 0.1.0
-     *
-     * @param array $criteria Criteria to search for.
-     *
-     * @return mixed Result of the search.
-     */
-    public function find(array $criteria);
+	/**
+	 * Find a result based on a specific criteria.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $criteria Criteria to search for.
+	 *
+	 * @return mixed Result of the search.
+	 */
+	public function find(array $criteria);
 }

src/View/Support/AbstractFinder.php

Indentation +90 added lines, -90 removed lines

@@ -26,102 +26,102 @@
 abstract class AbstractFinder implements FinderInterface
 {
 
-    use ConfigTrait;
+	use ConfigTrait;
 
-    /**
-     * Array of Findables that the Finder can iterate through to find a match.
-     *
-     * @since 0.1.0
-     *
-     * @var Findable[]
-     */
-    protected $findables;
+	/**
+	 * Array of Findables that the Finder can iterate through to find a match.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var Findable[]
+	 */
+	protected $findables;
 
-    /**
-     * NullObject that is returned if the Finder could not find a match.
-     *
-     * @since 0.1.0
-     *
-     * @var NullObject
-     */
-    protected $nullObject;
+	/**
+	 * NullObject that is returned if the Finder could not find a match.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var NullObject
+	 */
+	protected $nullObject;
 
-    /**
-     * Instantiate an AbstractFinder object.
-     *
-     * @since 0.1.0
-     *
-     * @param ConfigInterface $config Configuration of the EngineFinder.
-     *
-     * @throws FailedToProcessConfigException If the config could not be processed.
-     */
-    public function __construct(ConfigInterface $config)
-    {
-        $this->processConfig($config);
-        $this->registerFindables($this->config);
-        $this->registerNullObject($this->config);
-    }
+	/**
+	 * Instantiate an AbstractFinder object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param ConfigInterface $config Configuration of the EngineFinder.
+	 *
+	 * @throws FailedToProcessConfigException If the config could not be processed.
+	 */
+	public function __construct(ConfigInterface $config)
+	{
+		$this->processConfig($config);
+		$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->registerFindable($findableKey, $findableObject);
-        }
-    }
+	/**
+	 * 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->registerFindable($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());
-    }
+	/**
+	 * 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());
+	}
 
-    /**
-     * Register a single Findable.
-     *
-     * @since 0.1.0
-     *
-     * @param string $key      Key used to reference the Findable.
-     * @param mixed  $findable Findable as a FQCN, callable or object.
-     */
-    protected function registerFindable($key, $findable)
-    {
-        $this->findables[$key] = $findable;
-    }
+	/**
+	 * Register a single Findable.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string $key      Key used to reference the Findable.
+	 * @param mixed  $findable Findable as a FQCN, callable or object.
+	 */
+	protected function registerFindable($key, $findable)
+	{
+		$this->findables[$key] = $findable;
+	}
 
-    /**
-     * 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 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';
-    }
+	/**
+	 * 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';
+	}
 }

src/View/View/AbstractView.php

Indentation +48 added lines, -48 removed lines

@@ -25,55 +25,55 @@
 abstract class AbstractView implements ViewInterface, Findable
 {
 
-    /**
-     * URI of the view.
-     *
-     * @since 0.1.0
-     *
-     * @var string
-     */
-    protected $uri;
+	/**
+	 * URI of the view.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var string
+	 */
+	protected $uri;
 
-    /**
-     * Engine to use for the view.
-     *
-     * @since 0.1.0
-     *
-     * @var EngineInterface
-     */
-    protected $engine;
+	/**
+	 * Engine to use for the view.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @var EngineInterface
+	 */
+	protected $engine;
 
-    /**
-     * Instantiate an AbstractView object.
-     *
-     * @since 0.1.0
-     *
-     * @param string          $uri    URI for the view.
-     * @param EngineInterface $engine Engine to use for the view.
-     */
-    public function __construct($uri, EngineInterface $engine)
-    {
-        $this->uri    = $uri;
-        $this->engine = $engine;
-    }
+	/**
+	 * Instantiate an AbstractView object.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param string          $uri    URI for the view.
+	 * @param EngineInterface $engine Engine to use for the view.
+	 */
+	public function __construct($uri, EngineInterface $engine)
+	{
+		$this->uri    = $uri;
+		$this->engine = $engine;
+	}
 
-    /**
-     * 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)
-    {
-        $output = $this->engine->render($this->uri, $context);
-        if ($echo) {
-            echo $output;
-        } else {
-            return $output;
-        }
-    }
+	/**
+	 * 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)
+	{
+		$output = $this->engine->render($this->uri, $context);
+		if ($echo) {
+			echo $output;
+		} else {
+			return $output;
+		}
+	}
 }

src/View/View/ViewInterface.php

Indentation +10 added lines, -10 removed lines

@@ -22,14 +22,14 @@
 interface ViewInterface
 {
 
-    /**
-     * Render the view.
-     *
-     * @since 0.1.0
-     *
-     * @param array $context Optional. The context in which to render the view.
-     *
-     * @return string Rendered HTML.
-     */
-    public function render(array $context = []);
+	/**
+	 * Render the view.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $context Optional. The context in which to render the view.
+	 *
+	 * @return string Rendered HTML.
+	 */
+	public function render(array $context = []);
 }

src/View/View/NullView.php

Indentation +12 added lines, -12 removed lines

@@ -24,16 +24,16 @@
 class NullView implements ViewInterface, NullObject
 {
 
-    /**
-     * Render the view.
-     *
-     * @since 0.1.0
-     *
-     * @param array $context Optional. The context in which to render the view.
-     *
-     * @return string Rendered HTML.
-     */
-    public function render(array $context = [])
-    {
-    }
+	/**
+	 * Render the view.
+	 *
+	 * @since 0.1.0
+	 *
+	 * @param array $context Optional. The context in which to render the view.
+	 *
+	 * @return string Rendered HTML.
+	 */
+	public function render(array $context = [])
+	{
+	}
 }