README

🐛 Sikessem Debugger

Debug a PHP script easily by following its backtrace.

🔖 Contents

• 🐛 Sikessem Debugger
  • 🔖 Contents
  • 📋 Requirements
  • 🎉 Getting Started
    • ⚡️ Installation
    • 🧑‍💻 Usage
  • 📖 Documentation
  • 👏 Contribution
    • 👷 Code of Conduct
    • 👥 Contributing Guide
    • 🔒️ Good First Issues
    • 💬 Discussions
  • 🔐 Security Reports
  • 📄 License

📋 Requirements

• Requires PHP 8.1+ (at least 8.1.19 recommended to avoid potential bugs).
• Requires Composer v2+ to manage PHP dependencies.

🎉 Getting Started

⚡️ Installation

Install Debugger using Composer:

• By adding the sikessem/debugger dependency to your composer.json file:

{
    "require" : {
        "sikessem/debugger": "self.version"
    }
}

• Or by including the dependency:

composer require sikessem/debugger --no-dev

🧑‍💻 Usage

<?php

$trace = backtrace();

$trace->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.

👏 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

Sikessem has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

👥 Contributing Guide

Read our Contributing Guide 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 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.

💬 Discussions

Larger discussions and proposals are discussed in Sikessem's GitHub discussions.

🔐 Security Reports

If you discover a security vulnerability within Sikessem, please email SIGUI Kessé Emmanuel at contact@sigui.ci. All security vulnerabilities will be promptly addressed.

📄 License

The Sikessem Debugger is open-sourced software licensed under the MIT License - see the LICENSE file for details.