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でデータを保存する save()で発生するエラーを確認する方法を解説

CakePHP3でデータ保存処理のログを取得する方法。save()では true、falseの戻り値しか取得できないが、saveOrFail()と try…catch文を使いエラーログ、エンティティを取得し、不具合の解析を行う。

: CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合

CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。

: CakePHP3でcomposerを利用してライブラリ・プラグインをインストールする方法

CakePHP3でcomposerを使ってパッケージ（ライブラリ、プラグイン）をインストールする方法の解説。PHPを使うのはCakePHP3が初めてというような方への使い方から解説。

: CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを

CakePHP3でルーティングの設定変更をしたけど反映されない！そんなときは慌てず騒がずキャッシュをクリアしよう！ルーティングの設定もキャッシュされることがあるらしい。

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

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

: CakePHP3のUpload Plugin 3.0をバリデーションなど実運用向けのカスタマイズ方法解説・その２

CakePHP3でファイル、画像をアップロードするプラグイン、upload plugin 3を導入する手順を解説した記事。3部作のその2でバリデーションなどの実用的なカスタマイズ方法を解説。