-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
SubjectFilterDecorator.php
70 lines (63 loc) · 2.04 KB
/
SubjectFilterDecorator.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
<?php
declare(strict_types=1);
/**
* CakePHP : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP Project
* @since 3.3.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Event\Decorator;
use Cake\Core\Exception\CakeException;
use Cake\Event\EventInterface;
/**
* 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.
*/
class SubjectFilterDecorator extends AbstractDecorator
{
/**
* @inheritDoc
*/
public function __invoke(): mixed
{
$args = func_get_args();
if (!$this->canTrigger($args[0])) {
return null;
}
return $this->_call($args);
}
/**
* Checks if the event is triggered for this listener.
*
* @template TSubject of object
* @param \Cake\Event\EventInterface<TSubject> $event Event object.
* @return bool
*/
public function canTrigger(EventInterface $event): bool
{
if (!isset($this->_options['allowedSubject'])) {
throw new CakeException(self::class . ' Missing subject filter options!');
}
if (is_string($this->_options['allowedSubject'])) {
$this->_options['allowedSubject'] = [$this->_options['allowedSubject']];
}
try {
$subject = $event->getSubject();
} catch (CakeException) {
return false;
}
return in_array($subject::class, $this->_options['allowedSubject'], true);
}
}