Documentation

Utiliser la fabrique pour créer des logs - Zend_Log

Utiliser la fabrique pour créer des logs

En plus de pouvoir instancier les objets directement, il est possible d'utiliser une fabrique, la méthode factory() d'une instance Log, et il est possible de configurer les objets d'écriture (writers) et leurs filtres. En utilisant la fabrique, vous pouvez attacher plusieurs objets d'écriture dont la configuration peut être passée sous forme de tableau ou d'objet Zend_Config.

Un exemple:

  1. $logger = Zend_Log::factory(array(
  2.     'timestampFormat' => 'Y-m-d',
  3.     array(
  4.         'writerName'   => 'Stream',
  5.         'writerParams' => array(
  6.             'stream'   => '/tmp/zend.log',
  7.         ),
  8.         'formatterName' => 'Simple',
  9.         'formatterParams' => array(
  10.             'format'   => '%timestamp%: %message% -- %info%',
  11.         ),
  12.         'filterName'   => 'Priority',
  13.         'filterParams' => array(
  14.             'priority' => Zend_Log::WARN,
  15.         ),
  16.     ),
  17.     array(
  18.         'writerName'   => 'Firebug',
  19.         'filterName'   => 'Priority',
  20.         'filterParams' => array(
  21.             'priority' => Zend_Log::INFO,
  22.         ),
  23.     ),
  24. ));

Le code ci-dessus instancie un objet journal et 2 objets d'écriture dont un vers un fichier local, puis un vers Firebug. Chacun possède un filtre sur la priorité avec un niveau maximum différent.

Les évènements sont journalisés avec le format de date ISO 8601 par défaut. Vous pouvez choisir votre propre format avec l'option timestampFormat.

Chaque objet d'écriture support les options suivantes:

writerName (requis)

Le nom "court" de l'objet d'écriture; le nom sans le préfixe. Voyez "writerNamespace" pour plus de détails, des exemples sont : "Mock", "Stream", "Firebug".

writerParams (optionnel)

Tableau associatif de paramètre à utiliser à l'instanciation de l'objet d'écriture. Chaque méthode factory() fera suivre ces paramètres.

writerNamespace (optionnel)

Le préfixe de classe ou espace de nom(namespace) à utiliser pour créer le nom de classe complet de l'objet d'écriture. Par défault : "Zend_Log_Writer".

formatterName (optionnel)

Le nom "court" d'un formateur à utiliser sur l'objet d'écriture. Voyez "formatterNamespace" pour plus de détails. Exemples: "Simple", "Xml".

formatterParams (optionnel)

Tableau associatif de paramètre à utiliser à l'instanciation de l'objet formateur. Chaque méthode factory() fera suivre ces paramètres.

formatterNamespace (optionnel)

Le préfixe de classe ou espace de nom(namespace) à utiliser pour créer le nom de classe complet de l'objet formateur. Par défault : "Zend_Log_Formatter".

filterName (optionnel)

Le nom "court" d'un filtre à utiliser sur l'objet d'écriture. Voyez "filterNamespace" pour plus de détails. Exemples: "Message", "Priority".

filterParams (optionnel)

Tableau associatif de paramètre à utiliser à l'instanciation de l'objet filtre. Chaque méthode factory() fera suivre ces paramètres.

filterNamespace (optionnel)

Le préfixe de classe ou espace de nom(namespace) à utiliser pour créer le nom de classe complet de l'objet filtre. Par défault : "Zend_Log_Filter".

Chaque objet d'écriture et chaque filtre possède des options.

Options pour les objets d'écriture

Zend_Log_Writer_Db Options

db

Une instance de Zend_Db_Adapter

table

Nom de la table à utiliser.

columnMap

Tableau associatif de correspondance entre les noms des colonnes de la table et les champs des évènements du journal.

Zend_Log_Writer_Firebug Options

Aucune option n'est acceptée par cet objet d'écriture.

Zend_Log_Writer_Mail Options

Zend_Log_Writer_Mail Options
Option Type de données Valeur par défaut Description
mail String Zend_Mail Une instance de Zend_Mail
charset String iso-8859-1 L'encodage pour le courriel
from String or Array NULL Expéditeur du courriel. Les paramètres pour un type Array sont :
  • email : adresse de l'expéditeur

  • name : nom de l'expéditeur

to String or Array NULL Destinataire(s) du courriel
cc String or Array NULL Destinataire(s) en copie(s) du courriel
bcc String or Array NULL Destinataire(s) en copie(s) cachée(s) du courriel
subject String NULL Sujet du courriel
subjectPrependText String NULL Un résumé du nombre de chaque niveau d'erreurs sera ajouté à la suite du sujet du courriel
layout String NULL Une instance de Zend_Layout
layoutOptions Array NULL Voir la section Zend_Layout options de configuration
layoutFormatter String NULL Une instance de Zend_Log_Formatter_Interface

Zend_Log_Writer_Mock Options

Aucune option n'est acceptée par cet objet d'écriture.

Zend_Log_Writer_Null Options

Aucune option n'est acceptée par cet objet d'écriture.

Zend_Log_Writer_Stream Options

stream|url

Un identifiant de flux PHP valide vers lequel journaliser.

mode

Le mode I/O (Lecture/Ecriture) à utiliser; défaut : "a" pour "append".

Zend_Log_Writer_Syslog Options

application

Nom de l'application utilisé par le journaliseur syslog.

facility

Facility utilisée par le journal syslog.

Zend_Log_Writer_ZendMonitor Options

Aucune option n'est acceptée par cet objet d'écriture.

Options des filtres

Zend_Log_Filter_Message Options

regexp

Expression régulière à faire correspondre par rapport au message du journal.

Zend_Log_Filter_Priority Options

priority

La priorité maximale à journaliser.

operator

L'opérateur de comparaison (supérieur ou inférieur) à utiliser pour la comparaison, "<=" est utilisé par défaut.

Zend_Log_Filter_Suppress Options

Aucune option n'est acceptée par cet objet d'écriture.

Créer des objets d'écriture et des filtres configurés

SI vous souhaitez créer vos propres objets d'écriture du journal, ou vos propres filtres, il est possible de les rendre compatibles avec Zend_Log::factory() facilement.

Vous devez au minimum implémenter Zend_Log_FactoryInterface, qui attend une méthode statique factory() accéptant un seul argument, $config, de types tableau ou instance de Zend_Config. Si vos objets étendent Zend_Log_Writer_Abstract, ou vos filtres étendent Zend_Log_Filter_Abstract, alors ce sera tout.

Après, définissez la correspondance entre les options de configuration et les arguments du constructeur. Par exemple :

  1. class My_Log_Writer_Foo extends Zend_Log_Writer_Abstract
  2. {
  3.     public function __construct($bar, $baz)
  4.     {
  5.         // ...
  6.     }
  7.  
  8.     public static function factory($config)
  9.     {
  10.         if ($config instanceof Zend_Config) {
  11.             $config = $config->toArray();
  12.         }
  13.         if (!is_array($config)) {
  14.             throw new Exception(
  15.                 'factory attend un tableau ou un Zend_Config'
  16.             );
  17.         }
  18.  
  19.         $default = array(
  20.             'bar' => null,
  21.             'baz' => null,
  22.         );
  23.         $config = array_merge($default, $config);
  24.  
  25.         return new self(
  26.             $config['bar'],
  27.             $config['baz']
  28.         );
  29.     }
  30. }

Aussi, il est possible d'appeler les setters après l'instanciation, mais avant de retourner l'instance:

  1. class My_Log_Writer_Foo extends Zend_Log_Writer_Abstract
  2. {
  3.     public function __construct($bar = null, $baz = null)
  4.     {
  5.         // ...
  6.     }
  7.  
  8.     public function setBar($value)
  9.     {
  10.         // ...
  11.     }
  12.  
  13.     public function setBaz($value)
  14.     {
  15.         // ...
  16.     }
  17.  
  18.     public static function factory($config)
  19.     {
  20.         if ($config instanceof Zend_Config) {
  21.             $config = $config->toArray();
  22.         }
  23.         if (!is_array($config)) {
  24.             throw new Exception(
  25.                 'factory attend un tableau ou un Zend_Config'
  26.             );
  27.         }
  28.  
  29.         $writer = new self();
  30.         if (isset($config['bar'])) {
  31.             $writer->setBar($config['bar']);
  32.         }
  33.         if (isset($config['baz'])) {
  34.             $writer->setBaz($config['baz']);
  35.         }
  36.         return $writer;
  37.     }
  38. }

Copyright

© 2006-2022 by Zend by Perforce. Made with by awesome contributors.

This website is built using zend-expressive and it runs on PHP 7.

Contacts