CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法
2019/03/02
CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngを設定する
CakePHPで linkタグを設定。HtmlHelper::metaの利用方法も解説
CakePHPで構築したシステムで、「Error: [MissingControllerException] Controller class ImagesController could not be found.」というメッセージとともに「favicon.ico」や「apple-touch-icon-72-precomposed.png」や「apple-touch-icon-144-precomposed.png」などのファイルが存在しない、というエラーが出力される場合があります。
その時は、「/app/View/Layouts/default.ctp」に下記の記述を追加しましょう。
HTMLで記述する場合は、以下の通りとなります。
1 2 3 |
<link rel="shortcut icon" href="/images/favicon.ico" /> <link rel="apple-touch-icon-precomposed" href="/images/apple-touch-icon-144-precomposed.png" sizes="144x144" /> |
上記と同様の記述を CakePHPの HtmlHelperを利用して記述する場合は、以下の通りとなります。
1 2 3 4 5 |
<?php echo $this->Html->meta('icon', '/images/favicon.ico'); echo $this->Html->meta('apple-touch-icon-144-precomposed.png', '/images/apple-touch-icon-144-precomposed.png', array("size"=>"144x144")); ?> |
いずれの方法を使うにしても、「<head> ... </head>」の間のどこかに記述します。
この記述を追記する際に注意するポイントは、相対パスで記述するのではなく、フルパスで記述する(「/」から書き始める)、ということです。
CakePHPで linkタグ、HtmlHelper::metaを利用する方法についての解説
先に説明した対処方法について、以降で詳しい解説をしていきます。
favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーを出力した経緯
CakePHPに、会員管理プラグイン「CakeDC/Users」を導入したサイトの開発を行っています。
その際、下記の様なエラーがエラーログに出力されていることに気づきました。
1 2 3 4 5 6 7 8 9 |
2018-04-01 01:01:01 Error: [MissingControllerException] Controller class ImagesController could not be found. Exception Attributes: array ( 'class' => 'ImagesController', 'plugin' => NULL, ) Request URL: /admin/images/apple-touch-icon-144-precomposed.png Stack Trace: #0 /var/www/html/example/app/webroot/index.php(110): Dispatcher->dispatch(Object(CakeRequest), Object(CakeResponse)) #1 {main} |
1 2 3 4 5 6 7 8 9 |
2018-04-01 02:02:02 Error: [MissingControllerException] Controller class ImagesController could not be found. Exception Attributes: array ( 'class' => 'ImagesController', 'plugin' => NULL, ) Request URL: /admin/images/favicon.ico Stack Trace: #0 /var/www/html/example/app/webroot/index.php(110): Dispatcher->dispatch(Object(CakeRequest), Object(CakeResponse)) #1 {main} |
エラーログの内容を解説すると以下の通りです。
「ImagesController」が見つかりませんでした。
エラー発生のリクエスト URLは「/admin/images/apple-touch-icon-144-precomposed.png」「/admin/images/favicon.ico」です。
また、エラーが発生した個所は「/var/www/html/example/app/webroot/index.php」の 110行目です。
という内容です。
ちなみに、「/example/app/webroot/index.php」の 110行目付近のソースコードは以下の通りです。
106 107 108 109 110 |
$Dispatcher = new Dispatcher(); $Dispatcher->dispatch( new CakeRequest(), new CakeResponse() ); |
これは、CakePHPの Bakeで作成されるデフォルトの状態と変わらないものです。
また、index.phpは 上記の 110行目で終了しています。
そのため、110行目は、ファイルの最後の「);」と言ことになるのですが、これでは何が原因でエラーになっているのかが分かりません。
「CakeDC/Users」を使った会員管理システムである
また、このシステムでは、最初にも書きましたが「CakeDC/Users」を使ってログインが必要なシステムになっています。
一般ユーザ(Member)と、管理者ユーザ(admin)とに画面が分かれています。
そして、「一般ユーザ(Member)」の URLは下記のものになりますが
https://example.com/login
「管理者ユーザ(admin)」の URLは、下記の様に自動的に「admin」が付与されるようにルーティングされています。
https://example.com/admin/login
この「admin」が付与されるルーティングは「CakeDC/Users」をインストールする過程で設定します。
「CakeDC/Users」に関しては下記に記事を書いていますので、参考にしてください。
CakePHP3のユーザ管理・ログイン認証プラグインCakeDC/Usersのインストール解説・3.6以降対応
今回の不具合の原因は、この「CakeDC/Users」のログインに関連したルーティングの処理で発生しているのです。
テンプレートファイルや画像、CSS、JSのリンクもルーティングされる
「CakeDC/Users」などでルーティング処理がされる際、「/app/View/Layouts/default.ctp」を始めとするテンプレートファイルのファイル名や、テンプレートにある画像ファイル、CSSファイル、JSファイルへのリンクもルーティングの処理がされるのです。
より具体的には、下記のように「favicon.ico」までのパスを上記のように相対パスで記述していたとします。
1 |
<link rel="shortcut icon" href="images/favicon.ico" /> |
この場合、「一般ユーザ(Member)」でアクセスしたときは下記になりますが、
「/images/favicon.ico
」
「管理者ユーザ(admin)」でアクセスしたときは、ルーティングの設定があるため、下記の様に「/admin」が追加されてしまうのです。
「/admin/images/favicon.ico
」
「一般ユーザ(Member)」と「管理者ユーザ(admin)」とで全く画面のイメージが違うために、「/images/」と「/admin/images/」を別々に用意している場合はこれでも問題ないのだと思います。
ですが、今回構築していたシステムは、基本的な画面イメージはどちらもほぼ同じで、登録、更新の機能が違うという程度でしたので、管理者ユーザ側の画像ファイルも含めて、すべて「/images」に入っている状態でした。
そのために、「管理者ユーザ(admin)」でアクセスをすると、画像のフォルダも「/admin/images/」にルーティングされることで、「ファイルがない」というエラーにつながるという結果になっていました。
ルーティング処理されるパスの問題点の解消方法
先にも書きましたが、このルーティングされる際に画像などのパスもルーティングされてしまう問題点の解消方法は、画像フォルダのパスの指定を、相対パスではなく、「/」から始まるフルパスで記述しておくことです。
ちなみに、もう一つ私がはまった点としては、テンプレートとして使用しているファイルが一つだけではなかった、という点です。
標準的には、テンプレートファイルは「/app/View/Layout/default.ctp」になりますので、このファイルのパスを変更します。
ですが、私がメンテナンスをしていたシステムには、「default.ctp」のほかに管理画面用の「admin.ctp」がありまして、こちらのパスも相対パスで記述されていました。
そのため、「default.ctp」だけを変更して動作確認しても、エラーが出続けるという状況になっていました。
その他、「login.ctp」「error.ctp」といったテンプレートを作っている場合もあるでしょうから、その他のテンプレートも確認してみることをおススメします。
favicon.icoによって could not be foundのエラーが出るときの対処方法のまとめ
「favicon.ico」のリンクを指定する「linkタグ」の記述は、以下のようになります。
リンクを記述する際のポイントは、「/」からフルパスで書き始めることです。
1 |
<link rel="shortcut icon" href="/images/favicon.ico" /> |
上記のように、CakePHPでも直接 HTMLの linkタグを記述しても全く問題はありませんが、CakePHPの HtmlHelperを使って書くこともできます。
HtmlHelperを使って書くとちょっとカッコよく見せることもできる!という感じです。
HtmlHelper::meta()の使い方
HtmlHelperを使って linkタグを記述する場合は「HtmlHelper::meta()」を使用します。
詳細は、下記の Cookbookにもあります。
CakePHP 2.x Cookbook HtmlHelper
https://book.cakephp.org/2.0/ja/core-libraries/helpers/html.html
HtmlHelper::meta()は、下記の形式で使用します。
1 |
HtmlHelper::meta(string $type, string $url = null, array $options = array()) |
一番簡単な記述方法としては、以下のようになります。
1つ目のパラメーターにファイルのタイプを指定し、2つ目のパラメーターにファイルのパスを指定します。
1 |
echo $this->Html->meta('icon', '/images/favicon.ico'); |
処理されて出力される linkタグは以下のようになります。
1 |
<link href="/images/favicon.ico" type="image/x-icon" rel="icon" /><link href="/images/favicon.ico" type="image/x-icon" rel="shortcut icon" /> |
また、タイプやオプションの指定内容によって少しずつ編集される内容が変わってきます。
それを実験した内容が下記になりますので参考にしてみてください。
1 2 3 4 5 6 |
echo $this->Html->meta('favicon.ico', '/images/favicon.ico'); // ↑このように記述すると、 // ↓こう編集されます <link href="http://example.com/images/favicon.ico" type="application/rss+xml" rel="alternate" title="favicon.ico" /> |
1 2 3 4 5 6 |
echo $this->Html->meta('favicon.ico', '/images/favicon.ico', array("type"=>"icon")); // ↑このように記述すると、 // ↓こう編集されます <link href="/images/favicon.ico" type="image/x-icon" rel="icon" /><link href="/images/favicon.ico" type="image/x-icon" rel="shortcut icon" /> |
1 2 3 4 5 6 |
echo $this->Html->meta('apple-touch-icon-144-precomposed.png', '/images/apple-touch-icon-144-precomposed.png', array("size"=>"144x144")); // ↑このように記述すると、 // ↓こう編集されます <link href="http://example.com/images/apple-touch-icon-144-precomposed.png" type="application/rss+xml" rel="alternate" title="apple-touch-icon-144-precomposed.png" size="144x144" /> |
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
MySQL、CakePHP 2.3で「tinyint(1)」の Boolean型の動作を再確認
MySQL+CakePHPの環境で「tinyint(1)」を利用する際の動作を検証。「tinyint(1)」の Boolean型について CakePHPでは自動処理が実施されていることを確認しました。
-
-
CakePHP3、CakePHP4でユーザ定義の定数、変数を設定し、読み込む方法解説
CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。
-
-
CakePHP3のInsert On Duplicate Key Update(upsert)構文を解説・バルク処理も
CakePHP3で Insert … On Duplicate Key Update構文(upsert)を実行する方法を解説。バルク処理の方法も用意されているため大量処理の場合も対応可能。
-
-
cakephp3 カスタムバリデーションを簡易的に実装する方法
CakePHP3の独自のバリデーションをテーブルクラス内に簡単に記述する方法を解説。他のテーブルクラスでは使えないが、記述する量は少なく実装できるため、他で使わない処理を書くのには便利。
-
-
CakePHP3で環境変数を設定して本番環境と開発環境を分けて処理をする場合
CakePHP3で開発環境と本番環境とで違う設定ファイルを読み込ませて環境ごとに定数を切り替える方法を解説。Apacheのhttpd.confに環境変数を設定し、それを読み込み判別する。
-
-
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。
-
-
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。
-
-
CakePHP 2.x系 Viewでのコメントの記述方法など
CakePHPにおいて View、ctpファイルでコメントを記述する方法を解説。
-
-
CakePHP 2.3でファイルのアップロード処理を作る
CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。
-
-
CakePHP 2.3 Search Pluginで検索処理 その5入力項目に複数項目入力した場合の AND検索、OR検索
CakePHPの検索プラグイン Search Pluginの検索処理の中で複数項目を入力した場合の AND検索、OR検索についての解説です。