ingenerator / kohana-view

classes/Ingenerator/KohanaView/ViewTemplateSelector.php

Indentation +51 added lines, -51 removed lines

@@ -18,61 +18,61 @@
 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 = preg_replace('/\\\\|_/', '/', get_class($view));
-        $template = preg_replace('/([a-z])([A-Z])/', '\1_\2', $template);
-        $template = strtolower($template);
-        if (substr($template, 0, 5) === 'view/') {
-            $template = substr($template, 5);
-        }
+	/**
+	 * @param ViewModel $view
+	 *
+	 * @return string
+	 */
+	protected function calculateTemplateFromClassName(ViewModel $view)
+	{
+		$template = preg_replace('/\\\\|_/', '/', get_class($view));
+		$template = preg_replace('/([a-z])([A-Z])/', '\1_\2', $template);
+		$template = strtolower($template);
+		if (substr($template, 0, 5) === 'view/') {
+			$template = substr($template, 5);
+		}
 
-        return $template;
-    }
+		return $template;
+	}
 
 }

classes/Ingenerator/KohanaView/ViewModel.php

Indentation +9 added lines, -9 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,10 +17,10 @@ 
 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/ViewModel/AbstractViewModel.php

Indentation +68 added lines, -68 removed lines

@@ -37,81 +37,81 @@
  */
 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)
-    {
-        $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";
-        }
+	/**
+	 * 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)
+	{
+		$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";
+		}
 
-        if ( ! empty($errors)) {
-            throw new \InvalidArgumentException(
-                "Invalid variables provided to ".static::class."::display()"
-                ."\n - ".implode("\n - ", $errors)
-            );
-        }
+		if ( ! empty($errors)) {
+			throw new \InvalidArgumentException(
+				"Invalid variables provided to ".static::class."::display()"
+				."\n - ".implode("\n - ", $errors)
+			);
+		}
 
-        $this->variables = $variables;
-    }
+		$this->variables = $variables;
+	}
 
 }

classes/Ingenerator/KohanaView/TemplateCompiler.php

Indentation +71 added lines, -71 removed lines

@@ -31,86 +31,86 @@
 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 new \InvalidArgumentException('Cannot compile empty template');
-        }
+	/**
+	 * 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 new \InvalidArgumentException('Cannot compile empty template');
+		}
 
-        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)) {
-            // Try to help user to avoid accidental double-escaping
-            throw new \InvalidArgumentException(
-                "Invalid implicit double-escape in template - remove $escape_method from {$matches[0]} or mark as raw"
-            );
+		} elseif ($this->startsWith($var, $escape_method)) {
+			// Try to help user to avoid accidental double-escaping
+			throw new \InvalidArgumentException(
+				"Invalid implicit double-escape in template - remove $escape_method from {$matches[0]} or mark as raw"
+			);
 
-        } 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.php

Indentation +6 added lines, -6 removed lines

@@ -17,11 +17,11 @@
 interface TemplateManager
 {
 
-    /**
-     * @param string $template_name Name of the template to use (can include path separators)
-     *
-     * @return string Path to the compiled template file
-     */
-    public function getPath($template_name);
+	/**
+	 * @param string $template_name Name of the template to use (can include path separators)
+	 *
+	 * @return string Path to the compiled template file
+	 */
+	public function getPath($template_name);
 
 }

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 CFSWrapper       $cascading_files
-     * @param TemplateCompiler $compiler
-     * @param array            $options
-     */
-    public function __construct(CFSWrapper $cascading_files, TemplateCompiler $compiler, array $options)
-    {
-        $this->cascading_files  = $cascading_files;
-        $this->compiler         = $compiler;
-        $this->cache_dir        = trim($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 CFSWrapper       $cascading_files
+	 * @param TemplateCompiler $compiler
+	 * @param array            $options
+	 */
+	public function __construct(CFSWrapper $cascading_files, TemplateCompiler $compiler, array $options)
+	{
+		$this->cascading_files  = $cascading_files;
+		$this->compiler         = $compiler;
+		$this->cache_dir        = trim($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'");
+			}
+		}
+	}
 
 }

classes/Ingenerator/KohanaView/TemplateManager/CFSWrapper.php

Indentation +7 added lines, -7 removed lines

@@ -15,11 +15,11 @@
 class CFSWrapper
 {
 
-    /**
-     * @see \Kohana::find_file
-     */
-    public function find_file($dir, $file)
-    {
-        return \Kohana::find_file($dir, $file, NULL, FALSE);
-    }
+	/**
+	 * @see \Kohana::find_file
+	 */
+	public function find_file($dir, $file)
+	{
+		return \Kohana::find_file($dir, $file, NULL, FALSE);
+	}
 }

classes/Ingenerator/KohanaView/TemplateSpecifyingViewModel.php

Indentation +8 added lines, -8 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;
 
@@ -16,8 +16,8 @@ 
 interface TemplateSpecifyingViewModel
 {
 
-    /**
-     * @return string
-     */
-    public function getTemplateName();
+	/**
+	 * @return string
+	 */
+	public function getTemplateName();
 }

classes/Ingenerator/KohanaView/Renderer.php

Indentation +6 added lines, -6 removed lines

@@ -17,11 +17,11 @@
 interface Renderer
 {
 
-    /**
-     * @param ViewModel $view
-     *
-     * @return string
-     */
-    public function render(ViewModel $view);
+	/**
+	 * @param ViewModel $view
+	 *
+	 * @return string
+	 */
+	public function render(ViewModel $view);
 
 }