Completed
Pull Request — master (#4198)
by Craig
05:53
created

StoppableUserEntityEvent::stopPropagation()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 1
nc 1
nop 0
dl 0
loc 3
rs 10
c 1
b 0
f 0
1
<?php
2
3
declare(strict_types=1);
4
5
/*
6
 * This file is part of the Zikula package.
7
 *
8
 * Copyright Zikula Foundation - https://ziku.la/
9
 *
10
 * For the full copyright and license information, please view the LICENSE
11
 * file that was distributed with this source code.
12
 */
13
14
namespace Zikula\UsersModule\Event;
15
16
use Psr\EventDispatcher\StoppableEventInterface;
17
18
/**
19
 * A 'Generic' event that requires a UserEntity on construction and sets
20
 * an immutable datetime object for tracking purposes.
21
 * This class adds the ability to stop the propagation.
22
 */
23
class StoppableUserEntityEvent extends UserEntityEvent implements StoppableEventInterface
24
{
25
    private $propagationStopped = false;
26
27
    /**
28
     * {@inheritdoc}
29
     */
30
    public function isPropagationStopped(): bool
31
    {
32
        return $this->propagationStopped;
33
    }
34
35
    /**
36
     * Stops the propagation of the event to further event listeners.
37
     *
38
     * If multiple event listeners are connected to the same event, no
39
     * further event listener will be triggered once any trigger calls
40
     * stopPropagation().
41
     */
42
    public function stopPropagation(): void
43
    {
44
        $this->propagationStopped = true;
45
    }
46
}
47