Markup

クラス: Peach_Markup_HelperObject

定義: /Peach/Markup/HelperObject.php

既存の Component をラップして, ノードツリーの構築を簡略化・省力化するための糖衣構文を備えたクラスです.

主に (MVC フレームワークで言うところの) View の範囲で使用されることを想定しています.

すべての実装されたインタフェース

メソッド

メソッド 詳細

constructor __construct

line 53

Peach_Markup_HelperObject __construct(Peach_Markup_Helper $helper, mixed $var)

指定された Helper オブジェクトに紐付けられた新しいインスタンスを構築します.

このコンストラクタは Peach_Markup_Helper::createObject() から呼び出されます. 通常は, エンドユーザーがコンストラクタを直接呼び出す機会はありません.

Tags

  • access : public

引数

Peach_Markup_Helper   $helper  
mixed   $var   このオブジェクトがラップする値 (テキスト, Component など)

accept

line 236

void accept(Peach_Markup_Context $context)

このオブジェクトがラップしているノードの accept() を呼び出します.

Tags

  • access : public

引数

Peach_Markup_Context   $context  

定義

Peach_Markup_Component::accept()
指定された Context にこのノードを処理させます. Visitor パターンの accept() に相当します.

append

line 75

Peach_Markup_HelperObject append(mixed $var)

このオブジェクトの子ノードとして, 指定された値を追加します.

このオブジェクトがラップしているオブジェクトが Container でない場合は何もしません.

Tags

  • return : 自分自身
  • access : public

引数

mixed   $var   追加される値

定義

Peach_Markup_Container::append()
このコンテナにノードを追加します.

appendCode

line 111

Peach_Markup_HelperObject appendCode(string|Peach_Markup_Code $code)

指定された文字列を整形済コードとして追加します.

Tags

  • return : このオブジェクト自身
  • access : public

引数

string|Peach_Markup_Code   $code   追加対象の整形済文字列

appendTo

line 99

指定された Container にこのオブジェクトを追加します.

以下の 2 つのコードは, どちらも $obj2 の中に $obj1 を追加しています.

  1.  $obj1->appendTo($obj2);
  2.  $obj2->append($obj1);

append() との違いは, 返り値が $obj1 になるか $obj2 になるかという点にあります.

Tags

  • return : 自分自身
  • access : public

引数

Peach_Markup_Container   $container   追加先の Container

attr

line 135

setAttribute() および setAttributes() の糖衣構文です.

引数が配列の場合は setAttributes() を実行し, 引数が 1 つ以上の文字列の場合は setAttribute() を実行します. もしもこのオブジェクトがラップしているノードが Element ではなかった場合, このメソッドは何も行いません.

jQuery のようなメソッドチェインを実現するため, このオブジェクト自身を返します.

Tags

  • return : このオブジェクト自身
  • access : public

引数

string|array|Peach_Util_ArrayMap   $var   セットする属性

children

line 162

このオブジェクトの子ノード一覧をあらわす HelperObject を返します.

Tags

  • access : public

debug

line 189

string debug()

この HelperObject をデバッグ出力します.

Tags

  • access : public

getChildNodes

line 248

array getChildNodes()

このオブジェクトの子ノードの一覧を取得します.

もしもこのオブジェクトがラップしているノードが Container だった場合は, そのオブジェクトの子ノードの一覧を返します. それ以外は空の配列を返します.

Tags

  • access : public

定義

Peach_Markup_Container::getChildNodes()
このコンテナの子ノードの一覧を Peach_Markup_Node オブジェクトの配列として返します.

getNode

line 63

このオブジェクトがラップしているノードを返します.

Tags

  • access : public

prototype

line 205

この HelperObject がラップしている要素の属性をコピーして, 新しい要素を生成します.

もしもラップしているオブジェクトが Element ではなかった場合は 空の NodeList をラップする HelperObject を返します.

Tags

  • return : コピーされた要素をラップする HelperObject
  • access : public

write

line 180

mixed write()

この HelperObject をレンダリングします.

Tags

  • return : 出力結果. デフォルトではマークアップされた結果の文字列
  • access : public