FuelPHP, a PHP 5.3 Framework Documentation

Rest コントローラ

Rest コントローラとは?

Rest コントローラは Base コントローラを継承したもので、RESTful のサポートが組み込まれています。 これは、API を簡単に構築をすることが出来ます。

Please note: もし、REST コントローラの中で before() や router メソッドを 使うなら、うまく動作させるために親クラスの parent::before() (または router) を呼び出さなければ いけません。

Rest コントローラを使う

すべてのコントローラと同様に、fuel/app/classes/controllerディレクトリ内にクラスを作成します。 それらは Controller_Rest クラスを継承し、"Controller_" というプレフィックスを付けます。 以下は "test" コントローラの例です:

class Controller_Test extends Controller_Rest
{

	public function get_list()
	{
		return $this->response(array(
			'foo' => Input::get('foo'),
			'baz' => array(
				1, 50, 219
			),
			'empty' => null
		));
	}
}

このコントローラの "list" メソッドは下記の URL から呼び出されます。

http://localhost/test/list.json?foo=bar

他のコントローラと同様に、 Rest コントローラにおいても "action_" というプレフィックスのメソッドは、 HTTP メソッドをプレフィックスとしたメソッドの代わりになることに気づくでしょう。 HTTP メソッドに当てはまるプレフィクスのメソッドがない場合、"action_" プレフィクスのメソッドが代わりに呼び出されます。 Rest コントローラがサポートしている一般的な HTTP メソッドは下記のとおりです。

これは制約に関するリストではありません。FuelPHP フレームワークは、Web サーバが受け付けるどんな HTTP メソッドも受け付けます。

出力

{
	"foo":"bar",
	"baz":[1,50,219],
	"empty":null
}

ファイル拡張子が URL で定義されているので、これは JSON として出力されます。デフォルトでは、XML フォーマット出力されるか、 fuel/core/config/rest.php に設定されているフォーマットで出力されます。

設定

REST コントローラは fuel/core/config/rest.php でグローバルに設定されており、既にデフォルト値が入力されています。 この設定ファイルを上書きするには、あなたのアプリケーションの設定ディレクトリに同名の設定ファイルを追加して、 設定したい値に変更してください。 これによって、Core の設定が上書きされますが、上書きされなかった設定は元の値が保持されます。

設定可能な値一覧

'xml'

'xml'

'REST API'

''

array('admin' => '1234')

false

サポートされるフォーマット

• xml – ほとんどのプログラミング言語は XML を読めます
• json – JavaScript で役立ち、PHP アプリでも使用が増えています。
• csv – 表計算プログラムで開きます
• html – シンプルな HTML の表
• php – eval() 可能な PHP コードでの表現
• serialize – PHP でアンシリアライズ可能な、シリアライズされたデータ

フォーマットの決定

返される結果のフォーマットを決定するために、REST コントローラは次のアルゴリズムを用います:

• 対応フォーマットを含むなら、protected なプロパティである $format を使用する
• 対応フォーマットであるなら、URL の拡張子を使用する
• 対応フォーマットを含むなら、ルートの中で指定された :format 変数のフォーマットを使用する
• HTTP_ACCEPT で定義されたフォーマットを使用する
• あなたのクラスの $rest_format プロパティで定義されたデフォルト値を使用する
• グローバル設定の default_format でで意義された値を使用する

多くの場合、 HTTP_ACCEPT が存在し、正しい結果のフォーマットである text/html を（少なくとも）含んでいます。 このことは $rest_format や rest.php 設定ファイルで定義されたグローバルなデフォルトが 使われないことを意味しています。

HTTP_ACCEPT がフォーマットの判定に使われないようにするには、 rest.php で ignore_http_accept キーの値を true に設定します。

結果のフォーマットを REST コントローラ内でハードコードすることはバッドプラクティスであることに注意してください。 返される結果のフォーマットはクライアントによって指定されるべきです。HTTP_ACCEPT に備えて、 例えば、jQuery.ajax() のような、 ほとんどの Ajax の手法は、application/json ヘッダを設定することを許可します。

XML Base Node Name

XML が出力される場合に、 XML のベースノードは $xml_basenode パラメータで設定されます。

class Controller_Test extends Controller_Rest
{
	// コントローラ全体に設定する
	protected $xml_basenode = 'my_basenode';

	// または、コントローラのメソッド内で
	public function get_items()
	{
		$this->xml_basenode = 'other_basenode';

		return $this->response(array(
			'foo' => Input::get('foo'),
			'baz' => array(
				1, 50, 219
			),
			'empty' => null
		));
	}
}

特別なコントローラのメソッド