Documentation du code de SPIP et de ses plugins

Albums

Autorisations

Table of Contents

Functions

albums_autoriser()  : mixed
Fonction d'appel pour le pipeline
autoriser_albumcreer_menu_dist()  : bool
Autorisation à afficher l'icone de création rapide.
autoriser_albums_menu_dist()  : bool
Autorisation de voir les albums dans le menu d'édition.
autoriser_album_creer_dist()  : bool
Autorisation de créer un album
autoriser_album_voir_dist()  : bool
Autorisation à voir un album
autoriser_albumotheque_administrer_dist()  : bool
Autorisation à accéder à l'albumothèque.
autoriser_ajouteralbum_dist()  : bool
Autorisation d'ajouter un album, optionnellement en le liant à un objet.
autoriser_album_modifier_dist()  : bool
Autorisation à modifier un album.
autoriser_album_supprimer_dist()  : bool
Autorisation à supprimer définitivement un album.
autoriser_album_associer_dist()  : bool
Autorisation à associer un album à un objet donné.
autoriser_album_dissocier_dist()  : bool
Autorisation à dissocier un album d'un objet donné.
autoriser_dissocieralbums_dist()  : bool
Autorisation à dissocier *tous* les albums d'un objet donné.
autoriser_autoassocieralbum_dist()  : bool
Auto-association d'albums à du contenu éditorial qui le référence.
autoriser_album_vider_dist()  : bool
Autorisation de vider un album
tester_autorisation_album()  : bool
Différents tests utiles aux autorisations des albums
tester_album_wiki()  : bool
Teste si un album se trouve dans un secteur wiki auquel on a accès (plugin autorité)

Functions

autoriser_albumcreer_menu_dist()

Autorisation à afficher l'icone de création rapide.

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

Il faut être autorisé à créer un album.

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
autoriser_album_creer_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_albums_menu_dist()

Autorisation de voir les albums dans le menu d'édition.

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

Il faut être autorisé à administrer les albums.

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
autoriser_albums_administrer_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_creer_dist()

Autorisation de créer un album

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

Il faut être admin ou rédacteur.

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
used-by
autoriser_albumcreer_menu_dist()
used-by
autoriser_ajouteralbum_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_voir_dist()

Autorisation à voir un album

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

Open bar pour tout le monde.

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

$options : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_albumotheque_administrer_dist()

Autorisation à accéder à l'albumothèque.

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

Il faut être admin ou rédacteur.

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_ajouteralbum_dist()

Autorisation d'ajouter un album, optionnellement en le liant à un objet.

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

Cette autorisation est prévue pour le formulaire ajouter_album.

Il faut avoir le droit de créer un album, et si un objet est indiqué, que l'ajout d'albums soit activé sur ce type, et avoir le droit de modifier l'objet ou être admin complet.

Parameters
$faire : string

Action demandée

$type : string

Type d'objet à lier à l'album (optionnel)

$id : int

Identifiant de l'objet à lier à l'album

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$options : array<string|int, mixed>

Options de cette autorisation

Tags
example
#AUTORISER{ajouteralbum}
#AUTORISER{ajouteralbum, #OBJET, #ID_OBJET}
uses
tester_autorisation_album()
uses
autoriser_album_creer_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_modifier_dist()

Autorisation à modifier un album.

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

Il faut être l'auteur ou admin complet, ou si plugin autorité, que l'album soit dans un secteur wiki

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
staticvar

$autorisations

Return values
bool

true s'il a le droit, false sinon

autoriser_album_supprimer_dist()

Autorisation à supprimer définitivement un album.

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

Il faut avoir le droit de le modifier et qu'il soit à la poubelle, ou vide et inutilisé.

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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_associer_dist()

Autorisation à associer un album à un objet donné.

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

Il faut pouvoir modifier l'objet ou être admin complet

Parameters
$faire : string

Action demandée

$type : string

Type d'objet auquel on veut associer ou dissocier un album

$id : int

Identifiant de l'objet auquel on veut associer ou dissocier un album

$qui : array<string|int, mixed>

Description de l'auteur demandant l'autorisation

$options : array<string|int, mixed>

Options de cette autorisation Doit contenir les clés objet et id_objet pour rensigner le type et l'identifiant de l'objet

Tags
note

Les infos sur l'objet dont dans les options (5ème paramètre)

example
#AUTORISER{associer,album,#ID_ALBUM,'',#ARRAY{objet,#OBJET,id_objet,#ID_OBJET}}
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_album_dissocier_dist()

Autorisation à dissocier un album d'un objet donné.

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

Il faut pouvoir modifier l'objet ou être admin complet, et que l'album ne soit pas inséré dans le texte.

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

$options : array<string|int, mixed>

Options de cette autorisation Doit contenir les clés objet et id_objet pour renseigner le type et l'identifiant de l'objet

Tags
note

Les infos sur l'objet dont dans les options (5ème paramètre)

example
#AUTORISER{dissocier,album,#ID_ALBUM,'',#ARRAY{objet,#OBJET,id_objet,#ID_OBJET}}
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_dissocieralbums_dist()

Autorisation à dissocier *tous* les albums d'un objet donné.

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

Il faut plusieurs albums liés, et pouvoir modifier l'objet ou ê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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
example
#AUTORISER{dissocieralbums,#OBJET,#ID_OBJET}
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

autoriser_autoassocieralbum_dist()

Auto-association d'albums à du contenu éditorial qui le référence.

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

Par défaut true pour tous les objets.

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

$options : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_album_vider_dist()

Autorisation de vider un album

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

Il faut qu'il y ait des documents, et ê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

$options : array<string|int, mixed>

Options de cette autorisation

Tags
uses
tester_autorisation_album()
Return values
bool

true s'il a le droit, false sinon

tester_autorisation_album()

Différents tests utiles aux autorisations des albums

tester_autorisation_album(string $test, array<string|int, mixed> $args) : bool
Parameters
$test : string
$args : array<string|int, mixed>
Tags
used-by
autoriser_album_creer_dist()
used-by
autoriser_albumotheque_administrer_dist()
used-by
autoriser_ajouteralbum_dist()
used-by
autoriser_album_modifier_dist()
used-by
autoriser_album_supprimer_dist()
used-by
autoriser_album_associer_dist()
used-by
autoriser_album_dissocier_dist()
used-by
autoriser_dissocieralbums_dist()
used-by
autoriser_album_vider_dist()
Return values
bool

tester_album_wiki()

Teste si un album se trouve dans un secteur wiki auquel on a accès (plugin autorité)

tester_album_wiki(int $id_album, array<string|int, mixed> $qui) : bool
Parameters
$id_album : int
$qui : array<string|int, mixed>
Tags
note

Il faudrait une fonction générique dans autorité.

Return values
bool

        
On this page

Search results