forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathevent.html
510 lines (478 loc) · 14.4 KB
/
event.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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
<!doctype html>
<html lang="ja">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link rel="stylesheet" href="./../assets/css/combined.css">
<link rel="shortcut icon" href="./../favicon.ico" />
<script src="http://www.google.com/jsapi" type="text/javascript"></script>
<script type="text/javascript">
var path = './../';
var class_prefix = "Event::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Event - クラス - FuelPHP ドキュメント</title>
</head>
<body>
<div id="container">
<header id="header">
<div class="table">
<h1>
<a href="http://fuelphp.com"><img height="37px" width="147px" src="./../assets/img/fuel.png" /></a>
<strong>Documentation</strong>
</h1>
<form id="google_search">
<p>
<span id="search_clear"> </span>
<input type="submit" name="search_submit" id="search_submit" value="検索" />
<input type="text" value="" id="search_input" name="search_input" />
</p>
</form>
</div>
<nav>
<div class="clear"></div>
</nav>
<a href="#" id="toc_handle">目次</a>
<div class="clear"></div>
</header>
<div id="cse">
<div id="cse_point"></div>
<div id="cse_content"></div>
</div>
<div id="main">
<h2>Event クラス</h2>
<p>イベントクラスを使うことで Fuel のコアの処理に、コアのファイルを変更することなく介入することができます。</p>
<h3 id="system_events">システムに定義されたイベント</h3>
<p>
FuelPHP は <kbd>fuelphp</kbd> インスタンス上にいくつかイベントを定義します。これにより、コアを拡張することなく、
内部の処理へフックできます。それらイベントは次の通り:
</p>
<table class="config">
<tbody>
<tr class="header">
<th>Event</th>
<th>説明</th>
</tr>
<tr>
<th>app_created</th>
<td>
このイベントは FuelPHP フレームワークが初期化された後にトリガーされます。
</td>
</tr>
<tr>
<th>request_created</th>
<td>
このイベントは新しい <kbd>Request</kbd> オブジェクトが作られた後にトリガーされます。
</td>
</tr>
<tr>
<th>request_started</th>
<td>
このイベントは <kbd>Request</kbd> の実行がリクエストされる際にトリガーされます。
</td>
</tr>
<tr>
<th>controller_started</th>
<td>
このイベントはコントローラーの <kbd>before()</kbd> メソッドが呼び出される前にトリガーされます。
</td>
</tr>
<tr>
<th>controller_finished</th>
<td>
このイベントはコントローラーの <kbd>after()</kbd> メソッドが呼び出され、レスポンスを受け取った後にトリガーされます。
</td>
</tr>
<tr>
<th>response_created</th>
<td>
このイベントは新しい <kbd>Response</kbd> オブジェクトが作られた後にトリガーされます。
</td>
</tr>
<tr>
<th>request_finished</th>
<td>
このイベントは <kbd>Request</kbd> の実行が完了し、レスポンスが受け取られる際にトリガーされます。
</td>
</tr>
<tr>
<th>shutdown</th>
<td>
このイベントはメインのリクエストが処理され、出力内容が送信され切った後にトリガーされます。
</td>
</tr>
<tr>
<td> </td>
</tr>
<tr>
<th>例</th>
<td>
<strong>app/config/event.php</strong> の中で
<pre class="php"><code><?php
return array(
'fuelphp' => array(
'app_created' => function()
{
// FuelPHP 初期化された後の処理
},
'request_created' => function()
{
// Request が作られた後の処理
},
'request_started' => function()
{
// Request がリクエストされる際の処理
},
'controller_started' => function()
{
// コントローラーの before() メソッドが呼び出される前の処理
},
'controller_finished' => function()
{
// コントローラーの after() メソッドが呼び出された後の処理
},
'response_created' => function()
{
// Response が作られた後の処理
},
'request_finished' => function()
{
// Request が完了し、レスポンスを受け取った後の処理
},
'shutdown' => function()
{
// 出力内容が送信され切った後の処理
},
),
);
</code></pre>
</td>
</tr>
</tbody>
</table>
<h3 id="class_methods">クラスメソッド</h3>
<article>
<h4 class="method" id="method_register">register($event, $callback)</h4>
<p><strong>register</strong> メソッドにより <kbd>trigger</kbd>メソッドが呼び出された際に実行されるオブジェクトを、ファイルに登録させることができます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$event</kbd></th>
<td><i>必須</i></td>
<td>あなたが自身のコードに登録しているイベント</td>
</tr>
<tr>
<th><kbd>$callback</kbd></th>
<td><i>必須</i></td>
<td>コールバックメソッド</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>boolean</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Event::register('user_login', 'Class::method');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_unregister">unregister($event, $callback = null)</h4>
<p>The <strong>unregister</strong> メソッドにより <kbd>trigger</kbd> メソッドが呼び出された際に実行されるオブジェクトを、ファイルに登録解除させることができます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$event</kbd></th>
<td><i>必須</i></td>
<td>あなたが自身のコードに登録しているイベント</td>
</tr>
<tr>
<th><kbd>$callback</kbd></th>
<td><i>optional</i></td>
<td>コールバックメソッド。 指定が無い場合は全てのコールバックが削除されます</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>boolean</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 2 つのイベント用コールバックを定義
$callback_one = function()
{
echo 'コールバック 1';
};
$callback_two = function()
{
echo 'コールバック 2';
};
// "my_event" という名前でイベントを登録
Event::register('my_event', $callback_one);
Event::register('my_event', $callback_two);
// callback_one を登録解除
Event::unregister('my_event', $callback_one);
// イベントをトリガー
Event::trigger('my_event');
// "コールバック 2" のみが出力されるはず。
// "my_event" から全てのコールバックを登録解除
Event::unregister('my_event');
// イベントをトリガー
Event::trigger('my_event');
// 何も出力されないはず。</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_trigger">trigger($event, $data = '', $return_type = 'string', $reversed = false)</h4>
<p><strong>trigger</strong> メソッドはトリガーのため、または、register メソッドを通じて関連付けられたコールバックを有効化するために使われます</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$event</kbd></th>
<td><i>必須</i></td>
<td>あなたがトリガーするイベント</td>
</tr>
<tr>
<th><kbd>$data</kbd></th>
<td><pre class="php"><code>''</code></pre></td>
<td>トリガーされたメソッドに送りたいあらゆるデータ</td>
</tr>
<tr>
<th><kbd>$return_type</kbd></th>
<td><pre class="php"><code>'string'</code></pre></td>
<td>戻り値として期待しているデータの種類 (string, array, json, none, serialized) - <strong>デフォルトは文字列</strong></td>
</tr>
<tr>
<th><kbd>$reversed</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td>true にセットするとイベントを逆順で発火させます (FIFO ではなく LIFO になる) 。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>mixed - <var>$return_type</var> の値に依存する。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Event::trigger('user_login', $data)</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_has_events">has_events($event)</h4>
<p><strong>has_events</strong> メソッドを使い、特定の登録済みイベントがトリガーを持っているかチェックできます。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$event</kbd></th>
<td><i>必須</i></td>
<td>あなたがチェックしているイベント</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>boolean</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Event::has_events('user_login')</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_forge">forge(array $events = array())</h4>
<p><strong>forge</strong> は新しいイベントオブジェクトを返します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$events</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>あなたがチェックしているイベント</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Event_Instance object</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 新しいイベントオブジェクトを作成
$events = Event::forge();
// イベントと一緒に
// 新しいイベントオブジェクトを作成
$events = Event::forge(array(
'update' => function(){
// 更新処理の際に何かする
},
'register' => function(){
// 登録処理の際に何かする
},
));
/**
* !! その他すべての Event メソッドは、インスタンスにも適用される
*/
$events->register('my_event', function(){
echo 'これはすごい';
});
$events->trigger('my_event');
// "これはすごい" が出力される
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_instance">instance($name = 'fuelphp', array $events = array())</h4>
<p><strong>instance</strong> は新しいイベントのシングルトンオブジェクトを返します。</p>
<table class="method">
<tbody>
<tr>
<th class="legend">静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$name</kbd></th>
<td><pre class="php"><code>'fuelphp'</code></pre></td>
<td>インスタンスの名前</td>
</tr>
<tr>
<th><kbd>$events</kbd></th>
<td><pre class="php"><code>array()</code></pre></td>
<td>あなたがチェックしているイベント</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Event_Instance object</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// 新しいイベントインスタンスを生成
$events = Event::instance('my_instance');
$same = Event::instance('my_instance');
$events->register('my_event', function(){
echo 'すごい!';
});
$same->register('my_event', function(){
echo 'これは ';
});
Event::instance('my_instance')->trigger('my_event');
// "これは すごい!" が出力されるはず</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
</div>
<footer>
<p>
© FuelPHP Development Team 2010-2016 - <a href="http://fuelphp.com">FuelPHP</a> is released under the MIT license.
[ <a href="https://github.com/fuel/docs/commits/1.8/develop/classes/event.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/event.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/event.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>