Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 13.4] [TASK] Remove duplicate FlexForm example #5417

Merged
merged 5 commits into from
Mar 5, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 35 additions & 33 deletions Documentation/ExtensionArchitecture/HowTo/Configuration.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. include:: /Includes.rst.txt
.. index:: Extension; Configuration
.. _extension_configuration:
.. include:: /Includes.rst.txt
.. index:: Extension; Configuration
.. _extension-configuration:

=============
Configuration
Expand All @@ -13,9 +13,10 @@ various options described here each differs in:
plugin)
* the access level required to make the change (editor, admin)

.. index::
TypoScript
Configuration; TypoScript
.. index::
TypoScript
Configuration; TypoScript
.. _extension-configuration-typoscript-constants:

TypoScript and constants
========================
Expand All @@ -24,16 +25,18 @@ You can define configuration options using TypoScript.
These options can be changed via TypoScript constants and setup in the backend.
The changes apply to the current page and all subpages.

.. seealso::
.. seealso::

* :ref:`Extbase TypoScript configuration <extbase_typoscript_configuration>`

* :ref:`Extbase TypoScript configuration <extbase_typoscript_configuration>`
* :ref:`t3tsref:typoscript-syntax-what-are-constants`

* :ref:`t3tsref:typoscript-syntax-what-are-constants`

.. index::
Configuration; Extension configuration
Files; ext_conf_template.txt

.. index::
Configuration; Extension configuration
Files; ext_conf_template.txt
.. _extension-configuration-global:

Extension configuration
=======================
Expand All @@ -42,42 +45,39 @@ Extension configuration is defined in the file :file:`ext_conf_template.txt`
using TypoScript constant syntax.

The configuration options you define in this file can be changed in the
backend :guilabel:`Admin Tools > Settings > Extension Configuration` and is stored in :file:`config/system/settings.php`.
backend :guilabel:`Admin Tools > Settings > Extension Configuration` and is
stored in :file:`config/system/settings.php`.

Use this file for general options that should be globally applied to the extension.
Use this file for general options that should be globally applied to
the extension.

.. seealso::
.. seealso::

* :ref:`extension-options`
* :ref:`extension-options`


.. index:: FlexForms
.. index:: FlexForms

.. _extension-configuration-flexforms:

FlexForms
=========

FlexForms can be configured in the backend by editors. With FlexForms you can
configure each plugin or content element individually without adding extra fields to the :sql:`tt_content` table.
`FlexForms <https://docs.typo3.org/permalink/t3coreapi:flexforms>`_ define
forms that can be used by editors to configure plugins and content elements.

In Extbase plugins, settings made in the FlexForm of a plugin
override settings made in the TypoScript configuration of that plugin.

.. note::

If you wish to access a setting set via FlexForm in Extbase from your controller via
:php:`$this->settings`, the name of the setting must begin with **settings**,
directly followed by a dot (`.`).
If you want to access a setting via FlexForm in Extbase from your controller via
:php:`$this->settings`, the name of the setting must begin with **settings**,
directly followed by a dot (`.`).

.. seealso::

* :ref:`flexforms`


Example
-------

.. include:: /CodeSnippets/Extbase/Configuration/PluginSettings.rst.txt
* `FlexForms <https://docs.typo3.org/permalink/t3coreapi:flexforms>`_

.. _extension-configuration-settings:

Access settings
===============
Expand All @@ -86,9 +86,11 @@ The settings can be read using :php:`$this->settings` in an
Extbase controller action and via :html:`{settings}` within Fluid.

Example: Access settings in an Extbase controller
--------------------------------------------------
-------------------------------------------------

.. include:: /CodeSnippets/Extbase/Controllers/Settings.rst.txt

.. include:: /CodeSnippets/Extbase/Controllers/Settings.rst.txt
.. _extension-configuration-yaml:

YAML
====
Expand Down