CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

2017/03/12 2017/10/28

DocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

CakePHP3では UrlHelperで取得するように変わった

　
「CakePHP3でファイルのアップロード処理を自作・解説付き・その１」「CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２」でファイルのアップロード処理を作りましたが、その際、アップロードした画像を表示するための画像のパスの取得方法についても調べましたので解説します。
　
　<img src=”【ここ部分のパス】/upload.jpg”>
　
また、取得方法は、CakePHP2では HtmlHelperを使用していましたが、CakePHP3では UrlHelperを使用するように変更になっていますので、CakePHP2の時の記述方法では動かなくなっています。
　
　

UrlHelperを使ってサイトの URLを取得する方法

　
UrlHelperを使ってフォルダのパス、URLを取得する方法を解説します。
UrlHelperを使うこの方法は、ビューでのみ使用可能です。
　

// ドキュメントルートを取得
echo $this->Url->build("/");
　
// URLとして取得
echo $this->Url->build("/",true);

// ドキュメントルートを取得

echo $this->Url->build("/");

// URLとして取得

echo $this->Url->build("/",true);

　
基本形がこの形です。
第 1引数に「”/”」を指定すると、ドキュメントルート（webroot）フォルダのパスが取得できます。
　
第 2引数に「true」を指定すると、URLが取得できます。
　例：http://example.com/
　

// image フォルダのパスを取得
echo $this->Url->build("/images");
　
// image フォルダのパスを取得（ディレクトリセパレーター付き）
echo $this->Url->build("/images/");

// image フォルダのパスを取得

echo $this->Url->build("/images");

// image フォルダのパスを取得（ディレクトリセパレーター付き）

echo $this->Url->build("/images/");

　
上記のように引数を指定することで、ドキュメントルート内の「images」フォルダのパスが取得できます。
また、引数内にディレクトリセパレーター「/」も含めると、ディレクトリセパレーターが付いたパスが取得できます。
　
　

// 現在の URLを取得
echo $this->Url->build();
　
// 現在の URLを取得
echo $this->Url->build("",true);

// 現在の URLを取得

echo $this->Url->build();

// 現在の URLを取得

echo $this->Url->build("",true);

　
第 1引数を与えない場合は、表示しているパス、URLを取得することができます。
第 1引数の記述方法は「""」「null」のいずれでも OKです。
　
　

CakePHP3 ビギナーズガイド: 最新のPHPフレームワークをマスターせよ！ PRIMERシリーズ (libroブックス)

Routerクラスを使ってサイトの URLを取得する方法

　
Routerクラスを使ってサイトの URLを取得する方法の解説です。
Routerクラスは、ビュー以外のコントロールやモデルなどで使用できます。
　
　
Routerクラスを使用する際は、まず最初に use句で使用を宣言します。

use Cake\Routing\Router;

1	use Cake\Routing\Router;

// ドキュメントルートを取得
$path = Router::url("/");
　
// URLとして取得
$path = Router::url("/",true);

// ドキュメントルートを取得

$path = Router::url("/");

// URLとして取得

$path = Router::url("/",true);

　
パスの取得方法は、上記の通りです。
UrlHelperも「Router::url()」クラスで取得する方法も、最終的には同じメソッドが呼び出されますので、引数の仕様は同じで、第 2引数に「true」を指定すると URLを取得することができます。
　
　

リクエストオブジェクトを利用してパスを取得する方法

　
今回の記事の趣旨とはやや違いますが、リクエストオブジェクトを使ってパスを取得する方法もあります。
リクエストオブジェクトからパスを取得する方法は、ビュー、コントローラーを問わず取得することができます。
　
ただし、取得できるのはリクエストに応じたパスですので、リクエストの URLに関係ないパは取得できませんし、URLも取得できません。
　
　
リクエストの URLが「/subdir/articles/edit/1?page=1」だとすると、それぞれ下記の情報を取得することができます。
　

// 「/subdir/articles/edit/1?page=1」を取得する
echo $this->request->here();
　
// 「/subdir/」を取得する
echo $this->request->webroot;
　
// 「/subdir」を取得する（ディレクトリセパレーターがない）
echo $this->request->base;

// 「/subdir/articles/edit/1?page=1」を取得する

echo $this->request->here();

// 「/subdir/」を取得する

echo $this->request->webroot;

// 「/subdir」を取得する（ディレクトリセパレーターがない）

echo $this->request->base;

　
　
この方法を利用して、下記の記述で webroot内にある「images」フォルダへのパスを生成することもできます。
　

$this->request->webroot . "images/"；

1	$this->request->webroot . "images/"；

　
　
CakePHP3.4.0以降は下記の様に記述するようです。

// 「/subdir/」を取得する
echo $this->request->getAttribute("webroot");
　
// 「/subdir」を取得する（ディレクトリセパレーターがない）
echo $this->request->getAttribute("base");

// 「/subdir/」を取得する

echo $this->request->getAttribute("webroot");

// 「/subdir」を取得する（ディレクトリセパレーターがない）

echo $this->request->getAttribute("base");

　
　
リクエストオブジェクトを利用したパス情報の取得方法は、下記のオフィシャルサイトに詳細があります。
https://book.cakephp.org/3.0/ja/controllers/request-response.html#id6
　
　

CakePHP3でのURLやドメイン、フォルダへのパスの取得のまとめ

　
CakePHP3では、URLやドメイン、フォルダへのパスの取得方法が変更になり、UrlHelperを使う方法、Routerクラスを使う方法になりました。
　
画像を表示するためのパスを取得する場合など、ビューの中で使う場合が多いと思いますので、UrlHelperを使う機会の方が多いと思いますが、この方法で取得が可能になります。
　
　
今回の解説は、表示の際に使用するパスの取得ですが、対して、ファイルアップロードの処理やエクセルファイルのダウンロード処理などを構築する際には、フォルダの絶対パスが必要になります。
そのようなフォルダのパスを表す定数についての記事は下記に書いていますので、あわせて参考にしてください。
　
　
　

- CakePHP 2.x　3.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3ログファイルへの出力・$this->log()、独自ログへの出力方法の解説

コントロール、モデルの変数の中身を見るときはログに出力する方法が有効です。$this->log()を利用すると変数だけじゃなく、連想配列、オブジェクトも簡単にログ出力ができます。

: CakePHP3でComposerでインストールできないプラグイン、外部ライブラリを vendorに入れて手動で読み込む方法

CakePHP3にComposerからインストールできないプラグインやライブラリなどを利用する方法、vendorにファイルを設置し、composer.jsonを更新し、それを呼び出す方法を詳細に解説。

: CakePHP3でkeywords、DescriptionをHTMLヘルパーを使って設定する

CakePHP3のkeywordsとdescriptionを設定する方法の解説。CakePHP3にはmetaタグを編集するHTMLヘルパーが用意されているためそれを利用すればOK！ポイントはブロック化を有効にすること。

: CakePHP3で保存前にバリデーション結果を取得する2つの方法

CakePHP3でデータベースに値を保存する前にバリデーションを行い、その結果によって処理を振り分ける方法について解説。「$topic->errors()」と「$topic->hasErrors()」の2つの方法がある。