Documentation du code de SPIP et de ses plugins

Boussole

serveur_informer_boussole.php

Ce fichier contient l'action `serveur_informer_boussole` utilisée par un site client pour obtenir les informations complètes sur une boussole.

Table of Contents

action_serveur_informer_boussole_dist()  : void
Cette action permet à un site client d'interroger un serveur actif et d'obtenir en retour les informations complètes sur une boussole.

Functions

action_serveur_informer_boussole_dist()

Cette action permet à un site client d'interroger un serveur actif et d'obtenir en retour les informations complètes sur une boussole.

action_serveur_informer_boussole_dist() : void

Cette action est anonyme car elle doit pouvoir être appelée par tout utilisateur. Elle nécessite un seul argument, l'alias de la boussole. L'action renvoie :

  • le fichier cache XML de la boussole demandée, si il existe;
  • un fichier XML d'erreur contenant l'id de l'erreur;
  • rien si le serveur n'est pas actif (l'erreur doit être traitée par l'appelant).
Tags
note

Les cas d'erreur retournés par un serveur actif sont :

  • l'alias de la boussole est vide,
  • la boussole demandée n'est pas hébergée par le serveur,
  • le cache de la boussole n'est pas disponible,
  • aucune boussole n'est hébergée par le serveur.
pipeline_appel

declarer_boussoles

Return values
void

Search results