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 Element

マークアップ言語の要素を表現するクラスです.

Peach\Markup\Element implements Peach\Markup\Node

Direct known subclasses

Peach\Markup\ContainerElement, Peach\Markup\EmptyElement
Abstract
Namespace: Peach\Markup
Located at Peach/Markup/Element.php
Methods summary
public
# __construct( string $name )

指定された要素名を持つ Element を構築します.

指定された要素名を持つ Element を構築します.

Parameters

$name
要素名

Throws

InvalidArgumentException
要素名が空文字列だった場合
public string
# getName( )

この要素の名前を返します.

この要素の名前を返します.

Returns

string
この要素の名前
public string
# getAttribute( string $name )

指定された属性の値を返します. 属性が存在しないか, 値の省略された属性の場合は NULL を返します. 属性が存在しているかどうかを調べる場合は Element::hasAttribute() を使用してください.

指定された属性の値を返します. 属性が存在しないか, 値の省略された属性の場合は NULL を返します. 属性が存在しているかどうかを調べる場合は Element::hasAttribute() を使用してください.

Parameters

$name
属性名

Returns

string
属性の値. 存在しないか, 値の省略された属性の場合は NULL
public boolean
# hasAttribute( string $name )

指定された属性が存在するかどうかを調べます.

指定された属性が存在するかどうかを調べます.

Parameters

$name
属性名

Returns

boolean
属性が存在する場合は TRUE, それ以外は FALSE
public
# setAttribute( string $name, string $value = null )

この要素に属性を設定します. $value が設定されていない場合は, 値が省略された属性を追加します.

この要素に属性を設定します. $value が設定されていない場合は, 値が省略された属性を追加します.

Parameters

$name
属性名
$value
属性値
public
# setAttributes( array|Peach\Util\ArrayMap $attr )

この要素に複数の属性を一括して設定します.

$element->setAttributes(array("id" => "foo", "class" => "bar"));

のように, キーに属性名, 値に属性の値を指定してください.

この要素に複数の属性を一括して設定します.

$element->setAttributes(array("id" => "foo", "class" => "bar"));

のように, キーに属性名, 値に属性の値を指定してください.

キーが省略された場合 (具体的にはキーに整数が指定された場合) は, その値を属性名とする Boolean 属性を設定します.

Parameters

$attr
属性の一覧
public
# removeAttribute( string $name )

指定された属性を削除します.

指定された属性を削除します.

Parameters

$name
属性名
public array
# getAttributes( )

この要素が持つすべての属性を配列で返します. この要素の返り値を, そのまま {Element::setAttributes()} の引数として使用することで属性のコピーをすることも出来ます.

この要素が持つすべての属性を配列で返します. この要素の返り値を, そのまま {Element::setAttributes()} の引数として使用することで属性のコピーをすることも出来ます.

Returns

array

すべての属性の配列. キーが属性名, 値が属性値. ただし値の省略された属性の場合は属性値が NULL となる.

public Peach\Markup\NodeList
# getAppendee( )

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

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

Returns

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

Implementation of

Peach\Markup\Component::getAppendee()
Methods inherited from Peach\Markup\Component
accept()
PEACH2 API documentation generated by ApiGen