1. sfDebug.class.php
  2. /**
 * sfDebug provides some method to help debugging a symfony application.
 *
 * @package    symfony
 * @subpackage debug
 * @author     Fabien Potencier 
 * @version    SVN: $Id: sfDebug.class.php 22118 2009-09-18 07:02:26Z fabien $
 */
  3. class sfDebug
  4. {
  5.   /**
  6.    * Returns symfony information as an array.
  7.    *
  8.    * @return array An array of symfony information
  9.    */
  10.   public static function symfonyInfoAsArray()
  11.   {
  12.     return array(
  13.       'version' => SYMFONY_VERSION,
  14.       'path'    => sfConfig::get('sf_symfony_lib_dir'),
  15.     );
  16.   }
  18.   /**
  19.    * Returns PHP information as an array.
  20.    *
  21.    * @return array An array of php information
  22.    */
  23.   public static function phpInfoAsArray()
  24.   {
  25.     $values = array(
  26.       'php'        => phpversion(),
  27.       'os'         => php_uname(),
  28.       'extensions' => get_loaded_extensions(),
  29.     );
  31.     natcasesort($values['extensions']); 
  33.     // assign extension version
  34.     if ($values['extensions'])
  35.     {
  36.       foreach($values['extensions'] as $key => $extension)
  37.       {
  38.         $values['extensions'][$key] = phpversion($extension) ? sprintf('%s (%s)', $extension, phpversion($extension)) : $extension;
  39.       }
  40.     }
  42.     return $values;
  43.   }
  45.   /**
  46.    * Returns PHP globals variables as a sorted array.
  47.    *
  48.    * @return array PHP globals
  49.    */
  50.   public static function globalsAsArray()
  51.   {
  52.     $values = array();
  53.     foreach (array('cookie', 'server', 'get', 'post', 'files', 'env', 'session') as $name)
  54.     {
  55.       if (!isset($GLOBALS['_'.strtoupper($name)]))
  56.       {
  57.         continue;
  58.       }
  60.       $values[$name] = array();
  61.       foreach ($GLOBALS['_'.strtoupper($name)] as $key => $value)
  62.       {
  63.         $values[$name][$key] = $value;
  64.       }
  65.       ksort($values[$name]);
  66.     }
  68.     ksort($values);
  70.     return $values;
  71.   }
  73.   /**
  74.    * Returns sfConfig variables as a sorted array.
  75.    *
  76.    * @return array sfConfig variables
  77.    */
  78.   public static function settingsAsArray()
  79.   {
  80.     $config = sfConfig::getAll();
  82.     ksort($config);
  84.     return $config;
  85.   }
  87.   /**
  88.    * Returns request parameter holders as an array.
  89.    *
  90.    * @param sfRequest $request A sfRequest instance
  91.    *
  92.    * @return array The request parameter holders
  93.    */
  94.   public static function requestAsArray(sfRequest $request = null)
  95.   {
  96.     if (!$request)
  97.     {
  98.       return array();
  99.     }
  101.     return array(
  102.       'options'         => $request->getOptions(),
  103.       'parameterHolder' => self::flattenParameterHolder($request->getParameterHolder(), true),
  104.       'attributeHolder' => self::flattenParameterHolder($request->getAttributeHolder(), true),
  105.     );
  106.   }
  108.   /**
  109.    * Returns response parameters as an array.
  110.    *
  111.    * @param sfResponse $response A sfResponse instance
  112.    *
  113.    * @return array The response parameters
  114.    */
  115.   public static function responseAsArray(sfResponse $response = null)
  116.   {
  117.     if (!$response)
  118.     {
  119.       return array();
  120.     }
  122.     return array(
  123.       'status'      => array('code' => $response->getStatusCode(), 'text' => $response->getStatusText()),
  124.       'options'     => $response->getOptions(),
  125.       'cookies'     => method_exists($response, 'getCookies')     ? $response->getCookies() : array(),
  126.       'httpHeaders' => method_exists($response, 'getHttpHeaders') ? $response->getHttpHeaders() : array(),
  127.       'javascripts' => method_exists($response, 'getJavascripts') ? $response->getJavascripts('ALL') : array(),
  128.       'stylesheets' => method_exists($response, 'getStylesheets') ? $response->getStylesheets('ALL') : array(),
  129.       'metas'       => method_exists($response, 'getMetas')       ? $response->getMetas() : array(),
  130.       'httpMetas'   => method_exists($response, 'getHttpMetas')   ? $response->getHttpMetas() : array(),
  131.     );
  132.   }
  134.   /**
  135.    * Returns user parameters as an array.
  136.    *
  137.    * @param sfUser $user A sfUser instance
  138.    *
  139.    * @return array The user parameters
  140.    */
  141.   public static function userAsArray(sfUser $user = null)
  142.   {
  143.     if (!$user)
  144.     {
  145.       return array();
  146.     }
  148.     return array(
  149.       'options'         => $user->getOptions(),
  150.       'attributeHolder' => self::flattenParameterHolder($user->getAttributeHolder(), true),
  151.       'culture'         => $user->getCulture(),
  152.     );
  153.   }
  155.   /**
  156.    * Returns a parameter holder as an array.
  157.    *
  158.    * @param sfParameterHolder $parameterHolder A sfParameterHolder instance
  159.    * @param boolean $removeObjects when set to true, objects are removed. default is false for BC.
  160.    *
  161.    * @return array The parameter holder as an array
  162.    */
  163.   public static function flattenParameterHolder($parameterHolder, $removeObjects = false)
  164.   {
  165.     $values = array();
  166.     if ($parameterHolder instanceof sfNamespacedParameterHolder)
  167.     {
  168.       foreach ($parameterHolder->getNamespaces() as $ns)
  169.       {
  170.         $values[$ns] = array();
  171.         foreach ($parameterHolder->getAll($ns) as $key => $value)
  172.         {
  173.           $values[$ns][$key] = $value;
  174.         }
  175.         ksort($values[$ns]);
  176.       }
  177.     }
  178.     else
  179.     {
  180.       foreach ($parameterHolder->getAll() as $key => $value)
  181.       {
  182.         $values[$key] = $value;
  183.       }
  184.     }
  186.     if ($removeObjects)
  187.     {
  188.       $values = self::removeObjects($values);
  189.     }
  191.     ksort($values);
  193.     return $values;
  194.   }
  196.   /**
  197.    * Removes objects from the array by replacing them with a String containing the class name.
  198.    *
  199.    * @param array $values an array
  200.    *
  201.    * @return array The array without objects
  202.    */
  203.   public static function removeObjects($values)
  204.   {
  205.     $nvalues = array();
  206.     foreach ($values as $key => $value)
  207.     {
  208.       if (is_array($value))
  209.       {
  210.         $nvalues[$key] = self::removeObjects($value);
  211.       }
  212.       else if (is_object($value))
  213.       {
  214.         $nvalues[$key] = sprintf('%s Object()', get_class($value));
  215.       }
  216.       else
  217.       {
  218.         $nvalues[$key] = $value;
  219.       }
  220.     }
  222.     return $nvalues;
  223.   }
  225.   /**
  226.    * Shortens a file path by replacing symfony directory constants.
  227.    * 
  228.    * @param  string $file
  229.    * 
  230.    * @return string
  231.    */
  232.   static public function shortenFilePath($file)
  233.   {
  234.     foreach (array('sf_root_dir', 'sf_symfony_lib_dir') as $key)
  235.     {
  236.       if (0 === strpos($file, $value = sfConfig::get($key)))
  237.       {
  238.         $file = str_replace($value, strtoupper($key), $file);
  239.         break;
  240.       }
  241.     }
  243.     return $file;
  244.   }
  245. }
Debug toolbar