/fuel/core/classes/viewmodel.php

<?php

/**

 * Part of the Fuel framework.

 *

 * @package    Fuel

 * @version    1.0

 * @author     Fuel Development Team

 * @license    MIT License

 * @copyright  2010 - 2011 Fuel Development Team

 * @link       http://fuelphp.com

 */



namespace Fuel\Core;





/**

 * ViewModel

 *

 * @package	    Fuel

 * @subpackage  Core

 * @category    Core

 * @author      Jelmer Schreuder

 */

abstract class ViewModel

{



	/**

	 * This method is deprecated...use forge() instead.

	 *

	 * @deprecated until 1.2

	 */

	public static function factory($viewmodel, $method = 'view')

	{

		logger(\Fuel::L_WARNING, 'This method is deprecated.  Please use a forge() instead.', __METHOD__);

		return static::forge($viewmodel, $method);

	}



	/**

	 * Factory for fetching the ViewModel

	 *

	 * @param   string  ViewModel classname without View_ prefix or full classname

	 * @param   string  Method to execute

	 * @return  ViewModel

	 */

	public static function forge($viewmodel, $method = 'view', $auto_filter = null)

	{

		$namespace = \Request::active() ? ucfirst(\Request::active()->module) : '';

		$class = $namespace.'\\View_'.ucfirst(str_replace(array('/', DS), '_', $viewmodel));



		if ( ! class_exists($class))

		{

			if ( ! class_exists($class = $viewmodel))

			{

				throw new \OutOfBoundsException('ViewModel "View_'.ucfirst(str_replace(array('/', DS), '_', $viewmodel)).'" could not be found.');

			}

		}



		return new $class($method, $auto_filter);

	}



	/**

	 * @var  string  method to execute when rendering

	 */

	protected $_method;



	/**

	 * @var  string|View  view name, after instantiation a View object

	 * @deprecated until v1.2

	 */

	protected $_template;



	/**

	 * @var  string|View  view name, after instantiation a View object

	 */

	protected $_view;



	/**

	 * @var  bool  whether or not to use auto filtering

	 */

	protected $_auto_filter;



	/**

	 * @var  Request  active request during ViewModel creation for proper context

	 */

	protected $_active_request;



	protected function __construct($method, $auto_filter = null)

	{

		$this->_auto_filter = $auto_filter;

		class_exists('Request', false) and $this->_active_request = \Request::active();



		// @TODO Remove in 1.2.  This is for backwards compat only.

		empty($this->_view) and $this->_view = $this->_template;



		if (empty($this->_view))

		{

			// Take the class name and guess the view name

			$class = get_class($this);

			$this->_view = strtolower(str_replace('_', DS, preg_replace('#^([a-z0-9_]*\\\\)?(View_)?#i', '', $class)));

		}



		$this->set_view();



		// @TODO Remove in 1.2.  This is for backwards compat only.

		if ( ! empty($this->_template))

		{

			logger(\Fuel::L_WARNING, '$this->_template is deprecated.  Please use a $this->_view instead.', __METHOD__);

			$this->_view = $this->_template;

		}



		$this->_method = $method;



		$this->before();

	}



	/**

	 * Must return a View object or something compatible

	 *

	 * @return     Object  any object on which the template vars can be set and which has a toString method

	 * @deprecated until 1.2

	 */

	protected function set_template()

	{

		logger(\Fuel::L_WARNING, 'This method is deprecated.  Please use a $this->set_view() instead.', __METHOD__);

		return $this->set_view();

	}



	/**

	 * Must return a View object or something compatible

	 *

	 * @return  Object  any object on which the template vars can be set and which has a toString method

	 */

	protected function set_view()

	{

		$this->_view = \View::forge($this->_view);

	}



	/**

	 * Returns the active request object.

	 *

	 * @return  Request

	 */

	protected function request()

	{

		return $this->_active_request;

	}



	/**

	 * Executed before the view method

	 */

	public function before() {}



	/**

	 * The default view method

	 * Should set all expected variables upon itself

	 */

	public function view() {}



	/**

	 * Executed after the view method

	 */

	public function after() {}



	/**

	 * Fetches an existing value from the template

	 *

	 * @return  mixed

	 */

	public function & __get($name)

	{

		return $this->get($name);

	}



	/**

	 * Gets a variable from the template

	 *

	 * @param  string

	 */

	public function & get($key, $default = null)

	{

		if (is_null($default) and func_num_args() === 1)

		{

			return $this->_view->get($key);

		}

		return $this->_view->get($key, $default);

	}



	/**

	 * Sets and sanitizes a variable on the template

	 *

	 * @param  string

	 * @param  mixed

	 */

	public function __set($key, $value)

	{

		return $this->set($key, $value);

	}



	/**

	 * Sets a variable on the template

	 *

	 * @param  string

	 * @param  mixed

	 * @param  bool|null

	 */

	public function set($key, $value, $filter = null)

	{

		is_null($filter) and $filter = $this->_auto_filter;

		$this->_view->set($key, $value, $filter);



		return $this;

	}



	/**

	 * Magic method, determines if a variable is set.

	 *

	 *     isset($view->foo);

	 *

	 * @param   string  variable name

	 * @return  boolean

	 */

	public function __isset($key)

	{

		return isset($this->_view->$key);

	}



	/**

	 * Assigns a value by reference. The benefit of binding is that values can

	 * be altered without re-setting them. It is also possible to bind variables

	 * before they have values. Assigned values will be available as a

	 * variable within the view file:

	 *

	 *     $this->bind('ref', $bar);

	 *

	 * @param   string   variable name

	 * @param   mixed    referenced variable

	 * @param   bool     Whether to filter the var on output

	 * @return  $this

	 */

	public function bind($key, &$value, $filter = null)

	{

		$this->_view->bind($key, $value, $filter);



		return $this;

	}



	/**

	 * Change auto filter setting

	 *

	 * @param   null|bool  change setting (bool) or get the current setting (null)

	 * @return  void|bool  returns current setting or nothing when it is changed

	 */

	public function auto_filter($setting = null)

	{

		if (func_num_args() == 0)

		{

			return $this->_view->auto_filter();

		}



		return $this->_view->auto_filter($setting);

	}





	/**

	 * Add variables through method and after() and create template as a string

	 */

	public function render()

	{

		if (class_exists('Request', false))

		{

			$current_request = Request::active();

			Request::active($this->_active_request);

		}



		$this->{$this->_method}();

		$this->after();



		$return = $this->_view->render();



		if (class_exists('Request', false))

		{

			Request::active($current_request);

		}



		return $return;

	}



	/**

	 * Auto-render on toString

	 */

	public function __toString()

	{

		try

		{

			return $this->render();

		}

		catch (\Exception $e)

		{

			\Error::exception_handler($e);



			return '';

		}

	}

}