album_fonctions.php
Fonctions utiles au modèle album
Contient principalement des balises destinées au modèle standard
Tags
Table of Contents
Functions
- balise_ALBUM_DOC_dist() : object
- Compile la balise `#ALBUM_DOC` qui retourne le code HTML d'un modèle de document ajusté pour les albums.
- calculer_album_doc() : string
- Fonction privée pour calculer le HTML de la balise #ALBUM_DOC
- balise_ALBUM_PARAMS_dist() : object
- Compile la balise `#ALBUM_PARAMS` qui retourne soit un ensemble de valeurs utiles au modèle album, soit une seule.
- calculer_album_params() : array<string|int, mixed>|string
- Fonction privée pour calculer la balise `#ALBUM_PARAMS`
- nettoyer_contexte_modele_album() : void
- Nettoyer le contexte pour ne garder que les trucs en rapport avec le modèle
- calculer_id_modele_album() : string
- Renvoie un identifiant unique pour le modèle
- albums_classe_ratio() : string
- Renvoie une classe correspondant à un ratio
- critere_DOCUMENTS_documents_album_dist() : void
- Compile le critère `{documents_album}`
Functions
balise_ALBUM_DOC_dist()
Compile la balise `#ALBUM_DOC` qui retourne le code HTML d'un modèle de document ajusté pour les albums.
balise_ALBUM_DOC_dist(object $p) : object
Utilise en général un modèle standard #DOC auquel on ajoute des attributs
et applique des traitements d'images.
Le choix du modèle et les traitements dépendent de la disposition de l'album et du contexte.
S'utilise uniquement dans une boucle documents ou documents_liens.
Parameters
- $p : object
-
Pile au niveau de la balise
Tags
Return values
object —Pile complétée par le code à générer
calculer_album_doc()
Fonction privée pour calculer le HTML de la balise #ALBUM_DOC
calculer_album_doc(array<string|int, mixed> $document, array<string|int, mixed> $contexte) : string
Parameters
- $document : array<string|int, mixed>
-
Tableau d'infos sur le document array<int id_document, string media, int largeur, int hauteur>
- $contexte : array<string|int, mixed>
-
Contexte d'appel du modèle, sans les trucs par défaut inutiles (date, date_redac, etc.)
Tags
Return values
stringbalise_ALBUM_PARAMS_dist()
Compile la balise `#ALBUM_PARAMS` qui retourne soit un ensemble de valeurs utiles au modèle album, soit une seule.
balise_ALBUM_PARAMS_dist(object $p) : object
Parameters
- $p : object
-
Pile au niveau de la balise
Tags
Return values
object —Pile complétée par le code à générer
calculer_album_params()
Fonction privée pour calculer la balise `#ALBUM_PARAMS`
calculer_album_params([array<string|int, mixed> $contexte = [] ][, string|null $param = null ]) : array<string|int, mixed>|string
En fonction du contexte, de la config et des défauts, on choisit la disposition, le modèle pour les documents, les valeurs pour les traitements à appliquer aux images, etc.
Chaque disposition a ses propres traitements d'image et options par défaut.
Parameters
- $contexte : array<string|int, mixed> = []
-
Environnement du modèle, sans les trucs par défaut inutiles (date, date_redac, etc.)
- $param : string|null = null
Tags
Return values
array<string|int, mixed>|string —Soit un tableau de params : array<string disposition, string modele_doc, string recadrer_ratio, string recadrer_sens, int largeur, int hauteur, bool images> Soit la valeur d'un param
nettoyer_contexte_modele_album()
Nettoyer le contexte pour ne garder que les trucs en rapport avec le modèle
nettoyer_contexte_modele_album([array<string|int, mixed>|null $contexte = [] ]) : void
Permet de calculer un hash
Parameters
- $contexte : array<string|int, mixed>|null = []
calculer_id_modele_album()
Renvoie un identifiant unique pour le modèle
calculer_id_modele_album(array<string|int, mixed>|null $contexte) : string
Dépend de la façon dont sont sélectionnés les documents : soit via id_album, soit id_patate, etc.
Parameters
- $contexte : array<string|int, mixed>|null
Tags
Return values
string —- Si album : <id_album>
- Si objet :
_<id_objet> - si documents : documents_
albums_classe_ratio()
Renvoie une classe correspondant à un ratio
albums_classe_ratio(string $ratio) : string
Indique le format le plus proche : carré, portrait ou paysage Ainsi que le ratio entier le plus proche : 2:1, 3:1
Pour le ratio on arrondit à l'entier le plus proche, ex. : 2.21:1 → 2:1 → 2
Parameters
- $ratio : string
-
Ratio sous la forme
1:1
Return values
string —format-square, format-landscape_2, format-portrait_3, etc.
critere_DOCUMENTS_documents_album_dist()
Compile le critère `{documents_album}`
critere_DOCUMENTS_documents_album_dist(string $idb, object &$boucles, object $crit) : void
Rustine pour forcer une jointure en LEFT avec les documents liés. Des fois le compilo fait du caca : plusieurs jointures sur la même table, et ça pète les conditions dans le WHERE.
Parameters
- $idb : string
-
Identifiant de la boucle
- $boucles : object
-
AST du squelette
- $crit : object
-
Paramètres du critère dans cette boucle