Debug Kit¶

Configuração do banco de dados¶

Como informado anteriormente, por padrão, o DebugKit armazenará os dados do painel em um banco de dados SQLite no diretório /tmp de sua aplicação. Se você não puder instalar a extensão pdo_sqlite do PHP, você pode configurar o DebugKit para usar um banco de dados diferente ao definir uma conexão debug_kit em seu arquivo config/app.php. Por exemplo:

/**
 * A conexão debug_kit armazena meta-dados do DebugKit.
 */
'debug_kit' => [
    'className' => 'Cake\Database\Connection',
    'driver' => 'Cake\Database\Driver\Mysql',
    'persistent' => false,
    'host' => 'localhost',
    //'port' => 'nonstandard_port_number',
    'username' => 'dbusername',    // Your DB username here
    'password' => 'dbpassword',    // Your DB password here
    'database' => 'debug_kit',
    'encoding' => 'utf8',
    'timezone' => 'UTC',
    'cacheMetadata' => true,
    'quoteIdentifiers' => false,
    //'init' => ['SET GLOBAL innodb_stats_on_metadata = 0'],
],

Criando uma Panel Class¶

Panel Classes precisam ser colocadas no diretório src/Panel. O nome do arquivo deve combinar com o nome da classe, então a classe MyCustomPanel deveria remeter ao nome de arquivo src/Panel/MyCustomPanel.php:

namespace App\Panel;

use DebugKit\DebugPanel;

/**
 * My Custom Panel
 */
class MyCustomPanel extends DebugPanel
{
    ...
}

Perceba que painéis customizados são necessários para extender a classe DebugPanel.

Callbacks¶

Por padrão objetos do painel possuem dois callbacks, permitindo-lhes acoplar-se na requisição atual. Painéis inscrevem-se aos eventos Controller.initialize e Controller.shutdown. Se o seu painel precisa inscrever-se a eventos adicionais, você pode usar o método implementedEvents para definir todos os eventos aos quais o seu painel possa precisar estar inscrito.

Você deveria estudar os painéis nativos para absorver alguns exemplos de como construir painéis.

Elementos do painel¶

Cada painel deve ter um elemento view que renderiza o conteúdo do mesmo. O nome do elemento deve ser sublinhado e flexionado a partir do nome da classe. Por exemplo SessionPanel deve possuir um elemento nomeado session_panel.ctp, e SqllogPanel deve possuir um elemento nomeado sqllog_panel.ctp. Estes elementos devem estar localizados na raiz do seu diretório src/Template/Element.

Títulos personalizados e Elementos¶

Os painéis devem relacionar o seu título e o nome do elemento por convenção. No entanto, se você precisa escolher um nome de elemento personalizado ou título, você pode definir métodos para customizar o comportamento do seu painel:

• title() - Configure o título que é exibido na barra de ferramentas.

• elementName() - Configure qual elemento deve ser utilizada para um determinado painel.

Métodos de captura¶

Você também pode implementar os seguintes métodos para customizar como o seu painel se comporta e se aparenta:

• shutdown(Event $event) Esse método coleta e prepara os dados para o painel. Os dados são geralmente armazenados em $this->_data.

• summary() Este método retorna uma string de dados resumidos para serem exibidos na toolbar, mesmo quando um painel está minimizado. Frequentemente, é um contador ou um pequeno resumo de informações.

• data() Este método retorna os dados do painel que serão usados como contexto para o elemento. Você pode manipular os dados coletados no método shutdown(). Esse método deve retornar dados que podem ser serializados.

Painéis em outros plugins¶

Painéis disponibilizados por plugins funcionam quase que totalmente como outros plugins, com uma pequena diferença: Você deve definir public $plugin como o nome do diretório do plugin, com isso os elementos do painel poderão ser encontrados no momento de renderização:

namespace MyPlugin\Panel;

use DebugKit\DebugPanel;

class MyCustomPanel extends DebugPanel
{
    public $plugin = 'MyPlugin';
        ...
}

Para usar um plugin ou painel da aplicação, atualize a configuração do DebugKit de sua aplicação para incluir o painel:

Configure::write(
    'DebugKit.panels',
    array_merge(Configure::read('DebugKit.panels'), ['MyCustomPanel'])
);

O código acima deve carregar todos os painéis padrão tanto como os outros painéis customizados do MyPlugin.