概要

Node インタフェースはマークアップ言語を構成するパーツをあらわします. 具体的には要素・テキスト・コメントなどに相当します.

API は DOM に似ている部分もありますが, それは表面的な相似に過ぎません. このモジュールの目的はマークアップ言語のモデル化ではなく出力であるため, DOM で定義されている一部のノードは意図的にサポートされていません. 逆に, DOM には無くこのモジュールのみに存在するノードもあります.

Element

Element はマークアップ言語における「要素」を表現するクラスです. Element には ContainerElement と EmptyElement の 2 種類があります.

ContainerElement

ContainerElement は開始タグと終了タグから成る要素を表します. append() メソッドを使ってテキストや任意のノードを子ノードとして追加することが出来ます.

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

$p = new Peach_Markup_ContainerElement("p");
$p->setAttribute("class", "test");
$p->append("The Quick Brown Fox Jumps Over The Lazy Dogs.");
$builder = new Peach_Markup_DefaultBuilder();
echo $builder->build($p);

このコードは以下の結果を出力します.

<p class="test">The Quick Brown Fox Jumps Over The Lazy Dogs.</p>

EmptyElement

EmptyElement は空要素 (終了タグを伴わないタグ) を表すクラスです. HTML では img, input, br, hr などの要素が該当します.

このノードは Peach_Markup_DefaultBuilder::setRenderer() で Renderer の種類を切り替えることで, タグの書式を制御することが出来ます. 以下にサンプルコードを掲載します. タグの末尾が ">" から "/>" に変化していることに注目してください.

$input = new Peach_Markup_EmptyElement("input");
$input->setAttributes(array("type" => "text", "name" => "subject", "value" => ""));
$builder = new Peach_Markup_DefaultBuilder();
$builder->setRenderer("HTML");
echo $builder->build($input); // Output: <input type="text" name="subject" value="">
$builder->setRenderer("XHTML");
echo $builder->build($input); // Output: <input type="text" name="subject" value="" />

属性の設定方法

要素に属性をセットするためのメソッドとして setAttribute() と setAttributes() の 2 種類があります. 属性を 1 つだけセットする場合は setAttribute(), 複数の属性を一度にセットしたい場合は setAttributes() といった具合に使い分けると良いでしょう.

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

// setAttribute() で属性をセットします
$script = new Peach_Markup_ContainerElement("script");
$script->setAttribute("type", "text/javascript");
$script->setAttribute("src", "sample.js");
// 以下のように setAttributes() で複数の属性を一度にセットすることも出来ます
$script = new Peach_Markup_ContainerElement("script");
$script->setAttributes(array("type" => "text/javascript", "src" => "sample.js"));

Boolean 属性の設定方法

例えば HTML における input 要素の readonly 属性のような, 値を持たない属性のことを Boolean 属性と呼びます. 要素に Boolean 属性をセットするには以下の方法があります.

setAttribute() の第 2 引数に null を指定する (または第 2 引数を省略する)
setAttributes() の引数の配列で, キーに属性名, 値に null を設定する
setAttributes() の引数の配列で, キーを省略し, 値に属性名を設定する

input 要素に readonly 属性を付加するサンプルコードを掲載します. 以下に挙げるコードはすべて同じ意味になります.

// setAttribute() の第 2 引数を省略する場合
$input = new Peach_Markup_EmptyElement("input");
$input->setAttributes(array("type" => "text", "name" => "subject", "value" => "Sample"));
$input->setAttribute("readonly");
// キーに属性名, 値に null を指定する場合
$input = new Peach_Markup_EmptyElement("input");
$input->setAttributes(array("type" => "text", "name" => "subject", "value" => "Sample", "readonly" => null));
// キーを省略する場合
$input = new Peach_Markup_EmptyElement("input");
$input->setAttributes(array("type" => "text", "name" => "subject", "value" => "Sample", "readonly"));

Text

Text は要素内のテキストを表します. このノードは出力される際に自動的に htmlspecialchars() で特殊文字を変換します.

append() メソッドの引数に文字列を指定した場合, 内部ではその文字列の内容をあらわす Text ノードが生成され, そのノードが追加されるという仕組みになっています.

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

$text = new Paach_Markup_Text("<Hello> & <World!>");
$p1 = new Peach_Markup_ContainerElement("p");
$p1->append($text);
// 通常は, 以下のように文字列を直接 append してください (上の書き方と同じ処理です)
$p2 = new Peach_Markup_ContainerElement("p");
$p2->append("<Hello> & <World!>");
$builder = new Peach_Markup_DefaultBuilder();
echo $builder->build($p1); // Output: <p><Hello> & <World!></p>

Code

Code は整形済のテキストを表すクラスです. Text ノードと違い, 出力の際に特殊文字の変換 (エスケープ) は一切せず, 与えられた文字列をそのまま出力します. XML 宣言, DOCTYPE 宣言, CDATA セクション, PI (処理命令) など, このモジュールでサポートされていない構文をノードの一部として扱いたい場合に使用してください.

以下は HTML の style 要素を出力するサンプルコードです.

$str = <<<EOS
body {
color: #000;
background-color: #fff;
width: 100%;
}
@media(min-width: 901px) {
body {
width: 900px;
}
}
EOS;
$style = new Peach_Markup_ContainerElement("style");
$style->setAttribute("type", "text/css");
$style->append(new Peach_Markup_Code($str));
$builder = new Peach_Markup_DefaultBuilder();
echo $builder->build($style);

このコードは以下の文字列を出力します.

<style type="text/css">
body {
color: #000;
background-color: #fff;
width: 100%;
}
@media(min-width: 901px) {
body {
width: 900px;
}}
</style>

Comment

Comment は  で囲まれたコメント部分を表現するクラスです. 以下にサンプルコードを掲載します.

$comment = new Peach_Markup_Comment();
$comment->append("Sample comment");
$builder = new Peach_Markup_DefaultBuilder();
echo $builder->build($comment); // Output:

コメントアウト

単純にテキストをコメントにするだけではなく, 任意のノードのコメントアウトも表現出来ます. 以下に例を挙げます.

$h1 = new Peach_Markup_ContainerElement("h1");
$h1->append("Sample");
$p = new Peach_Markup_ContainerElement("p");
$p->append("This paragraph is disabled.");
$comment = new Peach_Markup_Comment();
$comment->append($h1);
$comment->append($p);
$builder = new Peach_Markup_DefaultBuilder();
echo $builder->build($comment);

このコードは以下の文字列を出力します.

<!--
<h1>Sample</h1>
<p>This paragraph is disabled.</p>
-->

メタコメント

以下のように, コメントの先頭と末尾に任意の文字列を付与することが出来ます.

$h1 = new Peach_Markup_ContainerElement("h1");
$h1->append("Sample");
$p = new Peach_Markup_ContainerElement("p");
$p->append("This paragraph is disabled.");
$comment = new Peach_Markup_Comment("START", "END");
$comment->append($h1);
$comment->append($p);
$builder = new Peach_Markup_DefaultBuilder();
echo $builder->build($comment);

このコードは以下の文字列を出力します. 先ほどの例と似ていますが, コメントの先頭と末尾に "START", "END" という文字列が付与されていることに注目してください.

<!--START
<h1>Sample</h1>
<p>This paragraph is disabled.</p>
END-->

この機能を使って一部のブラウザに実装されている条件付きコメント ("" など) を表現することも出来ますが, 条件付きコメント専用の API として Peach_Markup_Html::conditionalComment() が既に用意されているので, 通常はそちらを使用することを推奨します.

Markup

Node (各種パーツ)

Table of Contents

概要