Commit e58095d5 authored by Bertrand Gauthier's avatar Bertrand Gauthier
Browse files

Correction de la doc

parent 5933c32c

README.md

+6 −4
Original line number Diff line number Diff line
@@ -161,20 +161,22 @@ Logging 
À partir de la version 6.4, il est possible de spécifier un logger à injecter dans les lignes de commandes Symfony.



NB : le logger est injecté dans toutes les commandes, mais seule la commande `TraiterEvenementsCommand` l'exploite 

(en cas de déblocage du journal).

pour l'instant (en cas de déblocage du journal).



Exemple de config d'un logger capable d'envoyer un mail (grâce au writer fourni par unicaen/mail) :

Exemple de config d'un logger capable d'envoyer un mail (grâce au writer fourni par unicaen/mail ^7.5) :

```php

    // config globale

    'unicaen-evenement' => [

        'command_logger' => 'unicaen_evenement_command_logger', // cf. config à ajouter dans 'psr_log' ci-dessous

    ],

    // ...

    

    // config locale

    'psr_log' => [

        'unicaen_evenement_command_logger' => [

            'writers' => [

                'mail' => [

                    'name' => \UnicaenMail\Log\Writer\MailWriter::class,

                    'priority' => 1,

                    'priority' => 4, // i.e. WARN, cf. https://docs.laminas.dev/laminas-log/intro/#using-built-in-priorities

                    'options' => [

                        'to' => 'jean.pranbonenote@univ.fr',

                    ],

config/module.config.php

+6 −0
Original line number Diff line number Diff line
@@ -38,6 +38,12 @@ return array( 
        ],

    ],



    'service_manager' => [

        'abstract_factories' => [

            PsrLoggerAbstractAdapterFactory::class,

        ],

    ],



    'form_elements' => [

        'factories' => [

        ],

config/unicaen-evenement.global.php.dist

+2 −24
Original line number Diff line number Diff line
@@ -17,32 +17,10 @@ return [ 
        ],



        // Éventuel logger injecté dans les Commands Symfony

        //'command_logger' => 'unicaen_evenement_command_logger', // cf. config à ajouter dans 'psr_log' ci-dessous

        'command_logger' => null, // aucun logger

        //'command_logger' => 'unicaen_evenement_command_logger', // logger à configurer dans la config locale (clé 'psr_log')

    ],



    /*

    // Config du logger mentionné ci-dessus :

    'psr_log' => [

        'unicaen_evenement_command_logger' => [

            'writers' => [

                'mail' => [

                    'name' => \UnicaenMail\Log\Writer\MailWriter::class,

                    'priority' => 1,

                    'options' => [

                        'to' => 'jean.pranbonenote@univ.fr',

                    ],

                ],

            ],

        ],

    ],

    // À ajouter, si absent de la config de votre appli :

    //'service_manager' => [

    //    'abstract_factories' => [

    //        PsrLoggerAbstractAdapterFactory::class,

    //    ],

    //],

    */



    'navigation' => [

        'default' => [

            'home' => [

config/unicaen-evenement.local.php.dist

+15 −0
Original line number Diff line number Diff line
@@ -12,4 +12,19 @@ return [ 
        //Durée de conservations des logs

        //'conservation-time' => new DateInterval('P1Y'),

    ],



    // Config du logger éventuellement mentionné dans la config globale :

    'psr_log' => [

        'unicaen_evenement_command_logger' => [

            'writers' => [

                'mail' => [

                    'name' => \UnicaenMail\Log\Writer\MailWriter::class,

                    'priority' => 4, // WARN, cf. https://docs.laminas.dev/laminas-log/intro/#using-built-in-priorities

                    'options' => [

                        'to' => 'jean.pranbonenote@univ.fr',

                    ],

                ],

            ],

        ],

    ],

];
 
 No newline at end of file

doc/migration.md

+6 −4
Original line number Diff line number Diff line
@@ -16,11 +16,13 @@ La dépendance avec unicaen/mail a été supprimée dans le but de : 
Auparavant, la classe `TraiterEvenementsCommand` pouvait être amenée à envoyer un mail eb cas de "débocage du journal".

Désormais, ce n'est plus le cas : charge à l'application appelante de spécifier un "logger" équipé d'un "writer" 

sachant envoyer des mails. Ce logger sera automatiquement injecté dans chaque Command Symfony qui se contentera de

faire un simple `$this->logger->warning()` par exemple.

faire un simple `$this->logger->warning()` par exemple (priority 4).



Pour migrer, il vous faudra dans la config de votre application spécifier un logger via la nouvelle clé de config

`'command_logger'` puis configurer le logger en question via la clé de config Laminas `'psr_log'` :

reportez-vous à la config exemple [unicaen-evenement.global.php.dist](../config/unicaen-evenement.global.php.dist).

Pour migrer, il vous faudra dans la config de votre application :

- spécifier un logger via la nouvelle clé de config `'command_logger'`, cf. config globale exemple

  [unicaen-evenement.global.php.dist](../config/unicaen-evenement.global.php.dist) ;

- configurer le logger en question via la clé de config Laminas `'psr_log'`, cf. config locale exemple.

  [unicaen-evenement.local.php.dist](../config/unicaen-evenement.local.php.dist).





6.3.0