|
1
|
|
|
<?php |
|
2
|
|
|
declare(strict_types = 1); |
|
3
|
|
|
/** |
|
4
|
|
|
* Contains EveApiEvent class. |
|
5
|
|
|
* |
|
6
|
|
|
* PHP version 7.0+ |
|
7
|
|
|
* |
|
8
|
|
|
* LICENSE: |
|
9
|
|
|
* This file is part of Yet Another Php Eve Api Library also know as Yapeal |
|
10
|
|
|
* which can be used to access the Eve Online API data and place it into a |
|
11
|
|
|
* database. |
|
12
|
|
|
* Copyright (C) 2014-2017 Michael Cummings |
|
13
|
|
|
* |
|
14
|
|
|
* This program is free software: you can redistribute it and/or modify it |
|
15
|
|
|
* under the terms of the GNU Lesser General Public License as published by the |
|
16
|
|
|
* Free Software Foundation, either version 3 of the License, or (at your |
|
17
|
|
|
* option) any later version. |
|
18
|
|
|
* |
|
19
|
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT |
|
20
|
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
21
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License |
|
22
|
|
|
* for more details. |
|
23
|
|
|
* |
|
24
|
|
|
* You should have received a copy of the GNU Lesser General Public License |
|
25
|
|
|
* along with this program. If not, see |
|
26
|
|
|
* <http://spdx.org/licenses/LGPL-3.0.html>. |
|
27
|
|
|
* |
|
28
|
|
|
* You should be able to find a copy of this license in the COPYING-LESSER.md |
|
29
|
|
|
* file. A copy of the GNU GPL should also be available in the COPYING.md file. |
|
30
|
|
|
* |
|
31
|
|
|
* @copyright 2014-2017 Michael Cummings |
|
32
|
|
|
* @license LGPL-3.0+ |
|
33
|
|
|
* @author Michael Cummings <[email protected]> |
|
34
|
|
|
*/ |
|
35
|
|
|
namespace Yapeal\Event; |
|
36
|
|
|
|
|
37
|
|
|
use EventMediator\Event; |
|
38
|
|
|
use Yapeal\Xml\EveApiReadWriteInterface; |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* Class EveApiEvent |
|
42
|
|
|
*/ |
|
43
|
|
|
class EveApiEvent extends Event implements EveApiEventInterface |
|
44
|
|
|
{ |
|
45
|
|
|
/** |
|
46
|
|
|
* Get data object. |
|
47
|
|
|
* |
|
48
|
|
|
* @return EveApiReadWriteInterface |
|
49
|
|
|
* @throws \LogicException Throws exception if code tries to access data before it is set. |
|
50
|
|
|
*/ |
|
51
|
|
|
public function getData(): EveApiReadWriteInterface |
|
52
|
|
|
{ |
|
53
|
|
|
if (!$this->data instanceof EveApiReadWriteInterface) { |
|
54
|
|
|
$mess = 'Tried to use data before it was set'; |
|
55
|
|
|
throw new \LogicException($mess); |
|
56
|
|
|
} |
|
57
|
|
|
return $this->data; |
|
58
|
|
|
} |
|
59
|
|
|
/** |
|
60
|
|
|
* Used to check if event was handled sufficiently by any listener(s). |
|
61
|
|
|
* |
|
62
|
|
|
* This should return true when a listener uses setHandledSufficiently() and/or eventHandled() methods for the |
|
63
|
|
|
* event. |
|
64
|
|
|
* |
|
65
|
|
|
* @return bool |
|
66
|
|
|
*/ |
|
67
|
2 |
|
public function isSufficientlyHandled(): bool |
|
68
|
|
|
{ |
|
69
|
2 |
|
return ($this->handledSufficiently || $this->hasBeenHandled()); |
|
70
|
|
|
} |
|
71
|
|
|
/** |
|
72
|
|
|
* Set data object. |
|
73
|
|
|
* |
|
74
|
|
|
* @param EveApiReadWriteInterface $value |
|
75
|
|
|
* |
|
76
|
|
|
* @return self Fluent interface. |
|
77
|
|
|
*/ |
|
78
|
|
|
public function setData(EveApiReadWriteInterface $value): self |
|
79
|
|
|
{ |
|
80
|
|
|
$this->data = $value; |
|
81
|
|
|
return $this; |
|
82
|
|
|
} |
|
83
|
|
|
/** |
|
84
|
|
|
* Set to indicate event was handled sufficiently while still allows additional listener(s) to have a chance to |
|
85
|
|
|
* handle the event as well. |
|
86
|
|
|
* |
|
87
|
|
|
* @param bool $value |
|
88
|
|
|
* |
|
89
|
|
|
* @return self Fluent interface. |
|
90
|
|
|
*/ |
|
91
|
2 |
|
public function setHandledSufficiently(bool $value = true): self |
|
92
|
|
|
{ |
|
93
|
2 |
|
$this->handledSufficiently = $value; |
|
94
|
2 |
|
return $this; |
|
95
|
|
|
} |
|
96
|
|
|
/** |
|
97
|
|
|
* Holds the data instance. |
|
98
|
|
|
* |
|
99
|
|
|
* @var EveApiReadWriteInterface $data |
|
100
|
|
|
*/ |
|
101
|
|
|
protected $data; |
|
102
|
|
|
/** |
|
103
|
|
|
* Holds the handled sufficiently state. |
|
104
|
|
|
* |
|
105
|
|
|
* @var bool $handledSufficiently |
|
106
|
|
|
*/ |
|
107
|
|
|
protected $handledSufficiently = false; |
|
108
|
|
|
} |
|
109
|
|
|
|
Yapeal /
yapeal-ng
