API
Table of Contents
Constants
- _BOUSSOLE_ID_BOUSSOLE_SPIP = 'spip'
- Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
- _BOUSSOLE_TYPES_FOURNISSEUR = ['serveur', 'plugin']
- Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
Functions
- boussole_actualiser() : void
- Mise à jour en base de données d'une liste ou de toutes les boussoles installées.
- boussole_charger() : array<string|int, mixed>
- Charge en base de donnée une boussole connue par son identifiant.
- boussole_decharger() : bool
- Suppression de la boussole dans la base de données du site client.
- boussole_lire_consignation() : array<string|int, mixed>
- Renvoie les informations de consignation d'une ou de toutes les boussoles chargées.
- boussole_ecrire_consignation() : bool
- Consigne un chargement de boussole ou l'efface.
- boussole_identifier_fournisseur() : array<string|int, mixed>
- Renvoie le fournisseur sous sa forme tabulaire à partir de la consignation d'une boussole.
- boussole_est_disponible() : bool
- Détermine si une boussole est disponible soit par API REST auprès d'un serveur ou soit via un plugin installé localement.
- boussole_lister_disponibilites() : array<string|int, mixed>
- Renvoie, pour le site courant, la liste des boussoles disponibles au chargement.
Constants
_BOUSSOLE_ID_BOUSSOLE_SPIP
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_ID_BOUSSOLE_SPIP
= 'spip'
_BOUSSOLE_TYPES_FOURNISSEUR
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_TYPES_FOURNISSEUR
= ['serveur', 'plugin']
Functions
boussole_actualiser()
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
Parameters
- $boussoles : null|array<string|int, mixed> = []
-
Tableau des identifiants des boussoles à actualiser ou tableau vide pour toutes les boussoles
Tags
boussole_charger()
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.
Parameters
- $boussole : string
-
Identifiant de la boussole
- $fournisseur : null|array<string|int, mixed> = []
-
Type et identifiant du fournisseur. Si omis, la fonction va le rechercher.
Tags
Return values
array<string|int, mixed> —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é.
boussole_decharger()
Suppression de la boussole dans la base de données du site client.
boussole_decharger(string $boussole) : bool
Parameters
- $boussole : string
-
Identifiant de la boussole
Tags
Return values
bool —false si l'identifiant de la boussole est vide, true sinon
boussole_lire_consignation()
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.
Parameters
- $boussole : null|string = ''
-
Identifiant de la boussole ou vide pour toutes les boussoles
Tags
Return values
array<string|int, mixed> —Les informations de consignation d'une boussole ou de toutes les boussoles.
boussole_ecrire_consignation()
Consigne un chargement de boussole ou l'efface.
boussole_ecrire_consignation(string $boussole[, null|array<string|int, mixed> $consignation = [] ]) : bool
Parameters
- $boussole : string
-
Identifiant de la boussole
- $consignation : null|array<string|int, mixed> = []
-
Tableau de consignation du chargement de la boussole. Si vide ou non fourni provoque l'effacement de la consignation.
Tags
Return values
bool —true si ok, false sinon (identifiant de boussole vide)
boussole_identifier_fournisseur()
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.
Parameters
- $consignation : array<string|int, mixed>
-
Tableau des informations de consignation d'une boussole
Tags
Return values
array<string|int, mixed> —Tableau des informations sur le fournisseur.
boussole_est_disponible()
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.
Parameters
- $boussole : string
-
Identifiant de la boussole
- $fournisseur : array<string|int, mixed>
-
Tableau identifiant le fournisseur:
- type : serveur ou plugin
- id : l'identifiant du serveur ou le préfixe du plugin
Tags
Return values
bool —true si la boussole est disponible, false sinon. Le fournisseur est retourné dans l'argument
de sortie $fournisseur
boussole_lister_disponibilites()
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.
Tags
Return values
array<string|int, mixed> —Tableau des boussoles disponibles. Pour chaque boussole on indique le fournisseur, serveur ou plugin.