\edition

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.

Summary

Methods
Properties
Constants
__destruct()
__construct()
view_pdf()
view_pdfetiquette()
pdf_om_etat_om_lettretype()
view_pdfetat()
view_pdflettretype()
get_edition_from_collectivite()
get_logo_from_collectivite()
get_substitution_vars_values()
get_merge_fields_values()
replace_all_elements()
replace_substitution_vars()
replace_merge_fields()
expose_pdf_output()
No public properties found
No constants found
init_om_application()
addToLog()
$f
N/A
handle_output()
No private properties found
N/A

Properties

$f

$f : null|\application

Instance de la classe 'application'.

Type

null|\application

Methods

__destruct()

__destruct() 

Destructeur.

__construct()

__construct() 

Constructeur.

view_pdf()

view_pdf() : void

VIEW - view_pdf.

Cette vue remplace l'ancien script 'pdf/pdf.php'. Elle permet d'afficher la liste des éditions disponibles 'sql//*.pdf.inc.php' ainsi que de générer le fichier PDF d'une édition en particulier.

view_pdfetiquette()

view_pdfetiquette() : void|array

VIEW - view_pdfetiquette.

Cette vue remplace l'ancien script 'pdf/pdfetiquette.php'. Elle permet de générer le fichier PDF d'une édition d'étiquettes en particulier parmi les éditions disponibles 'sql//*.pdfetiquette.inc.php'.

Returns

void|array

pdf_om_etat_om_lettretype()

pdf_om_etat_om_lettretype(string  $edition_elem, string  $collectivite) : array

Génération de l'édition PDF pour une édition "etat" ou "lettretype".

Parameters

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.

Returns

array

view_pdfetat()

view_pdfetat(string  $collectivite = null) : array

VIEW - view_pdfetat.

Génération de l'édition PDF pour une édition "etat".

Parameters

string $collectivite

Identifiant de la collectivité spécifique (dans certains cas d'utilisation liés au multi-collectivité) sur laquelle porte l'édition.

Returns

array

view_pdflettretype()

view_pdflettretype(string  $collectivite = null) : array

VIEW - view_pdflettretype.

Génération de l'édition PDF pour une édition "lettretype".

Parameters

string $collectivite

Identifiant de la collectivité spécifique (dans certains cas d'utilisation liés au multi-collectivité) sur laquelle porte l'édition.

Returns

array

get_edition_from_collectivite()

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.

Parameters

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.

Returns

array

get_logo_from_collectivite()

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.

Parameters

string $id_logo

identifiant du logo

integer $id_collectivite

identifiant de la collectivité

Returns

mixed —

null si aucun logo ou array contenant les informations du logo.

get_substitution_vars_values()

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.

Parameters

null|mixed $om_collectivite_idx

Identifiant de la collectivité.

Returns

array

get_merge_fields_values()

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.

Parameters

string $id_om_requete

Identifiant numérique de l'enregistrement 'om_requete'.

string $idx

Identifiant de l'élément.

Returns

array

replace_all_elements()

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.

Parameters

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.

Returns

string

replace_substitution_vars()

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.

Parameters

string $bloc

Chaîne de caractères.

array $substitution_vars_values

Tableau de valeurs des variables de remplacement.

Returns

string

replace_merge_fields()

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.

Parameters

string $bloc

Chaîne de caractères.

array $merge_fields_values

Tableau de valeurs des champs de fusion.

Returns

string

expose_pdf_output()

expose_pdf_output(string  $pdf_output, string  $filename) : void

Expose le fichier PDF à l'utilisateur.

Parameters

string $pdf_output

PDF sous forme de chaîne de carctères.

string $filename

Nom du fichier.

init_om_application()

init_om_application() : boolean

Initialisation de la classe 'application'.

Cette méthode permet de vérifier que l'attribut f de la classe contient bien la ressource utils du framework et si ce n'est pas le cas de la récupérer.

Returns

boolean

addToLog()

addToLog(string  $message, integer  $type = DEBUG_MODE) : void

Ajout d'un message au système de logs.

Cette méthode permet de logger un message.

Parameters

string $message

Message à logger.

integer $type

Niveau de log du message.

handle_output()

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.

Parameters

resource $pdf

Instance d'une classe PDF.

string $filename

Nom du fichier.

Returns

void|string