fusionspim/php-capsule-listener

This package is abandoned and no longer maintained. No replacement package was suggested.

Simple debugging tool for usage with Laravel's Eloquent ORM

7.0.0 2022-04-25 11:40 UTC

Requires

• php: ^8.0
• ext-json: ^8.0
• ext-mbstring: ^8.0
• illuminate/database: ^9.0
• illuminate/events: ^9.0
• symfony/var-dumper: ^5.0 || ^6.0

Requires (Dev)

• ext-sqlite3: ^8.0
• ergebnis/composer-normalize: ^2.6
• fusionspim/php-cs-fixer-config: ^10.0
• phpunit/phpunit: ^9.0.0

MIT

• orm
• debug
• laravel
• eloquent
• capsule

README

Capsule Debug Listener is a simple debugging tool for usage with Laravel's Eloquent ORM. It's named "Capsule" after the standalone version of Eloquent.

It will dump out what queries are being executed by Eloquent in your code and show where in your codebase they originate from.

Installation:

composer require --dev fusionspim/php-capsule-listener

Usage

You can start using it by creating a new instance and enabling listening:

$listener = new CapsuleDebugListener;
$listener->enable();
// Run some SQL.
$listener->disable();

If you need to start and stop the debugger across files, you can use it as a singleton:

CapsuleDebugListener::getInstance()->enable();
// Run some SQL.
CapsuleDebugListener::getInstance()->disable();

You can also use it as a multiton by specifying a name. This may be handy for multiple connections:

CapsuleDebugListener::getInstance('write')
    ->setConnection(Capsule::connection('write'))
    ->enable();
// Run some SQL.
CapsuleDebugListener::getInstance('write')->disable();

There are also some handy helper function pairs. You can dump the trace like this:

start_dumping_queries();
// Run some SQL.
stop_dumping_queries();

And you can capture a trace like this:

start_capturing_queries();
// Run some SQL.
$logs = stop_capturing_queries();
var_dump($logs);

By default the output is dumped out using Symfony's VarDumper, but you can also specify your own output handling function when calling enable():

(new CapsuleDebugListener)->enable(function (array $stack) {
    // Your custom output handling here.
});

A trace array is structured like this:

[
    // A running count of how many queries have run.
    'count' => 1,
                        
    // The SQL run with parameters replaced.
    // May contain sensitive data.
    'sql' => 'SELECT * FROM foo', 
    
    // An array that contains a cleaned up stack trace of where the query originated from.
    // Excludes Eloquent's codebase and any magic functions.
    'callees' => [
        'Foo\Bar\Model:do_something in /src/Foo/Bar/Model.php:256',
    ],
]

If you need to debug a specific connection, you can specific it via setConnection():

$listener = new CapsuleDebugListener();
$listener->setConnection(Capsule::connection('write'));
$listener->enable();
// Run some SQL.
$listener->disable();