events/EventListener.php at master · arikaim/events · GitHub

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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
<?php
/**
 * Arikaim
 *
 * @link        http://www.arikaim.com
 * @copyright   Copyright (c)  Konstantin Atanasov <info@arikaim.com>
 * @license     http://www.arikaim.com/license
 *
*/
namespace Arikaim\Core\Events;

use Arikaim\Core\Interfaces\Events\EventListenerInterface;

/**
 * Base class for event listener.
*/
abstract class EventListener implements EventListenerInterface
{
    /**
     * Event name
     *
     * @var string|null
     */
    protected $eventName;

    /**
     * Event priority
     *
     * @var integer
     */
    protected $priority = 0;

    /**
     * Subscriber code executed.
     *
     * @param EventInterface $event
     * @return mixed
     */
    abstract public function execute($event);

    /**
     * Constructor
     *
     * @param string|null $eventName
     * @param integer $priority
     */
    public function __construct(?string $eventName = null, int $priority = 0)
    {
        $this->eventName = $eventName;
        $this->priority = $priority;

        if (empty($this->eventName) == false) {
            $this->subscribe($eventName,$priority);
        }
    }

    /**
     * Get event name
     *
     * @return string
     */
    public function getEventName(): string
    {
        return $this->eventName;
    }

    /**
     * Get priority
     *
     * @return integer
     */
    public function getPriority(): int
    {
        return $this->priority;
    }

    /**
     * Subscribe to event
     *
     * @param string $eventName
     * @param integer $priority
     * @return void
     */
    public function subscribe(string $eventName, int $priority = 0): void
    {
        $this->eventName = $eventName;
        $this->priority = $priority;
    }
}