HistoUser context normalization

CHANGELOG

=========

0.2.3 (28/11/2025)

------------------

- Config : nouveau Paramétre unicaen.user_class et unicaen.role_class

- Config : nouveau Paramétre histo.histo_default_username pour pouvoir définir l'utilisateur par défaut lors de l'historisation

- Mise en place du HistoContextBuilder

0.2.1 (17/10/2025)

------------------

- Ajout de RestaurerProcessor

parameters:

  unicaen.user_class: 'Unicaen\Utilisateur\Entity\User'

  unicaen.role_class: 'Unicaen\Utilisateur\Entity\Role'

  histo.histo_default_username:  '%env(trim:HISTO_DEFAULT_USERNAME)%'

services:

  _defaults:

    autowire: true

  Unicaen\Utilisateur\:

    resource: '../src/*'

  'Unicaen\Utilisateur\Serializer\HistoContextBuilder':

    decorates: 'api_platform.serializer.context_builder'

    arguments: [ '@Unicaen\Utilisateur\Serializer\HistoContextBuilder.inner' ]

    autoconfigure: false

    #[ORM\Column(length: 180, unique: true)]

    protected string $email;

    #[Groups(['user:read', 'user:create', 'user:update'])]

    #[Groups(['user:read', 'user:create', 'user:update', 'histoUser:read'])]

    #[ORM\Column(length: 180, nullable: true)]

    protected ?string $displayName = null;

<?php

namespace App\Serializer;

use ApiPlatform\State\SerializerContextBuilderInterface;

use Symfony\Component\HttpFoundation\Request;

use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;

use Unicaen\Utilisateur\Model\HistoriqueAwareInterface;

class HistoContextBuilder  implements SerializerContextBuilderInterface

{

    private $decorated;

    private $authorizationChecker;

    public function __construct(SerializerContextBuilderInterface $decorated, AuthorizationCheckerInterface $authorizationChecker)

    {

        $this->decorated = $decorated;

        $this->authorizationChecker = $authorizationChecker;

    }

    public function createFromRequest(Request $request, bool $normalization, ?array $extractedAttributes = null): array

    {

        $context = $this->decorated->createFromRequest($request, $normalization, $extractedAttributes);

        $resourceClass = $context['resource_class'] ?? null;

        //Vérification sur le fait que la class demandé existe

        if(!$resourceClass || ! class_exists($resourceClass)) { return $context;}

        //Vérification que la class est une HistoriqueAwareInterface

        if(!is_a(new $resourceClass(), HistoriqueAwareInterface::class)) {return $context;}

        $method = $request->getMethod();

        //  Ajout du groupe histoUser:read pour la méthode GET

        //  ce context de normalisation ne permet d'acceder qu'au displayName de l'utilisateur et pas aux autres informations tel que la liste de ces rôles

        switch ($method) {

            case 'GET':

                $context['groups'][] = 'histoUser:read';

            break;

        }

        return $context;

    }

}

 No newline at end of file

_Note : trouver comment mettre automatiquement les annotations sur les attributs d'historisation permettrait de ne pas avoir a le faire dans chaque entités historisable_

### HistoriqueContextBuilder

Afin de limiter les infos d'utilisateur accessible pour les entités historisé, un nouveau context de Normalisation a été défini : `histoUser:read`

Ce context permet de n'acceder qu'à l'attribut displayName de l'utilisateur dans le cadre de l'affichage des histoUser. Les autres attributs tel que les rôles des utilisateurs ne sont pas fournis dans se context.

Le contextBuilder `HistoriqueContextBuilder` permet de rajouter automatiquement aux entités implémentant l'interface `HistoriqueAwareInterface` le context de normalisation `histoUser:read`

Lorsque l'on est en GET. Il n'y a donc rien a faire pour récuperer le nom des HistoUser.

### HistoriqueStateProcessor

Les attributs d'histoCreation et histoModification sont automatiquement définie par le processor `HistoriqueStateProcessor` lors de la mise à jours des données via Doctrine.