serginhold/phalcon-profiler

Maintainers

Details

github.com/SerginhoLD/phalcon-profiler

Source

Issues

Installs: 23

Dependents: 0

Suggesters: 0

Security: 0

Stars: 2

Watchers: 1

Forks: 0

Open Issues: 0

0.2.0 2023-07-11 09:29 UTC

Requires

  • php: >=8.0
  • ext-phalcon: ^5.1
  • ext-yaml: *
  • ext-zip: *

Requires (Dev)

MIT 0d86b272acbde7376889e5bb5f89918c17fb136c

profilerphalcon

This package is auto-updated.

Last update: 2024-05-11 11:37:42 UTC

README

composer require --dev serginhold/phalcon-profiler

  • PHP >= 8.0
  • Phalcon >= 5.1
  • ext-yaml
  • ext-zip

Install

Di:

use Phalcon\Di\DiInterface;
use Phalcon\Mvc\Application;
use SerginhoLD\Phalcon\WebProfiler\WebProfiler;

/** @var DiInterface $di */
if ('dev' === $env) {
    $di->register(new WebProfiler());
}

/** @var Application $application */
$application->setEventsManager($di->getShared('eventsManager'));

Configure eventsManager:

eventsManager:
  className: Phalcon\Events\Manager
  calls:
    - method: enablePriorities
      arguments:
        - { type: parameter, value: true }

Enable events in services:

  dispatcher:
  db:
  view:
  volt:
    calls:
      - method: setEventsManager
        arguments:
          - { type: service, name: eventsManager }

Profiler config

// ./config/config.php

return [
    'profiler' => [
        'viewsCachePath' => '/var/www/var/cache/volt/',
        'tagsDir' => '/var/www/var/profiler',
        'routePrefix' => '/_profiler',
        'collectors' => [
            /** @see \SerginhoLD\Phalcon\WebProfiler\Collector\CollectorInterface */
            CustomCollector::class,
        ],
    ],
];

Toolbar

{# layout.volt #}
<body>
content

{% if _profilerTag is defined %}
    <script>
        document.addEventListener('DOMContentLoaded', function () {
            fetch('{{ url(['for': '_profiler-bar', 'tag': _profilerTag])|escape_js }}')
                .then(function(res) { return res.text() })
                .then(function(data) {
                    document.body.innerHTML += data
                })
                .catch(function(e) {
                    console.error(e)
                })
        })
    </script>
{% endif %}
</body>

screenshot.bar.png

Logger

Create a logger adapter:

$container->setShared('devLoggerAdapter', function () use ($container) {
    return $container->has('profilerLoggerAdapter')
        ? $container->getShared('profilerLoggerAdapter')
        : new \Phalcon\Logger\Adapter\Noop();
});

Usage:

logger:
  className: Phalcon\Logger\Logger
  shared: true
  arguments:
    - { type: parameter, value: main }
  calls:
    - method: addAdapter
      arguments:
        - { type: parameter, value: profiler }
        - { type: service, name: devLoggerAdapter }

Stopwatch in production

Create a stopwatch adapter:

use Phalcon\Di\DiInterface;
use Phalcon\Di\ServiceProviderInterface;

class StopwatchProvider implements ServiceProviderInterface
{
    public function register(DiInterface $di): void
    {
        $di->setShared('stopwatch', function () use ($di) {
            return $di->has('profilerStopwatch') ? $di->getShared('profilerStopwatch') : null;
        });
    }
}

Usage:

$di->get('stopwatch')?->start('test');
// ...
$di->get('stopwatch')?->stop('test');

Custom collector

use SerginhoLD\Phalcon\WebProfiler\Collector\CollectorInterface;

class CustomCollector implements CollectorInterface
{
    public function templatePath(): string
    {
        return '/var/www/templates/custom'; // .volt
    }

    public function name(): string
    {
        return 'Custom';
    }

    public function icon(): string
    {
        return '';
    }

    public function collect(): array
    {
        return [
            'message' => 'hello',
        ];
    }
}
{# custom.volt #}
{% extends '@profiler/profiler.volt' %}

{% block panel %}
    Message: {{ message|e }}
{% endblock %}

Screenshot

screenshot.png