Documentation du code de SPIP et de ses plugins

Palette Factory

ezpalette_autorisations.php

Ce fichier contient les fonctions d'autorisation du plugin.

Deux familles s'y côtoient, distinguées par le préfixe de leur type :

  • les autorisations sur les pages, dont le type commence par un souligné — _palettes, _palettecollections — qui ne sont pas des objets au sens de SPIP ;
  • les autorisations sur l'objet palette lui-même, qui suivent la nomenclature standard autoriser_palette_<action>_dist().
Tags
note

C'est ici, et non dans la déclaration de la table, que les palettes standard sont protégées. La déclaration dit que le type palette est éditable ; l'autorisation vérifie que cette palette l'est, en consultant sa colonne editable. Une palette issue d'une collection standard est rechargée depuis son fichier JSON : toute modification en base serait perdue au prochain chargement, la refuser est donc une protection et non une restriction de confort.

Table of Contents

Functions

ezpalette_autoriser()  : void
Fonction appelée par le pipeline `autoriser`, dont la seule existence déclare le fichier.
autoriser_palettes_voir_dist()  : bool
Autorisation d'accéder à la page des palettes.
autoriser_palettes_menu_dist()  : bool
Autorisation d'afficher l'entrée de menu du plugin, calée sur celle de voir la page.
autoriser_palettecollections_voir_dist()  : bool
Autorisation de voir la liste des collections de palettes.
autoriser_palettecollections_charger_dist()  : bool
Autorisation de recharger les collections standard depuis leurs fichiers JSON.
autoriser_palette_voir_dist()  : bool
Autorisation de voir une palette.
autoriser_palette_creer_dist()  : bool
Autorisation de créer une palette.
autoriser_palette_modifier_dist()  : bool
Autorisation de modifier une palette.
autoriser_palette_supprimer_dist()  : bool
Autorisation de supprimer une palette, calée sur celle de la modifier.

Functions

ezpalette_autoriser()

Fonction appelée par le pipeline `autoriser`, dont la seule existence déclare le fichier.

ezpalette_autoriser() : void

autoriser_palettes_voir_dist()

Autorisation d'accéder à la page des palettes.

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

L'action : voir

$type : string

Le type : _palettes, qui n'est pas un objet au sens de SPIP

$id : int

Inutilisé

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

autoriser_palettes_menu_dist()

Autorisation d'afficher l'entrée de menu du plugin, calée sur celle de voir la page.

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

L'action : menu

$type : string

Le type : _palettes

$id : int

Inutilisé

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

autoriser_palettecollections_voir_dist()

Autorisation de voir la liste des collections de palettes.

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

L'action : voir

$type : string

Le type : _palettecollections

$id : int

Inutilisé

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

autoriser_palettecollections_charger_dist()

Autorisation de recharger les collections standard depuis leurs fichiers JSON.

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

L'opération vide et réécrit la table pour les collections concernées : elle est réservée aux administrateurs complets. Jusqu'ici l'autorisation n'était pas déclarée et le contrôle ne tenait qu'à la retombée sur autoriser_defaut_dist(), ce qui produisait le bon résultat mais par accident.

Parameters
$faire : string

L'action : charger

$type : string

Le type : _palettecollections

$id : int

Inutilisé

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

autoriser_palette_voir_dist()

Autorisation de voir une palette.

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

L'action : voir

$type : string

Le type d'objet : palette

$id : int

Identifiant de la palette

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

autoriser_palette_creer_dist()

Autorisation de créer une palette.

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

L'action : creer

$type : string

Le type d'objet : palette

$id : int

Inutilisé

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

autoriser_palette_modifier_dist()

Autorisation de modifier une palette.

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

Une palette n'est modifiable que si sa collection ne l'est pas elle-même rechargée depuis un fichier JSON, ce que porte sa colonne editable.

Parameters
$faire : string

L'action : modifier

$type : string

Le type d'objet : palette

$id : int

Identifiant de la palette

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

L'initiateur de l'action

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

Options éventuelles

Tags
uses
palette_lire()
Return values
bool

autoriser_palette_supprimer_dist()

Autorisation de supprimer une palette, calée sur celle de la modifier.

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

L'action : supprimer

$type : string

Le type d'objet : palette

$id : int

Identifiant de la palette

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

L'initiateur de l'action

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

Options éventuelles

Return values
bool

        
On this page

Search results