pixelee/insight-dumper

InsightDumper est un outil de débogage PHP conçu pour offrir aux développeurs une vision claire et approfondie de leurs données au moment du développement.

dev-main 2024-04-20 08:14 UTC

Requires

• php: >=8.2

Requires (Dev)

• phpunit/phpunit: ^9.5
• roave/security-advisories: dev-latest

MIT

• Guillaume Bouyer

README

InsightDumper is a PHP debugging tool designed to provide developers with a clear and detailed view of their data during development. Combining advanced variable dumping features with a colorful and intuitive visual presentation, InsightDumper transforms the way developers interact with their data, making the debugging process not just more efficient but also enjoyable.

Key Features

• Enhanced Visualization: Enjoy a colorful and structured display of data, making the inspection of complex arrays, objects, and other PHP data types straightforward and direct.
• Seamless Integration: Designed for effortless integration into any PHP project, whether you're using a specific framework like Laravel or Symfony, or operating in a pure PHP environment.
• Rich Functionality: From straightforward variable dumping to advanced features like execution tracing and performance profiling, InsightDumper is equipped to meet all your debugging needs.
• Customization: Tailor the display and behavior of InsightDumper to perfectly match your debugging workflow and preferences.

Whether you're a solo developer working on your passion project or a team building a large-scale PHP application, InsightDumper is here to illuminate your debugging process with clarity, color, and deep insight into your data.

Installation

To get started with InsightDumper, install it via Composer:

composer require pixelee/insight-dumper

Usage

Standard PHP Project

1. Setup: Include Composer's autoload file and the in() function file in your project.

require_once 'vendor/autoload.php';
require_once __DIR__ . '/vendor/pixelee/insight-dumper/Resources/functions/in.php';

1. Variable Dumping: Use the in() function to dump variables for debugging.

$data = ['name' => 'John', 'age' => 30];
in($data);

PHP MVC Frameworks

Laravel

• Service Provider and Facade (Optional): Optionally, register InsightDumper as a service provider and create a facade for an elegant syntax.
• Usage: Call in() within your application to debug data effortlessly.

// In a controller method
$users = User::all();
in($users);

Symfony

• Service Configuration: Optionally, configure InsightDumper as a service in services.yaml.
• Usage: Use in() in controllers or services for debugging.

// In a controller action
$users = $this->userRepository->findAll();
in($users);