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 = [] ]) : int
Parameters
-
$id_parent
: mixed
= null
-
-
$champs
: array<string|int, mixed>
= []
-
Un tableau avec les champs par défaut lors de l'insertion
-
pipeline_appel
-
-
pipeline_appel
-
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
-
uses
-
API
-
link
-
https://www.spip.net/fr_article5526.html
action_repondre_pensebete_dist()
Action pour répondre à une question dans un pense-bête
(posée via son modele modeles/pd_reponse.html)
action_repondre_pensebete_dist([null|string $arg = null ]) : array<string|int, mixed>
Parameters
-
$arg
: null|string
= null
-
Identifiant du pense-bête et type du formulaire utilisé pour la réponse
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)
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
-
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>
Un simple formulaire de config,
on a juste à déclarer les saisies
formulaires_configurer_pensebetes_saisies_dist() : mixed
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 = 0 ][, mixed $config_fonc = '' ][, mixed $row = [] ][, 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
= 0
-
-
$config_fonc
: mixed
= ''
-
-
$row
: mixed
= []
-
-
$hidden
: mixed
= ''
-
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 = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, 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
= ''
-
-
$associer_objet
: string
= ''
-
Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
tel que 'article|3'
-
$lier_trad
: int
= 0
-
-
$config_fonc
: string
= ''
-
-
$row
: array<string|int, mixed>
= []
-
-
$hidden
: array<string|int, mixed>
= ''
-
-
uses
-
formulaires_editer_objet_charger()
-
uses
-
mes_saisies_pensebete()
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 = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, 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
= ''
-
-
$associer_objet
: string
= ''
-
Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
tel que 'article|3'
-
$lier_trad
: int
= 0
-
-
$config_fonc
: string
= ''
-
-
$row
: array<string|int, mixed>
= []
-
-
$hidden
: array<string|int, mixed>
= ''
-
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 = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, 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
= ''
-
-
$associer_objet
: string
= ''
-
Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
tel que 'article|3'
-
$lier_trad
: int
= 0
-
-
$config_fonc
: string
= ''
-
-
$row
: array<string|int, mixed>
= []
-
-
$hidden
: array<string|int, mixed>
= ''
-
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 = 0 ][, string $config_fonc = '' ][, array<string|int, mixed> $row = [] ][, 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
= ''
-
-
$associer_objet
: string
= ''
-
Éventuel 'objet|x' indiquant de lier le mot créé à cet objet,
tel que 'article|3'
-
$lier_trad
: int
= 0
-
-
$config_fonc
: string
= ''
-
-
$row
: array<string|int, mixed>
= []
-
-
$hidden
: array<string|int, mixed>
= ''
-
-
uses
-
objet_inserer()
-
uses
-
objet_associer()
Traitement du formulaire d'édition
formulaires_traiter_pbq_dist(array<string|int, mixed> $champs) : string
Le traitement est nécessaire pour placer l'identifiant unique
de l'auteur à qui la réponse sera apportée dans la variable id_rep.
Parameters
-
$champs
: array<string|int, mixed>
-
Champs du formulaire du plugin inserer_modele
-
uses
-
plugin
Return values
string
—
$code Arguments en ligne pour appeler le modèle
inc_envoyer_pensebete_dist()
Permettre de créer et d'envoyer un pense-bête
inc_envoyer_pensebete_dist(int $id_donneur, array<string|int, mixed> $receveurs, string $titre, string $texte[, string $associer_objet = '' ]) : array<string|int, mixed>
Parameters
-
$id_donneur
: int
-
-
$receveurs
: array<string|int, mixed>
-
auteurs bénéficaires
deux clés : auteurs_receveurs
, la liste d'id d'auteurs
listes_receveurs
, la liste des statuts
-
$titre
: string
-
-
$texte
: string
-
-
$associer_objet
: string
= ''
-
objet auquel est éventuellement associé le pense-bête
Return values
array<string|int, mixed>
—
$retours tableau
deux clés : ok
boolean pour le succès
message
string pour l'explication
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
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é
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
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
pensebetes_autoriser()
Fonction d'appel pour le pipeline
pensebetes_autoriser() : mixed
-
pipeline
-
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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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
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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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
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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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
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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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_pensebeteparstatut_creer_dist()
Autorisation de créer un pense-bête dont les destinataires seront les auteurs d'un certain statut
autoriser_pensebeteparstatut_creer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, mixed $opt) : bool
Parameters
-
$faire
: string
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action : objet _pensebete_par_statut
A noter que les underscores sont retirés par l'appel de la fonction autoriser
et qu'il convient de débuter le nom de l'objet par un underscore pour
préciser que ce n'est pas un objet.
-
$id
: int
-
Identifiant de l'objet : 0
, liste
-
$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]
-
$opt
: mixed
-
Return values
bool
—
true
si l'auteur est autorisée à exécuter l'action, false
sinon.
autoriser_pensebetemultiauteurs_creer_dist()
Autorisation de créer un pense-bête dont les destinataires peuvent être multiples
autoriser_pensebetemultiauteurs_creer_dist(string $faire, string $type, int $id, null|array<string|int, mixed>|int $qui, mixed $opt) : bool
Parameters
-
$faire
: string
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action : objet _pensebete_multi_auteurs
A noter que les underscores sont retirés par l'appel de la fonction autoriser
et qu'il convient de débuter le nom de l'objet par un underscore pour
préciser que ce n'est pas un objet.
-
$id
: int
-
Identifiant de l'objet : 0
, liste
-
$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]
-
$opt
: mixed
-
Return values
bool
—
true
si l'auteur est autorisée à exécuter l'action, 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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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_iconifier_dist()
Autorisation d'iconifier un pense-bête,
c'est à dire lui mettre un logo.
autoriser_pensebete_iconifier_dist(string $faire, string $type, int $id, array<string|int, mixed> $qui, array<string|int, mixed> $opt) : bool
Parameters
-
$faire
: string
-
-
$type
: string
-
Type d'objet sur lequel appliquer l'action
-
$id
: int
-
-
$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>
-
-
$prive
: mixed
= false
-
-
pipeline
-
Return values
array<string|int, mixed>
—
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
-
-
pipeline
-
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>
-
-
pipeline
-
Return values
array<string|int, mixed>
—
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>
-
-
pipeline
-
Return values
array<string|int, mixed>
—
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 Organiseur.
Parameters
-
$flux
: array<string|int, mixed>
-
-
pipeline
-
Return values
array<string|int, mixed>
—
pensebetes_aide_index()
Utiliser ce pipeline permet d'ajouter une aide au plugin,
pensebetes_aide_index(mixed $index) : array<string|int, mixed>
Parameters
-
$index
: mixed
-
-
pipeline
-
Return values
array<string|int, mixed>
—
pensebetes_recuperer_fond()
Permet d'agir sur le flux de données d'un fond
pensebetes_recuperer_fond(array<string|int, mixed> $flux) : array<string|int, mixed>
Ajout d'une aide en ligne relative à l'association sur le formulaire prive/formulaires/editer_liens.html
Modification de la ligne :
<h3 class="titrem">[(#ENV{objet_source}|objet_info{texte_ajouter}|_T)]</h3>
Parameters
-
$flux
: array<string|int, mixed>
-
-
pipeline
-
Return values
array<string|int, mixed>
—
pensebetes_optimiser_base_disparus()
Optimiser la base de données
pensebetes_optimiser_base_disparus(array<string|int, mixed> $flux) : array<string|int, mixed>
Appelé depuis ecrire/genie/optimiser.php, il permet de compléter le nettoyage des objets
en supprimant des éléments lors des tâches périodiques.
Parameters
-
$flux
: array<string|int, mixed>
-
-
pipeline
-
-
link
-
https://programmer.spip.net/optimiser_base_disparus,532
Return values
array<string|int, mixed>
—