.. include:: /Includes.rst.txt

.. index:: Extbase; View
.. _extbase-view:

================
View
================

The result of an action or a chain of actions is usually a view where output,
most often as HTML is displayed to the user.

The action, located in the controller returns a :php:`ResponseInterface`
(:php:`Psr\Http\Message\ResponseInterface`)
which contains the result of the view. The view, property :php:`$view` of type
:php:`ViewInterface` (:php:`TYPO3Fluid\Fluid\View\ViewInterface`).

In the most common case it is sufficient to just set some variables on the
:php:`$view` and return :php:`$this->htmlResponse()`:

.. include:: /CodeSnippets/Extbase/View/HtmlResponse.rst.txt

Read more in the section :ref:`extbase_responses`.

View configuration
===================

The view can be configured with TypoScript:

.. include:: /CodeSnippets/Extbase/View/TypoScript.rst.txt

.. _extbase_responses:

Responses
==========

HTML response
--------------

In the most common case it is sufficient to just set some variables on the
:php:`$view` and return :php:`$this->htmlResponse()`. The Fluid templates
will then configure the rendering:

.. include:: /CodeSnippets/Extbase/View/HtmlResponse.rst.txt

It is also possible to directly pass a HTML string to the function
:php:`htmlResponse()`. This way other templating engines but Fluid can be used:

.. include:: /CodeSnippets/Extbase/View/HtmlResponseCustom.rst.txt

.. attention::
   **Never** directly pass user input to the response without proper escaping.
   See :ref:`security-xss`.

JSON response
--------------

Similar to the method :php:`$this->htmlResponse()` there is a method
:php:`$this->jsonResponse()`. In case you are using it you have to make sure
the view renders valid JSON.

Rendering JSON by Fluid is in most cases not a good option. Fluid uses special
signs that are needed in JSON etc. So in most cases the :php:`jsonResponse()`
is used to directly output a json string:

.. include:: /CodeSnippets/Extbase/View/JsonResponseCustom.rst.txt

It is also possible to use the JSON response together with a special view class
the :php:`JsonView` (:php:`TYPO3\CMS\Extbase\Mvc\View\JsonView`).

Response in a different format
-------------------------------

If you need any output format but HTML or JSON, build the response object
using :php:`$responseFactory` implementing the
:php:`ResponseFactoryInterface`:

.. include:: /CodeSnippets/Extbase/View/CustomResponse.rst.txt