Squelettes
Table of Contents
Functions
- balise_BOUSSOLE_INFOS() : Champ
- Compilation de la balise `#BOUSSOLE_INFOS` retournant les informations générales sur une boussole.
- calcul_boussole_infos() : array<string|int, mixed>
- Récupération des informations sur une boussole donnée ou sur toutes les boussoles installées.
- boussole_traduire() : string
- Traduction d'un champ d'une boussole, d'un groupe de sites ou d'un site.
- boussole_logo_topnav() : string
- Renvoie chemin nom du logo topnav à partir du chemin du logo de la boussole.
Functions
balise_BOUSSOLE_INFOS()
Compilation de la balise `#BOUSSOLE_INFOS` retournant les informations générales sur une boussole.
balise_BOUSSOLE_INFOS(Champ $p) : Champ
La balise #BOUSSOLE_INFOS renvoie :
- le tableau des infos contenues dans la meta boussole_infos_xxx si l'alias "xxx" est fourni,
- la liste de tous les tableaux d'infos des meta boussole_infos_* sinon.
La liste des informations disponibles est la suivante :
- 'logo' : l'url du logo de la boussole
- 'version' : la version de la boussole
- 'fournisseur' : le fournisseur de la boussole
- 'sha' : sha256 du fichier cache de la boussole
- 'alias' : alias de la boussole
- 'demo' : url de la page de démo de la boussole
- 'nbr_sites' : nombre de sites intégrés dans la boussole
- 'maj' : date de la dernière mise à jour des informations
Parameters
- $p : Champ
-
Pile au niveau de la balise.
Tags
Return values
Champ —Pile complétée par le code à générer.
calcul_boussole_infos()
Récupération des informations sur une boussole donnée ou sur toutes les boussoles installées.
calcul_boussole_infos(string $boussole) : array<string|int, mixed>
Les informations retournées pour une boussole d'alias "xxx" sont celles stockées dans la meta
boussole_infos_xxx auxquelles on adjoint la date de la dernière mise à jour de cette meta.
Parameters
- $boussole : string
-
Alias de la boussole ou chaine vide
Tags
Return values
array<string|int, mixed> —Tableau de la ou des boussoles installées. Si l'alias de la boussole est erroné, la fonction retourne un tableau vide
boussole_traduire()
Traduction d'un champ d'une boussole, d'un groupe de sites ou d'un site.
boussole_traduire(string $boussole, string $champ[, null|string $objet = '' ]) : string
Parameters
- $boussole : string
-
Alias de la boussole
- $champ : string
-
Champ à traduire. La liste des champs possibles est :
- 'nom_boussole', 'slogan_boussole', 'descriptif_boussole' pour un objet boussole
- 'nom_groupe', 'slogan_groupe' pour un objet groupe
- 'nom_site', 'slogan_site', 'descriptif_site', 'nom_slogan_site' pour un objet site
- $objet : null|string = ''
-
Identifiant d'un objet groupe ou site. Vide pour la traduction d'un champ d'un objet boussole
Tags
Return values
string —Champ traduit dans la langue du site
boussole_logo_topnav()
Renvoie chemin nom du logo topnav à partir du chemin du logo de la boussole.
boussole_logo_topnav(string $logo) : string
Le nom du logo est en fait suffixé par -topnav.
Parameters
- $logo : string
-
URL du logo de boussole.
Tags
Return values
string —URL du logo topnav de la même boussole.