SubjectFilterDecorator (class)
Class SubjectFilterDecorator
Event Subject Filter Decorator
Use this decorator to allow your event listener to only be invoked if event subject matches the allowedSubject
option.
The allowedSubject
option can be a list of class names, if you want to check multiple classes.
- Cake\Event\Decorator\AbstractDecorator
- Cake\Event\Decorator\SubjectFilterDecorator
Inherited Properties
Method Summary
- __invoke() publicInvoke
- canTrigger() publicChecks if the event is triggered for this listener.
Method Detail
__invoke()source public
__invoke( )
Invoke
Returns
mixedOverrides
Cake\Event\Decorator\AbstractDecorator::__invoke()
canTrigger()source public
canTrigger( Cake\Event\Event $event )
Checks if the event is triggered for this listener.
Parameters
-
Cake\Event\Event
$event
- Event object.
Returns
booleanMethods inherited from Cake\Event\Decorator\AbstractDecorator
__construct()source public
__construct( callable $callable , array $options [] )
Constructor.
Parameters
- callable
$callable
- Callable.
- array
$options
optional [] - Decorator options.
_call()source protected
_call( array $args )
Calls the decorated callable with the passed arguments.
Parameters
- array
$args
- Arguments for the callable.
Returns
mixed
© 2005–2017 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/3.4/class-Cake.Event.Decorator.SubjectFilterDecorator.html