.. include:: /Includes.rst.txt .. index:: pair: Site handling; PHP .. _sitehandling-php-api: ===================================== PHP API: accessing site configuration ===================================== The PHP API for sites comes in two parts: - Accessing the current, resolved site object - Finding a site object / configuration via a page or identifier The first case is relevant when we want to access the site configuration in the current request, for example, if we want to know which language is currently rendered. The second case is about accessing site configuration options independent of the current request but based on a page ID or a site identifier. Let us look at both cases in detail. Accessing the current site object ================================= When rendering the frontend or backend, TYPO3 builds an HTTP request object through a :ref:`PSR-15 middleware stack ` and enriches it with information. Part of that information are the objects :php:`\TYPO3\CMS\Core\Site\Entity\Site` and :php:`\TYPO3\CMS\Core\Site\Entity\SiteLanguage`. Both objects are available as :ref:`attributes ` in the current :ref:`request object `. Depending on the context, there are two main ways to access them: - via the PSR-7 HTTP request object directly - for example in a PSR-15 middleware, an :ref:`Extbase controller ` or a :ref:`user function `. - via :php:`$GLOBALS['TYPO3_REQUEST']` - everywhere you do not have a request object. .. hint:: The first method is preferred if possible as :php:`$GLOBALS['TYPO3_REQUEST']` was deprecated in TYPO3 v9.2 and will be removed in a future version. Methods: .. code-block:: php :caption: EXT:my_extension/Classes/MyClass.php // current site $site = $request->getAttribute('site'); // current site language $siteLanguage = $request->getAttribute('language'); .. versionchanged:: 11.3 The :ref:`Extbase ` request class implements the PSR-7 :php:`\Psr\Http\Message\ServerRequestInterface`. Therefore you can retrieve all needed attributes from the request object. .. index:: pair: Site handling; SiteFinder .. _sitehandling-site-object: Finding a site object ===================== When you need to access the site configuration for a specific page ID or by a site identifier, you can use the class :php:`\TYPO3\CMS\Core\Site\SiteFinder`. The methods for finding a specific site throw a :php:`\TYPO3\CMS\Core\Exception\SiteNotFoundException` if no site was found. API --- .. include:: /CodeSnippets/Manual/Core/SiteFinder.rst.txt .. index:: pair: Site handling; Site object The site object =============== A :php:`\TYPO3\CMS\Core\Site\Entity\Site` object gives access to the site configuration options via - :php:`getConfiguration()`: returns the complete configuration - :php:`getAttribute()`: returns a specific configuration attribute (root level configuration only) Additionally, the site object provides methods for accessing related objects (languages / errorHandling): - :php:`getErrorHandler()`: returns a :php:`PageErrorHandler` according to the site configuration - :php:`getAvailableLanguages()`: returns languages available to a user (including access checks) - :php:`getLanguageById()`: returns a site language object for a language ID - ... Take a look at the class to find out more: :t3src:`core/Classes/Site/Entity/Site.php`. .. index:: pair: Site handling; SiteLanguage object The site language object ======================== The :php:`SiteLanguage` object is basically a simple model that represents the configuration options of the site regarding language as an object and provides getters for those properties. See :t3src:`core/Classes/Site/Entity/SiteLanguage.php`.