SPIP Code

Documentation du code de SPIP et de ses plugins

noiZetier

noizetier_autorisations.php

Table of Contents

Functions

noizetier_autoriser()  : mixed
Fonction appelée par le pipeline.
autoriser_noizetier_dist()  : bool
Autorisation minimale d'accès à toutes les pages du noiZetier sauf celle de configuration du plugin lui-même.
autoriser_noizetier_menu_dist()  : bool
Autorisation d'affichage du menu d'accès à la configuration du noiZetier (page=noizetier_pages).
autoriser_noizetier_configurer_dist()  : bool
Autorisation d'accès à la page de configuration du plugin noiZetier (page=configurer_noizetier).
autoriser_noizetier_configurerpage_dist()  : bool
Autorisation de configuration d'une page ou d'un objet du noiZetier (page=noizetier_page).
autoriser_noizetier_activercomposition_dist()  : bool
Autorisation d'activation des compositions sur un type d'objet. Permet de lancer l'action depuis le noiZetier sans passer par la configuration du plugin Compositions.
autoriser_noizetier_creercomposition_dist()  : bool
Autorisation de création d'une composition virtuelle du noiZetier à partir d'une page source (page=noizetier_page_edit).
autoriser_noizetier_supprimercomposition_dist()  : bool
Autorisation de suppression d'une composition virtuelle du noiZetier.
autoriser_noizetier_modifierpage_dist()  : bool
Autorisation de modification certains paramètres d'une page (page=noizetier_page_edit). Suivant que la page est une page explicite ou une composition virtuelle la liste des paramètres éditables varie.
autoriser_noizetier_dupliquercomposition_dist()  : bool
Autorisation de copie d'une composition pour créer une composition virtuelle du noiZetier possédant les mêmes caractéristiques (page=noizetier_page_edit).
autoriser_noisette_editer()  : bool
Autorisation d'édition d'une noisette déjà ajoutée dans le bloc d'une page ou d'un contenu (page=noisette_edit).

Functions

autoriser_noizetier_dist()

Autorisation minimale d'accès à toutes les pages du noiZetier sauf celle de configuration du plugin lui-même.

autoriser_noizetier_dist( $faire,  $type,  $id,  $qui,  $options) : bool

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

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_menu_dist()

Autorisation d'affichage du menu d'accès à la configuration du noiZetier (page=noizetier_pages).

autoriser_noizetier_menu_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut être autorisé à configurer le noiZetier.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_configurer_dist()

Autorisation d'accès à la page de configuration du plugin noiZetier (page=configurer_noizetier).

autoriser_noizetier_configurer_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Par défaut, seuls les webmestres sont autorisés à modifier la configuration du noiZetier et en particulier la liste des pages accessibles par les autres utilisateurs.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_configurerpage_dist()

Autorisation de configuration d'une page ou d'un objet du noiZetier (page=noizetier_page).

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

La configuration consiste dans tous les cas à manipuler les noisettes des divers blocs de la page et si la page est une composition virtuelle à éditer ses caractéristiques (page=noizetier_page_edit). Il faut :

  • être autorisé à configurer le noiZetier,
  • que la page ou l'objet existe et soit bien accessible pour le noiZetier (i.e. plugin Compositions actif si on est en présence d'une composition),
  • et que :
    • si on est en présence d'un objet, son type soit bien activé dans la configuration,
    • ou que si on est en présence d'une composition basée sur un type d'objet, celui-ci soit bien activé.
Parameters
$faire : string

L'action se nomme configurerpage

$type : null|string

Le type est toujours noizetier.

$id : null|int|string

Inutilisé car l'identifiant représente soit la page soit l'objet (forcer null)

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

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page ou de l'objet concerné sous la forme d'un tableau associatif dont les index sont 'page' ou 'objet' et 'id_objet'.

Return values
bool

autoriser_noizetier_activercomposition_dist()

Autorisation d'activation des compositions sur un type d'objet. Permet de lancer l'action depuis le noiZetier sans passer par la configuration du plugin Compositions.

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

Il faut :

  • être autorisé à configurer le noiZetier
  • que la page source existe et ne soit pas une composition
  • que le plugin Compositions soit bien activé
  • que l'utilisateur soit autorisé à configurer le plugin Compositions
  • et que la page soit celle d'un type d'objet et que les compositions ne soient pas déjà activées.
Parameters
$faire : string

L'action se nomme activercomposition

$type : null|string

Le type est toujours noizetier.

$id : null|int|string

Inutilisé car l'identifiant représente soit la page (forcer null)

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

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page concernée sous la forme d'un tableau associatif dont l'index 'page'.

Return values
bool

autoriser_noizetier_creercomposition_dist()

Autorisation de création d'une composition virtuelle du noiZetier à partir d'une page source (page=noizetier_page_edit).

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

Il faut :

  • être autorisé à configurer le noiZetier
  • que la page source existe et ne soit pas une composition
  • que le plugin Compositions soit bien activé
  • et que si la page est celle d'un type d'objet, que les compositions soient bien activées.
Parameters
$faire : string

L'action se nomme creercomposition

$type : null|string

Le type est toujours noizetier.

$id : null|int|string

Inutilisé car l'identifiant représente soit la page (forcer null)

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

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page concernée sous la forme d'un tableau associatif dont l'index 'page'.

Return values
bool

autoriser_noizetier_supprimercomposition_dist()

Autorisation de suppression d'une composition virtuelle du noiZetier.

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

Il faut :

  • être autorisé à configurer la page concernée (pour la suppression des noisettes)
  • et que la page existe toujours et soit bien une composition virtuelle.
Parameters
$faire : string

L'action se nomme supprimercomposition

$type : null|string

Le type est toujours noizetier.

$id : null|int|string

Inutilisé car l'identifiant représente soit la page (forcer null)

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

Inutilisé, l'API utilise l'auteur connecté (forcer null)

$options : array<string|int, mixed>

Permet de passer les identifiants de la page concernée sous la forme d'un tableau associatif dont l'index 'page'.

Return values
bool

autoriser_noizetier_modifierpage_dist()

Autorisation de modification certains paramètres d'une page (page=noizetier_page_edit). Suivant que la page est une page explicite ou une composition virtuelle la liste des paramètres éditables varie.

autoriser_noizetier_modifierpage_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut être autorisé à configurer la page.

Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noizetier_dupliquercomposition_dist()

Autorisation de copie d'une composition pour créer une composition virtuelle du noiZetier possédant les mêmes caractéristiques (page=noizetier_page_edit).

autoriser_noizetier_dupliquercomposition_dist( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut :

  • être autorisé à configurer le noiZetier
  • que la page source existe et soit une composition
  • et que le plugin Compositions soit bien activé.
Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool

autoriser_noisette_editer()

Autorisation d'édition d'une noisette déjà ajoutée dans le bloc d'une page ou d'un contenu (page=noisette_edit).

autoriser_noisette_editer( $faire,  $type,  $id,  $qui,  $options) : bool

Il faut :

  • ne pas être dans un mode de migration des noisettes (du à un upgrade des tables du plugin)
  • que la noisette existe bien,
  • et être autorisé à configurer la page ou le contenu auquel est rattachée la noisette.
Parameters
$faire :
$type :
$id :
$qui :
$options :
Return values
bool 

        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results