$f
$f :null|\application
Instance de la classe 'application'.
Définition de la classe 'edition'.
Cette classe gère le module 'Édition' du framework openMairie. Ce module permet de gérer les différentes vues pour la génération des éditions PDF.
$f :null|\application
Instance de la classe 'application'.
pdf_om_etat_om_lettretype(string $edition_elem,string $collectivite): array
Génération de l'édition PDF pour une édition "etat" ou "lettretype".
| string | $edition_elem | Élement sur lequel porte l'édition. Les valeurs possibles sont "etat" ou "lettretype". |
| string | $collectivite | Identifiant de la collectivité spécifique (dans certains cas d'utilisation liés au multi-collectivité) sur laquelle porte l'édition. |
view_pdfetat(string $collectivite = null): array
VIEW - view_pdfetat.
Génération de l'édition PDF pour une édition "etat".
| string | $collectivite | Identifiant de la collectivité spécifique (dans certains cas d'utilisation liés au multi-collectivité) sur laquelle porte l'édition. |
view_pdflettretype(string $collectivite = null): array
VIEW - view_pdflettretype.
Génération de l'édition PDF pour une édition "lettretype".
| string | $collectivite | Identifiant de la collectivité spécifique (dans certains cas d'utilisation liés au multi-collectivité) sur laquelle porte l'édition. |
get_edition_from_collectivite(string $table,string $id_edition,string $id_collectivite,string $idx_edition_direct_preview = null): array
Gestion de la sélection des paramètres de l'édition à générer en fonction du paramètre actif et/ou du niveau de la collectivité.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE.
| string | $table | Table. |
| string | $id_edition | Identifiant de l'édition. |
| string | $id_collectivite | Identifiant de la colletcivité. |
| string | $idx_edition_direct_preview | Identifiant numérique de l'édition. |
get_logo_from_collectivite(string $id_logo,integer $id_collectivite): mixed
Récupère le chemin du logo en fonction de la collectivité : si un logo actif existe pour la collectivité passée en paramètre on le retourne sinon on retourne celui de la collectivité multi.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE.
| string | $id_logo | identifiant du logo |
| integer | $id_collectivite | identifiant de la collectivité |
null si aucun logo ou array contenant les informations du logo.
get_substitution_vars_values(null|mixed $om_collectivite_idx = null): array
Récupération des valeurs des VARIABLES DE REMPLACEMENT.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE.
Cette méthode permet de récupérer les valeurs pour les variables de remplacement globales à toute l'application.
ATTENTION le résultat est stocké à partir du premier appel et renvoyé directement aux appels suivants.
XXX Vérifier le fonctionnement du multi collectivité ici.
| null|mixed | $om_collectivite_idx | Identifiant de la collectivité. |
get_merge_fields_values(string $id_om_requete,string $idx): array
Récupération des valeurs des CHAMPS DE FUSION.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE.
| string | $id_om_requete | Identifiant numérique de l'enregistrement 'om_requete'. |
| string | $idx | Identifiant de l'élément. |
replace_all_elements(string $bloc,array $substitution_vars_values,array $merge_fields_values): string
Remplace dans la chaîne passée en paramètre les variables de substitutions et les champs de fusion par leurs valeurs.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE. La boucle est réalisée 5 fois pour permettre de remplacer les champs de dans les variables de remplacement et inversement.
| string | $bloc | Chaîne de caractères. |
| array | $substitution_vars_values | Tableau de valeurs des variables de remplacement. |
| array | $merge_fields_values | Tableau de valeurs des champs de fusion. |
replace_substitution_vars(string $bloc,array $substitution_vars_values): string
Remplace dans la chaîne passée en paramètres les variables de remplacement par leurs valeurs.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE.
| string | $bloc | Chaîne de caractères. |
| array | $substitution_vars_values | Tableau de valeurs des variables de remplacement. |
replace_merge_fields(string $bloc,array $merge_fields_values): string
Remplace dans la chaîne passée en paramètres les champs de fusion par leurs valeurs.
Méthode spécifique à OM_ETAT et OM_LETTRETYPE.
| string | $bloc | Chaîne de caractères. |
| array | $merge_fields_values | Tableau de valeurs des champs de fusion. |
handle_output(resource $pdf,string $filename): void|string
Gère la sortie PDF.
La sortie est gréré en fonction du paramètre $_GET['output']. En fonction de ce paramètre le PDF peut donc être envoyé en inline dans le navigateur, en mode download, écrit sur le disque ou retourné sous forme de chaîne de caractères.
| resource | Instance d'une classe PDF. |
|
| string | $filename | Nom du fichier. |