macino/pdbg

PHP Debuging helper and benchmark tool

1.0.1 2025-02-13 07:46 UTC

Requires

• php: >=8.1

MIT

• tomas.macik

README

Auhtor:	Tomas Macik
Contact:	[e-mail]

Contents

• References
  • Instantination
    • pdbg(), Pdbg::getInst(), _p()
  • Logging and dumping
    • log(msg), l(msg)
    • point([desc]), p([desc])
    • dump(var[, desc]), d(var[, desc])
    • hdump(var[, desc]), hd(var[, desc)
    • hdigh()
  • Benchmarking
    • bstart([desc]), bs([desc])
    • bench(), b()
  • Flushing the buffer
    • flush(), fl()
    • hflush(), hfl()
    • fflush([append]), ffl([append])

References

Instantination

pdbg(), Pdbg::getInst(), _p()

Returns singleton instance of pdbg class.

Logging and dumping

log(msg), l(msg)

Append a message from msg to log buffer with timestamp prefix.

point([desc]), p([desc])

Appends a check point message to log buffer. Description of check point will be added if present in desc.

dump(var[, desc]), d(var[, desc])

Append an exported variable to log buffer. var_export fce is used to get the exported content of variable. Description of dump will be added if present in desc.

hdump(var[, desc]), hd(var[, desc)

Same as dump, but with syntax highlight in html. Improves readability in browsers but it worsen it in console output.

hdigh()

As How Do I Get Here, prints a formatted backtrace to actual position including function itself. It does not dump the objects, only arguments of each function in trace.

Benchmarking

Pdbg can provide multiple benchmarks. Bench marks have their own buffer, so by ending the last started benchmark will be ended. Benchmarsk are messaured in microsecond precission.

bstart([desc]), bs([desc])

Starts a new bechmark and mark it to log buffer with description (default='-').

bench(), b()

Ends the last started benchmark and mark it to log buffer with message containing the duration of the benchmark in miliseconds units.

Flushing the buffer

flush(), fl()

Stops outputbuffer if present. Flushes the content of log buffer to stdout without any surrounding tags and dies. This is good for console debugging.

hflush(), hfl()

Same as flush(), but it uses htmlentities and <pre> tags to format output, so it would be more readable in html output.

fflush([append]), ffl([append])

Flushes the content of log buffer to file pdbg.log without any formatting. If append is true, the content will be appended to the file. Otherwise the file will be overwritten with new content.