Documentation du code de SPIP et de ses plugins

Mashup Factory

ezmashup_autorisations.php

Ce fichier contient les fonctions d'autorisations du plugin.

Table of Contents

Functions

ezmashup_autoriser()  : mixed
Fonction appelée par le pipeline.
autoriser_ezmashup_dist()  : bool
Autorisation minimale d'accès à toutes les pages du plugin Mashup Factory ou d'un plugin utilisateur.
autoriser_feeds_voir_dist()  : bool
Autorisation de voir la liste des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).
autoriser_feeds_charger_dist()  : bool
Autorisation de charger ou décharger les feeds d'un plugin utilisateur dans la table `spip_feeds`.
autoriser_feed_executer_dist()  : bool
Autorisation de peupler ou de vider le dataset cible d'un feed.
autoriser_feed_creer_dist()  : bool
Autorisation de créer des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).
autoriser_feed_modifier_dist()  : bool
Autorisation, pour les feeds éditables, de supprimer ou d'éditer un feed.

Functions

autoriser_ezmashup_dist()

Autorisation minimale d'accès à toutes les pages du plugin Mashup Factory ou d'un plugin utilisateur.

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

Il faut :

  • fournir un préfixe valide de plugin actif.
  • éventuellement, avoir une autorisation d'accès spécifique (service propre au plugin) Par défaut, en l'absence de personnalisation par un plugin, Mashup Factory limite l'autorisation aux administrateurs complets.

Cette autorisation est à la base des autres autorisations du plugin. Il n'est jamais utile de l'appeler dans une fonction autre que les autorisations dérivées.

Parameters
$faire : string

L'action : ezmashup

$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 : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool

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

autoriser_feeds_voir_dist()

Autorisation de voir la liste des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).

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

Il faut :

  • posséder l'autorisation minimale ezmashup
  • éventuellement, avoir une autorisation de visualisation des feeds spécifique (service propre au plugin).
Parameters
$faire : string

L'action : voir

$type : string

Le type d'objet ou nom de table : _feeds (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 : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool

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

autoriser_feeds_charger_dist()

Autorisation de charger ou décharger les feeds d'un plugin utilisateur dans la table `spip_feeds`.

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

Il faut :

  • posséder l'autorisation minimale ezmashup.
  • éventuellement, avoir une autorisation de chargement spécifique (service propre au plugin)
Parameters
$faire : string

Action demandée : charger

$type : string

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

$id : int

Identifiant de l'objet : 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 : plugin, préfixe du plugin utilisateur

Return values
bool

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

autoriser_feed_executer_dist()

Autorisation de peupler ou de vider le dataset cible d'un feed.

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

Il faut :

  • posséder l'autorisation minimale ezmashup
  • fournir un identifiant de feed existant
  • que le feed soit actif
  • et éventuellement, avoir une autorisation d'exécution spécifique (service propre au plugin)
Parameters
$faire : string

Action demandée : executer (pour peupler, vider)

$type : string

Type d'objet sur lequel appliquer l'action : feed

$id : int

Identifiant de l'objet : celui du feed sur lequel appliquer l'action

$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 : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool

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

autoriser_feed_creer_dist()

Autorisation de créer des feeds (page feeds ou autre page spécifique d'un plugin utilisateur).

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

Il faut :

  • posséder l'autorisation minimale ezmashup.
  • éventuellement, avoir une autorisation de création spécifique (service propre au plugin)

Par défaut, Mashup Factory renvoie false pour cette autorisation.

Parameters
$faire : string

L'action : creer

$type : string

Le type d'objet ou nom de table : feed (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 : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool

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

autoriser_feed_modifier_dist()

Autorisation, pour les feeds éditables, de supprimer ou d'éditer un feed.

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

Il faut :

  • posséder l'autorisation minimale ezmashup
  • fournir un identifiant de feed existant
  • que le feed soit actif et éditable
  • et éventuellement, avoir une autorisation de modification spécifique (service propre au plugin)

Par défaut, Mashup Factory renvoie false pour cette autorisation.

Parameters
$faire : string

Action demandée : modifier (pour éditer ou supprimer)

$type : string

Type d'objet sur lequel appliquer l'action : feed

$id : int

Identifiant de l'objet : celui du feed sur lequel appliquer l'action

$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 : plugin, préfixe du plugin utilisateur

Tags
uses
ezmashup_plugin_autoriser()
Return values
bool

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


        
On this page

Search results