3.8 KiB
3.8 KiB
Backend — Regles PHP / Symfony / API Platform
Structure de fichier
- Toujours
declare(strict_types=1);en tete de tout fichier PHP - PHP CS Fixer : regles Symfony + PSR-12 + strict types (commande :
make php-cs-fixer-allow-risky) - Commentaires (docblock, inline, bloc) en francais ; code (classes, methodes, variables) en anglais
API Platform (pas de controllers)
- Toujours utiliser
#[ApiResource]+ Providers + Processors — pas de controllers Symfony classiques - Routes prefixees
/api(viaconfig/routes/api_platform.yaml) - Le login
/login_checkest hors prefix/api(nginx reecritREQUEST_URIvers/login_check) - Exception : si tu dois creer un controller custom sous
/api/, mettrepriority: 1sur#[Route]pour eviter le conflit avec API Platform{id}
Repositories
- Interface :
*RepositoryInterfacedansDomain/Repository/ - Implementation Doctrine :
Doctrine*RepositorydansInfrastructure/Doctrine/ - Le domaine garde les attributs ORM (approche pragmatique)
RBAC (permissions)
Format obligatoire : module.resource[.subresource].action en snake_case.
- Exemples :
core.users.view,commercial.clients.contacts.edit,core.audit_log.view - Declarees via la methode statique
permissions()des*Module.php - Synchronisation :
app:sync-permissions - Verification API Platform :
is_granted('module.resource.action') - Verification front :
usePermissions()
Roles
- Hierarchie dans
config/packages/security.yaml:ROLE_ADMIN,ROLE_USER - Le role ne remplace pas la permission RBAC — deux niveaux complementaires
Audit (obligatoire)
- Toute entite metier (nouvelle ou existante) :
#[Auditable](deShared/Domain/Attribute/) - Champs sensibles (password, token, secret) :
#[AuditIgnore] - Audit ManyToMany : trace automatiquement
{fieldName: {added: [ids], removed: [ids]}}— aucune action supplementaire - Spec complete : @doc/audit-log.md
Timestampable + Blamable (obligatoire pour entites metier)
Toute nouvelle entite metier sous src/Module/*/Domain/Entity/ doit porter les 4 colonnes created_at / updated_at / created_by / updated_by, remplies automatiquement. Trois lignes a ajouter a l'entite :
use App\Shared\Domain\Contract\BlamableInterface;
use App\Shared\Domain\Contract\TimestampableInterface;
use App\Shared\Domain\Trait\TimestampableBlamableTrait;
class MyEntity implements TimestampableInterface, BlamableInterface
{
use TimestampableBlamableTrait; // porte les 4 props + getters/setters
// ... reste metier
}
- Le
TimestampableBlamableSubscriber(Shared/Infrastructure/Doctrine/) remplit les colonnes auprePersist/preUpdate. Hors contexte HTTP (CLI, cron, migration), le blame restenull(libelle « Systeme » cote front). - La migration de l'entite doit creer les 4 colonnes (
created_at/updated_atNOT NULL,created_by/updated_bynullableON DELETE SET NULL). - Garde-fou CI :
tests/Architecture/EntitiesAreTimestampableBlamableTestechoue si une entite oublie le pattern. Un referentiel statique justifie (ex:CategoryType) doit etre explicitement whiteliste dans la constanteEXCLUDEDavec un commentaire. - Spec complete : @docs/specs/M0-categories/spec-back.md § 2.8 + § 2.8.bis
Serialization
Pour embarquer une relation dans le JSON (au lieu d'un IRI Hydra), ajouter le groupe du parent sur les proprietes de l'entite cible.
Exemple : pour qu'User.profile soit embarque au lieu d'un lien IRI sous le groupe user:read, annoter Profile.$firstName avec #[Groups(['user:read'])].
Upload de fichiers
- Valider cote serveur avec
$file->getMimeType()— jamaisgetClientMimeType()(spoofable par le client)
PostgreSQL
- Noms de colonnes toujours en minuscules dans le SQL brut (commun a tous les projets MALIO)