saisies_fonctions.php
Déclaration de fonctions pour les squelettes
Table of Contents
Functions
- saisie_balise_structure_formulaire() : string
- Retourne une balise dev. Maintenu pour compatibilité historique, ne plus utiliser.
- balise_DIV_dist() : Pile
- Compile la balise `DIV` qui retourne simplement le texte `div`
- saisie_traitement_vue() : string
- Traiter la valeur de la vue en fonction du env si un traitement a ete fait en amont (champs extra) ne rien faire si pas de traitement defini (formidable) passer typo ou propre selon le type du champ
- saisies_picker_selected_par_objet() : array<string|int, mixed>
- Liste les éléments du sélecteur générique triés
- lister_tables_objets_edit() : array<string|int, mixed>
- Lister les objets qui ont une url_edit renseignée et qui sont éditables.
- saisies_label() : string
- Afficher la chaine de langue traduite.
- saisies_liens_ouvrants() : string
- Les liens ouvrants, c'est mal en général.
- saisies_statut_titre() : string
- Afficher un statut traduit
- saisies_picker_preselect_objet() : array<string|int, mixed>
- Convertit si nécessaire une valeur au format du picker ajax du sélecteur générique quand on sait que la valeur ne concerne qu'un seul type d'objet.
- saisies_utf8_restaurer_planes() : string
- Function inverse de la fonction du core `utf8_noplanes()` Trouve les entités HTML numérique des hautes "planes" et les remets en Unicode
Functions
saisie_balise_structure_formulaire()
Retourne une balise dev. Maintenu pour compatibilité historique, ne plus utiliser.
saisie_balise_structure_formulaire( $tag) : string
Parameters
Tags
Return values
string —$tag initial ou div
balise_DIV_dist()
Compile la balise `DIV` qui retourne simplement le texte `div`
balise_DIV_dist(Pile $p) : Pile
Maintenu pour ne pas casser les squelettes qui s'appuient dessus, mais à ne plus utiliser. Servait à la compatibilité entre SPIP 3.0 et SPIP 3.1+
Variante d'écriture, plus courte, que le filtre saisie_balise_structure_formulaire
À partir de SPIP 3.1
- ul.editer-groupe deviennent des div.editer-groupe
- li.editer devient div.editer
Parameters
- $p : Pile
Tags
Return values
Pilesaisie_traitement_vue()
Traiter la valeur de la vue en fonction du env si un traitement a ete fait en amont (champs extra) ne rien faire si pas de traitement defini (formidable) passer typo ou propre selon le type du champ
saisie_traitement_vue(string|null $valeur, string|array<string|int, mixed> $env) : string
Parameters
- $valeur : string|null
- $env : string|array<string|int, mixed>
Return values
stringsaisies_picker_selected_par_objet()
Liste les éléments du sélecteur générique triés
saisies_picker_selected_par_objet(string $selected) : array<string|int, mixed>
Les éléments sont triés par objets puis par identifiants
Parameters
- $selected : string
-
Liste des objets sélectionnés
Tags
Return values
array<string|int, mixed> —Liste des objets triés
lister_tables_objets_edit()
Lister les objets qui ont une url_edit renseignée et qui sont éditables.
lister_tables_objets_edit() : array<string|int, mixed>
Return values
array<string|int, mixed> —Liste des objets : index : nom de la table (spip_articles, spip_breves, etc.) 'type' : le type de l'objet ; 'url_edit' : l'url d'édition de l'objet ; 'texte_objets' : le nom humain de l'objet éditorial.
saisies_label()
Afficher la chaine de langue traduite.
saisies_label(string $chaine) : string
Parameters
- $chaine : string
Return values
stringsaisies_liens_ouvrants()
Les liens ouvrants, c'est mal en général.
saisies_liens_ouvrants(string $texte) : string
Sauf dans un cas particulier : dans les explications dans un formulaire. En effet, si le lien n'est pas ouvrant, la personne en train de remplir un formulaire a) lis une explication b) clique sur le lien pour savoir comment remplir son formulaire c) est redirigée directement vers une page d) perd du coup ce qu'elle avait commencé remplir. Par conséquent, en terme d'accessibilité, il vaut mieux POUR LES EXPLICATIONS DE FORMULAIRE avoir des liens systématiquement ouvrant, et ce que le lien pointe en interne ou en externe (ce qui distingue du filtre |liens_ouvrants). D'où un filtre saisies_liens_ouvrants
Parameters
- $texte : string
Return values
string —$texte
saisies_statut_titre()
Afficher un statut traduit
saisies_statut_titre(string $statut[, string $objet = '' ]) : string
Parameters
- $statut : string
-
Le statut (publie, refuse, ...)
- $objet : string = ''
-
Le type d’objet (article, rubrique, ...)
Return values
string —La traduction du statut, si on la trouve, sinon simplement la clé...
saisies_picker_preselect_objet()
Convertit si nécessaire une valeur au format du picker ajax du sélecteur générique quand on sait que la valeur ne concerne qu'un seul type d'objet.
saisies_picker_preselect_objet(array<string|int, mixed>|string|int $valeur, string $objet) : array<string|int, mixed>
Fait en quelque sorte l'inverse de picker_selected(). Cela évite d'avoir à modifier le charger des formulaires quand on traite des cas simples : juste un plusieurs ids d'un seul type d'objet.
Parameters
- $valeur : array<string|int, mixed>|string|int
-
- Soit un tableau issu du sélecteur (dans ce cas on ne fait rien) :
array('article|1', 'article|2') - Soit l'id d'un objet : 1
- Soit un tableau d'ids : array(1,2)
- Soit un tableau issu du sélecteur (dans ce cas on ne fait rien) :
- $objet : string
Tags
Return values
array<string|int, mixed> —Tableau au format du sélecteur générique
saisies_utf8_restaurer_planes()
Function inverse de la fonction du core `utf8_noplanes()` Trouve les entités HTML numérique des hautes "planes" et les remets en Unicode
saisies_utf8_restaurer_planes(string|null $x) : string
Parameters
- $x : string|null