Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/donquixote/nicetrace
PHP library to generate a human-friendly backtrace array.
https://github.com/donquixote/nicetrace
Last synced: 7 days ago
JSON representation
PHP library to generate a human-friendly backtrace array.
- Host: GitHub
- URL: https://github.com/donquixote/nicetrace
- Owner: donquixote
- License: mit
- Created: 2016-03-06T02:19:26.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2016-03-06T06:39:50.000Z (over 8 years ago)
- Last Synced: 2024-10-08T09:54:00.334Z (about 1 month ago)
- Language: PHP
- Size: 29.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nicetrace
PHP library to generate a human-friendly backtrace array.
Inspired from [ddebug_backtrace()](http://cgit.drupalcode.org/devel/tree/devel.module?h=8868652ec5f2a1121cf306287f1996dad44f4c27#n1951) in the [Devel](https://drupal.org/project/devel) module for Drupal.
The structure of the nicetrace can be seen in [nicetrace.php](tests/fixtures/nicetrace.php)
## Development status
This library is quite fresh, and I am still ironing out API details, that is, names of interfaces, method signatures, etc.
You are welcome to participate.
## Features
The main design goal is a backtrace array structure that looks nice in recursive array display tools, such as [Krumo](https://github.com/mmucklo/krumo), or possibly [Ladybug](https://github.com/raulfraile/ladybug).
- Indices of trace items enhanced with function / method names.
- Indices for arguments enhanced with parameter names (based on reflection).
- Indices of trace items reversed, so that the index reflects the depth in the call tree.
- Arguments inlined, so the array becomes flatter. E.g.
`$backtrace[5]['args'][0] = ..` becomes
`$nicetrace[' 8: foo()']['args[0]: $x'] = ..`.
- Filename and line number from trace item one level deeper, instead of the "called from".
- File paths shortened, if known base paths are specified.
- File basename and line number combined into one array key. E.g.
`$backtrace[5]['file'] = '/../src/MyNamespace/MyFile.php'; $backtrace[5]['line'] = 97;` becomes
`$nicetrace[' 8: foo()']['MyClass.php: 97'] = 'src/MyNamespace/MyClass.php';`
## Basic usage
```php
use Donquixote\Nicetrace\Util\NicetraceUtil;
$backtrace = debug_backtrace();
$nicetrace = NicetraceUtil::backtraceGetNicetrace($backtrace);
// Choose your favourite recursive function/method for recursive printing.
print_r($nicetrace);
```
## Advanced usage
The library allows to create and compose custom [BacktraceToNicetrace](src/BacktraceToNicetrace/BacktraceToNicetraceInterface.php) handlers.
It is recommended to use the fluent interface provided by the [Builder](src/BacktraceToNicetrace/Builder/BacktraceToNicetraceBuilder.php) class.
```php
use Donquixote\Nicetrace\BacktraceToNicetrace\BacktraceToNicetraceBuilder;
$backtrace = debug_backtrace();
$backtraceToNicetrace = BacktraceToNicetraceBuilder::start()
->withClasslessKey()
->create();
$nicetrace = NicetraceUtil::backtraceGetNicetrace($backtrace);
// Choose your favourite recursive function/method for recursive printing.
print_r($nicetrace);
```
The [test case](tests/src/NicetraceTest.php) gives some examples.