SPIP Code

Documentation du code de SPIP et de ses plugins

Boussole

client.php

Ce fichier contient l'API de gestion en base de données des boussoles installées sur le site client.

Table of Contents

boussole_actualiser_boussoles()  : void
Mise à jour en base de données d'une liste ou de toutes les boussoles installées sur le site client.
boussole_ajouter()  : array<string|int, mixed>
Ajout ou actualisation de la boussole dans la base de données du site client.
boussole_supprimer()  : bool
Suppression de la boussole dans la base de données du site client.
boussole_charger()  : string
Chargement d'une boussole donnée fournie par un serveur.
phraser_xml_boussole()  : array<string|int, mixed>
Conversion du fichier XML de la boussole en un tableau des sites de la boussole.

Functions

boussole_actualiser_boussoles()

Mise à jour en base de données d'une liste ou de toutes les boussoles installées sur le site client.

boussole_actualiser_boussoles([array<string|int, mixed> $boussoles = array() ]) : void

La fonction appelle, pour toutes les boussoles identifiées dans la base de données du site client, l'api d'ajout/actualisation d'une boussole.

Parameters
$boussoles : array<string|int, mixed> = array()

Tableau des alias des boussoles à actualiser ou tableau vide pour toutes les boussoles

Tags
uses
boussole_ajouter()
Return values
void —

boussole_ajouter()

Ajout ou actualisation de la boussole dans la base de données du site client.

boussole_ajouter(string $boussole[, string $serveur = 'spip' ]) : array<string|int, mixed>
Parameters
$boussole : string

Alias de la boussole

$serveur : string = 'spip'

Alias du serveur fournissant les données sur la boussole

Tags
uses
phraser_xml_boussole()
note

Le message de retour reflète soit l'ajout ou l'actualisation de la boussole, soit l'erreur rencontrée. Les erreurs possibles sont :

  • celles retournées par la fonction de phrasage du XML, phraser_xml_boussole(),
  • une erreur d'écriture en base de données.
Return values
array<string|int, mixed> —

Tableau décrivant le statut des traitements effectués :

  • index 0 : true ou false,
  • index 1 : libellé traduit du message.

boussole_supprimer()

Suppression de la boussole dans la base de données du site client.

boussole_supprimer(string $boussole) : bool
Parameters
$boussole : string

Alias de la boussole

Return values
bool —

false si l'alias de la boussole est vide, true sinon

boussole_charger()

Chargement d'une boussole donnée fournie par un serveur.

boussole_charger(string $boussole[, string $serveur = 'spip' ]) : string
Parameters
$boussole : string

Alias de la boussole

$serveur : string = 'spip'

Nom du serveur fournissant les données sur la boussole

Return values
string —

Contenu complet de la boussole issu du cache serveur

phraser_xml_boussole()

Conversion du fichier XML de la boussole en un tableau des sites de la boussole.

phraser_xml_boussole(string $contenu) : array<string|int, mixed>
Parameters
$contenu : string

Contenu complet de la boussole au format du cache serveur

Tags
uses
action_serveur_informer_boussole_dist()
note

Les cas d'erreur retournés par cette fonction sont :

  • ceux de l'action action_serveur_informer_boussole_dist si le serveur est actif,
  • la réponse du serveur est invalide ou le serveur est inactif, sinon.
Return values
array<string|int, mixed> —

Tableau décrivant tous les éléments de la boussole prêts à être insérés tels quels dans la base de données et le message d'erreur éventuel :

- index 'boussole' : les champs spécifiques de la boussole,
- index 'sites' : les champs des sites de la boussole,
- index 'extras' : les traductions de chaque éléments (boussole, site, groupe) de la boussole,
- index 'erreur' : libellé traduit du message d'erreur.

Search results