Le module **unicaen/renderer** est en charge du stockage des templates et des macros associées.
Ainsi que les rendus générés à partir des templates et macros.
Le module fournit un menu dans Administration > Contenus permettant d'accéder aux instances créées : Macros, Templates et Rendus.
Dans ces menus, il est possible de gérer ceux-ci.
Dépendances
-----------
Utilisation de tinyMCE (v4.+) pour la partie WYSIWYG (qualité de vie).
Description du fonctionnement
============================
Les macros
----------
Les macros reposent sur un code unique permettant au service **RenduService** de les substituer plus tard dans le texte.
Les macros font référence à :
- une **variable** qui doit être passé au préalable dans un tableau
- une **méthode** (retournant une chaine de caratères) que doit possèder cette variable.
Les templates
-------------
Les templates stockent les textes avec macros qui seront transformés en rendu.
On retrouve trois blocs de textes :
- la partie **sujet** pour le sujet du courrier ou le titre d'un document (et le nom du fichier)
- la partie **corps** pour le corps du rendu
- la partie **css** qui est fcaultive qui correpond à un morceau de css qui est apposé au rendu généré
La génération de rendus
-------------------------
La génération passe par l'utilisation de la méthode `generateRenduByTemplate(Template, array)` qui prend en argument :
1. un template
2. un tableau de variables utilisés par les macros
Alternativement, la fonction `generateRenduByTemplateCode(string, array)` permet la génération avec seulement le code du template et renvoi une exception si le code n'est associé à aucun template.
L'utilisation du rendu peut être fait directement via l'usage des accésseurs de `Rendu` que cela soit pour : un affichage directe, un export PDF ou la génération d'un courrier électronique.
```phtml
<dl>
<dt> Sujet </dt>
<dd> <?php echo $rendu->getSujet(); ?> </dd>
<dt> Sujet </dt>
<dd> <?php echo $rendu->getCorps(); ?> </dd>
</dl>
```
***Remarque 1 !!!*** Les rendus générés sont sauvegardés en base de données.
***Remarque 2 !!!*** La génération d'URLs, passant par l'appel d'helpers particuliers, la méthode la plus simple est de fournir un service générant celles-ci.
Aides de vue founies
--------------------
```phpregexp
'view_helpers' => [
'invokables' => [
'rendu' => RenduViewHelper::class,
],
],
```
`$this->rendu($monRendu)` : Affiche un rendu généré avec description à gauche et texte générée à droite.
Configuration
=============
Pas de configuration locale
Tables pour les données du modules
==================================
**N.B.** Le script permettant de créer les tables est fourni dans le fichier [renderer/SQL/001_tables.sql]
1.**unicaen_renderer_macro** : table stockant les macros
***Attention !!!*** Penser à donner les privilèges aux rôles adéquats.
Dépendances
===========
Dépendance à **UnicaenPrivilege**
----------------------------------
1. Dans **vendor/unicaen/renderer/config/merged/index.config.php**, **vendor/unicaen/renderer/config/merged/macro.config.php**, **vendor/unicaen/renderer/config/merged/rendu.config.php**, **vendor/unicaen/renderer/config/merged/template.config.php** : `UnicaenPrivilege\Guard\PrivilegeController` pour les gardes liées aux actions.
Peut être directement remplacer par l'equivalent fournit par `unicaen/auth`.
1. Dans **vendor/unicaen/renderer/src/UnicaenRenderer/Provider/Privilege/DocumentcontenuPrivileges.php**, **vendor/unicaen/renderer/src/UnicaenRenderer/Provider/Privilege/DocumentmacroPrivileges.php**, **vendor/unicaen/renderer/src/UnicaenRenderer/Provider/Privilege/DocumenttemplatePrivileges.php** : `UnicaenPrivilege\Provider\Privilege\Privileges` classe mère des privilèges du module.
Peut être directement remplacer par l'equivalent fournit par `unicaen/auth`.