forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathautoloader.html
485 lines (463 loc) · 13.6 KB
/
autoloader.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
<!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 = "Autoloader::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Autoloader - クラス - 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>Autoloader クラス</h2>
<p>Autoloader クラスは Fuel の自動読み込み機能です。自動読み込み処理に影響するメソッドも提供します。</p>
<article>
<h4 class="method" id="method_add_namespace">add_namespace($namespace, $path, $psr = false)</h4>
<p><strong>add_namespace</strong> メソッドは名前空間とそのパスを追加します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$namespace</kbd></th>
<td><em>必須</em></td>
<td class="description">名前空間</td>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><em>必須</em></td>
<td class="description">名前空間のパス</td>
</tr>
<tr>
<th><kbd>$psr</kbd></th>
<td><pre class="php"><code>false</code></pre></td>
<td class="description">PSR-0 に準拠した名前空間である場合は、 <strong>true</strong> をセットします。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::add_namespace('Mynamespace', PKGPATH.'mynamespace/');
// 入れ子になっている名前空間は、二重のバックスラッシュを付ける
Autoloader::add_namespace('Nested\\Namespace', PKGPATH.'nested/');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_add_namespaces">add_namespaces($namespace, $prepend = false)</h4>
<p><strong>add_namespaces</strong> メソッドは名前空間の配列を付け加えます。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$namespace</kbd></th>
<td><em>必須</em></td>
<td class="description">名前空間の配列。</td>
</tr>
<tr>
<th><kbd>$prepend</kbd></th>
<td><em>false</em></td>
<td class="description">配列の先頭に加えたいなら <em>true</em> にします。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::add_namespaces(array(
'Mynamespace' => PKGPATH.'mynamespace/',
'Othernamespace' => PKGPATH.'othernamespace/',
));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_namespace_path">namespace_path($namespace)</h4>
<p><strong>namespace_path</strong> メソッドは名前空間のパス名を取得します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$namespace</kbd></th>
<td><em>必須</em></td>
<td class="description">名前空間</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>名前空間のパス。存在しない時は <em>false</em> が返ります。</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code> // /path/to/mynamespace/
$path = Autoloader::namespace_path('Mynamespace');
// false
$path = Autoloader::namespace_path('Unknown\\Namespace');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_add_class">add_class($class, $path)</h4>
<p><strong>add_class</strong> メソッドはクラスのパスを付け加えます。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$class</kbd></th>
<td><em>必須</em></td>
<td class="description">クラス名</td>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><em>必須</em></td>
<td class="description">当該クラスのパス</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::add_class('Namespace\\Class', PKGPATH.'namespace/classes/class.php');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_add_classes">add_classes($classes)</h4>
<p><strong>add_class</strong> メソッドはクラスの配列を追加します。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$classes</kbd></th>
<td><em>必須</em></td>
<td class="description">クラスの配列</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::add_classes(array(
'Namespace\\Class' => PKGPATH.'namespace/classes/class.php',
'Namespace\\Other' => PKGPATH.'namespace/classes/other.php',
));
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_alias_to_namespace">alias_to_namespace($class, $namespace = '')</h4>
<p><strong>alias_to_namespace</strong> メソッドはクラスに名前空間の別名を与えます。初期設定はルートです。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$class</kbd></th>
<td><em>必須</em></td>
<td class="description">クラス名</td>
</tr>
<tr>
<th><kbd>$namespace</kbd></th>
<td><em>''</em></td>
<td class="description">別名としたい名前空間</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::alias_to_namespace('Mynamspace\\Myclass');
// 名前空間の別名を付ける
Autoloader::alias_to_namespace('Mynamspace\\Myclass', 'Other\\Namespace\\');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_add_core_namespace">add_core_namespace($namespace, $prefix = false)</h4>
<p>
<strong>add_core_namespace</strong> メソッドは、名前空間のプレフィックス無しで使われるかもしれないクラスに対して、グローバル名前空間の別名となる名前空間を付けます。
クラスにプレフィックスを付けると、コアクラスとそれまで付けられていた種々の名前空間をそのプレフィックスを付けて上書きします。
</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$namespace</kbd></th>
<td><em>必須</em></td>
<td class="description">名前空間</td>
</tr>
<tr>
<th><kbd>$prefix</kbd></th>
<td><em>false</em></td>
<td class="description">名前空間にプレフィックスを付けたいときは <em>true</em> を設定してください。</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::add_core_namespace('Mynamespace');</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<article>
<h4 class="method" id="method_load">load($class)</h4>
<p><strong>load</strong> メソッドは、当該クラスの探査を試み、読み込み、_init メソッドが存在した場合はそれを動作させます。</p>
<table class="method">
<tbody>
<tr>
<th>静的</th>
<td>はい</td>
</tr>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$class</kbd></th>
<td><em>必須</em></td>
<td class="description">クラス名</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td><em>Void</em></td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>Autoloader::load('Model_Users');
</code></pre>
</td>
</tr>
</tbody>
</table>
</article>
<h3 id="procedural_helpers">処理ヘルパー</h3>
<article>
<h4 id="function_import">import($path, $folder = 'classes')</h4>
<p><strong>import</strong> 関数は COREPATH 内の php ファイルをインポートします。</p>
<table class="method">
<tbody>
<tr>
<th>パラメータ</th>
<td>
<table class="parameters">
<tr>
<th>パラメータ</th>
<th>型</th>
<th>デフォルト</th>
<th class="description">説明</th>
</tr>
<tr>
<th><kbd>$path</kbd></th>
<td><em>string</em></td>
<td><em>必須</em></td>
<td>ファイルパス</td>
</tr>
<tr>
<th><kbd>$folder</kbd></th>
<td><em>string</em></td>
<td><pre class="php"><code>'classes'</code></pre></td>
<td>パスの前に付けるフォルダ。COREPATH からの相対パス</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>string</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// Spyc をインポートする
import('spyc/spyc', 'vendor');</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/autoloader.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/autoloader.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/autoloader.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>