コントローラー¶

AppController¶

冒頭で述べたように、 AppController クラスはアプリケーションのすべてのコントローラーの 親クラスとなります。 AppController はそれ自身、CakePHP のコアライブラリーに含まれる Cake\Controller\Controller クラスを継承しています。 AppController は src/Controller/AppController.php に次のように定義されます。

namespace App\Controller;

use Cake\Controller\Controller;

class AppController extends Controller
{
}

AppController で作られたクラス変数とメソッドはそれを継承するすべてのコントローラーで 有効となります。コンポーネント (あとで学びます) は多くのコントローラー (必ずしもすべてのコントローラーとは限りません) で使われるコードをまとめるのに使われます。

アプリケーション中のすべてのコントローラーで使われるコンポーネントを読み込むために AppController を使うことができます。CakePHP はこうした用途のために、 Controller のコンストラクターの最後で呼び出される initialize() メソッドを提供します。

namespace App\Controller;

use Cake\Controller\Controller;

class AppController extends Controller
{
    public function initialize(): void
    {
        // CSRF コンポーネントを常に有効にします。
        $this->loadComponent('Csrf');
    }
}

リクエストの流れ¶

CakePHP アプリケーションへのリクエストが生じると、 CakePHP の Cake\Routing\Router と Cake\Routing\Dispatcher クラスは正しいコントローラーを見つけて、 インスタンスを作成するために ルートを接続 を使用します。 リクエストデータはリクエストオブジェトの中にカプセル化されています。 CakePHP はすべての重要なリクエスト情報を $this->request プロパティーの中に格納します。 CakePHP のリクエストオブジェクトについてのより詳しい情報は リクエスト の章を参照してください。

コントローラーのアクション¶

コントローラーのアクションは、リクエストパラメーターを、要求を送ってきたブラウザーやユーザーに対する レスポンスに変換する役割があります。CakePHP は規約に則ることで、このプロセスを自動化し、 本来であればあなたが書かなければならなかったコードを省いてくれます。

CakePHP は規約に従って、アクション名のビューを描画します。オンラインベーカリーの例に戻りますが、 RecipesController は view() ・ share() ・ search() アクションを持つかもしれません。 このコントローラーは src/Controller/RecipesController.php にあり、 次のようなコードになっています。

// src/Controller/RecipesController.php

class RecipesController extends AppController
{
    public function view($id)
    {
        // アクションの処理をここで行います。
    }

    public function share($customerId, $recipeId)
    {
        // アクションの処理をここで行います。
    }

    public function search($query)
    {
        // アクションの処理をここで行います。
    }
}

これらのアクションのテンプレートファイルは templates/Recipes/view.php 、 templates/Recipes/share.php 、そして templates/Recipes/search.php になります。 規約に従ったビューのファイル名は、アクション名を小文字にしてアンダースコアーでつないだものです。

通常、コントローラーのアクションは View クラスがビュー層の描画で使う コンテキストを作るために set() を使います。 CakePHP の規約に従うと、手動でビューを描画したり生成したりする必要はありません。 代わりに、コントローラーのアクションが完了すると、CakePHP はビューの描画と送信をします。

もし何らかの理由でデフォルトの動作をスキップさせたければ、完全にレスポンスを作成して、 アクションから Cake\Http\Response オブジェクトを返すこともできます。

アプリケーションでコントローラーを効率的に使うために、CakePHP のコントローラーから提供される いくつかのコアな属性やメソッドを説明しましょう。

ビューとの相互作用¶

コントローラーはビューといくつかの方法でお互いに作用しあっています。最初に、コントローラーは Controller::set() を使って、ビューにデータを渡すことができます。 コントローラーからどのビュークラスを使うか、どのビューを描画すべきか、を決めることもできます。

// まずコントローラーからデータを渡します

$this->set('color', 'pink');

// すると、ビューでそのデータを利用できます
?>

You have selected <?= h($color) ?> icing for the cake.

$data = [
    'color' => 'pink',
    'type' => 'sugar',
    'base_price' => 23.95
];

// $color・$type および $base_price を作成し
// ビューで使用できるようになります

$this->set($data);

$this->viewBuilder()
    ->addHelper('MyCustom')
    ->setTheme('Modern')
    ->setClassName('Modern.Admin');

namespace App\Controller;

class RecipesController extends AppController
{
// ...
    public function search()
    {
        // templates/Recipes/search.php のビューを描画します
        return $this->render();
    }
// ...
}

// templates/element/ajaxreturn.php のエレメントを描画します
$this->render('/element/ajaxreturn');

namespace App\Controller;

class PostsController extends AppController
{
    public function my_action()
    {
        $this->render('custom_file');
    }
}

namespace App\Controller;

class PostsController extends AppController
{
    public function myAction()
    {
        $this->render('Users.UserDetails/custom_file');
    }
}

コンテンツタイプのネゴシエーション¶

Cake\Controller\Controller::viewClasses()¶

コントローラは、サポートするビュークラスの一覧を定義することができます。 コントローラのアクションが完了すると、 CakePHP はビューリストを使用して content-typeのネゴシエーション（コンテントタイプの取り決め）を実行します。 これにより、アプリケーションは同じコントローラアクションを再利用してHTML ビューをレンダリングしたり JSONやXML のレスポンスをレンダリングしたりすることができるようになります。 コントローラにサポートするビュークラスのリストを定義するには、 viewClasses() メソッドを使用します。:

namespace App\Controller;

use Cake\View\JsonView;
use Cake\View\XmlView;

class PostsController extends AppController
{
    public function viewClasses()
    {
        return [JsonView::class, XmlView::class];
    }
}

アプリケーションの View クラスは、リクエストの Accept ヘッダーやルーティング拡張機能に基づいて、 他のビューを選択できない場合に自動的にフォールバックとして使用されます。 もしアプリケーションが異なるレスポンスフォーマットに対して異なるロジックを実行する必要がある場合は、 $this->request->is() を使用して、必要な条件ロジックを構築することができます。

コンテンツタイプネゴシエーションのフォールバック¶

リクエストのコンテントタイプの設定にマッチする View がない場合、 CakePHP はベースとなる View クラスを使用します。 もし、content-typeのネゴシエーションを要求したい場合は、 406ステータスコードを設定する NegotiationRequiredView を使用します。:

public function viewClasses()
{
    // Acceptヘッダーのネゴシエーションを要求するか、406のレスポンスを返します。
    return [JsonView::class, NegotiationRequiredView::class];
}

TYPE_MATCH_ALL のコンテンツタイプ値を使用して、独自のフォールバックビューロジックを構築することができます:

namespace App\View;

use Cake\View\View;

class CustomFallbackView extends View
{
    public static function contentType(): string
    {
        return static::TYPE_MATCH_ALL;
    }

}

match-allビューは、content-typeのネゴシエーションが試みられた 後で のみ適用されることを覚えておくことが重要です。

他のページへのリダイレクト¶

Cake\Controller\Controller::redirect(string|array $url, integer $status)¶

もっともよく使う、フロー制御のメソッドは Controller::redirect() です。 このメソッドは最初の引数に、CakePHP の相対 URL を受け取ります。 ユーザーが正常に注文を出した時、レシート画面にリダイレクトさせたいかもしれません。

public function place_order()
{
    // 注文終了のためのロジック
    if ($success) {
        return $this->redirect(
            ['controller' => 'Orders', 'action' => 'thanks']
        );
    }

    return $this->redirect(
        ['controller' => 'Orders', 'action' => 'confirm']
    );
}

このメソッドは適切なヘッダーが設定されたレスポンスのインスタンスを返します。 ビューの描画を抑制し、ディスパッチャーが実際にリダイレクトを行えるようにするために このレスポンスのインスタンスを return すべきです。

$url 引数に相対 URL または絶対 URL を指定することもできます。

return $this->redirect('/orders/thanks');

return $this->redirect('http://www.example.com');

アクションにデータを渡すこともできます。

return $this->redirect(['action' => 'edit', $id]);

Controller::redirect() の第二引数では、リダイレクトに伴う HTTP ステータスコードを定義することができます。リダイレクトの性質によっては、 301 (moved parmanently) または 303 (see other) を使ったほうが良いでしょう。

リファラーのページにリダイレクトする必要があれば、次のようにできます。

return $this->redirect($this->referer());

クエリー文字列とハッシュを使う例は次のようになります。

return $this->redirect([
    'controller' => 'Orders',
    'action' => 'confirm',
    $order->id,
    '?' => [
        'product' => 'pizza',
        'quantity' => 5
    ],
    '#' => 'top'
]);

生成される URL はこのようになります。

http://www.example.com/orders/confirm?product=pizza&quantity=5#top

// delete アクションから、更新後の一覧ページを描画することができます。
$this->setAction('index');

追加のモデル読み込み¶

Cake\Controller\Controller::loadModel(string $modelClass, string $type)¶

loadModel 関数は、コントローラーのデフォルト以外のモデルを使う必要がある時に便利です。

// コントローラーのメソッドの中で。
$this->loadModel('Articles');
$recentArticles = $this->Articles->find('all', [
    'limit' => 5,
    'order' => 'Articles.created DESC'
]);

もしも組み込み ORM 以外のテーブルプロバイダーを使いたければ、 ファクトリーメソッドに接続することで、そのテーブルシステムを CakePHP のコントローラーに紐づけることができます。

// コントローラーのメソッドの中で。
$this->modelFactory(
    'ElasticIndex',
    ['ElasticIndexes', 'factory']
);

テーブルファクトリーを登録した後は、インスタンスを読み出すために loadModel を使うことができます。

// コントローラーのメソッドの中で。
$this->loadModel('Locations', 'ElasticIndex');

モデルのページネーション¶

Cake\Controller\Controller::paginate()¶

このメソッドはモデルから取得した結果をページ分けするために使われます。 ページサイズやモデルの検索条件などを指定できます。 paginate() のより詳しい使い方は ページネーション の章を参照してください。

$paginate 属性は paginate() がどうふるまうかを簡単にカスタマイズする方法を提供します。

class ArticlesController extends AppController
{
    public $paginate = [
        'Articles' => [
            'conditions' => ['published' => 1]
        ]
    ];
}

コンポーネント読み込みの設定¶

Cake\Controller\Controller::loadComponent($name, $config = [])¶

コントローラーの initialize() メソッドの中で、読み込みたいコンポーネントや、 その設定データを定義することができます。

public function initialize(): void
{
    parent::initialize();
    $this->loadComponent('Csrf');
    $this->loadComponent('Comments', Configure::read('Comments'));
}

property Cake\Controller\Controller::$components¶

コントローラーの $components プロパティーでは、コンポーネントの設定ができます。 設定されたコンポーネントとそれに依存するコンポーネントは CakePHP によって構築されます。 より詳しい情報は コンポーネントの設定 の章を参照してください。先に述べたように、 $components プロパティーはコントローラーの各親クラスで定義されたプロパティーとマージされます。

ヘルパー読み込みの設定¶

property Cake\Controller\Controller::$helpers¶

追加で利用する MVC クラスをどうやって CakePHP のコントローラーに伝えるのかを見てみましょう。

class RecipesController extends AppController
{
    public $helpers = ['Form'];
}

これらの変数はそれぞれ、継承された値とマージされます。したがって、たとえば FormHelper を、あるいは AppController で宣言されている他のクラスを、 再度宣言する必要はありません。

リクエストライフサイクルコールバック¶

CakePHP のコントローラーはリクエストのライフサイクル周りにロジックを挿入できる いくつかのイベント／コールバックを呼び出します。

//use Cake\Event\EventInterface;
public function beforeFilter(EventInterface $event)
{
    parent::beforeFilter($event);
}

Controller Middleware¶

Cake\Controller\Controller::middleware($middleware, array $options = [])¶

Middleware can be defined globally, in a routing scope or within a controller. To define middleware for a specific controller use the middleware() method from your controller's initialize() method:

public function initialize(): void
{
    parent::initialize();

    $this->middleware(function ($request, $handler) {
        // Do middleware logic.

        // Make sure you return a response or call handle()
        return $handler->handle($request);
    });
}

Middleware defined by a controller will be called before beforeFilter() and action methods are called.

コントローラーのより詳細¶