https://github.com/kktsvetkov/kluzo

Kluzo PHP Debug Tool is the PHP debugging tool that is always helping you prevent making stupid mistakes and causing accidents
https://github.com/kktsvetkov/kluzo

debug debug-bar debug-tool debug-toolbar debugbar debugger debugging kluzo php php7

Last synced: about 1 month ago
JSON representation

Kluzo PHP Debug Tool is the PHP debugging tool that is always helping you prevent making stupid mistakes and causing accidents

• Host: GitHub
• URL: https://github.com/kktsvetkov/kluzo
• Owner: kktsvetkov
• License: lgpl-3.0
• Created: 2021-10-15T07:03:17.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-01T09:27:29.000Z (about 3 years ago)
• Last Synced: 2024-10-13T12:07:33.340Z (2 months ago)
• Topics: debug, debug-bar, debug-tool, debug-toolbar, debugbar, debugger, debugging, kluzo, php, php7
• Language: PHP
• Homepage:
• Size: 224 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
**NB!** *KT: I am still fiddling with this, and it is not yet stable. In other words,

the code, structure, classes and methods will likely change*

# Kluzo PHP Debug Tool

**Kluzo PHP Debug Tool** is the PHP debugging tool with a purpose: to help you

prevent making stupid mistakes and causing accidents.

**What does this library do?**

In basic terms, *the Inspector wearing Disguise collects Clues in Pockets, which

at the end are presented in a Report using different Formats.*

## Basic Use

You can take **Kluzo** as is out of the box and start using it right away.

## Advanced Use

* [Clues](docs/CLUES.md): how, where and when are clues collected

* [Pockets](docs/POCKETS.md): organizing the clues in ... well, pockets

* [Reports](docs/REPORTS.md): how the collected information are presented when the case is over

* [Formats](docs/FORMATS.md): how formatting the clues for the report works

* [Inspector](docs/INSPECTOR.md): the Inspector collects the clues in pockets, and when ready presents the report

* [Inspector Disguise](docs/DISGUISE.md): how to access the Inspector  

* [Inspector Tricks](docs/TRICKS.md): how the Inspector can learn new tricks

## Tips and Tricks

If the documentation is too big and lengthy for you, here are few tips:

- To silence Kluzo on production environments you must call `kluzo::mute()` (this

	is actually `Kluzo\Disguise::mute()`). This will replace the current

	inspector with an "Imposter" (`Kluzo\Inspector\ImposterInspector`) that

	ignores your commands and at the end of the script will not produce a report.

- You can turn on and off Kluzo while working if you want to stop it from collecting

	clues:

	* turn it ON: `kluzo::on()`, `kluzo::enable()`, `kluzo::resume()` (all aliases to `kluzo::resumeCase()`)

	* turn it OFF: `kluzo::off()`, `kluzo::disable()`, `kluzo::suspend()` (all aliases to `kluzo::suspendCase()`)

	* check is it ON: `kluzo::ison()` (alias of `kluzo::isCasesActive()`)

	* check is it ON: `kluzo::isoff()` (alias of `kluzo::isCasesSuspended()`)

- It is not recommended to rely on the ON/OFF feature if you want to

	silence Kluzo on live production environments as there might be occasional

	rogue code that turns it back on; instead it is better to use `kluzo::mute()`