itzbund / gsb-permissions
GSB11 Permission collection for the Goverment Site Build (GSB) 11. Der GSB 11 ist eine Maßnahme der Dienstekonsolidierung Bund (DKB) des Bundesministeriums des Innern und für Heimat (BMI) und wird im Auftrag des Informationstechnikzentrums Bund (ITZBund) durchgeführt.
Maintainers
Details
gitlab.opencode.de/bmi/government-site-builder-11/extensions/gsb_permissions.git
Installs: 0
Dependents: 0
Suggesters: 0
Security: 0
Type:typo3-cms-extension
pkg:composer/itzbund/gsb-permissions
Requires
- php: ^8.3
- b13/permission-sets: ^1.0
- typo3/cms-core: ^13.4
Requires (Dev)
- ergebnis/composer-normalize: ^2.47.0
- helmich/typo3-typoscript-lint: ^3.3.0
- phpmd/phpmd: ^2.13
- ssch/typo3-rector: ^3.5
- typo3/coding-standards: ^0.8
- typo3/testing-framework: ^8.2
Suggests
- ext-redis: *
This package is auto-updated.
Last update: 2025-10-16 07:38:51 UTC
README
GSB 11 Extension gsb-permission
About
This extension collects the gsb11 standard permissions.
Installation
The best way to install this extension is to start with the GSB Sitepackage Kickstarter extension.
Configuration
Nothing to do.
Feature Flags
This document explains how to use feature flags. We separate between two different kinds of feature flags:
Feature
Feature flags allow you to enable or disable specific features in your installation. \ This is of particular importance to disable features that have not passed the approval process.
Optional
Optional flags allow you to (de-)activate specific features for your installation. \ A practical use for these is the (de-)activation of an extension.
For more information about feature flags in TYPO3, please refer to the official TYPO3 Documentation on Feature Flags.
Feature Flag Configuration
Feature and Optional 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
- TYPO3__SYS__features__GSB11_FEATURE_123_NEW_FEATURE=%const(bool:true)%
# OPTIONAL FLAG
- TYPO3__SYS__features__GSB11_OPTION_123_ENABLE_EXTENSION=%const(bool:true)%
In this example, both feature flags, GSB11_FEATURE_123_NEW_FEATURE
and GSB11_OPTION_123_ENABLE_EXTENSION
,
are 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.
Feature Flag State | Evaluated Value | Description |
---|---|---|
featureFlag = true | true | The feature is explicitly enabled. |
featureFlag = false | false | The feature is explicitly disabled. |
featureFlag = '' | false | An empty value is treated as false . |
featureFlag not exist | false | A non-existent flag defaults to false . |
Usage in PHP Code
To use a feature flag in your PHP code, you can check the flag's value with the isFeatureEnabled()
method of the Features
class:
if (GeneralUtility::makeInstance(Features::class)->isFeatureEnabled('GSB11_FEATURE_123_NEW_FEATURE')) {
echo 'Feature is enabled';
// Feature-specific code
...
}
Usage in Fluid Templates
Feature flags can also be checked in your Fluid templates with TYPO3's Feature ViewHelper.
Basic usage
<f:feature name="GSB11_FEATURE_123_NEW_FEATURE">
This is being shown if the flag is enabled
</f:feature>
Feature > then > else
<f:feature name="GSB11_OPTION_123_ENABLE_EXTENSION">
<f:then>
Flag is enabled
</f:then>
<f:else>
Flag is undefined or not enabled
</f:else>
</f:feature>
Current feature flags of siteconfig_impexp
Feature flag | Description |
---|---|
currently none | - |
Usage
Configuration Import Command
The extension provides a TYPO3 Console Command that automatically imports configurations for workspaces and backend user groups from YAML files.
Running the Command
# Via TYPO3 Console
./vendor/bin/typo3 gsb_permissions:configuration:import
# Via ddev (if available)
ddev typo3 gsb_permissions:configuration:import
How it Works
The command searches all active TYPO3 packages for the following directories:
Configuration/Workspaces/
- for workspace configurationsConfiguration/BackendUserGroups/
- for backend user groups
YAML File Structure
Workspace Configuration (Configuration/Workspaces/*.yaml
):
workspaces:
mode: 'replace' # or 'append', 'update'
entries:
- uid: 1
title: 'Simple Approval Process'
adminusers: 'be_groups_5,be_groups_7'
members: 'be_groups_9,be_groups_6'
# additional workspace properties...
Backend User Groups (Configuration/BackendUserGroups/*.yaml
):
BackendUserGroups:
mode: 'update' # or 'append', 'replace'
entries:
- uid: 1
title: '[GSB][DBM] Base'
permission_sets: 'itzbund/gsb-permission/acl-dbm-base'
# additional group properties...
Import Modes
Mode | Description |
---|---|
append | New entries are added (default) |
replace | Table is cleared and refilled |
update | Existing entries are updated, new ones added |
Automatic Import
The command is automatically executed when:
- The extension is installed
- An update is performed
- The configuration is updated via the backend
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.