Class HelperObject

既存の Component をラップして, ノードツリーの構築を簡略化・省力化するための糖衣構文を備えたクラスです. 主に (MVC フレームワークで言うところの) View の範囲で使用されることを想定しています.

Peach\Markup\HelperObject implements Peach\Markup\Container

Namespace: Peach\Markup
Located at Peach/Markup/HelperObject.php

Methods summary
`public`	# `__construct( Peach\Markup\Helper $helper, mixed $var )` 指定された Helper オブジェクトに紐付けられた新しいインスタンスを構築します. このコンストラクタは Helper::tag() から呼び出されます. 通常は, エンドユーザーがコンストラクタを直接呼び出す機会はありません. 指定された Helper オブジェクトに紐付けられた新しいインスタンスを構築します. このコンストラクタは Helper::tag() から呼び出されます. 通常は, エンドユーザーがコンストラクタを直接呼び出す機会はありません. Parameters `$helper` `$var` このオブジェクトがラップする値 (テキスト, Component など)
`public Peach\Markup\Component`	# `getNode( )` このオブジェクトがラップしているノードを返します. このオブジェクトがラップしているノードを返します. Returns `Peach\Markup\Component`
`public`	# `appendNode( mixed $var )` このオブジェクトの子ノードとして, 指定された値を追加します. このオブジェクトがラップしているオブジェクトが Container でない場合は何もしません. このオブジェクトの子ノードとして, 指定された値を追加します. このオブジェクトがラップしているオブジェクトが Container でない場合は何もしません. Parameters `$var` 追加される値 Implementation of `Peach\Markup\Container::appendNode()`
`public Peach\Markup\HelperObject`	# `append( mixed $var )` このオブジェクトの子ノードとして, 指定された値を追加して, 最後に自分自身を返します. メソッドチェーンを可能にするための appendNode() のシンタックスシュガーです. このオブジェクトの子ノードとして, 指定された値を追加して, 最後に自分自身を返します. メソッドチェーンを可能にするための appendNode() のシンタックスシュガーです. Parameters `$var` 追加される値 Returns `Peach\Markup\HelperObject` 自分自身
`public Peach\Markup\HelperObject`	# `appendTo( Peach\Markup\Container $container )` 指定された Container にこのオブジェクトを追加します. 以下の 2 つのコードは, どちらも $obj2 の中に $obj1 を追加しています. $obj1->appendTo($obj2); $obj2->append($obj1); HelperObject::append() との違いは, 返り値が $obj1 になるか $obj2 になるかという点にあります. 指定された Container にこのオブジェクトを追加します. 以下の 2 つのコードは, どちらも $obj2 の中に $obj1 を追加しています. $obj1->appendTo($obj2); $obj2->append($obj1); HelperObject::append() との違いは, 返り値が $obj1 になるか $obj2 になるかという点にあります. Parameters `$container` 追加先の Container Returns `Peach\Markup\HelperObject` 自分自身
`public Peach\Markup\HelperObject`	# `appendCode( string\|Peach\Markup\Code $code )` 指定された文字列を整形済コードとして追加します. 指定された文字列を整形済コードとして追加します. Parameters `$code` 追加対象の整形済文字列 Returns `Peach\Markup\HelperObject` このオブジェクト自身
`public Peach\Markup\HelperObject`	# `attr( string\|array\|Peach\Util\ArrayMap $var,… )` Element::setAttribute() および Element::setAttributes() の糖衣構文です. 引数が配列の場合は setAttributes() を実行し, 引数が 1 つ以上の文字列の場合は setAttribute() を実行します. もしもこのオブジェクトがラップしているノードが Element ではなかった場合, このメソッドは何も行いません. Element::setAttribute() および Element::setAttributes() の糖衣構文です. 引数が配列の場合は setAttributes() を実行し, 引数が 1 つ以上の文字列の場合は setAttribute() を実行します. もしもこのオブジェクトがラップしているノードが Element ではなかった場合, このメソッドは何も行いません. jQuery のようなメソッドチェインを実現するため, このオブジェクト自身を返します. Parameters `$var`,… セットする属性 Returns `Peach\Markup\HelperObject` このオブジェクト自身
`public Peach\Markup\HelperObject`	# `children( )` このオブジェクトの子ノード一覧をあらわす HelperObject を返します. このオブジェクトの子ノード一覧をあらわす HelperObject を返します. Returns `Peach\Markup\HelperObject`
`public mixed`	# `write( )` この HelperObject をレンダリングします. この HelperObject をレンダリングします. Returns mixed 出力結果. デフォルトではマークアップされた結果の文字列
`public string`	# `debug( )` この HelperObject をデバッグ出力します. この HelperObject をデバッグ出力します. Returns string
`public Peach\Markup\HelperObject`	# `prototype( )` この HelperObject がラップしている要素の属性をコピーして, 新しい要素を生成します. もしもラップしているオブジェクトが Element ではなかった場合は空の NodeList をラップする HelperObject を返します. この HelperObject がラップしている要素の属性をコピーして, 新しい要素を生成します. もしもラップしているオブジェクトが Element ではなかった場合は空の NodeList をラップする HelperObject を返します. Returns `Peach\Markup\HelperObject` コピーされた要素をラップする HelperObject
`public`	# `accept( Peach\Markup\Context $context )` このオブジェクトがラップしているノードの accept() を呼び出します. このオブジェクトがラップしているノードの accept() を呼び出します. Parameters `$context` Implementation of `Peach\Markup\Component::accept()`
`public array`	# `getChildNodes( )` このオブジェクトの子ノードの一覧を取得します. もしもこのオブジェクトがラップしているノードが Container Container だった場合は, そのオブジェクトの子ノードの一覧を返します. それ以外は空の配列を返します. このオブジェクトの子ノードの一覧を取得します. もしもこのオブジェクトがラップしているノードが Container Container だった場合は, そのオブジェクトの子ノードの一覧を返します. それ以外は空の配列を返します. Returns array Implementation of `Peach\Markup\Container::getChildNodes()`
`public Peach\Markup\NodeList`	# `getAppendee( )` このオブジェクトがラップしているノードの getApendee() の結果を返します. このオブジェクトがラップしているノードの getApendee() の結果を返します. Returns `Peach\Markup\NodeList` Implementation of `Peach\Markup\Component::getAppendee()`