概要

Html は HTML の出力に特化したユーティリティクラスです. このクラスは HTML 出力専用の Helper オブジェクトをクラス変数として保持しています. 各クラスメソッドではその Helper オブジェクトを使って HTML コードを出力します. (この Helper オブジェクトのことを以下「グローバル Helper」と呼びます)

基本的な使い方

tag

このクラスで最も使用頻度の高いメソッドは tag() です. tag() は引数に要素名を取り, 指定された要素を HelperObject として返すメソッドです. HelperObject クラスの詳細については Helper / HelperObject を参照してください.

以下に tag() を用いたサンプルコードを掲載します.

echo Peach_Markup_Html::tag("p")
->attr("class", "sample")
->append(Peach_Markup_Html::tag("span")->append("This is test"))
->append(Peach_Markup_Html::tag("br"))
->append("This is a sample text.")
->append(Peach_Markup_Html::tag("img", array("src" => "test.jpg", "alt" => "")))
->write();
/*
Output:
This is test
This is a sample text.
<img src="test.jpg" alt="">
*/

以下のように tag() の第 2 引数に配列を指定することで, 属性をセットすることも出来ます.

$p = Peach_Markup_Html::tag("p", array("class" => "sample"))->append("Sample text");
echo $p->write(); // Output: Sample text

書式のカスタマイズ

デフォルトでは HTML 形式でコードを出力しますが, XHTML 形式で出力したい場合には, 以下のように引数に true を指定して init() メソッドを実行してください. これによりグローバル Helper が XHTML 用に初期化されます.

Peach_Markup_Html::init(true);
echo Peach_Markup_Html::tag("p")
->attr("class", "sample")
->append(Peach_Markup_Html::tag("span")->append("This is test"))
->append(Peach_Markup_Html::tag("br"))
->append("This is a sample text.")
->append(Peach_Markup_Html::tag("img", array("src" => "test.jpg", "alt" => "")))
->write();
/*
Output:
This is test
This is a sample text.
<img src="test.jpg" alt="" />
*/

インデントや改行文字など, その他の書式をカスタマイズする場合は getBuilder() を使用してください. 返り値の DefaultBuilder オブジェクトに対して変更を加えることで, このクラスの出力をカスタマイズすることが出来ます.

以下にサンプルコードを掲載します.

$builder = Peach_Markup_Html::getBuilder();
$builder->setRenderer("XHTML");
$builder->setIndent(new Peach_Markup_Indent(0, " ", Peach_Markup_Indent::LF));
echo Peach_Markup_Html::tag("p")
->attr("class", "sample")
->append(Peach_Markup_Html::tag("span")->append("This is test"))
->append(Peach_Markup_Html::tag("br"))
->append("This is a sample text.")
->append(Peach_Markup_Html::tag("img", array("src" => "test.jpg", "alt" => "")))
->write();
/*
Output:
This is test
This is a sample text.
<img src="test.jpg" alt="" />
*/

alias

tag() のような使用頻度の高いクラスメソッドを記述するために, 毎回 "Peach_Markup_Html::tag" というコードを書くのは面倒かもしれません. Html クラスには, 定義されている各種クラスメソッドに対して任意の名前の関数を割り当てる alias() というメソッドがあります. 事前に alias() を実行することで, 各種クラスメソッドを簡潔に記述することが出来ます.

デフォルトの挙動

以下のように引数なしで実行すると "tag" という名前の関数が新たに定義されます. 定義された関数は "Peach_Markup_Html::tag" と全く同じように動作します.

Peach_Markup_Html::alias(); // 関数 tag() が生成される
echo tag("p")
->attr("class", "sample")
->append(tag("span")->append("This is test"))
->append(tag("br"))
->append("This is a sample text.")
->append(tag("img", array("src" => "test.jpg", "alt" => "")))
->write();
/*
Output:
This is test
This is a sample text.
<img src="test.jpg" alt="">
*/

注意事項として, Symfony など一部の PHP フレームワークでは, デフォルトで同名のヘルパー関数が定義されている場合があります. 関数名が被ることにより予期せぬエラーが発生する原因となるので, 特定のフレームワークに組み込んだりその他のベンダーの PHP クラスライブラリを導入する場合には, 安易に alias() を使わないようにするか, 後述の方法で被らないような関数名を定義してください.

関数名を指定して別名を定義

alias() の引数にメソッド名と関数名を指定することで, 任意の名前で関数を定義することが出来ます. 以下のサンプルコードでは tag() メソッドに "t" という関数名を割り当てています.

Peach_Markup_Html::alias(array("tag" => "t")); // 関数 t() が生成される
echo t("p")
->attr("class", "sample")
->append(t("span")->append("This is test"))
->append(t("br"))
->append("This is a sample text.")
->append(t("img", array("src" => "test.jpg", "alt" => "")))
->write();
/*
Output:
This is test
This is a sample text.
<img src="test.jpg" alt="">
*/

alias の引数には, キーにメソッド名, 値にそのメソッドの別名となる配列を指定してください. キーとして使える文字列 (メソッド名) は以下の通りです.

以下のように複数の関数を同時に定義することも出来ます.

Peach_Markup_Html::alias(array(
"tag" => "t",
"comment" => "c",
"select" => "s"
));

select

PHP で動的に HTML コードを出力する際, 特に select 要素はロジックが複雑になりがちです. Html クラスには select 要素を出力するための専用のメソッド select() が用意されています. このメソッドを使うことで select 要素の出力がより直感的に出来るでしょう.

以下に select() メソッドのサンプルコードを掲載します. 1 番目の引数にはデフォルトで選択されている値, 2 番目の引数には選択肢の一覧を配列形式, 3 番目の引数には select 要素にセットする属性を指定してください.

$candidates = array(
"Apple" => 1,
"Orange" => 2,
"Pear" => 3,
"Peach" => 4,
);
echo Peach_Markup_Html::select(4, $candidates, array("name" => "favorite"))->write();
/*
Output:
<select name="favorite">
<option value="1">Apple</option>
<option value="2">Orange</option>
<option value="3">Pear</option>
<option value="4" selected>Peach</option>
</select>
*/

2 番目の引数を二次元配列にすることで, optgroup を含む select 要素を表現することも出来ます. 以下にサンプルコードを掲載します.

$candidates = array(
"Fruit" => array(
"Apple" => "1",
"Orange" => "2",
"Pear" => "3",
"Peach" => "4",
),
"Dessert" => array(
"Chocolate" => "5",
"Doughnut" => "6",
"Ice cream" => "7",
),
"Others" => "8",
);
echo Peach_Markup_Html::select(4, $candidates, array("name" => "favorite"))->write();
/*
Output:
<select name="favorite">
<optgroup label="Fruit">
<option value="1">Apple</option>
<option value="2">Orange</option>
<option value="3">Pear</option>
<option value="4" selected>Peach</option>
</optgroup>
<optgroup label="Dessert">
<option value="5">Chocolate</option>
<option value="6">Doughnut</option>
<option value="7">Ice cream</option>
</optgroup>
<option value="8">Others</option>
</select>
*/

comment

comment() は文字通りコメントを生成するためのメソッドです. このメソッドは Comment ノードをラップした HelperObject を生成して返します.

以下に comment() メソッドのサンプルコードを掲載します.

echo Peach_Markup_Html::comment("This is test")->write();
// Output:

引数に任意のノードを指定するか, または append() で任意のノードを追加することで, そのノードをコメントアウトした状態で出力することができます. 以下に例を挙げます.

$p1 = Peach_Markup_Html::tag("p")->append("First text");
$p2 = Peach_Markup_Html::tag("p")->append("Second text");
$comment = Peach_Markup_Html::comment()->append($p1)->append($p2);
echo $comment->write();
/*
Output:
<!--
First text
Second text
-->
*/

conditionalComment

conditionalComment() は一部のブラウザで実装されている条件付きコメント ("" など) を出力するためのメソッドです.

1 番目の引数にはコメントの条件 ("lt IE 7" など), 2 番目の引数には条件付きコメントの内容を指定してください. 2 番目の引数は省略することも出来ます. 以下に例を挙げます.

$p = Peach_Markup_Html::tag("p")->append("R.I.P. Windows XP 2001 - 2014");
$comment = Peach_Markup_Html::conditionalComment("lt IE 7", $p);
echo $comment->write();
/*
Output:
<!--[if lt IE 7]>
R.I.P. Windows XP 2001 - 2014
<![endif]-->
*/

Markup

Html (HTML 出力専用クラス)

Table of Contents

概要