PHP Class FluidTYPO3\Flux\Utility\CompatibilityRegistry
Utility class responsible for keeping and providing
arbitrary values (such as configuration defaults, class
names, feature flags etc.) based on the version of
TYPO3 being used, or based on arbitrary versions of
packages, extensions, PHP, PHP modules, binaries etc.
Usage example
-------------
Use \FluidTYPO3\Flux\Utility\CompatibilityRegistry;
CompatibilityRegistry::register(
'FluidTYPO3\\Flux\\Backend\\Preview',
array(
'6.2.0' => 'FluidTYPO3\\Flux\\Backend\\LegacyPreview',
'7.1.0' => 'FluidTYPO3\\Flux\\Backend\\Preview'
)
);
$classWhichApplies = CompatibilityRegistry::get(
'FluidTYPO3\\Flux\\Backend\\Preview'
);
Also supports reading a specific version's applied value:
$legacyClassName = CompatibilityRegistry::get(
'FluidTYPO3\\Flux\\Backend\\Preview',
'7.1.0'
);
And a default to be used if nothing can be resolved:
$classOrDefault = CompatibilityRegistry::get(
'FluidTYPO3\\Flux\\Backend\\Preview',
NULL,
'FluidTYPO3\\Flux\\Backend\\UnsupportedPreview'
);
(note that
NULL is passed as version which means we
attempt to resolve the currently running version's best
match. It is still possible to pass a specific version
number here).
Another example - say you created a backend module and
need it to work with a custom stylesheet on multiple
versions of TYPO3 which are styled differently:
CompatibilityRegistry::register(
'MyExtension',
'/mySpecialNameForTheStylesheet',
array(
'6.2.0' => 'EXT:my_extension/.../Styles.6.2.0.css',
'7.2.0' => 'EXT:my_extension/.../Styles.7.2.0.css',
'7.5.0' => 'EXT:my_extension/.../Styles.7.5.0.css'
)
);
And to retrieve:
$styleSheet = CompatibilityRegistry::get(
'MyExtension/mySpecialNameForTheStylesheet'
);
And to illustrate, if...:
- TYPO3 is 6.2.* obviously the '6.2.0' entry is used
- TYPO3 is 7.1.0 the '6.2.0' is used because '7.2.' is too high
- TYPO3 is 7.4.0 the '7.2.0' is used
- TYPO3 is anything at or above 7.5.0 then '7.5.0' is used
Feature Flags
-------------
The Compatibility Registry can also handle feature
flags for you; returning the closest matching set of
or individual feature flag based on version:
CompatibilityRegistry::registerFeatureFlags(
'FluidTYPO3.Flux',
array(
'6.2.0' => array('form', 'nestedContent', 'provider', 'preview'),
'7.5.0' => array('form', 'nestedContent', 'provider', 'preview', 'formengine'),
'7.6.0' => array('form', 'provider', 'preview', 'formengine')
)
);
And to retrieve:
if (CompatibilityRegistry::hasFeatureFlag('FluidTYPO3.Flux', 'nestedContent')) {
Would only be true until TYPO3 version hits 7.6.0, then
no longer triggers.
}
Deprecation
-----------
Because usage of CompatibilityRegistry is a very clear
intention of *supporting deprecation*, there is a built-in
layer warning of deprecation when you *register* either
values or feature flags but *do not include a currently
supported TYPO3 version* (as far as Flux is aware). To
disable this deprecation reporting simply pass TRUE as
the last parameter for either of the register commands:
CompatibilityRegistry::register('MyClass', array(...), TRUE);
CompatibilityRegistry::registerFeatureFlag('MyExt', array(...), TRUE);
Doing so merely prevents the check for whether or not you
include a value or feature flag for a non-deprecated TYPO3.
Extension versions as key
-------------------------
It is possible to make a registered variable or feature
flag not depend on the TYPO3 version but instead the
version of any arbitrary package - like a composer
dependency or version of PHP. To utilise this slightly
off-standard registry behavior, *manually include the
version you are checking against when you retrieve the
values from the registry*.
Say your extension depends on extension "comments"
(fictional) but "comments" may be installed in several
versions that can be supported without breaking, as
long as certain features are not enabled:
CompatibilityRegistry::registerFeatureFlags(
'MyExt',
array(
'3.1.0' => array('falRelations'),
'4.0.0' => array('falRelations', 'ajax')
),
TRUE
Note: *always* pass true here; the versions we record
aren't for TYPO3 so we don't want deprecation warnings.
);
$extensionVersion = ExtensionManagementUtility::getExtensionVersion('comments');
if (CompatibilityRegistry::hasFeatureFlag('MyExt', 'ajax', $extensionVersion) {
It's okay to use our fresh feature that depends on
the version of "comments" extension, not TYPO3 itself.
}
Which naturally means that only if the "comments"
extension is installed in at least version 4.0.0 will
the "ajax" feature flag query be TRUE.
Show file
Open project: fluidtypo3/flux
Class Usage Examples
Protected Properties
Public Methods
Protected Methods
Method Details
cache()
protected static method
get()
public static method
getFeatureFlags()
public static method
hasFeatureFlag()
public static method
register()
public static method
registerFeatureFlags()
public static method
resolveVersion()
protected static method
resolveVersionedValue()
protected static method
Property Details
$cache protected static property
|
protected static array $cache |
| return |
array |
|
$featureFlags protected static property
|
protected static array $featureFlags |
| return |
array |
|
$registry protected static property
|
protected static array $registry |
| return |
array |
|
