Documentation du code de SPIP et de ses plugins

Boussole

CLIENT

Table of Contents

Functions

action_client_actualiser_boussoles_dist()  : void
Cette action permet au site client d'actualiser l'ensemble des boussoles insérées dans sa base de données.
action_client_supprimer_boussole_dist()  : void
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_synchroniser_site_dist()  : void
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.
formulaires_ajouter_boussole_charger_dist()  : array<string|int, mixed>
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_traiter_dist()  : array<string|int, mixed>
Exécution de l'action du formulaire : la boussole choisie est chargée en base en utilisant le fournisseur adéquat.

Functions

action_client_actualiser_boussoles_dist()

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é.

Tags
uses
boussole_actualiser()

action_client_supprimer_boussole_dist()

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.

Tags
uses
boussole_decharger()

action_client_synchroniser_site_dist()

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 :

  • le nom du site
  • le descriptif du site

formulaires_ajouter_boussole_charger_dist()

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>
Tags
uses
boussole_lister_disponibilites()
uses
serveur_boussole_est_spip()
Return values
array<string|int, mixed>

Le tableau des données à charger par le formulaire :

  • 'boussole' : l'alias de la boussole choisie
  • '_boussoles' : la liste des boussoles accessibles

formulaires_ajouter_boussole_traiter_dist()

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>
Tags
uses
boussole_charger()
uses
erreur_boussole_expliquer()
Return values
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.


        
On this page

Search results