# HG changeset patch # User Aurelien Campeas # Date 1273071147 -7200 # Node ID b44bad36e609260fd6edcac4be3f3906da05db7d # Parent 1fc46a6287a7263173c60b3b63d0a7963592a9f5 [doc/book] refresh a bit the edit controller section diff -r 1fc46a6287a7 -r b44bad36e609 doc/book/en/devweb/edition/dissection.rst --- a/doc/book/en/devweb/edition/dissection.rst Wed May 05 15:29:39 2010 +0200 +++ b/doc/book/en/devweb/edition/dissection.rst Wed May 05 16:52:27 2010 +0200 @@ -1,3 +1,5 @@ + +.. _form_dissection: Dissection of a form -------------------- @@ -110,7 +112,7 @@ back correctly. The `freezeFormButtons(...)` javascript callback defined on the -``conlick`` event of the form element prevents accidental multiple +``onlick`` event of the form element prevents accidental multiple clicks in a row. The ``action`` of the form is mapped to the ``validateform`` controller @@ -119,6 +121,8 @@ A full explanation of the validation loop is given in :ref:`validation_process`. +.. _attributes_section: + The attributes section '''''''''''''''''''''' @@ -281,7 +285,7 @@ defined on click events on these buttons. This function basically submits the form. -.. validation_process:: +.. _validation_process: The form validation process --------------------------- diff -r 1fc46a6287a7 -r b44bad36e609 doc/book/en/devweb/edition/editcontroller.rst --- a/doc/book/en/devweb/edition/editcontroller.rst Wed May 05 15:29:39 2010 +0200 +++ b/doc/book/en/devweb/edition/editcontroller.rst Wed May 05 16:52:27 2010 +0200 @@ -1,71 +1,68 @@ .. _edit_controller: The `edit controller` -+++++++++++++++++++++ +--------------------- -It can be found in (:mod:`cubicweb.web.views.editcontroller`). +It can be found in (:mod:`cubicweb.web.views.editcontroller`). This +controller processes data received from an html form to create or +update entities. -Editing control +Edition handling ~~~~~~~~~~~~~~~~ -.. XXX this look obsolete +The parameters related to entities to edit are specified as follows +(first seen in :ref:`attributes_section`):: -The parameters related to entities to edit are specified as follows :: - - : + : where entity eid could be a letter in case of an entity to create. We name those parameters as *qualified*. -1. Retrieval of entities to edit by looking for the forms parameters - starting by `eid:` and also having a parameter `__type` associated - (also *qualified* by eid) +* Retrieval of entities to edit is done by using the forms parameters + `eid` and `__type` -2. For all the attributes and the relations of an entity to edit: +* For all the attributes and the relations of an entity to edit + (attributes and relations are handled a bit differently but these + details are not much relevant here) : + + * using the ``rtype``, ``role`` and ``__type`` information, fetch + an appropriate field instance - 1. search for a parameter `edits-` or `edito-` - qualified in the case of a relation where the entity is object - 2. if found, the value returned is considered as the initial value - for this relaiton and we then look for the new value(s) in the parameter - (qualified) - 3. if the value returned is different from the initial value, an database update - request is done + * check if the field has been modified (if not, proceed to the next + relation) + + * build an rql expression to update the entity -3. For each entity to edit: +At the end, all rql expressions are executed. - 1. if a qualified parameter `__linkto` is specified, its value has to be - a string (or a list of string) such as: :: +* For each entity to edit: + + * if a qualified parameter `__linkto` is specified, its value has + to be a string (or a list of strings) such as: :: :: - where is either `subject` or `object` and each eid could be - separated from the others by a `_`. Target specifies if the *edited entity* - is subject or object of the relation and each relation specified will - be inserted. + where is either `subject` or `object` and each eid could + be separated from the others by a `_`. Target specifies if the + *edited entity* is subject or object of the relation and each + relation specified will be inserted. - 2. if a qualified parameter `__clone_eid` is specified for an entity, the - relations of the specified entity passed as value of this parameter are - copied on the edited entity. - - 3. if a qualified parameter `__delete` is specified, its value must be - a string or a list of string such as follows: :: - - :: + * if a qualified parameter `__clone_eid` is specified for an entity, the + relations of the specified entity passed as value of this parameter are + copied on the edited entity. - where each eid subject or object can be seperated from the other - by `_`. Each relation specified will be deleted. + * if a qualified parameter `__delete` is specified, its value must be + a string or a list of string such as follows: :: - 4. if a qualified parameter `__insert` is specified, its value should - follow the same pattern as `__delete`, but each relation specified is - inserted. + :: -4. If the parameters `__insert` and/or `__delete` are found not qualified, - they are interpreted as explained above (independantly from the number - of entities edited). + where each eid subject or object can be seperated from the other + by `_`. Each specified relation will be deleted. + -5. If no entity is edited but the form contains the parameters `__linkto` - and `eid`, this one is interpreted by using the value specified for `eid` - to designate the entity on which to add the relations. +* If no entity is edited but the form contains the parameters `__linkto` + and `eid`, this one is interpreted by using the value specified for `eid` + to designate the entity on which to add the relations. .. note:: diff -r 1fc46a6287a7 -r b44bad36e609 doc/book/en/devweb/js.rst --- a/doc/book/en/devweb/js.rst Wed May 05 15:29:39 2010 +0200 +++ b/doc/book/en/devweb/js.rst Wed May 05 16:52:27 2010 +0200 @@ -22,8 +22,8 @@ .. XXX external_resources variable (which needs love) -CubicWeb javascript API -~~~~~~~~~~~~~~~~~~~~~~~ +Server-side Javascript API +~~~~~~~~~~~~~~~~~~~~~~~~~~ Javascript resources are typically loaded on demand, from views. The request object (available as self._cw from most application objects, @@ -39,8 +39,8 @@ snippet inline in the html headers. This is quite useful for setting up early jQuery(document).ready(...) initialisations. -CubicWeb javascript events -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Javascript events +~~~~~~~~~~~~~~~~~ * ``server-response``: this event is triggered on HTTP responses (both standard and ajax). The two following extra parameters are passed @@ -53,8 +53,8 @@ ajax request, otherwise the document itself for standard HTTP requests. -Important AJAX APIS -~~~~~~~~~~~~~~~~~~~ +Important javascript AJAX APIS +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * `asyncRemoteExec` and `remoteExec` are the base building blocks for doing arbitrary async (resp. sync) communications with the server @@ -72,10 +72,10 @@ A simple example with asyncRemoteExec ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -In the python side, we have to extend the BaseController class. The -@jsonize decorator ensures that the `return value` of the method is -encoded as JSON data. By construction, the JSonController inputs -everything in JSON format. +In the python side, we have to extend the ``BaseController`` +class. The ``@jsonize`` decorator ensures that the return value of the +method is encoded as JSON data. By construction, the JSonController +inputs everything in JSON format. .. sourcecode: python @@ -225,13 +225,13 @@ `http://myinstance/json?`). The actual JSonController method name is encoded in the `params` dictionary using the `fname` key. -A more real-life example from CubicWeb -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +A more real-life example +~~~~~~~~~~~~~~~~~~~~~~~~ -A frequent use case of Web 2 applications is the delayed (or -on-demand) loading of pieces of the DOM. This is typically achieved -using some preparation of the initial DOM nodes, jQuery event handling -and proper use of loadxhtml. +A frequent need of Web 2 applications is the delayed (or demand +driven) loading of pieces of the DOM. This is typically achieved using +some preparation of the initial DOM nodes, jQuery event handling and +proper use of loadxhtml. We present here a skeletal version of the mecanism used in CubicWeb and available in web/views/tabs.py, in the `LazyViewMixin` class. @@ -317,9 +317,6 @@ } - - -.. XXX reloadComponent .. XXX userCallback / user_callback Javascript library: overview diff -r 1fc46a6287a7 -r b44bad36e609 web/data/cubicweb.edition.js --- a/web/data/cubicweb.edition.js Wed May 05 15:29:39 2010 +0200 +++ b/web/data/cubicweb.edition.js Wed May 05 16:52:27 2010 +0200 @@ -402,6 +402,7 @@ } _displayValidationerrors(formid, descr[0], descr[1]); updateMessage(_('please correct errors below')); + // ensure the browser does not scroll down document.location.hash = '#header'; return false; }