rizalmf/slim-simple-profiler

Simple Middleware For Profiling Slim Framework 3

v1.0.0 2021-07-06 12:39 UTC

Requires

• php: >=7.3
• maximebf/debugbar: ^1.16
• psr/http-message: >=1.0
• twig/twig: ^3.3

Requires (Dev)

• phpunit/phpunit: *
• slim/slim: ~3.0

MIT

• Rizal Maulana Fahmi

• debug
• profiler
• middleware
• slim framework
• psr-7
• slim 3

README

Simple Middleware For Profiling Slim Framework 3. implement awesome library maximebf/debugbar. Inspired by Codeigniter profiler

Screenshots

Table of contents

• Install
• Usage
  • Enable/disable darkmode
  • Eloquent/ORM
  • Doctrine/ORM
  • GuzzleHttp
  • Set response format
• License

Install

via "composer require"

composer require rizalmf/slim-simple-profiler

Usage:

use Simple\Profiler\Profiler;
use Simple\Profiler\Container;

require_once __DIR__ . '/vendor/autoload.php'; // example path

$app = new \Slim\App();

// add middleware
$app->add(new Profiler(new Container()));

Enable/disable darkmode

Set darkmode html format. default: true

// ...
$container = new Container();
$container->setDarkMode(false);

$app->add(new Profiler($container));

Eloquent/ORM

Register \Illuminate\Database\Capsule\Manager to container

//-------- OPTION ONE --------//
// in case you use static Manager

// ...
$DB = new \Illuminate\Database\Capsule\Manager();
$DB->addConnection($settings['your_eloquent_cfg']);

$DB->setAsGlobal();
$DB->bootEloquent();

// register to container
$container->setEloquentManager($DB);

// add middleware
$app->add(new Profiler($container));

//-------- OPTION TWO --------//
// in case you set eloquent to slim container

// ...
$settings = require __DIR__.'/../config/settings.php';
$app = new \Slim\App($settings);

$appContainer = $app->getContainer();

$appContainer['capsule'] = function ($c) {
    $capsule = new \Illuminate\Database\Capsule\Manager;
    $capsule->addConnection($c->get('settings')['your_eloquent_cfg']);

    $capsule->setAsGlobal();
    $capsule->bootEloquent();

    return $capsule;
};

// register capsule to container
$container->setEloquentManager($appContainer['capsule']);

// add middleware
$app->add(new Profiler($container));

Doctrine/ORM

Register \Doctrine\DBAL\Logging\DebugStack to container

// ...
$settings = require __DIR__.'/../config/settings.php';
$app = new \Slim\App($settings);

$appContainer = $app->getContainer();

$appContainer['dao'] = function ($c) {
    $settings = $c->get('settings');

    $config = \Doctrine\ORM\Tools\Setup::createAnnotationMetadataConfiguration(
        $settings['doctrine']['meta']['entity_path'],
        $settings['doctrine']['meta']['auto_generate_proxies'],
        $settings['doctrine']['meta']['proxy_dir'],
        $settings['doctrine']['meta']['cache'],
        false
    );
    return \Doctrine\ORM\EntityManager::create($settings['doctrine']['connection'], $config);
};

// first.. you have to bind DebugStack to your entityManager
$logger = new \Doctrine\DBAL\Logging\DebugStack();
$appContainer['dao']->getConnection()
    ->getConfiguration()
    ->setSQLLogger($logger);

// register DebugStack to container
$container->setDoctrineStack($logger);

// add middleware
$app->add(new Profiler($container));

GuzzleHttp

Catch guzzlehttp events via Profiler::guzzleStack()

// ...

$stack = \GuzzleHttp\HandlerStack::create();
$stack->push(\Simple\Profiler\Profiler::guzzleStack());

// set options \GuzzleHttp\Client 
$options['handler'] = $stack;
$client = new \GuzzleHttp\Client($options);

Set response format

Default: Container::HTTP_FORMAT

// ...
$container = new Container();

// response as text/html
$container->setResponseFormat(Container::HTTP_FORMAT);

// response as application/json content-type
$container->setResponseFormat(Container::JSON_FORMAT);

$app->add(new Profiler($container));

LICENSE

The MIT License (MIT) Copyright (c) 2021 Rizal Maulana Fahmi