SPIP Code

Documentation du code de SPIP et de ses plugins

Champs Extras

Pipelines

Table of Contents

Functions

cextras_declarer_tables_objets_sql()  : array<string|int, mixed>
Déclarer les nouveaux champs et les nouvelles infos des objets éditoriaux
cextras_declarer_tables_interfaces()  : array<string|int, mixed>
Déclarer les nouvelles infos sur les champs extras ajoutés en ce qui concerne les traitements automatiques sur les balises.
champs_extras_objet()  : array<string|int, mixed>
Retourne la liste des saisies de champs extras concernant un objet donné
champs_extras_autorisation()  : array<string|int, mixed>
Filtrer par autorisation les saisies transmises
champs_extras_ajouter_drapeau_edition()  : array<string|int, mixed>
Ajoute pour chaque saisie de type SQL un drapeau (input hidden) permettant de retrouver les saisies editées.
cextras_editer_contenu_objet()  : array<string|int, mixed>
Ajouter les champs extras sur les formulaires CVT editer_xx
cextras_pre_edition()  : array<string|int, mixed>
Ajouter les champs extras soumis par les formulaire CVT editer_xx
cextras_afficher_contenu_objet()  : array<string|int, mixed>
Ajouter les champs extras sur la visualisation de l'objet
cextras_appliquer_traitements_saisies()  : array<string|int, mixed>
Pour les saisies transmises, appliquer les traitements sur leurs contenus
cextras_formulaire_verifier()  : array<string|int, mixed>
Vérification de la validité des champs extras
cextras_revisions_chercher_label()  : array<string|int, mixed>
Insertion dans le pipeline revisions_chercher_label (Plugin révisions) Trouver le bon label à afficher sur les champs dans les listes de révisions
cextras_formulaire_fond()  : array<string|int, mixed>
Ajouter les saisies de champs extras sur des formulaires spécifiques
cextras_crayons_controleur()  : array<string|int, mixed>
Définir une fonction de contrôleur pour Crayons si on tente d'éditer un champs extras.
cextras_crayons_verifier()  : array<string|int, mixed>
Vérifier une saisie envoyée depuis un formulaire de Crayons.
cextras_verifier_saisie()  : false|string
Vérifie qu'une valeur est acceptée par la déclaration de saisie transmise.

Functions

cextras_declarer_tables_objets_sql()

Déclarer les nouveaux champs et les nouvelles infos des objets éditoriaux

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

La fonction déclare tous les champs extras (saisies de type sql).

Elle déclare aussi, en fonction des options choisies pour les champs

  • la recherche dans le champs, avec une certaine pondération,
  • le versionnage de champ,
  • l'utilisation par le ctière {vu} du plugin-dist/medias
Parameters
$tables : array<string|int, mixed>

Description des tables

Tags
note

Ne pas utiliser dans le code de cette fonction table_objet() qui ferait une réentrance et des calculs faux. Ni charger public/interfaces trop tôt (qui fait de même) en appelant automatiquement declarer_interfaces()

Du coup, le champ 'traitements' des champs extras ne peut appeler directement les constantes _TRAITEMENT_TYPO ou _TRAITEMENT_RACCOURCIS ; elles sont du coup déclarées, si besoin, en tant que chaine. ie: 'traitements' => '_TRAITEMENT_TYPO', et non 'traitements' => _TRAITEMENT_TYPO,. L’expression correcte est reformée ensuite dans cextras_declarer_tables_interfaces()

On peut aussi utiliser une fonction spécifique, tel que 'traitements' => 'propre(%s)',.

pipeline

declarer_tables_objets_sql

Return values
array<string|int, mixed> —

Description complétée des tables

cextras_declarer_tables_interfaces()

Déclarer les nouvelles infos sur les champs extras ajoutés en ce qui concerne les traitements automatiques sur les balises.

cextras_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
note

public/interfaces est forcément chargé ici, vu que c’est lui qui exécute le pipeline...

pipeline

declarer_tables_interfaces

Return values
array<string|int, mixed> —

Déclarations d'interface pour le compilateur

champs_extras_objet()

Retourne la liste des saisies de champs extras concernant un objet donné

champs_extras_objet(string $table) : array<string|int, mixed>
Parameters
$table : string

Nom d'une table SQL éditoriale

Tags
pipeline_appel

declarer_champs_extras

used-by
vues_champs_extras_dist()
used-by
vues_champs_extras_fieldset_dist()
Return values
array<string|int, mixed> —

Liste des saisies de champs extras de l'objet

champs_extras_autorisation()

Filtrer par autorisation les saisies transmises

champs_extras_autorisation(string $faire[, string $quoi = '' ][, array<string|int, mixed> $saisies = array() ][, array<string|int, mixed> $args = array() ]) : array<string|int, mixed>

Chacune des saisies est parcourue et si le visiteur n'a pas l'autorisation de la voir, elle est enlevée de la liste. La fonction ne retourne donc que la liste des saisies que peut voir la personne.

Parameters
$faire : string

Type d'autorisation testée : 'voir', 'modifier'

$quoi : string = ''

Type d'objet tel que 'article'

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

Liste des saisies à filtrer

$args : array<string|int, mixed> = array()

Arguments pouvant être utiles à l'autorisation

Return values
array<string|int, mixed> —

Liste des saisies filtrées

champs_extras_ajouter_drapeau_edition()

Ajoute pour chaque saisie de type SQL un drapeau (input hidden) permettant de retrouver les saisies editées.

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

Particulièrement utile pour les checkbox qui ne renvoient rien si on les décoche.

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

Liste de saisies

Return values
array<string|int, mixed> —

$saisies Saisies complétées des drapeaux d'édition

cextras_editer_contenu_objet()

Ajouter les champs extras sur les formulaires CVT editer_xx

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

Liste les champs extras de l'objet, et s'il y en a les ajoute sur le formulaire d'édition en ayant filtré uniquement les saisies que peut voir le visiteur et en ayant ajouté des champs hidden servant à champs extras.

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

Données du pipeline

Tags
pipeline

editer_contenu_objet

Return values
array<string|int, mixed> —

Données du pipeline

cextras_pre_edition()

Ajouter les champs extras soumis par les formulaire CVT editer_xx

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

Pour chaque champs extras envoyé par le formulaire d'édition, ajoute les valeurs dans l'enregistrement à effectuer.

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

Données du pipeline

Tags
pipeline

pre_edition

Return values
array<string|int, mixed> —

Données du pipeline

cextras_afficher_contenu_objet()

Ajouter les champs extras sur la visualisation de l'objet

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

S'il y a des champs extras sur l'objet, la fonction les ajoute à la vue de l'objet, en enlevant les saisies que la personne n'a pas l'autorisation de voir.

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

Données du pipeline

Tags
pipeline

afficher_contenu_objet

Return values
array<string|int, mixed> —

Données du pipeline

cextras_appliquer_traitements_saisies()

Pour les saisies transmises, appliquer les traitements sur leurs contenus

cextras_appliquer_traitements_saisies(array<string|int, mixed> $saisies, array<string|int, mixed> $valeurs) : array<string|int, mixed>

On applique les eventuels traitements definis pour chaque saisie, dans l'option 'traitements'. Si la valeur de l'option correspond à une constante connue (tel que _TRAITEMENTS_RACCOURCIS), ce sera la valeur de la constante qui sera utilisée, sinon directement le texte écrit. Il faut absolument %s pour que cela fonctionne.

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

Liste décrivant les saisies

$valeurs : array<string|int, mixed>

Couples (champ => valeur)

Tags
note

La saisies-vues/_base applique le filtre |propre par défaut si elle ne trouve pas de saisie. Dans ce cas, certains traitements peuvent être effectués 2 fois !

used-by
vues_champs_extras_dist()
used-by
vues_champs_extras_fieldset_dist()
Return values
array<string|int, mixed> —

Couples (champ => valeur traitée, le cas échéant)

cextras_formulaire_verifier()

Vérification de la validité des champs extras

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

Lorsqu'un formulaire 'editer_xx' se présente, la fonction effectue, pour chaque champs extra les vérifications prévues dans la définition de la saisie, et retourne les éventuelles erreurs rencontrées.

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

Données du pipeline

Tags
pipeline

formulaire_verifier

Return values
array<string|int, mixed> —

Données du pipeline

cextras_revisions_chercher_label()

Insertion dans le pipeline revisions_chercher_label (Plugin révisions) Trouver le bon label à afficher sur les champs dans les listes de révisions

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

Si un champ est un champ extra, son label correspond au label défini du champs extra

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

Données du pipeline

Tags
pipeline

revisions_chercher_label

Return values
array<string|int, mixed> —

Données du pipeline

cextras_formulaire_fond()

Ajouter les saisies de champs extras sur des formulaires spécifiques

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

Les champs extras s'ajoutent déjà automatiquement sur les formulaires d'édition des objets éditoriaux. Pour d'autres formulaires plus spécifiques, tel que des formulaires d'inscriptions, il est possible d'envoyer, dans la partie 'charger' du formulaire en question la clé _champs_extras_saisies, listant les saisies à afficher dedans.

Elles seront ajoutées automatiquement à l'endroit où le code html <!--extra--> est présent dans le formulaire.

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

qui aide à récupérer les saisies.

pipeline

formulaire_fond

Return values
array<string|int, mixed>

cextras_crayons_controleur()

Définir une fonction de contrôleur pour Crayons si on tente d'éditer un champs extras.

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

Si on édite un champs extras avec Crayons, sans avoir créé manuellement de contrôleur spécifique pour le champ en question, Crayons propose soit un textarea, soit un input.

Vu que l'on connaît les déclarations de nos champs extras, on va les utiliser pour créer un formulaire d'édition plus adapté à notre champ.

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

crayons_controleur

Return values
array<string|int, mixed>

cextras_crayons_verifier()

Vérifier une saisie envoyée depuis un formulaire de Crayons.

cextras_crayons_verifier(array<string|int, mixed> $flux) : array<string|int, mixed>
Parameters
$flux : array<string|int, mixed>
Tags
pipeline

crayons_verifier

Return values
array<string|int, mixed>

cextras_verifier_saisie()

Vérifie qu'une valeur est acceptée par la déclaration de saisie transmise.

cextras_verifier_saisie(array<string|int, mixed> $saisie, mixed $valeur[, mixed &$normaliser = null ][, bool $depuis_crayons = false ]) : false|string

Obsolète, ne plus utiliser. Cextras passe désormais par l'api de verification de saisies, et les plugins qui appellent cette fonction devraient faire de même.

Parameters
$saisie : array<string|int, mixed>
$valeur : mixed
$normaliser : mixed = null

Valeur normalisée, le cas échéant

$depuis_crayons : bool = false

true si en provenance d'une vérification par Crayons.

Return values
false|string —

Message d'erreur, le cas echéant.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results