按 PSR-2 规范重命名函数名，格式化代码，类库文件重命名

demo.php

@@ -1,37 +1,38 @@
 <?php
 include './php/slog.function.php';
 
-//配置
-slog(array(
-    'host'                => 'localhost',//websocket服务器地址，默认localhost
-    'optimize'            => false,//是否显示利于优化的参数，如果运行时间，消耗内存等，默认为false
-    'show_included_files' => false,//是否显示本次程序运行加载了哪些文件，默认为false
-    'error_handler'       => false,//是否接管程序错误，将程序错误显示在console中，默认为false
-    'force_client_ids'    => array(//日志强制记录到配置的client_id,默认为空,client_id必须在allow_client_ids中
+echo "string";
+// 配置
+slog([
+    'host'                => 'localhost',  // Websocket 服务器地址，默认 localhost
+    'optimize'            => false,        // 是否显示有利于程序优化的信息，如运行时间、吞吐率、消耗内存等，默认为 false
+    'show_included_files' => false,        // 是否显示本次程序运行加载了哪些文件，默认为 false
+    'error_handler'       => false,        // 是否接管程序错误，将程序错误显示在 Console 中，默认为 false
+    'allow_client_ids'    => [             // 限制允许读取日志的 client_id，默认为空，表示所有人都可以获得日志。
         //'client_01',
         //'client_02',
-    ),
-    'allow_client_ids'    => array(//限制允许读取日志的client_id，默认为空,表示所有人都可以获得日志。
+        //'client_03',
+    ],
+    'force_client_ids'    => [             // 日志强制记录到配置的 client_id，默认为空，client_id 必须在 allow_client_ids 中
         //'client_01',
         //'client_02',
-        //'client_03',
-    ),
-),'config');
+    ]
+], 'config');
 
-//输出日志
-slog('hello world');  //一般日志
-slog('msg','log');  //一般日志
-slog('msg','error'); //错误日志
-slog('msg','info'); //信息日志
-slog('msg','warn'); //警告日志
-slog('msg','trace');// 输入日志同时会打出调用栈
-slog('msg','alert');//将日志以alert方式弹出
-slog('msg','log','color:red;font-size:20px;');//自定义日志的样式，第三个参数为css样式
+// 输出日志
+slog('hello world');     // 一般日志
+// slog('msg', 'log');       // 一般日志
+// slog('msg', 'error');     // 错误日志
+// slog('msg', 'info');      // 信息日志
+// slog('msg', 'warn');      // 警告日志
+// slog('msg', 'trace');     // 输入日志，同时会打出调用栈
+// slog('msg', 'alert');     // 将日志以alert方式弹出
+slog('msg', 'log', 'color:red;font-size:20px;');  // 自定义日志的样式，第三个参数为css样式
 
-//调试sql
+// 调试sql
 /*
-$link=mysql_connect( 'localhost:3306' , 'root' , '123456' , true ) ;
-mysql_select_db('kuaijianli',$link);
-$sql="DELETE * FROM `uxxxser`";
-slog($sql,$link);
- */
+$link = mysql_connect( 'localhost:3306', 'root', '123456', true) ;
+mysql_select_db('kuaijianli', $link);
+$sql = "DELETE * FROM `uxxxser`";
+slog($sql, $link);
+*/

php/slog.php

@@ -5,69 +5,88 @@
  * @author luofei614<weibo.com/luofei614>
  */
 
-namespace think\org;
+namespace think\slog;
 
 class Slog
 {
-    public static $start_time = 0;
+    public static $start_time   = 0;
     public static $start_memory = 0;
-    public static $port = 1116; //SocketLog 服务的http的端口号
-    public static $log_types = array('log', 'info', 'error', 'warn', 'table', 'group', 'groupCollapsed', 'groupEnd', 'alert');
+    public static $port         = 1116; // SocketLog 服务的 http 的端口号
+    public static $log_types    = ['log', 'info', 'error', 'warn', 'table', 'group', 'groupCollapsed', 'groupEnd', 'alert'];
 
-    protected static $_allowForceClientIds = array();    //配置强制推送且被授权的client_id
+    protected static $_allowForceClientIds = [];    // 配置强制推送且被授权的client_id
 
     protected static $_instance;
 
-    protected static $config = array(
-        'enable' => true, //是否记录日志的开关
-        'host' => 'localhost',
-        //是否显示利于优化的参数，如果允许时间，消耗内存等
-        'optimize' => false,
+    protected static $config = [
+        'enable'              => true,      // 是否记录日志的开关
+        'host'                => 'localhost',
+        'optimize'            => false,     // 是否显示利于优化的参数，如果允许时间，消耗内存等
         'show_included_files' => false,
-        'error_handler' => false,
-        //日志强制记录到配置的client_id
-        'force_client_ids' => array(),
-        //限制允许读取日志的client_id
-        'allow_client_ids' => array()
-    );
-
-    protected static $logs = array();
-
-    protected static $css = array(
-        'sql' => 'color:#009bb4;',
-        'sql_warn' => 'color:#009bb4;font-size:14px;',
+        'error_handler'       => false,
+        'force_client_ids'    => [],   // 日志强制记录到配置的 client_id
+        'allow_client_ids'    => []    // 限制允许读取日志的client_id
+    ];
+
+    protected static $logs = [];
+
+    protected static $css = [
+        'sql'           => 'color:#009bb4;',
+        'sql_warn'      => 'color:#009bb4;font-size:14px;',
         'error_handler' => 'color:#f4006b;font-size:14px;',
-        'page' => 'color:#40e2ff;background:#171717;'
-    );
+        'page'          => 'color:#40e2ff;background:#171717;'
+    ];
 
+    /**
+     * [__callStatic description]
+     * @param  [type] $method [description]
+     * @param  [type] $args   [description]
+     * @return [type]         [description]
+     */
     public static function __callStatic($method, $args)
     {
         if (in_array($method, self::$log_types)) {
             array_unshift($args, $method);
-            return call_user_func_array(array(self::getInstance(), 'record'), $args);
+            $ret = call_user_func_array([self::getInstance(), 'record'], $args);
+            // 立即发送日志
+            self::sendLog();
+            self::$logs = [];
+
+            return $ret;
         }
     }
 
+    /**
+     * 显示 SQL 语句调试信息
+     * @param  [type] $sql  [description]
+     * @param  [type] $link [description]
+     * @return [type]       [description]
+     */
     public static function sql($sql, $link)
     {
+        // 使用 mysqli 方式连接 DB
         if (is_object($link) && 'mysqli' == get_class($link)) {
-            return self::mysqlilog($sql, $link);
+            return self::mysqliLog($sql, $link);
         }
 
+        // 使用 mysql 方式连接 DB
         if (is_resource($link) && ('mysql link' == get_resource_type($link) || 'mysql link persistent' == get_resource_type($link))) {
-            return self::mysqllog($sql, $link);
+            return self::mysqlLog($sql, $link);
         }
 
-
+        // 使用 PDO 方式连接 DB
         if (is_object($link) && 'PDO' == get_class($link)) {
-            return self::pdolog($sql, $link);
+            return self::pdoLog($sql, $link);
         }
 
         throw new Exception('SocketLog can not support this database link');
     }
 
-
-
+    /**
+     * 增大 log 日志的字体，颜色设置为 red
+     * @param  [type] $log [description]
+     * @return [type]      [description]
+     */
     public static function big($log)
     {
         self::log($log, 'font-size:20px;color:red;');
@@ -79,15 +98,17 @@ class Slog
             return;
         }
         self::groupCollapsed($msg, $css);
-        $traces = debug_backtrace(false);
-        $traces = array_reverse($traces);
-        $trace_level = $trace_level == '' ? 0 : intval($trace_level);
-        $max = count($traces) - $trace_level;
+
+        $traces      = debug_backtrace(false);
+        $traces      = array_reverse($traces);
+        $trace_level = ($trace_level == '') ? 0 : intval($trace_level);
+        $max         = count($traces) - $trace_level;
+
         for ($i = 0; $i < $max; $i++) {
-            $trace = $traces[$i];
-            $fun = isset($trace['class']) ? $trace['class'] . '::' . $trace['function'] : $trace['function'];
-            $file = isset($trace['file']) ? $trace['file'] : 'unknown file';
-            $line = isset($trace['line']) ? $trace['line'] : 'unknown line';
+            $trace     = $traces[$i];
+            $fun       = isset($trace['class']) ? $trace['class'] . '::' . $trace['function'] : $trace['function'];
+            $file      = isset($trace['file']) ? $trace['file'] : 'unknown file';
+            $line      = isset($trace['line']) ? $trace['line'] : 'unknown line';
             $trace_msg = '#' . $i . '  ' . $fun . ' called at [' . $file . ':' . $line . ']';
             //不输出参数速度会有明显的改善
             //if(!empty($trace['args'])){
@@ -101,8 +122,13 @@ class Slog
         self::groupEnd();
     }
 
-
-    public static function mysqlilog($sql, $db)
+    /**
+     * 使用 mysqli 对象的 Log
+     * @param  [type] $sql [description]
+     * @param  [type] $db  [description]
+     * @return [type]      [description]
+     */
+    public static function mysqliLog($sql, $db)
     {
         if (!self::check()) {
             return;
@@ -110,35 +136,45 @@ class Slog
 
         $css = self::$css['sql'];
         if (preg_match('/^SELECT /i', $sql)) {
-            //explain
+            // 对传入的查询语句执行 explain
             $query = @mysqli_query($db, "EXPLAIN " . $sql);
-            $arr = mysqli_fetch_array($query);
-            self::sqlexplain($arr, $sql, $css);
+            $arr   = mysqli_fetch_array($query);
+            self::sqlExplain($arr, $sql, $css);
         }
-        self::sqlwhere($sql, $css);
+        self::sqlWhere($sql, $css);
         self::trace($sql, 2, $css);
     }
 
-
-    public static function mysqllog($sql, $db)
+    /**
+     * 使用 mysql 对象的 Log
+     * @param  [type] $sql [description]
+     * @param  [type] $db  [description]
+     * @return [type]      [description]
+     */
+    public static function mysqlLog($sql, $db)
     {
         if (!self::check()) {
             return;
         }
         $css = self::$css['sql'];
         if (preg_match('/^SELECT /i', $sql)) {
-            //explain
+            // 对传入的查询语句执行 explain
             $query = @mysql_query("EXPLAIN " . $sql, $db);
-            $arr = mysql_fetch_array($query);
-            self::sqlexplain($arr, $sql, $css);
+            $arr   = mysql_fetch_array($query);
+            self::sqlExplain($arr, $sql, $css);
         }
         //判断sql语句是否有where
-        self::sqlwhere($sql, $css);
+        self::sqlWhere($sql, $css);
         self::trace($sql, 2, $css);
     }
 
-
-    public static function pdolog($sql, $pdo)
+    /**
+     * 使用 PDO 对象的 Log
+     * @param  [type] $sql [description]
+     * @param  [type] $db  [description]
+     * @return [type]      [description]
+     */
+    public static function pdoLog($sql, $pdo)
     {
         if (!self::check()) {
             return;
@@ -150,16 +186,23 @@ class Slog
                 $obj = $pdo->query("EXPLAIN " . $sql);
                 if (is_object($obj) && method_exists($obj, 'fetch')) {
                     $arr = $obj->fetch(\PDO::FETCH_ASSOC);
-                    self::sqlexplain($arr, $sql, $css);
+                    self::sqlExplain($arr, $sql, $css);
                 }
             } catch (Exception $e) {
             }
         }
-        self::sqlwhere($sql, $css);
+        self::sqlWhere($sql, $css);
         self::trace($sql, 2, $css);
     }
 
-    private static function sqlexplain($arr, &$sql, &$css)
+    /**
+     * 对 SQL 语句执行 Explain 解析
+     * @param  [type] $arr  [description]
+     * @param  [type] &$sql [description]
+     * @param  [type] &$css [description]
+     * @return [type]       [description]
+     */
+    private static function sqlExplain($arr, &$sql, &$css)
     {
         $arr = array_change_key_case($arr, CASE_LOWER);
         if (false !== strpos($arr['extra'], 'Using filesort')) {
@@ -171,16 +214,22 @@ class Slog
             $css = self::$css['sql_warn'];
         }
     }
-    private static function sqlwhere(&$sql, &$css)
+
+    /**
+     * 检查 SQL 语句是否还有 Where 条件，如果不含有则显示 warn 信息
+     * @param  [type] &$sql [description]
+     * @param  [type] &$css [description]
+     * @return [type]       [description]
+     */
+    private static function sqlWhere(&$sql, &$css)
     {
-        //判断sql语句是否有where
-        if (preg_match('/^UPDATE |DELETE /i', $sql) && !preg_match('/WHERE.*(=|>|<|LIKE|IN)/i', $sql)) {
+        // 判断 SQL 语句是否有 where 条件
+        if (preg_match('/^UPDATE | DELETE /i', $sql) && !preg_match('/WHERE.*(=|>|<|LIKE|IN)/i', $sql)) {
             $sql .= '<---###########[NO WHERE]';
             $css = self::$css['sql_warn'];
         }
     }
 
-
     /**
      * 接管报错
      */
@@ -189,12 +238,20 @@ class Slog
         if (!self::check()) {
             return;
         }
-
-        set_error_handler(array(__CLASS__, 'error_handler'));
-        register_shutdown_function(array(__CLASS__, 'fatalError'));
+        // 自定义的错误处理
+        set_error_handler([__CLASS__, 'errorHandler']);
+        register_shutdown_function([__CLASS__, 'fatalError']);
     }
 
-    public static function error_handler($errno, $errstr, $errfile, $errline)
+    /**
+     * 设置错误处理函数
+     * @param  [type] $errno   [description]
+     * @param  [type] $errstr  [description]
+     * @param  [type] $errfile [description]
+     * @param  [type] $errline [description]
+     * @return [type]          [description]
+     */
+    public static function errorHandler($errno, $errstr, $errfile, $errline)
     {
         switch ($errno) {
             case E_WARNING:
@@ -247,17 +304,23 @@ class Slog
         self::trace($msg, 2, self::$css['error_handler']);
     }
 
+    /**
+     * Fatal Error 函数
+     * @return [type] [description]
+     */
     public static function fatalError()
     {
         // 保存日志记录
         if ($e = error_get_last()) {
-            self::error_handler($e['type'], $e['message'], $e['file'], $e['line']);
-            self::sendLog(); //此类终止不会调用类的 __destruct 方法，所以此处手动sendLog
+            self::errorHandler($e['type'], $e['message'], $e['file'], $e['line']);
+            self::sendLog(); // 此类终止不会调用类的 __destruct 方法，所以此处手动 sendLog
         }
     }
 
-
-
+    /**
+     * 获取实例
+     * @return [type] [description]
+     */
     public static function getInstance()
     {
         if (self::$_instance === null) {
@@ -266,22 +329,28 @@ class Slog
         return self::$_instance;
     }
 
-
+    /**
+     * 执行检查
+     * @return [type] [description]
+     */
     protected static function check()
     {
         if (!self::getConfig('enable')) {
             return false;
         }
+
         $tabid = self::getClientArg('tabid');
-        //是否记录日志的检查
+        // 是否记录日志的检查
         if (!$tabid && !self::getConfig('force_client_ids')) {
             return false;
         }
-        //用户认证
+
+        // 用户认证
         $allow_client_ids = self::getConfig('allow_client_ids');
         if (!empty($allow_client_ids)) {
-            //通过数组交集得出授权强制推送的client_id
+            // 通过数组交集运算，得出授权强制推送的 client_id
             self::$_allowForceClientIds = array_intersect($allow_client_ids, self::getConfig('force_client_ids'));
+
             if (!$tabid && count(self::$_allowForceClientIds)) {
                 return true;
             }
@@ -293,12 +362,18 @@ class Slog
         } else {
             self::$_allowForceClientIds = self::getConfig('force_client_ids');
         }
+
         return true;
     }
 
+    /**
+     * 获取客户端参数
+     * @param  [type] $name [description]
+     * @return [type]       [description]
+     */
     protected static function getClientArg($name)
     {
-        static $args = array();
+        static $args = [];
 
         $key = 'HTTP_USER_AGENT';
 
@@ -309,33 +384,38 @@ class Slog
         if (!isset($_SERVER[$key])) {
             return null;
         }
+
         if (empty($args)) {
             if (!preg_match('/SocketLog\((.*?)\)/', $_SERVER[$key], $match)) {
-                $args = array('tabid' => null);
+                $args = ['tabid' => null];
                 return null;
             }
             parse_str($match[1], $args);
         }
+
         if (isset($args[$name])) {
             return $args[$name];
         }
+
         return null;
     }
 
-
-    //设置配置
+    /**
+     * 按需设置项目的调试配置项
+     * @param  [type] $config [description]
+     * @return [type]         [description]
+     */
     public static function config($config)
     {
         $config = array_merge(self::$config, $config);
-        if (isset($config['force_client_id'])) {
-            //兼容老配置
-            $config['force_client_ids'] = array_merge($config['force_client_ids'], array($config['force_client_id']));
-        }
+
         self::$config = $config;
+
         if (self::check()) {
-            self::getInstance(); //强制初始化SocketLog实例
+            self::getInstance(); // 强制初始化 SocketLog 实例
+
             if ($config['optimize']) {
-                self::$start_time = microtime(true);
+                self::$start_time   = microtime(true);
                 self::$start_memory = memory_get_usage();
             }
 
@@ -345,8 +425,11 @@ class Slog
         }
     }
 
-
-    //获得配置
+    /**
+     * 获取配置项
+     * @param  [type] $name [description]
+     * @return [type]       [description]
+     */
     public static function getConfig($name)
     {
         if (isset(self::$config[$name])) {
@@ -355,21 +438,28 @@ class Slog
         return null;
     }
 
-    //记录日志
+    /**
+     * 记录日志
+     * @param  [type] $type [description]
+     * @param  string $msg  [description]
+     * @param  string $css  [description]
+     * @return [type]       [description]
+     */
     public function record($type, $msg = '', $css = '')
     {
         if (!self::check()) {
             return;
         }
 
-        self::$logs[] = array(
+        self::$logs[] = [
             'type' => $type,
-            'msg' => $msg,
-            'css' => $css
-        );
+            'msg'  => $msg,
+            'css'  => $css
+        ];
     }
 
     /**
+     * 调试后台 API 时，发送信息
      * @param null $host - $host of socket server
      * @param string $message - 发送的消息
      * @param string $address - 地址
@@ -378,33 +468,37 @@ class Slog
     public static function send($host, $message = '', $address = '/')
     {
         $url = 'http://' . $host . ':' . self::$port . $address;
-        $ch = curl_init();
+        $ch  = curl_init();
         curl_setopt($ch, CURLOPT_URL, $url);
         curl_setopt($ch, CURLOPT_POST, true);
         curl_setopt($ch, CURLOPT_POSTFIELDS, $message);
         curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
         curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 1);
         curl_setopt($ch, CURLOPT_TIMEOUT, 10);
-        $headers = array(
-            "Content-Type: application/json;charset=UTF-8"
-        );
-        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); //设置header
+
+        $headers = ["Content-Type: application/json;charset=UTF-8"];
+
+        curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); // 设置 header
         $txt = curl_exec($ch);
+
         return true;
     }
 
+    /**
+     * 发送 Log
+     * @return [type] [description]
+     */
     public static function sendLog()
     {
         if (!self::check()) {
             return;
         }
 
-
-        $time_str = '';
+        $time_str   = '';
         $memory_str = '';
         if (self::$start_time) {
-            $runtime = microtime(true) - self::$start_time;
-            $reqs = number_format(1 / $runtime, 2);
+            $runtime  = microtime(true) - self::$start_time;
+            $reqs     = number_format(1 / $runtime, 2);
             $time_str = "[运行时间：{$runtime}s][吞吐率：{$reqs}req/s]";
         }
         if (self::$start_memory) {
@@ -417,42 +511,44 @@ class Slog
         } else {
             $current_uri = "cmd:" . implode(' ', $_SERVER['argv']);
         }
-        array_unshift(self::$logs, array(
+
+        array_unshift(self::$logs, [
             'type' => 'group',
-            'msg' => $current_uri . $time_str . $memory_str,
-            'css' => self::$css['page']
-        ));
+            'msg'  => $current_uri . $time_str . $memory_str,
+            'css'  => self::$css['page']
+        ]);
 
         if (self::getConfig('show_included_files')) {
-            self::$logs[] = array(
+            self::$logs[] = [
                 'type' => 'groupCollapsed',
-                'msg' => 'included_files',
-                'css' => ''
-            );
-            self::$logs[] = array(
+                'msg'  => 'included_files',
+                'css'  => ''
+            ];
+            self::$logs[] = [
                 'type' => 'log',
-                'msg' => implode("\n", get_included_files()),
-                'css' => ''
-            );
-            self::$logs[] = array(
+                'msg'  => implode("\n", get_included_files()),
+                'css'  => ''
+            ];
+            self::$logs[] = [
                 'type' => 'groupEnd',
-                'msg' => '',
-                'css' => '',
-            );
+                'msg'  => '',
+                'css'  => '',
+            ];
         }
 
-        self::$logs[] = array(
+        self::$logs[] = [
             'type' => 'groupEnd',
-            'msg' => '',
-            'css' => '',
-        );
+            'msg'  => '',
+            'css'  => '',
+        ];
 
         $tabid = self::getClientArg('tabid');
         if (!$client_id = self::getClientArg('client_id')) {
             $client_id = '';
         }
+
         if (!empty(self::$_allowForceClientIds)) {
-            //强制推送到多个client_id
+            // 强制推送到多个 client_id
             foreach (self::$_allowForceClientIds as $force_client_id) {
                 $client_id = $force_client_id;
                 self::sendToClient($tabid, $client_id, self::$logs, $force_client_id);
@@ -472,19 +568,19 @@ class Slog
      */
     protected static function sendToClient($tabid, $client_id, $logs, $force_client_id)
     {
-        $logs = array(
-            'tabid' => $tabid,
-            'client_id' => $client_id,
-            'logs' => $logs,
+        $logs = [
+            'tabid'           => $tabid,
+            'client_id'       => $client_id,
+            'logs'            => $logs,
             'force_client_id' => $force_client_id,
-        );
-        $msg = @json_encode($logs);
-        $address = '/' . $client_id; //将client_id作为地址， server端通过地址判断将日志发布给谁
+        ];
+        $msg     = @json_encode($logs);
+        $address = '/' . $client_id; // 将 client_id 作为地址，server 端通过地址判断将日志发布给谁
         self::send(self::getConfig('host'), $msg, $address);
     }
 
     public function __destruct()
     {
-        self::sendLog();
+        // self::sendLog();
     }
 }

php/slog.function.php

@@ -1,7 +1,7 @@
 <?php
-require 'slog.php';
+require 'slog.class.php';
 
-use think\org\Slog;
+use think\slog\Slog;
 
 function slog($log, $type = 'log', $css = '')
 {
@@ -9,22 +9,23 @@ function slog($log, $type = 'log', $css = '')
         $type = preg_replace_callback('/_([a-zA-Z])/', function ($matches) {
             return strtoupper($matches[1]);
         }, $type);
-        if (method_exists('\think\org\Slog', $type) || in_array($type, Slog::$log_types)) {
-            return  call_user_func(array('\think\org\Slog', $type), $log, $css);
+
+        if (method_exists('\think\slog\Slog', $type) || in_array($type, Slog::$log_types)) {
+            return  call_user_func(['\think\slog\Slog', $type], $log, $css);
         }
     }
 
     if (is_object($type) && 'mysqli' == get_class($type)) {
-        return Slog::mysqlilog($log, $type);
+        return Slog::mysqliLog($log, $type);
     }
 
     if (is_resource($type) && ('mysql link' == get_resource_type($type) || 'mysql link persistent' == get_resource_type($type))) {
-        return Slog::mysqllog($log, $type);
+        return Slog::mysqlLog($log, $type);
     }
 
 
     if (is_object($type) && 'PDO' == get_class($type)) {
-        return Slog::pdolog($log, $type);
+        return Slog::pdoLog($log, $type);
     }
 
     throw new Exception($type . ' is not SocketLog method');