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にデイトピッカー jQuery UI DatePickerを実装する手順の解説

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

: CakePHP3のアソシエーションでJOINのタイプのLEFT、INNERを切り替えながら使う方法

CakePHP3でテーブルのアソシエーションしたデータの取得をコントローラー側でINNERかLEFTを指定する方法を解説。TableファイルにINNERで指定していてもController側で変更ができる。

: CakePHP3のCakeDC/Usersの画面、メール本文テンプレートのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。ユーザ新規登録の流れを紹介しつつテンプレートファイルがどこにあるか、設定情報ファイルがどこにあるか、を説明しつつカスタマイズの方法を解説します。

: CakePHP5系でDeprecatedを回避しfindListでキーと値のカラムを指定して取得する方法

CakePHP4のfindListでキーと値のカラムを指定してテーブルにアクセスする方法がCakePHP5では「Deprecated（非推奨）」となった。推奨の記述方法を解説。

: CakePHP3のCakeDC/Usersでログインユーザの所有レコードのみ更新、削除する権限管理の設定方法

CakePHP3のユーザ管理、ログイン認証プラグイン「CakeDC/Users」の権限管理を行う方法やアクセスできるコントローラー、アクションを設定、所有権を持つレコードのみ更新できる設定方法を解説。

: Windows環境の XAMPPを利用して CakePHPの開発する際の注意点

WindowsベースにXAMPPで環境を構築しCakePHP4を利用したWebシステムを構築する際は、大文字と小文字の違いを意識する必要がある。LinuxベースのWebサーバに移動させたときに不具合で動作しないこともある。