en | fr | Contact  | Imprimer  | Partager

FrameBeurk documentation

5. Clefs

Les paramètres de la requête http transmis par le navigateur au serveur permettent de déterminer les clefs des actions Maj et Vue à réaliser.

Les paramètres des clefs ne sont pas tous libres : Les premiers sont obligatoires et systématiques, les autres (nommés paramètres supplémentaires) dépendent du couple (Entité, Action). Pour les Vues (mais pas les Majs), ces paramètres supplémentaires doivent être déclarés en configuration. Leur présence est vérifiée dans le contrôleur Vue, et ils sont instanciés en variable globale pour être directement utilisés dans le code des actions.


5.1. Clef Maj

Les 3 paramètres obligatoires sont :

  • ActMaj : Code action de Maj. Recommandation : Verbe à l’impératif 2ème personne du singulier, initiale en minuscule.
  • EntMaj : Type d’entité. Recommandation : Nom au singulier, initiale en majuscule.
  • IdMaj : Id de l’entité mise à jour. Toujours numérique positif si présent. Facultatif dans le cas d’une entité singleton.

5.2. Jeton anti-double-soumission

Afin d’éliminer les problèmes de double-soumission de formulaire liés à une navigation dans l’historique ou un rafraichissement de la page, FrameBeurk génère à chaque transaction un nouveau jeton, qui est stocké dans les données du dialogue (en session PHP) et envoyé vers le navigateur dans le ou les formulaires du code html et dans une variable Javascript.

Dans le cas (fréquent) d’une navigation Ajax, les formulaires présents dans les parties non rechargée de la page ont une version périmée du jeton qui serait refusée s’il était envoyé tel quel. La fonction Javascript d’envoi d’un formulaire par Ajax remplace donc le jeton périmé par la dernière version envoyée.

5.3. Jeton Clef

Par exemple dans le cas de l’envoi de lien par mail, il est préférable d’envoyer une URL ayant en paramètre un jeton unique généré aléatoirement, plutôt que les paramètres ActMaj+EntMaj+IdMaj.

Le framework met à disposition la table Beurk_Clef pour stocker la correspondance entre le jeton clef et les données de la clef à utiliser pour le traitement. A réception du paramètre JetonClef, le contrôleur Maj accède à cette table pour vérifier la validité du jeton et extraire la clef d'action prévue.

5.4. Clef Vue

Semblable à la Clef Maj (les recommandations sont aussi les mêmes), les 3 paramètres obligatoires sont :

  • ActVue : Code action de Vue.
  • EntVue : Type d’entité.
  • IdVue : Id de l’entité affichée.

Dans le cas d’une Vue qui affiche le formulaire préalable à l’exécution d’une Maj, le code action de la Vue est le même que celui de la Maj.

5.5. Div Vue

Lorsque la Vue est affichée par index.php, son emplacement sur la page est déterminé par le Layout.
Lorsque c’est par ajax.php, le navigateur envoie au serveur en paramètre DivVue de la requête le nom prévu de la div où afficher la Vue. Le serveur renvoie avec le résultat de la requête ce même nom de div, sauf si les traitements en décident autrement. Le navigateur affiche la Vue reçue dans la DivVue reçue.

Si le paramètre DivVue n’est pas précisé dans la requête envoyée par le navigateur, le serveur renvoie un nom de div par défaut, composé de la concaténation de ActVue, EntVue et IdVue.

5.6. Clef Vue et Div Vue d’erreur

Toujours dans le cas d’ajax, le navigateur peut envoyer une Clef Vue d’erreur et une Div Vue d’erreur, qui seront retournées par le serveur en cas d’erreur pendant l’action de Maj (non représenté sur le schéma).


© ToolOscope SASU 2010-2015. © Arnaud De Rette 2016-2018. Tous droits réservés.