| 7 | |
| 8 | Ela dispõe de 8 níveis e dois 2 tipos de log: |
| 9 | |
| 10 | === Níveis de Log === |
| 11 | |
| 12 | 0. Emergência: O sistema está inoperante; |
| 13 | 1. Alerta: O sistema necessita de atenção imediata; |
| 14 | 2. Crítico: O sistema encontra-se em situação crítica; |
| 15 | 3. Erro: Erro no sistema; |
| 16 | 4. Aviso: O sistema encontrou-se em situação em que poderia apresentar problemas; |
| 17 | 5. Notificação: O sistema está em situação normal, porém em uma situação significante; |
| 18 | 6. Informação: Informações gerais; |
| 19 | 7. Debug: Modo de Debug. |
| 20 | |
| 21 | === Tipos de Log === |
| 22 | |
| 23 | * Arquivo: Salva o log em arquivo; |
| 24 | * Firebug: Mostra o log no firebug; |
| 25 | |
| 26 | == Configurações == |
| 27 | |
| 28 | Na página de administração do processo pode-se configurar o nível de log. Os níveis de log serão mostrados conforme a configuração especificada, sendo que os logs de maior número fazem com que os logs de menor número sejam lançados. |
| 29 | |
| 30 | '''Exemplo:''' |
| 31 | Para uma configuração "Informação": |
| 32 | {{{ |
| 33 | $log->emerg('emergencia...'); |
| 34 | $log->info('informação...'); |
| 35 | $log->debug('debug...'); |
| 36 | }}} |
| 37 | |
| 38 | No caso acima, somente os logs info e emerg serão lançados. O log de debug não será, pois é maior que o log configurado. |
| 39 | |
| 40 | Os tipos de log permitidos no frontend somente poderão ser configurados por um administrador do módulo, já que envolve questões de segurança. |
| 41 | |
| 42 | == Obtendo um objeto de log == |
| 43 | |
| 44 | Para obter um objeto de log deve-se utilizar a factory, passando como primeiro parâmetro a string 'wf_log': |
| 45 | |
| 46 | {{{ |
| 47 | $log = $this->factory->getInstance('wf_log'); |
| 48 | }}} |
| 49 | |
| 50 | Para obter um objeto de log com um tipo específico que não seja o padrão 'file', basta passar como segundo parâmetro o nome do tipo de log desejado: |
| 51 | {{{ |
| 52 | $log = $this->factory->getInstance('wf_log', 'firebug'); |
| 53 | }}} |
| 54 | |
| 55 | Para obter um objeto de log composto, basta passar como segundo parâmetro um array com os tipos de log desejados: |
| 56 | {{{ |
| 57 | $log = $this->factory->getInstance('wf_log', array('file', 'firebug')); |
| 58 | }}} |
| 59 | |
| 60 | == Métodos == |
| 61 | |
| 62 | === addLogType === |
| 63 | |
| 64 | '''Descrição:''' A classe wf_log suporta que sejam utilizados mais de um tipo de log por vez. Este método adiciona um tipo de log à composição de logs. |
| 65 | |
| 66 | '''Parâmetros:''' |
| 67 | |
| 68 | $logType: nome do tipo de log. |
| 69 | |
| 70 | '''Retorno:''' true para o caso do tipo de log ter sido adicionado com sucesso, false caso contrário. |
| 71 | |
| 72 | '''Exemplo de Uso:''' |
| 73 | |
| 74 | {{{ |
| 75 | $log = $this->factory->getInstance('wf_log'); // neste caso o objeto será criado somente com o tipo padrão: file |
| 76 | $log->addLogType('firebug'); |
| 77 | }}} |
| 78 | |
| 79 | ---- |
| 80 | |
| 81 | === removeLogType === |
| 82 | |
| 83 | '''Descrição:''' Este método remove um tipo de log à composição de logs. |
| 84 | |
| 85 | '''Parâmetros:''' |
| 86 | |
| 87 | $logType: nome do tipo de log. |
| 88 | |
| 89 | '''Retorno:''' o objeto de log removido da composição para o caso do método ter sido executado com sucesso. null caso contrário |
| 90 | |
| 91 | '''Exemplo de Uso:''' |
| 92 | |
| 93 | {{{ |
| 94 | $log = $this->factory->getInstance('wf_log'); |
| 95 | $log->addLogType('firebug'); |
| 96 | |
| 97 | $log->removeLogType('file'); |
| 98 | }}} |
| 99 | |
| 100 | ---- |
| 101 | |
| 102 | === emerg === |
| 103 | |
| 104 | '''Descrição:''' Lança um log de nível emergência |
| 105 | |
| 106 | '''Parâmetros:''' |
| 107 | |
| 108 | $message: Mensagem a ser lançada |
| 109 | |
| 110 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 111 | |
| 112 | '''Exemplo de Uso:''' |
| 113 | |
| 114 | {{{ |
| 115 | $log = $this->factory->getInstance('wf_log'); |
| 116 | |
| 117 | $log->emerg('emergência...'); |
| 118 | }}} |
| 119 | |
| 120 | ---- |
| 121 | |
| 122 | === alert === |
| 123 | |
| 124 | '''Descrição:''' Lança um log de nível alerta |
| 125 | |
| 126 | '''Parâmetros:''' |
| 127 | |
| 128 | $message: Mensagem a ser lançada |
| 129 | |
| 130 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 131 | |
| 132 | '''Exemplo de Uso:''' |
| 133 | |
| 134 | {{{ |
| 135 | $log = $this->factory->getInstance('wf_log'); |
| 136 | |
| 137 | $log->alert('alerta...'); |
| 138 | }}} |
| 139 | |
| 140 | ---- |
| 141 | |
| 142 | === crit === |
| 143 | |
| 144 | '''Descrição:''' Lança um log de nível crítico |
| 145 | |
| 146 | '''Parâmetros:''' |
| 147 | |
| 148 | $message: Mensagem a ser lançada |
| 149 | |
| 150 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 151 | |
| 152 | '''Exemplo de Uso:''' |
| 153 | |
| 154 | {{{ |
| 155 | $log = $this->factory->getInstance('wf_log'); |
| 156 | |
| 157 | $log->crit('crítico...'); |
| 158 | }}} |
| 159 | |
| 160 | ---- |
| 161 | |
| 162 | === error === |
| 163 | |
| 164 | '''Descrição:''' Lança um log de nível erro |
| 165 | |
| 166 | '''Parâmetros:''' |
| 167 | |
| 168 | $message: Mensagem a ser lançada |
| 169 | |
| 170 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 171 | |
| 172 | '''Exemplo de Uso:''' |
| 173 | |
| 174 | {{{ |
| 175 | $log = $this->factory->getInstance('wf_log'); |
| 176 | |
| 177 | $log->error('erro...'); |
| 178 | }}} |
| 179 | |
| 180 | ---- |
| 181 | |
| 182 | |
| 183 | |
| 184 | === warning === |
| 185 | |
| 186 | '''Descrição:''' Lança um log de nível aviso |
| 187 | |
| 188 | '''Parâmetros:''' |
| 189 | |
| 190 | $message: Mensagem a ser lançada |
| 191 | |
| 192 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 193 | |
| 194 | '''Exemplo de Uso:''' |
| 195 | |
| 196 | {{{ |
| 197 | $log = $this->factory->getInstance('wf_log'); |
| 198 | |
| 199 | $log->warning('aviso...'); |
| 200 | }}} |
| 201 | |
| 202 | ---- |
| 203 | |
| 204 | === notice === |
| 205 | |
| 206 | '''Descrição:''' Lança um log de nível notificação |
| 207 | |
| 208 | '''Parâmetros:''' |
| 209 | |
| 210 | $message: Mensagem a ser lançada |
| 211 | |
| 212 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 213 | |
| 214 | '''Exemplo de Uso:''' |
| 215 | |
| 216 | {{{ |
| 217 | $log = $this->factory->getInstance('wf_log'); |
| 218 | |
| 219 | $log->notice('notificação...'); |
| 220 | }}} |
| 221 | |
| 222 | ---- |
| 223 | |
| 224 | === lnfo === |
| 225 | |
| 226 | '''Descrição:''' Lança um log de nível informação |
| 227 | |
| 228 | '''Parâmetros:''' |
| 229 | |
| 230 | $message: Mensagem a ser lançada |
| 231 | |
| 232 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 233 | |
| 234 | '''Exemplo de Uso:''' |
| 235 | |
| 236 | {{{ |
| 237 | $log = $this->factory->getInstance('wf_log'); |
| 238 | |
| 239 | $log->info('informação...'); |
| 240 | }}} |
| 241 | |
| 242 | ---- |
| 243 | |
| 244 | === debug === |
| 245 | |
| 246 | '''Descrição:''' Lança um log de nível debug |
| 247 | |
| 248 | '''Parâmetros:''' |
| 249 | |
| 250 | $message: Mensagem a ser lançada |
| 251 | |
| 252 | '''Retorno:''' true caso a mensagem tenha sido lançada com sucesso, false caso contrário. |
| 253 | |
| 254 | '''Exemplo de Uso:''' |
| 255 | |
| 256 | {{{ |
| 257 | $log = $this->factory->getInstance('wf_log'); |
| 258 | |
| 259 | $log->debug('debug...'); |
| 260 | }}} |
| 261 | |
| 262 | ---- |