goa/doc/devmanual_fr/chap_ui_gestion_formulaire.txt
author sylvain.thenault@logilab.fr
Tue, 07 Apr 2009 19:55:10 +0200 (2009-04-07)
branchtls-sprint
changeset 1276 f213008fad2c
parent 0 b97547f5f1fa
permissions -rw-r--r--
catch FieldNotFound instead of Exception in field_by_name, return the field if guessable
Gestion de formulaires
======================

Contr�le de la g�n�ration automatique de formulaire pour les entit�s manipul�e
------------------------------------------------------------------------------
XXX FILLME

* les formulaires 'edition' et 'creation'

Le formulaire g�n�r� par d�faut ne vous convient pas ? Vous �tes peut-�tre pas
oblig� de le refaire � la main ! :)

* rtags primary, secondary, generated, generic,
  `Entity.relation_category(rtype, x='subject')`
* inline_view (now a rtag?)
* sp�cification widget


Fonctionnement du contr�leur d'�dition par d�faut (id: 'edit')
--------------------------------------------------------------

Contr�le de l'�dition
`````````````````````
Pr�requis: les param�tres li�s aux entit�s � �diter sont sp�cifi�s de la forme ::

  <nom de champ>:<eid de l'entit�>

o� l'eid de l'entit� pourra �tre une lettre dans le cas d'une entit� � cr�er. On
d�nommera ces param�tres comme *qualifi�*.

1. r�cup�ration des entit�s � �diter en cherchant les param�tres de formulaire
   commen�ant par 'eid:' ayant �galement un param�tre '__type' associ�
   (�galement *qualifi�* par l'eid �videmment)

2. pour tous les attributs et relations de chaque entit� � �diter

   1. recherche d'un param�tre 'edits-<nom relation>' ou 'edito-<nom relation>'
      qualifi� dans le cas d'une relation dont l'entit� est objet
   2. si trouv�, la valeur r�cup�r�e est consid�r�e comme la valeur originale
      pour cette relation, et on cherche la (ou les) nouvelle(s) valeur(s) dans
      le param�tre <nom relation> (qualifi�)
   3. si la valeur est diff�rente de l'originale, une requ�te de modification en
      base est effectu�e

3. pour chaque entit� � �diter

   1. si un param�tre `__linkto` qualifi� est sp�cifi�, sa valeur doit �tre une
      chaine (ou une liste de chaine) de la forme : ::

        <relation type>:<eids>:<target>

      o� <target> vaut 'subject' ou 'object' et chaque eid peut-�tre s�par� d'un
      autre par un '_'. Target sp�cifie *l'entit� �dit�e* est sujet ou objet de la
      relation et chaque relation ainsi sp�cifi�e sera ins�r�e.

   2. si un param�tre `__cloned_eid` qualifi� est sp�cifi� pour une entit�, les
      relations de l'entit� sp�cifi�e en valeur de cette argument sont copi�es sur
      l'entit� �dit�e


   3. si un param�tre `__delete` qualifi� est sp�cifi�, sa valeur doit �tre une
      chaine (ou une liste de chaine) de la forme : ::

	<subject eids>:<relation type>:<object eids>

      o� chaque eid sujet ou objet peut-�tre s�par� d'un autre par un '_'. Chaque
      relation ainsi sp�cifi�e sera supprim�e.

   4. si un param�tre `__insert` qualifi� est sp�cifi�, sa valeur doit �tre de
      m�me format que pour `__delete`, mais chaque relation ainsi sp�cifi�e sera 
      ins�r�e.

4. si les param�tres `__insert` et/ou  `__delete` sont trouv�s non qualifi�s,
   ils sont interpr�t�s comme d�crit ci-dessus (quelque soit le nombre d'entit�
   �dit�)

5. si aucune entit� n'est �dit�e mais que le formulaire contient les param�tres
   `__linkto` et `eid`, celui-ci est interpr�t� en prenant la valeur sp�cifi�
   par le param�tre `eid` pour d�signer l'entit� sur laquelle ajouter les
   relations


A noter que :

* si le param�tre `__action_delete` est trouv�, toutes les entit�s comme
  sp�cifi�es � �diter seront supprim�es

* si le param�tre `__action_cancel` est trouv�, aucune action n'est effectu�e

* si le param�tre `__action_apply` est trouv�, l'�dition est effectu�e
  normalement mais la redirection sera effectu�e sur le formulaire (cf `Contr�le
  de la redirection`_)

* le param�tre `__method` est �galement support� comme sur le template principal
  (XXX not very consistent, maybe __method should be dealed in the view controller) 

* si aucune entit� � �diter n'est trouv�e et qu'il n'y a pas de param�tre
  `__action_delete`, `__action_cancel`, `__linkto`, `__delete` ou `__insert`,
  une erreur est lev�e

* placer dans le formulaire le param�tre `__message` permettra d'utiliser la
  valeur de ce param�tre comme message d'information � l'utilisateur une fois
  l'�dition effectu�e.


Contr�le de la redirection
``````````````````````````
Une fois que l'�dition s'est bien pass�, reste un probl�me : c'est bien beau
tout �a, mais o� qu'on va maintenant ?? Si rien n'est sp�cifi�, le controlleur
se d�brouille, mais comme il fait pas toujours ce qu'on voudrait, on peut
controller �a en utilisant les param�tres suivant :

* `__redirectpath`: chemin de l'url (relatif � la racine du site, sans param�tre
  de formulaire
  
* `__redirectparams`: param�tres de formulaires � ajouter au chemin
  
* `__redirectrql`: requ�te RQL de redirection

* `__redirectvid`: identifiant de vue de redirection

* `__errorurl`: url du formulaire original, utilis� pour la redirection en cas
  d'erreur de validation pendant l'�dition. Si celui-ci n'est pas sp�cifi�, une
  page d'erreur sera pr�sent�e plutot qu'un retour sur le formulaire (qui est le
  cas �ch�ant responsable d'afficher les erreurs)

* `__form_id`: identifiant de vue du formulaire original, utilis�e si
  `__action_apply` est trouv�

En g�n�ral on utilise soit `__redirectpath et `__redirectparams` soit
`__redirectrql` et `__redirectvid`.