內容簡介
RHJ4 Diagnostics 可以捕獲 PHP 中撰寫的診斷訊息，並有條件地將它們導向不同的日誌函數。該外掛可以在頁面執行期間啟用或禁用，並且它可以攔截和處理各種類型的 PHP 錯誤，例如 E_ERROR 和 ~E_NOTICE。文件包含多種用法示例。
診斷可以與 RHJ4 通知緊密結合。每個外掛都使用了另一個外掛中的功能。
使用：
問題：
當我不確定哪個地方出現了錯誤時，追蹤語句是我偏好的調試方法。實現追蹤的常見方法是使用 PHP 的 error_log 函数，該函數將一行文本寫入在 PHP.ini 配置文件中指定的特定文件中。
這種方法很簡單有效，但是也會帶來幾個問題：
1. 之後必須返回代碼並刪除 error_log 呼叫，否則它們將減慢程序速度並填充錯誤日誌，成為現在無用的訊息。
2. 日誌還可能包含形式為 PHP 訊息和堆棧轉儲的不需要儲存的“噪音”。您可以使用 error_reporting（級別）函數控制這些之中的訊息，但有些訊息根本不會消失。
3. 根據您的配置，您可能無法訪問 PHP.ini，因此可能無法查看生成的日誌，因為您無權訪問日誌寫入的位置。
RHJ4Diagnostics：
JavaScript 代碼在瀏覽器中執行，PHP 代碼在服務器中執行，這兩種情況下，您都希望能夠輕鬆捕獲和報告異常情況。
RHJ4Diagnostics 可以在幾個位置上報告其訊息：在瀏覽器的除錯控制台中，在 PHP error_log 中，或者在您指定的函數中。
診斷可以在整個網站或代碼部分中啟用或禁用。由於診斷非常輕量級，因此無需將其從代碼中刪除即可禁用。
PHP API：
PHP 代碼實現為一個類，具有以下功能：
instance()：返回外掛實例（不初始化）。
init($options = NULL)：初始化外掛。
kill()：殺死當前外掛實例。
options ($options = null)：解析並設置當前加載頁面的選項。
set($options = NULL)：在 wp_options 表中解析和設置選項。注意：支持多站點。選項將在 wp_$blog_id_options 表格中設置。
reset()：將所有選項重置為其默認值。
diagnostic($message, $options = NULL)：捕獲診斷訊息。注意：如果 $options 是一個字符串，它將被視為是：array（'source' - > 'whatever:'）。
set_error_reporting($level = null)：設置 PHP error_reporting_level。
render_error_level($level)：將整數 error_level 值轉換為字符串。
OPTIONS：
以下選項可用於所有接受 $options 的函數：
.enabled 啟用外掛（預設值：false）。如果未啟用，將不會顯示診斷訊息。
.threshold 設置閾值以確定哪些訊息將被日誌記錄。具有高於當前閾值的訊息將被記錄。
外掛標籤
開發者團隊
原文外掛簡介
RHJ4 Diagnostics captures diagnostic messages written in PHP and conditionally directs them to various different logging functions. The plugin can be enabled or disabled during page execution, and it can intercept and handle various classes of PHP errors, e.g. E_ERROR & ~E_NOTICE. The documentation includes numerous usage examples.
Diagnostics works closely with RHJ4 Notifications. Each uses functionality in the other plugin.
Usage
The Problem
Using trace statements is my preferred method of debugging when I am not
exactly sure where the bug is coming from. A common method for implementing
tracing is to use the PHP error_log function which writes a line of text
into a specific file that is identified in the PHP.ini configuration file.
This method is simple and effective, but there are several problems that come
along with it:
You have to go back through your code later and remove the error_log calls
or they will slow the program down and fill the error log with what are now
useless messages.
The log may also contain undesired “noise” in the form of PHP messages and
stack dumps. Many of these you can control using the error_reporting (level)
function, but some of these messages simply won’t go away.
Depending on your configuration, you may not have access to PHP.ini and you
may not be able to see the generated log because you don’t have access
rights to the location the log was written to.
RHJ4Diagnostics
Diagnostic problems can arise in the Javascript code executing in the browser
or in PHP code executing in the server. In both cases, you want to be able to
easily capture and report the condition.
RHJ4Diagnostics reports its messages in several places: on the Browser’s
debugging console, in the PHP error_log, or to a function you specify.
Diagnostics can be turned on or off for an entire site or for a single section
of code. Since the diagnostics are very lightweight, they don’t have to be
removed from the code in order to be disabled.
PHP API
The PHP code is implemented as a class with the following functions:
instance(): Return instance of plugin (does not initialize).
init($options = NULL): Initialize plugin
kill(): Kill current instance of plugin
options ($options = null): parse and set options for currently loaded page
set($options = NULL): parse and set options in wp_options table. NOTE: Multisite is supported. Options will be set in wp_$blog_id_options table.
reset(): reset all options to their defaults
diagnostic($message, $options = NULL): Capture a diagnostic message. NOTE: $if $options is a string, it will be treated as if it were: array(‘source’ -> ‘whatever:’).
set_error_reporting($level = null): Set PHP error_reporting_level
render_error_level($level): Translate integer error_level value to string
OPTIONS
The following options may be used for all functions that accept $options:
enabled enables plugin (default: false). If not enabled, no diagnostic messages will be displayed.
threshold sets a threshold that determines which messages will be logged. Messages with a threshold above the current threshold will not be written to the log file.
output identifies output handler function (default: ‘rhj4_log’). Output may be a single function name or an array of function names. Function must exist to be set.
source identifies the body of code that diagnostics will be coming from. This string will be prepended to each message.
logfile identifies where output diagnostics will be saved (default: ‘rhj4_diags.log’).
level PHP error reporting level for PHP diagnostics (default: 71 = 64 + 4 + 2 + 1 = ERROR, WARNING, PARSE, COMPILE ERROR). PHP errors will be reported if WP_DEBUG is TRUE. RHJ4Diagnostics will be reported if plugin is enabled.
Option values are stored in the wp_options table using the key ‘rhj4_diagnostic_options’.
SHORTCODES
The shortcode format is:
[rhj4_diagnostics =
The following code values are supported:
enable [true|false<- default] Enables logging on this page.
disable [true|false<- default] Disables logging on this page.
threshold [0 | integer value] Sets diagnostic threshold level. Only messages with this threshold or lower will be logged.
save [true|false<- default] Used with Enable, Disable and Threshold to save settings
to database. To enable diagnostics for all pages:
[rhj4_diagnostics enable=true save=true]
show [true|false<- default] Displays current log file contents.
clear [true|false<- default] Deletes current log file.
options [true|false<- default] Displays current option values on page.
demo [true|false<- default] Shows a demonstration of many ways of using this plugin.
test [true|false<- default] Performs some diagnostic tests on the code.
options [true|false<- default] Shows the current option values.
verbose [true|false<- default] Echos diagnostic information on the page.
log [true|false<- default] Writes a diagnostic to the log. Requires message. For example:
[rhj4_diagnostics log=true message='log this message']
message = is used with notify and log to define the message to be sent.
notify [true|false<- default] Displays a notification popup using RHJ4Notifications. Requires message and uses sticky and type.
[rhj4_diagnostics notify=true message='show this message in popup' sticky=true, type=NOTIFICATION_TYPE_WARNING]
sticky [true|false<- default] is used with notify to indicate whether the notification message is “sticky”, i.e. will stay visible on the screen until a page turn or the message is deleted.
type = (NOTIFICATION_TYPE_CONFIRMATION<- default) indicates the type of notification to be generated.
Example:
[rhj4_diagnostics enable=true show=true clear=true show_options=true]
Will produce:
Options
array (size=6)
'enabled' => int 1
'threshold' => int 10
'output' => string 'rhj4_log' (length=8)
'source' => string 'DIAG: ' (length=6)
'logfile' => string 'rhj4_diags.log' (length=14)
'level' => int 71
Logfile: D:\ApacheHtdocs\bhamwpdev/wp-content/rhj4_diags.log
09/14/14 04:56:09->DIAG: Page Name [] User [bob_jones]
09/14/14 04:56:55->DIAG: Page Name [diags] User [bob_jones]
rhj4_diags.log deleted
Example:
[rhj4_diagnostics notify=true message="this is a notification" verbose=true]
Will generate a popup window containing the notification message.
NOTE: Use of the notify function requires the installation of the RHJ4 Notifications plugin.
DEMONSTRATION Page: Visit http://bellinghamwordpressdevelopers.com/diags for a demonstration of these shortcodes in action.
EXAMPLES
There are two basic ways to invoke this plugin:
Call rhj4_diagnostic and pass in the message and (optionally) any options
Acquire an instance of the plugin and work with that:
$diags = RHJ4Diagnostics::instance();
$diags holds an instance of the diagnostics object and can be used to invoke methods in the object.
These two lines are equivalent:
$diags->diagnostic('message','SOURCE: ');
$diags->diagnostic('message', array('source' => 'SOURCE: '));
Enable plugin for this page and print a message:
$diags->diagnostic('message',
array('source' => 'SOURCE: ', 'enabled' => true));
This code:
rhj4_diagnostic('this is a message');
Will produce this output in the current log file:
08/13/14 23:36:44->DIAGNOSTICS:this is a message
This example:
$diags = RHJ4Diagnostics::instance();
$diags = RHJ4Diagnostics::instance()->init(array (
'enabled' => true,
'threshold' => 10,
'output' => 'rhj4_log',
'source' => 'DIAGNOSTICS:',
'logfile' => 'rhj4_diags.log',
'level' => E_ALL & ~E_DEPRECATED & ~E_NOTICE & ~E_STRICT
));
$diags->diagnostic($diags->plugin_slug.' enabled');
Will:
Enable the plugin.
Set the message threshold to 10.
Set the output logging function (‘rhj4_log).
Identify the logging file (‘rhj4_diags.log’).
Tell the plugin to report all PHP errors except E_DEPRECATED, E_NOTICE and E_STRICT.
Write a line in the output file like this:
08/13/14 23:36:42->DIAGNOSTICS:rhj4_diagnostics enabled
Demo Code
Add this line of code (or uncomment the line in the plugin source):
add_action('init','rhj4_diagnostics_demo');
and the plugin will execute code in the function rhj4_diagnostics_demo:
Get an instance of this plugin:
$diags = RHJ4Diagnostics::instance();
Reset option settings to their defaults. The reset values are remembered in wp_options:
$diags->clear_log();
$diags->reset();
$options = $diags->options();
var_dump($options);
After reset, plugin will not be enabled, so this next message won’t show:
$message = rhj4_diagnostic('This message will NOT appear in the log.');
var_dump($message);
Enable plugin and change the source message:
$message = $diags->diagnostic('This message WILL appear in log', array(
'enabled' => true,
'source' => 'DEMO: '
));
$options = $diags->options();
var_dump($message);
var_dump($options);
$message = $diags->diagnostic('Turn on reporting of PHP Errors', array(
'level' => E_ALL ));
$options = $diags->options();
var_dump($message);
var_dump($options);
rhj4_diagnostic('End of demo','THE END: ');
Custom Output Handlers
You can write your own output handlers that will direct diagnostics to any file (or database table) that you want. Here is an example:
function my_diagnostic_test_output($message, $logfile = 'rhj4_diags_test.log') {
$timestamp = date('m/d/y H:i:s',time());
$file = fopen($logfile,"a+");
fwrite($file, $timestamp.'->'.$message."\n");
fclose($file);
}
Multiple Output Handlers
//
// This example writes the output to two log files
//
rhj4_diagnostic('more complex message', array(
'source' =>'MULTIPLE FUNCTIONS: ',
'output' => array(
array( 'function' => 'my_diagnostic_test_output',
'logfile' => 'rhj4_diags_test.log'),
array( 'function' => 'rhj4_log',
'logfile' => 'rhj4_diags.log')
)));
SUPPORT
I will attempt to answer your email as quickly as I can, but cannot promise immediate response.
I will entertain ideas for enhancements, especially if I hear the same request from multiple people.
Donations will encourage my support… and my thanks.
CONSULTING
I make my living by helping WordPress developers. If I can help you, please contact me.
Bob Jones
[email protected]
http://bellinghamwordpressdevelopers.com/
