ingenerator / kohana-view

classes/Ingenerator/View/Layout.php

Indentation +141 added lines, -141 removed lines

@@ -22,146 +22,146 @@
  */
 abstract class Ingenerator_View_Layout extends View_Model
 {
-    // The name of the template model to use
-    public $template = 'Global';
-
-    // Whether to render the view within the template or not, null for auto
-    protected $_use_template = null;
-
-    /**
-     * Sets a new template to use for this view model. By default template names
-     * become View_Template_$template classes.
-     *
-     * @param string $template
-     */
-    public function set_template($template)
-    {
-        $this->template = $template;
-    }
-
-    /**
-     * Returns the View_Model representing the template layout (instantiating it
-     * if it has not previously been created).
-     *
-     * @return View_Model
-     */
-    public function var_page()
-    {
-        if ( is_string($this->template))
-        {
-            $class = 'View_Template_'.$this->template;
-            if ( ! class_exists($class))
-            {
-                $class = 'View';
-            }
-            $this->template = new $class();
-        }
-        return $this->template;
-    }
-
-    /**
-     * Hook called just before the body content is rendered, as a useful extension
-     * point for transforming any data or setting variables on the page template.
-     *
-     *     class View_Index extends View_Layout
-     *     {
-     *         public function pre_render()
-     *         {
-     *             $page = $this->var_page();
-     *             $page->title = 'Index';
-     *         }
-     *     }
-     */
-    public function pre_render()
-    {
-    }
-
-    /**
-     * Hook called just after the body content is rendered, as a useful extension
-     * point for transforming any data or setting variables on the page template.
-     *
-     * @see View_Layout::pre_render()
-     */
-    public function post_render()
-    {
-    }
-
-
-    /**
-     * Renders the body content (calling [View_Layout::pre_render()] and
-     * [View_Layout::post_render()] in the process).
-     *
-     * If required, the body content will then be passed to the template view
-     * for rendering within the page layout and the fully templated page returned.
-     * Otherwise, the body fragment is returned alone and the page template is
-     * never rendered.
-     *
-     * @param string $file If wishing to generate a view to a file
-     * @return string The formatted view content
-     */
-    public function render($file = null)
-    {
-        $this->pre_render();
-
-        // Generate the body content
-        $body = parent::render($file);
-
-        $this->post_render();
-
-        // Render the template if required
-        if ($this->use_template())
-        {
-            $template = $this->var_page();
-            $template->set('var_body', $body);
-            return $template->render();
-        }
-
-        return $body;
-    }
-
-    /**
-     * Setter/Getter for the use_template setting determining whether or not to
-     * render the page template or just the body fragment.
-     *
-     * By default, $this-_use_template is null, meaning the class should determine
-     * automatically based on whether the request is an AJAX request.
-     *
-     * If manually set true or false, the class will respect this value.
-     *
-     * @uses Request::is_ajax
-     * @uses Request::current()
-     *
-     * @param boolean $use_template
-     * @return boolean If called as getter
-     * @return View_Layout If called as setter
-     */
-    public function use_template($use_template = null)
-    {
-        // If we're being called as a setter
-        if ($use_template !== null)
-        {
-            $this->_use_template = $use_template;
-            return $this;
-        }
-
-        // If an explicit value was set
-        if ($this->_use_template !== null)
-        {
-            return $this->_use_template;
-        }
-
-        // Guess based on is_ajax
-        if (Request::current())
-        {
-            if (Request::current()->is_ajax())
-            {
-                return false;
-            }
-            else
-            {
-                return true;
-            }
-        }
-    }
+	// The name of the template model to use
+	public $template = 'Global';
+
+	// Whether to render the view within the template or not, null for auto
+	protected $_use_template = null;
+
+	/**
+	 * Sets a new template to use for this view model. By default template names
+	 * become View_Template_$template classes.
+	 *
+	 * @param string $template
+	 */
+	public function set_template($template)
+	{
+		$this->template = $template;
+	}
+
+	/**
+	 * Returns the View_Model representing the template layout (instantiating it
+	 * if it has not previously been created).
+	 *
+	 * @return View_Model
+	 */
+	public function var_page()
+	{
+		if ( is_string($this->template))
+		{
+			$class = 'View_Template_'.$this->template;
+			if ( ! class_exists($class))
+			{
+				$class = 'View';
+			}
+			$this->template = new $class();
+		}
+		return $this->template;
+	}
+
+	/**
+	 * Hook called just before the body content is rendered, as a useful extension
+	 * point for transforming any data or setting variables on the page template.
+	 *
+	 *     class View_Index extends View_Layout
+	 *     {
+	 *         public function pre_render()
+	 *         {
+	 *             $page = $this->var_page();
+	 *             $page->title = 'Index';
+	 *         }
+	 *     }
+	 */
+	public function pre_render()
+	{
+	}
+
+	/**
+	 * Hook called just after the body content is rendered, as a useful extension
+	 * point for transforming any data or setting variables on the page template.
+	 *
+	 * @see View_Layout::pre_render()
+	 */
+	public function post_render()
+	{
+	}
+
+
+	/**
+	 * Renders the body content (calling [View_Layout::pre_render()] and
+	 * [View_Layout::post_render()] in the process).
+	 *
+	 * If required, the body content will then be passed to the template view
+	 * for rendering within the page layout and the fully templated page returned.
+	 * Otherwise, the body fragment is returned alone and the page template is
+	 * never rendered.
+	 *
+	 * @param string $file If wishing to generate a view to a file
+	 * @return string The formatted view content
+	 */
+	public function render($file = null)
+	{
+		$this->pre_render();
+
+		// Generate the body content
+		$body = parent::render($file);
+
+		$this->post_render();
+
+		// Render the template if required
+		if ($this->use_template())
+		{
+			$template = $this->var_page();
+			$template->set('var_body', $body);
+			return $template->render();
+		}
+
+		return $body;
+	}
+
+	/**
+	 * Setter/Getter for the use_template setting determining whether or not to
+	 * render the page template or just the body fragment.
+	 *
+	 * By default, $this-_use_template is null, meaning the class should determine
+	 * automatically based on whether the request is an AJAX request.
+	 *
+	 * If manually set true or false, the class will respect this value.
+	 *
+	 * @uses Request::is_ajax
+	 * @uses Request::current()
+	 *
+	 * @param boolean $use_template
+	 * @return boolean If called as getter
+	 * @return View_Layout If called as setter
+	 */
+	public function use_template($use_template = null)
+	{
+		// If we're being called as a setter
+		if ($use_template !== null)
+		{
+			$this->_use_template = $use_template;
+			return $this;
+		}
+
+		// If an explicit value was set
+		if ($this->_use_template !== null)
+		{
+			return $this->_use_template;
+		}
+
+		// Guess based on is_ajax
+		if (Request::current())
+		{
+			if (Request::current()->is_ajax())
+			{
+				return false;
+			}
+			else
+			{
+				return true;
+			}
+		}
+	}
 
 }

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      */
     public function var_page()
     {
-        if ( is_string($this->template))
+        if (is_string($this->template))
         {
             $class = 'View_Template_'.$this->template;
             if ( ! class_exists($class))

Braces +1 added lines, -2 removed lines

@@ -156,8 +156,7 @@
             if (Request::current()->is_ajax())
             {
                 return false;
-            }
-            else
+            } else
             {
                 return true;
             }

classes/Ingenerator/View/Template/Global.php

Indentation +1 added lines, -1 removed lines

@@ -16,5 +16,5 @@
  */
 abstract class Ingenerator_View_Template_Global extends View_Model
 {
-    public $var_title = 'Page title';
+	public $var_title = 'Page title';
 }

views/template/global.php

Indentation +6 added lines, -6 removed lines

@@ -1,11 +1,11 @@
 <?php
 /**
- * Basic global template view, rendered by the View_Template_Global class.
- *
- * @see View_Template_Global
- * @var string $title Page title
- * @var string $body  Page body HTML
- */
+   * Basic global template view, rendered by the View_Template_Global class.
+   *
+   * @see View_Template_Global
+   * @var string $title Page title
+   * @var string $body  Page body HTML
+   */
 ?>
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>

Spacing +2 added lines, -2 removed lines

@@ -10,9 +10,9 @@
 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
 <html>
     <head>
-        <title><?=$title;?></title>
+        <title><?=$title; ?></title>
     </head>
     <body>
-        <?=$body;?>
+        <?=$body; ?>
     </body>
 </html>

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;
+	}
 
 }

koharness.php

Indentation +7 added lines, -7 removed lines

@@ -1,13 +1,13 @@
 <?php
 /**
- * Configuration for the koharness module testing environment.
- * 
- * @author    Andrew Coulton <andrew@ingenerator.com>
- * @copyright 2013 inGenerator Ltd
- * @link      https://github.com/ingenerator/koharness
- */
+	 * Configuration for the koharness module testing environment.
+	 * 
+	 * @author    Andrew Coulton <andrew@ingenerator.com>
+	 * @copyright 2013 inGenerator Ltd
+	 * @link      https://github.com/ingenerator/koharness
+	 */
 return array(
   'modules' => array(
-    'kohana-view' => __DIR__,
+	'kohana-view' => __DIR__,
   )
 );

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);
 
 }