serveur.php
Ce fichier contient l'API de gestion des caches des boussoles hébergées par le site serveur.
Table of Contents
- _BOUSSOLE_OBJET_BOUSSOLE = 'boussole'
- _BOUSSOLE_OBJET_GROUPE = 'groupe'
- _BOUSSOLE_OBJET_SITE = 'site'
- _BOUSSOLE_PATTERN_SHA = '%sha_contenu%'
- Pattern permettant d'insérer le sha256 calculé à partir du XML d'origine d'une boussole dans le cache produit
- boussole_actualiser_caches() : void
- Génération du cache de chaque boussole hébergée par le serveur et du cache de la liste de ces boussoles.
- boussole_cacher_xml() : bool
- Génération du cache xml de la boussole contruit soit à partir de xml non traduit soit à partir d'un xml déjà traduit.
- boussole_cacher_liste() : bool
- Génération du cache de la liste des boussoles disponibles Ce cache est renvoyé sur l'action serveur_lister_boussoles
- boussole_valider_xml() : bool
- Teste la validite du fichier xml de la boussole en fonction de la DTD boussole.dtd
- xml_to_cache() : bool
- Lecture du xml d'une boussole issue d'un plugin ou d'une boussole manuelle et génération du cache xml incluant les traductions et les chemins des logos
- inserer_balise() : string
- Insertion d'un balise ouvrante, fermante ou vide
- compiler_traductions_plugin() : array<string|int, string>
- Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
- compiler_traductions_manuelle() : array<string|int, string>
- Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
- inserer_traductions() : string
- Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
- indenter() : string
- Contruction de la chaine de tabulations correspondant au décalage souhaité
Constants
_BOUSSOLE_OBJET_BOUSSOLE
public
mixed
_BOUSSOLE_OBJET_BOUSSOLE
= 'boussole'
_BOUSSOLE_OBJET_GROUPE
public
mixed
_BOUSSOLE_OBJET_GROUPE
= 'groupe'
_BOUSSOLE_OBJET_SITE
public
mixed
_BOUSSOLE_OBJET_SITE
= 'site'
_BOUSSOLE_PATTERN_SHA
Pattern permettant d'insérer le sha256 calculé à partir du XML d'origine d'une boussole dans le cache produit
public
mixed
_BOUSSOLE_PATTERN_SHA
= '%sha_contenu%'
Functions
boussole_actualiser_caches()
Génération du cache de chaque boussole hébergée par le serveur et du cache de la liste de ces boussoles.
boussole_actualiser_caches() : void
Tags
Return values
void —boussole_cacher_xml()
Génération du cache xml de la boussole contruit soit à partir de xml non traduit soit à partir d'un xml déjà traduit.
boussole_cacher_xml(string $alias[, string $prefixe_plugin = '' ]) : bool
Ce cache est renvoyé sur l'action serveur_informer_boussole
Parameters
- $alias : string
- $prefixe_plugin : string = ''
Return values
bool —boussole_cacher_liste()
Génération du cache de la liste des boussoles disponibles Ce cache est renvoyé sur l'action serveur_lister_boussoles
boussole_cacher_liste(array<string|int, mixed> $boussoles) : bool
Parameters
- $boussoles : array<string|int, mixed>
Return values
bool —boussole_valider_xml()
Teste la validite du fichier xml de la boussole en fonction de la DTD boussole.dtd
boussole_valider_xml(string $url, array<string|int, mixed> &$erreur) : bool
Parameters
- $url : string
-
url absolue du fichier xml de description de la boussole
- $erreur : array<string|int, mixed>
-
tableau des erreurs collectees suite a la validation xml
Return values
bool —xml_to_cache()
Lecture du xml d'une boussole issue d'un plugin ou d'une boussole manuelle et génération du cache xml incluant les traductions et les chemins des logos
xml_to_cache(string $fichier_xml, string $alias_boussole[, string $prefixe_plugin = '' ]) : bool
Parameters
- $fichier_xml : string
- $alias_boussole : string
- $prefixe_plugin : string = ''
Return values
bool —inserer_balise()
Insertion d'un balise ouvrante, fermante ou vide
inserer_balise(string $type, string $nom_balise[, array<string|int, mixed> $attributs = array() ], int $indentation) : string
Parameters
- $type : string
- $nom_balise : string
- $attributs : array<string|int, mixed> = array()
- $indentation : int
Return values
string —compiler_traductions_plugin()
Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
compiler_traductions_plugin(string $alias_boussole, string $type_objet, string $alias_objet, int $indentation) : array<string|int, string>
Parameters
- $alias_boussole : string
- $type_objet : string
- $alias_objet : string
- $indentation : int
Return values
array<string|int, string> —compiler_traductions_manuelle()
Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
compiler_traductions_manuelle(array<string|int, mixed> $objet, int $indentation) : array<string|int, string>
Parameters
- $objet : array<string|int, mixed>
- $indentation : int
Return values
array<string|int, string> —inserer_traductions()
Insertion d'une balise complète <nom>, <slogan> ou <description> incluant les traductions en <multi>
inserer_traductions(string $nom, string $slogan, string $description, int $indentation) : string
Parameters
- $nom : string
- $slogan : string
- $description : string
- $indentation : int
Return values
string —indenter()
Contruction de la chaine de tabulations correspondant au décalage souhaité
indenter(int $decalage) : string
Parameters
- $decalage : int