CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法
2023/12/28
CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP4で、現在処理しているコントローラー名、アクション名を取得したい場合があるかと思います。
例えば、「CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()」で記事を書きましたが、ユーザ管理システムを構築する中で、特定のコントローラーの特定のアクションのページは、ユーザ認証をしていないユーザでもページを表示する、という設定をしたいときに、処理しているコントローラー名を取得する必要がでてきます。
そんな時の処理しているコントローラー名、アクション名を取得する方法を解説します。
ちなみに、CakePHP3用の記事は「CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法」に書いていますが、CakePHP4になり使えない記述方法もあるようですので、改めて、CakePHP4用の記事としてまとめました。
CakePHP4で現在のコントローラーを取得する方法
下記の記述方法で、現在のコントローラーの値を取得することができます。
1 2 3 4 5 6 7 |
$this->request->getParam('controller'); // 3.4.0 で追加 $this->name; // 以下は CakePHP4では使えなくなりました // $this->request->controller; // $this->request->params['controller']; // $this->request->param('controller'); |
CakePHP4で現在のアクションを取得する方法
下記の記述方法で、現在のアクションの値を取得することができます。
1 2 3 4 5 6 |
$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()」メソッドは、コントローラー名やアクション名の取得だけではなく、下記の様にしてプラグイン名やプレフィックスの値を取得することもできますので、覚えておくと役に立ちそうな気がします。
1 2 3 4 5 6 7 8 9 10 11 |
// 使用しているプラグイン名を取得 $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’)」です。
下記の記述形式で使用します。
1 |
$this->request->getAttribute('params'); |
取得結果は以下のようになります。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 |
// 下記の 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
CakePHP4の関連記事
CakePHP4でロギングスコープやログレベルを使用してログを出し分ける方法を解説CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法
Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法
CakePHP4で複数の引数(パラメータ)を付与してコマンドを実行する方法
CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説
CakePHP4 でコマンドプログラム(シェルプログラム)を作成する方法解説
Windows環境の XAMPPを利用して CakePHPの開発する際の注意点
CakePHP4の規約外のカラムをキーにアソシエーション(テーブル連結)する方法
CakePHPで Auto Incrementを外すと Duplicate entry '0' for keyのエラーが出るかも
CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因
その他の「CakePHP4」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法
CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。
-
-
CakePHP4で定数の設定と呼び出し方法の解説(defineとConfigure)
CakePHP4で定数を設定、使用する方法を解説。定数定義はdefineとConfigureを使用する方法を解説。また、bootstrap.phpに直接記述する方法と別のファイルにする方法を解説。
-
-
CakePHP3で値を入力直後にバリデーションする方法解説
CakePHP3でバリデーションの実行を保存する時から入力情報を受け取るときに変更する処理の解説。CakePHP3ではnewEntity()の処理でバリデートするため1行追加で対応可能。
-
-
CakePHP 2.3 bakeの超初心者向けフォロー講座
CakePHP 2.3 bakeの超初心者向けフォロー講座
-
-
Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法
CakePHP4のコマンド(シェル)に対して、環境変数を指定して実行する方法を解説。LinuxとWindows上のXAMPPとでは記述方法が異なるため、Windowsのsetコマンドについても詳細解説。
-
-
CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可
CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる!
-
-
CakePHP 2.3でOn Duplicate Key構文を実装
CakePHPで On Duplicate Key構文を Queryを利用して実装する方法をサンプルソース付きで解説します。
-
-
CakePHP3で生の SQLの実行はConnectionManagerを使う
CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。
-
-
CakePHP4でcontrollerで実行したバリデーションエラーをmodelのにマージする方法
CakePHP4でcontrollerで実行したバリデーションの結果をModelのバリデーション結果に追加するメソッド「setError()」「setErrors()」の使い方の解説。
-
-
CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定
CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。