エス技研

WordPress、CakePHP、PHP、baserCMSなどの Web系システムを中心に情報を提供します!


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」といったような表現をするしかないのでしょうか??

 - CakePHP 3.x 4.x

GoogleAdwords

GoogleAdwords

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

Message

メールアドレスが公開されることはありません。 が付いている欄は必須項目です

下記の空欄を埋めてください。 * Time limit is exhausted. Please reload CAPTCHA.

日本語が含まれない投稿は無視されますのでご注意ください。(スパム対策)

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

  関連記事

CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得
CakePHP3でDocumentRootやwebroot、imgフォルダのURLやドメイン、パスを取得

URLやドメイン、フォルダへのパスの取得は、ビューではUrlHelperを使い、コントローラーではRouterクラスを使います。第2引数の指定でURLを取得することも可能。

CakePHP 2.3 Search Pluginで検索処理 その6ORDER、sortソートの機能

CakePHPの検索プラグイン Search Pluginの検索処理の中で order、ソートについての解説です。

CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可
CakePHP3のプラグイン「CakeDC/Users」を日本語化・翻訳ファイルもダウンロード可

CakePHP3のユーザ管理、ログイン認証プラグインである「CakeDC/Users」のメッセージを日本語にする手順の解説とともに、日本語の翻訳ファイルを提供。ファイルを設置すれば日本語になる!

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

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

CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法
CakePHP4で現在処理しているコントローラー名、アクション名を取得する方法

CakePHP3で現在処理しているコントローラー名、アクション名を取得する方法を解説。複数の方法があるが、getParam()メソッドを使う方法が汎用性があって便利かも。

CakePHPで favicon.icoやapple-touch-icon-144-precomposed.pngが could not be foundのエラーが出るときの対処方法
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エラーになることがある。その対処方法の解説。

CakePHP3のインストールでURL rewriting......のエラーが!その解決方法解説
CakePHP3のインストールでURL rewriting……のエラーが!その解決方法解説

CakePHP3をインストールしたら URL rewriting is not properly configured.のエラーが。原因は.htaccessが有効になっていないこと。httpd.confに設定を追加すればOK。

CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法
CakePHP3で /Layout/defult.ctpにある titleタグ、h1タグを編集する方法

CakePHP3でtitleタグ、h1タグのテキストをデフォルトから変更する方法を解説。テンプレートファイルに「$this->assign()」でテキストを指定して「/Layout/defult.ctp」で受け取る。

CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法
CakePHP3のデバッグキット(DebugKit)を強制的に有効、無効に変更する方法

CakePHP3に付属しているデバッグのためのツール、デバッグキットを強制的に有効化、無効化する方法を解説。初期設定では開発環境としてありそうなドメインの場合のみ有効になるように設定されている。

CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説
CakePHP3のCakeDC/Usersのバリデーションのカスタマイズ方法解説

CakeDC謹製Usersプラグインの紹介。Usersのカスタマイズとして入力項目のバリデーションの変更を、プラグインのファイルは触らずオーバーライドにより実装する方法を解説する。