PHP Coupé

Aprendendo

Classes

Coupe_Debug

Funções para debug das aplicações feitas com o PHP Coupe. Informa os componentes usados (classes, módulos, etc), conexões com banco de dados, tempo de cada conexão ao banco, avisos gerais pré-programados, etc.

Os resultados são impressos em uma tabela que flutua sobre o layout do site (position: absolute). Essa tabela possui por tanto alguns comandos de GUI para inserção dos resultados.

Cronometrando

Timer

Opera como um cronômetro para medir o tempo de execução dos comandos.
Trabalha por meio de ações executadas sobre um identificador único.
Pode-se iniciar uma contagem, pausar, despausar ou encerrar a contagem.

Recebe: ($string=identificador_unico, $string=start|pause|unpause|stop, [$string=mensagem_para_descrever_a_contagem], [$string=descricao_a_ser_exibida])
Retorna: VOID (adiciona o tempo ao seu array para ser exibido mais tarde através da função 'show')

...
$Coupe->import('Coupe_Debug');
$Coupe->Coupe_Debug->group('Operações', array('operacoes'));
$Coupe->Coupe_Debug->description('operacoes', 'Tempo para fazer algumas operações');
$Coupe->Coupe_Debug->timer('operacoes', 'start');
// sequencia de operacoes
// for ($i=0; $i...)
// fim da sequencia de operacoes
$Coupe->Coupe_Debug->timer('operacoes', 'stop');
// o tempo corrido serah exibido quando utilizada a funcao 'show'
...

Registrando

Mensage

Recebe mensagens indicativas do programa.
Pode ser usada como indicador do comportamento do programa.

Recebe: ($string=identificador, $string=mensagem, [$string=descricao_a_ser_exibida])
Retorna: VOID (adiciona a mensagem ao seu array para ser exibida mais tarde através da função 'show')

...
$Coupe->import('Coupe_Debug');
$Coupe->Coupe_Debug->group('Avisos gerais', array('mensagens'));
$Coupe->Coupe_Debug->description('mensagens', 'Alertas');
$Coupe->Coupe_Debug->mensage('mensagens', 'Aconteceu um erro aqui');
$Coupe->Coupe_Debug->mensage('mensagens', 'Seu script passou por aqui');
// as mensagens serao exibidas quando utilizada a funcao 'show'
...

Exibindo

Group

Cria grupos para exibição das informações do debug.
Toda mensagem ou timer exibido no debug, DEVE pertencer a um grupo.
Por tanto, o grupo deve ser a primeira coisa a ser criada quando se imprimir algo na tabela do debug.

Recebe: ($string=titulo_grupo, $array=identificadores_das_informacoes)
Retorna: VOID (apenas adiciona itens ao array que será utilizado em 'makeList')

...
$Coupe->import('Coupe_Debug');
$Coupe->Coupe_Debug->group('Grupo de informações', array('bancos_acessados', 'funcoes_carregadas', 'imagens_carregadas'));
...

Description

Criar uma descrição para uma 'mensagem' ou 'timer' exibido na tabela de debug.
Pode-se deixar de usar essa função para incluir a descrição como parâmetro das funções 'mensage' ou 'timer'.

Recebe: ($string=identificador, $string=descricao)
Retorna: VOID (apenas adiciona itens ao array que serah utilizado em 'mensage' ou 'timer')

...
$Coupe->import('Coupe_Debug');
$Coupe->Coupe_Debug->group('Grupo de informações', array('bancos_acessados', 'funcoes_carregadas', 'imagens_carregadas'));
$Coupe->Coupe_Debug->description('bancos_acessados', 'Bancos acessados pela aplicação');
$Coupe->Coupe_Debug->description('funcoes_carregadas', 'Funções utilizadas nessa página');
$Coupe->Coupe_Debug->description('imagens_carregadas', 'Imagens carregadas nessa página');
...

Show

Exibe as informações do debug.

Recebe: VOID
Retorna: STRING (tabela com os resultados)

...
$Coupe->import('Coupe_Debug');
// apos a utilizacao das funcoes de 'timer' e 'mensage', as informacoes sao exibidas
return $Coupe->Coupe_Debug->show();
...