forked from NEKOGET/FuelPHP_docs_jp
-
Notifications
You must be signed in to change notification settings - Fork 0
/
fuel.html
324 lines (309 loc) · 9.28 KB
/
fuel.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
<!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 = "Fuel::";
</script>
<script src="./../assets/js/combined.js"></script>
<title>Fuel - クラス - 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>Fuel クラス</h2>
<p>
Fuel クラスには、Fuel フレームワークのコアメソッドが含まれています。
本ドキュメントでは、アプリケーションで利用可能な同クラスの public メソッドを纏めています。
ここに記していないメソッドはクラス内部でのみ利用されるものなので、利用してはいけません。</p>
<h3 id="class_constants">クラス定数</h3>
<p style="margin-bottom:10px;">環境定数。config.php においてアプリケーションの動作環境を定めるために用いられます。</p>
<table class="config">
<tbody>
<tr class="header">
<th>名前</th>
<th>型</th>
<th>値</th>
<th>説明</th>
</tr>
<tr>
<th>TEST</th>
<td>string</td>
<td><pre class="php"><code>'test'</code></pre></td>
<td>
テスト環境を同定します。
</td>
</tr>
<tr>
<th>DEVELOPMENT</th>
<td>string</td>
<td><pre class="php"><code>'development'</code></pre></td>
<td>
開発環境を同定します。
</td>
</tr>
<tr>
<th>STAGING</th>
<td>string</td>
<td><pre class="php"><code>'staging'</code></pre></td>
<td>
ステージング環境を同定します。
</td>
</tr>
<tr>
<th>PRODUCTION</th>
<td>string</td>
<td><pre class="php"><code>'production'</code></pre></td>
<td>
製品環境を同定します。
</td>
</tr>
</tbody>
</table>
<p id="log_constants" style="margin-bottom:10px;">ロギング定数。<a href="log.html">Log</a> クラスで用いられます。また <a href="log.html#function_logger">logger()</a> 関数で用いられます。</p>
<table class="config">
<tbody>
<tr class="header">
<th>名前</th>
<th>型</th>
<th>値</th>
<th>説明</th>
</tr>
<tr>
<th>L_NONE</th>
<td>integer</td>
<td><pre class="php"><code>0</code></pre></td>
<td>
ロギングレベル 0:ログをとりません。
</td>
</tr>
<tr>
<th>L_ERROR</th>
<td>integer</td>
<td><pre class="php"><code>1</code></pre></td>
<td>
エラーメッセージのログをとります。
</td>
</tr>
<tr>
<th>L_WARNING</th>
<td>integer</td>
<td><pre class="php"><code>2</code></pre></td>
<td>
警告メッセージのログをとります。
</td>
</tr>
<tr>
<th>L_DEBUG</th>
<td>integer</td>
<td><pre class="php"><code>3</code></pre></td>
<td>
デバッグメッセージのログをとります。
</td>
</tr>
<tr>
<th>L_INFO</th>
<td>integer</td>
<td><pre class="php"><code>4</code></pre></td>
<td>
情報メッセージのログをとります。
</td>
</tr>
<tr>
<th>L_ALL</th>
<td>integer</td>
<td><pre class="php"><code>5</code></pre></td>
<td>
全てのレベルのログをとります。
</td>
</tr>
</tbody>
</table>
<p style="margin-bottom:10px;">Other constants:</p>
<table class="config">
<tbody>
<tr class="header">
<th>名前</th>
<th>型</th>
<th>値</th>
<th>説明</th>
</tr>
<tr>
<th>VERSION</th>
<td>string</td>
<td><pre class="php"><code>'<script type="text/javascript">document.write(DocVersion);</script>'</code></pre></td>
<td>
インストールされている Fuel のバージョンです。
</td>
</tr>
</tbody>
</table>
<h3>クラスプロパティ</h3>
<p style="margin-bottom:10px;">これらのプロパティは public なプロパティとして定義されていますが、正当な理由なく変更しないでください。</p>
<table class="config">
<tbody>
<tr class="header">
<th>名前</th>
<th>静的</th>
<th>型</th>
<th>値</th>
<th>説明</th>
</tr>
<tr>
<th>$initialized</th>
<td>はい</td>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>
フレームワークが初期化されているか。
</td>
</tr>
<tr>
<th>$env</th>
<td>はい</td>
<td>string</td>
<td><pre class="php"><code>Fuel::DEVELOPMENT</code></pre></td>
<td>
フレームワークを実行する環境定数。上記の環境定数のいずれかでなければいけません。
</td>
</tr>
<tr>
<th>$profiling</th>
<td>はい</td>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>
true の場合、プロファイラーを有効にします。
</td>
</tr>
<tr>
<th>$locale</th>
<td>はい</td>
<td>string</td>
<td><pre class="php"><code>'en_US'</code></pre></td>
<td>
現在のロケールを定義します。
</td>
</tr>
<tr>
<th>$timezone</th>
<td>はい</td>
<td>string</td>
<td><pre class="php"><code>'UTC'</code></pre></td>
<td>
現在のタイムゾーンを定義します。
</td>
</tr>
<tr>
<th>$encoding</th>
<td>はい</td>
<td>string</td>
<td><pre class="php"><code>'UTF-8'</code></pre></td>
<td>
現在の文字エンコードを定義します。
</td>
</tr>
<tr>
<th>$is_cli</th>
<td>はい</td>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>
true の場合、フレームワークは CLI モードで実行されます。
</td>
</tr>
<tr>
<th>$is_test</th>
<td>はい</td>
<td>boolean</td>
<td><pre class="php"><code>false</code></pre></td>
<td>
true の場合、フレームワークは Unit Test モードで実行されます。
</td>
</tr>
</tbody>
</table>
<article>
<h4 class="method" id="method_load">load($file)</h4>
<p><strong>load</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>$file</kbd></th>
<td><i>必須</i></td>
<td>ロードしたいファイル名</td>
</tr>
</table>
</td>
</tr>
<tr>
<th>返り値</th>
<td>Mixed</td>
</tr>
<tr>
<th>例</th>
<td>
<pre class="php"><code>// ある PHP file をロード
if (Fuel::load('myfile.php'))
{
echo "MyFile was loaded successfully";
}
</code></pre>
</td>
</tr>
</tbody>
</table>
<p class="note"> 次の点に注意してください。もしインクルードされるファイルに <strong>return</strong> 宣言が含まれていない (NOT) 場合、ロードが成功すれば load() は <strong>1</strong> を返し、失敗すれば <strong>0</strong> を返します!</p>
</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/fuel.html">原文コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/commits/1.8/develop_japanese/classes/fuel.html">翻訳コミット履歴</a> | <a href="https://github.com/NEKOGET/FuelPHP_docs_jp/blob/1.8/develop_japanese/classes/fuel.html">GitHubで修正</a> ]
</p>
</footer>
</div>
</body>
</html>