IConfig
in
Interface IConfig
Configuration of the global scale architecture
Tags
Attributes
- #[Consumable]
- $since: '12.0.1'
Table of Contents
Methods
- isGlobalScaleEnabled() : bool
- Check if global scale is enabled.
- isPrimary() : bool
- Check if the current instance is the primary instance.
- isPrimaryAdmin() : bool
- Check if the given user is one of the admin on the primary instance.
- isSecondary() : bool
- Check if the current instance is one of the secondary instance.
- onlyInternalFederation() : bool
- Check if federation should only be used internally in a global scale setup.
Methods
isGlobalScaleEnabled()
Check if global scale is enabled.
public
isGlobalScaleEnabled() : bool
Tags
Return values
boolisPrimary()
Check if the current instance is the primary instance.
public
isPrimary() : bool
This instance is then only used to log in the users and then redirect them to their associated secondary instance.
Tags
Return values
boolisPrimaryAdmin()
Check if the given user is one of the admin on the primary instance.
public
isPrimaryAdmin(string $userId) : bool
These users won't be redirected to a secondary instance and instead will stay on the primary instance to manage the configuration of the instance.
Parameters
- $userId : string
Tags
Return values
boolisSecondary()
Check if the current instance is one of the secondary instance.
public
isSecondary() : bool
These instances are the actual instance of a user and hold all their data.
Tags
Return values
boolonlyInternalFederation()
Check if federation should only be used internally in a global scale setup.
public
onlyInternalFederation() : bool