Documentation du code de SPIP et de ses plugins

Pense-bêtes

Documentation

Packages

SPIP
Application

Table of Contents

action_editer_pensebete_dist()  : array<string|int, mixed>
Action de création / modification d'un pense-bête
pensebete_inserer()  : int
Crée un nouveau pense-bête et retourne son ID
pensebete_modifier()  : string
Modifie les données d'un pense-bête
action_poser_pensebete_dist()  : void
Action pour poser un Pense-bête depuis l'espace public
action_supprimer_pensebete_dist()  : void
Action pour supprimer un Pense-bête
pensebetes_declarer_tables_objets_sql()  : array<string|int, mixed>
Declaration de l'objet éditorial pensebetes
pensebetes_declarer_tables_auxiliaires()  : array<string|int, mixed>
Declaration de la table de liaison de l'objet éditorial pensebetes
pensebetes_declarer_tables_interfaces()  : array<string|int, mixed>
Interfaces de la table pensebetes
formulaires_configurer_pensebetes_saisies_dist()  : mixed
Un simple formulaire de config, on a juste à déclarer les saisies
formulaires_editer_pensebete_saisies_dist()  : mixed
Chargement des valeurs de SAISIES
formulaires_editer_pensebete_charger_dist()  : mixed
Chargement du formulaire d'édition de pensebete
formulaires_editer_pensebete_identifier_dist()  : mixed
Identifier le formulaire en faisant abstraction des parametres qui ne representent pas l'objet edite
formulaires_editer_pensebete_verifier_dist()  : mixed
Vérification du formulaire d'édition de pensebete
formulaires_editer_pensebete_traiter_dist()  : mixed
Traitement du formulaire d'édition de pensebete
pensebetes_upgrade()  : void
Création et mise à jour du plugin Pensebetes
pensebetes_vider_tables()  : void
Faire le ménage lors de la désinstallation du plugin Pensebetes
cfg_1_0_2()  : void
Fonction privée : remplacer les noms d'objet par les noms de table
cfg_1_0_4()  : void
Fonction privée : remplacer les valeurs d’id_objet à zéro
pensebetes_autoriser()  : mixed
Fonction d'appel pour le pipeline
autoriser_associerpensebetes_dist()  : bool
Autorisation d'associer un pensebete
autoriser_pensebetes_menu_dist()  : bool
Autorisation de voir un élément de menu (pensebetes)
autoriser_pensebetecreer_menu_dist()  : bool
Autorisation de voir le bouton d'accès rapide de création (pensebete)
autoriser_murs_menu_dist()  : bool
Autorisation de voir le bouton d'outil collaboratif du mur
autoriser_pensebete_creer_dist()  : bool
Autorisation de créer (pensebete)
autoriser_pensebete_voir_dist()  : bool
Autorisation de voir (pensebete)
autoriser_pensebete_modifier_dist()  : bool
Autorisation de modifier (pensebete)
autoriser_pensebete_supprimer_dist()  : bool
Autorisation de supprimer (pensebete)
pensebetes_insert_head_css()  : array<string|int, mixed>
Ajout de la feuille de style de Pensebetes, dans l'espace public si demandé Appelé aussi depuis le privé avec $prive à true.
pensebetes_insert_head_prive_css()  : string
Ajout de la CSS du Pensebetes au head privé
pensebetes_affiche_gauche()  : array<string|int, mixed>
Ajout de contenu à gauche de la page,
pensebetes_affiche_milieu()  : array<string|int, mixed>
Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets
pensebetes_quete_calendrier_prive()  : array<string|int, mixed>
Insérer des évènements dans le calendrier privé

Functions

action_editer_pensebete_dist()

Action de création / modification d'un pense-bête

action_editer_pensebete_dist([null|int $arg = null ]) : array<string|int, mixed>
Parameters
$arg : null|int = null

Identifiant du pense-bête. En absence utilise l'argument de l'action sécurisée.

Return values
array<string|int, mixed>

Liste (identifiant du pense-bête, Texte d'erreur éventuel)

pensebete_inserer()

Crée un nouveau pense-bête et retourne son ID

pensebete_inserer([mixed $id_parent = null ][, array<string|int, mixed> $champs = array() ]) : int
Parameters
$id_parent : mixed = null
$champs : array<string|int, mixed> = array()

Un tableau avec les champs par défaut lors de l'insertion

Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
int

Identifiant du pense-bête créé

pensebete_modifier()

Modifie les données d'un pense-bête

pensebete_modifier(int $id_pensebete[, null|array<string|int, mixed> $set = null ]) : string

Récupère les valeurs qui ont été postées d'un formulaire d'édition automatiquement.

Parameters
$id_pensebete : int

Identifiant du pense-bête

$set : null|array<string|int, mixed> = null

Couples de valeurs à affecter d'office

Return values
string

Vide en cas de succès, texte d'erreur sinon.

action_poser_pensebete_dist()

Action pour poser un Pense-bête depuis l'espace public

action_poser_pensebete_dist() : void

dans l'environnement le titre et le message du pensebête sont transmis mais l'émetteur et le recepteur sont dans les arguments sécurisés de l'action

Tags
uses
API

editer_pensebete

link
https://www.spip.net/fr_article5526.html
Return values
void

action_supprimer_pensebete_dist()

Action pour supprimer un Pense-bête

action_supprimer_pensebete_dist([int $id_pensebete = null ]) : void

En réalité, c'est la déclaration de l'auteur comme receveur du pense-bête qui est supprimée, ce qui fait qu'il ne s'affiche plus (pour lui). Si l'auteur était le dernier receveur, alors le pense-bête effectivement est supprimé.

Parameters
$id_pensebete : int = null

Identifiant de l'objet

Return values
void

pensebetes_declarer_tables_objets_sql()

Declaration de l'objet éditorial pensebetes

pensebetes_declarer_tables_objets_sql(array<string|int, mixed> $tables) : array<string|int, mixed>
Parameters
$tables : array<string|int, mixed>
Return values
array<string|int, mixed>

pensebetes_declarer_tables_auxiliaires()

Declaration de la table de liaison de l'objet éditorial pensebetes

pensebetes_declarer_tables_auxiliaires(array<string|int, mixed> $tables) : array<string|int, mixed>

Le plugin crée : une table de liaison pour les pense-bêtes 'spip_pensebetes_liens' une table des receveurs des pense-bêtes 'spip_pensebetes_receveurs'

Parameters
$tables : array<string|int, mixed>
Return values
array<string|int, mixed>

pensebetes_declarer_tables_interfaces()

Interfaces de la table pensebetes

pensebetes_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>
Return values
array<string|int, mixed>

formulaires_configurer_pensebetes_saisies_dist()

Un simple formulaire de config, on a juste à déclarer les saisies

formulaires_configurer_pensebetes_saisies_dist() : mixed
Return values
mixed

formulaires_editer_pensebete_saisies_dist()

Chargement des valeurs de SAISIES

formulaires_editer_pensebete_saisies_dist([mixed $id_pensebete = 'new' ][, mixed $id_parent = '' ][, mixed $retour = '' ][, mixed $associer_objet = '' ], mixed $lier_trad[, mixed $config_fonc = '' ][, mixed $row = array() ][, mixed $hidden = '' ]) : mixed

Aide à la création du formulaire avec le plugin SAISIES

Les valeurs sont calculées en fonction de la configuration mais aussi d'éventuelles autorisations qui permettent de gérer plus finement la configuration.

Parameters
$id_pensebete : mixed = 'new'
$id_parent : mixed = ''
$retour : mixed = ''
$associer_objet : mixed = ''
$lier_trad : mixed
$config_fonc : mixed = ''
$row : mixed = array()
$hidden : mixed = ''
Return values
mixed

formulaires_editer_pensebete_charger_dist()

Chargement du formulaire d'édition de pensebete

formulaires_editer_pensebete_charger_dist([int|string $id_pensebete = 'new' ][, int $id_parent = '' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, array<string|int, mixed> $hidden = '' ]) : mixed

Déclarer les champs postés et y intégrer les valeurs par défaut

Parameters
$id_pensebete : int|string = 'new'

identifiant de l'objet ou 'new' si absent.

$id_parent : int = ''

identifiant de la rubrique.

$retour : string = ''

lien pour le retour.

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$lier_trad : int
$config_fonc : string = ''
$row : array<string|int, mixed> = array()
$hidden : array<string|int, mixed> = ''
Tags
uses
formulaires_editer_objet_charger()
uses
mes_saisies_pensebete()
Return values
mixed

formulaires_editer_pensebete_identifier_dist()

Identifier le formulaire en faisant abstraction des parametres qui ne representent pas l'objet edite

formulaires_editer_pensebete_identifier_dist([int|string $id_pensebete = 'new' ][, int $id_parent = '' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, array<string|int, mixed> $hidden = '' ]) : mixed
Parameters
$id_pensebete : int|string = 'new'

identifiant de l'objet ou 'new' si absent.

$id_parent : int = ''

identifiant de la rubrique.

$retour : string = ''

lien pour le retour.

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$lier_trad : int
$config_fonc : string = ''
$row : array<string|int, mixed> = array()
$hidden : array<string|int, mixed> = ''
Return values
mixed

formulaires_editer_pensebete_verifier_dist()

Vérification du formulaire d'édition de pensebete

formulaires_editer_pensebete_verifier_dist([int|string $id_pensebete = 'new' ][, int $id_parent = '' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, array<string|int, mixed> $hidden = '' ]) : mixed
Parameters
$id_pensebete : int|string = 'new'

identifiant de l'objet ou 'new' si absent.

$id_parent : int = ''

identifiant de la rubrique.

$retour : string = ''

lien pour le retour.

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$lier_trad : int
$config_fonc : string = ''
$row : array<string|int, mixed> = array()
$hidden : array<string|int, mixed> = ''
Return values
mixed

formulaires_editer_pensebete_traiter_dist()

Traitement du formulaire d'édition de pensebete

formulaires_editer_pensebete_traiter_dist([int|string $id_pensebete = 'new' ][, int $id_parent = '' ][, string $retour = '' ][, string $associer_objet = '' ], int $lier_trad[, string $config_fonc = '' ][, array<string|int, mixed> $row = array() ][, array<string|int, mixed> $hidden = '' ]) : mixed

Le traitement effectue une mise à zéro de l'id_auteur pour éviter des associations considérées comme inutiles.

Parameters
$id_pensebete : int|string = 'new'

identifiant de l'objet ou 'new' si absent.

$id_parent : int = ''

identifiant de la rubrique.

$retour : string = ''

lien pour le retour.

$associer_objet : string = ''

Éventuel 'objet|x' indiquant de lier le mot créé à cet objet, tel que 'article|3'

$lier_trad : int
$config_fonc : string = ''
$row : array<string|int, mixed> = array()
$hidden : array<string|int, mixed> = ''
Tags
uses
objet_inserer()
uses
objet_associer()
Return values
mixed

pensebetes_upgrade()

Création et mise à jour du plugin Pensebetes

pensebetes_upgrade(string $nom_meta_base_version, string $version_cible) : void
Parameters
$nom_meta_base_version : string

version du schéma de données du plugin installé

$version_cible : string

Version déclarée dans paquet.xml

Return values
void

pensebetes_vider_tables()

Faire le ménage lors de la désinstallation du plugin Pensebetes

pensebetes_vider_tables(string $nom_meta_base_version) : void
Parameters
$nom_meta_base_version : string

version du schéma de données du plugin installé

Return values
void

cfg_1_0_2()

Fonction privée : remplacer les noms d'objet par les noms de table

cfg_1_0_2() : void

Permettre de conserver la configuration définie par les versions précédentes à la version 1.0.2

Return values
void

cfg_1_0_4()

Fonction privée : remplacer les valeurs d’id_objet à zéro

cfg_1_0_4() : void

Comptabilité ascendante Permettre de conserver la configuration définie par les versions précédentes à la version 1.1.5

Return values
void

pensebetes_autoriser()

Fonction d'appel pour le pipeline

pensebetes_autoriser() : mixed
Tags
pipeline

autoriser

Return values
mixed

autoriser_associerpensebetes_dist()

Autorisation d'associer un pensebete

autoriser_associerpensebetes_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_pensebetes_menu_dist()

Autorisation de voir un élément de menu (pensebetes)

autoriser_pensebetes_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_pensebetecreer_menu_dist()

Autorisation de voir le bouton d'accès rapide de création (pensebete)

autoriser_pensebetecreer_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_murs_menu_dist()

Autorisation de voir le bouton d'outil collaboratif du mur

autoriser_murs_menu_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_pensebete_creer_dist()

Autorisation de créer (pensebete)

autoriser_pensebete_creer_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_pensebete_voir_dist()

Autorisation de voir (pensebete)

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

On peut voir les pensebetes dont on est l'auteur ou le destinataire.

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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_pensebete_modifier_dist()

Autorisation de modifier (pensebete)

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

On peut modifier que les pensebetes dont on est l'auteur.

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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

autoriser_pensebete_supprimer_dist()

Autorisation de supprimer (pensebete)

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

On peut supprimer tous les pensebetes que l'on peut voir.

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

$opt : array<string|int, mixed>

Options de cette autorisation

Return values
bool

true s'il a le droit, false sinon

pensebetes_insert_head_css()

Ajout de la feuille de style de Pensebetes, dans l'espace public si demandé Appelé aussi depuis le privé avec $prive à true.

pensebetes_insert_head_css(array<string|int, mixed> $flux[, mixed $prive = false ]) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

$prive : mixed = false
Tags
pipeline

insert_head_css

Return values
array<string|int, mixed>

Données du pipeline

pensebetes_insert_head_prive_css()

Ajout de la CSS du Pensebetes au head privé

pensebetes_insert_head_prive_css(string $flux) : string
Parameters
$flux : string

Contenu du head

Tags
pipeline

insert_header_prive_css

Return values
string

Contenu du head complété

pensebetes_affiche_gauche()

Ajout de contenu à gauche de la page,

pensebetes_affiche_gauche(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_gauche

Return values
array<string|int, mixed>

Données du pipeline

pensebetes_affiche_milieu()

Ajout de contenu sur certaines pages, notamment des formulaires de liaisons entre objets

pensebetes_affiche_milieu(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed>

Données du pipeline

pensebetes_quete_calendrier_prive()

Insérer des évènements dans le calendrier privé

pensebetes_quete_calendrier_prive(array<string|int, mixed> $flux) : array<string|int, mixed>

On y insère les Pense-bêtes de l'auteur. Les données sont formatées en json et utilisées par la librairie javascript Fullcalendar au travers du Plugin-dist Organiseur.

Parameters
$flux : array<string|int, mixed>

Données du pipeline

Tags
pipeline

quete_calendrier_prive

Return values
array<string|int, mixed>

Données du pipeline

Search results