doc/book/en/devweb/request.rst
changeset 9580 abaae1496ba4
parent 9183 95e69c2d52a9
child 10222 75d6096216d7
equal deleted inserted replaced
9579:d5b0e1f4c5c5 9580:abaae1496ba4
    18 
    18 
    19 * `Browser control`:
    19 * `Browser control`:
    20 
    20 
    21   * `ie_browser`: tells if the browser belong to the Internet Explorer
    21   * `ie_browser`: tells if the browser belong to the Internet Explorer
    22     family
    22     family
    23   * `xhtml_browser`: tells if the browser is able to properly handle
       
    24     XHTML (at the HTTP content_type level)
       
    25 
    23 
    26 * `User and identification`:
    24 * `User and identification`:
    27 
    25 
    28   * `user`, instance of `cubicweb.entities.authobjs.CWUser` corresponding to the
    26   * `user`, instance of `cubicweb.entities.authobjs.CWUser` corresponding to the
    29     authenticated user
    27     authenticated user
    30 
    28 
    31 * `Session data handling`
    29 * `Session data handling`
    32 
    30 
    33   * `session.data` is the dictionnary of the session data; it can be manipulated like an ordinary Python dictionnary
    31   * `session.data` is the dictionary of the session data; it can be
       
    32     manipulated like an ordinary Python dictionary
    34 
    33 
    35 * `Edition` (utilities for edition control):
    34 * `Edition` (utilities for edition control):
    36 
    35 
    37   * `cancel_edition`: resets error url and cleans up pending operations
    36   * `cancel_edition`: resets error url and cleans up pending operations
    38   * `create_entity`: utility to create an entity (from an etype,
    37   * `create_entity`: utility to create an entity (from an etype,
   102   * `set_content_type(content_type, filename=None)`, adds the header HTTP
   101   * `set_content_type(content_type, filename=None)`, adds the header HTTP
   103     'Content-Type'
   102     'Content-Type'
   104   * `get_header(header)`, returns the value associated to an arbitrary header
   103   * `get_header(header)`, returns the value associated to an arbitrary header
   105     of the HTTP request
   104     of the HTTP request
   106   * `set_header(header, value)`, adds an arbitrary header in the response
   105   * `set_header(header, value)`, adds an arbitrary header in the response
   107   * `cursor()` returns a RQL cursor on the session
   106   * `execute(*args, **kwargs)`, executes an RQL query and return the result set
   108   * `execute(*args, **kwargs)`, shortcut to ``.cursor().execute()``
       
   109   * `property_value(key)`, properties management (`CWProperty`)
   107   * `property_value(key)`, properties management (`CWProperty`)
   110   * dictionary `data` to store data to share informations between components
   108   * dictionary `data` to store data to share informations between components
   111     *while a request is executed*
   109     *while a request is executed*
   112 
   110 
   113 Please note that this class is abstract and that a concrete implementation
   111 Please note that this class is abstract and that a concrete implementation
   118 
   116 
   119 API
   117 API
   120 ```
   118 ```
   121 
   119 
   122 The elements we gave in overview for above are built in three layers,
   120 The elements we gave in overview for above are built in three layers,
   123 from ``cubicweb.req.RequestSessionBase``, ``cubicweb.dbapi.DBAPIRequest`` and
   121 from ``cubicweb.req.RequestSessionBase``, ``cubicweb.repoapi.ClientConnection`` and
   124 ``cubicweb.web.CubicWebRequestBase``.
   122 ``cubicweb.web.ConnectionCubicWebRequestBase``.
   125 
   123 
   126 .. autoclass:: cubicweb.req.RequestSessionBase
   124 .. autoclass:: cubicweb.req.RequestSessionBase
   127    :members:
   125    :members:
   128 
   126 
   129 .. autoclass:: cubicweb.dbapi.DBAPIRequest
   127 .. autoclass:: cubicweb.repoapi.ClientConnection
   130    :members:
   128    :members:
   131 
   129 
   132 .. autoclass:: cubicweb.web.request.CubicWebRequestBase
   130 .. autoclass:: cubicweb.web.request.ConnectionCubicWebRequestBase
   133    :members:
   131    :members: