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
Invoke
_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.
__invoke() public
__invoke(): mixedInvoke
Returns
mixed_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 $event): boolEvaluates the filter conditions
Parameters
string$condition-
Condition type
Cake\Event\EventInterface$event-
Event object
Returns
boolcanTrigger() public
canTrigger(Cake\Event\EventInterface $event): boolChecks if the event is triggered for this listener.
Parameters
Cake\Event\EventInterface$event-
Event object.
Returns
boolProperty Detail
$_callable protected
Callable
Type
callable$_options protected
Decorator options
Type
array© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Event.Decorator.ConditionDecorator.html