Documentation du code de SPIP et de ses plugins

Saisies

saisies_pipelines.php

Utilisation des pipelines

Table of Contents

Constants

_SAISIES_AFFICHER_SI_JS_HIDE  = 'slideUp(800)'
_SAISIES_AFFICHER_SI_JS_SHOW  = 'slideDown(800)'

Functions

saisies_header_prive()  : string
Ajoute les scripts JS et CSS de saisies dans l'espace privé
saisies_insert_head()  : array<string|int, mixed>
Insérer automatiquement les scripts JS et CSS de saisies dans toutes les pages de l'espace public
saisies_affichage_final()  : string
Ajoute les scripts JS et CSS de saisies dans l'espace public
saisies_generer_head()  : string
Génère le contenu du head pour les saisies (css et js)
saisies_formulaire_charger()  : array<string|int, mixed>
Déclarer automatiquement les champs d'un formulaire CVT qui déclare des saisies
saisies_formulaire_charger_generer_hidden_ancienne_valeur_depubliee()  : string
Envoie sous forme d'hidden chiffré les anciennes valeurs lorsqu'une saisie à des choix dépubliés uniquement si on vérifie les valeurs acceptables
saisies_preremplir_defaut_depuis_config()  : array<string|int, mixed>
Pre remplir les options 'defaut' des saisies depuis `lire_config()`
saisies_styliser()  : array<string|int, mixed>
Aiguiller CVT vers un squelette propre à Saisies lorsqu'on a déclaré des saisies et qu'il n'y a pas déjà un HTML
saisies_formulaire_verifier()  : array<string|int, mixed>
Ajouter les vérifications déclarées dans la fonction "saisies" du CVT
saisies_verifier_previsualisation_au_dessus()  : array<string|int, mixed>
Modifie si besoin le $flux de vérification pour activer la prévisualisation au dessus
saisies_formulaire_verifier_etape()  : array<string|int, mixed>
Ajouter les vérifications déclarées dans la fonction "saisies" du CVT mais pour les étapes
saisies_formulaire_receptionner()  : array<string|int, mixed>
1. À la reception d'un formulaire, rechercher les saisie qui autorise choix_alternatif, et mettre si besoin la valeur envoyé en choix alternatif comme valeur principal.
saisies_formulaire_receptionner_deplacer_choix_alternatif()  : void
Regarde les saisies qui ont un choix alternatif, et met dans _request() la valeur de ce choix alternatif si jamais ce n'est pas une saisie tabulaire
saisies_formulaire_receptionner_retablir_cle_secrete()  : mixed
Rétablir si besoin les anciennes clés secretes à réceptions
afficher_si_definir_fonctions()  : mixed
Retourne une chaine renvoyant les functions js de masquage/affiche
saisies_saisies_verifier_lister_disponibles()  : array<string|int, mixed>
Bien que proposé avec le plugin verifier la vérification `fichiers` n'a de sens que si la saisie `fichiers` du plugin CVT-Upload est disponible.
saisies_saisies_lister_disponibles()  : array<string|int, mixed>
Bien que livrée avec saisies, la saisie `mot` ne doit pas être proposée si les mots ne sont pas activés On se branche sur le pipeline pour que la fonction originelle soit la plus simple possible, qu'elle n'ait pas à se préoccuper de l'état de la config SPIP
saisies_formulaire_fond()  : array<string|int, mixed>
Appliquer le chiffrement des name de nospam sur les `afficher_si`
saisies_formulaire_receptionner_set_request_anciennes_valeurs()  : void
Prendre les anciennes valeurs envoyées par _request et les mettres en contexte globale après les avoirs décodées

Constants

Functions

saisies_header_prive()

Ajoute les scripts JS et CSS de saisies dans l'espace privé

saisies_header_prive(string $flux) : string
Parameters
$flux : string
Return values
string

saisies_insert_head()

Insérer automatiquement les scripts JS et CSS de saisies dans toutes les pages de l'espace public

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

$flux modifié

saisies_affichage_final()

Ajoute les scripts JS et CSS de saisies dans l'espace public

saisies_affichage_final(string $flux) : string

Ajoute également de quoi gérer le datepicker de la saisie date si celle-ci est utilisée dans la page.

Parameters
$flux : string
Return values
string

saisies_generer_head()

Génère le contenu du head pour les saisies (css et js)

saisies_generer_head([string $html_content = '' ][, mixed $tester_saisies = false ]) : string
Parameters
$html_content : string = ''

le contenu html où l'on teste la présence de saisies

$tester_saisies : mixed = false
Return values
string

saisies_formulaire_charger()

Déclarer automatiquement les champs d'un formulaire CVT qui déclare des saisies

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

Recherche une fonction formulaires_XX_saisies_dist et l'utilise si elle est présente. Cette fonction doit retourner une liste de saisies dont on se sert alors pour calculer les champs utilisés dans le formulaire.

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

saisies_formulaire_charger_generer_hidden_ancienne_valeur_depubliee()

Envoie sous forme d'hidden chiffré les anciennes valeurs lorsqu'une saisie à des choix dépubliés uniquement si on vérifie les valeurs acceptables

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

, le flux du pipeline saisies_charger()

Return values
string

saisies_preremplir_defaut_depuis_config()

Pre remplir les options 'defaut' des saisies depuis `lire_config()`

saisies_preremplir_defaut_depuis_config(array<string|int, mixed> $saisies, string $meta_case) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>

;

$meta_case : string

;

Return values
array<string|int, mixed>

$saisies

saisies_styliser()

Aiguiller CVT vers un squelette propre à Saisies lorsqu'on a déclaré des saisies et qu'il n'y a pas déjà un HTML

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

Dans le cadre d'un formulaire CVT demandé, si ce formulaire a déclaré des saisies, et qu'il n'y a pas de squelette spécifique pour afficher le HTML du formulaire, alors on utilise le formulaire générique intégré au plugin saisie, qui calculera le HTML à partir de la déclaration des saisies indiquées.

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

saisies_formulaire_verifier()

Ajouter les vérifications déclarées dans la fonction "saisies" du CVT

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

Si un formulaire CVT a déclaré des saisies, on utilise sa déclaration pour effectuer les vérifications du formulaire.

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

'data' Liste des erreurs du formulaire 'args' Arguments du pipeline

Tags
see
saisies_formulaire_charger()
uses
saisies_verifier()
Return values
array<string|int, mixed>

$flux ajusté

saisies_verifier_previsualisation_au_dessus()

Modifie si besoin le $flux de vérification pour activer la prévisualisation au dessus

saisies_verifier_previsualisation_au_dessus(array<string|int, mixed> $flux, array<string|int, mixed> $saisies, string|null $valider_previsu) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>

comme pour le pipeline

$saisies : array<string|int, mixed>

tableau de saisies

$valider_previsu : string|null

, le résultat de _request('valider_previsu')

Return values
array<string|int, mixed>

$flux idem

saisies_formulaire_verifier_etape()

Ajouter les vérifications déclarées dans la fonction "saisies" du CVT mais pour les étapes

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

Liste des erreurs du formulaire

Tags
see
saisies_formulaire_charger()
uses
saisies_verifier()
Return values
array<string|int, mixed>

iste des erreurs

saisies_formulaire_receptionner()

1. À la reception d'un formulaire, rechercher les saisie qui autorise choix_alternatif, et mettre si besoin la valeur envoyé en choix alternatif comme valeur principal.

saisies_formulaire_receptionner(array<string|int, mixed> $flux) : array<string|int, mixed>
  1. À la réception d'un formulaire de config rechercher les input avec l'option cle_secrete. Si la valeur postée est vide, cela veut dire qu'on conserve celle en base. Dans ce cas, reinjecter cette dernière en `set_request'. Cela permet de ne pas perdre la valeur à chaque configuration du formulaire
Parameters
$flux : array<string|int, mixed>

;

Return values
array<string|int, mixed>

$flux;

saisies_formulaire_receptionner_deplacer_choix_alternatif()

Regarde les saisies qui ont un choix alternatif, et met dans _request() la valeur de ce choix alternatif si jamais ce n'est pas une saisie tabulaire

saisies_formulaire_receptionner_deplacer_choix_alternatif(array<string|int, mixed> $flux, array<string|int, mixed> $saisies) : void
Parameters
$flux : array<string|int, mixed>

le flux, a priori ne sert pas, mais permet d'avoir une signature similaire à d'autres sous fonction du pipeline _receptionner

$saisies : array<string|int, mixed>

saisies_formulaire_receptionner_retablir_cle_secrete()

Rétablir si besoin les anciennes clés secretes à réceptions

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

description d'un $flux de receptions

$saisies : array<string|int, mixed>

description des saisies

Tags
@return

void:

afficher_si_definir_fonctions()

Retourne une chaine renvoyant les functions js de masquage/affiche

afficher_si_definir_fonctions() : mixed

saisies_saisies_verifier_lister_disponibles()

Bien que proposé avec le plugin verifier la vérification `fichiers` n'a de sens que si la saisie `fichiers` du plugin CVT-Upload est disponible.

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

$flux

saisies_saisies_lister_disponibles()

Bien que livrée avec saisies, la saisie `mot` ne doit pas être proposée si les mots ne sont pas activés On se branche sur le pipeline pour que la fonction originelle soit la plus simple possible, qu'elle n'ait pas à se préoccuper de l'état de la config SPIP

saisies_saisies_lister_disponibles(array<string|int, mixed> $saisies) : array<string|int, mixed>
Parameters
$saisies : array<string|int, mixed>

les saisies

Return values
array<string|int, mixed>

$saisies les saisies sans la saisies mot

saisies_formulaire_fond()

Appliquer le chiffrement des name de nospam sur les `afficher_si`

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

saisies_formulaire_receptionner_set_request_anciennes_valeurs()

Prendre les anciennes valeurs envoyées par _request et les mettres en contexte globale après les avoirs décodées

saisies_formulaire_receptionner_set_request_anciennes_valeurs(string $flux) : void
Parameters
$flux : string

        
On this page

Search results