リクエストとレスポンスオブジェクト¶

$controllerName = $this->request->getParam('controller');

// 3.4.0 より前
$controllerName = $this->request->param('controller');

$params = $this->request->getAttribute('params');

// 渡された引数
$passedArgs = $this->request->getParam('pass');

// URL は /posts/index?page=1&sort=title
$page = $this->request->getQuery('page');

// 3.4.0 より前
$this->request->query('page');

$foo = $this->request->getQuery('value_that_does_not_exist');
// $foo === null

// デフォルト値も提供できます。
$foo = $this->request->getQuery('does_not_exist', 'default val');

$query = $this->request->getQueryParams();

// name 属性が 'MyModel[title]' の入力は次のようにアクセスします。
$title = $this->request->getData('MyModel.title');

$foo = $this->request->getData('Value.that.does.not.exist');
// $foo == null

$jsonData = $this->request->input('json_decode');

// ホストの取得
$host = $this->request->env('HTTP_HOST');

// 値を設定。一般的にはテストに役立ちます。
$this->request->env('REQUEST_METHOD', 'POST');

$env = $this->request->getServerParams();

// PUT/POST アクションで投稿されたデータを JSON 形式にエンコードで取得する
$jsonData = $this->request->input('json_decode');

// PUT/POST アクションで投稿されたデータを XML エンコードで取得する
$data = $this->request->input('Cake\Utility\Xml::build', ['return' => 'domdocument']);

// 現在のリクエスト URL が /subdir/articles/edit/1?page=1 であると仮定

// /subdir/articles/edit/1?page=1 を保持
$here = $request->getRequestTarget();

// /subdir を保持
$base = $request->getAttribute('base');

// /subdir/ を保持
$base = $request->getAttribute('webroot');

// 3.4.0 より前
$webroot = $request->webroot;
$base = $request->base;
$here = $request->here();

$isPost = $this->request->is('post');

// environment detector の追加
$this->request->addDetector(
    'post',
    ['env' => 'REQUEST_METHOD', 'value' => 'POST']
);

// pattern value detector の追加
$this->request->addDetector(
    'iphone',
    ['env' => 'HTTP_USER_AGENT', 'pattern' => '/iPhone/i']
);

// option detector の追加
$this->request->addDetector('internalIp', [
    'env' => 'CLIENT_IP',
    'options' => ['192.168.0.101', '192.168.0.100']
]);

// callback detector を追加。有効な callable 形式でなければなりません。
$this->request->addDetector(
    'awesome',
    function ($request) {
        return $request->getParam('awesome');
    }
);

// 追加の引数を使用する検出器を追加。3.3.0 以降。
$this->request->addDetector(
    'controller',
    function ($request, $name) {
        return $request->getParam('controller') === $name;
    }
);

$userName = $this->request->session()->read('Auth.User.name');

// 'example.org' を表示
echo $request->domain();

// 'my.dev.example.org' の場合、 ['my', 'dev'] を返す
$subdomains = $request->subdomains();

// 'my.dev.example.org' を表示
echo $request->host();

// POST を出力
echo $request->getMethod();

// 3.4.0 より前
echo $request->method();

public function delete()
{
    // POST と DELETE のリクエストのみ受け入れます
    $this->request->allowMethod(['post', 'delete']);
    ...
}

// 文字列としてヘッダーを取得
$userAgent = $this->request->getHeaderLine('User-Agent');

// 全ての値を配列で取得
$acceptHeader = $this->request->getHeader('Accept');

// ヘッダーの存在を確認
$hasAcceptHeader = $this->request->hasHeader('Accept');

// 3.4.0 より前
$userAgent = $this->request->header('User-Agent');

$this->request->trustProxy = true;

// これらのメソッドがプロキシーのヘッダーを使用するようになります。
$port = $this->request->port();
$host = $this->request->host();
$scheme = $this->request->scheme();
$clientIp = $this->request->clientIp();

$accepts = $this->request->accepts();

$acceptsJson = $this->request->accepts('application/json');

$acceptsLanguages = $this->request->acceptLanguage();

$acceptsSpanish = $this->request->acceptLanguage('es-es');

// クッキーの値、またはクッキーが存在しない場合 null を取得
$rememberMe = $this->request->getCookie('remember_me');

// 値の読み込み、またはデフォルトの 0 を取得
$rememberMe = $this->request->getCookie('remember_me', 0);

// ハッシュとして全てのクッキーを取得
$cookies = $this->request->getCookieParams();

// CookieCollection インスタンス (3.5.0 以降) を取得
$cookies = $this->request->getCookieCollection()

// vCard タイプを追加
$this->response->type(['vcf' => 'text/v-card']);

// レスポンスのコンテンツタイプを vcard に設定
$this->response = $this->response->withType('vcf');

// 3.4.0 より前
$this->response->type('vcf');

public function sendFile($id)
{
    $file = $this->Attachments->getFile($id);
    $response = $this->response->withFile($file['path']);
    // レスポンスオブジェクトを返すとコントローラーがビューの描画を中止します
    return $response;
}

// 3.4.0 より前
$file = $this->Attachments->getFile($id);
$this->response->file($file['path']);
// レスポンスオブジェクトを返すとコントローラーがビューの描画を中止します
return $this->response;

$response = $this->response->withFile(
    $file['path'],
    ['download' => true, 'name' => 'foo']
);

// 3.4.0 より前
$this->response->file(
    $file['path'],
    ['download' => true, 'name' => 'foo']
);

public function sendIcs()
{
    $icsString = $this->Calendars->generateIcs();
    $response = $this->response;

    // レスポンスのボディーに文字列コンテンツを挿入する (3.4.0 以降)
    $response = $response->withStringBody($icsString);

    // レスポンスのボディーに文字列コンテンツを挿入する (3.4.0 より前)
    $response->body($icsString);

    $response = $response->withType('ics');

    // 任意のダウンロードファイル名を指定できます
    $response = $response->withDownload('filename_for_download.ics');

    // レスポンスオブジェクトを返すとコントローラーがビューの描画を中止します
    return $response;
}

// 一つのヘッダーを追加/置換
$response = $response->withHeader('X-Extra', 'My header');

// 一度に複数ヘッダーを設定
$response = $response->withHeader('X-Extra', 'My header')
    ->withHeader('Location', 'http://example.com');

// 既存のヘッダーに値を追加
$response = $response->withAddedHeader('Set-Cookie', 'remember_me=1');

// 3.4.0 より前 - 一つのヘッダーを設定
$this->response->header('Location', 'http://example.com');

// ボディーの中に文字列をセット
$response = $response->withStringBody('My Body');

// json レスポンスにしたい場合
$response = $response->withType('application/json')
    ->withStringBody(json_encode(['Foo' => 'bar']));

$response = $response->withBody($stream);

// 3.4.0 より前でボディーを設定
$this->response->body('My Body');

// ファイルからのストリーム化
use Zend\Diactoros\Stream;

$stream = new Stream('/path/to/file', 'rb');
$response = $response->withBody($stream);

// コールバックからのストリーム化
use Cake\Http\CallbackStream;

// 画像の作成
$img = imagecreate(100, 100);
// ...

$stream = new CallbackStream(function () use ($img) {
    imagepng($img);
});
$response = $response->withBody($stream);

// 3.4.0 より前では、次のようにストリーミングレスポンスを作成することができます。
$file = fopen('/some/file.png', 'r');
$this->response->body(function () use ($file) {
    rewind($file);
    fpassthru($file);
    fclose($file);
});

$this->response = $this->response->withCharset('UTF-8');

// 3.4.0 より前
$this->response->charset('UTF-8');

public function index()
{
    // キャッシュの無効化
    $this->response = $this->response->withDisabledCache();

    // 3.4.0 より前
    $this->response->disableCache();
}

public function index()
{
    // キャッシュの有効化
    $this->response = $this->response->withCache('-1 minute', '+5 days');
}

use Cake\Http\Cookie\Cookie;

// コンストラクタの中の全ての引数
$cookie = new Cookie(
    'remember_me', // 名前
    1, // 値
    new DateTime('+1 year'), // 有効期限、適用する場合
    '/', // パス、該当する場合
    'example.com', // ドメイン名、適用する場合
    false, // secure のみ?
    true // http のみ ?
);

// ビルダーメソッドを使用
$cookie = (new Cookie('remember_me'))
    ->withValue('1')
    ->withExpiry(new DateTime('+1 year'))
    ->withPath('/')
    ->withDomain('example.com')
    ->withSecure(false)
    ->withHttpOnly(true);

use Cake\Http\Cookie\CookieCollection;

// 新規のコレクションを作成
$cookies = new CookieCollection([$cookie]);

// 既存のコレクションに追加
$cookies = $cookies->add($cookie);

// 名前でクッキーを削除
$cookies = $cookies->remove('remember_me');

$response = $this->response->withCookie($cookie);

// クッキーが存在するかどうかをチェック
$cookies->has('remember_me');

// コレクション内のクッキーの数を取得
count($cookies);

// クッキーインスタンスを取得
$cookie = $cookies->get('remember_me');

// 値の取得
$value = $cookie->getValue()

// JSON 値の中のデータにアクセス
$id = $cookie->read('User.id');

// 状態のチェック
$cookie->isHttpOnly();
$cookie->isSecure();