Markup

クラス: Peach_Markup_Helper

定義: /Peach/Markup/Helper.php

ノードの生成を簡略化するための API を備えたヘルパーです.

ノードの構築およびマークアップ出力の手間を省力化するためのクラスです.

メソッド

メソッド 詳細

constructor __construct

line 49

Peach_Markup_Helper __construct(Peach_Markup_Builder $builder, [array $emptyNodeNames = array()])

指定された Builder を使ってマークアップを行う, 新しい Helper インスタンスを生成します.

第二引数で, 空要素として扱われる要素名の一覧を指定することができます.

Tags

  • access : public

引数

Peach_Markup_Builder   $builder   マークアップに利用する Builder
array   $emptyNodeNames   空要素の要素名一覧
Top

createObject

line 70

Peach_Markup_HelperObject createObject(string|Peach_Markup_Component $var, [array $attr = array()])

新しい HelperObject を生成します.

このメソッドが返す HelperObject は, 引数の型に応じて以下のように振る舞います.

  • 文字列の場合: その文字列を要素名に持つ Element
  • null または空文字列の場合: 空の NodeList
  • Node オブジェクトの場合: その Node 自身

第 2 引数に配列を指定した場合, 生成された要素に対して属性をセットすることが出来ます. (生成された HelperObject が要素ではない場合, 第 2 引数は無視されます)

Tags

  • access : public

引数

string|Peach_Markup_Component   $var  
array   $attr  
Top

getBuilder

line 130

Peach_Markup_Builder getBuilder()

この Helper にセットされている Builder オブジェクトを返します.

返り値の Builder に対する変更は, この Helper にも影響されます.

Tags

  • access : public
Top

setBuilder

line 141

void setBuilder(Peach_Markup_Builder $builder)

この Helper にセットされている Builder を, 引数の Builder オブジェクトで上書きします.

Tags

  • access : public

引数

Peach_Markup_Builder   $builder  
Top

write

line 119

mixed write(Peach_Markup_HelperObject $object)

指定された HelperObject の変換結果を返します.

このヘルパーに設定されている Builder を使って, 引数の HelperObject を build した結果を返します.

Tags

  • access : public

引数

Peach_Markup_HelperObject   $object  
Top