CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説

CakePHP3で静的ページの作成は webrootか pagesを使う

CakePHP3で静的ページの作成には 2つの方法がある

　
CakePHP3で静的なページを作成したい場合は 2つの方法があります。
　

• /webroot フォルダを活用する
• /src/Controller/PagesController.php を活用する

　
この記事では、上記の 2つの方法について解説します。
　
　

/webroot フォルダを活用する

　
まず、/webroot フォルダを活用する方法です。
　
/webroot フォルダを活用する方法はシンプルです。
　
/webroot フォルダは、ドキュメントルートの場所になっていて、ブラウザでアクセスできる領域になっています。
そのため、静的なファイルをこの場所に入れれば、ブラウザでアクセスすることができます。
　
通常は、画像ファイルや CSSファイル、JavaScriptファイルなどを設置する場所として活用されます。
　
同様に、静的な HTMLファイルを設置すればそのままブラウザでアクセスすることができます。
　
例えば、デフォルトでは下記のファイルが入っています。
/webroot/img/cake.power.gif
　
これにアクセスする場合の URLは下記のようになります。
http://example.com/img/cake.power.gif
　
ファイルを置くだけでアクセスできますので、非常に簡単です。
　

/src/Controller/PagesController.php を活用する

　
/webroot フォルダを活用する方法は、シンプルで分かりやすい方法です。
　
ですが、静的なページといえども HTMLファイルとして設置するのではなく、CakePHPの中に組み込みたい、と思う場合もあるでしょう。
　
例えば、CakePHPのテンプレート機能を活用して、ヘッダーやフッターなどを共通で使用するパーツ化している場合などは、まさに CakePHPに組み込みたいと思う場面でしょう。
　
そんなときは、/src/Controller/PagesController.php を活用します。
　
　
デフォルトの PagesController.php ファイルは「display」というアクションしか入っていないシンプルなファイルです。
　
ですが、このアクションでは、受け取った URLに基づいてテンプレートファイルを取得し画面を表示する、という機能を持っています。
　
これによって、静的なページは下記の URLのように表示する事ができるようになっています。
http://example.com/pages/******
　
　

デフォルトのトップページを参考にした解説

　
CakePHPをインストールして最初に表示されるデフォルトのトップページもこの pagesを利用して表示されています。
　
トップページですので
http://example.com/
という URLで表示されますが、pagesを使って
http://example.com/pages/home
という URLでアクセスしても同様のページを表示することができます。
　
また、このデフォルトのトップページのテンプレートファイルは「/src/Template/Pages/home.ctp」です。
　
　
同様に、「/src/Template/」フォルダの中に「****.ctp」というファイルを作成し、
http://example.com/pages/****
という URLでアクセスすると、設置した「****.ctp」ファイルの内容が表示されます。
　
　

ルーティング機能を使って URLとプログラム実体とを関連付ける

　
また、「http://example.com/」という URLでアクセスした際、「http://example.com/pages/home」のページを表示させるようにする設定は「ルーティング」設定と呼ばれるものです。
　
CakePHP3・Cookbook・ルーティング
https://book.cakephp.org/3.0/ja/development/routing.html
　
この記事では詳細な解説はしませんので、上記のオフィシャルサイトなどを確認してほしいのですが、ルーティングの設定は「/config/routes.php」ファイルで行います。
　
デフォルトの設定では下記の記述があると思いますが、これが、ドキュメントルート「/」にアクセスがあった場合は「http://example.com/pages/home」のページを表示する、という設定をしているものになります。
　

　
これによって、ドキュメントルートのページが表示される、ということになっています。
　
　

pagesに関する追加の解説

　
前項のデフォルトのトップページを参考に解説したように、pages機能を利用して、静的なページを表示することができるようになります。
　
ですが、pages機能を利用してアクセスする場合は
http://example.com/pages/****
という URLになってしまいます。
　
ですが、これを
http://example.com/****
という URLでアクセスしたい場合もあるかと思いますが、その時は、先に解説したように、ルーティング機能を使って、URLとそれで利用するプログラムとを関連付けて望んでいる URLを設定することができるようになります。
　
　
今回は「静的なページを作るためのページとして pagesを利用する」という趣旨で記事を書いています。
ですが、pagesの利用は静的ページ専用というわけではありません。
　
正確には、データベースに接続せず、Controllerや Modelでの処理が必要がないページを表示する場合に使うのが pages、という感じのものです。
　
そのため、完全に静的なページだけではなく、テンプレートファイル側に記載するだけで済むような簡単な処理であれば pages機能を用いたページを作成するといいでしょう。
　
　
最後になってしまいましたが、ルーティングの設定は、基本的にはファイルの記載を変更すればすぐに反映されますが、環境によってはキャッシュされる場合もあるようです。
ルーティングの設定をしたけども、思ったような動きにならない、というときはキャッシュをクリアしてみるといいのではないか、と思います。
下記の記事を参考にしてください。
CakePHP3のルーティング（routes.php）の変更が反映されない時はキャッシュのクリアを
CakePHP3、CakePHP4のキャッシュをクリアする方法「bin/cake cache clear_all」を使う
　
　

CakePHP3の関連記事