Gestion des formulaires, fonctions existantes pour calculs :

Dans la construction du formulaire, il y a une possibilité puissante de construire des champs en appliquant des "calculs" sur d'autres champs saisis. Dans ces champs, on peut appliquer toutes les formules applicables pour calculer un champ PHP: opérateurs arithmétiques, fonctions PHP, mais aussi fonctions spécifiques fournies avec le plugin.

Le but de cet article est de lister ces fonctions, de donner leur résultat attendu et la liste des paramètres à fournir. Les fonctions sont rassemblées dans le fichier "plugins/formulaire/for-fonctions-formulaire.inc"; il ne sera pas inutile de s'y reporter pour voir la toute dernière mouture et d'éventuelles nouvelles fonctions, au cas où l'article n'aurait pas suivi l'actualité...

Si vous voulez développer vos propres fonctions vous pouvez le faire; il suffit de les enregistrer dans le fichier  "data/plugins/formulaire/for-fonctions-perso.inc" et bien sûr de respecter les normes PHP.

on fait référence à un champ du formulaire en mettant un $ suivi du nom interne du champ. ATTENTION A QUELQUES REGLES:

1. Ne jamais faire commencer le nom interne de 2 champs par les mêmes caractères du style nom et nom_complet; si vous devez appeler le deuxième dans un calcul, il va le confondre avec le premier et la suite va provoquer une erreur
2. si vous devez appeler des champs calculés dans un champ calculé, ce dernier doit être placé après...

Fonction DateCreation

retourne la date de création de la fiche; ce champ ne devrait plus bouger.

paramètre 1 : doit être exactement le nom du champ sur lequel on applique la fonction.
paramètre 2 : format de la date retournée, même syntaxe que la fonction PHP date. Par défaut le format utilisé est "d/m/Y - H:i:s"

exemple : DateCreation($datecre, "d-m-Y")

Note : Si vous écrivez votre propre programme PHP, pour pouvoir utiliser la fonction, vous devez positionner une variable $for_act à la valeur "add" ou "dup", lorsque vous voulez que le champ soit modifié.

Fonction DateMaj

retourne la date de modification de la fiche; ce champ est actualisé chaque fois qu'un internaute autorisé enregistre la fiche.

paramètre 1 : format de la date retournée, même syntaxe que la fonction PHP date.Par défaut le format utilisé est "d/m/Y - H:i:s"

exemple : DateMaj()

Fonction auteur

retourne le pseudo de l'internaute qui a modifié la fiche; ce champ est actualisé chaque fois qu'un internaute autorisé enregistre la fiche. Il n'y a pas de paramètre.

exemple : auteur()

Fonction ListeVerticale

retourne jusqu'à 9 champs texte chacun d'eux étant mis sur une ligne. Construction d'un champ adresse, par exemple.

paramètre 1 à 9 :champs texte.

exemple : ListeVerticale($adresse,$codepostal,$ville) ; si $adresse = 123 rue de la pompe, $codepostal = 12345 et $ville = Chantemerle alors le résultat affiché sera :
123 rue de la pompe
12345
Chantemerle

Fonction NomPrenom

retourne la concaténation de 2 champs texte séparés par un espace. Le "prénom" est mis en minuscule sauf la première lettre qui est mise en majuscule. Le "nom" est mis en majuscule. Cette fonction est utile pour mettre un champ nom dans une page : on économise une colonne, les tris seront améliorés.

paramètre 1 : champ texte sensé représenter le nom.
paramètre 2 : champ texte sensé représenter le prénom
paramètre 3 : format de retour = "NP" ou "PN" (NP par défaut); si NP, la fonction retourne nom suivi de prénom, si PN ce sera prénom suivi de nom.

exemple : NomPrenom($nom, $prenom, 'PN') ; si $nom = terieur et $prenom = alex, alors le résultat est Alex TERIEUR.

Fonction ajoutePseudo

Ajoute le pseudo du user identifié à la fin d'un champ. Elle permet de créer une file d'attente. Elle ne devrait pas être utilisée sur un champ calculé, sinon à chaque modification d'une fiche, le champ va se remplir. Cette fonction est faite pour être utilisée avec un bouton action. Imaginez que vous ayez une bibliothèque gérée par le plugin, vous programmez un bouton "réservation" qui active une fonction qui va mettre à jour le champ avec la fonction ajoutePseudo. Au passage, la 1ère fonction envoie un courriel au bibliothécaire qui peut voir le champ des réservations.

Fonction envoiCourrielWebmestre

Envoie un courriel au webmestre du site (adresse déclarée dans config générale), chaque fois qu'une fiche est créée ou modifiée. Un message est affiché dans le champ calcul. 5 champs peuvent être indiqués en paramètre; leur valeur sera listée dans le courriel.

exemple : envoiCourrielWebmestre($nom, $prenom);