FuelPHPのコアクラスの概要

FuelPHPのコアクラスについて自分なりに簡単にまとめてみました。自分なりにまとめていますので、間違いがあるかもしれませんが、そのときは指摘していただければ幸いです。それぞれの詳細な使い方は後日調べてみたいと思います。ほとんどが静的メソッドですので、アプリケーションのどこからでも、クラス名::メソッド名()で使用することができます。

Agentクラス

Agentクラスはユーザー情報(ブラウザの種類、プラットフォームやオペレーションシステム)を取得することが出来るクラスです。以下に紹介するメソッドは全て静的メソッドですので、Agent::メソッド名()で使用できます。

  • accepts_charset(文字セット)
    指定した文字セットかどうかを調べます。。trueかfalseを返します。
  • accepts_language($language)
    指定した言語かどうかを調べます。trueかfalseを返します。
  •  browser()
    ブラウザ名を返します。
  • platform()
    プラットフォーム名を返します。例:’Win7’、’Linux’、’MacOSX’
  • version()
    ブラウザのバージョンを返します。
  • charsets()
    ブラウザで使用可能な文字セットを配列で返します。
  • languages()
    ブラウザで使用可能なISO言語を配列で返します。
  • properties()
    ブラウザの全てのプロパティを配列で返します。
  • property(プロパティ名)
    ブラウザの特定のプロパティの値を返します。プロパティ名には調べたい値を指定します。
  • is_mobiledevice()
    ブラウザがモバイルかどうかを調べます。trueかfalseを返します。
  • is_robot()
    訪問者がロボットやクローラーかどうかを調べます。 trueかfalseを返します。

ARRクラス

ARRクラスは、配列を扱うためのクラスです。これも全て静的メソッドです。今回、ARRクラスについて調べ直したら、間違いがたくさんありましたので、修正させていただきます(2012/09/06)。詳しくは『FuelPHPのARRクラス』を参照して下さい。

  • to_assoc(配列)
    配列の中のセグメントの数が偶数の場合は、連想配列としてセットし、奇数の場合はNULL値を返します。奇数の場合はエラーを表示します。
  •  assoc_to_keyval(連想配列,キー,値)
    $連想配列から第2引数をキーとして、第3引数の値を返します。
  • average(配列)
    $配列の平均値を返します。
  •  delete(連想配列,キー)
    連想配列から、キーに該当する値を削除します。削除が成功した場合は、trueを失敗したときはfalseを返します。キーは 『.』(ドット)でつなげて、まとめて削除したり、多次元配列を指定できます。又、キーを配列で指定してまとめて削除することが出来ます。
  • get(連想配列,キー,デフォルト値)
    連想配列から第2引数をキーとして値を取得します。もし見つからない場合はデフォルト値を返します。
  • insert(配列,値,挿入位置)
    配列に値を挿入します。 挿入位置は後ろから数えた数字を入力します。挿入位置はキーの番号(数値)で指定します。
  •  insert_before_key(配列,値,キー番号)
    配列のキー番号の前に値を挿入します。
  • insert_after_key(配列,値,キー番号)
    配列のキー番号の後ろに値を挿入します。
  • insert_after_value(配列,値,検索値)
    検索値に一致する配列の後に値を挿入します。成功したらtrue、失敗したらfalseを返します。

Assetクラス

Assetクラスは、JS、CSS、imgファイル等のグループ化と表示や収集を支援するメソッドです。デフォルト値は、コアクラスのconfig/asset.phpにありますが、修正して使用したい場合は、fuel/app/configフォルダにコピーして、それを修正して使用します。取り急ぎ必要ではないので、省略します。

Autoloaderクラス

Autoloaderクラスは、自動読み込みのためのクラスです。

  • add_namespace(名前空間,パス,PSR-0準拠か否か)
    名前空間とそのパスを追加します。第3引数は省略可能ですが、初期値はfaleです。
  • add_namespaces(名前空間の配列,挿入位置)
    名前空間の配列を挿入します。挿入位置はtrueかfalseで指定します。 trueが先頭、falseが末尾です。省略すれば、falseが指定されます。
  • namespace_path(名前空間)
    名前空間のパスを返します。存在しないときはfalseを返します。
  • add_class(クラス名,パス)
    クラスのパスを追加します。
  • add_classes(クラスの配列) 
    クラスの配列を追加します。
  • alias_to_namespace(クラス名,別名)
    クラス名に別名を付けます。
  • add_core_namespace(名前空間,接頭辞)
    申し訳ありません、マニュアルを読んでもいまいち理解できませんので、説明を省略します。
  • load(クラス)
    クラスをロードします。_initメソッドが存在した場合は、それを実行します。

Cacheクラス

Cacheクラスを使用すると、リソースの重い結果をキャッシュして処理を高速化できます。デフォルトはコアクラスのconfigフォルダにcache.phpとして存在しますが、設定を修正したい場合は、fuel/app/configフォルダに保存して、それを修正します。とりあえずデフォルトのままでも使えると思いますので、これも省略します。

CLIクラス

CLIクラスはコマンドラインで対話するためのクラスです。これも使用頻度が少なそうなので、省略します。

Configクラス

ConfigクラスはFuelPHPの基本的な設定のためのクラスです。

  • get(項目名,初期値)
    項目名の値を返します。項目値が存在しない場合は初期値を返します。項目値がグループであればグループ全体を返します。
  • set(項目名,値)
    指定した項目に値をセットします。
  • delete(項目名)
    指定した項目を削除します。
  • load(ファイル名,グループ名,リロード,上書き)
    設定ファイルを読み込みます。第2引数以降は、省略可能です。設定ファイルが既に読み込まれている場合はfalseが返ります。
  • save(設定ファイル名, 文字列又は配列)
    設定ファイルを保存します。設定ファイルが存在しないときは、fuel/app/configフォルダに新規作成されます。第2引数が文字列の場合はグループ名、配列の場合は設定値として保存されます。保存されたらtrue、保存されなかったらfalseを返します。

Cookieクラス

Cookieクラスでは、クッキーの取得、設定、削除が出来ます。クッキークラスの設定ファイルは、fuel/app/configフォルダのconfigクラス内の146行目以下に設定されています。

  • get(クッキー名,初期値)
    $_COOKIE配列からクッキー名をキーとした値を取得します。クッキーの値が見つからない場合は初期値を返します。初期値は省略できますが、クッキーが見つからない場合はNULL値を返します。
  • set(クッキー名,値,有効期限,パス,ドメイン名,セキュア接続,HTTP経由)
    クッキー名にクッキー値を指定します。第3引数以降は、省略可能ですが、省略した場合は全てNULL値が挿入されます。
  • delete(クッキー名,パス,ドメイン名,セキュア接続,HTTP経由)
    指定したクッキー名の値を削除します。同様に第3引数以降は省略可能です。

Cryptクラス

Cryptクラスは、暗号化のためのクラスです。fuel/app/configフォルダに設定ファイルcrypt.phpがあります。

  • encode(値,暗号キー)
    暗号キーをもとに指定した値を暗号化した値を返します。暗号キーを省略した場合は設定ファイルの初期値が指定されます。
  •  decode(値,暗号キー)
    暗号キーをもとに指定した値を複合化した値を返します。同じく暗号キーを省略した場合は、設定ファイルの初期値が指定されます。デコードできなかった場合はfalseを返します。

DBクラス

DBクラスは、 データベースを操作するSQLを発行するためのクラスです。データベースを扱う上で重要なクラスですので、簡単にまとめてみますなどということは言えませんので今回は省略します。後日、DBクラスだけでまとめてみたいと思います。

DBUtilクラス

DBUtilクラスはデータベース本体を操作するためのクラスです。データベースやテーブルを作成したり、変更、削除等のできるクラスです。これも簡単に説明しきれませんので、DBクラスと一緒に後日まとめてみます。

Dateクラス

Dateクラスは日付を扱うヘルパー関数を集めたクラスです。PHPのDateTimeクラスとは異なり、fuelPHPのDateクラスは国際化を完全サポートしています。

  • forge(タイムスタンプ,タイムゾーン)
    コアクラスのDateオブジェクトを返します。タイムスタンプもタイムゾーンも省略した場合、configファイルの値が適用されます。
  • time(タイムゾーン)
    指定されたタイムゾーンの現在時刻をDateオブジェクトで返します。同じく省略した場合configファイルの値が適用されます。
  • create_from_stirng(日付文字列,使用するパターンキー)
    指定した日付文字列からDateオブジェクトを作成します。使用するパターンキーの初期値は、config/date.phpの”local”の値を適用します。
  •  range_to_array(開始日付,終了日付,間隔)
    指定範囲の日付のDateオブジェクトから配列を返します。 開始日付および終了日付はDateオブジェクトまたはタイムスタンプで指定します。
  • days_in_month(月,年)
    指定した年月の日数を返します。第2引数を省略すると現在の年が指定されます。
  • time_ago(タイムスタンプ)
    現在時刻とタイムスタンプとの差を返します。
  • format(パターンキー)
    パターンキーで指定した書式の日付を返します。
  • get_timestamp()
    Dateオブジェクトのタイムスタンプを返します。
  • get_timezone()
    Dateオブジェクトのタイムゾーンを返します。
  • set_timezone(タイムゾーン)
    Dateオブジェクトに指定したタイムゾーンをセットします。

Debugクラス

Debugクラスはデバッグ(バグ取り)のためのクラスです。初心者にはあまり関係がないので、今回は省略します。ただ、Debugクラスを駆使することが開発スピードを上げ、効率よくアプリケーションを作成するための近道だとは思います。

Eventクラス

Eventクラスは、コアクラスを変更することなくイベントを発生させることが出来るクラスです。

  • register(イベント名,コールバックメソッド)
    イベントが発生したときに、コールバックメソッドを呼び出します。正常にコールバックしたらtrueをコールバックに失敗したら、falseを返します。
  • trigger(イベント名,データ,戻り値の型)
    イベントが発生したときにデータを返します。戻り値の型の初期値は文字列です。
  • has_events(イベント名)
    指定したイベントはトリガを持っているかどうかをチェックします。trueかfalseを返します。

トリガとは元々は、『銃の引き金又は引き金を引く』というような意味で何かのきっかけで物事が開始するような場合に使われます。つまり、上記では、イベントを境にして、プログラムが起動することを意味します。

Fieldsetクラス

フィールドセットクラスは、マニュアルによるとフォームとバリデーションクラスを使い、このフォームとバリデーションを1つの領域としてモデル化して使用するようなことが書いてありますが、実際に使いながら調べてみないといまいちピントきませんので、後日詳細は調べてみたいと思います。尚、foregeメソッドとinstanceメソッド以外は静的メソッドではありませんので、注意が必要です。

  • forege(フィールドセット名,configの配列)
    新しいフィールドセットのインスタンス(フィールドセットのオブジェクト)を返します。
  • instance(インスタンス名)
    指定したインスタンス(フィールドセットオブジェクト)を返します。指定したインスタンスがないときはfalseを返します。
  • validation()
    現在のバリデーション(検証)インスタンス(バリデーションオブジェクト)を返します。 バリデーションインスタンスがないときは、新規に作成します。
  • form()
    現在のフォームのインスタンス(フォームオブジェクト)を返します。 存在しないときは新規に作成します。
  • add(名前,ラベル名,属性の配列,ルールの配列)
    現在のフィールドセットに新しいフィールドを追加します。Filedset_Filedオブジェクトを返します。
  • add_before(名前,ラベル名,属性の名前, 属性の配列,ルールの配列,フィールド名)
    現在のフィールドセットの前に新しいフィールドを追加します。
  • add_after(名前,ラベル名,属性の配列,ルールの配列,フィールド名)
    現在のフィールドセットの後に新しいフィールドを追加します。addとほとんど変わらないと思います。
  • field(フィールド名)
    現在のフィールドセットから新しいフィールドのインスタンスを作成します。
  • add_model(クラス名、インスタンス名,メソッド)
    モデルのフィールドを追加します。
  • set_config(config名,値)
  • get_config(キー,既定値)
  • populate(初期値,再設定値)
    入力フィールドに初期値を設定します。第2引数は省略するとfalseが指定されます。
  • repopulate()
    入力値を保持します
  • build(フォームのURL)
    HTMLフォームのマークアップを生成します。
  • input(フィールド名)
    指定のフィールドの検証入力値の配列を取得します。
  • validated($field=null)
    検証後の入力値の配列を取得します。
  • errors($fied=null)
    検証に合格しなかった入力値の配列を取得します。
  • show_errros(Array $config=array())

Fileクラス

Fileクラスは、ファイルとフォルダ(ディレクトリ)を扱うためのメソッドです。デフォルトの設定ファイルはコアクラスのconfigフォルダにありますので、設定ファイルを修正する場合はapp/configフォルダにfile.phpをコピーして修正して下さい。

  • create(作成場所のパス,ファイル名,コンテンツ,領域)
    ファイルを新規作成します。 新規作成できたときは、tureを返します。ファイルが既にあるときや、無効なパスが指定されたときはException(例外)がスローされます。
  • creat_dir(作成場所のパス,ディレクトリ名,ディレクトリの権限,領域)
    ディレクトリを新規作成します。
  • read(ファイルのパス,as_string,領域)
    ファイルを読み取るのだとは思いますが、いまいち英文が理解できませんでしたので、正確な使い方は実践してみないと分かりません。
  • read_dir(ディレクトリのパス、階層,フィルター,領域)
    配列にディレクトリの内容を読み込みます。 第2引数の階層は、初期値が0で全ての階層を読み込みます。現在のディレクトリのみを読み込む場合は1を指定します。
  • update(ファイルのパス,ファイル名,コンテンツ,領域)
    ファイルを更新します。尚、ファイルが存在しないときは新規作成されます。
  • append(パス,ファイル名,コンテンツ,領域)
    ファイルを追加します。
  • rename(パス,新しいパス名かファイル名,領域)
    ディレクトリ名かファイル名を変更します。
  •  rename_dir(パス,新しいパス名,領域)
    ディレクトリ名を変更するのだと思いますが、英文が解読できず、マニュアルがいまいち理解出ません。
  • copy(パス,新しいパス,領域)
    ファイルをコピーします。
  • copy_dir(パス,新しいパス,領域)
    ディレクトリをコピーします。
  • delete(パス,領域)
    ファイルを削除します。
  • delete_dir(パス,サブディレクトリの削除の有無,親ディレクトリの削除の有無,領域)
    ディレクトリを削除します。
  • open_file(パス,ロックの有無,領域)
    ファイルを開き、それをロックします。第2引数はデフォルトがtrueですので、をfalseにするとファイルをロックしないで開きます。
  • close_file(リソース,領域)
    ファイルを閉じて、ロックを解除します。
  • get(パス,configの配列,領域)
    指定したパスにあるファイルのファイルハンドラを取得します。
  • get_url(パス,configの配列,領域)
    ファイルの公開URLを取得します。
  • get_permission(パス,領域)
    ファイル又はディレクトリのアクセス権を取得します。
  • get_time(パス,created又はmodified,領域)
    ファイルの作成した時間か更新した時間を取得します。 第2引数の既定値はmodified(修正)です。
  • get_size(パス,領域)
    ファイルのサイズをバイト単位で取得します。
  • file_info(パス,領域)
    ファイル情報の配列を取得します。
  • download(パス,新しいファイル名,MIMEタイプ,領域)
    ファイルをダウンロードします。新しいファイル名やMIMEタイプがNULL値なら、既存のファイル名やMIMEタイプを書き換えます。

Finderクラス

Finderクラスは、ファイルの検索パスを検索したり、ファイルをロードしたりするために使うクラスです。

  • forge(パスの配列)
    新しいfinderオブジェクトを返します。
  • instance()
    instanceメソッドは、finderのシングルトンオブジェクトを返します。
  • seach(ディレクトリ,ファイル,拡張子,複数検索のtrueかfalse,キャッシュ) 
    ファイルを検索します。
  • add_path(パス,ポジション)
    Finderのインスタンスに新しい検索パスを追加します。
  • remove_Path(パス)
    Finderのインスタンスの検索リストから指定されたパスを削除します。
  • paths()
    検索パスのリストの配列を返します。
  • list_files(ディレクトリ,ファイルの種類)
    ディレクトリ内の全てのファイルのリストを取得します。
  • locate(ディレクトリ,拡張子,複数検索のtrueかfalse,キャッシュ)

 formクラス

formクラスは、HTMLのフォームタグを生成するためのクラスです。バリデーションクラスと一緒にフィールドセットとして使用することで完全なフォームを作成することが出来ます。HTMLタグを打てる人ならformクラス単独で使う意味はあまりないかもしれません。フィールドセットクラスの中で使用することでこのformクラスが生きてくるのではないのでしょうか。

  • open(属性の配列,hiddenの配列)
    フォーム開始タグを生成します。
  • close()
    フォーム終了タグを生成します。
  • input(フィールド名,値,属性の配列)
    HTMLのテキストフィールドを生成します。
  • button(フィールド名,値,属性の配列)
    HTMLのボタンタグを生成します。
  • hidden(フィールド名,値,属性の配列)
    hidden属性のテキストフィールドを生成します。
  • password(フィールド名,値,属性の配列)
    password属性のテキストフィールドを生成します。
  •  radio(フィールド名,値,属性の配列)
    ラジオボタンタグを生成します。
  • checkbox(フィールド名,値,属性の配列)
    チェックボックスタグを生成します。
  • file(フィールド,属性の配列)
    ファイル属性のテキストフィールドを生成します。
  • reset(フィールド名,値,配列の属性)
    リセットボタンを生成します。
  •  submit(フィールド名,値,属性の配列)
    submit タグを生成します。
  • textarea(フィールド名,値,属性の配列)
    テキストエリアタグを生成します。
  • select(フィールド名,オプションの配列,属性の配列)
    セレクトフィールドタグを生成します。
  • label(ラベル名,id,配列の属性)
    ラベルタグを生成します。
  • fieldset_open(属性の配列,legend)
    フィールドセットの開始タグを生成します。
  • fieldset_close() 
    フィールドセットの終了タグを生成します。

Formatクラス

FormatクラスはXML、JSON、CSV等の様々のファイル間のデータ変換をするためのクラスです。取り急ぎ使わないと思いますので、省略します。

FTPクラス

FTPクラスはFTPプロトコルを介して、リモートサーバーとファイルのダウンロードやアップロードをするためのクラスです。今は手動でレンタルサーバーとやりとりしていますが、自動的に保守メンテナンス出来るようにするためには必要だと思います。これも取り急ぎ必要ではないので、省略します。

Fuelクラス

Fuelクラスは、FuelPHPのコアメソッドが含まれているクラスです。これも取り急ぎ知らなくてもいいと思いますので、省略します。

HTMLクラス

HTMLクラスはHTMLタグのラッパークラスです。まあ、普通にタグを打てるのなら早急に覚える必要も無いのかなと思い後日調べることにしたいと思います。

ラッパーとは、元々は、包装紙やカバーなどのものを包むという意味で、あるクラスや関数、データ型などが提供する機能やデータを別の形で提供するもののことをいいます。

Imageクラス

Imageクラスは、簡単にリサイズ、トリミング等、画像の操作を行うためのクラスです。設定ファイルを修正する場合は、core/configフォルダにあるimage.phpをapp/configフォルダにコピーして、コピーしたファイルを使用します。

  • forge(configの配列)
    新しいイメージドライバーインスタンスを作成します。
  • config(インデックス又は設定オプションの配列,値)
    config(設定)オプションの値を変更したイメージドライバーのインスタンスを作成します。値はインデックスが配列でないときに指定することが出来ます。
  • load(ファイル名,$return_data)
    編集するためにイメージをロードします。$return_dataの初期値はfalseですが、マニュアルの意味が理解できずに、trueにした場合の挙動がいまいち分かりません。
  • crop(x1,y1,x2,y2)
    座標やパーセントを使用して新しい画像を作成します。
  • resize(横幅,高さ,$keepar,$pad)
    画像をリサイズします。横幅は必須項目です。高さがNULL値で、$keeparがtrueなら、縦横比はオリジナルに準じます。
  • crop_resize(横幅,高さ)
    横幅や高さに合わせて新しい画像を作成します。横幅は必須項目です。
  • rorate(回転させる度数)
    画像を時計回りに回転させます。
  • watermark(ファイル名,透かしの位置,padding)
    画像に透かしを追加します。透かしの位置はtop|center|middle|bottomとleft|center|middle|bottomを組み合わせて指定します。 paddingは画像の端からの位置です(ピクセル単位で指定します)。
  • border(サイズ,色)
    画像に境界線を追加します。 サイズは必須です(ピクセル単位で指定します)。
  • mask(マスク画像)
    画像にマスクを適用します。マスク画像は必須です。マスクする画像を指定します。
  • rounded(半径,辺の指定,アンチエイリアス)
    画像に角丸を適用します。 半径の指定は必須です。角丸を適用する辺をtl|tr|bl|brで指定します。初期値のNULL値の場合は4角全てを指定します。
  • save(フィル名,パーミッション)
    ファイル名を指定して保存します。パーミッションの初期値はNULL値です。NULL値の場合は755を適用します。
  • save_pa(先頭付加文字,末尾付加文字,拡張子,パーミッション)
    先頭付加文字や末尾付加文字を指定して、以前の画像と同じが場所に保存しします。先頭付加文字は必須です。
  • output(ファイルタイプ)
    画像を出力し、ヘッダー情報を取得します。ファイルタイプは(PNG,GIF,JPEG)として画像を出力します。ファイル形式がNULL値の場合は元の画像の拡張子がデフォルになります。

Inflectorクラス

Inflectorクラスはテーブル名やクラス名を変換するためのクラスみたいですね。他のフレームワーク等で今まで使ってきたクラスやテーブル名をFuelPHPの設定に合わせるため変換することが出来るということでしょうか。これも取り急ぎ必要が無いので省略します。

Inputクラス

Inputクラスは、HTTPパラメータ、サーバー変数、ユーザーエージェントの詳細にアクセスすることの出来るクラスです。

  • uri()
    現在のURIを返します。
  • cookie(インデックスキー,初期値)
    $_COOKIE変数を返します。インデックスキーをドットで区切ると多次元配列にアクセスできます。値が見つからないときは、初期値を返します。初期値を省略するとNULL値が代入されます。
  • delete(インデックスキー,初期値)
  • put(インデックスキー,初期値)
  • get(インデックスキー,初期値)
    $_GET変数を取得します。
  • post(インデックスキー,初期値)
    $_POST変数を取得します。
  • get_post(インデクスキー,初期値)
    最初に$_GET変数をチェックしてから、$_GET変数と$_POST変数を取得します。 get_post()メソッドは現在削除されています。(2012/06/12修正)
  • is_ajax()
    AJAXを介して呼び出された場合は、tureを返します。
  • method()
    コントローラを呼び出すために使用するHTTPメソッドを返します。
  • protocol()
    コントローラを呼び出すために使用するプロトコルを返します。
  • ip()
    ユーザーのパブリックIPアドレスを返します。
  • real_ip()
    ユーザーの本当のIPアドレスを返します。プロキシサーバー経由の場合、ユーザーのプライベートIPアドレスを探しますが、情報が見つからない場合は、パブリックIPアドレスを返します。
  • server(インデックスキー,初期値)
    $_SERVER配列からインデックスキーのパラメータを返します。
  • refferrer(インデックスキー)
    直前に閲覧していたページのURL情報を返します。
  • user_agent(初期値)
    $_SERVER配列からユーザーエージェントを返します。
  • all()
    GET,POST,PUT,DELETEの全ての変数を返します。
  • file(インデックスキー,初期値)
    ファイルの配列からインデックスキーの項目を返します。
  • param(インデックスキー,初期値)
    GET,POST,PUT,DELETEのいずれかから項目を返します。

Langクラス

Langクラスはアプリケーションの言語ファイルに関するクラスです。取り急ぎ使いませんので、省略します。

Logクラス

Logクラスは、ログファイル(コンピュータの利用状況やデータ通信の記録したファイル)を利用するためのクラスです。これも取り急ぎ使いませんので、省略します。

Migrateクラス

Migrateクラスは、データ移行のためのクラスです。これも省略します。

Model_Crudクラス

Model_Crudクラスは、CRUD(生成、読み取り、更新、削除)操作を支援するためのクラスです。Model_Crudクラスを使うには、最初に\Model_Crudクラスを拡張するクラスを作成する必要があります。実際に使用してみないとニュアンスの分からないものの説明は省略しています。

  • forge(データの配列)
    新しいModel_Crudクラスのインスタンスを返します。
  • find_by_pk(主キーの値)
    主キーの値でレコードを検索します。
  • find_one_by(列,値,演算子)
    指定された列と値で1つのレコードを検索します。
  • find_by(列,値,演算子,制限,オフセット値)
    指定された列と値に一致する全てのレコードを検索します。
  • find_by_*(値)
    済みません、英文の説明がいまいち理解できません。
  • find_all(リミット値,オフセット値)
    全てのレコードを検索します。
  • find(設定値の配列,キー)
  • pre_find(クエリー)
  • post_find($result)
  • set(値の配列)
    現在のモデルのインスタンスに値をセットします。静的メソッドではありません。
  • save()
  • delete()
  • is_new(レコード)
    指定のレコードが新規かどうかを調べ、現在のインスタンスを返します。
  • is_frozen(レコード)
    指定のレコードが凍結されているかどうか調べ、現在のインスタンスを返します。
  • validation()
    モデルのバリデーションインスタンスを返します。
  • to_array()
  • pre_save($query)
  • post_save($result)
  • pre_save($query)
  • post_update($result)
  • pre_delete($query)
  • post_delete($result)
  • pre_validate($data)
  • post_validate($data)
  • pre_values($data)

Mongo_Dbクラス

最近のはやりのNoSQLのMongo_dbを扱うためのクラスです。NoSQLはまだ勉強したことがないので、これも省略します。そのうち勉強する機会があれば、NoSQLについても調べてみたいと思います。

Numクラス

Numクラスは、数値を扱うための書式設定のためのクラスです。

  • bytes(サイズ)
    指定のサイズ(文字列,int型、浮動小数点型)をバイト単位に変換します。
  • format_bytes(バイト,進数)
    指定のバイト数を人間が読める形に変換します。
  • quantity(数字,進数)
    指定の数字を人間が読める形に変換します。
  • format(文字列,フォーマット形式)
    指定の文字列を指定されたフォーマット形式に変換します。
  • mask_string(文字列,フォーマット形式,無視する文字)
    指定した文字列を指定されたフォーマット形式でマスクをかけます。
  • format_phone(文字列,フォーマット形式)
    指定した文字列を指定した電話番号の形式に変換します。
  • smart_format_phone(文字列)
    指定した文字列を数字の長さによって指定した電話番号形式の数字に変換します。
  • format_exp(文字列,フォーマット形式)
    指定した文字列をクレジットカードの有効期限の文字列に変換します。
  • mask_credit_card(文字列,フォーマット形式)
    指定した文字列をマスク形式のクレジットカード番号文字列に変換します。

Packageクラス

Packageクラスは、パッケージを簡単にロードしたり、アンロードしたりするためのクラスです。これも取り急ぎ必要が無いので省略します。

 Paginationクラス

Paginationクラスは、簡単にページネーションを作成する為のクラスです。

  • set_config(設定の配列)
    設定の配列を渡すことによって、ページネーションの設定を変更することが出来ます。
  • create_links()
    ビュー内の改ページリンクを生成します。
  • next_links(ページ上に表示するテキスト)
    conifig(設定値)に基づいた改ページリンクの次へリンクを生成します。
  • prev_link(表示テキスト)
    config(設定値)に基づいた戻るリンクを生成します。
  • page_links()

Redisクラス

Redisクラスは、Mong_Dbと同様にNoSQLのデータベースRedisを扱うためのクラスです。これも省略します。

Requestクラス

Requestクラスは、URIを処理するためのクラスです。

  • factory(URI,ルート)
    新しいリクエストオブジェクトを返します。
  • execute()
    リクエストオブジェクト内の結果を返します。静的メソッドではありません。
  • response()
    リクエストのレスポンスオブジェクトを返します。静的メソッドではありません。
  • parent()
    リクエストのコアオブジェクトを返します。静的メソッドではありません。
  • children()
  • show_404($return)
    アプリケーションの404ページを表示するかどうかを返します。$returnはtrueかfalseで指定します。初期値はfalseです。
  • main()
    メインリクエストのインスタンス(最初のページ要求によって作成されたもの)を返します。
  • active()
    現在のアクティブなリクエストのインスタンスを返します。
  • add_path(パス,接頭辞)
    現在のリクエストインスタンスの検索パスを追加します。
  • get_paths()
    検索パスの定義されたリストを返します。

Responseクラス

Responseクラスは、HTTPレスポンスやブラウザの出力に関するクラスです。

  • set_header(ヘッダー名,値,置換)
    ヘッダー情報をセットします。第3引数は同じ名前の時に置換します。初期値はtrueです。置換したくないときはfalseを指定します。静的メソッドではありません。
  • send_headers()
    ブラウザに設定されたヘッダー情報を送信します。
  • redirect(リダイレクトするurl,リダイレクション方式,HTTPステータスコード)
    新しいurlにリダイレクトします。返値はなく、現在のスクリプトを終了します。

Securityクラス

Securityクラスは、アプリケーションをCSRF攻撃等から守るためのクラスです。fuel/app/config/config.phpの140行目以降に設定されています。

  • check_token(値)
    指定した値のCSRFトークンをチェックします。値がNULL値の時はPOSTの値をチェックします。
  • fetch_token()
    クッキーからCSRFトークンを取得します。
  • js_fetch_token()
    AJAX操作のCSRFトークンを取得します。
  • js_set_token()
    AJAX操作のためのCSRFトークンを生成します。
  • clean(文字列,フィルター)
    指定した文字列又は、配列にフィルターをかけます。
  • strip_tags(文字列)
    文字列からHTML及びPHPタグを取り除きます。
  • xss_clean(文字列)
    HTMLawedライブラリから危険なHTMLタグを取り除きます。
  • htmlentities(文字列)
    文字列をhtmlentites処理を施したHTML文字に変換します。

手続きヘルパー

  • e(文字列)
    Security::htmlentitiesの別名(略称)関数です。htmlentities処理の施された文字列を返します。

Sessinクラス

Sessionクラスは、セッションに関する手続きの為のクラスです。fuel/core/condig/session.phpにデフォルトの設定がありますが、これを修正する場合はfuel/app/configフォルダにコピーして、コピーしたsession.phpを修正します。セッションクラスはWebアプリケーションを作成する上で最も重要なクラスの1つですので、後日Sessionクラスだけでまとめてみたいと思います。

Strクラス

Strクラスは文字列の操作を支援するためのクラスです。

  • increment(文字列,最初の番号)
    文字列の末尾に番号を追加します。番号が既に存在するときはその番号に数値を1追加します。
  • random(タイプ,文字列の長さ)
    指定されたタイプに基づいて、ランダムな文字列を生成します。
  • truncate(文字列,文字数制限,継続文字列,第4引数)
    文字列を文字数制限で切り捨て、継続文字列を末尾に追加します。第4引数がtureの場合はHTMLを壊さないようにします。
  • alternator($args)
    済みません、英文が解読不能のため説明を省略します。
  • lower(文字列,コンコード)
    指定の文字列を全て小文字に変換します。
  • tr(文字列,配列)
    PHPのstrtr()関数を使用して、指定した文字列を配列のキーを第2引数に、配列の値を第3引数として置換します(※strtr関数は、str(文字列,検索文字,置換文字)という風に使います)。

Themeクラス

Themeクラスは、アプリケーションにテーマを提供するためのクラスです。テーマは、テーマテンプレート(ビュー)とAsset(資産)をグループ化し、アクティブなテーマを切り替えることにより、アプリケーションの外観と雰囲気を変更することが出来ます。

テーマはモジュールやパッケージと同様に、複数の場所に格納することが出来ます。configファイルで、これらの場所へのパスを定義したり、実行時にテーマのインスタンスに追加することが出来ます。テーマはテーマ情報ファイルを通じてあなたのテーマの設定情報を提供することが出来ます。

テーマクラスは、core/configフォルダにあるtheme.phpをapp/configフォルダにコピーして、そのコピーしたtheme.phpファイルの設定を変更することによりあなたのテーマクラスを利用することが出来ます。

このテーマクラスは使いこなせば、かなり便利そうなのですので、そのうち詳細な使い方を調べてみたいと思います。

Uploadクラス

Uploadクラスは、安全にアプリケーションにアップロードされているファイルを処理するためのクラスです。Uploadクラスは、furel/core/config/upload.phpにデフォルトの設定ファイルがあります。設定ファイルを修正する場合は、fuel/app/configフォルダにコピーして、コピーしたupload.phpファイルを修正して下さい。

  • is_valid()
    バリデーション済みのファイルがあるかどうかをture,falseでします。
  • get_files(インデックス番号)
    指定したインデックス番号の検証済みファイルの多次元配列を返します。インデックス番号を指定しない場合はすべての検証済みファイルを持つ配列が返されます。また、ファイルが存在しないときはfalseを返します。
  • get_errors(インデック番号)
    エラーが発生したアップロードファイルの多次元配列を取得します。インデックス番号を指定しない場合は、すべてのエラー発生ファイルの一覧を返します。ファイルが存在しないときはtrueを返します。
  • register(イベント名,コールバック)
    アップロードイベントのコールバックを登録することができます。
  • process(設定の配列)
    config(設定)の配列に基づきアップロードされたファイルに関する情報を検証します。
  • save(パス,パス,パス,…)
    指定したパスにアップロードされるすべての検証ファイルを保存します。

Uriクラス

Uriクラスは、URIを処理するためのクラスです。

  • base(インデックスの付加の真偽)
    ベースURLを返します。返された1URLにインデックスを付加するかどうかをtrueかfalseで指定できます。初期値はtrueです。
  • create($uri,クエリ文字列の配列,セキュアの真偽)
    ベースURLを含めたuriを生成します。クエリ文字列を付与する場合は配列で指定します。セキュア指定(httpかhttpsか)をtrueかfalseで指定できます。
  • current()
    HMVCパターン内のベースURLを含む現在のURLを返します。
  • main()
    ベースURLを含む現在のURLを返します。
  • segment(セグメント,初期値)
    セグメントの値を返します。
  • segments()
    セグメントの値を配列として返します。
  • to_assoc()
    セグメントの値を取得し、セグメントの数が偶数の場合は連想配列に変換し、奇数の場合はNULL値を返します。
  • string()
    現在のURIを取得します。

Validationクラス

Validationクラスは、データの検証のためのクラスです。フィールドセットとして、フォームと一緒に使用することで効果を発揮するとのことですが、これも実際にフィールドクラスを使ってみないとわからないので、後日詳細は調べてみます。ですので、大事なValidationクラスですが、本日は省略します。

Viewクラス

Viewクラスはビューファイルを使うためのクラスです。これはすでにいくつか使ってきていますが、復習のためまとめてみます。

  • forge(ファイル名,値の配列,エンコード)
    新しいビューオブジェクトを返します。
  • auto_encode(tureまたはfalse)
    自動エンコードするかどうかを指定します。
  • set_filename(ファイル名)
    ビューのファイル名を設定または変更します。
  • set(変数名,値,エンコード)
    ビューに変数を割り当てます。
  • set_global(変数名,値,エンコード)
    すべてのビューに変数を割り当てます。
  • bind(変数名または配列,値)
    変数または配列に参照によって値を割り当てます。割り当てられた値はビューのファイル内の変数として利用できます。
  • bind_global(変数名,値)
    すべてのビューのアクセス参照によってグローバル変数を割り当てます。
  • render(ファイル名)
    ビューオブジェクトをレンダリングします。

手続きヘルパー
render($view,$data)
render関数は、View::renderの別名関数です。つまり、
1) View::render(ファイル名)->set(データ配列)
2) render(ファイル名,データ配列)
の1)と2)は同じです。

一応、ざっとコアクラスを私なりにまとめてみました。今回はあくまでも私の整理用としてまとめていますので、間違ったところや表現のおかしいところは多々あるかも知れませんが、ご容赦ください。尚、間違いを発見した場合は随時修正していきます。

このエントリーを含むはてなブックマーク Buzzurlにブックマーク livedoorクリップ Yahoo!ブックマークに登録

トラックバック&コメント

この投稿のトラックバックURL:

コメントをどうぞ

このページの先頭へ