1. sfWebDebugPanelView.class.php
  2. /**
 * sfWebDebugPanelView adds a panel to the web debug toolbar with information about the view layer.
 * 
 * @package     symfony
 * @subpackage  debug
 * @author      Kris Wallsmith 
 * @version     SVN: $Id: sfWebDebugPanelView.class.php 24069 2009-11-17 06:59:01Z Kris.Wallsmith $
 */
  3. class sfWebDebugPanelView extends sfWebDebugPanel
  4. {
  5.   protected
  6.     $actions  = array(),
  7.     $partials = array();
  9.   /**
  10.    * Constructor.
  11.    *
  12.    * @param sfWebDebug $webDebug The web debug toolbar instance
  13.    */
  14.   public function __construct(sfWebDebug $webDebug)
  15.   {
  16.     parent::__construct($webDebug);
  18.     $this->webDebug->getEventDispatcher()->connect('controller.change_action', array($this, 'listenForChangeAction'));
  19.     $this->webDebug->getEventDispatcher()->connect('template.filter_parameters', array($this, 'filterTemplateParameters'));
  20.   }
  22.   /**
  23.    * Resets the parameter collections.
  24.    * 
  25.    * @param sfEvent $event
  26.    */
  27.   public function listenForChangeAction(sfEvent $event)
  28.   {
  29.     $this->actions  = array();
  30.     $this->partials = array();
  31.   }
  33.   /**
  34.    * Stacks action and partial parameters in the template.filter_parameters event.
  35.    * 
  36.    * @param  sfEvent $event
  37.    * @param  array   $parameters
  38.    * 
  39.    * @return array
  40.    */
  41.   public function filterTemplateParameters(sfEvent $event, $parameters)
  42.   {
  43.     $entry = array('parameters' => $parameters);
  45.     if ('action' == $parameters['sf_type'] && $file = $this->getLastTemplate())
  46.     {
  47.       $this->actions[] = $entry + array('file' => $file);
  48.     }
  49.     else if ('partial' == $parameters['sf_type'] && $file = $this->getLastTemplate('sfPartialView'))
  50.     {
  51.       $this->partials[] = $entry + array('file' => $file);
  52.     }
  54.     return $parameters;
  55.   }
  57.   /**
  58.    * Returns the path to the last template rendered.
  59.    * 
  60.    * @param  string $class Name of the rendering view class
  61.    * 
  62.    * @return string|null
  63.    */
  64.   protected function getLastTemplate($class = 'sfPHPView')
  65.   {
  66.     foreach (array_reverse($this->webDebug->getLogger()->getLogs()) as $log)
  67.     {
  68.       if (
  69.         ($class == $log['type'] || (class_exists($log['type'], false) && is_subclass_of($log['type'], $class)))
  70.         &&
  71.         preg_match('/^Render "(.*)"$/', $log['message'], $match)
  72.       )
  73.       {
  74.         return $match[1];
  75.       }
  76.     }
  77.   }
  79.   /**
  80.    * @see sfWebDebugPanel
  81.    */
  82.   public function getTitle()
  83.   {
  84.     if (count($this->actions) || count($this->partials))
  85.     {
  86.       return '<img src="'.$this->webDebug->getOption('image_root_path').'/view.png" alt="View Layer" /> view';
  87.     }
  88.   }
  90.   /**
  91.    * @see sfWebDebugPanel
  92.    */
  93.   public function getPanelTitle()
  94.   {
  95.     return 'View Layer';
  96.   }
  98.   /**
  99.    * @see sfWebDebugPanel
  100.    */
  101.   public function getPanelContent()
  102.   {
  103.     $html = array();
  105.     foreach ($this->actions as $action)
  106.     {
  107.       $html[] = $this->renderTemplateInformation($action['file'], $action['parameters']);
  108.     }
  110.     foreach ($this->partials as $partial)
  111.     {
  112.       $html[] = $this->renderTemplateInformation($partial['file'], $partial['parameters'], 'Partial');
  113.     }
  115.     return join("\n", $html);
  116.   }
  118.   /**
  119.    * Renders information about the passed template and its parameters.
  120.    * 
  121.    * The rendered HTML for each parameter is filtered through the "debug.web.view.filter_parameter_html" event.
  122.    * 
  123.    * @param  string $file       The template file path
  124.    * @param  array  $parameters
  125.    * @param  string $label
  126.    * 
  127.    * @return string
  128.    */
  129.   protected function renderTemplateInformation($file, $parameters, $label = 'Template')
  130.   {
  131.     static $i = 0;
  133.     $parameters = $this->filterCoreParameters($parameters);
  134.     $i++;
  136.     $html = array();
  137.     $html[] = sprintf('<h2>%s: %s %s</h2>', $label, $this->formatFileLink($file, null, $this->shortenTemplatePath($file)), $this->getToggler('sfWebDebugViewTemplate'.$i));
  138.     $html[] = '<div id="sfWebDebugViewTemplate'.$i.'" style="display:'.(1 == $i ? 'block' : 'none').'">';
  139.     if (count($parameters))
  140.     {
  141.       $html[] = '<p>Parameters:</p>';
  142.       $html[] = '<ul>';
  143.       foreach ($parameters as $name => $parameter)
  144.       {
  145.         $presentation = '<li>'.$this->formatParameterAsHtml($name, $parameter).'</li>';
  146.         $html[] = $this->webDebug->getEventDispatcher()->filter(new sfEvent($this, 'debug.web.view.filter_parameter_html', array('parameter' => $parameter)), $presentation)->getReturnValue();
  147.       }
  148.       $html[] = '</ul>';
  149.     }
  150.     else
  151.     {
  152.       $html[] = '<p>No parameters were passed to this template.</p>';
  153.     }
  154.     $html[] = '</div>';
  156.     return join("\n", $html);
  157.   }
  159.   /**
  160.    * Formats information about a parameter as HTML.
  161.    * 
  162.    * @param  string $name
  163.    * @param  mixed  $parameter
  164.    * 
  165.    * @return string
  166.    */
  167.   protected function formatParameterAsHtml($name, $parameter)
  168.   {
  169.     if (!method_exists($this, $method = 'format'.ucwords(gettype($parameter)).'AsHtml'))
  170.     {
  171.       $method = 'getParameterDescription';
  172.     }
  174.     return $this->$method($name, $parameter);
  175.   }
  177.   /**
  178.    * Formats object information as HTML.
  179.    * 
  180.    * @param  string $name
  181.    * @param  object $parameter
  182.    * 
  183.    * @return string
  184.    */
  185.   protected function formatObjectAsHtml($name, $parameter)
  186.   {
  187.     if ($parameter instanceof sfForm)
  188.     {
  189.       return $this->formatFormAsHtml($name, $parameter);
  190.     }
  191.     else
  192.     {
  193.       return $this->getParameterDescription($name, $parameter);
  194.     }
  195.   }
  197.   /**
  198.    * Formats form information as HTML.
  199.    * 
  200.    * @param  string $name
  201.    * @param  sfForm $form
  202.    * 
  203.    * @return string
  204.    */
  205.   protected function formatFormAsHtml($name, sfForm $form)
  206.   {
  207.     static $i = 0;
  209.     $i++;
  211.     if ($form->hasErrors() && sfLogger::NOTICE < $this->getStatus())
  212.     {
  213.       $this->setStatus(sfLogger::NOTICE);
  214.     }
  216.     $html = array();
  217.     $html[] = $this->getParameterDescription($name, $form, $form->hasErrors() ? '<code class="sfWebDebugWarning">$%s</code>' : null);
  218.     $html[] = $this->getToggler('sfWebDebugViewForm'.$i);
  219.     $html[] = '<div id="sfWebDebugViewForm'.$i.'" style="display:none">';
  221.     foreach ($form->getGlobalErrors() as $error)
  222.     {
  223.       $html[] = sprintf('<p><span class="sfWebDebugWarning">%s</span></p>', $error);
  224.     }
  226.     $html[] = '<ul>'.$this->formatFormFieldSchemaAsHtml($form->getFormFieldSchema(), $name.'[%s]').'</ul>';
  227.     $html[] = '</div>';
  229.     return join("\n", $html);
  230.   }
  232.   /**
  233.    * Formats form field schema information as HTML.
  234.    * 
  235.    * @param  sfFormFieldSchema $fieldSchema
  236.    * @param  string            $nameFormat
  237.    * 
  238.    * @return string
  239.    */
  240.   protected function formatFormFieldSchemaAsHtml(sfFormFieldSchema $fieldSchema, $nameFormat = '%s')
  241.   {
  242.     $html = array();
  244.     foreach ($fieldSchema as $field)
  245.     {
  246.       $name = sprintf($nameFormat, $this->varExport($field->getName()));
  247.       if ($field instanceof sfFormFieldSchema)
  248.       {
  249.         $html[] = $this->formatFormFieldSchemaAsHtml($field, $name.'[%s]');
  250.       }
  251.       else
  252.       {
  253.         $html[] = '<li>';
  254.         $html[] = $this->getParameterDescription($name, $field->getWidget());
  256.         if ($field->hasError())
  257.         {
  258.           $html[] = sprintf('<p><span class="sfWebDebugWarning">%s</span></p>', $field->getError());
  259.         }
  261.         $html[] = '</li>';
  262.       }
  263.     }
  265.     return join("\n", $html);
  266.   }
  268.   /**
  269.    * Formats information about a parameter as HTML.
  270.    * 
  271.    * @param  string $name
  272.    * @param  mixed  $parameter
  273.    * 
  274.    * @return string
  275.    */
  276.   protected function getParameterDescription($name, $parameter, $nameFormat = null, $typeFormat = null)
  277.   {
  278.     if (null === $nameFormat)
  279.     {
  280.       $nameFormat = '<code>$%s</code>';
  281.     }
  283.     if (null === $typeFormat)
  284.     {
  285.       $typeFormat = '<span class="sfWebDebugDataType">(%s)</span>';
  286.     }
  288.     return sprintf($nameFormat.' '.$typeFormat, $name, is_object($parameter) ? $this->formatFileLink(get_class($parameter)) : gettype($parameter));
  289.   }
  291.   /**
  292.    * Shortens an action's template path.
  293.    * 
  294.    * @param  string $path
  295.    * 
  296.    * @return string
  297.    */
  298.   protected function shortenTemplatePath($path)
  299.   {
  300.     $path = realpath($path);
  302.     // application module
  303.     $sep = preg_quote(DIRECTORY_SEPARATOR);
  304.     if (preg_match('#modules'.$sep.'(\w+)'.$sep.'templates'.$sep.'(.*)$#', $path, $match))
  305.     {
  306.       return $match[1].'&nbsp;&hellip;&nbsp;'.$match[2];
  307.     }
  309.     return str_replace('SF_ROOT_DIR'.DIRECTORY_SEPARATOR, '', sfDebug::shortenFilePath($path));
  310.   }
  312.   /**
  313.    * Removes parameters prefixed with "sf_" from the array.
  314.    * 
  315.    * @param  array $parameters
  316.    * 
  317.    * @return array
  318.    */
  319.   protected function filterCoreParameters($parameters)
  320.   {
  321.     $filtered = array();
  323.     foreach ($parameters as $name => $value)
  324.     {
  325.       if (0 !== strpos($name, 'sf_'))
  326.       {
  327.         $filtered[$name] = $value;
  328.       }
  329.     }
  331.     return $filtered;
  332.   }
  334.   /**
  335.    * Returns a string representation of a value.
  336.    * 
  337.    * @param  string $value
  338.    * 
  339.    * @return string
  340.    */
  341.   protected function varExport($value)
  342.   {
  343.     if (is_numeric($value))
  344.     {
  345.       $value = (integer) $value;
  346.     }
  348.     return var_export($value, true);
  349.   }
  350. }
Debug toolbar