Documentation du code de SPIP et de ses plugins

Boussole

boussole_autorisations.php

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.

Functions

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


        
On this page

Search results