CakePHP3で静的ページの作成は webrootか pagesを使う。トップページを参考に解説
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」のページを表示する、という設定をしているものになります。
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」を使う
CakePHP3の関連記事
CakePHP4のCSS、JavaScript、画像のブラウザへのキャッシュをコントロールするCakePHP3でレコードを保存(追加、更新、Insert、Update)する複数の方法を紹介
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でPHP Simple HTML DOM Parserを使ってスクレイピングする方法
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3の1対多での連携を中間テーブルを使った多対多の連携に変更するときの手順
CakePHP3でデフォルトのソート条件を設定してユーザの選択肢たソート条件を有効にする方法
CakePHP3で Ajaxを使う方法の解説。3.6以降対応。Successとthenの両方を解説。
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3にOGPをfetch、asignを利用してテンプレートごとに指定する方法を解説
その他の「CakePHP3」に関する記事一覧
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
URL短縮サービス「TTTオンライン(https://ttt.onl)」公開
URL短縮サービス「TTTオンライン(https://ttt.onl)」を公開。メールやSNSでは使いにくい長いURLを短いURLに変換するサービス。QRコードも。Google URL Shortenerが2019年3月にサービス終了。
-
-
CakePHP3でパンくずの指定は HTMLヘルパーを使って指定する方法を解説
CakePHP3でパンくずの指定方法の解説。2つのヘルパーがあるが簡単なHTMLヘルパーを使った方法を、実際の状況に合わせて3つのパターン(エレメント化、ブロック化)にして解説。
-
-
CakePHP4で「app_local.php」「.env」を利用して環境ごとの定数を振り分ける方法
CakePHP4で.env、app_local.phpに定数を定義してそれを呼び出す方法の解説。Gitでは管理せず本番環境と開発環境とで異なる定数を定義するためそれを利用する方法。
-
-
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。
-
-
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。
-
-
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。
-
-
CakePHP2、CakePHP3、CakePHP4、CakePHP5のバージョンを調べる 2つの方法
CakePHPのバージョンの調べ方2点を紹介。CakePHP3~CakePHP5は共通だが CakePHP2はフォルダ構成が異なるためコマンドのパスもオプションも異なる。
-
-
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。
-
-
CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法
CakePHPで「CakeDC/Users」などルーティングを行うプラグインを利用するときに、favicon.icoやapple-touch-icon-144-precomposed.pngがNotFoundエラーになることがある。その対処方法の解説。
-
-
CakePHPのFlashエラーは出るが入力項目ごとのメッセージが出ないエラーの原因
Bakeして自動生成した入力フォーム処理を元に少し処理を追加したら、入力エラーがあってもエラーメッセージが表示されなくなった。原因はリダイレクトの処理にあった。