khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 17:59:36 +07:00
Code Issues Packages Projects Releases Wiki Activity

Adding some introductions to new chapter structure

Browse Source 
Introduction to responders

Introduction HTML responses

Introduction to data responses

Introduction special reponders

Introduction security considerations

Signed-off-by: Christian Wolf <github@christianwolf.email>
This commit is contained in:
Christian Wolf
2025-02-28 13:52:05 +01:00
parent 27c0ce5720
commit 0935fa8ff5
1 changed files with 22 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
developer_manual/basics/controllers.rst
View File

@@ -342,11 +342,21 @@ Responses
Similar to how every controller receives a request object, every controller method has to return a Response.
This can be in the form of a Response subclass or in the form of a value that can be handled by a registered responder.
There are different kinds of responses available, like HTML-based responses, data responses, or other.
The app decides of which kind the response is, by returning an appropriate ``Response`` object in the corresponding controller method.
The following sections give an overview over the various kinds and how to implement them.
.. _controller_html_responses:
HTML-based Responses
--------------------
HTML pages are typically served using template responses.
This is typically used as a starting point to load the website.
This code linked by the template is by default encapsulated by the server to provide some common styling (e.g. the header row).
The code then uses JavaScript to load further components (see :ref:`Frontend building in Vue<ApplicationJs>`) and the actual data.
This section only focuses on the actual HTML content, not the data to fill into the dynamic pages.
.. _controller_template:
Templates
@@ -428,6 +438,12 @@ class implementing the ``OCP\\AppFramework\\Http\\Template\\IMenuAction`` interf
Data-based responses
--------------------
In contrast to the HTML template responses, the data responses return some user-data in packed form.
There are different encodings thinkable like JSON, XML, or other formats.
The main point is that the data is requested by the browser using JavaScript on behalf of the shown website.
The user only indirectly requested the data by user interaction with the frontend.
.. _ocscontroller:
OCS
@@ -638,6 +654,9 @@ Because returning values works fine in case of a success but not in case of fail
Miscellaneous responses
-----------------------
Some special responses are available as well.
These are discussed here.
Redirects
^^^^^^^^^
@@ -758,6 +777,9 @@ If you want to use a custom, lazily rendered response simply implement the inter
Security considerations
-----------------------
Depending on your use-case, you can tighten or loosen the security measurements installed by default on the routes.
This section gives you a quick overview over the options.
.. _controller_authentication:
Authentication