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

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

2025/02/14 2025/03/23

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

　
CakePHP4系、CakePHP5系では、現在実行中のコントローラー名、アクション名を取得する際は下記のように取得します。
　

// 現在のコントローラー名を取得
$currentController = $this->request->getParam('controller');

// 現在のアクション名を取得
$currentAction     = $this->request->getParam('action');

// 現在のコントローラー名を取得

$currentController = $this->request->getParam('controller');

// 現在のアクション名を取得

$currentAction = $this->request->getParam('action');

　
CakePHP3系ではいろいろな取得方法がありましたが、CakePHP4系、CakePHP5系では上記の「getParam()」メソッドを使う方法に集約されました。
下記に、そのような解説記事を書いていますので、詳しく知りたい方は下記を読んでください。
　
「CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法」
「CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法」
　
また、上記の記事で紹介する「getParam()」メソッドを使って、コントローラー名やアクション名を取得する方法ですが、コントローラ内でも使えますし、ビュー（テンプレート）内でも同じ記述方法で取得することができます。
　
覚えておくと非常に便利に利用することができます。
　
　

アクションから別の関数に遷移したときの「`getParam('action')`」の結果は？

　
この記事では、それらの前提を踏まえたうえで
ブラウザで「A」というアクションにアクセスします。
その「A」の処理の中で、「B」という関数を呼び出して処理をするとします。
その「B」の中で「getParam('action')」を使用すると、その結果は「A」なのか「B」なのか、分かりますか？
という内容です。
　
正解は「A」です。
　
　
結論だけでいい方はここで終了でいいかと思います。
　
具体的な検証方法を説明しながら解説をしていきます。
　
　

「`getParam('action')`」でアクション名を取得する処理

　
「UsersController.php」の中に下記のアクションの処理があるとします。
　

public function view($id = null)
{
  $user = $this->Users->get($id, contain: []);
  $this->set(compact('user'));

  echo "view - action";
  echo "controller：" . $this->request->getParam('controller');
  echo "action：" . $this->request->getParam('action');

  $this->_view();
}

public function _view()
{
  echo "_view - action";
  echo "controller：" . $this->request->getParam('controller');
  echo "action：" . $this->request->getParam('action');
}

public function view($id = null)

{

$user = $this->Users->get($id, contain: []);

$this->set(compact('user'));

echo "view - action";

echo "controller：" . $this->request->getParam('controller');

echo "action：" . $this->request->getParam('action');

$this->_view();

}

public function _view()

{

echo "_view - action";

echo "controller：" . $this->request->getParam('controller');

echo "action：" . $this->request->getParam('action');

}

　
上記に対して「/users/view/1」を実行すると下記のように表示されます。
　

view - action
controller：Users
action：view
_view - action
controller：Users
action：view

view - action

controller：Users

action：view

_view - action

controller：Users

action：view

　
「view」アクションでも、「_view」アクションでも「action：view」が表示されます。
　
何をしているのか、理解できていれば当然と言えば当然の結果のような気もします。
　
そもそも、現在のコントローラー、アクションの情報を取得しているのではなく、リクエストの情報である「$this->request」の値を取得しているわけなので、「_view」に移動しても「$this->request」の値は変わらないってことですね．．．
　
　
ちなみに、逆に「_view」に移動したとき、その場所が「_view」であることを取得する処理があるのかどうか調べてみましたが、見つけることはできませんでした。
もしかするとないのかもしれません。
（「$this->request」の中を見てみましたが「_view」の情報はありませんでした。）
　
　
また、コンポーネント内では「$this->request」を取得することはできませんので、コンポーネント内で「$this->request->getParam('action')」でアクション名を取得することはできませんでした。
　
　

routes.phpでURLを変えても実際にアクセスしているアクションになる

　
ルーティングの設定を行う「/config/routes.php」ファイルに下記のように追記をしたとします。
　

$builder->connect('/sample/test01/*',  ['controller' => 'Users', 'action' => 'view']);

1	$builder->connect('/sample/test01/*', ['controller' => 'Users', 'action' => 'view']);

　
この場合、
　https://example.com/sample/test01/1
にアクセスした場合は
　https://example.com/user/view/1
にアクセスしていること同じとなり、同じ画面が表示されます。
　
では、この時、「getParam('controller')」「getParam('action')」で取得した値はどうなるでしょうか？
　
結果は、ルーティングをしていても実際にアクセスをしているコントローラー名、アクション名を取得します。
　

controller：Users
action：view

1 2	controller：Users action：view

　
これはちょっと予想外で、「controller：sample」「action：test01」が取得できるのかと思っていました。
　
ちなみに、「sample/test01/1」を取得したい場合は下記で取得することができます。
　

$this->request->getUri()->getPath();

1	$this->request->getUri()->getPath();

　
　
また、CakePHPでサーバ情報、環境情報を取得する方法については、改めて記事にしましたので、下記をご確認ください。
「CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介」
　
　

CakePHPのコマンドではアクション名は取得出来なさそう

　
ブラウザで実行する画面の処理の場合は、Webリクエストとして情報を取得できますので、「$this->request->getParam('action')」のような形で Requestオブジェクトから情報を取得することができます。
　
ですが、コマンドの場合は、Requestオブジェクトがないため、コントローラー名、アクション名を取得することはできなさそうです。
　
ですが、下記の処理によって、実行しているコマンド名を取得することはできます。
　

$this->name;
$this->getName();

1 2	$this->name; $this->getName();

　
ちなみに、上記の処理を Web画面で実行すると、コントローラー名が取得できます。
　
　
また、CakePHPでのコマンド作成については下記に記事を書いていますので、こちらも参考にしてください。
　
「CakePHP4 でコマンドプログラム（シェルプログラム）を作成する方法解説」
「CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説」
「CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法」
「Windows上のXAMPP環境のCakePHPのコマンド実行時に環境変数を指定する方法」
　
　

- CakePHP 3.x 4.x 5.x CakePHP5

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

Message コメントをキャンセル

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

: CakePHP4で複数の引数（パラメータ）を付与してコマンドを実行する方法

CakePHP4でコマンドを実行する際に引数（パラメータ）をコマンド内で受け取る処理について解説。複数個の引数にも対応する記述方法も解説。

: CakePHP4 のコマンドプログラムからコンポーネントを読み込む方法解説

CakePHP4でコマンドプログラムからコンポーネントを呼び出す方法を解説。コントローラーから呼び出すときと大差はないが、use句でコンポーネントを指定する事がポイント。

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP3でレコードを保存（追加、更新、Insert、Update）する複数の方法を紹介

CakePHP3でレコードを追加、更新（Insert、Update）する記述方法を解説。1件ずつ処理、全件をまとめて処理、条件に該当する複数件のレコードを処理方法をサンプルコードを用いて解説。

: CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説

CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。

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

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

: CakePHP4で公開側と管理側のデザインテンプレートを分ける方法・setLayout()

CakePHP4でデフォルトのレイアウトファイル「default.php」は管理側に使用し、これとは別のデザインを公開側のページに設定したい、を実装する方法を解説。

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

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

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

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

: MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認

MySQL＋CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。