Application
Table of Contents
Functions
- boussole_autoriser() : mixed
- autoriser_boussole_dist() : bool
- Autorisation minimale d'utiliser le plugin Boussole.
- autoriser_boussoles_voir_dist() : bool
- Autorisation de voir la liste des boussoles et des serveurs.
- autoriser_boussole_voir_dist() : bool
- Autorisation de voir la page d'une boussole.
- autoriser_boussole_declarerserveur_dist() : bool
- Autorisation d'ajout d'un serveur dans la liste des serveurs accessibles par le site client.
- autoriser_boussole_retirerserveur_dist() : bool
- Autorisation de retrait d'un serveur dans la liste des serveurs accessibles par le site client.
- autoriser_boussole_ajouterdansclient_dist() : bool
- Autorisation d'ajout d'une boussole dans la base d'un client.
- autoriser_boussole_modifierdansserveur_dist() : bool
- Autorisation de modifier l'affichage d'une boussole, à savoir, l'ordre des groupes et des sites, la visibilité des sites.
- autoriser_boussole_importer_dist() : bool
- Autorisation d'importer les sites d'une boussole dans la liste des sites référencés.
- autoriser_boussole_servir_dist() : bool
- Autorisation pour un site de répondre aux requêtes des clients.
- boussole_cache_configurer() : array<string|int, mixed>
- Renvoie la configuration spécifique des caches gérés par Boussole.
- formulaires_configurer_boussole_serveur_charger() : array<string|int, mixed>
- Chargement des données : le formulaire permet d'activer la fonction serveur et d'en saisir l'identifiant.
- formulaires_configurer_boussole_serveur_verifier() : array<string|int, mixed>
- Vérification des saisies : si on active la fonction serveur, il est obligatoire de saisir un identifiant et que celui-ci soit différent du serveur spip si on est sur un site différent.
- formulaires_declarer_serveur_boussole_verifier_dist() : array<string|int, mixed>
- Vérification des saisies : - l'url est non vide, - bien formée, - ne correspond pas à celui de spip - et que le serveur désigné fourni bien au moins une boussole.
- formulaires_declarer_serveur_boussole_traiter_dist() : array<string|int, mixed>
- Exécution de l'action du formulaire : déclaration du serveur de boussoles.
- formulaires_editer_boussole_charger() : array<string|int, mixed>
- Chargement des données : le formulaire affiche les sites de la boussole, classés par groupe.
- formulaires_editer_boussole_traiter() : array<string|int, mixed>
- Exécution de l'action du formulaire : chaque action sur la boussole est enregistrée dans la base de données.
- formulaires_importer_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_importer_boussole_verifier_dist() : array<string|int, mixed>
- Vérification des saisies : si on active la fonction serveur, il est obligatoire de saisir un identifiant et que celui-ci soit différent du serveur spip si on est sur un site différent.
- formulaires_importer_boussole_traiter_dist() : array<string|int, mixed>
- Exécution de l'action du formulaire : les sites de la boussole choisie sont importés dans la base.
- importer_sites_boussole() : int
- Importe les sites d'une boussole dans une rubrique donnée.
- genie_boussole_actualiser_client_dist() : int
- Ce CRON permet mettre à jour les boussoles.
- boussole_taches_generales_cron() : array<string|int, mixed>
- Activation du CRON de mise à jour des statistiques de plugins.
Functions
boussole_autoriser()
boussole_autoriser( $flux) : mixed
Parameters
autoriser_boussole_dist()
Autorisation minimale d'utiliser le plugin Boussole.
autoriser_boussole_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
- il faut être admin complet
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussoles_voir_dist()
Autorisation de voir la liste des boussoles et des serveurs.
autoriser_boussoles_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
- il faut avoir l'autorisation minimale d'utiliser la Boussole
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_voir_dist()
Autorisation de voir la page d'une boussole.
autoriser_boussole_voir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
- il faut avoir l'autorisation minimale d'utiliser la Boussole
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_declarerserveur_dist()
Autorisation d'ajout d'un serveur dans la liste des serveurs accessibles par le site client.
autoriser_boussole_declarerserveur_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_retirerserveur_dist()
Autorisation de retrait d'un serveur dans la liste des serveurs accessibles par le site client.
autoriser_boussole_retirerserveur_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_ajouterdansclient_dist()
Autorisation d'ajout d'une boussole dans la base d'un client.
autoriser_boussole_ajouterdansclient_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_modifierdansserveur_dist()
Autorisation de modifier l'affichage d'une boussole, à savoir, l'ordre des groupes et des sites, la visibilité des sites.
autoriser_boussole_modifierdansserveur_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Cette configuration est associée à la boussole pour le serveur et sera renvoyée aux sites client demandeurs.
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_importer_dist()
Autorisation d'importer les sites d'une boussole dans la liste des sites référencés.
autoriser_boussole_importer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
autoriser_boussole_servir_dist()
Autorisation pour un site de répondre aux requêtes des clients.
autoriser_boussole_servir_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Pour cela:
- le plugins REST Factory doit être activé
- le mode serveur doit être actif sur le site.
Parameters
- $faire : string
-
Action demandée
- $type : string
-
Type d'objet sur lequel appliquer l'action
- $id : int
-
Identifiant de l'objet
- $qui : array<string|int, mixed>
-
Description de l'auteur demandant l'autorisation
- $opt : array<string|int, mixed>
-
Options de cette autorisation
Return values
bool —true s'il a le droit, false sinon
boussole_cache_configurer()
Renvoie la configuration spécifique des caches gérés par Boussole.
boussole_cache_configurer(string $plugin) : array<string|int, mixed>
Parameters
- $plugin : string
-
Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
Return values
array<string|int, mixed> —Tableau de la configuration brute du plugin.
formulaires_configurer_boussole_serveur_charger()
Chargement des données : le formulaire permet d'activer la fonction serveur et d'en saisir l'identifiant.
formulaires_configurer_boussole_serveur_charger() : array<string|int, mixed>
Return values
array<string|int, mixed> —Le tableau des données à charger par le formulaire et l'indicateur éditable qui est mis à false si le plugin REST Factory n'est pas actif.
formulaires_configurer_boussole_serveur_verifier()
Vérification des saisies : si on active la fonction serveur, il est obligatoire de saisir un identifiant et que celui-ci soit différent du serveur spip si on est sur un site différent.
formulaires_configurer_boussole_serveur_verifier() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>formulaires_declarer_serveur_boussole_verifier_dist()
Vérification des saisies : - l'url est non vide, - bien formée, - ne correspond pas à celui de spip - et que le serveur désigné fourni bien au moins une boussole.
formulaires_declarer_serveur_boussole_verifier_dist() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>formulaires_declarer_serveur_boussole_traiter_dist()
Exécution de l'action du formulaire : déclaration du serveur de boussoles.
formulaires_declarer_serveur_boussole_traiter_dist() : array<string|int, mixed>
Tags
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.
formulaires_editer_boussole_charger()
Chargement des données : le formulaire affiche les sites de la boussole, classés par groupe.
formulaires_editer_boussole_charger(string $boussole) : array<string|int, mixed>
Il est possible de cacher un site, changer son rang voire changer le rang d'un groupe.
Parameters
- $boussole : string
-
Identifiant de la boussole
Return values
array<string|int, mixed> —Le tableau des données à charger par le formulaire :
- 'alias' : l'identifiant de la boussole à éditer
formulaires_editer_boussole_traiter()
Exécution de l'action du formulaire : chaque action sur la boussole est enregistrée dans la base de données.
formulaires_editer_boussole_traiter(string $boussole) : array<string|int, mixed>
Parameters
- $boussole : string
-
Identifiant de la boussole
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.
formulaires_importer_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_importer_boussole_charger_dist() : array<string|int, mixed>
Return values
array<string|int, mixed> —Le tableau des données à charger par le formulaire :
formulaires_importer_boussole_verifier_dist()
Vérification des saisies : si on active la fonction serveur, il est obligatoire de saisir un identifiant et que celui-ci soit différent du serveur spip si on est sur un site différent.
formulaires_importer_boussole_verifier_dist() : array<string|int, mixed>
Return values
array<string|int, mixed> —Le tableau des messages d'erreur ou vide si ok.
formulaires_importer_boussole_traiter_dist()
Exécution de l'action du formulaire : les sites de la boussole choisie sont importés dans la base.
formulaires_importer_boussole_traiter_dist() : array<string|int, mixed>
Tags
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.
importer_sites_boussole()
Importe les sites d'une boussole dans une rubrique donnée.
importer_sites_boussole(string $boussole, int $id_parent[, null|bool $langue_site = true ][, null|bool $forcer_statut_publie = false ]) : int
Parameters
- $boussole : string
-
Identifiant de la boussole
- $id_parent : int
-
Id de la rubrique parente
- $langue_site : null|bool = true
-
Indique que seule la langue du site est importée
- $forcer_statut_publie : null|bool = false
-
Indique que le statut des sites créés est forcé à publié
Tags
Return values
int —Nombre de sites importés.
genie_boussole_actualiser_client_dist()
Ce CRON permet mettre à jour les boussoles.
genie_boussole_actualiser_client_dist(int $last) : int
Parameters
- $last : int
-
Timestamp de la date de dernier appel de la tâche.
Tags
Return values
int —Retour de la fonction toujours à 1
boussole_taches_generales_cron()
Activation du CRON de mise à jour des statistiques de plugins.
boussole_taches_generales_cron(array<string|int, mixed> $taches_generales) : array<string|int, mixed>
Parameters
- $taches_generales : array<string|int, mixed>
-
Liste des taches à compléter
Return values
array<string|int, mixed> —Liste des taches mise à jour