-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathclass-FloatingPoint.Grapevine.Library.Commands.CommandHandlerInterface.html
242 lines (171 loc) · 7.59 KB
/
class-FloatingPoint.Grapevine.Library.Commands.CommandHandlerInterface.html
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="ApiGen 2.8.0" />
<title>Interface FloatingPoint\Grapevine\Library\Commands\CommandHandlerInterface | Grapevine by Floating Point Software</title>
<script type="text/javascript" src="resources/combined.js?657771206"></script>
<script type="text/javascript" src="elementlist.js?1472664112"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-FloatingPoint.html">FloatingPoint<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Domain.html">Domain<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Domain.Forums.html">Forums<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Domain.Forums.Commands.html">Commands</a>
</li>
<li><a href="namespace-FloatingPoint.Domain.Forums.Handlers.html">Handlers</a>
</li>
</ul></li></ul></li>
<li class="active"><a href="namespace-FloatingPoint.Grapevine.html">Grapevine<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Grapevine.Http.html">Http<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Grapevine.Http.Requests.html">Requests<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Grapevine.Http.Requests.Forums.html">Forums</a>
</li>
</ul></li></ul></li>
<li class="active"><a href="namespace-FloatingPoint.Grapevine.Library.html">Library<span></span></a>
<ul>
<li class="active"><a href="namespace-FloatingPoint.Grapevine.Library.Commands.html">Commands</a>
</li>
<li><a href="namespace-FloatingPoint.Grapevine.Library.Database.html">Database</a>
</li>
<li><a href="namespace-FloatingPoint.Grapevine.Library.Support.html">Support</a>
</li>
</ul></li>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.html">Modules<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.html">Forums<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Commands.html">Commands</a>
</li>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Handlers.html">Handlers</a>
</li>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Models.html">Models</a>
</li>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Repositories.html">Repositories</a>
</li>
<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Services.html">Services</a>
</li>
</ul></li></ul></li></ul></li>
<li><a href="namespace-FloatingPoint.Http.html">Http<span></span></a>
<ul>
<li><a href="namespace-FloatingPoint.Http.Controllers.html">Controllers</a>
</li>
</ul></li></ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr />
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.Bus.html">Bus</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.Command.html">Command</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.CommandResponse.html">CommandResponse</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.Translator.html">Translator</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.ValidationBus.html">ValidationBus</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.BusInterface.html">BusInterface</a></li>
<li class="active"><a href="class-FloatingPoint.Grapevine.Library.Commands.CommandHandlerInterface.html">CommandHandlerInterface</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.CommandInterface.html">CommandInterface</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.TranslatorInterface.html">TranslatorInterface</a></li>
</ul>
<h3>Exceptions</h3>
<ul>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.HandlerException.html">HandlerException</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.InvalidCommandArgumentException.html">InvalidCommandArgumentException</a></li>
<li><a href="class-FloatingPoint.Grapevine.Library.Commands.NullCommandConstructorException.html">NullCommandConstructorException</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="" />
<input type="hidden" name="ie" value="UTF-8" />
<input type="text" name="q" class="text" />
<input type="submit" value="Search" />
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-FloatingPoint.Grapevine.Library.Commands.html" title="Summary of FloatingPoint\Grapevine\Library\Commands"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Interface CommandHandlerInterface</h1>
<div class="info">
<b>Namespace:</b> <a href="namespace-FloatingPoint.html">FloatingPoint</a>\<a href="namespace-FloatingPoint.Grapevine.html">Grapevine</a>\<a href="namespace-FloatingPoint.Grapevine.Library.html">Library</a>\<a href="namespace-FloatingPoint.Grapevine.Library.Commands.html">Commands</a><br />
<b>Located at</b> <a href="source-class-FloatingPoint.Grapevine.Library.Commands.CommandHandlerInterface.html#5-15" title="Go to source code">Library/Commands/CommandHandlerInterface.php</a><br />
</div>
<table class="summary" id="methods">
<caption>Methods summary</caption>
<tr data-order="handle" id="_handle">
<td class="attributes"><code>
public
mixed
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_handle">#</a>
<code><a href="source-class-FloatingPoint.Grapevine.Library.Commands.CommandHandlerInterface.html#7-14" title="Go to source code">handle</a>( <span><code><a href="class-FloatingPoint.Grapevine.Library.Commands.CommandInterface.html">FloatingPoint\Grapevine\Library\Commands\CommandInterface</a></code> <var>$command</var></span> )</code>
<div class="description short">
<p>The handle method should accept the command, and deal with the command by
executing whatever functionality is required, based on the command's
properties.</p>
</div>
<div class="description detailed hidden">
<p>The handle method should accept the command, and deal with the command by
executing whatever functionality is required, based on the command's
properties.</p>
<h4>Parameters</h4>
<div class="list"><dl>
<dt><var>$command</var></dt>
<dd><code><code><a href="class-FloatingPoint.Grapevine.Library.Commands.CommandInterface.html">FloatingPoint\Grapevine\Library\Commands\CommandInterface</a></code></code><br>$command</dd>
</dl></div>
<h4>Returns</h4>
<div class="list">
<code>mixed</code><br />
</div>
</div>
</div></td>
</tr>
</table>
</div>
<div id="footer">
Grapevine by Floating Point Software API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>