PHP

PHPのEOMを駆使してヒアドキュメントでスマートにコーディング

  /

PHPプログラミングを学ぶ中で、複数行にわたる長い文字列やコードを効率的に管理する方法を知ることは、コーディングの品質と生産性を向上させる大切なステップです。
その中でも、ヒアドキュメント（Heredoc）とEOM（End Of Document）は、多くの場面で利用される便利な手法として知られています。

この記事では、初心者エンジニアでも理解しやすい形で、ヒアドキュメントとEOMの基本から応用までを解説します。また、これらを活用して、HTMLやCSSなどの複数行コードを簡単にPHP変数に代入し、出力する具体例を紹介します。

Contents

ヒアドキュメントとは？

ヒアドキュメント（Heredoc）は、PHPで提供されている構文の一つで、複数行にわたる文字列を一つの変数に簡単に代入することができます。通常、HTMLやCSSのような複数行コードを扱う際に使用され、特に以下のようなメリットがあります。

  • コードの可読性が向上する。
  • HTMLやCSS、JavaScriptなどのコードをそのまま変数に代入可能。
  • コーディング作業の効率化。

ヒアドキュメントを使う基本的な構文は次の通りです：

<?php
$str = <<<EOD
これはヒアドキュメントの基本構文です。
複数行のテキストを一つの変数に簡単に代入できます。
EOD;

print $str;
?>

このコードを実行すると、次のように出力されます：

これはヒアドキュメントの基本構文です。
複数行のテキストを一つの変数に簡単に代入できます。

ヒアドキュメントを使ったCSSコードの管理

次に、ヒアドキュメントを使ってCSSコードをPHP変数に代入する例を見てみましょう。以下のコードでは、ヒアドキュメントを使用して簡単にCSSを管理しています。

<?php
$css_code = <<<CSS

CSS;

print $css_code;
?>

このように、ヒアドキュメントを使用することで、複数行のCSSコードをPHPスクリプト内で簡単に扱うことができます。

PHPのヒアドキュメント（Heredoc）構文では、<<< の後に続く識別子（ここでは CSS）は任意の名前を付けることができます。
この識別子は、大文字小文字を区別し、開始部分（<<<CSS）と終了部分（CSS；）が一致していれば正常に動作します。

以下のポイントが守られていれば問題ありません：

  • 開始部分の識別子 <<<CSS と終了部分の識別子 CSS； が一致している。
  • 識別子はコードと同じインデントではなく、左端に揃えている。

この場合、CSS は単なる識別子で、内容が CSS であることを表現するためのラベルとして適切です。
もし内容が異なる場合でも、例えば HTML や SQL といった別の名前を使っても機能に影響はありません。

EOMとヒアドキュメントを使ったHTMLコードの管理

次に、ヒアドキュメントを使用してHTMLコードを管理する方法を見ていきましょう。以下の例は、EOMを使用して複数行のHTMLコードを一つの変数に代入し、それを出力するコードです。

<?php
$str_work = <<< EOM
 
<h2>End Of Document内の情報はココからスタート↓↓↓</h2>
 
<ul>
<li><a href="/css/255">CSSとpng画像でjpg画像をマスク表示してみる</a></li>
<li><a href="/javascript/252">テキストボックスのデフォルトテキスト（VALU値）を入力時にクリアさせる方法</a></li>
<li><a href="/javascript/250">FlipboardPageLayout：メージめくりを導入できるJs</a></li>
<li><a href="/javascript/248">jquery.quicksand：liタグコンテンツをアニメーションソートしてくれるjs</a></li>
<li><a href="/php/241">PHPのsetcookieを使用してスマホサイトとPCサイトを切り替える方法</a></li>
</ul>
 
<h3>End Of Document内の情報はココまでが最後↑↑↑</h3>
 
EOM;
 
print $str_work;
?>

　
この$str_work変数に代入された値は、HTMLとしてそのまま出力され、ウェブページ上で利用可能です。
ここでのメリットは、複数行のHTMLコードを一つの変数にまとめて管理できるため、コードの可読性やメンテナンス性が向上します。

EOM（End Of Document）を使って複数行のヒアドキュメントを変数に代入して出力するphpのデモページ

ヒアドキュメントの活用例として、実際のウェブページでのデモをご覧いただけるリンクは以下になります。

EOM（End Of Document）を使って複数行のヒアドキュメントを変数に代入して出力するphpのデモ

まとめ

この記事では、PHPのヒアドキュメントとEOMの基本構文から実践的な使用例までを解説しました。これらの構文を活用することで、複数行のコードを効率的に管理し、コーディングの効率化を図ることができます。

特にHTMLやCSS、JavaScriptのようなコードを頻繁に扱う場合、ヒアドキュメントを使うことで、コードの可読性とメンテナンス性が大幅に向上します。ぜひ、自分のプロジェクトに取り入れてみてください！

　
※流用される場合は自己責任でお願いします。
　デモページタグ内のGoogleアナリティクスタグは流用しないで下さい。

EOM ヒアドキュメント
関連記事