Skip to content
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@
Extension folder `Classes` for PHP classes
==========================================

Contains all PHP classes. One class per file. Should have sub folders like
Contains all the PHP classes in an extension, with one class per file. Should have subfolders like
:code:`Controller/`, :code:`Domain/`, :code:`Service/` or :code:`View/`.
For more details on class file namings and PHP namespaces, see chapter
For more details on class file naming and PHP namespaces, see chapter
:ref:`namespaces <namespaces>`.

Typical PHP classes in this folder:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
Extension folder `Configuration/Backend`
========================================

The folder :file:`EXT:my_extension/Configuration/Backend/` may contain
configuration that is important within the TYPO3 Backend.
The folder :file:`EXT:my_extension/Configuration/Backend/` contains
configuration that is important in the TYPO3 Backend.

All files in this directory are automatically included during the TYPO3
All files in this directory are automatically included during TYPO3
bootstrap.

.. _extension-configuration-backend-ajaxroutes:
Expand All @@ -25,8 +25,7 @@ bootstrap.
:regex: /^.*Configuration\/Backend\/AjaxRoutes\.php$/
:shortDescription: Defines routes for backend Ajax requests

In this file routes for Ajax requests that should be used in the backend can
be defined.
Defines file routes for Ajax requests in the backend.

Read more about :ref:`Using Ajax in the backend <ajax-backend>`.

Expand All @@ -40,10 +39,9 @@ bootstrap.
:regex: /^.*Configuration\/Backend\/Routes\.php$/
:shortDescription: Defines routes for backend controllers

This file maps the URI paths used in the backend to the controller that should
be used.
This file maps URI paths in the backend to controllers.

Most backend routes defined in the TYPO3 core can be found in the following
Backend routes defined in the TYPO3 core are in the following
file, which you can use as example:

:t3src:`backend/Configuration/Backend/Routes.php`
Expand All @@ -58,6 +56,6 @@ bootstrap.
:regex: /^.*Configuration\/Backend\/Modules\.php$/
:shortDescription: Defines the backend module configuration

This file is used for the
This file is used for
:ref:`Backend module configuration <backend-modules-configuration>`. See that
chapter for details.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:file:`Persistence`
===================

This folder can contain the following files:
This folder contains the following file:

.. _extension-configuration-extbase-persistence-classes:

Expand All @@ -16,8 +16,8 @@ This folder can contain the following files:
:regex: /^.*Configuration\/Extbase\/Persistence\/Classes\.php$/
:shortDescription: Contains the mapping between a database table and its Extbase model

In the file :file:`EXT:my_extension/Configuration/Extbase/Persistence/Classes.php` the
mapping between a database table and its model can be configured. The mapping
:file:`EXT:my_extension/Configuration/Extbase/Persistence/Classes.php` is
used to configure mapping between a database table and its model. The mapping
in this file overrides the automatic mapping by naming convention.

.. seealso::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
:regex: /^.*Configuration\/Icons\.php$/
:shortDescription: Registration of custom icons

In this file custom icons can be registered in the
This file registers custom icons to the
:php:`\TYPO3\CMS\Core\Imaging\IconRegistry`.

See the :ref:`Icon API <icon>` for details.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,15 @@
Extension folder `Configuration`
================================

The folder :file:`EXT:my_extension/Configuration/` may contain
The folder :file:`EXT:my_extension/Configuration/` contains
configuration of different types.

Some of the sub directories in here have reserved names with special meanings.
Most subdirectories have reserved names.

All files in this directory and in the sub directories :file:`TCA` and
:file:`Backend` are automatically included during the TYPO3 bootstrap.
Files in the root of this directory and in the :file:`TCA` and
:file:`Backend` subdirectories are automatically included during TYPO3 bootstrap.

The following files and folders are commonly found in the :file:`Configuration`
folder:
The typical file structure is:


.. directory-tree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
Page TSconfig can be set using
`the site as Page TSconfig provider <https://docs.typo3.org/permalink/t3tsref:include-static-page-tsconfig-per-site>`_

Only put page TSconfig in this file which absolutely has to be set globally.
Only put global page TSconfig in this file.

.. typo3:file:: page.tsconfig
:scope: extension
Expand All @@ -21,7 +21,7 @@
:shortDescription: Global page TSconfig

In this file global page TSconfig can be stored. It will be automatically
included for all pages.
included in all pages.

For details see
:ref:`Setting the page TSconfig globally <t3tsref:pagesettingdefaultpagetsconfig>`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
`Services.yaml`
===============

It is possible to use a YAML or PHP format:
It is possible to use YAML or PHP format:

.. typo3:file:: Services.yaml
:scope: extension
Expand All @@ -23,7 +23,7 @@ It is possible to use a YAML or PHP format:
:regex: /^.*Configuration\/Services\.php$/
:shortDescription: Dependency injection service configuration

Services can be configured in this file. TYPO3 uses it for:
This file can configure services. TYPO3 uses it for:

* :ref:`Dependency Injection <configure-dependency-injection-in-extensions>`
* :ref:`Event Listeners <EventDispatcherRegistration>`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,12 @@ Extension folder `Configuration/Sets`
`Site sets <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_ have
been introduced.

In this directory TYPO3 extensions can provide their
This directory contains an extension's
`Site sets <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_.

Each set must be saved in its own directory and have at least a file called
:file:`config.yaml`.
Each set must be in its own directory and consist of at least a
:file:`config.yaml` file.


.. _extension-configuration-sets-config-yaml:

Expand All @@ -25,8 +26,8 @@ Each set must be saved in its own directory and have at least a file called
:regex: /^.*Configuration\/Sets\/[\w\-]+\/config\.yaml$/
:shortDescription: Contains the definition of a site set. Mandatory.

Contains the `definition of a site set <https://docs.typo3.org/permalink/t3coreapi:site-sets-definition>`_
and its dependencies.
Contains the `definition of the site set <https://docs.typo3.org/permalink/t3coreapi:site-sets-definition>`_
and any dependencies.

Example:

Expand All @@ -40,8 +41,8 @@ Example:
:regex: /^.*Configuration\/Sets\/[\w\-]+\/settings\.yaml$/
:shortDescription: Override settings defined by other sets.

In this file an extension can override settings defined by other sets. For
example :ref:`Settings provided by site set "Fluid Styled Content" <typo3/cms-fluid-styled-content:site-set-fluid-styled-content-settings>`:
In this file an extension can override settings defined by other sets, for
example, :ref:`settings defined in the "Fluid Styled Content" site set <typo3/cms-fluid-styled-content:site-set-fluid-styled-content-settings>`:

.. literalinclude:: /ApiOverview/SiteHandling/_Sets/_site-package/_settings-map.yaml
:language: yaml
Expand All @@ -66,12 +67,12 @@ Example:
:regex: /^.*Configuration\/Sets\/[\w\-]+\/setup\.typoscript$/
:shortDescription: Provides frontend TypoScript for sites depending on this set.

This file contains the Frontend :ref:`TypoScript <t3tsref:guide-overview>`
that the set should provide. If the
This file contains a set's Frontend
:ref:`TypoScript <t3tsref:guide-overview>`. If the
extension keeps its TypoScript in folder `TypoScript <https://docs.typo3.org/permalink/t3coreapi:extension-configuration-typoscript>`_
for backward compatibility reasons this file **should** contain an import of
file :file:`Configuration/TypoScript/setup.typoscript` for the main set of the
extension:
for backward compatibility reasons, this file **should** import
the :file:`Configuration/TypoScript/setup.typoscript` file in the main
extension set:

.. code-block:: typoscript
:caption: EXT:my_extension/Configuration/Sets/MySet/setup.typoscript
Expand All @@ -87,8 +88,8 @@ Example:
:regex: /^.*Configuration\/Sets\/[\w\-]+\/constants\.typoscript$/
:shortDescription: Provides frontend TypoScript constants for sites depending on this set.

This file contains the Frontend TypoScript Constants that the set should
provide. This file can be used if your extension depends on other extensions
This file contains the Frontend TypoScript Constants in the set.
This file should be used if the extension depends on other extensions
that still rely on TypoScript constants.

.. _extension-configuration-sets-page-tsconfig:
Expand All @@ -100,4 +101,4 @@ Example:
:shortDescription: Provides page TSconfig (backend TypoScript) for sites depending on this set.

This file contains the :ref:`Page TSconfig <t3tsref:pagetoplevelobjects>`
(backend TypoScript) that the set should provide.
(backend TypoScript).
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@
Extension folder `Configuration/TCA`
====================================

The folder :file:`EXT:my_extension/Configuration/TCA/` may contain or override
The folder :file:`EXT:my_extension/Configuration/TCA/` can contain or override
:ref:`TCA (Table Configuration Array) <t3tca:introduction>` data.

All files in this directory are automatically included during the TYPO3
All files in this directory are automatically included during TYPO3
:ref:`bootstrap <bootstrapping>`.

Files within :file:`Configuration/TCA/` files are loaded within a dedicated scope.
This means that variables defined in those files cannot leak to any other
TCA file during the TCA compilation process.
Files in :file:`Configuration/TCA/` are loaded in a dedicated scope.
This means that variables defined in the files cannot leak to other
TCA files during the TCA compilation process.

.. _extension-configuration-tca-table:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
.. versionadded:: 13.1

Page TSconfig can be set using
`the site et as Page TSconfig provider <https://docs.typo3.org/permalink/t3tsref:include-static-page-tsconfig-per-site>`_
`the site set as a Page TSconfig provider <https://docs.typo3.org/permalink/t3tsref:include-static-page-tsconfig-per-site>`_

Default user TSconfig can be provided in file
Default user TSconfig can be put in the file
:ref:`extension-configuration-user_tsconfig`.

.. typo3:file:: something.tsconfig
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@
==================

.. versionchanged:: 13.1
Until TYPO3 v13 frontend TypoScript files where kept in folder
Until TYPO3 v13 frontend TypoScript files were kept in
:path:`EXT:my_extension/Configuration/TypoScript/` by convention.

Extensions that need to be backward compatible should
Extensions that need to be backwardly compatible should
`Support both site sets and TypoScript records <https://docs.typo3.org/permalink/t3tsref:extdev-add-typoscript-sets-v12>`_.

Newly created extensions or site packages should use the
Newly created extensions and site packages should use a
`Site set as a TypoScript provider <https://docs.typo3.org/permalink/t3tsref:typoscript-site-sets-set>`_

TypoScript constants should be stored in a file called :file:`constants.typoscript`
and TypoScript setup in a file called :file:`setup.typoscript`.
TypoScript constants should be stored in the file :file:`constants.typoscript`
and TypoScript setup in :file:`setup.typoscript`.

.. typo3:file:: constants.typoscript
:scope: extension
Expand All @@ -33,19 +33,19 @@ and TypoScript setup in a file called :file:`setup.typoscript`.
:regex: /^.*Configuration\/TypoScript\/.*setup\.typoscript/
:shortDescription: Contains the TypoScript setup of the extension. The path is convention, the file name mandatory.

These two files are made available for inclusion in TypoScript records with
:php:`ExtensionManagementUtility::addStaticFile` in the file
These two files are made available for inclusion in TypoScript records by
:php:`ExtensionManagementUtility::addStaticFile` in
:file:`Configuration/TCA/Overrides/sys_template.php`:

.. literalinclude:: _snippets/_sys_template.php
:caption: EXT:my_extension/Configuration/TCA/Overrides/sys_template.php

It is also possible to use subfolders or a differently named folder. The file
names have to stay exactly the same including case.
It is possible to use subfolders or a differently named folder instead, however, the file
names have to stay the same.

.. warning::
In Sites that use no Site set it is possible, though not recommended,
to provide TypoScript that is always included.
In Sites that don't use Site sets it is possible, though not recommended,
to have TypoScript that is always included.
See :ref:`ext_typoscript_constants_typoscript` and
:ref:`ext_typoscript_setup_typoscript`. These files are not included when
site uses a set.
a site uses a set.
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@
:regex: /^.*Configuration\/user\.tsconfig$/
:shortDescription: Global user TSconfig

In this file global :ref:`user TSconfig <t3tsref:usertsconfig>` can be stored. It will
be automatically included for the whole TYPO3 installation during build time.
This file stores global :ref:`user TSconfig <t3tsref:usertsconfig>`. It is
automatically included for the whole TYPO3 installation during build time.

For details see
:ref:`Setting the user TSconfig globally <t3tsref:usersettingdefaultusertsconfig>`.
For details, see
:ref:`Setting user TSconfig globally <t3tsref:usersettingdefaultusertsconfig>`.


.. code-block:: typoscript
Expand Down
Loading
Loading