搜索brannonh / php-debug
用于PHP脚本的简单调试类
Requires
- php: >=5.3.0
This package is auto-updated.
Last update: 2024-09-05 11:33:18 UTC
README
php-debug是一个用于PHP脚本的简单调试类。在没有调试器的情况下使用，例如在客户环境中，或者需要收集复杂和/或大量数据，这些数据在调试会话中无法进行分析时，可以使用它。
功能
- 将调试值封装在一个变量中，使以后识别和删除调试代码变得更加容易。
- 使用数组保存复杂的数据结构。
- 只保留特定数量的日志条目（默认为500条最新条目），以避免填满磁盘空间。
- 以JSON格式记录日志数据。
支持
此库未在5.3.29之前的PHP版本上测试。如果您尝试它，请通过打开新的问题让我们知道结果。
如果您在其他版本上发现问题，也请通过打开新问题告诉我们。
用法
要使用php-debug，只需将Debug.php文件放在源文件中的某个位置，并在需要调试的文件中包含或要求它。然后，创建一个新的Debug对象并使用它来收集、保存和记录数据。
// Instantiate Debug. $debug = new Debug; // Save / modify data. $debug->set('hello', 'world'); $debug->set('counter', 0); $debug->increase('counter');
在记录时，数据将存储在您选择的文件位置上作为JSON（默认情况下，在Debug.php相同的目录中为debug.json）。
// Save data to the log file. $debug->log_data('hello'); $debug->log_data('counter');
API
以下API文档按字母顺序排序。为了快速了解基础知识并开始使用，我们建议阅读__construct、set、get、merge、log_data和log_all。
__construct($filename, $data, $log_now, $max_entries)
构造函数的所有参数都有默认值，因此不需要任何参数即可开始使用Debug。$data参数设置内部数据存储，应始终是关联数组。当$data设置为标量或对象时，Debug的行为是未定义的。
参数
返回值
count($key)
计算存储在$key处的数组中的值的数量或字符串中的字符数。
参数
返回值
is_empty($key)
获取PHP的empty()函数在$key处存储的数据元素的结果。
参数
返回值
decrease($key, $val)
对存储在$key处的数据元素执行--或-=操作。
参数
返回值
get($key)
获取存储在$key处的数据元素的值。
参数
返回值
increase($key, $val)
对存储在$key处的数据元素执行++或+=操作。
参数
返回值
log_all()
将所有存储的数据元素写入日志文件。
参数
返回值
log_data($keys)
将存储在$keys处的数据元素写入日志文件。
参数
返回值
log($data, $raw)
直接将数据写入日志文件，而无需将其保存为数据元素。
log_all 和 log_data 与保存的数据元素交互，但此函数会跳过该步骤，当您只想记录当前值时。 log_all 和 log_data 在内部使用此功能。
参数
返回值
merge($key, $data)
将 $data 数组合并到存储在 $key 位置的数据元素中。这是一种一次性更新数据元素中多个值的方法。假设 $key 指向一个数组。
参数
返回值
set($key, $data)
将 $data 保存为存储在 $key 位置的数据元素的值。