Documentation du code de SPIP et de ses plugins

Check Factory

ezcheck_autorisations.php

Ce fichier contient les fonctions d'autorisations du plugin.

Table of Contents

Functions

ezcheck_autoriser()  : mixed
Fonction appelée par le pipeline.
autoriser_ezcheck_dist()  : bool
Autorisation minimale d'accès à toutes les pages du plugin Check Factory sauf celle de configuration du plugin lui-même (controles, dashboard).
autoriser_ezcheck_menu_dist()  : bool
Autorisation d'affichage du menu d'accès aux dashboards (page=ezcheck).
autoriser_ezcheck_configurer_dist()  : bool
Autorisation d'accès à la page de configuration du plugin Check Factory (page=configurer_ezcheck).
autoriser_dashboard_voir_dist()  : bool
Autorisation d'afficher la page d'un dashboard donné. A partir de cette page il est possible de visualiser les contrôles et les anomalies, d'exécuter un contrôle manuellement, lancer une action corrective.
autoriser_typecontrole_modifier_dist()  : bool
Autorisation d'activation et de désactivation des types de contrôle.
autoriser_typecontrole_executer_dist()  : bool
Autorisation d'exécution d'un type de contrôle.
autoriser_typecontrole_cloturer_dist()  : bool
Autorisation de cloture ou de mise à la poubelle des observations fermées d'un type de contrôle.
autoriser_observation_instituer_dist()  : bool
Autorisation de changement de statut d'une observation.

Functions

autoriser_ezcheck_dist()

Autorisation minimale d'accès à toutes les pages du plugin Check Factory sauf celle de configuration du plugin lui-même (controles, dashboard).

autoriser_ezcheck_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Par défaut, seuls les administrateurs complets sont autorisés à utiliser ces pages. Cette autorisation est à la base de la plupart des autres autorisations du plugin.

Parameters
$faire : string

L'action : ezcheck

$type : string

Le type d'objet ou nom de table : chaine vide

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_ezcheck_menu_dist()

Autorisation d'affichage du menu d'accès aux dashboards (page=ezcheck).

autoriser_ezcheck_menu_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être autorisé à utiliser ezcheck.

Parameters
$faire : string

L'action : menu

$type : string

Le type d'objet ou nom de table : ezcheck (ce n'est pas un objet au sens SPIP)

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_ezcheck_configurer_dist()

Autorisation d'accès à la page de configuration du plugin Check Factory (page=configurer_ezcheck).

autoriser_ezcheck_configurer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut être autorisé :

  • à utiliser le plugin
  • et avoir l'autorisation stabdard de configuration.
Parameters
$faire : string

L'action : configurer

$type : string

Le type d'objet ou nom de table : ezcheck (ce n'est pas un objet au sens SPIP)

$id : int

Id de l'objet sur lequel on veut agir : 0, inutilisé

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_dashboard_voir_dist()

Autorisation d'afficher la page d'un dashboard donné. A partir de cette page il est possible de visualiser les contrôles et les anomalies, d'exécuter un contrôle manuellement, lancer une action corrective.

autoriser_dashboard_voir_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool
  • être autorisé à utiliser Check Factory,
  • que l'identifiant du dashboard soit connu.
Parameters
$faire : string

L'action : voir

$type : string

Le type d'objet ou nom de table : dashboard (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du dashboard sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_typecontrole_modifier_dist()

Autorisation d'activation et de désactivation des types de contrôle.

autoriser_typecontrole_modifier_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à configurer Check Factory
  • que le type de contrôle soit bien chargé
  • et qu'il ne soit pas un état.
Parameters
$faire : string

L'action : modifier

$type : string

Le type d'objet ou nom de table : typecontrole (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du type de contrôle sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_typecontrole_executer_dist()

Autorisation d'exécution d'un type de contrôle.

autoriser_typecontrole_executer_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à utiliser Check Factory
  • que le type de contrôle soit bien chargé, actif et que ce ne soit pas un état
  • et que soit la fonction de contrôle existe.
Parameters
$faire : string

L'action : executer

$type : string

Le type d'objet ou nom de table : typecontrole (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du type de contrôle sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : null, inutilisé

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_typecontrole_cloturer_dist()

Autorisation de cloture ou de mise à la poubelle des observations fermées d'un type de contrôle.

autoriser_typecontrole_cloturer_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à exécuter le type de contrôle.
Parameters
$faire : string

L'action : cloturer

$type : string

Le type d'objet ou nom de table : typecontrole (ce n'est pas un objet au sens SPIP)

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant du type de contrôle sous forme d'une chaine. C'est un détournement de l'utilisation habituelle pour un objet.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : action, action de cloture parmi acquitter, corriger ou supprimer

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.

autoriser_observation_instituer_dist()

Autorisation de changement de statut d'une observation.

autoriser_observation_instituer_dist(string $faire, string $type, int|string $id, null|array<string|int, mixed>|int $qui, null|array<string|int, mixed> $options) : bool

Il faut :

  • être autorisé à utiliser Check Factory,
  • que l'observation existe,
  • que l'action soit fournie et corresponde à corriger, acquitter ou supprimer.
Parameters
$faire : string

L'action : instituer

$type : string

Le type d'objet ou nom de table : observation

$id : int|string

Id de l'objet sur lequel on veut agir : identifiant numérique de l'observation.

$qui : null|array<string|int, mixed>|int

L'initiateur de l'action:

  • si null on prend alors visiteur_session
  • un id_auteur (on regarde dans la base)
  • un tableau auteur complet, y compris [restreint]
$options : null|array<string|int, mixed>

Tableau d'options sous forme de tableau associatif : index action qui mène au changement de statut.

Return values
bool

truesi l'auteur est autorisée à exécuter l'action, false sinon.


        
On this page

Search results