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

2018/06/30 2019/03/23

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

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

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 2.x　3.x

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

Message コメントをキャンセル

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

: CakePHP3のキャッシュをクリアする方法「bin/cake cache clear_all」を使う

CakePHP3では処理を高速化する手法の一つとしてキャッシュを利用している。しかし、その情報は元の情報を更新しても反映されない場合がある。そんなときはキャッシュを削除する必要がある。

: CakePHP 2.3でOn Duplicate Key構文を実装

CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。

: CakePHP3でassociatedを使って関連データをまとめて保存する方法（hasOne、hasMany、belongsTo）

CakePHP3で関連データをまとめて保存する方法。hasOne、hasMany、belongsTo等の関連データはassociatedを追加することでまとめて保存することができます。

: CakePHP 2.3　Search Pluginで検索処理　その５入力項目に複数項目入力した場合の AND検索、OR検索

CakePHPの検索プラグイン Search Pluginの検索処理の中で複数項目を入力した場合の AND検索、OR検索についての解説です。

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

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

: CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２

ファイルのアップロード機能の自作サンプルコードとその解説のその２。アップロード機能に関連するファイルの更新や削除の処理や画像、フォルダのパスの指定方法などを含めて解説。

: CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的なページを設置する場合の方法（webrootとpagesとを活用する方法）を解説。pagesの解説はデフォルトのトップページがどう表示されているかを参考に解説。ルーティングの機能も。