document entities

src/Entity/Access/AccessCommunication.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Paramètres d'abonnement à la com pour un Access
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Access/AccessFamily.php

@@ -7,13 +7,13 @@ namespace App\Entity\Access;
 use ApiPlatform\Metadata\ApiResource;
 // use DH\Auditor\Provider\Doctrine\Auditing\Annotation\Auditable;
 use App\Entity\Billing\AccessFictionalIntangible;
-use App\Entity\Person\PersonActivity;
 use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Fais le lien entre les Access dont les titulaires sont membres d'une même famille
+ * (cf. table 'children_guardians' pour les responsables légaux)
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Access/AccessNetworkSetting.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Access/AccessSocial.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Caractéristiques socio-professionnelles pour un Access
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Access/OrganizationResponsability.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Responsibilité d'un Access au sein d'une Organization
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Access/PersonalizedList.php

@@ -13,7 +13,7 @@ use JetBrains\PhpStorm\Pure;
 use Symfony\Component\Serializer\Annotation\Groups;
 
 /**
- * Liste personnalisées.
+ * Listes personnalisées.
  *
  * Security :
  *

src/Entity/AccessWish/AccessTmp.php

@@ -10,7 +10,7 @@ use App\Entity\Organization\Organization;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/AccessWish/DocumentWish.php

@@ -14,7 +14,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/AccessWish/EducationStudentWish.php

@@ -20,7 +20,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Awin/Product.php

@@ -7,6 +7,9 @@ namespace App\Entity\Awin;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Produit / Évènement pour le portail fourni par le partenaire Awin
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 #[ORM\Table(name: 'AwinProduct')]

src/Entity/Billing/AccessBilling.php

@@ -13,7 +13,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Paramètres de facturation pour un Access
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Billing/AccessFictionalIntangible.php

@@ -15,7 +15,8 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Correspond à une ligne de facturation pour un Access
+ * (@see FictionalIntangible)
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Billing/AdvancePayment.php

@@ -7,6 +7,9 @@ namespace App\Entity\Billing;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 // #[Auditable]
 #[ORM\Entity]

src/Entity/Billing/Afi.php

@@ -9,6 +9,9 @@ use App\Entity\Core\File;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class Afi

src/Entity/Billing/BergerLevrault.php

@@ -13,7 +13,8 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Fais le lien entre les factures (Bill) concernées par l'export et l'objet File généré
+ * NB: BergerLevrault est un format de données demandé par le Trésor Public pour l'export des données comptables
  */
 // #[Auditable]
 #[ORM\Entity]

src/Entity/Billing/Bill.php

@@ -8,6 +8,9 @@ use ApiPlatform\Metadata\ApiResource;
 use App\Entity\Access\Access;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Facture
+ */
 #[ApiResource(operations: [])]
 // #[Auditable]
 #[ORM\Entity]

src/Entity/Billing/BillAccessDetail.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Paramètres d'un Access pour une facture (Bill)
  */
 // #[Auditable]
 #[ORM\Entity]

src/Entity/Billing/BillAccounting.php

@@ -7,6 +7,9 @@ namespace App\Entity\Billing;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Facture ou avoir (@see Bill, BillCredit)
+ */
 #[ApiResource(operations: [])]
 // #[Auditable]
 #[ORM\Entity]

src/Entity/Billing/BillCredit.php

@@ -7,6 +7,9 @@ namespace App\Entity\Billing;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Avoir
+ */
 #[ApiResource(operations: [])]
 // #[Auditable]
 #[ORM\Entity]

src/Entity/Billing/BillDebitBalance.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Trop-perçu conservé pour être reversé à la Bill suivante
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/BillLine.php

@@ -12,7 +12,8 @@ use App\Entity\Product\EquipmentLoan;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Une ligne de facturation
+ * @see BillAccounting
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Billing/BillPayment.php

@@ -13,7 +13,8 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Données de paiement d'une facture BillAccounting
+ * NB: il peut y avoir plusieurs lignes pour une facture en cas de paiement en plusieurs fois
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/BillPeriod.php

@@ -9,7 +9,8 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Période associée à une facture
+ * (Ex: Deuxième trimestre 2020)
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/BillSchedule.php

@@ -10,6 +10,9 @@ use App\Entity\Organization\Organization;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class BillSchedule

src/Entity/Billing/BillScheduleDate.php

@@ -7,6 +7,9 @@ namespace App\Entity\Billing;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class BillScheduleDate

src/Entity/Billing/BillTotalDetail.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Totaux des lignes BillLine d'une facture BillAccounting, avec calcul de TVA
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/BillingExportSetting.php

@@ -13,7 +13,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Paramètres généraux des exports de factures (Bill)
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/BillingIntangibleExcludeDate.php

@@ -10,7 +10,8 @@ use App\Entity\Product\EquipmentLoan;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Indique les produits (BillingIntangible) déjà facturés
+ * TODO: confirmer la doc?
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Billing/BillingSetting.php

@@ -13,6 +13,9 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 use JetBrains\PhpStorm\Pure;
 
+/**
+ * Paramètres globaux d'une Organization concernant la facturation
+ */
 #[ApiResource(operations: [])]
 // #[Auditable]
 #[ORM\Entity(repositoryClass: BillingSettingRepository::class)]

src/Entity/Billing/BillingSettingRent.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Paramètres globaux d'une Organization concernant la facturation liée à la location
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/Ciril.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/CirilCivil.php

@@ -9,6 +9,9 @@ use App\Entity\Core\File;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class CirilCivil

src/Entity/Billing/EducationalProjectIntangible.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Fais le lien entre l'Access qui règle la facture et l'EducationalProject concerné
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/EducationalProjectPayer.php

@@ -13,7 +13,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table EducationalProjectPayer, et supprimer l'attribut discr.
  *
- * Classe ... qui ...
+ * Fais le lien entre l'Access qui règle la facture et l'EducationalProject concerné
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Billing/FamilyQuotient.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Définition d'une tranche de quotient familial
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Billing/FamilyQuotientBand.php

@@ -9,6 +9,9 @@ use App\Entity\Product\IntangibleDiscountDetail;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class FamilyQuotientBand

src/Entity/Billing/FamilyQuotientBandDetail.php

@@ -9,6 +9,9 @@ use App\Entity\Product\IntangibleDiscountDetail;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class FamilyQuotientBandDetail

src/Entity/Billing/FamilyQuotientModel.php

@@ -10,6 +10,9 @@ use App\Entity\Product\IntangiblePriceAndDiscount;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class FamilyQuotientModel

src/Entity/Billing/Jvs.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/Odyssee.php

@@ -9,6 +9,9 @@ use App\Entity\Core\File;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class Odyssee

src/Entity/Billing/PayboxPaymentReturn.php

@@ -7,6 +7,9 @@ namespace App\Entity\Billing;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class PayboxPaymentReturn

src/Entity/Billing/PayfipPaymentReturn.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/Pes.php

@@ -12,7 +12,8 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Paramètres généraux d'un export PES
+ * NB: PES est un format de données demandé par le Trésor Public pour l'export des données comptables
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/PesSetting.php

@@ -10,7 +10,7 @@ use App\Entity\Organization\Organization;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: (Plus utilisée, à confirmer)
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/SddBank.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Billing/SddRegie.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  * // TODO: possible factoriser avec SddBank?
  */
 // #[Auditable]

src/Entity/Billing/SddTeneur.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/AbstractBooking.php

@@ -17,7 +17,6 @@ use Doctrine\ORM\Mapping as ORM;
 
 /**
  * Données d'un évènement générique, classe de base des évènements.
- *
  * @see Event, Course, EducationalProject, Examen, OrganizationHoliday, PersonHoliday
  */
 #[ActivityYearConstraintAware(startYearFieldName: 'startYear', endYearFieldName: 'endYear')]

src/Entity/Booking/AbstractBookingRecur.php

@@ -7,7 +7,8 @@ namespace App\Entity\Booking;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Données de récurrence d'un évènement, classe de base des récurrences d'évènements
+ * @see EventRecur, CourseRecur, EducationalProjectRecur, ExamenRecur, OrganizationHolidayRecur, PersonHolidayRecur
  */
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'BookingRecur')]

src/Entity/Booking/Attendance.php

@@ -14,7 +14,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Représente une période d'absence pour un Access dans une Organization
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/AttendanceBooking.php

@@ -10,7 +10,7 @@ use App\Entity\Access\Access;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Représente l'absence d'un Access à un type de Booking et à une date précise
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/CalendarSynchro.php

@@ -11,7 +11,7 @@ use App\Entity\Core\File;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/CourseRecur.php

@@ -11,7 +11,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table CourseRecur, et supprimer l'attribut discr.
  *
- * Classe ... qui ...
+ * Cours récurrent
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/EducationalProject.php

@@ -25,7 +25,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table EducationalProject, et supprimer l'attribut discr.
  * @todo : migration table tag_booking
- * Classe ... qui ...
+ * Prestation pédagogique
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/EducationalProjectAge.php

@@ -9,6 +9,9 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Serializer\Annotation\Groups;
 
+/**
+ * Répartition des âges dans une prestation pédagogique EducationnalProject
+ */
 // #[Auditable]
 #[ApiResource(operations: [])]
 #[ORM\Entity]

src/Entity/Booking/EducationalProjectPublic.php

@@ -11,6 +11,9 @@ use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Type de public d'une prestation pédagogique EducationnalProject
+ */
 // #[Auditable]
 #[ApiResource(operations: [])]
 #[ORM\Entity]

src/Entity/Booking/EducationalProjectRecur.php

@@ -9,6 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
+ * TODO: documenter
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table EducationalProjectRecur, et supprimer l'attribut discr.
  */
 // #[Auditable]

src/Entity/Booking/Event.php

@@ -25,6 +25,8 @@ use Symfony\Component\Validator\Constraints as Assert;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table Event, et supprimer l'attribut discr.
  * @todo : migration table tag_booking
+ *
+ * Évènement, rencontre
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/EventGender.php

@@ -8,6 +8,9 @@ namespace App\Entity\Booking;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Enum des genres d'évènements
+ */
 // #[Auditable]
 #[ApiResource(operations: [])]
 #[ORM\Entity]

src/Entity/Booking/EventRecur.php

@@ -10,6 +10,8 @@ use Doctrine\ORM\Mapping as ORM;
 
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table EventRecur, et supprimer l'attribut discr.
+ *
+ * Évènement récurrent
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/EventReport.php

@@ -12,6 +12,9 @@ use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Compte-rendu d'un évènement Event
+ */
 // #[Auditable]
 #[ApiResource(operations: [])]
 #[ORM\Entity]

src/Entity/Booking/EventUser.php

@@ -10,7 +10,7 @@ use App\Entity\Access\Access;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Participation d'un Access à un Event
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/Examen.php

@@ -24,7 +24,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table Examen, et supprimer l'attribut discr.
  * @todo : migration table tag_booking
- * Classe ... qui ...
+ * Examen
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/ExamenConvocation.php

@@ -14,7 +14,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Convocation d'un Access (élève) à un Examen
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/ExamenRecur.php

@@ -11,7 +11,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table ExamenRecur, et supprimer l'attribut discr.
  *
- * Classe ... qui ...
+ * Examen récurrent
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/OrganizationHoliday.php

@@ -18,7 +18,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table OrganizationHoliday, et supprimer l'attribut discr.
  *
- * Classe ... qui ...
+ * Périodes de vacances d'une Organization
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/OrganizationHolidayRecur.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Périodes de vacances récurrentes d'une Organization
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/PersonHoliday.php

@@ -18,7 +18,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table PersonHoliday, et supprimer l'attribut discr.
  *
- * Classe ... qui ...
+ * Périodes de vacances d'un Access
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Booking/PersonHolidayRecur.php

@@ -11,7 +11,7 @@ use Doctrine\ORM\Mapping as ORM;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table PersonHolidayRecur, et supprimer l'attribut discr.
  *
- * Classe ... qui ...
+ * Périodes de vacances récurrentes d'un Access
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/Work.php

@@ -13,7 +13,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Booking/WorkByUser.php

@@ -10,7 +10,7 @@ use App\Entity\Access\Access;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/AbstractControl.php

@@ -12,6 +12,10 @@ use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Contrôle du bon état des Place, Room et Equipment, effectué ou planifié
+ * Classe de base de @see PlaceControl, RoomControl, EquipmentControl
+ */
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'Control')]
 #[ORM\DiscriminatorColumn(name: 'discr', type: 'string')]

src/Entity/Core/AbstractInformation.php

@@ -20,7 +20,7 @@ use Symfony\Component\Serializer\Normalizer\DateTimeNormalizer;
 /**
  * @todo : A la suite de la migration, il faut supprimer le nom de la table pour avoir une table Notification, et supprimer l'attribut discr.
  *
- * Classe Notification. qui permet de gérer les notifications aux utilisateurs.
+ * Classe Notification qui permet de gérer les notifications aux utilisateurs.
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Core/AbstractRepair.php

@@ -11,6 +11,9 @@ use Doctrine\Common\Collections\ArrayCollection;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Classe de base de @see PlaceRepair, RoomRepair, EquipmentRepair
+ */
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'Repair')]
 #[ORM\DiscriminatorColumn(name: 'discr', type: 'string')]

src/Entity/Core/Categories.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/City.php

@@ -9,7 +9,8 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Ville.
+ * Enum des villes existantes (en France, Suisse, Luxembourg, Belgique)
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/Country.php

@@ -11,6 +11,9 @@ use App\Repository\Core\CountryRepository;
 // use DH\Auditor\Provider\Doctrine\Auditing\Annotation\Auditable;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * Pays
+ */
 #[ApiResource(
     operations: [
         new Get(),

src/Entity/Core/Department.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Département
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/Familly.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Enum des types d'art
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/Gender.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Enum des genres d'art, sous-type de Subfamilly
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/LoginLog.php

@@ -7,6 +7,9 @@ namespace App\Entity\Core;
 use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class LoginLog

src/Entity/Core/Region.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Région géographique
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/Subfamilly.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Enum des sous-familles d'art, sous-type de Familly
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Core/Tagg.php

@@ -45,7 +45,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Tag, étiquette
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Core/Tips.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Affiche une modale d'information à la connexion de l'utilisateur
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Education/CriteriaNotation.php

@@ -15,7 +15,7 @@ use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
- * Classe ... qui ...
+ * Critère d'évaluation permettant de définir un suivi pédagogique EducationNotation
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Education/CustomNotation.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Education/CycleByEducation.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: (Non utilisé, à confirmer)
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Education/Education.php

@@ -16,7 +16,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Enseignement proposé par une Organization
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Education/EducationCategory.php

@@ -13,7 +13,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Catégorie de l'enseignement Education
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Education/EducationComplement.php

@@ -11,7 +11,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Complément d'information lié à la catégorie EducationCategory d'un enseignement Education
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Education/EducationCurriculumPack.php

@@ -11,6 +11,9 @@ use App\Entity\Product\Intangible;
 use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
+/**
+ * TODO: documenter
+ */
 #[ApiResource(operations: [])]
 #[ORM\Entity]
 class EducationCurriculumPack

src/Entity/Education/EducationNotation.php

@@ -15,7 +15,7 @@ use Doctrine\ORM\Mapping as ORM;
 use Symfony\Component\Validator\Constraints as Assert;
 
 /**
- * Classe ... qui ...
+ * Notes d'un élève pour un enseignement suivi EducationStudent
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Education/EducationNotationCriteriaConfig.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Education/EducationStudent.php

@@ -15,7 +15,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * EducationCurriculum suivi par un Access pendant une année scolaire
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Education/EducationTeacher.php

@@ -12,7 +12,7 @@ use Doctrine\Common\Collections\Collection;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Fait le lien entre un Access (professeur) et un Education (enseignement)
  */
 #[ApiResource(operations: [])]
 // #[Auditable]

src/Entity/Education/PeriodNotation.php

@@ -10,7 +10,9 @@ use App\Entity\Organization\Organization;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Période de notation
+ *
+ * TODO: (Non utilisée, à confirmer)
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Education/SeizurePeriodNotation.php

@@ -9,7 +9,7 @@ use ApiPlatform\Metadata\ApiResource;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * Période de droit de saisir des notes pour un Access et une Education
  */
 // #[Auditable]
 #[ApiResource(operations: [])]

src/Entity/Message/AbstractMessage.php

@@ -15,7 +15,7 @@ use Ramsey\Uuid\Doctrine\UuidGenerator;
 use Ramsey\Uuid\UuidInterface;
 
 /**
- * Classe ... qui ...
+ * Classe de base de @see Message, Mail, Sms, Email
  */
 #[ORM\MappedSuperclass]
 #[OrganizationDefaultValue(fieldName: 'organization')]

src/Entity/Message/AbstractReport.php

@@ -11,7 +11,7 @@ use Doctrine\DBAL\Types\Types;
 use Doctrine\ORM\Mapping as ORM;
 
 /**
- * Classe ... qui ...
+ * TODO: documenter
  */
 #[ORM\MappedSuperclass]
 #[ORM\Table(name: 'ReportMessage')]