Extensions possibles pour le fichier de description d'une boussole.
public
mixed
_BOUSSOLE_FICHIER_EXTENSIONS_DEFAUT
= ['xml', 'json']
L'extension yaml nécessite l'utilisation du plugin YAML.
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_ID_BOUSSOLE_SPIP
= 'spip'
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_ID_SERVEUR_SPIP
= 'spip'
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_TYPES_FOURNISSEUR
= ['serveur', 'plugin']
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_URL_SERVEUR_SPIP
= 'https://boussole.spip.net'
Cette action permet au site client d'actualiser l'ensemble des boussoles insérées dans sa base de données.
action_client_actualiser_boussoles_dist() : void
L'action est utilisée sur demande depuis la page d'administration du client de l'espace privé.
Cette action permet au site client de retirer un serveur donné de sa liste des serveurs qu'il est autorisé à interroger (variable de configuration).
action_client_retirer_serveur_dist() : void
Cette action est réservée aux webmestres. Elle nécessite un seul argument, l'identifiant du serveur à retirer.
Cette action permet au site client de supprimer de sa base de données, de façon sécurisée, une boussole donnée.
action_client_supprimer_boussole_dist() : void
Cette action est réservée aux webmestres. Elle nécessite un seul argument, l'identifiant de la boussole.
Cette action permet de synchroniser un site référencé dans la base du client et de synchroniser ses données avec le site idoine (de même id_syndic) de la boussole associée.
action_client_synchroniser_site_dist() : void
Cette action est réservée aux webmestres. Elle nécessite deux arguments, l'id du site et l'identifiant de la boussole. Les données synchronisées sont :
Déclaration des nouvelles tables de la base de données propres au plugin.
boussole_declarer_tables_principales(array<string|int, mixed> $tables_principales) : array<string|int, mixed>
Le plugin déclare deux nouvelles tables qui sont :
spip_boussoles, qui contient les éléments constitutifs des boussoles,spip_boussoles_extras, qui contient les traductions de ces éléments.Tableau global décrivant la structure des tables de la base de données
Tableau fourni en entrée et mis à jour avec les nouvelles déclarations
Déclaration des informations tierces (alias, traitements, jointures, etc) sur les tables de la base de données modifiées ou ajoutées par le plugin.
boussole_declarer_tables_interfaces(array<string|int, mixed> $interface) : array<string|int, mixed>
Le plugin se contente de déclarer les alias des tables qu'il ajoute ainsi que des traitements classiques sur les champs ajoutés de type url et texte.
Tableau global des informations tierces sur les tables de la base de données
Tableau fourni en entrée et mis à jour avec les nouvelles informations
Installation du schéma de données propre au plugin et gestion des migrations suivant les évolutions du schéma.
boussole_upgrade(string $nom_meta_base_version, string $version_cible) : void
Le schéma comprend des tables et des variables de configuration.
Nom de la meta dans laquelle sera rangée la version du schéma
Version du schéma de données en fin d'upgrade
Suppression de l'ensemble du schéma de données propre au plugin, c'est-à-dire les tables et les variables de configuration.
boussole_vider_tables(string $nom_meta_base_version) : void
Nom de la meta dans laquelle sera rangée la version du schéma
Migration du schéma 0.1 au 0.2.
maj02_boussole() : void
Ajout de la table spip_boussoles_extras et suppression des boussoles autres que
la boussole "spip" car il n'est pas possible de les mettre à jour,
leur serveur n'étant pas connu.
Migration du schéma 0.2 au 0.3.
maj03_boussole(array<string|int, mixed> $defaut_config) : void
Les globales $serveur_boussoles_disponibles et $client_serveurs_disponibles sont
transférées dans des variables de configuration
Configuration par défaut supplémentaire ajoutée pour ce schéma. Si le site a déjà personnalisé les globales la configuration par défaut sera écrasée par celle des globales migrées.
Migration du schéma 0.3 au 0.4.
maj04_boussole(array<string|int, mixed> $defaut_config) : void
La constante _BOUSSOLE_ALIAS_SERVEUR est transformée en deux variables de configuration,
l'une pour l'activité de la fonction serveur et l'autre pour le nom du serveur.
Configuration par défaut supplémentaire ajoutée pour ce schéma. Si le site est déjà un serveur, la configuration par défaut sera écrasée par celle de la constante migrée.
Migration du schéma 0.4 au 0.5.
maj05_boussole(string $url_serveur_spip) : void
Le serveur de boussoles spip passe en https.
URL du serveur spip
boussole_autoriser(mixed $flux) : mixed
Autorisation minimale d'utiliser le plugin Boussole.
autoriser_boussole_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation de voir la liste des boussoles et des serveurs.
autoriser_boussoles_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation de voir la page d'une boussole.
autoriser_boussole_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation d'ajout d'un serveur dans la liste des serveurs accessibles par le site client.
autoriser_boussole_declarerserveur_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation de retrait d'un serveur dans la liste des serveurs accessibles par le site client.
autoriser_boussole_retirerserveur_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation d'ajout d'une boussole dans la base d'un client.
autoriser_boussole_ajouterdansclient_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation de modifier l'affichage d'une boussole, à savoir, l'ordre des groupes et des sites, la visibilité des sites.
autoriser_boussole_modifierdansserveur_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Cette configuration est associée à la boussole pour le serveur et sera renvoyée aux sites client demandeurs.
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation d'importer les sites d'une boussole dans la liste des sites référencés.
autoriser_boussole_importer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
Autorisation pour un site de répondre aux requêtes des clients.
autoriser_boussole_servir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Pour cela:
Action demandée
Type d'objet sur lequel appliquer l'action
Identifiant de l'objet
Description de l'auteur demandant l'autorisation
Options de cette autorisation
true s'il a le droit, false sinon
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 :
La liste des informations disponibles est la suivante :
Pile au niveau de la balise.
Pile complétée par le code à générer.
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.
Alias de la boussole ou chaine vide
Tableau de la ou des boussoles installées. Si l'alias de la boussole est erroné, la fonction retourne un tableau vide
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
Alias de la boussole
Champ à traduire. La liste des champs possibles est :
Identifiant d'un objet groupe ou site. Vide pour la traduction d'un champ d'un objet boussole
Champ traduit dans la langue du site
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.
URL du logo de boussole.
URL du logo topnav de la même boussole.
Affichage, dans la fiche d'un objet site, d'un bloc identifiant la boussole à laquelle appartient le site édité.
boussole_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
Flux fourni en entrée au pipeline
Flux éventuellement complété
Affiche dans la page d'accueil des sites référencés un raccourci pour importer l'ensemble des sites d'une boussole déjà installée.
boussole_affiche_gauche(array<string|int, mixed> $flux) : array<string|int, mixed>
Flux fourni en entrée au pipeline
Flux éventuellement complété
Permet de déclencher la mise à jour de la boussole si un site de la base appartenant à cette boussole est refusé ou réhabilité si il était déjà refusé.
boussole_post_edition(array<string|int, mixed> $flux) : array<string|int, mixed>
Flux fourni au pipeline
Flux d'entrée sans modification.
Déclare la collection boussoles à l'API d'ezrest.
boussole_liste_ezcollection(array<string|int, mixed> $collections) : array<string|int, mixed>
Configuration des collections déjà déclarées.
Collections complétées.
Renvoie la configuration spécifique des caches gérés par Boussole.
boussole_cache_configurer(string $plugin) : array<string|int, mixed>
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
Tableau de la configuration brute du plugin.
Détermine si le serveur est capable de répondre aux requêtes SVP.
boussoles_api_verifier_contexte(array<string|int, mixed> &$erreur) : bool
Pour cela on vérifie si le serveur a été activé et qu'il est prêt à répondre.
Tableau initialisé avec les index identifiant l'erreur ou vide si pas d'erreur. Les index mis à jour sont uniquement les suivants car les autres sont initialisés par l'appelant :
type : identifiant de l'erreur 501, soit runtime_nokelement : type d'objet sur lequel porte l'erreur, soit serveurvaleur : la valeur du mode runtimetrue si la valeur est valide, false sinon.
Récupère la liste boussoles avec toutes les informations possibles y compris leur nom en mode balise multi.
boussoles_collectionner(array<string|int, mixed> $conditions, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Conditions à appliquer au select
Tableau des critères de filtrage additionnels à appliquer au select.
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
Tableau des boussoles dont l'index est l'identifiant de la boussole.
Retourne la description complète d'une boussole (sites, traductions, logos).
boussoles_ressourcer(string $boussole, array<string|int, mixed> $filtres, array<string|int, mixed> $configuration) : array<string|int, mixed>
Identifiant de la boussole.
Tableau des critères de filtrage additionnels à appliquer au select.
Configuration de la collection utile pour savoir quelle fonction appeler pour construire chaque filtre.
La description de la boussole, de ses sites et toutes les traductions associées.
Chargement des données : le formulaire propose la liste des boussoles accessibles à partir des serveurs que le site client a déclaré.
formulaires_ajouter_boussole_charger_dist() : array<string|int, mixed>
Le tableau des données à charger par le formulaire :
Exécution de l'action du formulaire : la boussole choisie est chargée en base en utilisant le fournisseur adéquat.
formulaires_ajouter_boussole_traiter_dist() : array<string|int, mixed>
Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.
Chargement des données : le formulaire permet d'activer la fonction serveur et d'en saisir l'identifiant.
formulaires_configurer_boussole_serveur_charger() : array<string|int, mixed>
Le tableau des données à charger par le formulaire et l'indicateur éditable qui est mis à false si le plugin REST Factory n'est pas actif.
Vérification des saisies : si on active la fonction serveur, il est obligatoire de saisir un identifiant et que celui-ci soit différent du serveur spip si on est sur un site différent.
formulaires_configurer_boussole_serveur_verifier() : array<string|int, mixed>
Vérification des saisies : - l'url est non vide, - bien formée, - ne correspond pas à celui de spip - et que le serveur désigné fourni bien au moins une boussole.
formulaires_declarer_serveur_boussole_verifier_dist() : array<string|int, mixed>
Exécution de l'action du formulaire : déclaration du serveur de boussoles.
formulaires_declarer_serveur_boussole_traiter_dist() : array<string|int, mixed>
Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.
Chargement des données : le formulaire affiche les sites de la boussole, classés par groupe.
formulaires_editer_boussole_charger(string $boussole) : array<string|int, mixed>
Il est possible de cacher un site, changer son rang voire changer le rang d'un groupe.
Identifiant de la boussole
Le tableau des données à charger par le formulaire :
Exécution de l'action du formulaire : chaque action sur la boussole est enregistrée dans la base de données.
formulaires_editer_boussole_traiter(string $boussole) : array<string|int, mixed>
Identifiant de la boussole
Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.
Chargement des données : le formulaire propose la liste des boussoles accessibles à partir des serveurs que le site client a déclaré.
formulaires_importer_boussole_charger_dist() : array<string|int, mixed>
Le tableau des données à charger par le formulaire :
Vérification des saisies : si on active la fonction serveur, il est obligatoire de saisir un identifiant et que celui-ci soit différent du serveur spip si on est sur un site différent.
formulaires_importer_boussole_verifier_dist() : array<string|int, mixed>
Le tableau des messages d'erreur ou vide si ok.
Exécution de l'action du formulaire : les sites de la boussole choisie sont importés dans la base.
formulaires_importer_boussole_traiter_dist() : array<string|int, mixed>
Tableau retourné par le formulaire contenant toujours un message de bonne exécution ou d'erreur. L'indicateur editable est toujours à vrai.
Importe les sites d'une boussole dans une rubrique donnée.
importer_sites_boussole(string $boussole, int $id_parent[, null|bool $langue_site = true ][, null|bool $forcer_statut_publie = false ]) : int
Identifiant de la boussole
Id de la rubrique parente
Indique que seule la langue du site est importée
Indique que le statut des sites créés est forcé à publié
Nombre de sites importés.
Ce CRON permet mettre à jour les boussoles.
genie_boussole_actualiser_client_dist(int $last) : int
Timestamp de la date de dernier appel de la tâche.
Retour de la fonction toujours à 1
Activation du CRON de mise à jour des statistiques de plugins.
boussole_taches_generales_cron(array<string|int, mixed> $taches_generales) : array<string|int, mixed>
Liste des taches à compléter
Liste des taches mise à jour
Mise à jour en base de données d'une liste ou de toutes les boussoles installées.
boussole_actualiser([null|array<string|int, mixed> $boussoles = [] ]) : void
Tableau des identifiants des boussoles à actualiser ou tableau vide pour toutes les boussoles
Charge en base de donnée une boussole connue par son identifiant.
boussole_charger(string $boussole[, null|array<string|int, mixed> $fournisseur = [] ]) : array<string|int, mixed>
Par défaut, la boussole est récupérée soit depuis un site serveur via une API REST motorisée par REST Factory soit est fournie en local par un plugin.
Identifiant de la boussole
Type et identifiant du fournisseur. Si omis, la fonction va le rechercher.
Bloc de retour dont les index sont comparables à ceux de l'API ezrest. Ainsi, le statut de retour vaut 200 si tout c'est bien passé.
Suppression de la boussole dans la base de données du site client.
boussole_decharger(string $boussole) : bool
Identifiant de la boussole
false si l'identifiant de la boussole est vide, true sinon
Renvoie les informations de consignation d'une ou de toutes les boussoles chargées.
boussole_lire_consignation([null|string $boussole = '' ]) : array<string|int, mixed>
La fonction lit les metas directement dans la base sans passer par le cache metas.
Identifiant de la boussole ou vide pour toutes les boussoles
Les informations de consignation d'une boussole ou de toutes les boussoles.
Consigne un chargement de boussole ou l'efface.
boussole_ecrire_consignation(string $boussole[, null|array<string|int, mixed> $consignation = [] ]) : bool
Identifiant de la boussole
Tableau de consignation du chargement de la boussole. Si vide ou non fourni provoque l'effacement de la consignation.
true si ok, false sinon (identifiant de boussole vide)
Renvoie le fournisseur sous sa forme tabulaire à partir de la consignation d'une boussole.
boussole_identifier_fournisseur(array<string|int, mixed> $consignation) : array<string|int, mixed>
Cette fonction gère la transition entre le nouveau format du fournisseur et l'ancien.
Tableau des informations de consignation d'une boussole
Tableau des informations sur le fournisseur.
Détermine si une boussole est disponible soit par API REST auprès d'un serveur ou soit via un plugin installé localement.
boussole_est_disponible(string $boussole, array<string|int, mixed> &$fournisseur) : bool
On privilégie le serveur qui est réputé plus à jour.
Identifiant de la boussole
Tableau identifiant le fournisseur:
true si la boussole est disponible, false sinon. Le fournisseur est retourné dans l'argument
de sortie $fournisseur
Renvoie, pour le site courant, la liste des boussoles disponibles au chargement.
boussole_lister_disponibilites() : array<string|int, mixed>
La fonction détermine les boussoles accessibles par serveur et celles mise à disposition par des plugins activés.
Tableau des boussoles disponibles. Pour chaque boussole on indique le fournisseur, serveur ou plugin.
Acquiert une boussole ou la liste des boussoles d'un serveur.
inc_boussole_acquerir_dist(string $serveur, string $boussole, array<string|int, mixed> &$erreur) : array<string|int, mixed>
La fonction utilise un cache pour éviter de requêter le serveur à chaque appel.
Identifiant ou URL du serveur
Identifiant d'une boussole à acquérir ou vide si on souhaite acquérir la liste des boussoles.
Tableau descriptif de l'erreur
Configuration d'une boussole ou liste des boussoles d'un serveur.
Extraire les attributs d'une balise XML.
xml_boussole_extraire_attributs(SimpleXMLElement $xml_element) : array<string|int, mixed>
Contenu XML décodé sous la forme d'un objet.
Liste des attributs sous la forme [attribut] = valeur.
Identifier le logo de la boussole.
logo_boussole_identifier(string $boussole, string $type_objet[, null|string $objet = '' ]) : string
Identifiant de la boussole
Type d'objet pour lequel on veut récupérer le logo (boussole, site)
Identifiant de l'objet (uniquement pour une site)
URL Absolue du logo de l'objet concerné (boussole ou site)
Compile les traductions du nom, slogan et description d'une boussole, d'un groupe ou d'uns site.
boussole_compiler_traductions(string $boussole, string $type_objet, string $objet) : array<string|int, mixed>
La fonction renvoie une balise
Identifiant de la boussole
Type d'objet pour lequel on veut récupérer le logo (boussole, site)
Identifiant de l'objet (boussole, site)
Tableau des traductions
Renvoie le message de retour ou d'erreur compilé à partir du tableau d'erreur fourni en argument.
erreur_boussole_expliquer(array<string|int, mixed> $erreur) : string
Tableau descriptif de l'erreur
Message d'erreur compilé à partir de l'erreur.
Remplace ou ajoute un logo au site. L'image source est connue par son url.
inc_iconifier_site_dist(int $id_site, string $mode, string $url_image) : void
Id du site concerné.
Le type de l'icone, "on" pour le logo de base, ou "off" pour le survol.
Url de l'image source destinée à devenir le logo du site.
Renvoie, pour le site courant, son identifiant de serveur de boussoles.
serveur_boussole_identifier() : string
Le site doit être configuré comme serveur de boussole.
Identifiant du serveur ou vide si le site n'est pas configuré comme un serveur
Détermine si le serveur connu par son identifiant ou par son url est le serveur officiel de SPIP fournbissant la boussole SPIP.
serveur_boussole_est_spip([null|string $serveur = '' ]) : bool
Identifiant ou URL du serveur à vérifier. Si une URL est passée à la fonction, celle-ci considère qu'elle est, a priori, bien formée. Si l'identifiant est vide, la fonction utilise l'adresse du site courant
true si le serveur correspond à celui de spip ou false sinon.
Ajoute un serveur et son url dans la liste des serveurs disponibles, donc accessibles par l'API REST.
serveur_boussole_declarer(string $serveur, string $url) : bool
Identifiant du serveur
URL de base du serveur (adresse du site)
true si la déclaration est ok, false sinon (par exemple, si le serveur ou l'url est vide).
Retire une serveur désigné par son identifiant de la liste des serveurs accessibles par le site courant.
serveur_boussole_retirer(string $serveur) : bool
Il n'est pas possible de supprimer le serveur officiel spip.
Identifiant du serveur
true si le serveur, false sinon (par exemple, si le serveur est spip ou l'identifiant est erronné).
Renvoie, pour le site courant, la liste des serveurs déclarés, donc disponibles via l'API REST.
serveur_boussole_lister_disponibilites() : array<string|int, mixed>
Tableau des serveurs disponibles. Pour chaque serveur on renvoie l'url de base.