https://github.com/sikessem/debugger
🐛 Debug a PHP script easily by following its backtrace.
https://github.com/sikessem/debugger
backtrace debug php tracer
Last synced: 3 months ago
JSON representation
🐛 Debug a PHP script easily by following its backtrace.
- Host: GitHub
- URL: https://github.com/sikessem/debugger
- Owner: Sikessem
- License: mit
- Created: 2023-07-15T04:15:30.000Z (about 2 years ago)
- Default Branch: 0.x
- Last Pushed: 2023-07-15T13:41:31.000Z (about 2 years ago)
- Last Synced: 2025-06-19T14:08:46.602Z (4 months ago)
- Topics: backtrace, debug, php, tracer
- Language: PHP
- Homepage: https://packagist.org/packages/sikessem/debugger
- Size: 28.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![sikessem-logo]][sikessem-link]
[![php-icon]][php-link]
[![packagist-version-icon]][packagist-version-link]
[![packagist-download-icon]][packagist-download-link]
[![license-icon]][license-link]
[![actions-icon]][actions-link]
[![pr-icon]][pr-link]
[![twitter-icon]][twitter-link]
[sikessem-logo]: https://github.com/sikessem/art/blob/HEAD/images/sikessem.svg
[sikessem-link]: https://github.com/sikessem "Sikessem"
[php-icon]: https://img.shields.io/badge/PHP-ccc.svg?style=flat&logo=php
[php-link]: https://github.com/sikessem/debugger/search?l=php "PHP code"
[packagist-version-icon]: https://img.shields.io/packagist/v/sikessem/debugger
[packagist-version-link]: https://packagist.org/packages/sikessem/debugger "Debugger Releases"
[packagist-download-icon]: https://img.shields.io/packagist/dt/sikessem/debugger
[packagist-download-link]: https://packagist.org/packages/sikessem/debugger "Debugger Downloads"
[actions-icon]: https://github.com/sikessem/debugger/workflows/CI/badge.svg
[actions-link]: https://github.com/sikessem/debugger/actions "Debugger status"
[pr-icon]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?color=brightgreen
[pr-link]: https://github.com/sikessem/.github/blob/HEAD/CONTRIBUTING.md "PRs welcome!"
[twitter-icon]: https://img.shields.io/twitter/follow/sikessem.svg?label=@sikessem_tweets
[twitter-link]: https://twitter.com/intent/follow?screen_name=sikessem_tweets "Ping Sikessem"
[license-icon]: https://img.shields.io/badge/license-MIT-blue.svg
[license-link]: https://github.com/sikessem/debugger/blob/HEAD/LICENSE "Debugger License"
[conduct-link]: https://github.com/sikessem/debugger/blob/HEAD/CODE_OF_CONDUCT.md
[discuss-link]: https://github.com/orgs/sikessem/discussions
[docs-link]: https://github.com/sikessem/debugger#readme "Debugger Documentation"
***
# 🐛 Sikessem Debugger
Debug a PHP script easily by following its backtrace.
## 🔖 Contents
- [🐛 Sikessem Debugger](#-sikessem-debugger)
- [🔖 Contents](#-contents)
- [📋 Requirements](#-requirements)
- [🎉 Getting Started](#-getting-started)
- [⚡️ Installation](#️-installation)
- [🧑💻 Usage](#-usage)
- [📖 Documentation](#-documentation)
- [👏 Contribution](#-contribution)
- [👷 Code of Conduct](#-code-of-conduct)
- [👥 Contributing Guide](#-contributing-guide)
- [🔒️ Good First Issues](#️-good-first-issues)
- [💬 Discussions](#-discussions)
- [🔐 Security Reports](#-security-reports)
- [📄 License](#-license)
## 📋 Requirements
> - **Requires [PHP 8.1+](https://php.net/releases/)** (at least 8.1.19 recommended to avoid potential bugs).
> - **Requires [Composer v2+](https://getcomposer.org/)** to manage PHP dependencies.
## 🎉 Getting Started
### ⚡️ Installation
Install [Debugger](https://packagist.org/packages/sikessem/debugger) using [Composer](https://getcomposer.org/):
- By adding the `sikessem/debugger` dependency to your `composer.json` file:
```json
{
"require" : {
"sikessem/debugger": "self.version"
}
}
```
- Or by including the dependency:
```bash
composer require sikessem/debugger --no-dev
```
### 🧑💻 Usage
```php
getStack(); // Returns the trace stack
$trace->getDirectory(); // Returns the trace directory
$trace->getFile(); // Returns the trace file
$trace->getLine(); // Returns the trace line
$trace->getClass(); // Returns the trace class
$trace->getObject(); // Returns the trace object
$trace->getFunction(); // Returns the trace function
$trace->getType(); // Returns the trace type
$trace->getArgs(); // Returns the trace args
var_dump($trace); // Dumps the trace stack
```
## 📖 Documentation
The full documentation for the Sikessem Debugger can be found on [this address][docs-link].
## 👏 Contribution
The main purpose of this repository is to continue evolving Sikessem. We want to make contributing to this project as easy and transparent as possible, and we are grateful to the community for contributing bug fixes and improvements. Read below to learn how you can take part in improving Sikessem.
### [👷 Code of Conduct][conduct-link]
Sikessem has adopted a Code of Conduct that we expect project participants to adhere to.
Please read the [full text][conduct-link] so that you can understand what actions will and will not be tolerated.
### 👥 [Contributing Guide][pr-link]
Read our [**Contributing Guide**][pr-link] to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Sikessem.
### 🔒️ Good First Issues
We have a list of [good first issues][gfi] that contain bugs which have a relatively limited scope. This is a great place to get started, gain experience, and get familiar with our contribution process.
[gfi]: https://github.com/sikessem/debugger/labels/good%20first%20issue
### 💬 Discussions
Larger discussions and proposals are discussed in [**Sikessem's GitHub discussions**][discuss-link].
## 🔐 Security Reports
If you discover a security vulnerability within [Sikessem][sikessem-link], please email [SIGUI Kessé Emmanuel](https://sigui.ci) at [contact@sigui.ci](mailto:contact@sigui.ci). All security vulnerabilities will be promptly addressed.
## 📄 License
The Sikessem Debugger is open-sourced software licensed under the [MIT License](https://opensource.org/licenses/MIT) - see the [LICENSE][license-link] file for details.
***
Made with ❤︎ by @siguici.