【PHP】ヒアドキュメントについて解説します

こんにちは。たいら(@tairaengineer2)です。
転職を繰り返し現在5社経験している、12年目エンジニアです。

この記事では、 PHPのヒアドキュメントについて

ヒアドキュメントとは
ヒアドキュメントを書くルール
ヒアドキュメントを使ったサンプルプログラム

と、丁寧に解説していきます。

前提条件：実行環境について
ヒアドキュメントとは
ヒアドキュメントを書くルール
ヒアドキュメントを解説するプログラムの概要
PHPサンプルプログラム
実行結果
まとめ：ヒアドキュメントを使ってみよう！

前提条件：実行環境について

実行環境は以下の通りです。

OS	Windows11
PHPのバージョン	8.2.4
XAMPPのバージョン	8.2.4

PHPを動かすためにXAMPPを使っています。
XAMPPのインストールは、下の記事をご参考ください。

【XAMPP】インストールするやり方を解説します（Windows11向け）

ヒアドキュメントとは

ヒアドキュメントとは、長い文字列や

HTMLタグ
タブ
SQL

など特殊な文字列を変数に設定するときに使用する機能です。

使い方サンプルは以下です。

$sample = <<<EOF
	HelloWorld<br >
	HelloWorld<br >
	HelloWorld
EOF;

$sample = <<<EOF

HelloWorld

HelloWorld

EOF;

このヒアドキュメントを表示させると
PHPのヒアドキュメントを解説
と表示され、開発者ツールを使いHTMLを確認すると

ヒアドキュメントで指定したbrタグで改行できています。

ヒアドキュメントを書くルール

ヒアドキュメントを書くルールがあります。

「<<<【任意のID】」で始まり、「【任意のID】;」で終わること
最初と最後の【任意のID】は同一であること
【任意のID】に使用できる文字は英数字と記号は「_（アンダースコア）」であること
【任意のID】の最初の文字は数字以外であること

の4つです。

【任意のID】には最初と最後が同一であれば、何を設定してもOKです。
なので

$sample = <<<ABC_123
	HelloWorld<br >
	HelloWorld<br >
	HelloWorld
ABC_123;

$sample = <<<ABC_123

HelloWorld

HelloWorld

ABC_123;

こういうのもOKです。

ただ慣例的に

EOD（End Of Docment：ドキュメントの終わり）
EOF（End Of File：ファイルの終わり）
EOM（End Of Message：メッセージの終わり）
EOT（End Of Text：テキストの終わり）

のいずれかを使うことが多いです。

ヒアドキュメント内に変数を設定することができます。

$test = 'test';
$sample = <<<EOF
	$test
EOF;

$test = 'test';

$sample = <<<EOF

$test

EOF;

注意点として、変数の前後は半角スペースを入れる必要があります。

では、次の章で実際に使ってみます。

ヒアドキュメントを解説するプログラムの概要

ヒアドキュメントを解説するプログラムでは、ヒアドキュメントを

文字列のみ
HTMLタグあり
変数あり

の3種類で作成します。
ヒアドキュメントを画面に表示させ、設定した内容で表示できるかどうかを確認します。

phpプログラムは

C:\xampp\htdocs

配下に、【sample.php】というファイル名で格納しています。
PHPの__DIR__マジック定数を解説

PHPサンプルプログラム

<?php
	print('■ヒアドキュメントサンプル<br >');

	print('・文字列のみの場合<br >');
	$msg1 = <<<EOF
		あいうえおかきくけこさしすせそたちつてと
	EOF;
	print($msg1.'<br >');

	print('・HTMLタグありの場合<br >');
	$msg2 = <<<EOF
		<ul>
			<li>PHP</li>
			<li>Java</li>
			<li>Ruby</li>
		</ul>
	EOF;
	print($msg2);

	print('・変数あり場合<br >');
	$orange = 'オレンジ';
	$peach = 'モモ';
	$msg3 = <<<EOF
		ブドウ $orange ナシ $peach パイナップル
	EOF;
	print($msg3);
?>

<?php

print('■ヒアドキュメントサンプル ');

print('・文字列のみの場合 ');

$msg1 = <<<EOF

あいうえおかきくけこさしすせそたちつてと

EOF;

print($msg1.' ');

print('・HTMLタグありの場合 ');

$msg2 = <<<EOF

<ul>

</ul>

EOF;

print($msg2);

print('・変数あり場合 ');

$orange = 'オレンジ';

$peach = 'モモ';

$msg3 = <<<EOF

ブドウ $orange ナシ $peach パイナップル

EOF;

print($msg3);

ul要素は、順不同の箇条書きのリストを表す要素です。
こちらの記事をご参考ください。

【HTML】順不同の箇条書きのリストを表すul要素を解説します

実行結果

XAMPPを起動して、【http://localhost/sample.php】のURLにアクセスします。

XAMPPでPHPの動かし方については、こちらの記事をご参考ください。

XAMPPでApacheの動かし方を解説します（Windows11向け）

PHPのヒアドキュメントを解説
設定した内容で表示できていることが確認できました！

まとめ：ヒアドキュメントを使ってみよう！

以上がヒアドキュメントについての解説でした！

あなたのご参考になったのなら、とても嬉しいです(*´▽｀*)
ではでは～(・ω・)ﾉｼ