/
CreateTokenController.html
278 lines (219 loc) · 11.1 KB
/
CreateTokenController.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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>Flarum\Api\Controller\CreateTokenController | Flarum API</title>
<link rel="stylesheet" type="text/css" href="../../../assets/app.min.css">
<script src="../../../assets/app.min.js"></script>
<script src="../../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:Flarum_Api_Controller_CreateTokenController" data-root-path="../../../">
<div id="content">
<nav id="flarum-header" class="navbar navbar-expand-lg">
<h1 class="flarum-title navbar-brand"></h1>
<div class="collapse navbar-collapse">
<ul class="navbar-nav mr-auto mt-2 mt-lg-0">
<li class="nav-item"><a class="nav-link" href="https://flarum.org">Flarum</a></li>
<li class="nav-item"><a class="nav-link" href="https://discuss.flarum.org">Forum</a></li>
<li class="nav-item active"><a class="nav-link" href="../../../">PHP</a></li>
<li class="nav-item"><a class="nav-link" href="https://api.flarum.dev/js">JS</a></li>
<li class="nav-item"><a class="nav-link icon icon-github-circled" target="_blank" href="https://github.com/flarum/core"></a></li>
</ul>
</div>
<ul class="my-2 my-lg-0">
<li class="version nav-item">
<a href="../../../../">master</a>
</li>
</ul>
</nav>
<div>
<div id="left-column">
<div id="control-panel">
<script>
$('option[data-version="'+window.projectVersion+'"]').prop('selected', true);
</script>
<form id="search-form" action="../../../search.html" method="GET">
<span class="icon icon-search"></span>
<input name="search" class="typeahead form-control" type="search" placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-expand" role="navigation">
<ul class="navbar-nav mr-auto">
<li class="nav-item"><a class="nav-link" href="../../../classes.html">Classes</a></li>
<li class="nav-item"><a class="nav-link" href="../../../namespaces.html">Namespaces</a></li>
<li class="nav-item"><a class="nav-link" href="../../../interfaces.html">Interfaces</a></li>
<li class="nav-item"><a class="nav-link" href="../../../traits.html">Traits</a></li>
<li class="nav-item"><a class="nav-link" href="../../../doc-index.html">Index</a></li>
<li class="nav-item"><a class="nav-link" href="../../../search.html">Search</a></li>
</ul>
</nav>
<div id="page-content">
<div class="page-header">
<h1>
CreateTokenController
<a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php" target="_blank">
<img src="../../../assets/img/code.svg" height="30" />
</a>
</h1>
</div>
<p> class
<strong>CreateTokenController</strong> implements
<abbr title="Psr\Http\Server\RequestHandlerInterface">RequestHandlerInterface</abbr></p>
<h2>Properties</h2>
<table class="table table-condensed">
<tr>
<td class="type" id="property_users">
protected <a href="../../../Flarum/User/UserRepository.html"><abbr title="Flarum\User\UserRepository">UserRepository</abbr></a>
</td>
<td>$users</td>
<td class="last"></td>
<td></td>
<td width="24px"> <a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L29" target="_blank">
<img src="../../../assets/img/code.svg" height="18" />
</a>
</td>
</tr>
<tr>
<td class="type" id="property_bus">
protected <abbr title="Illuminate\Contracts\Bus\Dispatcher">Dispatcher</abbr>
</td>
<td>$bus</td>
<td class="last"></td>
<td></td>
<td width="24px"> <a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L34" target="_blank">
<img src="../../../assets/img/code.svg" height="18" />
</a>
</td>
</tr>
<tr>
<td class="type" id="property_events">
protected <abbr title="Illuminate\Contracts\Events\Dispatcher">Dispatcher</abbr>
</td>
<td>$events</td>
<td class="last"></td>
<td></td>
<td width="24px"> <a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L39" target="_blank">
<img src="../../../assets/img/code.svg" height="18" />
</a>
</td>
</tr>
</table>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-6 type">
<a href="#method___construct">__construct</a>(<a href="../../../Flarum/User/UserRepository.html"><abbr title="Flarum\User\UserRepository">UserRepository</abbr></a> $users, <abbr title="Illuminate\Contracts\Bus\Dispatcher">Dispatcher</abbr> $bus, <abbr title="Illuminate\Contracts\Events\Dispatcher">Dispatcher</abbr> $events)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L46" target="_blank">
<img src="../../../assets/img/code.svg" height="18" />
</a>
</div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>
</div>
<div class="col-md-6 type">
<a href="#method_handle">handle</a>(<abbr title="Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr> $request)
<p>{@inheritdoc}</p> </div>
<div class="col-md-2"></div>
<div class="col-md-2 text-right" style="padding-right: 5px;">
<a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L56" target="_blank">
<img src="../../../assets/img/code.svg" height="18" />
</a>
</div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___construct">
<div class="location">
at <a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L46" target="_blank">
line 46
</a>
</div>
<code>
<strong>__construct</strong>(<a href="../../../Flarum/User/UserRepository.html"><abbr title="Flarum\User\UserRepository">UserRepository</abbr></a> $users, <abbr title="Illuminate\Contracts\Bus\Dispatcher">Dispatcher</abbr> $bus, <abbr title="Illuminate\Contracts\Events\Dispatcher">Dispatcher</abbr> $events)
</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td><a href="../../../Flarum/User/UserRepository.html"><abbr title="Flarum\User\UserRepository">UserRepository</abbr></a></td>
<td>$users</td>
<td></td>
</tr>
<tr>
<td><abbr title="Illuminate\Contracts\Bus\Dispatcher">Dispatcher</abbr></td>
<td>$bus</td>
<td></td>
</tr>
<tr>
<td><abbr title="Illuminate\Contracts\Events\Dispatcher">Dispatcher</abbr></td>
<td>$events</td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_handle">
<div class="location">
at <a href="https://github.com/flarum/core/blob/master/src/Api/Controller/CreateTokenController.php#L56" target="_blank">
line 56
</a>
</div>
<code> <abbr title="Psr\Http\Message\ResponseInterface">ResponseInterface</abbr>
<strong>handle</strong>(<abbr title="Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr> $request)
</code>
</h3>
<div class="details">
<div class="method-description">
<p>{@inheritdoc}</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Psr\Http\Message\ServerRequestInterface">ServerRequestInterface</abbr></td>
<td>$request</td>
<td></td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td><abbr title="Psr\Http\Message\ResponseInterface">ResponseInterface</abbr></td>
<td></td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
<p>Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.</p>
<p>Created by <a href="https://github.com/datitisev">@datitisev</a>. Source code can be found on <a href="https://github.com/datitisev/FlarumAPIDocs">GitHub</a>.</p>
</div>
</div>
</div>
</div>
</body>
</html>