Flash

class Cake\View\Helper\FlashHelper(View $view, array $config = [])

FlashHelperは、 FlashComponent によって $_SESSION にセットされたフラッシュメッセージを描画する方法を提供しています。 FlashComponent および FlashHelper はフラッシュメッセージを描画するためのエレメントを使用します。 フラッシュエレメントは src/Template/Element/Flash ディレクトリー以下に存在します。 CakePHP の App テンプレートには、 success.ctpdefault.ctperror.ctp の 3つのフラッシュエレメントが付属しています。

フラッシュメッセージの描画

フラッシュメッセージを描画するためには、テンプレートファイルの中で FlashHelper の render() メソッドを使用します。

<?= $this->Flash->render() ?>

デフォルトでは、CakePHP は、フラッシュメッセージのためにセッション中の “flash” キーを使用します。 しかし、 FlashComponent の中でフラッシュメッセージを 設定した時にキーを指定した場合、そのキーを指定して描画します。

<?= $this->Flash->render('other') ?>

FlashComponent の中で設定したオプションを上書きすることもできます。

// コントローラーの中で
$this->Flash->set('The user has been saved.', [
    'element' => 'success'
]);

// テンプレートファイルの中で、 success.ctp の代わりに great_success.ctp を使用
<?= $this->Flash->render('flash', [
    'element' => 'great_success'
]);

注釈

フラッシュメッセージの独自テンプレートを作成する場合、全てのユーザーデータを適切に HTML エンコードしてください。CakePHP は、フラッシュメッセージのパラメーターをエスケープしません。

バージョン 3.1 で追加: FlashComponent はメッセージをスタックしています。 複数のフラッシュメッセージをセットした場合、 render() を呼び出すと、それぞれのメッセージが 設定された順番でそれぞれのエレメントの中で描画されます。

使用できる配列オプションについてもっと知りたい場合は、 FlashComponent セクションをご覧ください。

ルーティングのプレフィックスとフラッシュメッセージ

バージョン 3.0.1 で追加.

設定したルーティングのプレフィックスがある場合、フラッシュエレメントを src/Template/{Prefix}/Element/Flash に置きます。 これにより、アプリケーションの各部分に特定のメッセージレイアウトを設定できます。 例えば、フロントエンドと管理者のセクションで異なるレイアウトを使用する場合です。

フラッシュメッセージとテーマ

FlashHelper は、メッセージを描画するために標準のエレメントを使用し、指定したテーマに従います。 そのため、テーマが src/Template/Element/Flash/error.ctp ファイルを持つ場合、 エレメントやビューと同様に使用されます。