トップページ > 1. ドキュメント > 1.2. CharcoalPHPの基本 > 1.2.2. コアコンポーネント(基本) > リクエスト

リクエスト

リクエストオブジェクトとは

CharcoalPHPにおいてリクエストオブジェクトは処理のきっかけ(トリガー)となるものを表します。リクエストオブジェクトの典型的な例は一般的なWebアプリケーションにおけるHTTPリクエストです。

リクエストオブジェクトの働き リクエストオブジェクトには処理開始時に外部から指定されるパラメータを保持し、なおかつそのパラメータへのアクセスを抽象化する役割があります。たとえばHTTPリクエストを表すCharcoal_HttpRequestにはURLに含まれるクエリー文字列やPOST変数の値が自動的に格納されます。格納された変数の値はgetStringなどのアクセサメソッドによって取得することができます。リクエストオブジェクトがあるおかげでタスク側の処理では外部からのパラメータの受け渡し方法を気にする必要がなくなり、コードの移植性が高まります。

リクエストオブジェクトの主なメソッド リクエストオブジェクトを定義するCharcoal_IRequestインタフェースの主なメソッドには以下のものがあります。

メソッド名 説明
getProcedurePath リクエストの契機となったプロシージャパスを取得
getRequestID リクエストに対してフレームワークが一意に振ったIDを取得
getKeys リクエストパラメータのすべてのキー文字列を配列として取得
get リクエストパラメータを取得
getString リクエストパラメータを文字列として取得
getInteger リクエストパラメータを整数として取得
getBoolean リクエストパラメータをブール型値として取得
getArray リクエストパラメータを配列として取得
set リクエストパラメータを設定
keyExists リクエストパラメータのキー文字列の中に指定した文字列があるか
Pocket

Comments are closed.