Event.php
2.52 KB
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<?php
/**
* Part of the Joomla Framework Event Package
*
* @copyright Copyright (C) 2005 - 2019 Open Source Matters, Inc. All rights reserved.
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\Event;
use InvalidArgumentException;
/**
* Default Event class.
*
* @since 1.0
*/
class Event extends AbstractEvent
{
/**
* Add an event argument, only if it is not existing.
*
* @param string $name The argument name.
* @param mixed $value The argument value.
*
* @return Event This method is chainable.
*
* @since 1.0
*/
public function addArgument($name, $value)
{
if (!isset($this->arguments[$name]))
{
$this->arguments[$name] = $value;
}
return $this;
}
/**
* Set the value of an event argument.
* If the argument already exists, it will be overridden.
*
* @param string $name The argument name.
* @param mixed $value The argument value.
*
* @return Event This method is chainable.
*
* @since 1.0
*/
public function setArgument($name, $value)
{
$this->arguments[$name] = $value;
return $this;
}
/**
* Remove an event argument.
*
* @param string $name The argument name.
*
* @return mixed The old argument value or null if it is not existing.
*
* @since 1.0
*/
public function removeArgument($name)
{
$return = null;
if (isset($this->arguments[$name]))
{
$return = $this->arguments[$name];
unset($this->arguments[$name]);
}
return $return;
}
/**
* Clear all event arguments.
*
* @return array The old arguments.
*
* @since 1.0
*/
public function clearArguments()
{
$arguments = $this->arguments;
$this->arguments = array();
return $arguments;
}
/**
* Stop the event propagation.
*
* @return void
*
* @since 1.0
*/
public function stop()
{
$this->stopped = true;
}
/**
* Set the value of an event argument.
*
* @param string $name The argument name.
* @param mixed $value The argument value.
*
* @return void
*
* @throws InvalidArgumentException If the argument name is null.
*
* @since 1.0
*/
public function offsetSet($name, $value)
{
if ($name === null)
{
throw new InvalidArgumentException('The argument name cannot be null.');
}
$this->setArgument($name, $value);
}
/**
* Remove an event argument.
*
* @param string $name The argument name.
*
* @return void
*
* @since 1.0
*/
public function offsetUnset($name)
{
$this->removeArgument($name);
}
}