ingenerator / kohana-view

classes/Ingenerator/KohanaView/Exception/UnspecifiedTemplateNameException.php

Indentation +31 added lines, -31 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\Exception;
 
@@ -16,33 +16,33 @@ 
 class UnspecifiedTemplateNameException extends \UnexpectedValueException
 {
 
-    /**
-     * @param string $view_class
-     *
-     * @return static
-     */
-    public static function forEmptyValue($view_class)
-    {
-        return new static(
-            $view_class.'::getTemplateName() must return a template name, empty value returned'
-        );
-    }
+	/**
+	 * @param string $view_class
+	 *
+	 * @return static
+	 */
+	public static function forEmptyValue($view_class)
+	{
+		return new static(
+			$view_class.'::getTemplateName() must return a template name, empty value returned'
+		);
+	}
 
-    /**
-     * @param string $view_class
-     * @param string $template
-     *
-     * @return static
-     */
-    public static function forNonStringValue($view_class, $template)
-    {
-        return new static(
-            sprintf(
-                '%s::getTemplateName() must return a string template name, %s value returned',
-                $view_class,
-                is_object($template) ? get_class($template) : gettype($template)
-            )
-        );
-    }
+	/**
+	 * @param string $view_class
+	 * @param string $template
+	 *
+	 * @return static
+	 */
+	public static function forNonStringValue($view_class, $template)
+	{
+		return new static(
+			sprintf(
+				'%s::getTemplateName() must return a string template name, %s value returned',
+				$view_class,
+				is_object($template) ? get_class($template) : gettype($template)
+			)
+		);
+	}
 
 }

classes/Ingenerator/KohanaView/TemplateCompiler.php

Indentation +68 added lines, -68 removed lines

@@ -33,83 +33,83 @@
 class TemplateCompiler
 {
 
-    /**
-     * @var array
-     */
-    protected $options = [
-        'raw_output_prefix' => '!',
-        'escape_method'     => 'HTML::chars',
-    ];
+	/**
+	 * @var array
+	 */
+	protected $options = [
+		'raw_output_prefix' => '!',
+		'escape_method'     => 'HTML::chars',
+	];
 
-    /**
-     * @param array $options
-     */
-    public function __construct(array $options = [])
-    {
-        $this->options = array_merge($this->options, $options);
-    }
+	/**
+	 * @param array $options
+	 */
+	public function __construct(array $options = [])
+	{
+		$this->options = array_merge($this->options, $options);
+	}
 
-    /**
-     * Compile a string containing a PHP template, automatically escaping variables that are echoed in PHP short tags,
-     * and return the compiled PHP string.
-     *
-     * @param string $source
-     *
-     * @return string
-     * @throws \InvalidArgumentException if the template is empty or invalid
-     */
-    public function compile($source)
-    {
-        if ( ! $source) {
-            throw InvalidTemplateContentException::forEmptyTemplate();
-        }
+	/**
+	 * Compile a string containing a PHP template, automatically escaping variables that are echoed in PHP short tags,
+	 * and return the compiled PHP string.
+	 *
+	 * @param string $source
+	 *
+	 * @return string
+	 * @throws \InvalidArgumentException if the template is empty or invalid
+	 */
+	public function compile($source)
+	{
+		if ( ! $source) {
+			throw InvalidTemplateContentException::forEmptyTemplate();
+		}
 
-        return preg_replace_callback('/<\?=(.+?)(;|\?>)/s', [$this, 'compilePhpShortTag'], $source);
-    }
+		return preg_replace_callback('/<\?=(.+?)(;|\?>)/s', [$this, 'compilePhpShortTag'], $source);
+	}
 
-    /**
-     * @param string[] $matches
-     *
-     * @return string
-     */
-    protected function compilePhpShortTag($matches)
-    {
-        $var               = trim($matches[1]);
-        $terminator        = $matches[2];
-        $escape_method     = $this->options['escape_method'];
-        $raw_output_prefix = $this->options['raw_output_prefix'];
+	/**
+	 * @param string[] $matches
+	 *
+	 * @return string
+	 */
+	protected function compilePhpShortTag($matches)
+	{
+		$var               = trim($matches[1]);
+		$terminator        = $matches[2];
+		$escape_method     = $this->options['escape_method'];
+		$raw_output_prefix = $this->options['raw_output_prefix'];
 
-        if ($this->startsWith($var, $raw_output_prefix)) {
-            // Remove prefix and echo unescaped
-            $compiled = '<?='.trim(substr($var, strlen($raw_output_prefix))).';';
-        } elseif ($this->startsWith($var, '//')) {
-            // Echo an empty string to prevent the comment causing a parse error
-            $compiled = "<?='';$var;";
+		if ($this->startsWith($var, $raw_output_prefix)) {
+			// Remove prefix and echo unescaped
+			$compiled = '<?='.trim(substr($var, strlen($raw_output_prefix))).';';
+		} elseif ($this->startsWith($var, '//')) {
+			// Echo an empty string to prevent the comment causing a parse error
+			$compiled = "<?='';$var;";
 
-        } elseif ($this->startsWith($var, $escape_method)) {
-            throw InvalidTemplateContentException::containsImplicitDoubleEscape($escape_method, $matches[0]);
+		} elseif ($this->startsWith($var, $escape_method)) {
+			throw InvalidTemplateContentException::containsImplicitDoubleEscape($escape_method, $matches[0]);
 
-        } else {
-            // Escape the value before echoing
-            $compiled = "<?={$escape_method}($var);";
-        }
+		} else {
+			// Escape the value before echoing
+			$compiled = "<?={$escape_method}($var);";
+		}
 
-        if ($terminator === '?>') {
-            $compiled .= '?>';
-        }
+		if ($terminator === '?>') {
+			$compiled .= '?>';
+		}
 
-        return $compiled;
-    }
+		return $compiled;
+	}
 
-    /**
-     * @param string $string
-     * @param string $prefix
-     *
-     * @return bool
-     */
-    protected function startsWith($string, $prefix)
-    {
-        return (strncmp($string, $prefix, strlen($prefix)) === 0);
-    }
+	/**
+	 * @param string $string
+	 * @param string $prefix
+	 *
+	 * @return bool
+	 */
+	protected function startsWith($string, $prefix)
+	{
+		return (strncmp($string, $prefix, strlen($prefix)) === 0);
+	}
 
 }

classes/Ingenerator/KohanaView/TemplateManager/CFSTemplateManager.php

Indentation +112 added lines, -112 removed lines

@@ -24,117 +24,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 TemplateNotFoundException::forSourcePath('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 TemplateCacheException::pathNotWriteable($path);
-            }
-        } else {
-            if ( ! mkdir($path, 0777, TRUE)) {
-                throw TemplateCacheException::cannotCreateDirectory($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 TemplateNotFoundException::forSourcePath('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 TemplateCacheException::pathNotWriteable($path);
+			}
+		} else {
+			if ( ! mkdir($path, 0777, TRUE)) {
+				throw TemplateCacheException::cannotCreateDirectory($path);
+			}
+		}
+	}
 
 }

classes/Ingenerator/KohanaView/ViewModel/AbstractViewModel.php

Indentation +74 added lines, -74 removed lines

@@ -40,89 +40,89 @@
  */
 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 UndefinedViewVarException::forClassAndVar(static::class, $name);
-        }
-    }
+			return $this->$method();
+		} else {
+			throw UndefinedViewVarException::forClassAndVar(static::class, $name);
+		}
+	}
 
-    /**
-     * @param string $name
-     * @param mixed  $value
-     *
-     * @throws \BadMethodCallException values cannot be assigned except with the display method
-     */
-    public function __set($name, $value)
-    {
-        throw InvalidViewVarAssignmentException::forReadOnlyVar(static::class, $name);
-    }
+	/**
+	 * @param string $name
+	 * @param mixed  $value
+	 *
+	 * @throws \BadMethodCallException values cannot be assigned except with the display method
+	 */
+	public function __set($name, $value)
+	{
+		throw InvalidViewVarAssignmentException::forReadOnlyVar(static::class, $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 InvalidDisplayVariablesException::passedToDisplay(static::class, $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 InvalidDisplayVariablesException::passedToDisplay(static::class, $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;
+	}
 
 }

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

Indentation +13 added lines, -13 removed lines

@@ -12,21 +12,21 @@
 
 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 UnassignedViewVarException::forVariable(static::class, 'page_path', 'name/of/view');
-        }
+	/**
+	 * {@inheritdoc}
+	 */
+	public function getTemplateName()
+	{
+		if ( ! $this->variables['page_path']) {
+			throw UnassignedViewVarException::forVariable(static::class, 'page_path', 'name/of/view');
+		}
 
-        return $this->variables['page_path'];
-    }
+		return $this->variables['page_path'];
+	}
 
 
 }

classes/Ingenerator/KohanaView/ViewTemplateSelector.php

Indentation +45 added lines, -45 removed lines

@@ -22,55 +22,55 @@
 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 UnspecifiedTemplateNameException::forEmptyValue($view_class);
-        }
+	/**
+	 * @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 UnspecifiedTemplateNameException::forEmptyValue($view_class);
+		}
 
-        if ( ! is_string($template)) {
-            throw UnspecifiedTemplateNameException::forNonStringValue($view_class, $template);
-        }
+		if ( ! is_string($template)) {
+			throw UnspecifiedTemplateNameException::forNonStringValue($view_class, $template);
+		}
 
-        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;
+	}
 
 }