ingenerator / kohana-view

classes/Ingenerator/KohanaView/ViewModel/PageLayout/StaticPageContentView.php

Indentation +15 added lines, -15 removed lines

@@ -11,23 +11,23 @@
 
 class StaticPageContentView extends AbstractPageContentView implements TemplateSpecifyingViewModel
 {
-    protected $variables = [
-        'page_path' => NULL,
-    ];
+	protected $variables = [
+		'page_path' => NULL,
+	];
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getTemplateName()
-    {
-        if ( ! $this->variables['page_path']) {
-            throw new \BadMethodCallException(
-                'Call '.static::class.'::display(["page_path" => "name/of/view"]) before rendering static views'
-            );
-        }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getTemplateName()
+	{
+		if ( ! $this->variables['page_path']) {
+			throw new \BadMethodCallException(
+				'Call '.static::class.'::display(["page_path" => "name/of/view"]) before rendering static views'
+			);
+		}
 
-        return $this->variables['page_path'];
-    }
+		return $this->variables['page_path'];
+	}
 
 
 }

classes/Ingenerator/KohanaView/Renderer/PageLayoutRenderer.php

Indentation +68 added lines, -68 removed lines

@@ -34,82 +34,82 @@
  */
 class PageLayoutRenderer
 {
-    /**
-     * @var bool Whether to force (or not force) embedding the content in the layout
-     */
-    protected $use_layout;
+	/**
+	 * @var bool Whether to force (or not force) embedding the content in the layout
+	 */
+	protected $use_layout;
 
-    /**
-     * @var Renderer
-     */
-    protected $view_renderer;
+	/**
+	 * @var Renderer
+	 */
+	protected $view_renderer;
 
-    /**
-     * @var \Request
-     */
-    protected $current_request;
+	/**
+	 * @var \Request
+	 */
+	protected $current_request;
 
-    public function __construct(Renderer $view_renderer, \Request $current_request = NULL)
-    {
-        $this->view_renderer   = $view_renderer;
-        $this->current_request = $current_request;
-    }
+	public function __construct(Renderer $view_renderer, \Request $current_request = NULL)
+	{
+		$this->view_renderer   = $view_renderer;
+		$this->current_request = $current_request;
+	}
 
-    /**
-     * @param PageContentView $content_view
-     *
-     * @return string
-     */
-    public function render(PageContentView $content_view)
-    {
-        $content = $this->view_renderer->render($content_view);
-        if ($this->shouldUseLayout()) {
-            return $this->renderInLayout($content_view->var_page(), $content);
-        } else {
-            return $content;
-        }
-    }
+	/**
+	 * @param PageContentView $content_view
+	 *
+	 * @return string
+	 */
+	public function render(PageContentView $content_view)
+	{
+		$content = $this->view_renderer->render($content_view);
+		if ($this->shouldUseLayout()) {
+			return $this->renderInLayout($content_view->var_page(), $content);
+		} else {
+			return $content;
+		}
+	}
 
-    /**
-     * @return bool
-     */
-    protected function shouldUseLayout()
-    {
-        if ($this->use_layout !== NULL) {
-            return $this->use_layout;
-        }
+	/**
+	 * @return bool
+	 */
+	protected function shouldUseLayout()
+	{
+		if ($this->use_layout !== NULL) {
+			return $this->use_layout;
+		}
 
-        if ($this->current_request AND $this->current_request->is_ajax()) {
-            return FALSE;
-        } else {
-            return TRUE;
-        }
-    }
+		if ($this->current_request AND $this->current_request->is_ajax()) {
+			return FALSE;
+		} else {
+			return TRUE;
+		}
+	}
 
-    /**
-     * @param PageLayoutView $layout
-     * @param string         $content
-     *
-     * @return string
-     */
-    protected function renderInLayout(PageLayoutView $layout, $content)
-    {
-        $layout->setBodyHTML($content);
+	/**
+	 * @param PageLayoutView $layout
+	 * @param string         $content
+	 *
+	 * @return string
+	 */
+	protected function renderInLayout(PageLayoutView $layout, $content)
+	{
+		$layout->setBodyHTML($content);
 
-        return $this->view_renderer->render($layout);
-    }
+		return $this->view_renderer->render($layout);
+	}
 
-    /**
-     * Configure whether to always wrap the content in the layout (TRUE), never (FALSE) or automatically for
-     * non-AJAX requests (NULL)
-     *
-     * @param bool $use_layout
-     *
-     * @return void
-     */
-    public function setUseLayout($use_layout)
-    {
-        $this->use_layout = $use_layout;
-    }
+	/**
+	 * Configure whether to always wrap the content in the layout (TRUE), never (FALSE) or automatically for
+	 * non-AJAX requests (NULL)
+	 *
+	 * @param bool $use_layout
+	 *
+	 * @return void
+	 */
+	public function setUseLayout($use_layout)
+	{
+		$this->use_layout = $use_layout;
+	}
 
 }

classes/Ingenerator/KohanaView/TemplateManager/CFSTemplateManager.php

Indentation +112 added lines, -112 removed lines

@@ -22,117 +22,117 @@
  */
 class CFSTemplateManager implements TemplateManager
 {
-    /**
-     * @var string
-     */
-    protected $cache_dir;
-
-    /**
-     * @var CFSWrapper
-     */
-    protected $cascading_files;
-
-    /**
-     * @var array
-     */
-    protected $compiled_paths = [];
-
-    /**
-     * @var TemplateCompiler
-     */
-    protected $compiler;
-
-    /**
-     * @var boolean
-     */
-    protected $recompile_always;
-
-    /**
-     * Valid options:
-     * * cache_dir => the path where compiled templates will be cached
-     * * recompile_always => whether to recompile each template on every execution,
-     *
-     * @param TemplateCompiler $compiler
-     * @param array            $options
-     * @param CFSWrapper       $cascading_files
-     */
-    public function __construct(TemplateCompiler $compiler, array $options, CFSWrapper $cascading_files = NULL)
-    {
-        $this->cascading_files  = $cascading_files ?: new CFSWrapper;
-        $this->compiler         = $compiler;
-        $this->cache_dir        = rtrim($options['cache_dir'], '/');
-        $this->recompile_always = \Arr::get($options, 'recompile_always', FALSE);
-    }
-
-    /**
-     * {@inheritdoc}
-     */
-    public function getPath($template_name)
-    {
-        $compiled_path = $this->cache_dir.'/'.$template_name.'.php';
-
-        if ($this->isCompileRequired($compiled_path)) {
-            $source   = $this->requireSourceFileContent($template_name);
-            $compiled = $this->compiler->compile($source);
-            $this->writeFile($compiled_path, $compiled);
-            $this->compiled_paths[$compiled_path] = TRUE;
-        }
-
-        return $compiled_path;
-    }
-
-    /**
-     * @param string $compiled_path
-     *
-     * @return bool
-     */
-    protected function isCompileRequired($compiled_path)
-    {
-        if ($this->recompile_always AND ! isset($this->compiled_paths[$compiled_path])) {
-            return TRUE;
-        }
-
-        return ! file_exists($compiled_path);
-    }
-
-    /**
-     * @param string $template_name
-     *
-     * @return string
-     */
-    protected function requireSourceFileContent($template_name)
-    {
-        if ( ! $source_file = $this->cascading_files->find_file('views', $template_name)) {
-            throw new \InvalidArgumentException("Cannot find template source file 'views/$template_name'");
-        }
-
-        return file_get_contents($source_file);
-    }
-
-    /**
-     * @param string $compiled_path
-     * @param string $compiled
-     */
-    protected function writeFile($compiled_path, $compiled)
-    {
-        $this->ensureWriteableDirectory(dirname($compiled_path));
-        file_put_contents($compiled_path, $compiled);
-    }
-
-    /**
-     * @param string $path
-     */
-    protected function ensureWriteableDirectory($path)
-    {
-        if (is_dir($path)) {
-            if ( ! is_writeable($path)) {
-                throw new \RuntimeException("Cannot write to compiled template path '$path'");
-            }
-        } else {
-            if ( ! mkdir($path, 0777, TRUE)) {
-                throw new \RuntimeException("Cannot create template cache directory in '$path'");
-            }
-        }
-    }
+	/**
+	 * @var string
+	 */
+	protected $cache_dir;
+
+	/**
+	 * @var CFSWrapper
+	 */
+	protected $cascading_files;
+
+	/**
+	 * @var array
+	 */
+	protected $compiled_paths = [];
+
+	/**
+	 * @var TemplateCompiler
+	 */
+	protected $compiler;
+
+	/**
+	 * @var boolean
+	 */
+	protected $recompile_always;
+
+	/**
+	 * Valid options:
+	 * * cache_dir => the path where compiled templates will be cached
+	 * * recompile_always => whether to recompile each template on every execution,
+	 *
+	 * @param TemplateCompiler $compiler
+	 * @param array            $options
+	 * @param CFSWrapper       $cascading_files
+	 */
+	public function __construct(TemplateCompiler $compiler, array $options, CFSWrapper $cascading_files = NULL)
+	{
+		$this->cascading_files  = $cascading_files ?: new CFSWrapper;
+		$this->compiler         = $compiler;
+		$this->cache_dir        = rtrim($options['cache_dir'], '/');
+		$this->recompile_always = \Arr::get($options, 'recompile_always', FALSE);
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getPath($template_name)
+	{
+		$compiled_path = $this->cache_dir.'/'.$template_name.'.php';
+
+		if ($this->isCompileRequired($compiled_path)) {
+			$source   = $this->requireSourceFileContent($template_name);
+			$compiled = $this->compiler->compile($source);
+			$this->writeFile($compiled_path, $compiled);
+			$this->compiled_paths[$compiled_path] = TRUE;
+		}
+
+		return $compiled_path;
+	}
+
+	/**
+	 * @param string $compiled_path
+	 *
+	 * @return bool
+	 */
+	protected function isCompileRequired($compiled_path)
+	{
+		if ($this->recompile_always AND ! isset($this->compiled_paths[$compiled_path])) {
+			return TRUE;
+		}
+
+		return ! file_exists($compiled_path);
+	}
+
+	/**
+	 * @param string $template_name
+	 *
+	 * @return string
+	 */
+	protected function requireSourceFileContent($template_name)
+	{
+		if ( ! $source_file = $this->cascading_files->find_file('views', $template_name)) {
+			throw new \InvalidArgumentException("Cannot find template source file 'views/$template_name'");
+		}
+
+		return file_get_contents($source_file);
+	}
+
+	/**
+	 * @param string $compiled_path
+	 * @param string $compiled
+	 */
+	protected function writeFile($compiled_path, $compiled)
+	{
+		$this->ensureWriteableDirectory(dirname($compiled_path));
+		file_put_contents($compiled_path, $compiled);
+	}
+
+	/**
+	 * @param string $path
+	 */
+	protected function ensureWriteableDirectory($path)
+	{
+		if (is_dir($path)) {
+			if ( ! is_writeable($path)) {
+				throw new \RuntimeException("Cannot write to compiled template path '$path'");
+			}
+		} else {
+			if ( ! mkdir($path, 0777, TRUE)) {
+				throw new \RuntimeException("Cannot create template cache directory in '$path'");
+			}
+		}
+	}
 
 }

config/dependencies.php

Indentation +34 added lines, -34 removed lines

@@ -7,38 +7,38 @@
  * @license    http://kohanaframework.org/license
  */
 return [
-    'kohanaview' => [
-        'renderer' => [
-            'html' => [
-                '_settings' => [
-                    'class'     => '\Ingenerator\KohanaView\Renderer\HTMLRenderer',
-                    'arguments' => ['%kohanaview.template.selector%', '%kohanaview.template.manager%'],
-                    'shared'    => TRUE,
-                ],
-            ],
-        ],
-        'template' => [
-            'compiler' => [
-                '_settings' => [
-                    'class'     => '\Ingenerator\KohanaView\TemplateCompiler',
-                    'arguments' => [],
-                    'shared'    => TRUE,
-                ],
-            ],
-            'manager'  => [
-                '_settings' => [
-                    'class'     => '\Ingenerator\KohanaView\TemplateManager\CFSTemplateManager',
-                    'arguments' => ['%kohanaview.template.compiler%', '@kohanaview.template_manager@'],
-                    'shared'    => TRUE,
-                ],
-            ],
-            'selector' => [
-                '_settings' => [
-                    'class'     => '\Ingenerator\KohanaView\ViewTemplateSelector',
-                    'arguments' => [],
-                    'shared'    => TRUE,
-                ],
-            ],
-        ],
-    ],
+	'kohanaview' => [
+		'renderer' => [
+			'html' => [
+				'_settings' => [
+					'class'     => '\Ingenerator\KohanaView\Renderer\HTMLRenderer',
+					'arguments' => ['%kohanaview.template.selector%', '%kohanaview.template.manager%'],
+					'shared'    => TRUE,
+				],
+			],
+		],
+		'template' => [
+			'compiler' => [
+				'_settings' => [
+					'class'     => '\Ingenerator\KohanaView\TemplateCompiler',
+					'arguments' => [],
+					'shared'    => TRUE,
+				],
+			],
+			'manager'  => [
+				'_settings' => [
+					'class'     => '\Ingenerator\KohanaView\TemplateManager\CFSTemplateManager',
+					'arguments' => ['%kohanaview.template.compiler%', '@kohanaview.template_manager@'],
+					'shared'    => TRUE,
+				],
+			],
+			'selector' => [
+				'_settings' => [
+					'class'     => '\Ingenerator\KohanaView\ViewTemplateSelector',
+					'arguments' => [],
+					'shared'    => TRUE,
+				],
+			],
+		],
+	],
 ];

config/kohanaview.php

Indentation +12 added lines, -12 removed lines

@@ -1,17 +1,17 @@
 <?php
 /**
- * Configuration for the KohanaView module
- *
- * @author     Andrew Coulton <andrew@ingenerator.com>
- * @copyright  2015 inGenerator Ltd
- * @license    http://kohanaframework.org/license
- */
+	 * Configuration for the KohanaView module
+	 *
+	 * @author     Andrew Coulton <andrew@ingenerator.com>
+	 * @copyright  2015 inGenerator Ltd
+	 * @license    http://kohanaframework.org/license
+	 */
 return [
-    'template_manager' => [
-        // Where compiled templates should be stored
-        'cache_dir'        => \Kohana::$cache_dir.'/compiled_templates',
+	'template_manager' => [
+		// Where compiled templates should be stored
+		'cache_dir'        => \Kohana::$cache_dir.'/compiled_templates',
 
-        // Whether to recompile all templates on the first use of that template even if it exists
-        'recompile_always' => (\Kohana::$environment === \Kohana::DEVELOPMENT),
-    ],
+		// Whether to recompile all templates on the first use of that template even if it exists
+		'recompile_always' => (\Kohana::$environment === \Kohana::DEVELOPMENT),
+	],
 ];

classes/Ingenerator/KohanaView/ViewModel.php

Indentation +10 added lines, -10 removed lines

@@ -1,9 +1,9 @@ 
 <?php
 /**
- * @author     Andrew Coulton <andrew@ingenerator.com>
- * @copyright  2015 inGenerator Ltd
- * @license    http://kohanaframework.org/license
- */
+	 * @author     Andrew Coulton <andrew@ingenerator.com>
+	 * @copyright  2015 inGenerator Ltd
+	 * @license    http://kohanaframework.org/license
+	 */
 
 namespace Ingenerator\KohanaView;
 
@@ -17,11 +17,11 @@ 
 interface ViewModel
 {
 
-    /**
-     * @param  array $variables
-     *
-     * @return void
-     */
-    public function display(array $variables);
+	/**
+	 * @param  array $variables
+	 *
+	 * @return void
+	 */
+	public function display(array $variables);
 
 }

classes/Ingenerator/KohanaView/ViewTemplateSelector.php

Indentation +50 added lines, -50 removed lines

@@ -20,60 +20,60 @@
 class ViewTemplateSelector
 {
 
-    /**
-     * @param ViewModel $view
-     *
-     * @return string
-     */
-    public function getTemplateName(ViewModel $view)
-    {
-        if ($view instanceof TemplateSpecifyingViewModel) {
-            return $this->validateSpecifiedTemplateName($view);
-        } else {
-            return $this->calculateTemplateFromClassName($view);
-        }
-    }
+	/**
+	 * @param ViewModel $view
+	 *
+	 * @return string
+	 */
+	public function getTemplateName(ViewModel $view)
+	{
+		if ($view instanceof TemplateSpecifyingViewModel) {
+			return $this->validateSpecifiedTemplateName($view);
+		} else {
+			return $this->calculateTemplateFromClassName($view);
+		}
+	}
 
-    /**
-     * @param TemplateSpecifyingViewModel $view
-     *
-     * @return mixed
-     * @throws \UnexpectedValueException if no template is provided
-     */
-    protected function validateSpecifiedTemplateName(TemplateSpecifyingViewModel $view)
-    {
-        $template   = $view->getTemplateName();
-        $view_class = get_class($view);
-        if ( ! $template) {
-            throw new \UnexpectedValueException(
-                "$view_class::getTemplateName() must return a template name, empty value returned"
-            );
-        }
+	/**
+	 * @param TemplateSpecifyingViewModel $view
+	 *
+	 * @return mixed
+	 * @throws \UnexpectedValueException if no template is provided
+	 */
+	protected function validateSpecifiedTemplateName(TemplateSpecifyingViewModel $view)
+	{
+		$template   = $view->getTemplateName();
+		$view_class = get_class($view);
+		if ( ! $template) {
+			throw new \UnexpectedValueException(
+				"$view_class::getTemplateName() must return a template name, empty value returned"
+			);
+		}
 
-        if ( ! is_string($template)) {
-            $type = is_object($template) ? get_class($template) : gettype($template);
-            throw new \UnexpectedValueException(
-                "$view_class::getTemplateName() must return a string template name, $type value returned"
-            );
-        }
+		if ( ! is_string($template)) {
+			$type = is_object($template) ? get_class($template) : gettype($template);
+			throw new \UnexpectedValueException(
+				"$view_class::getTemplateName() must return a string template name, $type value returned"
+			);
+		}
 
-        return $template;
-    }
+		return $template;
+	}
 
-    /**
-     * @param ViewModel $view
-     *
-     * @return string
-     */
-    protected function calculateTemplateFromClassName(ViewModel $view)
-    {
-        $template = get_class($view);
-        $template = preg_replace('/\\\\|_/', '/', $template);
-        $template = preg_replace('#(^view/?(model)?/)|(?<!/)(view/?(model)?$)#i', '', $template);
-        $template = preg_replace('/([a-z])([A-Z])/', '\1_\2', $template);
-        $template = strtolower($template);
+	/**
+	 * @param ViewModel $view
+	 *
+	 * @return string
+	 */
+	protected function calculateTemplateFromClassName(ViewModel $view)
+	{
+		$template = get_class($view);
+		$template = preg_replace('/\\\\|_/', '/', $template);
+		$template = preg_replace('#(^view/?(model)?/)|(?<!/)(view/?(model)?$)#i', '', $template);
+		$template = preg_replace('/([a-z])([A-Z])/', '\1_\2', $template);
+		$template = strtolower($template);
 
-        return $template;
-    }
+		return $template;
+	}
 
 }

classes/Ingenerator/KohanaView/ViewModel/AbstractViewModel.php

Indentation +77 added lines, -77 removed lines

@@ -37,92 +37,92 @@
  */
 abstract class AbstractViewModel implements ViewModel
 {
-    /**
-     * @var array The actual view data
-     */
-    protected $variables = [];
+	/**
+	 * @var array The actual view data
+	 */
+	protected $variables = [];
 
-    /**
-     * @var string[] The names of the valid set of fields that must be passed to the display() method
-     */
-    protected $expect_var_names = [];
+	/**
+	 * @var string[] The names of the valid set of fields that must be passed to the display() method
+	 */
+	protected $expect_var_names = [];
 
-    public function __construct()
-    {
-        // Assign the expect_var_names to ensure that we don't accidentally start requiring compiled fields
-        $this->expect_var_names = array_keys($this->variables);
-    }
+	public function __construct()
+	{
+		// Assign the expect_var_names to ensure that we don't accidentally start requiring compiled fields
+		$this->expect_var_names = array_keys($this->variables);
+	}
 
-    /**
-     * Get field values
-     *
-     * @param string $name
-     *
-     * @return mixed
-     */
-    public function __get($name)
-    {
-        if (array_key_exists($name, $this->variables)) {
-            return $this->variables[$name];
-        } elseif (method_exists($this, 'var_'.$name)) {
-            $method = 'var_'.$name;
+	/**
+	 * Get field values
+	 *
+	 * @param string $name
+	 *
+	 * @return mixed
+	 */
+	public function __get($name)
+	{
+		if (array_key_exists($name, $this->variables)) {
+			return $this->variables[$name];
+		} elseif (method_exists($this, 'var_'.$name)) {
+			$method = 'var_'.$name;
 
-            return $this->$method();
-        } else {
-            throw new \BadMethodCallException(static::class." does not define a '$name' field");
-        }
-    }
+			return $this->$method();
+		} else {
+			throw new \BadMethodCallException(static::class." does not define a '$name' field");
+		}
+	}
 
-    /**
-     * @param string $name
-     * @param mixed  $value
-     *
-     * @throws \BadMethodCallException values cannot be assigned except with the display method
-     */
-    public function __set($name, $value)
-    {
-        throw new \BadMethodCallException(static::class.' variables are read-only, cannot assign '.$name);
-    }
+	/**
+	 * @param string $name
+	 * @param mixed  $value
+	 *
+	 * @throws \BadMethodCallException values cannot be assigned except with the display method
+	 */
+	public function __set($name, $value)
+	{
+		throw new \BadMethodCallException(static::class.' variables are read-only, cannot assign '.$name);
+	}
 
-    /**
-     * Set the data to be rendered in the view - note this does not actually render the view.
-     *
-     * @param array $variables
-     */
-    public function display(array $variables)
-    {
-        if ($errors = $this->validateDisplayVariables($variables)) {
-            throw new \InvalidArgumentException(
-                "Invalid variables provided to ".static::class."::display()"
-                ."\n - ".implode("\n - ", $errors)
-            );
-        }
+	/**
+	 * Set the data to be rendered in the view - note this does not actually render the view.
+	 *
+	 * @param array $variables
+	 */
+	public function display(array $variables)
+	{
+		if ($errors = $this->validateDisplayVariables($variables)) {
+			throw new \InvalidArgumentException(
+				"Invalid variables provided to ".static::class."::display()"
+				."\n - ".implode("\n - ", $errors)
+			);
+		}
 
-        $this->variables = $variables;
-    }
+		$this->variables = $variables;
+	}
 
-    /**
-     * @param array $variables
-     *
-     * @return string[] of errors
-     */
-    protected function validateDisplayVariables(array $variables)
-    {
-        $errors             = [];
-        $provided_variables = array_keys($variables);
-        foreach (array_diff($provided_variables, $this->expect_var_names) as $unexpected_var) {
-            if (method_exists($this, 'var_'.$unexpected_var)) {
-                $errors[] = "'$unexpected_var' conflicts with ::var_$unexpected_var()";
-            } else {
-                $errors[] = "'$unexpected_var' is not expected";
-            }
-        }
+	/**
+	 * @param array $variables
+	 *
+	 * @return string[] of errors
+	 */
+	protected function validateDisplayVariables(array $variables)
+	{
+		$errors             = [];
+		$provided_variables = array_keys($variables);
+		foreach (array_diff($provided_variables, $this->expect_var_names) as $unexpected_var) {
+			if (method_exists($this, 'var_'.$unexpected_var)) {
+				$errors[] = "'$unexpected_var' conflicts with ::var_$unexpected_var()";
+			} else {
+				$errors[] = "'$unexpected_var' is not expected";
+			}
+		}
 
-        foreach (array_diff($this->expect_var_names, $provided_variables) as $missing_var) {
-            $errors[] = "'$missing_var' is missing";
-        }
+		foreach (array_diff($this->expect_var_names, $provided_variables) as $missing_var) {
+			$errors[] = "'$missing_var' is missing";
+		}
 
-        return $errors;
-    }
+		return $errors;
+	}
 
 }