CakePHP3でDocumentRootやtmp、webroot、logsなどのフォルダへのパスの定数

DocumentRoot、tmp、webroot、logsなどのフォルダへのパスの定数

　
CakePHP3でファイルのアップロードや csvファイルの生成、エクセルファイルの生成などファイルを扱う処理を構築する際、そのファイルを保存する時などにフォルダを指定する必要があります。
　
ですが、フォルダをどうやって指定すればいいのか、その情報を見つけることができずに困っていましたが、それを発見しましたのでご紹介します。
　
　
ちなみに、CakePHP3でエクセルファイルを生成する方法や、ファイルをアップロードする方法は下記に記事を書いていますので、あわせて参考にしてみてください。
　CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法
　CakePHP3でファイルのアップロード処理を自作・解説付き・その１
　CakePHP3で画像・ファイルのアップロード処理を自作・解説付き・その２
　
また、ここで解説している定数は、サーバ上のパスが設定されています。
対して、プログラムが実行されているドメインや URLを取得したい場合は、下記に記事を書きましたので、こちらを参考にしてください。
　CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
　
　

CakePHP3の webroot、tmp、logs、config、cache、srcなどのパスの定数

　
CakePHP3でよく使う webroot、tmp、logs、config、cache、srcなどのパスの定数は、下記の「paths.php」ファイルに書いてあります。
　
/config/paths.php
　
　
具体的に「paths.php」ファイルに指定されている定数は以下の通りです。
　

ROOT

CakePHP3のアプリケーションを構築しているルートフォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\
　

APP_DIR

CakePHP3のアプリケーションの作成するソースファイルが入っているフォルダの名称です。この定数はパスではなくフォルダ名です。
具体的には、下記の値になります。
　src
　

APP

CakePHP3のアプリケーションの作成するソースファイルが入っているフォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/src/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\src\
　

CONFIG

設定情報が入っている「config」フォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/config/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\config\
　

WWW_ROOT

imgフォルダや CSSフォルダなどがある「webroot」フォルダのパスです。
画像ファイルのアップロード処理などを作る場合によく使うことになる定数ですね。
「webroot」のフォルダのパスになります。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/webroot/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\webroot\
　

TESTS

テストスクリプトが生成される「tests」フォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/tests/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\tests\
　

TMP

一時ファイルを保存するフォルダ「tmp」フォルダのパスです。
エクセルファイルのダウンロード処理や、公開しないファイルのアップロード先などに指定するときに使うことになるパスですね。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/tmp/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\tmp\
　

LOGS

ログファイルが保存される「logs」フォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/logs/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\logs\
　

CACHE

キャッシュファイルが保存される「cache」フォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/tmp/cache/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\tmp\cache\
　

CAKE_CORE_INCLUDE_PATH

CakePHP3のコアファイル「cakephp」フォルダへの絶対パスです。
下記の「CORE_PATH」との違いは、「CAKE_CORE_INCLUDE_PATH」には DS（ディレクトリセパレーター）がなく、「CORE_PATH」には DSがあります。
また、コンポーザーを使ってインストールする際はこの値が使われます。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/vendor/cakephp/cakephp
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\vendor\cakephp\cakephp
　

CORE_PATH

CakePHP3のコアファイル「cakephp」フォルダへのパスです。
「CAKE_CORE_INCLUDE_PATH」に DS（ディレクトリセパレーター）を追加したものになります。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/vendor/cakephp/cakephp/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\vendor\cakephp\cakephp\
　

CAKE

「CORE_PATH」の中の「src」フォルダのパスです。
具体的には、下記のパスになります。
（CakePHP3のフォルダ）/vendor/cakephp/cakephp/src/
　例：Windowsの XAMPPの場合：C:\xampp\htdocs\vendor\cakephp\cakephp\src\
　
　

realpath()関数

　
CakePHP3には、「realpath()」関数というフォルダのパスを取得するすることができる関数があります。
　
この「realpath()」関数は、先に説明した各フォルダを示す定数と合わせて使うことで、フォルダのパスを取得するときに威力を発揮してくれます。
　
　
例えば、定数「CAKE」のパスに対して、相対パス「../../cakephp」を追加して下記の様に記述すると、
realpath(CAKE . "../../cakephp/")
「（CakePHP3のフォルダ）/vendor/cakephp/cakephp」という「CAKE」からの相対パスになるフォルダの絶対パスを返してくれる、という関数です。
　
　
なので、定数として指定してあるフォルダの場所から相対パスを組み合わせて、その上で「realpath()」関数を使う方法で、おおよそ必要となるフォルダの場所は簡単に取得ができるようになります。
　
　
また、「realpath()」関数を通すと、パスの最後の DS（ディレクトリセパレーター）がなくなります。
　
そのため、本来の使い方ではないと思いますが、定数の最後に DS（ディレクトリセパレーター）があるのかないのか分からない場合は、とりあえず「realpath()」関数を通すと DSがなくなりますので、最後の DSを外す関数として使うのもありなんじゃないでしょうか。
　
　

CakePHP3の関連記事