mastir/php-dump

Tool to convert app scopes into binary readable data dump

v1.0 2024-08-12 12:27 UTC

Requires

• php: ^8.1
• ext-zlib: *
• php-ds/php-ds: ^1.5

Requires (Dev)

• friendsofphp/php-cs-fixer: *
• php-parallel-lint/php-parallel-lint: ^1.4
• phpro/grumphp: *
• phpstan/phpstan-strict-rules: ^1.0
• phpunit/php-code-coverage: ^10
• phpunit/phpunit: ^10
• vimeo/psalm: ^5

MIT

• Yevhen pochekuiev

• php
• debug
• dump
• tool

README

Tool to create small dump of your php application

Use cases

• Visualise application exceptions
• Save exception dump for later processing
• Attach dump in bug tracking system
• Dump request data to reproduce bugs
• Review and compare dumps

Basic usage

1. Create dump (binary string) using PhpDumpBuilder
2. Save/transfer dump (optional)
3. Read dump using php-dump.js
4. Render dump using react components in php-dump.jsx

See example in public/index.php

About

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

Install this package as a dependency using Composer.

composer require mastir/php-dump

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.

Copyright and License

mastir/php-dump is copyright © Yevhen and licensed for use under the terms of the MIT License (MIT). Please see LICENSE for more information.