1. sfVarLogger.class.php
  2. /**
 * sfVarLogger logs messages within its instance for later use.
 *
 * @package    symfony
 * @subpackage log
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfVarLogger.class.php 26989 2010-01-21 12:43:21Z FabianLange $
 */
  3. class sfVarLogger extends sfLogger
  4. {
  5.   protected
  6.     $logs          = array(),
  7.     $xdebugLogging = false;
  9.   /**
  10.    * Initializes this logger.
  11.    *
  12.    * Available options:
  13.    *
  14.    * - xdebug_logging: Whether to add xdebug trace to the logs (false by default).
  15.    *
  16.    * @param  sfEventDispatcher $dispatcher  A sfEventDispatcher instance
  17.    * @param  array             $options     An array of options.
  18.    *
  19.    * @return Boolean           true, if initialization completes successfully, otherwise false.
  20.    */
  21.   public function initialize(sfEventDispatcher $dispatcher, $options = array())
  22.   {
  23.     $this->xdebugLogging = isset($options['xdebug_logging']) ? $options['xdebug_logging'] : false;
  25.     // disable xdebug when an HTTP debug session exists (crashes Apache, see #2438)
  26.     if (isset($_GET['XDEBUG_SESSION_START']) || isset($_COOKIE['XDEBUG_SESSION']))
  27.     {
  28.       $this->xdebugLogging = false;
  29.     }
  31.     return parent::initialize($dispatcher, $options);
  32.   }
  34.   /**
  35.    * Gets the logs.
  36.    *
  37.    * Each log entry has the following attributes:
  38.    *
  39.    *  * priority
  40.    *  * time   
  41.    *  * message
  42.    *  * type
  43.    *  * debugStack
  44.    *
  45.    * @return array An array of logs
  46.    */
  47.   public function getLogs()
  48.   {
  49.     return $this->logs;
  50.   }
  52.   /**
  53.    * Returns all the types in the logs.
  54.    *
  55.    * @return array An array of types
  56.    */
  57.   public function getTypes()
  58.   {
  59.     $types = array();
  60.     foreach ($this->logs as $log)
  61.     {
  62.       if (!in_array($log['type'], $types))
  63.       {
  64.         $types[] = $log['type'];
  65.       }
  66.     }
  68.     sort($types);
  70.     return $types;
  71.   }
  73.   /**
  74.    * Returns all the priorities in the logs.
  75.    *
  76.    * @return array An array of priorities
  77.    */
  78.   public function getPriorities()
  79.   {
  80.     $priorities = array();
  81.     foreach ($this->logs as $log)
  82.     {
  83.       if (!in_array($log['priority'], $priorities))
  84.       {
  85.         $priorities[] = $log['priority'];
  86.       }
  87.     }
  89.     sort($priorities);
  91.     return $priorities;
  92.   }
  94.   /**
  95.    * Returns the highest priority in the logs.
  96.    *
  97.    * @return integer The highest priority
  98.    */
  99.   public function getHighestPriority()
  100.   {
  101.     $priority = 1000;
  102.     foreach ($this->logs as $log)
  103.     {
  104.       if ($log['priority'] < $priority)
  105.       {
  106.         $priority = $log['priority'];
  107.       }
  108.     }
  110.     return $priority;
  111.   }
  113.   /**
  114.    * Logs a message.
  115.    *
  116.    * @param string $message   Message
  117.    * @param string $priority  Message priority
  118.    */
  119.   protected function doLog($message, $priority)
  120.   {
  121.     // get log type in {}
  122.     $type = 'sfOther';
  123.     if (preg_match('/^\s*{([^}]+)}\s*(.+?)$/s', $message, $matches))
  124.     {
  125.       $type    = $matches[1];
  126.       $message = $matches[2];
  127.     }
  129.     $this->logs[] = array(
  130.       'priority'        => $priority,
  131.       'priority_name'   => $this->getPriorityName($priority),
  132.       'time'            => time(),
  133.       'message'         => $message,
  134.       'type'            => $type,
  135.       'debug_backtrace' => $this->getDebugBacktrace(),
  136.     );
  137.   }
  139.   /**
  140.    * Returns the debug stack.
  141.    *
  142.    * @return array
  143.    * 
  144.    * @see debug_backtrace()
  145.    */
  146.   protected function getDebugBacktrace()
  147.   {
  148.     // if we have xdebug and dev has not disabled the feature, add some stack information
  149.     if (!$this->xdebugLogging || !function_exists('debug_backtrace'))
  150.     {
  151.       return array();
  152.     }
  154.     $traces = debug_backtrace();
  156.     // remove sfLogger and sfEventDispatcher from the top of the trace
  157.     foreach ($traces as $i => $trace)
  158.     {
  159.       $class = isset($trace['class']) ? $trace['class'] : substr($file = basename($trace['file']), 0, strpos($file, '.'));
  161.       if (
  162.         !class_exists($class)
  163.         ||
  164.         (!in_array($class, array('sfLogger', 'sfEventDispatcher')) && !is_subclass_of($class, 'sfLogger') && !is_subclass_of($class, 'sfEventDispatcher'))
  165.       )
  166.       {
  167.         $traces = array_slice($traces, $i);
  168.         break;
  169.       }
  170.     }
  172.     return $traces;
  173.   }
  174. }
Debug toolbar