Fuelクラス
Fuelクラスには、Fuelフレームワークのコアメソッドが含まれています。
本ドキュメントでは、アプリケーションで利用可能な同クラスのpublicメソッドを纏めています。
ここに記していないメソッドはクラス内部でのみ利用されるものなので、利用してはいけません。
クラス定数
環境定数。config.phpにおいてアプリケーションの動作環境を定めるために用いられます。
| TEST |
文字列型 |
'test'
|
テスト環境を同定します。
|
| DEVELOPMENT |
文字列型 |
'development'
|
開発環境を同定します。
|
| STAGE |
文字列型 |
'stage'
|
ステージング環境を同定します。
|
| PRODUCTION |
文字列型 |
'production'
|
製品環境を同定します。
|
ロギング定数。Logクラスで用いられます。またlogger():関数で用いられます。
| L_NONE |
整数型 |
0
|
ロギングレベル 0:ログをとりません。
|
| L_ERROR |
整数型 |
1
|
エラーメッセージのログをとります。
|
| L_WARNING |
整数型 |
2
|
警告メッセージのログをとります。
|
| L_DEBUG |
整数型 |
3
|
デバッグメッセージのログをとります。
|
| L_INFO |
整数型 |
4
|
情報メッセージのログをとります。
|
| L_ALL |
整数型 |
5
|
全てのレベルのログをとります。
|
Other constants:
| VERSION |
文字列型 |
'1.1'
|
インストールされているFuelのバージョンです。
|
クラスプロパティ
これらのプロパティは public なプロパティとして定義されていますが、正当な理由なく変更しないでください。
| $initialized |
はい |
論理型 |
false
|
フレームワークが初期化されているか。
|
| $env |
はい |
文字列型 |
FUEL::DEVELOPMENT
|
フレームワークを実行する環境定数。上記の環境定数のいずれかでなければいけません。
|
| $profiling |
はい |
論理型 |
false
|
true の場合、プロファイラーを有効にします。
|
| $locale |
はい |
文字列型 |
en_US
|
現在のロケールを定義します。
|
| $timezone |
はい |
文字列型 |
UTC
|
現在のタイムゾーンを定義します。
|
| $encoding |
はい |
文字列型 |
UTF8
|
現在の文字エンコードを定義します。
|
| $is_cli |
はい |
論理型 |
false
|
true の場合、フレームワークは CLI モードで実行されます。
|
| $is_test |
はい |
論理型 |
false
|
true の場合、フレームワークは Unit Test モードで実行されます。
|
load($file)
load メソッドは、指定ファイルをロード(インクルード)し、その結果を返します。例えば、設定ファイルをロードする時に本メソッドは使われます。その場合、設定情報は配列で返されます。
| 静的メソッド |
はい |
| パラメータ |
| パラメータ名 |
初期値 |
解説 |
| $file |
必須 |
ロードしたいファイル名 |
|
| 返り値 |
Mixed |
| 例 |
// ある PHP file をロード
if (Fuel::load('myfile.php'))
{
echo "MyFile was loaded successfully";
}
|
次の点に留意してください。もしインクルードされるファイルに return 宣言が含まれていない (NOT) 場合、ロードが成功すれば load() は 1 を返し、失敗すれば 0 を返します!