README

GSB 11 Extension gsb_rss

About

This extension makes it possible to provide RSS feeds based on the search. filtered search result lists can be provided as rss feeds

Learn more about the GSB 11.

Installation

The best way to install this extension is to start with the GSB Sitepackage Kickstarter extension.

Quick installation without GSB Sitepackage Kickstarter

In a composer-based TYPO3 installation you can install the extension EXT:gsb_rss via composer:

  composer config -g gitlab-domains gitlab.opencode.de && \
  composer config -g repositories.gsb-rss vcs https://gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_rss

  composer require itzbund/gsb-rss

Feature flags

Feature flags are configured in the .env or the local-dev/.ddev/docker-compose.environment.yaml file on ddev machine. To add a feature flag, use the following syntax:

# Feature flag for the specific tickets. Set them to true to activate the features.
- GSB11_FEATURE_1234_ENHANCED_PHP_PERFORMANCE=%const(bool:true)%

In this example, the feature flag GSB11_FEATURE_1234_ENHANCED_PHP_PERFORMANCE is set to true. To disable the feature, change the value to false or delete the setting.

Feature Flag Truth Table

This table illustrates the behavior of feature flags in various states.

Curent feature flags of gsb_rss

Usage in PHP Code

To use a feature flag in your PHP code, you can check the flag's value in the global TYPO3 configuration. Here's an example:

if (GeneralUtility::makeInstance(Features::class)->isFeatureEnabled('GSB11_FEATURE_1234_ENHANCED_PHP_PERFORMANCE')) {
    // Only if the feature flag is set to true the feature is activated
    // Feature-specific code goes here
}

In this example, the feature-specific code will only execute if the feature flag GSB11_FEATURE_1234_ENHANCED_PHP_PERFORMANCE is set to true.

Usage in Fluid Templates

You can also use feature flags in your Fluid templates with a custom ViewHelper. First, ensure you include the namespace for the ViewHelper:

{namespace gsb=ITZBund\GsbCore\ViewHelpers}

Then, use the featureFlag ViewHelper to conditionally render content based on the feature flag:

<f:if condition="{gsb:featureFlag(featureKey: 'GSB11_FEATURE_1234_ENHANCED_PHP_PERFORMANCE')}">
    <!-- Feature-specific content goes here -->
</f:if>

Usage

Nothing to do.

Contribute

As with TYPO3, we encourage you to join the project by submitting changes. Development of the GSB 11 happens mainly in the GSB 11 TYPO3 extension repositories.

To get started, have a look at our detailed contribution walkthrough.