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 コメントをキャンセル

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

: CakePHP 2.3　ID以外のカラムでアソシエーション（連携）をさせる場合

ID以外のカラムでアソシエーション（連携）させるための考え方とサンプルソースを用いての説明を行っています。

: CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法

CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。

: CakePHP 2.3　Search Pluginで検索処理　その１設置方法

CakePHPの検索プラグイン Search Pluginの設置方法と基本的な検索処理の解説です。

: CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールする

CakePHP4、CakePHP3でブラウザにキャッシュさせる設定の解説。CSS、JavaScript、画像をブラウザにキャッシュさせるのか、定期的にリロードする設定にするのかの設定が可能。

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

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

: getParam('action')で取得するアクション名は別関数に移動しても不変

CakePHP4系、5系では「getParam()」で処理中のアクション名を取得できる。そのアクションから別関数を呼び出してた関数でアクション名を調べたが同一の名称だった。

: CakePHP4の規約外のカラムをキーにアソシエーション（テーブル連結）する方法

CakePHPで規定外のカラム名のキーを指定してアソシエーション（テーブル連結）をする方法を解説。アソシエーション名によってはミスが発生しやすい点もあるので注意も必要。

: CakePHP4のCakeDC/Usersの Usersへの接続、バリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。CakePHP4で使う場合のUsersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。