mirror of
https://github.com/smarty-php/smarty.git
synced 2025-11-04 06:11:37 +01:00
963e5dae5e
- new feature $smarty->debug = true; => overwrite existing Debug Console window (old behaviour) $smarty->debug = 2; => individual Debug Console window by template name
348 lines
11 KiB
PHP
348 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Smarty Internal Plugin Debug
|
|
* Class to collect data for the Smarty Debugging Consol
|
|
*
|
|
* @package Smarty
|
|
* @subpackage Debug
|
|
* @author Uwe Tews
|
|
*/
|
|
|
|
/**
|
|
* Smarty Internal Plugin Debug Class
|
|
*
|
|
* @package Smarty
|
|
* @subpackage Debug
|
|
*/
|
|
class Smarty_Internal_Debug extends Smarty_Internal_Data
|
|
{
|
|
/**
|
|
* template data
|
|
*
|
|
* @var array
|
|
*/
|
|
public static $template_data = array();
|
|
|
|
/**
|
|
* List of uid's which shall be ignored
|
|
*
|
|
* @var array
|
|
*/
|
|
public static $ignore_uid = array();
|
|
|
|
/**
|
|
* Ignore template
|
|
*
|
|
* @param object $template
|
|
*/
|
|
public static function ignore($template)
|
|
{
|
|
// calculate Uid if not already done
|
|
if ($template->source->uid == '') {
|
|
$template->source->filepath;
|
|
}
|
|
self::$ignore_uid[$template->source->uid] = true;
|
|
}
|
|
|
|
/**
|
|
* Start logging of compile time
|
|
*
|
|
* @param object $template
|
|
*/
|
|
public static function start_compile($template)
|
|
{
|
|
static $_is_stringy = array('string' => true, 'eval' => true);
|
|
if (!empty($template->compiler->trace_uid)) {
|
|
$key = $template->compiler->trace_uid;
|
|
if (!isset(self::$template_data[$key])) {
|
|
if (isset($_is_stringy[$template->source->type])) {
|
|
self::$template_data[$key]['name'] = '\'' . substr($template->source->name, 0, 25) . '...\'';
|
|
} else {
|
|
self::$template_data[$key]['name'] = $template->source->filepath;
|
|
}
|
|
self::$template_data[$key]['compile_time'] = 0;
|
|
self::$template_data[$key]['render_time'] = 0;
|
|
self::$template_data[$key]['cache_time'] = 0;
|
|
}
|
|
} else {
|
|
if (isset(self::$ignore_uid[$template->source->uid])) {
|
|
return;
|
|
}
|
|
$key = self::get_key($template);
|
|
}
|
|
self::$template_data[$key]['start_time'] = microtime(true);
|
|
}
|
|
|
|
/**
|
|
* End logging of compile time
|
|
*
|
|
* @param object $template
|
|
*/
|
|
public static function end_compile($template)
|
|
{
|
|
if (!empty($template->compiler->trace_uid)) {
|
|
$key = $template->compiler->trace_uid;
|
|
} else {
|
|
if (isset(self::$ignore_uid[$template->source->uid])) {
|
|
return;
|
|
}
|
|
|
|
$key = self::get_key($template);
|
|
}
|
|
self::$template_data[$key]['compile_time'] += microtime(true) - self::$template_data[$key]['start_time'];
|
|
}
|
|
|
|
/**
|
|
* Start logging of render time
|
|
*
|
|
* @param object $template
|
|
*/
|
|
public static function start_render($template)
|
|
{
|
|
$key = self::get_key($template);
|
|
self::$template_data[$key]['start_time'] = microtime(true);
|
|
}
|
|
|
|
/**
|
|
* End logging of compile time
|
|
*
|
|
* @param object $template
|
|
*/
|
|
public static function end_render($template)
|
|
{
|
|
$key = self::get_key($template);
|
|
self::$template_data[$key]['render_time'] += microtime(true) - self::$template_data[$key]['start_time'];
|
|
}
|
|
|
|
/**
|
|
* Start logging of cache time
|
|
*
|
|
* @param object $template cached template
|
|
*/
|
|
public static function start_cache($template)
|
|
{
|
|
$key = self::get_key($template);
|
|
self::$template_data[$key]['start_time'] = microtime(true);
|
|
}
|
|
|
|
/**
|
|
* End logging of cache time
|
|
*
|
|
* @param object $template cached template
|
|
*/
|
|
public static function end_cache($template)
|
|
{
|
|
$key = self::get_key($template);
|
|
self::$template_data[$key]['cache_time'] += microtime(true) - self::$template_data[$key]['start_time'];
|
|
}
|
|
|
|
/**
|
|
* Start logging of cache time
|
|
*
|
|
* @param object $template cached template
|
|
*/
|
|
public static function start_template($template)
|
|
{
|
|
$key = self::get_key($template);
|
|
self::$template_data[$key]['start_template_time'] = microtime(true);
|
|
}
|
|
|
|
/**
|
|
* End logging of cache time
|
|
*
|
|
* @param object $template cached template
|
|
*/
|
|
public static function end_template($template)
|
|
{
|
|
$key = self::get_key($template);
|
|
self::$template_data[$key]['total_time'] += microtime(true) - self::$template_data[$key]['start_template_time'];
|
|
self::$template_data[$key]['properties'] = $template->properties;
|
|
|
|
}
|
|
|
|
/**
|
|
* Register template object
|
|
*
|
|
* @param object $template cached template
|
|
*/
|
|
public static function register_template($template)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Register data object
|
|
*
|
|
* @param object $data data object
|
|
*/
|
|
public static function register_data($data)
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Opens a window for the Smarty Debugging Consol and display the data
|
|
*
|
|
* @param Smarty_Internal_Template|Smarty $obj object to debug
|
|
*/
|
|
public static function display_debug($obj, $full = false)
|
|
{
|
|
// prepare information of assigned variables
|
|
$ptr = self::get_debug_vars($obj);
|
|
if ($obj instanceof Smarty) {
|
|
$smarty = clone $obj;
|
|
} else {
|
|
$smarty = clone $obj->smarty;
|
|
}
|
|
$_assigned_vars = $ptr->tpl_vars;
|
|
ksort($_assigned_vars);
|
|
$_config_vars = $ptr->config_vars;
|
|
ksort($_config_vars);
|
|
$smarty->registered_filters = array();
|
|
$smarty->autoload_filters = array();
|
|
$smarty->default_modifiers = array();
|
|
$smarty->force_compile = false;
|
|
$smarty->left_delimiter = '{';
|
|
$smarty->right_delimiter = '}';
|
|
$smarty->debugging = false;
|
|
$smarty->debugging_ctrl = 'NONE';
|
|
$smarty->force_compile = false;
|
|
$_template = new Smarty_Internal_Template($smarty->debug_tpl, $smarty);
|
|
$_template->caching = false;
|
|
$_template->disableSecurity();
|
|
$_template->cache_id = null;
|
|
$_template->compile_id = null;
|
|
if ($obj instanceof Smarty_Internal_Template) {
|
|
$_template->assign('template_name', $obj->source->type . ':' . $obj->source->name);
|
|
}
|
|
if ($obj instanceof Smarty || $full) {
|
|
$_template->assign('template_data', self::$template_data);
|
|
} else {
|
|
$_template->assign('template_data', null);
|
|
}
|
|
$_template->assign('assigned_vars', $_assigned_vars);
|
|
$_template->assign('config_vars', $_config_vars);
|
|
$_template->assign('execution_time', microtime(true) - $smarty->start_time);
|
|
$_template->assign('display_mode', $smarty->debugging == 2 || !$full);
|
|
echo $_template->fetch();
|
|
if ($full) {
|
|
self::$ignore_uid = array();
|
|
self::$template_data = array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Recursively gets variables from all template/data scopes
|
|
*
|
|
* @param Smarty_Internal_Template|Smarty_Data $obj object to debug
|
|
*
|
|
* @return StdClass
|
|
*/
|
|
public static function get_debug_vars($obj)
|
|
{
|
|
$config_vars = array();
|
|
foreach ($obj->config_vars as $key => $var) {
|
|
$config_vars[$key]['value'] = $var;
|
|
if ($obj instanceof Smarty_Internal_Template) {
|
|
$config_vars[$key]['scope'] = $obj->source->type . ':' . $obj->source->name;
|
|
} elseif ($obj instanceof Smarty_Data) {
|
|
$tpl_vars[$key]['scope'] = $obj->dataObjectName;
|
|
} else {
|
|
$config_vars[$key]['scope'] = 'Smarty object';
|
|
}
|
|
}
|
|
$tpl_vars = array();
|
|
foreach ($obj->tpl_vars as $key => $var) {
|
|
foreach ($var as $varkey => $varvalue) {
|
|
if ($varkey == 'value') {
|
|
$tpl_vars[$key][$varkey] = $varvalue;
|
|
} else if ($varkey == 'nocache') {
|
|
if ($varvalue == true) {
|
|
$tpl_vars[$key][$varkey] = $varvalue;
|
|
}
|
|
} else {
|
|
if ($varkey != 'scope' || $varvalue !== 0)
|
|
$tpl_vars[$key]['attributes'][$varkey] = $varvalue;
|
|
}
|
|
}
|
|
if ($obj instanceof Smarty_Internal_Template) {
|
|
$tpl_vars[$key]['scope'] = $obj->source->type . ':' . $obj->source->name;
|
|
} elseif ($obj instanceof Smarty_Data) {
|
|
$tpl_vars[$key]['scope'] = $obj->dataObjectName;
|
|
} else {
|
|
$tpl_vars[$key]['scope'] = 'Smarty object';
|
|
}
|
|
}
|
|
|
|
if (isset($obj->parent)) {
|
|
$parent = self::get_debug_vars($obj->parent);
|
|
foreach($parent->tpl_vars as $name => $pvar){
|
|
if (isset($tpl_vars[$name]) && $tpl_vars[$name]['value'] === $pvar['value']) {
|
|
$tpl_vars[$name]['scope'] = $pvar['scope'];
|
|
}
|
|
}
|
|
$tpl_vars = array_merge($parent->tpl_vars, $tpl_vars);
|
|
|
|
foreach($parent->config_vars as $name => $pvar){
|
|
if (isset($config_vars[$name]) && $config_vars[$name]['value'] === $pvar['value']) {
|
|
$config_vars[$name]['scope'] = $pvar['scope'];
|
|
}
|
|
}
|
|
$config_vars = array_merge($parent->config_vars, $config_vars);
|
|
} else {
|
|
foreach (Smarty::$global_tpl_vars as $key => $var) {
|
|
if (!array_key_exists($key, $tpl_vars)) {
|
|
foreach ($var as $varkey => $varvalue) {
|
|
if ($varkey == 'value') {
|
|
$tpl_vars[$key][$varkey] = $varvalue;
|
|
} else {
|
|
if ($varkey == 'nocache') {
|
|
if ($varvalue == true) {
|
|
$tpl_vars[$key][$varkey] = $varvalue;
|
|
}
|
|
} else {
|
|
if ($varkey != 'scope' || $varvalue !== 0) {
|
|
$tpl_vars[$key]['attributes'][$varkey] = $varvalue;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$tpl_vars[$key]['scope'] = 'Global';
|
|
}
|
|
}
|
|
}
|
|
|
|
return (object) array('tpl_vars' => $tpl_vars, 'config_vars' => $config_vars);
|
|
}
|
|
|
|
/**
|
|
* Return key into $template_data for template
|
|
*
|
|
* @param object $template template object
|
|
*
|
|
* @return string key into $template_data
|
|
*/
|
|
private static function get_key($template)
|
|
{
|
|
static $_is_stringy = array('string' => true, 'eval' => true);
|
|
// calculate Uid if not already done
|
|
if ($template->source->uid == '') {
|
|
$template->source->filepath;
|
|
}
|
|
$key = $template->source->uid;
|
|
if (isset(self::$template_data[$key])) {
|
|
return $key;
|
|
} else {
|
|
if (isset($_is_stringy[$template->source->type])) {
|
|
self::$template_data[$key]['name'] = '\'' . substr($template->source->name, 0, 25) . '...\'';
|
|
} else {
|
|
self::$template_data[$key]['name'] = $template->source->filepath;
|
|
}
|
|
self::$template_data[$key]['compile_time'] = 0;
|
|
self::$template_data[$key]['render_time'] = 0;
|
|
self::$template_data[$key]['cache_time'] = 0;
|
|
self::$template_data[$key]['total_time'] = 0;
|
|
|
|
return $key;
|
|
}
|
|
}
|
|
}
|