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

2023/12/25 2023/12/28

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

　
CakePHP4で、現在処理しているコントローラー名、アクション名を取得したい場合があるかと思います。
　
例えば、「CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()」で記事を書きましたが、ユーザ管理システムを構築する中で、特定のコントローラーの特定のアクションのページは、ユーザ認証をしていないユーザでもページを表示する、という設定をしたいときに、処理しているコントローラー名を取得する必要がでてきます。
　
そんな時の処理しているコントローラー名、アクション名を取得する方法を解説します。
　
ちなみに、CakePHP3用の記事は「CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法」に書いていますが、CakePHP4になり使えない記述方法もあるようですので、改めて、CakePHP4用の記事としてまとめました。
　
　

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

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

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

//  以下は CakePHP4では使えなくなりました
//  $this->request->controller;
//  $this->request->params['controller'];
//  $this->request->param('controller');

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

$this->name;

// 以下は CakePHP4では使えなくなりました

// $this->request->controller;

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

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

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

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

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

//  以下は CakePHP4では使えなくなりました
//  $this->request->action;
//  $this->request->params['action'];
//  $this->request->param('action');

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

// 以下は CakePHP4では使えなくなりました

// $this->request->action;

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

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

CakePHP4 では getParam()メソッドを使う

　
コントローラー名、アクション名を取得する方法は、CakePHP3ではなんでこんなにいっぱいあるの？というくらいいろいろありましたが、CakePHP4では「getParam()メソッド」を使うように改められています。
　
コントローラー名は「$this->name;」でも取得可能ですが、同じような記述でアクション名を取得する方法がないため、この記述方法を使う場面は少ないかと思います。
　
　
また、「getParam()」メソッドは、コントローラー名やアクション名の取得だけではなく、下記の様にしてプラグイン名やプレフィックスの値を取得することもできますので、覚えておくと役に立ちそうな気がします。
　

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

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

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

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

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

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

// prefix名を取得

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

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

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

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

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

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

getAttribute(‘params’) でコントローラー名やアクション名などをまとめて取得

　
前項で「getParam()」を使用するとコントローラー名やアクション名などを取得できると説明しましたが、それらをまとめて取得する方法も用意されています。
　
それが「getAttribute(‘params’)」です。
　
下記の記述形式で使用します。

$this->request->getAttribute('params');

1	$this->request->getAttribute('params');

　
　
取得結果は以下のようになります。

// 下記の URLがあったとして
http://example.com/controller/action/aaa/bbb/ccc?xxx=000&yyy=111&zzz=222

// 下記を実行すると
print_r($this->request->getAttribute('params'));

// 下記のように出力されます
Array
(
    [controller] => controller
    [action] => action
    [pass] => Array
        (
            [0] => aaa
            [1] => bbb
            [2] => ccc
        )

    [plugin] => 
    [_matchedRoute] => /{controller}/{action}/*
    [?] => Array
        (
            [xxx] => 000
            [yyy] => 111
            [zzz] => 222
        )

    [_ext] => 
)

// 下記の URLがあったとして

http://example.com/controller/action/aaa/bbb/ccc?xxx=000&yyy=111&zzz=222

// 下記を実行すると

print_r($this->request->getAttribute('params'));

// 下記のように出力されます

Array

(

[controller] => controller

[action] => action

[pass] => Array

(

[0] => aaa

[1] => bbb

[2] => ccc

)

[plugin] =>

[_matchedRoute] => /{controller}/{action}/*

[?] => Array

(

[xxx] => 000

[yyy] => 111

[zzz] => 222

)

[_ext] =>

)

　
「getAttribute(‘params’)」は、コントローラー名やアクション名をまとめて取得できますので、あらかじめまとめて取得しておき、使用するときに「$getAttributeArray["controller"]の形式でその都度取り出す、といった使い方をしたいときに便利でしょう。
　
　

参考サイトは CakePHP4の Cookbook

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

- CakePHP 3.x 4.x CakePHP4

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

Message コメントをキャンセル

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

: CakePHP3でアソシエーション先のカラムでデータをソートして取得したい

アソシエーション先のテーブルのカラムをキーにソートをしたデータを取得したい！ときの記述方法を解説。「orderAsc()」ではなく「contain()」の中にSort条件を記述する。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

CakePHP3にjQuery UIのDatePickerを実装する手順を説明。併せて、デイトピッカーを設置に関連するCakePHP3の解説と、テーマを変更したり、表記を変更するカスタマイズする方法なども紹介。

: CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用

CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。

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

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

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。

: CakePHP3でQRコードを作成、表示するライブラリ「cakePHP-QR-Code-Helper」

CakePHPでQRコードを生成するライブラリ「cakePHP-QR-Code-Helper」の紹介。GDライブラリのインストールも必要ないHelperとして提供されているため、ファイルを設置すればすぐに使用可能。

: CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応

CakePHP3のユーザ管理プラグイン Usersは、ユーザ登録、メール認証、ログイン認証、ユーザ管理、権限管理、reCAPTCHAなど会員制のサイトを簡単に実現可能。その導入方法、カスタマイズ方法を解説。

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

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