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

2019/02/04 2019/02/24

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」のページを表示する、という設定をしているものになります。
　

    $routes->connect('/', ['controller' => 'Pages', 'action' => 'display', 'home']);

1	$routes->connect('/', ['controller' => 'Pages', 'action' => 'display', '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」を使う
　
　

- CakePHP 3.x 4.x CakePHP3

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

Message コメントをキャンセル

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

: CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法

CakePHP3でデフォルトのソート条件を設定しつつ画面上でユーザがソート条件を選択したときもソート処理を実行させる方法を解説。ソート条件はページネーションの処理として実装。

: CakePHP4のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説

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

: CakePHP3のCakeDC/UsersのUserHelperでログアウトやreCAPTCHAをカスタマイズ

CakeDC謹製Usersプラグインの紹介。UserHelperを利用し、ログアウトのリンクや権限があるときのみ表示されるリンク、プロフィールページへのリンク、reCAPTCHAの設置方法などを解説。

: CakePHP3で生の SQLの実行はConnectionManagerを使う

CakePHP3で生の SQL文を実行する方法を解説。クリエビルダーを使う場合は TableRegistryを利用するが、SQLを実行する場合は ConnectionManagerを使う。プリペアードステートメントの使用方法も解説。

: CakePHP3にデイトピッカー jQuery UI DatePickerを実装する手順の解説

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

: CakePHP3のOGPはHTMLヘルパーの$this->Html->meta()を使って設定

CakePHP3でOGPを設定する方法を解説。metaタグを編集するHTMLヘルパーを利用してOGPのタグを編集する。また、エレメントとして分割することでメンテナンス性も向上させる。

: CakePHP3でPHPExcelを使ってエクセルファイルを生成、出力する方法

CakePHP3でPHPExcelを利用してエクセルを編集、出力するサンプルソース＋解説。PHPExcelのインストール方法の解説からファイル保存とダウンロードの方法なども解説。

: CakePHP3でCookieを保存、呼び出し、削除の操作・CakePHP3.7対応

CakePHP3.7でCookieを保存、取り出し、削除する方法を解説。CakePHP3でのCookieの取り扱いはバージョンごとに変更されるため、環境に合わせた方法を探す必要がある。

: CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力

CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。

: CakePHP3でWarning Error: SplFileInfo::openFile()エラーが発生した場合の対処方法

CakePHP3のキャッシュファイルのパーミッションエラー Error: SplFileInfo::openFile()が発生した場合の対応方法解説。app.phpにキャッシュファイルのパーミッション設定を行い、既存のファイルは削除。