home *** CD-ROM | disk | FTP | other *** search
/ Cricao de Sites - 650 Layouts Prontos / WebMasters.iso / Servidores / xampp-win32-1.6.7-installer.exe / php / PEAR / System / Socket / Debugger.php < prev    next >
Encoding:
PHP Script  |  2008-07-02  |  8.3 KB  |  335 lines
  1. <?php
  2. // +----------------------------------------------------------------------+
  3. // | PEAR :: System :: Socket :: Debugger                                 |
  4. // +----------------------------------------------------------------------+
  5. // | This source file is subject to version 3.0 of the PHP license,       |
  6. // | that is available at http://www.php.net/license/3_0.txt              |
  7. // | If you did not receive a copy of the PHP license and are unable      |
  8. // | to obtain it through the world-wide-web, please send a note to       |
  9. // | license@php.net so we can mail you a copy immediately.               |
  10. // +----------------------------------------------------------------------+
  11. // | Copyright (c) 2004 Michael Wallner <mike@iworks.at>                  |
  12. // +----------------------------------------------------------------------+
  13. //
  14. // $Id: Debugger.php,v 1.1 2004/04/29 15:55:38 mike Exp $
  15.  
  16. /**
  17. * System::Socket::Debugger
  18. * 
  19. * @TODO!        XXX add extended support for PEAR::Log XXX
  20. * 
  21. * @author       Michael Wallner <mike@php.net>
  22. * @package      System_Socket
  23. * @category     System
  24. * @example      simple-debugger.php Simple debugging (echo) example
  25. */
  26.  
  27. if (!defined('SYSTEM_SOCKET_ROOT')) {
  28.     define('SYSTEM_SOCKET_ROOT', dirname(__FILE__) . '/..');
  29. }
  30.  
  31. require_once SYSTEM_SOCKET_ROOT . '/Socket/Observer.php';
  32.  
  33. define('SYSTEM_SOCKET_DEBUG_NONE',          0);
  34. define('SYSTEM_SOCKET_DEBUG_PEAR_LOG',      1);
  35. define('SYSTEM_SOCKET_DEBUG_PEAR_ERROR',    2);
  36. define('SYSTEM_SOCKET_DEBUG_ECHO',          3);
  37. define('SYSTEM_SOCKET_DEBUG_ERRORLOG',      4);
  38. define('SYSTEM_SOCKET_DEBUG_TRIGGERERROR',  5);
  39.  
  40. /** 
  41. * System_Socket_Debugger
  42. * 
  43. * The System_Socket_Debugger class aims to provide a simple and versatile
  44. * option to debug socket implementations in various ways.
  45. * 
  46. * Example 1:
  47. * <code>
  48. * require_once 'System/Socket.php';
  49. * require_once 'System/Socket/Debugger.php';
  50. * $conn = &System_Socket::createConnection(
  51. *   array('address'=>'pear.php.net', 'port'=>80));
  52. * $conn->attach(new System_Socket_Debugger(SYSTEM_SOCKET_DEBUG_ECHO));
  53. * </code>
  54. * 
  55. * Example 2:
  56. * <code>
  57. * // no need to explicitly create a System_Socket_Debugger object
  58. * require_once 'System/Socket.php';
  59. * require_once 'System/Socket/Debugger.php';
  60. * define('SYSTEM_SOCKET_DEBUG', SYSTEM_SOCKET_DEBUG_ECHO);
  61. * $conn = &System_Socket::createConnection(
  62. *   array('address'=>'pear.php.net', 'port'=>80));
  63. * // a debugger object gets attached automagically
  64. * </code>
  65. *
  66. * @author   Michael Wallner <mike@php.net>
  67. * @version  $Revision: 1.1 $
  68. * @access   public
  69. */
  70. class System_Socket_Debugger extends System_Socket_Observer
  71. {
  72.     /**
  73.     * Linefeed character(s)
  74.     * 
  75.     * @access   public
  76.     * @var      string
  77.     */
  78.     var $LF = "\n";
  79.     
  80.     /**
  81.     * Type
  82.     * 
  83.     * @access   public
  84.     * @var      int
  85.     */
  86.     var $type = SYSTEM_SOCKET_DEBUG_NONE;
  87.  
  88.     /**
  89.     * Whether to log all method calls
  90.     * 
  91.     * @access   public
  92.     * @var      bool
  93.     */
  94.     var $verboseCalls = true;
  95.     
  96.     /**
  97.     * Whether to log methods arguments
  98.     * 
  99.     * @access   public
  100.     * @var      bool
  101.     */
  102.     var $verboseArgs = true;
  103.     
  104.     /**
  105.     * Whether to log methods results
  106.     * 
  107.     * @access   public
  108.     * @var      bool
  109.     */
  110.     var $verboseResults = true;
  111.     
  112.     /**
  113.     * Whether to echo a date
  114.     * 
  115.     * @access   public
  116.     * @var      bool
  117.     */
  118.     var $echoDate = true;
  119.     
  120.     /**
  121.     * Echoed dates format
  122.     * 
  123.     * @access   public
  124.     * @var      string
  125.     */
  126.     var $dateFormat = 'Y-m-d H:i:s';
  127.     
  128.     /**
  129.     * PEAR::Log object
  130.     * 
  131.     * @readonly
  132.     * @access   public
  133.     * @var      object
  134.     */
  135.     var $PearLog = null;
  136.     
  137.     /**
  138.     * Whether a PEAR::Log object is attached
  139.     * 
  140.     * @readonly
  141.     * @access   public
  142.     * @var      bool
  143.     */
  144.     var $hasPearLog = false;
  145.     
  146.     /**
  147.     * Note stack
  148.     * 
  149.     * @access   protected
  150.     * @var      array
  151.     */
  152.     var $stack = array();
  153.     
  154.     /**
  155.     * Constructor
  156.     * 
  157.     * @access   public
  158.     * @return   object  System_Socket_Debugger
  159.     */
  160.     function System_Socket_Debugger($type = null)
  161.     {
  162.         System_Socket_Debugger::__construct($type);
  163.     }
  164.  
  165.     /**
  166.     * ZE2 Constructor
  167.     * @ignore
  168.     */
  169.     function __construct($type = null)
  170.     {
  171.         parent::__construct();
  172.         
  173.         if (isset($type)) {
  174.             $this->type = $type;
  175.         } elseif (defined('SYSTEM_SOCKET_DEBUG')) {
  176.             $this->type = SYSTEM_SOCKET_DEBUG;
  177.         }
  178.     }
  179.     
  180.     /**
  181.     * Set a configured PEAR_Log object
  182.     * 
  183.     * @access   public
  184.     * @return   bool
  185.     * @param    object Log  $log
  186.     */
  187.     function setPearLog(&$log)
  188.     {
  189.         if ($this->hasPearLog = is_a($log, 'Log')) {
  190.             $this->PearLog = &$log;
  191.             return true;
  192.         }
  193.         return false;
  194.     }
  195.     
  196.     /**
  197.     * Notify
  198.     * 
  199.     * @access   public
  200.     * @return   void
  201.     * @param    array   $note
  202.     */
  203.     function notify($note)
  204.     {
  205.         static $lastVerboseCall;
  206.         
  207.         $this->stack[] = $note;
  208.         list($event, $class, $result, $args) = $note;
  209.         
  210.         if (!$this->verboseCalls) {
  211.             if (isset($lastVerboseCall) && 
  212.                 preg_match('/^'. $lastVerboseCall .'.+/', $event)) {
  213.                 return;
  214.             }
  215.             $lastVerboseCall = $event;
  216.         }
  217.         
  218.         $message = $class . '::' . $event;
  219.         
  220.         if ($this->verboseArgs) {
  221.             $message .= '(';
  222.             if (is_array($args)) {
  223.                 foreach ($args as $arg) {
  224.                     $message .= $this->arg2string($arg) . ', ';
  225.                 }
  226.                 $message = substr($message, 0, -2);
  227.             } else {
  228.                 $message .= $this->arg2string($arg);
  229.             }
  230.             $message .= ')';
  231.         }
  232.         
  233.         if ($this->verboseResults) {
  234.             $message .= ' Result: ' . $this->arg2string($result);
  235.         }
  236.         
  237.         switch ($this->type) {
  238.             
  239.             case SYSTEM_SOCKET_DEBUG_PEAR_LOG:
  240.                 if ($this->hasPearLog) {
  241.                     $this->PearLog->log($message);
  242.                 }
  243.             break;
  244.             
  245.             case SYSTEM_SOCKET_DEBUG_PEAR_ERROR:
  246.                 PEAR::raiseError($message);
  247.             break;
  248.             
  249.             case SYSTEM_SOCKET_DEBUG_ERRORLOG:
  250.                 error_log($message);
  251.             break;
  252.             
  253.             case SYSTEM_SOCKET_DEBUG_TRIGGERERROR;
  254.                 trigger_error($message, E_USER_NOTICE);
  255.             break;
  256.  
  257.             case SYSTEM_SOCKET_DEBUG_ECHO: 
  258.                 if ($this->echoDate) {
  259.                     echo date($this->dateFormat) . ' ';
  260.                 }
  261.                 echo $message, $this->LF;
  262.             break;
  263.         }
  264.     }
  265.     
  266.     /**
  267.     * Get (part of) note stack
  268.     *
  269.     * Each received note gets stored in the notes stack of the debugger.  With
  270.     * this method you can get the whole stack or the <var>$num</var>th part.
  271.     * 
  272.     * @access   public
  273.     * @return   array
  274.     * @param    int     $num
  275.     */
  276.     function getStack($num = null)
  277.     {
  278.         return isset($num, $this->stack[$num]) ? 
  279.             $this->stack[$num] : $this->stack;
  280.     }
  281.     
  282.     /**
  283.     * arg2string
  284.     *
  285.     * Attempts to convert any argument to a representive string.
  286.     * 
  287.     * @access   public
  288.     * @return   string
  289.     * @param    mixed   $arg
  290.     */
  291.     function arg2string($arg)
  292.     {
  293.         switch (strToLower($type = getType($arg)))
  294.         {
  295.             case 'null':
  296.             {
  297.                 return 'NULL';
  298.             }
  299.             
  300.             case 'resource':
  301.             {
  302.                 return get_resource_type($arg) . ' (' . (string) $arg . ')';
  303.             }
  304.             
  305.             case 'double':
  306.             case 'integer':
  307.             {
  308.                 return (string) $arg;
  309.             }
  310.             
  311.             case 'object':
  312.             {
  313.                 return get_class($arg) . ' (' . (method_exists($arg, 'toString')
  314.                     ? $arg->toString() : ('Object' == ($string = (string) $arg)
  315.                     ? '(' . serialize($arg) . ')' : $string));
  316.             }
  317.             
  318.             case 'array':
  319.             {
  320.                 return 'Array (' . serialize($arg) .')';
  321.             }
  322.             
  323.             case 'string':
  324.             {
  325.                 return '"' . addCSlashes($arg, "\n\t\r\"\0") . '"';
  326.             }
  327.             
  328.             default:
  329.             {
  330.                 return "($type) " . (string) $arg;
  331.             }
  332.         }
  333.     }
  334. }
  335. ?>