Public API and stability

This extension was extracted from another extension to provide a stable, reusable API that other extensions can build on and rely on. To keep that promise meaningful, the API surface is split into a public part covered by backward-compatibility guarantees and an internal part that may change at any time.

Public API

The following types form the public API. Depend on these interfaces and types:

Type	Purpose
`FGTCLBEnvironmentStateManagerStateManagerInterface`	Central service to backup, bootstrap, apply, restore and execute within an environment.
`FGTCLBEnvironmentStateManagerEnvironmentBuilderFactoryInterface`	Resolves a TYPO3 core-version compatible environment builder.
`FGTCLBEnvironmentStateManagerEnvironmentBuilderInterface`	Builds a `StateInterface` for a given build context.
`FGTCLBEnvironmentStateManagerStateInterface`	Immutable snapshot of the bootstrapped environment elements (request, context, backend user, language service, ...).
`FGTCLBEnvironmentStateManagerStateBuildContext`	DTO describing which environment to build (application type, page and language; backend user and workspace for backend environments).
`FGTCLBEnvironmentStateManagerEventStateApplyEvent`, `FGTCLBEnvironmentStateManagerEventStateBackupEvent`	PSR-14 events to react on state changes.
`FGTCLBEnvironmentStateManagerExceptionNoTypo3VersionCompatibleEnvironmentBuilderFound`, `FGTCLBEnvironmentStateManagerExceptionSiteConfigCouldNotBeDetermined`	Exceptions thrown by the API.

The TYPO3 core-version specific Core12ExtendedStateInterface and Core13ExtendedStateInterface extend StateInterface and are part of the public API as well. They carry the version-specific parts of the state contract: the TypoScriptFrontendController accessors (withTypoScriptFrontendController() and typoScriptFrontendController()) are declared here, and not on the version-agnostic StateInterface, because the TypoScriptFrontendController is deprecated in TYPO3 v13 and removed in TYPO3 v14. Type-hint the version-agnostic StateInterface in code that should work across core versions, and only reference an ExtendedStateInterface when you explicitly target a specific TYPO3 core version.

Internal implementation details

The concrete, TYPO3 core-version specific implementations under the FGTCLBEnvironmentStateManagerCore12 and FGTCLBEnvironmentStateManagerCore13 namespaces – for example Core13StateManager, Core13FrontendEnvironmentBuilder and Core13State – as well as the EnvironmentBuilderFactory and the internal traits are marked @internal. They are registered as dependency injection services and resolved to the implementation matching the running TYPO3 core version.

Warning

Never type-hint or instantiate the core-version specific classes directly. Always inject the interfaces; the dependency injection container provides the implementation for the current TYPO3 core version. Their constructor signatures already differ between core versions and may change at any time without a backward-compatibility break.