cakephp2-php8/cake/libs/view/view.php
phpnut f0fe2102ec Updated VERSION file
Merging:

Revision: [1644]
Bad merge last commit had second param in the class_exists() call

Revision: [1643]
Fixed errors introduced in last changes:
Variable that was passed the loadController function was not expected controller class name,
It was the name fo the class without Controller. This would cause the loading to fail, since
it was possible that a class was already loaded with the name that was passed.
Example NewsController and a model called News.

Revision: [1642]
Added patch for MySql 5

Revision: [1641]
removing second parameter in the class_exists function calls.
closes Ticket #209

git-svn-id: https://svn.cakephp.org/repo/trunk/cake@1645 3807eeeb-6ff5-0310-8944-8be069107fe0
2005-12-27 17:14:32 +00:00

650 lines
No EOL
18 KiB
PHP

<?php
/* SVN FILE: $Id$ */
/**
* Methods for displaying presentation data
*
*
* PHP versions 4 and 5
*
* CakePHP : Rapid Development Framework <http://www.cakephp.org/>
* Copyright (c) 2005, Cake Software Foundation, Inc.
* 1785 E. Sahara Avenue, Suite 490-204
* Las Vegas, Nevada 89104
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @filesource
* @copyright Copyright (c) 2005, Cake Software Foundation, Inc.
* @link http://www.cakefoundation.org/projects/info/cakephp CakePHP Project
* @package cake
* @subpackage cake.cake.libs.view
* @since CakePHP v 0.10.0.1076
* @version $Revision$
* @modifiedby $LastChangedBy$
* @lastmodified $Date$
* @license http://www.opensource.org/licenses/mit-license.php The MIT License
*/
/**
* Included libraries.
*/
uses(DS.'view'.DS.'helper');
/**
* View, the V in the MVC triad.
*
* Class holding methods for displaying presentation data.
*
* @package cake
* @subpackage cake.cake.libs.view
* @since CakePHP v 0.10.0.1076
*/
class View extends Object
{
/**
* Name of the controller.
*
* @var string Name of controller
* @access public
*/
var $name = null;
/**
* Stores the current URL (for links etc.)
*
* @var string Current URL
*/
var $here = null;
/**
* Not used. 2005-09
*
* @var unknown_type
* @access public
*/
var $parent = null;
/**
* Action to be performed.
*
* @var string Name of action
* @access public
*/
var $action = null;
/**
* An array of names of models the particular controller wants to use.
*
* @var mixed A single name as a string or a list of names as an array.
* @access protected
*/
var $uses = false;
/**
* An array of names of built-in helpers to include.
*
* @var mixed A single name as a string or a list of names as an array.
* @access protected
*/
var $helpers = array('Html');
/**
* Path to View.
*
* @var string Path to View
*/
var $viewPath;
/**
* Variables for the view
*
* @var array
* @access private
*/
var $_viewVars = array();
/**
* Title HTML element of this View.
*
* @var boolean
* @access private
*/
var $pageTitle = false;
/**
* An array of model objects.
*
* @var array Array of model objects.
* @access public
*/
var $models = array();
/**
* Path parts for creating links in views.
*
* @var string Base URL
* @access public
*/
var $base = null;
/**
* Name of layout to use with this View.
*
* @var string
* @access public
*/
var $layout = 'default';
/**
* Turns on or off Cake's conventional mode of rendering views. On by default.
*
* @var boolean
* @access public
*/
var $autoRender = true;
/**
* Turns on or off Cake's conventional mode of finding layout files. On by default.
*
* @var boolean
* @access public
*/
var $autoLayout = true;
/**
* Array of parameter data
*
* @var array Parameter data
*/
var $params;
/**
* True when the view has been rendered.
*
* @var boolean
*/
var $hasRendered = null;
/**
* Enter description here...
*
* @var boolean
*/
var $controller = null;
/**
* Constructor
*
* @return View
*/
function View(&$controller)
{
$this->controller =& $controller;
$this->_viewVars =& $this->controller->_viewVars;
$this->action =& $this->controller->action;
$this->autoLayout =& $this->controller->autoLayout;
$this->autoRender =& $this->controller->autoRender;
$this->base =& $this->controller->base;
$this->webroot =& $this->controller->webroot;
$this->helpers =& $this->controller->helpers;
$this->here =& $this->controller->here;
$this->layout =& $this->controller->layout;
$this->modelNames =& $this->controller->modelNames;
$this->name =& $this->controller->name;
$this->pageTitle =& $this->controller->pageTitle;
$this->parent =& $this->controller->parent;
$this->viewPath =& $this->controller->viewPath;
$this->params =& $this->controller->params;
$this->data =& $this->controller->data;
$this->displayFields =& $this->controller->displayFields;
$this->webservices =& $this->controller->webservices;
}
/**
* Returns a view instance (singleton)
*
* @return object
*/
function getInstance()
{
static $instance;
if (!isset($instance))
{
$instance[0] =& new View();
}
return $instance[0];
}
/**
* Renders view for given action and layout. If $file is given, that is used
* for a view filename (e.g. customFunkyView.thtml).
*
* @param string $action Name of action to render for
* @param string $layout Layout to use
* @param string $file Custom filename for view
*/
function render($action=null, $layout=null, $file=null)
{
if (isset($this->hasRendered) && $this->hasRendered)
{
return true;
}
else
{
$this->hasRendered = false;
}
$this->autoRender = false;
if (!$action)
{
$action = $this->action;
}
if ($layout)
{
$this->setLayout($layout);
}
$viewFileName = $this->_getViewFileName($action);
if ($file)
{
$viewFileName = $file;
}
if (!is_file($viewFileName))
{
if (strtolower(get_class($this)) == 'template')
{
return array('action' => $action, 'layout' => $layout, 'viewFn' => $viewFileName);
}
// check to see if the missing view is due to a custom missingAction
if (strpos($action, 'missingAction') !== false)
{
$errorAction = 'missingAction';
}
else
{
$errorAction = 'missingView';
}
// check for controller-level view handler
foreach(array($this->name, 'errors') as $viewDir)
{
$errorAction =Inflector::underscore($errorAction);
if(file_exists(VIEWS.$viewDir.DS.$errorAction.'.thtml'))
{
$missingViewFileName = VIEWS.$viewDir.DS.$errorAction.'.thtml';
}
elseif(file_exists(LIBS.'view'.DS.'templates'.DS.$viewDir.DS.$errorAction.'.thtml'))
{
$missingViewFileName = LIBS.'view'.DS.'templates'.DS.$viewDir.DS.$errorAction.'.thtml';
}
else
{
$missingViewFileName = false;
}
$missingViewExists = is_file($missingViewFileName);
if ($missingViewExists)
{
break;
}
}
if (strpos($action, 'missingView') === false)
{
$controller = $this;
$controller->missingView = $viewFileName;
$controller->action = $action;
call_user_func_array(array(&$controller, 'missingView'), empty($params['pass'])? null: $params['pass']);
$isFatal = isset($this->isFatal) ? $this->isFatal : false;
if (!$isFatal)
{
$viewFileName = $missingViewFileName;
}
}
else
{
$missingViewExists = false;
}
if (!$missingViewExists || $isFatal)
{
// app/view/errors/missing_view.thtml view is missing!
if (DEBUG)
{
trigger_error(sprintf(ERROR_NO_VIEW, $action, $viewFileName), E_USER_ERROR);
}
else
{
$this->error('404', 'Not found', sprintf(ERROR_404, '', "missing view \"{$action}\""));
}
die();
}
}
if ($viewFileName && !$this->hasRendered)
{
$out = $this->_render($viewFileName, $this->_viewVars, 0);
if ($out !== false)
{
if ($this->layout && $this->autoLayout)
{
$out = $this->renderLayout($out);
}
print $out;
$this->hasRendered = true;
}
else
{
$out = $this->_render($viewFileName, $this->_viewVars, false);
trigger_error(sprintf(ERROR_IN_VIEW, $viewFileName, $out), E_USER_ERROR);
}
return true;
}
}
/**
* Renders a piece of PHP with provided parameters and returns HTML, XML, or any other string.
*
* This realizes the concept of Elements, (or "partial layouts")
* and the $params array is used to send data to be used in the
* Element.
*
* @param string $name Name of template file in the /app/views/elements/ folder
* @param array $params Array of data to be made available to the for rendered view (i.e. the Element)
* @return string Rendered output
*/
function renderElement($name, $params=array())
{
$fn = ELEMENTS.$name.'.thtml';
if (!file_exists($fn))
{
return "(Error rendering {$name})";
}
return $this->_render($fn, array_merge($this->_viewVars, $params), true, false);
}
/**
* Renders a layout. Returns output from _render(). Returns false on error.
*
* @param string $content_for_layout Content to render in a view, wrapped by the surrounding layout.
* @return mixed Rendered output, or false on error
*/
function renderLayout($content_for_layout)
{
$layout_fn = $this->_getLayoutFileName();
$data_for_layout = array_merge($this->_viewVars, array(
'title_for_layout'=>$this->pageTitle !== false? $this->pageTitle: Inflector::humanize($this->viewPath),
'content_for_layout'=>$content_for_layout));
if (is_file($layout_fn))
{
$out = $this->_render($layout_fn, $data_for_layout, true, false);
if ($out === false)
{
$out = $this->_render($layout_fn, $data_for_layout, false);
trigger_error(sprintf(ERROR_IN_LAYOUT, $layout_fn, $out), E_USER_ERROR);
return false;
}
else
{
return $out;
}
}
else
{
trigger_error(sprintf(ERROR_NO_LAYOUT, $this->layout, $layout_fn), E_USER_ERROR);
return false;
}
}
/**
* Sets layout to be used when rendering.
*
* @param string $layout
*/
function setLayout($layout)
{
$this->layout = $layout;
}
/**
* Displays an error page to the user. Uses layouts/error.html to render the page.
*
* @param int $code Error code (for instance: 404)
* @param string $name Name of the error (for instance: Not Found)
* @param string $message Error message as a web page
*/
function error ($code, $name, $message)
{
header ("HTTP/1.0 {$code} {$name}");
print ($this->_render(VIEWS.'layouts/error.thtml', array('code'=>$code,'name'=>$name,'message'=>$message)));
}
/**************************************************************************
* Private methods.
*************************************************************************/
/**
* Returns filename of given action's template file (.thtml) as a string. CamelCased action names will be under_scored! This means that you can have LongActionNames that refer to long_action_names.thtml views.
*
* @param string $action Controller action to find template filename for
* @return string Template filename
* @access private
*/
function _getViewFileName($action)
{
$action = Inflector::underscore($action);
if(!is_null($this->webservices))
{
$type = strtolower($this->webservices).DS;
}
else
{
$type = null;
}
$viewFileName = VIEWS.$this->viewPath.DS.$type.$action.'.thtml';
if(file_exists(VIEWS.$this->viewPath.DS.$type.$action.'.thtml'))
{
$viewFileName = VIEWS.$this->viewPath.DS.$type.$action.'.thtml';
}
elseif(file_exists(LIBS.'view'.DS.'templates'.DS.'errors'.DS.$type.$action.'.thtml'))
{
$viewFileName = LIBS.'view'.DS.'templates'.DS.'errors'.DS.$type.$action.'.thtml';
}
elseif(file_exists(LIBS.'view'.DS.'templates'.DS.$this->viewPath.DS.$type.$action.'.thtml'))
{
$viewFileName = LIBS.'view'.DS.'templates'.DS.$this->viewPath.DS.$type.$action.'.thtml';
}
$viewPath = explode(DS, $viewFileName);
$i = array_search('..', $viewPath);
unset($viewPath[$i-1]);
unset($viewPath[$i]);
$return = '/'.implode('/', $viewPath);
return $return;
}
/**
* Returns layout filename for this template as a string.
*
* @return string Filename for layout file (.thtml).
* @access private
*/
function _getLayoutFileName()
{
if(!is_null($this->webservices))
{
$type = strtolower($this->webservices).DS;
}
else
{
$type = null;
}
$layoutFileName = LAYOUTS.$type."{$this->layout}.thtml";
if(file_exists(LAYOUTS.$type."{$this->layout}.thtml"))
{
$layoutFileName = LAYOUTS.$type."{$this->layout}.thtml";
}
else if(file_exists(LIBS.'view'.DS.'templates'.DS."layouts".DS.$type."{$this->layout}.thtml"))
{
$layoutFileName = LIBS.'view'.DS.'templates'.DS."layouts".DS.$type."{$this->layout}.thtml";
}
return $layoutFileName;
}
/**
* Renders and returns output for given view filename with its
* array of data.
*
* @param string $___viewFn Filename of the view
* @param array $___data_for_view Data to include in rendered view
* @param boolean $___play_safe If set to false, the include() of the $__viewFn is done without suppressing output of errors
* @return string Rendered output
* @access private
*/
function _render($___viewFn, $___data_for_view, $___play_safe = true, $loadHelpers = true)
{
/**
* Fetching helpers
*/
if ($this->helpers != false && $loadHelpers = true)
{
$loadedHelpers = array();
$loadedHelpers = $this->_loadHelpers($loadedHelpers, $this->helpers);
foreach(array_keys($loadedHelpers) as $helper)
{
$replace = strtolower(substr($helper, 0, 1));
$camelBackedHelper = preg_replace('/\\w/', $replace, $helper, 1);
${$camelBackedHelper} =& $loadedHelpers[$helper];
if(isset(${$camelBackedHelper}->helpers) && is_array(${$camelBackedHelper}->helpers))
{
foreach(${$camelBackedHelper}->helpers as $subHelper)
{
${$camelBackedHelper}->{$subHelper} =& $loadedHelpers[$subHelper];
}
}
}
}
extract($___data_for_view, EXTR_SKIP); # load all view variables
/**
* Local template variables.
*/
$BASE = $this->base;
$params = &$this->params;
$page_title = $this->pageTitle;
/**
* Start caching output (eval outputs directly so we need to cache).
*/
ob_start();
/**
* Include the template.
*/
$___play_safe? @include($___viewFn): include($___viewFn);
$out = ob_get_clean();
return $out;
}
/**
* Loads helpers, with their dependencies.
*
* @param array $loaded List of helpers that are already loaded.
* @param array $helpers List of helpers to load.
* @return array
*/
function &_loadHelpers(&$loaded, $helpers)
{
foreach ($helpers as $helper)
{
$helperCn = $helper.'Helper';
if(in_array($helper, array_keys($loaded)) !== true)
{
if(!class_exists($helperCn))
{
$helperFn = Inflector::underscore($helper).'.php';
if(file_exists(HELPERS.$helperFn))
{
$helperFn = HELPERS.$helperFn;
}
else if(file_exists(LIBS.'view'.DS.'helpers'.DS.$helperFn))
{
$helperFn = LIBS.'view'.DS.'helpers'.DS.$helperFn;
}
if (is_file($helperFn))
{
require_once $helperFn;
}
else
{
$error =& new Controller();
$error->autoLayout = true;
$error->base = $this->base;
call_user_func_array(array(&$error, 'missingHelperFile'), Inflector::underscore($helper));
exit();
}
}
$replace = strtolower(substr($helper, 0, 1));
$camelBackedHelper = preg_replace('/\\w/', $replace, $helper, 1);
if(class_exists($helperCn))
{
${$camelBackedHelper} =& new $helperCn;
${$camelBackedHelper}->base = $this->base;
${$camelBackedHelper}->webroot = $this->webroot;
${$camelBackedHelper}->here = $this->here;
${$camelBackedHelper}->params = $this->params;
${$camelBackedHelper}->action = $this->action;
${$camelBackedHelper}->data = $this->data;
if(!empty($this->validationErrors))
{
${$camelBackedHelper}->validationErrors = $this->validationErrors;
}
$loaded[$helper] =& ${$camelBackedHelper};
if (isset(${$camelBackedHelper}->helpers) && is_array(${$camelBackedHelper}->helpers))
{
$loaded =& $this->_loadHelpers($loaded, ${$camelBackedHelper}->helpers);
}
}
else
{
$error =& new Controller();
$error->autoLayout = true;
$error->base = $this->base;
call_user_func_array(array(&$error, 'missingHelperClass'), $helper);
exit();
}
}
}
return $loaded;
}
}
?>