CakePHP 2.x系 Viewでのコメントの記述方法など
2017/03/11
PHPと CakePHPの相違点
CakePHPの初心者である私が、CakePHPを始めてすぐのころに、フレームワークなしの PHPとの相違点などでハマった点などを書いてみたいと思います。
まず、CakePHPのコーディング規約は下記の URLにあります。
http://book.cakephp.org/2.0/ja/contributing/cakephp-coding-conventions.html
これは、規約と書かれていますので、基本的にこの規約に従って記述するものなのですが、この通りに書かないと動かないところと、この通りに書かなくても動くところとあります。
それがまた厄介な問題を引き起こすわけですが...
PHPタグの記述の仕方の相違点
まず、PHPタグ。
PHPタグ
上記のコーディング規約にも「常にショートタグ(<? ?>)の代わりに、ロングタグ(<?php ?>)を使ってください。」と書いてあります。
この規約は、この通りに書かないと動かない部分で、初めて CakePHPを使った際にはこれに気づかず、この問題だけで半日くらいつぶしてしまいました....
Viewファイルでのコメントの記述方法
Viewファイルの中でのコメントの表記
コメントについて
「.php」のファイルは、「#」「//」「/* ~ */」が使えます。
Viewの「.ctp」ファイルでは、「/* ~ */」しか使えません。
CakePHPのコメントは、フレームワークを使わない PHPと同じく「#」「//」「/* ~ */」が使えます。
でも、これは、あくまでも「.php」の拡張子がつくファイルの Controlloerや Modelのファイルに限定されます。
つまりは、Viewは「.ctp」となりますので、PHPと同じコメントを利用することができないということになり、Viewで利用できるコメントは、「/* ~ */」のタイプのみになります。
また、「<?php」の直後にコメントの記号を書く際は、「<?php /*」のように「<?php」の後ろにはスペースを入れる必要があります。「<?php/*」のようにつなげて書くとPHPのコードとして認識されなくなります。
なお、フレームワークを使わない PHPではつなげて書いてもしっかりコメントとして認識されます。この違いによって、この正しいコメントの表記方法に気づくまでに 1ヶ月以上かかってしまいました...
正しい表記:
<?php /* コメント文章 */?>
誤った表記
<?php/* コメント文章 */?>
PHPのコメントを利用して HTMLソースを表示させない方法
ちなみに、この Viewファイル上でもそうですし、一般的な HTMLのソース上でも、HTMLをコメントにしたいけど HTMLのコメントはソースが見えてしまうので...という場合は、PHPのコメント処理を使うことで HTMLを出力させない、という方法を採っていました。
HTMLファイルの場合は、PHPが処理される状況でないと使えない方法ではありますが、この方法を教えてもらったときは感動に近いオドロキがありましたね。
それ以降、かなり頻繁に使っている手法です。利用されている方も多いとは思いますが
具体的には
※HTMLのコメントタグの場合
<!–
<div>テストの項目</div>
–>
※PHPのコメントタグの場合
<?php /*
<div>テストの項目</div>
*/ ?>
このように記述することで HTMLがブラウザに表示されないだけではなく、そもそも出力がされなくなりますので、安心してコメントとして残しておくことができるようになります。
フレームワークを使わない PHPはなんと表現するか?
ところで、CakePHPと、フレームワークを使わない普通の PHPを区別して表現する場合、フレームワークを使わない普通の PHPの方は、なんと表現するのが一般的なのでしょう?
「フレームワークを使わない PHP」といったような表現をするしかないのでしょうか??
GoogleAdwords
GoogleAdwords
この記事が参考になったと思いましたらソーシャルメディアで共有していただけると嬉しいです!
関連記事
-
-
CakePHP 2.3 テーブルの項目を演算した結果を条件として抽出する方法
アソシエーション(連携)している先のテーブルの項目で演算をする場合の考え方と注意点をサンプルソースを用いて説明しています。分かってしまえば簡単です。
-
-
CakePHPのpostlinkで生成した削除リンクをクリックしても処理が実行されない対処法
CakePHP環境にてpostLinkで生成した削除のリンクをクリックしても処理が実行されず、JavaScriptでUncaught TypeErrorが発生。原因は同一IDを複数記述していることだった。
-
-
CakePHP4のcake cache clear_allでPermission deniedはパーミッションの変更が必要
CakePHP4でキャッシュをクリアするコマンドcake cache clear_allでPermission deniedのエラーが出るのはcakeにパーミッションが足りないとき。その対処方法を解説。
-
-
CakePHP3でモデルなしフォームからCSVをアップロードしレコードを更新する方法解説
CakePHP3でCSVファイルをアップロードしレコードを追加、更新する処理の作成方法の解説。モデルとは直接関連しないフォームからCSVファイルをアップロードするため汎用的に使用可能。
-
-
CakePHP4 でコマンドプログラム(シェルプログラム)を作成する方法解説
CakePHP4でバッチ処理を行うためのコマンド・シェルの実装方法について解説。bakeでテンプレートファイルを作成し、「execute()」に処理を記述する方法を解説。
-
-
CakePHP3チュートリアルで日付と時刻のDateTimeでエラーが出たときの対処方法
CakePHP3のブックマークチュートリアルには記載ミスもあり、そのまま動かない個所もある。CakePHP3では namespaceを使うようになったので、classを呼び出すときに¥を追加する必要が!
-
-
CakePHP3でページごとに読み込むJavaScript、CSSを変える処理の解説
CakePHP3でJavaScriptやCSSを編集する基本形から、それらやテンプレート(エレメント)を特定のテンプレートを読み込んだときのみ編集、実行するための方法、ブロック化について解説。
-
-
CakePHP3でassociatedを使って関連データをまとめて保存する方法(hasOne、hasMany、belongsTo)
CakePHP3で関連データをまとめて保存する方法。hasOne、hasMany、belongsTo等の関連データはassociatedを追加することでまとめて保存することができます。
-
-
CakePHP4、5のnewEmptyEntityで作成したオブジェクトは空なのか、確認してみた
CakePHPでレコードを新規登録をする際にnewEmptyEntity()を使って空のEntityを作成するが、これのempty、is_nullなどのでの判定結果がtrueかfalseか確認してみた。
-
-
CakePHP 2.3でファイルのアップロード処理を作る
CakePHPでプラグインを使わないファイルアップロード処理を解説します。簡単です。DBにファイルを格納する方法も。