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 Comment

マークアップ言語のコメントをあらわすクラスです. 単なるコメントとしての用途だけでなく, 任意のノードをコメントアウトすることも出来ます.

Peach\Markup\Comment implements Peach\Markup\Container, Peach\Markup\Node
Namespace: Peach\Markup
Located at Peach/Markup/Comment.php
Methods summary
public
# __construct( string $prefix = "", string $suffix = "" )

指定された prefix と suffix を持つ Comment オブジェクトを構築します. prefix と suffix は, 主に条件付きコメントの先頭 ("[if IE 6]>" など) と 末尾 ("<![endif]" など) に使用されます. 引数を指定しない場合は通常のコメントノードを生成します.

指定された prefix と suffix を持つ Comment オブジェクトを構築します. prefix と suffix は, 主に条件付きコメントの先頭 ("[if IE 6]>" など) と 末尾 ("<![endif]" など) に使用されます. 引数を指定しない場合は通常のコメントノードを生成します.

Parameters

$prefix
コメントの冒頭 ("[if IE 6]>" など)
$suffix
コメントの末尾 ("<![endif]" など)
public string
# getPrefix( )

コメントの冒頭の文字列を返します.

コメントの冒頭の文字列を返します.

Returns

string
コメントの冒頭文字列. 存在しない場合は空文字列
public string
# getSuffix( )

コメントの末尾の文字列を返します.

コメントの末尾の文字列を返します.

Returns

string
コメントの末尾の文字列. 存在しない場合は空文字列
public
# accept( Peach\Markup\Context $context )

指定された Context にこのノードを処理させます. Context::handleComment() を呼び出します.

指定された Context にこのノードを処理させます. Context::handleComment() を呼び出します.

Parameters

$context
このノードを処理する Context

Implementation of

Peach\Markup\Component::accept()
public
# appendNode( mixed $var )

このコメントにテキストまたはノードを追加します. ノードを追加した場合, このコメントノードは引数のノードのコメントアウトとして働きます.

このコメントにテキストまたはノードを追加します. ノードを追加した場合, このコメントノードは引数のノードのコメントアウトとして働きます.

Parameters

$var
このコメントに追加するテキストまたはノード

Implementation of

Peach\Markup\Container::appendNode()
public array
# getChildNodes( )

このコメントノードに含まれる子ノードの一覧を返します.

このコメントノードに含まれる子ノードの一覧を返します.

Returns

array
子ノードの一覧

Implementation of

Peach\Markup\Container::getChildNodes()
public Peach\Markup\NodeList
# getAppendee( )

このオブジェクトを Container::appendNode() に指定した場合, このオブジェクト自身が追加されます.

このオブジェクトを Container::appendNode() に指定した場合, このオブジェクト自身が追加されます.

Returns

Peach\Markup\NodeList
このオブジェクトを 1 つだけ含んだ NodeList

Implementation of

Peach\Markup\Component::getAppendee()
PEACH2 API documentation generated by ApiGen