Creare un raccoglitore di dati personalizzato¶

Creare un raccoglitore di dati personalizzato è semplice, basta implementare DataCollectorInterface:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18

interface DataCollectorInterface
{
    /**
     * Collects data for the given Request and Response.
     *
     * @param Request    $request   A Request instance
     * @param Response   $response  A Response instance
     * @param \Exception $exception An Exception instance
     */
    function collect(Request $request, Response $response, \Exception $exception = null);

    /**
     * Returns the name of the collector.
     *
     * @return string The collector name
     */
    function getName();
}

Il metodo getName() deve restituire un nome univoco. Viene usato per accedere successivamente all'informazione (vedere Come usare il profilatore nei test funzionali, per esempio).

Il metodo collect() è responsabile della memorizzazione dei dati, a cui vuole dare accesso, in proprietà locali.

La maggior parte delle volte, conviene estendere DataCollector e popolare la proprietà $this->data (che si occupa di serializzare la proprietà $this->data):

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

class MemoryDataCollector extends DataCollector
{
    public function collect(Request $request, Response $response, \Exception $exception = null)
    {
        $this->data = array(
            'memory' => memory_get_peak_usage(true),
        );
    }

    public function getMemory()
    {
        return $this->data['memory'];
    }

    public function getName()
    {
        return 'memory';
    }
}

Abilitare i raccoglitori di dati personalizzati¶

Per abilitare un raccoglitore di dati, aggiungerlo come servizio in una delle proprie configurazioni e assegnarli il tag data_collector:

Aggiungere template al profilatore web¶

Quando si vogliono mostrare i dati raccolti dal proprio raccoglitore di dati nella barra di debug del web, oppure nel profilatore web, creare un template Twig, seguendo questo scheletro:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

{% extends 'WebProfilerBundle:Profiler:layout.html.twig' %}

{% block toolbar %}
    {# contenuto della barra di debug del web #}
{% endblock %}

{% block head %}
    {# se il profiltatore web ha bisogno di file JS o CSS #}
{% endblock %}

{% block menu %}
    {# contenuto del menù #}
{% endblock %}

{% block panel %}
    {# contenuto del pannello #}
{% endblock %}

I blocchi sono tutti facoltativi. Il blocco toolbar è usato per la barra di debug del web, mentre menu e panel sono usati per aggiungere un pannello al profilatore web.

Tutti i blocchi hanno accesso all'oggetto collector.

Per abilitare il template, aggiungere un attributo template al tag data_collector nella propria configurazione. Per esempio, ipotizzando che il template sia in un AcmeDebugBundle: