Overview

Namespaces

  • Peach
    • DF
    • DT
    • Http
      • Body
      • Header
    • Markup
    • Util

Classes

  • AbstractHelper
  • AbstractRenderer
  • BaseHelper
  • BreakControlWrapper
  • Builder
  • Code
  • Comment
  • ContainerElement
  • Context
  • DebugBuilder
  • DebugContext
  • DefaultBreakControl
  • DefaultBuilder
  • DefaultContext
  • Element
  • EmptyElement
  • HelperObject
  • HtmlHelper
  • Indent
  • MinimalBreakControl
  • NameBreakControl
  • NameValidator
  • NodeList
  • None
  • SgmlRenderer
  • Text
  • XmlRenderer

Interfaces

  • BreakControl
  • Component
  • Container
  • Helper
  • Node
  • Renderer
  • Overview
  • Namespace
  • Class

Class BaseHelper

汎用的な Helper オブジェクトです. コンストラクタ引数に指定された Builder および空要素タグ一覧をもとにノードの生成・出力を行います.

このクラスのインスタンスは, AbstractHelper の各派生クラスにおいて親の Helper オブジェクトとして使用されることを想定しています.

Peach\Markup\BaseHelper implements Peach\Markup\Helper
Namespace: Peach\Markup
Located at Peach/Markup/BaseHelper.php
Methods summary
public
# __construct( Peach\Markup\Builder $builder, array $emptyNodeNames = array() )

指定された Builder を使ってマークアップを行う, 新しい Helper インスタンスを生成します. 第二引数で, 空要素として扱われる要素名の一覧を指定することができます.

指定された Builder を使ってマークアップを行う, 新しい Helper インスタンスを生成します. 第二引数で, 空要素として扱われる要素名の一覧を指定することができます.

Parameters

$builder
マークアップに利用する Builder
$emptyNodeNames
空要素の要素名一覧
public Peach\Markup\HelperObject
# tag( string|Peach\Markup\Component $var, array $attr = array() )

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

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

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

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

Parameters

$var
$attr

Returns

Peach\Markup\HelperObject

Implementation of

Peach\Markup\Helper::tag()
public mixed
# write( Peach\Markup\HelperObject $object )

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

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

Parameters

$object

Returns

mixed

Implementation of

Peach\Markup\Helper::write()
public Peach\Markup\Builder
# getBuilder( )

この Helper にセットされている Builder オブジェクトを返します. 返り値の Builder に対する変更は, この Helper にも影響されます.

この Helper にセットされている Builder オブジェクトを返します. 返り値の Builder に対する変更は, この Helper にも影響されます.

Returns

Peach\Markup\Builder
public
# setBuilder( Peach\Markup\Builder $builder )

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

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

Parameters

$builder
public Peach\Markup\Element
# createElement( string $name )

指定された要素名を持つ新しい Element オブジェクトを返します.

指定された要素名を持つ新しい Element オブジェクトを返します.

Parameters

$name
要素名

Returns

Peach\Markup\Element
指定された要素名を持つ Element

Implementation of

Peach\Markup\Helper::createElement()
PEACH2 API documentation generated by ApiGen