CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

2018/06/30 2023/12/28

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法

　
CakePHP3で、現在処理しているコントローラー名、アクション名を取得したい場合があるかと思います。
　
例えば、「CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定」で記事を書きましたが、ユーザ管理システムを構築する中で、特定のコントローラーの特定のアクションのページは、ユーザ認証をしていないユーザでもページを表示する、という設定をしたいときに、処理しているコントローラー名を取得する必要がでてきます。
　
そんな時の処理しているコントローラー名、アクション名を取得する方法を解説します。　
　
※この記事は CakePHP3用の内容になります。CakePHP4用の記事は「CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法」に書いていますので、こちらも合わせて確認してください。
　

CakePHP3で現在のコントローラーを取得する方法

　
下記の記述方法で、現在のコントローラーの値を取得することができます。
　

$this->request->controller;
$this->request->params['controller'];
$this->request->param('controller');
$this->request->getParam('controller');    // 3.4.0 で追加
$this->name;

$this->request->controller;

$this->request->params['controller'];

$this->request->param('controller');

$this->request->getParam('controller'); // 3.4.0 で追加

$this->name;

CakePHP3で現在のアクションを取得する方法

　
下記の記述方法で、現在のアクションの値を取得することができます。
　

$this->request->action;
$this->request->params['action'];
$this->request->param('action');
$this->request->getParam('action');    // 3.4.0 で追加

$this->request->action;

$this->request->params['action'];

$this->request->param('action');

$this->request->getParam('action'); // 3.4.0 で追加

CakePHP 3.4以降なら getParam()メソッドが便利かも

　
コントローラー名、アクション名を取得する方法は、なんでこんなにいっぱいあるの？というくらいいろいろありますが、どれを使うかは好みで選べばいいのではないか、と思います。
　
あえて言うなら、「$this->name;」は、コントローラー名の取得の対になるアクション名の取得方法がありませんので、ちょっと残念かな、と思う程度です。
　
　
また、下記の「getParam()」メソッドを利用する方法は、CakePHP 3.4.0で追加された方法ですので、3.4.0より前のバージョンを使う予定がないのであれば、この「getParam()」メソッドを利用する方法が無難なのではないか、と思います。
　

$this->request->getParam('controller');
$this->request->getParam('action');

1 2	$this->request->getParam('controller'); $this->request->getParam('action');

　
　
また、「getParam()」メソッドは、コントローラー名やアクション名の取得だけではなく、下記の様にしてプラグイン名やプレフィックスの値を取得することもできますので、覚えておくと役に立ちそうな気がします。
　

// 使用しているプラグイン名を取得
$this->request->getParam("plugin");

// prefix名を取得
$this->request->getParam("prefix");

// パラメーター（引数）を取得
$this->request->getParam("pass");

// 使用しているプラグイン名を取得

$this->request->getParam("plugin");

// prefix名を取得

$this->request->getParam("prefix");

// パラメーター（引数）を取得

$this->request->getParam("pass");

　
3番目のパラメーターの取得に関しては、
http://example.com/controller/action/aaa/bbb/ccc
のような URLの場合、
Array ( [0] => aaa [1] => bbb [2] => ccc )
として取得できます。
　
　

参考サイトは CakePHP3の Cookbook

　
最後になりましたが、ここで解説をした内容は、下記のオフィシャルの Cookbookを参考にしています。
　
リクエストとレスポンスオブジェクト
https://book.cakephp.org/3.0/ja/controllers/request-response.html

- CakePHP 3.x 4.x 5.x

最後までお読みいただきましてありがとうございます。
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです！

Message コメントをキャンセル

※入力いただいたコメントは管理者の承認後に掲載されます。

: CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い

CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

: CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた

CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。

: CakePHP 2.3　Search Pluginで検索処理　その７queryを使って日付の範囲検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で queryを使って日付の範囲検索の方法です。

: CakePHP 2.3で PDFを作成する方法を調査「mpdf」「TCPDF」「FPDF」

CakePHPで PDFを編集、出力するには「mpdf」「TCPDF」「FPDF」といったプラグインがあり、使い勝手を比較検討しました。TCPDFが一番良さそうでした。

: CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法

CakePHPのバージョンの調べ方2点を紹介。CakePHP3～CakePHP5は共通だが CakePHP2はフォルダ構成が異なるためコマンドのパスもオプションも異なる。

: CakePHP5系でDeprecatedを回避しfindListでキーと値のカラムを指定して取得する方法

CakePHP4のfindListでキーと値のカラムを指定してテーブルにアクセスする方法がCakePHP5では「Deprecated（非推奨）」となった。推奨の記述方法を解説。

: CakePHP 2.3でファイルをアップロード・その2　ファイル名を乱数で設定

CakePHPのアップロードするファイル名を乱数で変更しセキュリティを高める方法を解説。

: CakePHP3で保存前にバリデーション結果を取得する2つの方法

CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。