diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/interfaces.rst | 22 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/narr/views.rst | 43 |
3 files changed, 64 insertions, 2 deletions
diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst new file mode 100644 index 000000000..e174966a4 --- /dev/null +++ b/docs/api/interfaces.rst @@ -0,0 +1,22 @@ +.. _interfaces_module: + +:mod:`repoze.bfg.interfaces` +============================ + +Request-related interfaces +--------------------------- + +.. automodule:: repoze.bfg.interfaces + + .. autoclass:: IRequest + + .. autoclass:: IGETRequest + + .. autoclass:: IPOSTRequest + + .. autoclass:: IPUTRequest + + .. autoclass:: IDELETERequest + + .. autoclass:: IHEADRequest + diff --git a/docs/index.rst b/docs/index.rst index 917bf8fe4..13edb8a48 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -47,6 +47,7 @@ Per-module :mod:`repoze.bfg` API documentation. :maxdepth: 2 api/events + api/interfaces api/push api/router api/security diff --git a/docs/narr/views.rst b/docs/narr/views.rst index 8cb00767a..3b60d1394 100644 --- a/docs/narr/views.rst +++ b/docs/narr/views.rst @@ -264,13 +264,52 @@ View Request Types You can optionally add a *request_type* attribute to your ``view`` declaration, which indicates what "kind" of request the view should be -used for. For example: +used for. If the request type for a request doesn't match the request +type that a view defines as its ``request_type`` argument, that view +won't be called. + +For example: .. code-block:: xml :linenos: <view - for=".models.IHello" + for=".models.Hello" + view=".views.handle_post" + name="handle_post" + request_type="repoze.bfg.interfaces.IPOSTRequest" + /> + +The above example registers a view for the ``IPOSTRequest`` type, so +it will only be called if the request is a POST request. Even if all +the other specifiers match (e.g. the model type is the class +``.models.Hello``, and the view_name is ``handle_post``), if the +request verb is not POST, it will not be invoked. This provides a way +to ensure that views you write are only called via specific HTTP +verbs. + +The least specific request type is ``repoze.bfg.interfaces.IRequest``. +All requests are guaranteed to implement this request type. It is +also the default request type for views that omit a ``request_type`` +argument. + +:mod:`repoze.bfg` also makes available more specific request types +matching HTTP verbs. When these are specified as a ``request_type`` +for a view, the view will be called only when the request has an HTTP +verb (aka HTTP method) matching the request type. See +:ref:`interfaces_module` for more information about available request +types. + +Custom View Request Types +------------------------- + +You can make use of *custom* view request types. For example: + +.. code-block:: xml + :linenos: + + <view + for=".models.Hello" view=".views.hello_json" name="hello.json" request_type=".interfaces.IJSONRequest" |
