a76e505892
The terminology did not really make sense for a lot of these sub pages. This change should have been done long ago, but was probably delayed because some people in Odoo call the web client the "backend", which is really misleading. This commit also renames the title "Reference Guides" to "Reference", since this section does not contain any guides anyway. Part-of: odoo/documentation#1243
87 lines
2.3 KiB
ReStructuredText
87 lines
2.3 KiB
ReStructuredText
|
|
.. _reference/controllers:
|
|
|
|
===============
|
|
Web Controllers
|
|
===============
|
|
|
|
Controllers
|
|
===========
|
|
|
|
Controllers need to provide extensibility, much like
|
|
:class:`~odoo.models.Model`, but can't use the same mechanism as the
|
|
pre-requisites (a database with loaded modules) may not be available yet (e.g.
|
|
no database created, or no database selected).
|
|
|
|
Controllers thus provide their own extension mechanism, separate from that of
|
|
models:
|
|
|
|
Controllers are created by :ref:`inheriting <python:tut-inheritance>` from :class:`~odoo.http.Controller`.
|
|
Routes are defined through methods decorated with :func:`~odoo.http.route`::
|
|
|
|
class MyController(odoo.http.Controller):
|
|
@route('/some_url', auth='public')
|
|
def handler(self):
|
|
return stuff()
|
|
|
|
To *override* a controller, :ref:`inherit <python:tut-inheritance>` from its
|
|
class and override relevant methods, re-exposing them if necessary::
|
|
|
|
class Extension(MyController):
|
|
@route()
|
|
def handler(self):
|
|
do_before()
|
|
return super(Extension, self).handler()
|
|
|
|
* decorating with :func:`~odoo.http.route` is necessary to keep the method
|
|
(and route) visible: if the method is redefined without decorating, it
|
|
will be "unpublished"
|
|
* the decorators of all methods are combined, if the overriding method's
|
|
decorator has no argument all previous ones will be kept, any provided
|
|
argument will override previously defined ones e.g.::
|
|
|
|
class Restrict(MyController):
|
|
@route(auth='user')
|
|
def handler(self):
|
|
return super(Restrict, self).handler()
|
|
|
|
will change ``/some_url`` from public authentication to user (requiring a
|
|
log-in)
|
|
|
|
API
|
|
===
|
|
|
|
.. _reference/http/routing:
|
|
|
|
Routing
|
|
-------
|
|
|
|
.. autofunction:: odoo.http.route
|
|
|
|
.. _reference/http/request:
|
|
|
|
Request
|
|
-------
|
|
|
|
The request object is automatically set on :data:`odoo.http.request` at
|
|
the start of the request
|
|
|
|
.. autoclass:: odoo.http.WebRequest
|
|
:members:
|
|
:member-order: bysource
|
|
.. autoclass:: odoo.http.HttpRequest
|
|
:members:
|
|
.. autoclass:: odoo.http.JsonRequest
|
|
:members:
|
|
|
|
Response
|
|
--------
|
|
|
|
.. autoclass:: odoo.http.Response
|
|
:members:
|
|
:member-order: bysource
|
|
|
|
.. maybe set this to document all the fine methods on Werkzeug's Response
|
|
object? (it works)
|
|
:inherited-members:
|