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

Use FQCN for SetRegistry/SetCollector #4831

Merged
merged 6 commits into from
Oct 15, 2024
Merged
Changes from 2 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
12 changes: 6 additions & 6 deletions Documentation/ApiOverview/SiteHandling/SiteSets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -392,12 +392,12 @@ already been validated, converted and, if not set, the default value is used.
SetRegistry
-----------

The `SetRegistry` retrieves the site sets found in an ordered sequence, as
The :php:`TYPO3\CMS\Core\Site\Set\SetRegistry` retrieves the site sets found in an ordered sequence, as
defined by `dependencies` in `config.yaml`. Please preferably use the site
object to access the required data. However, if you need to query one or more
site set definitions in order as defined by dependencies, then `SetRegistry`
site set definitions in order as defined by dependencies, then :short:`SetRegistry`
is the right place to go. To read all site set definitions, please
use `SetCollector`.
use :php:`TYPO3\CMS\Core\Site\Set\SetCollector`.

.. _site-sets-php-api-setregistry-getsets:

Expand Down Expand Up @@ -438,7 +438,7 @@ SetCollector
~~~~~~~~~~~~

TYPO3 comes with a new `ServiceProvider`, which goes through all extensions
with the first instantiation of the `SetCollector` and reads all site set
with the first instantiation of the :short:`SetCollector` and reads all site set
definitions found.

.. code-block:: php
Expand All @@ -450,8 +450,8 @@ definitions found.

However, this is not the official way to access the site set definitions and
their dependencies. Please access the configuration via the site object.
Alternatively, you can also use the `SetRegistry`, as only this manages the
Alternatively, you can also use the :short:`SetRegistry`, as only this manages the
site sets in the order declared by the dependency specification.

Only use the `SetCollector` if you need to read all site set definitions.
Only use the :short:`SetCollector` if you need to read all site set definitions.
Dependencies are not taken into account here.
Loading