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

Move section html templates

Browse Source 
Signed-off-by: Christian Wolf <github@christianwolf.email>
This commit is contained in:
Christian Wolf
2025-02-28 13:02:53 +01:00
parent e3989934a2
commit 2f1bc359c4
1 changed files with 34 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
developer_manual/basics/controllers.rst
View File

@@ -347,9 +347,43 @@ This can be in the form of a Response subclass or in the form of a value that ca
HTML-based Responses
--------------------
.. _controller_template:
Templates
^^^^^^^^^
A :doc:`template <front-end/templates>` can be rendered by returning a TemplateResponse. A TemplateResponse takes the following parameters:
* **appName**: tells the template engine in which app the template should be located
* **templateName**: the name of the template inside the templates/ folder without the .php extension
* **parameters**: optional array parameters that are available in the template through $_, e.g.::
array('key' => 'something')
can be accessed through::
$_['key']
* **renderAs**: defaults to *user*, tells Nextcloud if it should include it in the web interface, or in case *blank* is passed solely render the template
.. code-block:: php
<?php
namespace OCA\MyApp\Controller;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\TemplateResponse;
class PageController extends Controller {
public function index(): TemplateResponse {
$templateName = 'main'; // will use templates/main.php
$parameters = array('key' => 'hi');
return new TemplateResponse($this->appName, $templateName, $parameters);
}
}
Public page templates
^^^^^^^^^^^^^^^^^^^^^
@@ -532,41 +566,6 @@ Because returning values works fine in case of a success but not in case of fail
}
Templates
^^^^^^^^^
A :doc:`template <front-end/templates>` can be rendered by returning a TemplateResponse. A TemplateResponse takes the following parameters:
* **appName**: tells the template engine in which app the template should be located
* **templateName**: the name of the template inside the templates/ folder without the .php extension
* **parameters**: optional array parameters that are available in the template through $_, e.g.::
array('key' => 'something')
can be accessed through::
$_['key']
* **renderAs**: defaults to *user*, tells Nextcloud if it should include it in the web interface, or in case *blank* is passed solely render the template
.. code-block:: php
<?php
namespace OCA\MyApp\Controller;
use OCP\AppFramework\Controller;
use OCP\AppFramework\Http\TemplateResponse;
class PageController extends Controller {
public function index(): TemplateResponse {
$templateName = 'main'; // will use templates/main.php
$parameters = array('key' => 'hi');
return new TemplateResponse($this->appName, $templateName, $parameters);
}
}
Public page templates
^^^^^^^^^^^^^^^^^^^^^