Markup

クラス: Peach_Markup_DefaultBuilder

定義: /Peach/Markup/DefaultBuilder.php

Peach_Markup_Builder
   |
   +-Peach_Markup_DefaultBuilder

HTML や XML などを出力する際に使う, デフォルトの Builder です.

このクラスは, 以下の条件をカスタマイズすることが出来ます.

  • インデントの文字列 (半角スペース, タブ文字)
  • 改行コードの種類 (LF, CRLF, CR)
  • 空要素タグや boolean 属性の出力方法 (SGML, XML)

メソッド

継承されたメソッド

クラス: Peach_Markup_Builder

Peach_Markup_Builder::build()
指定されたノードを加工します. 返り値の型は具象クラスによって異なります.
Peach_Markup_Builder::createContext()
build を実行する際に用いる Context を初期化します.

メソッド 詳細

constructor __construct

line 56

Peach_Markup_DefaultBuilder __construct()

デフォルトの設定を持つ DefaultBuilder インスタンスを生成します.

Tags

  • access : public

createContext

line 171

Markup_Context createContext()

この Builder にセットされている Indent, Renderer, BreakControl を使って新しい DefaultContext を生成します.

Tags

  • access : protected

オーバーライド: Peach_Markup_Builder::createContext() (build を実行する際に用いる Context を初期化します.)

getBreakControl

line 149

Peach_Markup_BreakControl getBreakControl()

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

もしも BreakControl オブジェクトがセットされていない場合は null を返します.

Tags

  • return : BreakControl オブジェクト (セットされていない場合は null)
  • access : public

getIndent

line 69

Peach_Markup_Indent getIndent()

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

もしも Indent オブジェクトがセットされていない場合は null を返します.

Tags

  • return : Indent オブジェクト (セットされていない場合は null)
  • access : public

getRenderer

line 91

Peach_Markup_Renderer getRenderer()

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

もしも Renderer オブジェクトがセットされていない場合は null を返します.

Tags

  • return : Renderer オブジェクト (セットされていない場合は null)
  • access : public

setBreakControl

line 160

void setBreakControl([Peach_Markup_BreakControl $breakControl = null])

この Builder に指定された BreakControl をセットします.

null を指定した場合は設定を解除します.

Tags

  • access : public

引数

Peach_Markup_BreakControl   $breakControl  

setIndent

line 80

void setIndent([Peach_Markup_Indent $indent = null])

この Builder に指定された Indent オブジェクトをセットします.

null を指定した場合は設定を解除します.

Tags

  • access : public

引数

Peach_Markup_Indent   $indent  

setRenderer

line 109

void setRenderer([Peach_Markup_Renderer|string $renderer = null])

この Builder に指定された Renderer オブジェクトをセットします.

引数によって以下のように動作します.

  • Peach_Markup_Renderer オブジェクトを指定した場合: そのオブジェクトをセットします
  • 文字列 "xml" または "xhtml" を指定した場合 (大小問わず) : Peach_Markup_XmlRenderer オブジェクトをセットします
  • 文字列 "sgml" または "html" を指定した場合 (大小問わず) : Peach_Markup_SgmlRenderer オブジェクトをセットします
  • null を指定した場合 : 現在セットされている Renderer を解除します
  • それ以外: InvalidArgumentException をスローします

Tags

  • throws : InvalidArgumentException 不正な引数をセットした場合
  • access : public

引数

Peach_Markup_Renderer|string   $renderer