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 Search Pluginで検索処理 その2表示件数を動的に変える方法
CakePHPの検索プラグイン Search Pluginの検索処理の中で動的に表示件数を変える方法です。
-
-
CakePHP3にデザインテンプレートBootstrapを導入する方法・friendsofcake/bootstrap-ui使用
CakePHP3にプラグイン「friendsofcake/bootstrap-ui」、デザインテンプレート「Bootstrap」を設置する手順を解説。Bootstrapの簡単な使い方やデフォルトのデザインとの混在方法なども解説。
-
-
CakePHP3にWYSIWYGエディタのCKEditor4を設置、カスタマイズ方法を解説
WYSIWYGエディタであるCKEditor4をCDNを利用して簡単にCakePHP3に導入する方法とカスタマイズする方法を解説。CakePHP3にはページごとの振り分けを行うブロック化を利用する。
-
-
CakePHP3、CakePHP4、CakePHP5のバージョンを指定してインストールする詳細な手順を解説
CakePHP3のバージョンを指定してインストールする方法を詳細解説。CakePHP3のインストールはComposerを使うため設定もほぼ自動で完了。データベースの接続情報を記載すればアプリ開発のベースが整う。
-
-
CakePHP3でテーブルにカラム(項目)を追加したときに変更するポイントのまとめ
CakePHP3でシステム開発をする際、途中でカラムを追加した場合に何を変更すればいいかを確認。カラムを追加する前後で Bakeした結果を比較し、変更になった点をリストアップした。
-
-
CakePHP3でシェルを作成しコマンドラインから実行・CakePHP2との違い
CakePHP3のシェルスクリプトを作成し、コマンドラインから実行する方法を解説。複数単語をつなげる場合の対応方法がCakePHP2より制限が厳しくなったのでCakePHP3の命名規則の確認が必要だ。
-
-
CakePHP3でユーザ定義の定数、変数を設定し、読み込む方法解説
CakePHP3で定数や共通で使う変数をまとめて設定し、プログラム内で読み込む方法を、bootstrap.phpに直接記述する方法と定数ファイルを分ける方法の3つの方法で解説。
-
-
CakePHP4のクリエビルダーを使用してOR条件をAND条件でつなぐSQL文を作る方法
CakePHP4のクリエビルダーを使って複数のOR条件をANDでつなぐSQL文を作成する方法を解説。OR条件を記述したwhere句を2つつなげて記述する。
-
-
CakePHP 2.3で saveの便利な使い方・サンプルソース付き
CakePHPのレコードを保存、更新する際に使う Saveを詳細解説します。
-
-
CakePHP 2.3 Model、Controllerの見たい変数の中身をログ出力
CakePHPの Modelや Controllerの変数の中身をログとして出力して見る方法を提供します。