MAJ de la documentation

doc/001_table.sql → doc/001_table_oracle.sql

--- Table version PGSQL
-create table public.unicaen_instadia
-(
-    id            serial
-        constraint unicaen_instadia_pk primary key,
-    user_id       integer                 not null
-        constraint unicaen_instadia_redacteur_fk references public.unicaen_utilisateur_user,
-    rubrique      varchar(80)             not null,
-    sous_rubrique varchar(80),
-    horodatage    timestamp default now() not null,
-    contenu       text                    not null
-);
 
--- oracle
 CREATE
     TABLE INSTADIA
 (

doc/001_table_pgsql.sql

+create table public.unicaen_instadia
+(
+    id            serial
+        constraint unicaen_instadia_pk primary key,
+    user_id       integer                 not null
+        constraint unicaen_instadia_redacteur_fk references public.unicaen_utilisateur_user,
+    rubrique      varchar(80)             not null,
+    sous_rubrique varchar(80),
+    horodatage    timestamp default now() not null,
+    contenu       text                    not null
+);
\ No newline at end of file

readme.md

@@ -20,5 +20,34 @@ Les messages sont ensuite enregistrés dans la table unicaen_instadia
 Base de données
 ---------------
 
-Le script de création de la table unicaen_instadia est disponible dans le fichier
+Le script de création de la table unicaen_instadia est disponible dans le fichier doc/001_table_SGBD.sql
+
+
+| Champs        | Type      | Info                                | Commantaire                                      |
+|---------------|-----------|-------------------------------------|--------------------------------------------------|
+| id            | serial    | primary key                         |                                                  |
+| user_id       | int       | foreign key vers ```AbstractUser``` | reférence l'utilisateur ayant rédiger le message |
+| rubrique      | string    |                                     | référence le chat                                |
+| sous_rubrique | string    | nullable                            | référence le chat                                |
+| horodatage    | timestamp | default ```now()```                 | date d'émission du message                       |
+| contenu       | text      |                                     | message émis                                     |
 ---
+
+Javascript et CSS
+-----------------
+
+La bibliothèque repose sur un fichier js [public/instadia/js/instadia.js] et un css [public/instadia/css/instadia.css] qu'il faudra copie dans le public du projet.
+
+```bash
+cp -r vendor/unicaen/instadia/public public
+```
+
+Dépendance
+----------
+
+La seule dépendance interne aux bibliothèques unicaen est vers ```UnicaenUtilisateur``` pour la récupération de l'utilisateur mais qui peut être downgradée vers ```UnicaenAuth``` au besoin.
+- dans l'entité Instadia [src/UnicaenInstadia/Entity/Db/Instadia.php] et son mapping [src/UnicaenInstadia/Entity/Db/Mapping/UnicaenInstadia.Entity.Db.Instadia.dcm.xml]
+  - référence à ```AbstractUser``` : déclaration du lien vers l'utilisateur des messages
+- dans le service InstadiaService [src/UnicaenInstadia/Service/Instadia/InstadiaService.php] et sa factory [src/UnicaenInstadia/Service/Instadia/InstadiaServiceFactory.php]
+  - référence à ```AbstractUser``` : ajout de l'utilisateur ayant rédiger le message
+  - référence à ```UserService``` : récupération de l'utilisateur connecté
\ No newline at end of file