API
Table of Contents
Constants
- _BOUSSOLE_ID_SERVEUR_SPIP = 'spip'
- Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
- _BOUSSOLE_URL_SERVEUR_SPIP = 'https://boussole.spip.net'
- Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
Functions
- serveur_boussole_identifier() : string
- Renvoie, pour le site courant, son identifiant de serveur de boussoles.
- serveur_boussole_est_spip() : bool
- 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_declarer() : bool
- Ajoute un serveur et son url dans la liste des serveurs disponibles, donc accessibles par l'API REST.
- serveur_boussole_retirer() : bool
- Retire une serveur désigné par son identifiant de la liste des serveurs accessibles par le site courant.
- serveur_boussole_lister_disponibilites() : array<string|int, mixed>
- Renvoie, pour le site courant, la liste des serveurs déclarés, donc disponibles via l'API REST.
Constants
_BOUSSOLE_ID_SERVEUR_SPIP
Liste des types de fournisseur de boussoles : un serveur (REST) ou un plugin de boussole.
public
mixed
_BOUSSOLE_ID_SERVEUR_SPIP
= 'spip'
_BOUSSOLE_URL_SERVEUR_SPIP
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'
Functions
serveur_boussole_identifier()
Renvoie, pour le site courant, son identifiant de serveur de boussoles.
serveur_boussole_identifier() : string
Le site doit être configuré comme serveur de boussole.
Return values
string —Identifiant du serveur ou vide si le site n'est pas configuré comme un serveur
serveur_boussole_est_spip()
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
Parameters
- $serveur : null|string = ''
-
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
Tags
Return values
bool —true si le serveur correspond à celui de spip ou false sinon.
serveur_boussole_declarer()
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
Parameters
- $serveur : string
-
Identifiant du serveur
- $url : string
-
URL de base du serveur (adresse du site)
Tags
Return values
bool —true si la déclaration est ok, false sinon (par exemple, si le serveur ou l'url est vide).
serveur_boussole_retirer()
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.
Parameters
- $serveur : string
-
Identifiant du serveur
Tags
Return values
bool —true si le serveur, false sinon (par exemple, si le serveur est spip ou l'identifiant est erronné).
serveur_boussole_lister_disponibilites()
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>
Tags
Return values
array<string|int, mixed> —Tableau des serveurs disponibles. Pour chaque serveur on renvoie l'url de base.