CakePHP4、5で$_SERVERと同じようにURIを取得する「getUri()」の紹介

2025/02/15 2025/03/23

CakePHP4系、5系でRequestオブジェクトでは取得できないURI情報を取得する方法

　
「getParam('action')で取得するアクション名は別関数に移動しても不変」
上記の記事で、CakePHP4系、CakePHP5系で実行しているコントローラー、アクション名を取得する方法について解説しました。
　
「$this->request->getParam('controller')」「$this->request->getParam('action')」は、Requestオブジェクトの情報を取得していますので、アクセスした後のプログラム内での処理によって変化する情報ではありません。
　
ルーティングの設定によって、アクセスする URLと実行するコントローラー、アクションが異なっていても、実際にアクセスするコントローラー、アクション名が取得されます。
　
というのが、記事の概要です。
　
　
この記事では、「じゃぁ、URL（URI）の方の情報を取得するときはどうするの？」という解説を行います。
　
　

CakePHP4系、CakePHP5系で URI情報は関数「getUri()」で取得する

　
CakePHP4系、CakePHP5系では「getUri()」という関数が用意されています。
この「getUri()」を使用することでアクセスの URI情報を取得することができます。
　

// 実行関数
$this->request->getUri();

// 実行結果
Laminas\Diactoros\Uri Object
(
    [allowedSchemes:protected] => Array
        (
            [http] => 80
            [https] => 443
        )

    [scheme:Laminas\Diactoros\Uri:private] => http
    [userInfo:Laminas\Diactoros\Uri:private] => 
    [host:Laminas\Diactoros\Uri:private] => example.com
    [port:Laminas\Diactoros\Uri:private] => 80
    [path:Laminas\Diactoros\Uri:private] => /sample/test01/1
    [query:Laminas\Diactoros\Uri:private] => aaa=111
    [fragment:Laminas\Diactoros\Uri:private] => 
    [uriString:Laminas\Diactoros\Uri:private] => 
)

// 実行関数

$this->request->getUri();

// 実行結果

Laminas\Diactoros\Uri Object

(

[allowedSchemes:protected] => Array

(

[http] => 80

[https] => 443

)

[scheme:Laminas\Diactoros\Uri:private] => http

[userInfo:Laminas\Diactoros\Uri:private] =>

[host:Laminas\Diactoros\Uri:private] => example.com

[port:Laminas\Diactoros\Uri:private] => 80

[path:Laminas\Diactoros\Uri:private] => /sample/test01/1

[query:Laminas\Diactoros\Uri:private] => aaa=111

[fragment:Laminas\Diactoros\Uri:private] =>

[uriString:Laminas\Diactoros\Uri:private] =>

)

URI情報を個別に取得する関数も用意されている

　
上記のように「getUri()」を実行すると、URI情報がまとめて取得できます。
CakePHPでは、これに加え、「getUri()」によって取得した情報を個別に取得する関数も用意されています。
　

// アクセスの URL
// http://example.com/sample/test01/1?aaa=111

// 「/sample/test01/1」を取得
$this->request->getUri()->getPath();

// 「80」を取得
$this->request->getUri()->getPort();

// 「aaa=111」を取得
$this->request->getUri()->getQuery();

// 「example.com」を取得
$this->request->getUri()->getHost();

// 「http」を取得
$this->request->getUri()->getScheme();

// アクセスの URL

// http://example.com/sample/test01/1?aaa=111

// 「/sample/test01/1」を取得

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

// 「80」を取得

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

// 「aaa=111」を取得

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

// 「example.com」を取得

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

// 「http」を取得

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

PHPにはURI情報を取得する「`$_SERVER`」が用意されている

　
そもそもの話ですが、PHPにはサーバ情報、環境情報は「$_SERVER」に入っていますので、下記のように PHPの標準処理を利用して URIの情報を取得することもできます。
　

// アクセスの URL
// http://example.com/sample/test01/1?aaa=111

// 「/users/menu/1?aaa=111」を取得（「getPath()」とは値が異なる）
$_SERVER["REQUEST_URI"];

// 「80」を取得
$_SERVER["SERVER_PORT"];

// 「aaa=111」を取得
$_SERVER["REDIRECT_QUERY_STRING"];

// 「example.com」を取得
$_SERVER["SERVER_NAME"];

// 「http」を取得
$_SERVER["REQUEST_SCHEME"];

// アクセスの URL

// http://example.com/sample/test01/1?aaa=111

// 「/users/menu/1?aaa=111」を取得（「getPath()」とは値が異なる）

$_SERVER["REQUEST_URI"];

// 「80」を取得

$_SERVER["SERVER_PORT"];

// 「aaa=111」を取得

$_SERVER["REDIRECT_QUERY_STRING"];

// 「example.com」を取得

$_SERVER["SERVER_NAME"];

// 「http」を取得

$_SERVER["REQUEST_SCHEME"];

　
「getPath()」など、取得できる情報が少し異なる場合もありますが、取得できる情報は「$_SERVER」の方が多様ですので、CakePHP独自の「getPath()」を使用する必要があるのか、という疑問はありますね。
　
PHPオフィシャル　$_SERVER
https://www.php.net/manual/ja/reserved.variables.server.php
　
　

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

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

Message コメントをキャンセル

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

: CakePHP3のCakeDC/Users、Authでログインなしでもアクセスを許可する設定

CakePHP3の Authコンポーネントや CakeDC/Usersプラグインなどを利用したユーザ管理・認証システムにおいて、ログインしていなくても見ることができるページの設定方法を解説。

: CakePHP 2.3 主キー（ID）以外のキーで更新方法 updateAll

主キー（ID）以外のカラムをキーとして更新する方法、updateAllの使い方をサンプルを用いて解説します。

: CakePHP3のHtmlHelperのLink設定のまとめ。mailto、URL、Root／Homeのリンクなども

CakePHP3でHtmlHelperを使ってリンクの設定をする方法のまとめ。基本形からURLを指定、class、id、targetを指定、mailtoのリンク、画像をアンカーに、JavaScriptのダイアログなどの解説。

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

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

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

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

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

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

: CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因

Bakeして自動生成した入力フォーム処理を元に少し処理を追加したら、入力エラーがあってもエラーメッセージが表示されなくなった。原因はリダイレクトの処理にあった。

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

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