Class ConditionDecorator
Event Condition Decorator
Use this decorator to allow your event listener to only
be invoked if the if and/or unless conditions pass.
Namespace: Cake\Event\Decorator
Property Summary
-
$_callable protected
callableCallable
-
$_options protected
arrayDecorator options
Method Summary
-
__construct() public
Constructor.
-
__invoke() public
-
_call() protected
Calls the decorated callable with the passed arguments.
-
_evaluateCondition() protected
Evaluates the filter conditions
-
canTrigger() public
Checks if the event is triggered for this listener.
Method Detail
__construct() ¶ public
__construct(callable $callable, array<string, mixed> $options = [])Constructor.
Parameters
-
callable$callable Callable.
-
array<string, mixed>$options optional Decorator options.
_call() ¶ protected
_call(array $args): mixedCalls the decorated callable with the passed arguments.
Parameters
-
array$args Arguments for the callable.
Returns
mixed_evaluateCondition() ¶ protected
_evaluateCondition(string $condition, Cake\Event\EventInterface<TSubject> $event): boolEvaluates the filter conditions
Templates
TSubject
of object Parameters
-
string$condition Condition type
-
Cake\Event\EventInterface<TSubject>$event Event object
Returns
boolcanTrigger() ¶ public
canTrigger(Cake\Event\EventInterface<TSubject> $event): boolChecks if the event is triggered for this listener.
Templates
TSubject
of object Parameters
-
Cake\Event\EventInterface<TSubject>$event Event object.
Returns
bool