Documentation du code de SPIP et de ses plugins

Pétitions

Documentation

Packages

Application
SPIP

Table of Contents

_PETITIONS_DELAI_SIGNATURES_REJETEES  = 20
action_editer_petition_dist()  : mixed
petition_modifier()  : string
Mettre à jour une petition existante
petition_inserer()  : int
Insérer une petition en base
petition_instituer()  : string|null
Institution d'une pétition
revision_petition()  : mixed
action_editer_signature_dist()  : mixed
signature_modifier()  : string
Mettre a jour une signature existante
signature_inserer()  : int
Inserer une signature en base
signature_instituer()  : mixed
signature_entrop()  : array<string|int, mixed>
Pour eviter le recours a un verrou (qui bloque l'acces a la base), on commence par inserer systematiquement la signature puis on demande toutes celles ayant la propriete devant etre unique (mail ou site). S'il y en a plus qu'une on les retire sauf la premiere En cas d'acces concurrents il y aura des requetes de retraits d'elements deja detruits. Bizarre ? C'est mieux que de bloquer!
revision_signature()  : mixed
action_relancer_signature_dist()  : mixed
action_supprimer_signature_dist()  : mixed
action_traiter_lot_signature_dist()  : mixed
action_valider_signature_dist()  : mixed
balise_FORMULAIRE_SIGNATURE()  : mixed
balise_FORMULAIRE_SIGNATURE_stat()  : mixed
petitions_declarer_tables_interfaces()  : array<string|int, mixed>
Interfaces des tables petitions et signatures pour le compilateur
petitions_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclarer les objets éditoriaux des pétitions et signatures
formulaires_activer_petition_article_charger_dist()  : array<string|int, mixed>
Charger
formulaires_activer_petition_article_traiter_dist()  : array<string|int, mixed>
Traiter
formulaires_signature_charger_dist()  : mixed
affiche_reponse_confirmation()  : mixed
formulaires_signature_verifier_dist()  : mixed
formulaires_signature_traiter_dist()  : mixed
inc_controler_signature_dist()  : mixed
Recevabilite de la signature d'une petition
signature_a_confirmer()  : mixed
signature_test_pass()  : mixed
Creer un mot de passe aleatoire et verifier qu'il est unique dans la table des signatures
petitions_upgrade()  : mixed
Installation/maj des tables petitions et signatures
upgrade_index_signatures()  : mixed
petitions_vider_tables()  : mixed
Desinstallation/suppression des tables petitions et signatures
petitions_maj_117()  : void
Mise à jour 1.1.7
petitions_autoriser()  : mixed
Fonction d'appel pour le pipeline
autoriser_modererpetition_dist()  : bool
Autorisation de modérer une pétition
autoriser_signature_publier()  : bool
Autorisation de publier une signature
autoriser_signature_supprimer()  : bool
Autorisation de supprimer une signature
autoriser_signature_relancer()  : bool
Autorisation de relancer une signature
autoriser_signature_modifier_dist()  : bool
Autorisation de modifier une signature
autoriser_controlerpetition_voir_dist()  : bool
Autorisation de voir la page controler_petition
autoriser_controlerpetition_menu_dist()  : bool
Autorisation de voir le menu de gestion des signatures
autoriser_signature_autoassocierdocument_dist()  : bool
Autorisation d'auto-association de documents sur des signatures
balise_PETITION_dist()  : Champ
Compile la balise `#PETITION` permettant d'afficher, s'il existe, le texte de pétition associé à l'article.
quete_petitions()  : array<string|int, mixed>|bool|null|string
retourne le champ 'texte' d'une petition
petitions_afficher_config_objet()  : array<string|int, mixed>
Boite de configuration des objets articles
petitions_affiche_milieu()  : array<string|int, mixed>
Utilisation du pipeline affiche milieu
petitions_optimiser_base_disparus()  : array<string|int, mixed>
Optimiser la base de données en supprimant les pétitions orphelines

Constants

Functions

action_editer_petition_dist()

action_editer_petition_dist([mixed $arg = null ]) : mixed
Parameters
$arg : mixed = null
Return values
mixed

petition_modifier()

Mettre à jour une petition existante

petition_modifier(int $id_petition[, array<string|int, mixed> $set = null ]) : string
Parameters
$id_petition : int
$set : array<string|int, mixed> = null
Return values
string

petition_inserer()

Insérer une petition en base

petition_inserer(int $id_article[, array<string|int, mixed>|null $set = null ]) : int
Parameters
$id_article : int

Identifiant de l'article recevant la pétition

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

Identifiant de la pétition

petition_instituer()

Institution d'une pétition

petition_instituer(int $id_petition, array<string|int, mixed> $c) : string|null
Parameters
$id_petition : int

Identifiant de la pétition

$c : array<string|int, mixed>

Liste des champs à modifier

Return values
string|null

revision_petition()

revision_petition(mixed $id_petition[, mixed $c = null ]) : mixed
Parameters
$id_petition : mixed
$c : mixed = null
Return values
mixed

action_editer_signature_dist()

action_editer_signature_dist([mixed $arg = null ]) : mixed
Parameters
$arg : mixed = null
Return values
mixed

signature_modifier()

Mettre a jour une signature existante

signature_modifier(int $id_signature[, array<string|int, mixed> $set = null ]) : string
Parameters
$id_signature : int
$set : array<string|int, mixed> = null
Return values
string

signature_inserer()

Inserer une signature en base

signature_inserer(int $id_petition[, array<string|int, mixed>|null $set = null ]) : int
Parameters
$id_petition : int
$set : array<string|int, mixed>|null = null
Return values
int

signature_instituer()

signature_instituer(mixed $id_signature, mixed $c[, mixed $calcul_rub = true ]) : mixed
Parameters
$id_signature : mixed
$c : mixed
$calcul_rub : mixed = true
Return values
mixed

signature_entrop()

Pour eviter le recours a un verrou (qui bloque l'acces a la base), on commence par inserer systematiquement la signature puis on demande toutes celles ayant la propriete devant etre unique (mail ou site). S'il y en a plus qu'une on les retire sauf la premiere En cas d'acces concurrents il y aura des requetes de retraits d'elements deja detruits. Bizarre ? C'est mieux que de bloquer!

signature_entrop(string $where) : array<string|int, mixed>
Parameters
$where : string
Return values
array<string|int, mixed>

revision_signature()

revision_signature(mixed $id_signature[, mixed $c = false ]) : mixed
Parameters
$id_signature : mixed
$c : mixed = false
Return values
mixed

action_relancer_signature_dist()

action_relancer_signature_dist([mixed $id_signature = null ]) : mixed
Parameters
$id_signature : mixed = null
Return values
mixed

action_supprimer_signature_dist()

action_supprimer_signature_dist([mixed $id_signature = null ]) : mixed
Parameters
$id_signature : mixed = null
Return values
mixed

action_traiter_lot_signature_dist()

action_traiter_lot_signature_dist([mixed $arg = null ]) : mixed
Parameters
$arg : mixed = null
Return values
mixed

action_valider_signature_dist()

action_valider_signature_dist([mixed $id_signature = null ]) : mixed
Parameters
$id_signature : mixed = null
Return values
mixed

balise_FORMULAIRE_SIGNATURE()

balise_FORMULAIRE_SIGNATURE(mixed $p) : mixed
Parameters
$p : mixed
Return values
mixed

balise_FORMULAIRE_SIGNATURE_stat()

balise_FORMULAIRE_SIGNATURE_stat(mixed $args, mixed $context_compil) : mixed
Parameters
$args : mixed
$context_compil : mixed
Return values
mixed

petitions_declarer_tables_interfaces()

Interfaces des tables petitions et signatures pour le compilateur

petitions_declarer_tables_interfaces(array<string|int, mixed> $interfaces) : array<string|int, mixed>
Parameters
$interfaces : array<string|int, mixed>

Déclarations d'interface pour le compilateur

Tags
pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed>

Déclarations d'interface pour le compilateur

petitions_declarer_tables_objets_sql()

Déclarer les objets éditoriaux des pétitions et signatures

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

Description des tables

Tags
pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed>

Description complétée des tables

formulaires_activer_petition_article_charger_dist()

Charger

formulaires_activer_petition_article_charger_dist(int $id_article) : array<string|int, mixed>
Parameters
$id_article : int
Return values
array<string|int, mixed>

formulaires_activer_petition_article_traiter_dist()

Traiter

formulaires_activer_petition_article_traiter_dist(int $id_article) : array<string|int, mixed>
Parameters
$id_article : int
Return values
array<string|int, mixed>

formulaires_signature_charger_dist()

formulaires_signature_charger_dist(mixed $id_article) : mixed
Parameters
$id_article : mixed
Return values
mixed

affiche_reponse_confirmation()

affiche_reponse_confirmation(mixed $confirm) : mixed
Parameters
$confirm : mixed
Return values
mixed

formulaires_signature_verifier_dist()

formulaires_signature_verifier_dist(mixed $id_article) : mixed
Parameters
$id_article : mixed
Return values
mixed

formulaires_signature_traiter_dist()

formulaires_signature_traiter_dist(mixed $id_article) : mixed
Parameters
$id_article : mixed
Return values
mixed

inc_controler_signature_dist()

Recevabilite de la signature d'une petition

inc_controler_signature_dist(mixed $id_article, mixed $nom, mixed $mail, mixed $message, mixed $site, mixed $url_site, mixed $url_page) : mixed

les controles devraient mantenant etre faits dans formulaires_signature_verifier()

Parameters
$id_article : mixed
$nom : mixed
$mail : mixed
$message : mixed
$site : mixed
$url_site : mixed
$url_page : mixed
Return values
mixed

signature_a_confirmer()

signature_a_confirmer(mixed $id_article, mixed $url_page, mixed $nom, mixed $mail, mixed $site, mixed $url, mixed $msg, mixed $lang, mixed &$statut) : mixed
Parameters
$id_article : mixed
$url_page : mixed
$nom : mixed
$mail : mixed
$site : mixed
$url : mixed
$msg : mixed
$lang : mixed
$statut : mixed
Return values
mixed

signature_test_pass()

Creer un mot de passe aleatoire et verifier qu'il est unique dans la table des signatures

signature_test_pass() : mixed
Return values
mixed

petitions_upgrade()

Installation/maj des tables petitions et signatures

petitions_upgrade(string $nom_meta_base_version, string $version_cible) : mixed
Parameters
$nom_meta_base_version : string
$version_cible : string
Return values
mixed

petitions_vider_tables()

Desinstallation/suppression des tables petitions et signatures

petitions_vider_tables(string $nom_meta_base_version) : mixed
Parameters
$nom_meta_base_version : string
Return values
mixed

petitions_autoriser()

Fonction d'appel pour le pipeline

petitions_autoriser() : mixed
Tags
pipeline

autoriser

Return values
mixed

autoriser_modererpetition_dist()

Autorisation de modérer une pétition

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

Il faut que les pétitions soient activées globalement ou qu'il y en ait au moins une et avoir droit de modifier l'objet qui reçoit la pétition

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_signature_publier()

Autorisation de publier une signature

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

Il faut avoir le droit de modérer la petition de l'article en question

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_signature_supprimer()

Autorisation de supprimer une signature

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

Il faut avoir le droit de modérer la petition de l'article en question

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_signature_relancer()

Autorisation de relancer une signature

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

Toute personne idenfiée peut relancer une signature non publiée

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_signature_modifier_dist()

Autorisation de modifier une signature

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

Jamais

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_controlerpetition_voir_dist()

Autorisation de voir la page controler_petition

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

Il faut que les pétitions soient activées globalement et qu'il y ait au moins une signature

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_controlerpetition_menu_dist()

Autorisation de voir le menu de gestion des signatures

autoriser_controlerpetition_menu_dist(string $faire[, string $type = '' ], int $id[, array<string|int, mixed> $qui = null ][, array<string|int, mixed> $opt = null ]) : 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> = null

Description de l'auteur demandant l'autorisation

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

Options de cette autorisation

Tags
uses
autoriser_controlerpetition_voir_dist()
Return values
bool

true s'il a le droit, false sinon

autoriser_signature_autoassocierdocument_dist()

Autorisation d'auto-association de documents sur des signatures

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

Jamais

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

balise_PETITION_dist()

Compile la balise `#PETITION` permettant d'afficher, s'il existe, le texte de pétition associé à l'article.

balise_PETITION_dist(Champ $p) : Champ

Retourne :

  • '' si l'article courant n'a pas de pétition
  • le texte de celle-ci sinon (et ' ' si il est vide)
Parameters
$p : Champ

Pile au niveau de la balise

Tags
see
balise_FORMULAIRE_SIGNATURE()
link
https://www.spip.net/3967
Return values
Champ

Pile complétée du code à générer

quete_petitions()

retourne le champ 'texte' d'une petition

quete_petitions(int $id_article, string $table, string $id_boucle, string $serveur, array<string|int, mixed> &$cache) : array<string|int, mixed>|bool|null|string
Parameters
$id_article : int
$table : string
$id_boucle : string
$serveur : string
$cache : array<string|int, mixed>
Return values
array<string|int, mixed>|bool|null|string

petitions_afficher_config_objet()

Boite de configuration des objets articles

petitions_afficher_config_objet(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

petitions_affiche_milieu()

Utilisation du pipeline affiche milieu

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

Ajoute le formulaire de configuration des pétitions sur la configuration des contenus

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

Données du pipeline

Tags
pipeline

affiche_milieu

Return values
array<string|int, mixed>

Données du pipeline

petitions_optimiser_base_disparus()

Optimiser la base de données en supprimant les pétitions orphelines

petitions_optimiser_base_disparus(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Return values
array<string|int, mixed>

Search results