1. sfWebDebugPanel.class.php
  2. /**
 * sfWebDebugPanel represents a web debug panel.
 *
 * @package    symfony
 * @subpackage debug
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfWebDebugPanel.class.php 27284 2010-01-28 18:34:57Z Kris.Wallsmith $
 */
  3. abstract class sfWebDebugPanel
  4. {
  5.   protected
  6.     $webDebug = null,
  7.     $status   = sfLogger::INFO;
  9.   /**
  10.    * Constructor.
  11.    *
  12.    * @param sfWebDebug $webDebug The web debug toolbar instance
  13.    */
  14.   public function __construct(sfWebDebug $webDebug)
  15.   {
  16.     $this->webDebug = $webDebug;
  17.   }
  19.   /**
  20.    * Gets the link URL for the link.
  21.    *
  22.    * @return string The URL link
  23.    */
  24.   public function getTitleUrl()
  25.   {
  26.   }
  28.   /**
  29.    * Gets the text for the link.
  30.    *
  31.    * @return string The link text
  32.    */
  33.   abstract public function getTitle();
  35.   /**
  36.    * Gets the title of the panel.
  37.    *
  38.    * @return string The panel title
  39.    */
  40.   abstract public function getPanelTitle();
  42.   /**
  43.    * Gets the panel HTML content.
  44.    *
  45.    * @return string The panel HTML content
  46.    */
  47.   abstract public function getPanelContent();
  49.   /**
  50.    * Returns the current status.
  51.    * 
  52.    * @return integer A {@link sfLogger} priority constant
  53.    */
  54.   public function getStatus()
  55.   {
  56.     return $this->status;
  57.   }
  59.   /**
  60.    * Sets the current panel's status.
  61.    * 
  62.    * @param integer $status A {@link sfLogger} priority constant
  63.    */
  64.   public function setStatus($status)
  65.   {
  66.     $this->status = $status;
  67.   }
  69.   /**
  70.    * Returns a toggler element.
  71.    * 
  72.    * @param  string $element The value of an element's DOM id attribute
  73.    * @param  string $title   A title attribute
  74.    * 
  75.    * @return string
  76.    */
  77.   public function getToggler($element, $title = 'Toggle details')
  78.   {
  79.     return '<a href="#" onclick="sfWebDebugToggle(\''.$element.'\'); return false;" title="'.$title.'"><img src="'.$this->webDebug->getOption('image_root_path').'/toggle.gif" alt="'.$title.'"/></a>';
  80.   }
  82.   /**
  83.    * Returns a toggleable presentation of a debug stack.
  84.    * 
  85.    * @param  array $debugStack
  86.    * 
  87.    * @return string
  88.    */
  89.   public function getToggleableDebugStack($debugStack)
  90.   {
  91.     static $i = 1;
  93.     if (!$debugStack)
  94.     {
  95.       return '';
  96.     }
  98.     $element = get_class($this).'Debug'.$i++;
  99.     $keys = array_reverse(array_keys($debugStack));
  101.     $html  = $this->getToggler($element, 'Toggle debug stack');
  102.     $html .= '<div class="sfWebDebugDebugInfo" id="'.$element.'" style="display:none">';
  103.     foreach ($debugStack as $j => $trace)
  104.     {
  105.       $file = isset($trace['file']) ? $trace['file'] : null;
  106.       $line = isset($trace['line']) ? $trace['line'] : null;
  108.       $isProjectFile = $file && 0 === strpos($file, sfConfig::get('sf_root_dir')) && !preg_match('/(cache|plugins|vendor)/', $file);
  110.       $html .= sprintf('<span%s>#%s &raquo; ', $isProjectFile ? ' class="sfWebDebugHighlight"' : '', $keys[$j] + 1);
  112.       if (isset($trace['function']))
  113.       {
  114.         $html .= sprintf('in <span class="sfWebDebugLogInfo">%s%s%s()</span> ',
  115.           isset($trace['class']) ? $trace['class'] : '',
  116.           isset($trace['type']) ? $trace['type'] : '',
  117.           $trace['function']
  118.         );
  119.       }
  121.       $html .= sprintf('from %s line %s', $this->formatFileLink($file, $line), $line);
  122.       $html .= '</span><br/>';
  123.     }
  124.     $html .= "</div>\n";
  126.     return $html;
  127.   }
  129.   /**
  130.    * Formats a file link.
  131.    * 
  132.    * @param  string  $file A file path or class name
  133.    * @param  integer $line
  134.    * @param  string  $text Text to use for the link
  135.    * 
  136.    * @return string
  137.    */
  138.   public function formatFileLink($file, $line = null, $text = null)
  139.   {
  140.     // this method is called a lot so we avoid calling class_exists()
  141.     if ($file && !sfToolkit::isPathAbsolute($file))
  142.     {
  143.       if (null === $text)
  144.       {
  145.         $text = $file;
  146.       }
  148.       // translate class to file name
  149.       $r = new ReflectionClass($file);
  150.       $file = $r->getFileName();
  151.     }
  153.     $shortFile = sfDebug::shortenFilePath($file);
  155.     if ($linkFormat = sfConfig::get('sf_file_link_format', ini_get('xdebug.file_link_format')))
  156.     {
  157.       // return a link
  158.       return sprintf(
  159.         '<a href="%s" class="sfWebDebugFileLink" title="%s">%s</a>',
  160.         htmlspecialchars(strtr($linkFormat, array('%f' => $file, '%l' => $line)), ENT_QUOTES, sfConfig::get('sf_charset')),
  161.         htmlspecialchars($shortFile, ENT_QUOTES, sfConfig::get('sf_charset')),
  162.         null === $text ? $shortFile : $text);
  163.     }
  164.     else if (null === $text)
  165.     {
  166.       // return the shortened file path
  167.       return $shortFile;
  168.     }
  169.     else
  170.     {
  171.       // return the provided text with the shortened file path as a tooltip
  172.       return sprintf('<span title="%s">%s</span>', $shortFile, $text);
  173.     }
  174.   }
  176.   /**
  177.    * Format a SQL string with some colors on SQL keywords to make it more readable.
  178.    *
  179.    * @param  string $sql    SQL string to format
  180.    * 
  181.    * @return string $newSql The new formatted SQL string
  182.    */
  183.   public function formatSql($sql)
  184.   {
  185.     return preg_replace('/\b(UPDATE|SET|SELECT|FROM|AS|LIMIT|ASC|COUNT|DESC|WHERE|LEFT JOIN|INNER JOIN|RIGHT JOIN|ORDER BY|GROUP BY|IN|LIKE|DISTINCT|DELETE|INSERT|INTO|VALUES)\b/', '<span class="sfWebDebugLogInfo">\\1</span>', $sql);
  186.   }
  187. }
Debug toolbar