BeforeAppConfigSetEvent
extends Event
in package
Emitted before an admin sets an app config value via occ or the provisioning API.
Listeners can refuse the change with setValid(false).
Tags
Attributes
- #[Listenable]
- $since: '36.0.0'
Table of Contents
Properties
- $appId : string
- $configKey : string
- $configValue : string
- $valid : bool
Methods
- __construct() : mixed
- Compatibility constructor
- getAppId() : string
- getConfigKey() : string
- getConfigValue() : string
- isPropagationStopped() : bool
- {@inheritDoc}
- isRejected() : bool
- setValid() : void
- stopPropagation() : void
- Stops the propagation of the event to further event listeners
Properties
$appId
protected
string
$appId
$configKey
protected
string
$configKey
$configValue
protected
string
$configValue
$valid
protected
bool
$valid
= true
Methods
__construct()
Compatibility constructor
public
__construct(string $appId, string $configKey, string $configValue) : mixed
Parameters
- $appId : string
- $configKey : string
- $configValue : string
Tags
getAppId()
public
getAppId() : string
Tags
Return values
stringgetConfigKey()
public
getConfigKey() : string
Tags
Return values
stringgetConfigValue()
public
getConfigValue() : string
Tags
Return values
stringisPropagationStopped()
{@inheritDoc}
public
isPropagationStopped() : bool
Tags
Attributes
- #[Override]
Return values
boolisRejected()
public
isRejected() : bool
Tags
Return values
boolsetValid()
public
setValid(bool $valid) : void
Parameters
- $valid : bool
Tags
stopPropagation()
Stops the propagation of the event to further event listeners
public
stopPropagation() : void