diff --git a/readme.md b/readme.md index 4dc56348fc3dd17eebdf6980a6b269efe4d6c2bc..268d589154a9b1d519b763ff3279191a7245a657 100755 --- a/readme.md +++ b/readme.md @@ -4,40 +4,97 @@ Module Unicaen Evenement Description ----------- -Dépendances +La bibliothèque `unicaen/renderer` est en charge de la génération de contenus "génériques" basés sur des `templates` et `macros`. + +Utilisation de la bibliothèque ----------- +Le service `RenduService` fournit une méthode `generateRenduByTemplateCode` en charge de générer un contenu avec le code d'un temmplate et un tableau de variables qui seront exploitées par les macros. +Le troisième paramètre permet de controller l'enregistrement du rendu en base de données. -Description du fonctionnement -============================ +```php +$vars = ['variable1' => $variable1, ...]; +$rendu = $this->getRenduService()->generateRenduByTemplateCode(Templates::MON_TEMPLATE, $vars, false); + +echo $rendu->getSujet(); +echo $rendu->getCorps(); +``` Aides de vue founies -------------------- -Configuration -============= +La biliothèque fournit un `ViewHelper` pour l'affichage d'un rendu -Tables pour les données du modules -================================== +```php +echo $this->rendu($rendu); +``` -Privilèges associés au module -============================= +Administration +-------------- -Dépendances -=========== +La biliothèque fournit des interfaces d'administration pour le paramètre des macros et templates et le listing des rendus. +Le fichier `config/unicae-renderer.global.dist.php` contient la déclaration des différents menus d'administration. -CHANGELOG ---------- +Tables et privilèges associés +============================ -**5.0.5** - Ajout de la notion de namespace au template pour facilitité l'exploitation +Les tables et les privilèges sont fournis dans les fichiers suivants : `SQL/001_tables.sql` et `SQL/002_privileges.sql`. + +Macro +----- + +| Colonne | Attribut | Type | Descriptions | +|---------------|--------------|--------------|------------------------------------------| +| id | $id | serial PK | | +| code | $code | varchar(256) | identifiant de la macro | +| description | $description | text | | +| variable_name | $variable | varchar(256) | nom de la variable utilisée par la macro | +| methode_name | $methode | varchar(256) | nom de la méthode utilisée par la macro | + +_Remarque :_ ++ `variable_name` est recherchée dans le tableau de variable (si non trouvée alors un warning est mis dans le rendu `variable non trouvée`). ++ `methode_name` est appelé sur la variable `variable_name` comme suit `$variable_name->methode_name()` (si non trouvée alors un warning est mis dans le rendu `méthode non trouvée`). + +Template +---- + +| Colonne | Attribut | Type | Descriptions | +|----------------|--------------|--------------|-------------------------------------| +| id | $id | serial PK | | +| code | $code | varchar(256) | identifiant de la macro | +| description | $description | text | | +| namespace | $namespace | varchar(256) | Espace de "nom" du template | +| document_type | $type | text | un type parmi 'text', 'mail', 'pdf' | +| document_sujet | $sujet | text | Le sujet ou le nom du fichier | +| document_corps | $corps | text | Le corps ou le contenu du fichier | +| document_css | $css | text | Un snipet CSS pour la mise en forme | + +Rendu +---- + +| Colonne | Attribut | Type | Descriptions | +|-----------------|-----------|------------|---------------------------------| +| id | $id | serial PK | | +| template_id | $template | integer FK | identifiant du template utilisé | +| date_generation | $date | timestamp | | +| sujet | $sujet | text | Sujet "généré" | +| corps | $corps | text | Corps "généré" | -Modification du schéma ----------------------- -**6.0.3** (version à venir) +CHANGELOG +========= + +**6.0.3** (19/09/2023) + Ajout du filtre des types de template sur l'index des template + Ajout du filtre sur l'index des rendus (date + template) ++ Amélioration de la documentation + +**5.0.5** ++ Ajout de la notion de namespace au template pour facilitité l'exploitation + +Modification du schéma +---------------------- -avec la 5.0.5 +**5.0.5** ```sql alter table unicaen_renderer_template add namespace varchar(1024); ```