Commit e792e2d7 authored by Florentin L'Homme's avatar Florentin L'Homme
Browse files

Déplacement de HistoriqueListener dans unicaen/auth

parent 371b2b3c
Pipeline #4449 passed with stage
in 23 seconds
......@@ -289,7 +289,6 @@ return [
MailerService::class => MailerServiceFactory::class,
'UnicaenApp\HistoriqueListener' => HistoriqueListenerFactory::class,
'instadia' => InstadiaServiceFactory::class,
],
'shared' => [
......
......@@ -42,7 +42,7 @@ Pour que l'historique fonctionne, il faut :
==== Listener ====
Doctrine doit se charger, par l'entremise du Listener de peupler automatiquement les champs liés aux historiques lorsque l'entité est enregistrée en base.
Un Listener tout prêt est disponible : il s'agit de <php>UnicaenApp\ORM\Event\Listeners\HistoriqueListener</php>.
Un Listener tout prêt est disponible : il s'agit de <php>UnicaenAuth\ORM\Event\Listeners\HistoriqueListener</php>.
Il n'est cependant pas activé par défaut.
Pour l'activer, il suffit d'ajouter à la configuration du projet les données suivantes :
<code php>
......
......@@ -75,7 +75,7 @@ automatiquement les champs liés aux historiques lorsque l\'entité est
enregistrée en base.
Un Listener tout prêt est disponible : il s\'agit de
`UnicaenApp\ORM\Event\Listeners\HistoriqueListener`{.php}. Il n\'est
`UnicaenAuth\ORM\Event\Listeners\HistoriqueListener`{.php}. Il n\'est
cependant pas activé par défaut. Pour l\'activer, il suffit d\'ajouter à
la configuration du projet les données suivantes :
......
......@@ -4,7 +4,6 @@ namespace UnicaenApp\Entity;
use DateTime;
use UnicaenApp\Exception\RuntimeException;
use UnicaenApp\ORM\Event\Listeners\HistoriqueListener;
/**
* Code commun aux entités possédant une gestion d'historique.
......@@ -191,7 +190,6 @@ trait HistoriqueAwareTrait
* Marque cet enregistrement comme historisé.
*
* @see HistoriqueAwareInterface
* @see HistoriqueListener
*
* @param UserInterface|null $destructeur Auteur de la suppression ; si null, peut être renseigné
* automatiquement (cf. HistoriqueListener) si la classe implémente
......
<?php
namespace UnicaenApp\ORM\Event\Listeners;
use Doctrine\Common\EventSubscriber;
use Doctrine\ORM\Event\LifecycleEventArgs;
use Doctrine\ORM\Event\PreUpdateEventArgs;
use Doctrine\ORM\Events;
use RuntimeException;
use UnicaenApp\Entity\HistoriqueAwareInterface;
use UnicaenAuth\Entity\Db\AbstractUser;
use Zend\Authentication\AuthenticationService;
/**
* Listener Doctrine.
*
* Renseigne si besoin l'heure et l'auteur de la création/modification
* de toute entité dont la classe implémente HistoriqueAwareInterface.
*
* Déclenchement : avant que l'enregistrement ne soit persisté (création) ou mis à jour (update).
*
* @author Bertrand GAUTHIER <bertrand.gauthier at unicaen.fr>
* @see HistoriqueAwareInterface
*/
class HistoriqueListener implements EventSubscriber
{
/**
* @var AuthenticationService
*/
private $authenticationService;
/**
* @var mixed
*/
protected $identity;
/**
* @param AuthenticationService $authenticationService
*/
public function setAuthenticationService(AuthenticationService $authenticationService)
{
$this->authenticationService = $authenticationService;
}
/**
* @param LifecycleEventArgs $args
* @throws RuntimeException Aucun utilisateur disponible pour en faire l'auteur de la création/modification
*/
protected function updateHistorique(LifecycleEventArgs $args)
{
$entity = $args->getEntity();
// l'entité doit implémenter l'interface requise
if (! $entity instanceof HistoriqueAwareInterface) {
return;
}
$now = new \DateTime();
if (null === $entity->getHistoCreation()) {
$entity->setHistoCreation($now);
}
// on tente d'abord d'obtenir l'utilisateur connecté pour en faire l'auteur de la création/modification.
$user = $this->getAuthenticatedUser();
// si aucun utilisateur connecté n'est disponible, on utilise l'éventuel auteur existant
if (null === $user) {
$user = $entity->getHistoCreateur();
}
// si nous ne disposons d'aucun utilisateur, basta!
if (null === $user) {
throw new RuntimeException("Aucun utilisateur disponible pour en faire l'auteur de la création/modification.");
}
if (null === $entity->getHistoCreateur()) {
$entity->setHistoCreateur($user);
}
$entity->setHistoModificateur($user);
$entity->setHistoModification($now);
/* ce bloc a été mis en commentaire car il est inutile: cf. 2 lignes précédentes !
if (null === $entity->getHistoDestruction() && null === $entity->getHistoDestructeur()) {
$entity
->setHistoModification($now)
->setHistoModificateur($user);
}
*/
if (null !== $entity->getHistoDestruction() && null === $entity->getHistoDestructeur()) {
$entity->setHistoDestructeur($user);
}
}
/**
* Recherche l'utilisateur connecté pour l'utiliser comme auteur de la création/modification.
*
* @return AbstractUser
*/
private function getAuthenticatedUser()
{
$user = null;
if (($identity = $this->getIdentity())) {
if (isset($identity['db']) && $identity['db'] instanceof AbstractUser) {
/* @var $user AbstractUser */
$user = $identity['db'];
}
}
return $user;
}
/**
* @param LifecycleEventArgs $args
*/
public function prePersist(LifecycleEventArgs $args)
{
$this->updateHistorique($args);
}
/**
* @param PreUpdateEventArgs $args
*/
public function preUpdate(PreUpdateEventArgs $args)
{
$this->updateHistorique($args);
}
/**
* Injecte l'identité authentifiée courante.
*
* @param mixed $identity
* @return self
*/
public function setIdentity($identity)
{
$this->identity = $identity;
return $this;
}
/**
* Retourne l'identité authentifiée courante.
*
* @return mixed
*/
public function getIdentity()
{
if (null === $this->identity) {
$authenticationService = $this->authenticationService;
if ($authenticationService->hasIdentity()) {
$this->identity = $authenticationService->getIdentity();
}
}
return $this->identity;
}
/**
* {@inheritdoc}
*/
public function getSubscribedEvents()
{
return [Events::prePersist, Events::preUpdate];
}
}
\ No newline at end of file
<?php
namespace UnicaenApp\ORM\Event\Listeners;
use Interop\Container\ContainerInterface;
use Zend\Authentication\AuthenticationService;
use Zend\ServiceManager\FactoryInterface;
use Zend\ServiceManager\ServiceLocatorInterface;
/**
* Description of MouchardServiceFactory
*
* @author Laurent LÉCLUSE <laurent.lecluse at unicaen.fr>
*/
class HistoriqueListenerFactory implements FactoryInterface
{
public function createService(ServiceLocatorInterface $serviceLocator)
{
return $this->__invoke($serviceLocator, '?');
}
public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
{
/** @var AuthenticationService $authenticationService */
$authenticationService = $container->get('Zend\Authentication\AuthenticationService');
$listener = new HistoriqueListener();
$listener->setAuthenticationService($authenticationService);
return $listener;
}
}
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment