【PHP】ヒアドキュメントの使い方。

ちょっとはまったのでメモ。

ヒアドキュメントとは複数行に渡る文字列を作成するための記述方法。

下記のように記述する。

$var = '変数は展開される。';
		
$str = <<< TEXT
「&lt;&lt;&lt; TEXT」から「TEXT;」の間に記述された文字列は、
全てが静的な文字列と解釈される。
なお、ヒアドキュメント内での$var
		
また「TEXT」は任意の文字列を設定することができる。
ヒアドキュメント終端のキーとセットになっていればOK。
TEXT;
		
var_dump($str);

↓

string(358) "「<<< TEXT」から「TEXT;」の間に記述された文字列は、 全てが静的な文字列と解釈される。 なお、ヒアドキュメント内での変数は展開される。 また「TEXT」は任意の文字列を設定することができる。 ヒアドキュメント終端のキーとセットになっていればOK。"

といった感じで使用する。

しかしここで一つ注意点として終端を表すキーを記述する場合、その行にはキー文字列及びコロン以外の文字は存在してはならない。
例えばキー文字列の前にインデント(タブやスペース)が存在していると、PHPはヒアドキュメントの終端を正しくパースできず、シンタックスエラーになってしまうので注意されたし。