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 HtmlHelper

HTML の出力に特化した Helper です. XML 宣言, DOCTYPE 宣言, select 要素やコメントの出力機能などを備えています.

このクラスは通常コンストラクタではなく newInstance() メソッドを使って初期化を行います. フォーマットのきめ細やかなカスタマイズを行いたい場合のみコンストラクタから生成してください.

Peach\Markup\AbstractHelper implements Peach\Markup\Helper
Extended by Peach\Markup\HtmlHelper
Namespace: Peach\Markup
Located at Peach/Markup/HtmlHelper.php
Methods summary
public
# __construct( Peach\Markup\Helper $parent, string $docType = null, boolean $isXhtml = null )

指定された Helper オブジェクトを利用して HTML タグの出力を行う, 新しい HtmlHelper オブジェクトを構築します.

指定された Helper オブジェクトを利用して HTML タグの出力を行う, 新しい HtmlHelper オブジェクトを構築します.

第 2 引数の文字列は docType() メソッドの返り値に関係します. もしも未指定の場合, このオブジェクトが docType() メソッドで生成する Component は何も出力しません. 第 3 引数のフラグは xmlDec() メソッドの返り値に関係します. true の場合は xmlDec() が返す Component は XML 宣言を出力しますが, それ以外の場合は何も出力しません.

Parameters

$parent
カスタマイズ対象の Helper オブジェクト
$docType
この Helper が生成する文書型宣言の文字列
$isXhtml
XHTML として生成する場合のみ true

Overrides

Peach\Markup\AbstractHelper::__construct()
public static Peach\Markup\HtmlHelper
# newInstance( string $mode = null )

指定されたモードで HtmlHelper オブジェクトを生成します. 引数には以下の定数を指定してください.

指定されたモードで HtmlHelper オブジェクトを生成します. 引数には以下の定数を指定してください.

  • HtmlHelper::MODE_HTML4_STRICT
  • HtmlHelper::MODE_HTML4_TRANSITIONAL
  • HtmlHelper::MODE_XHTML1_STRICT
  • HtmlHelper::MODE_XHTML1_TRANSITIONAL
  • HtmlHelper::MODE_XHTML1_1
  • HtmlHelper::MODE_HTML5

Parameters

$mode

Returns

Peach\Markup\HtmlHelper
public Peach\Markup\Component
# xmlDec( )

XML 宣言をあらわす Component を返します. もしもこの HtmlHelper が XHTML モードで生成された場合, このメソッドは以下のコードを出力する Peach\Markup\Code オブジェクトを返します.

<?xml version="1.0" encoding="UTF-8"?>

XML 宣言をあらわす Component を返します. もしもこの HtmlHelper が XHTML モードで生成された場合, このメソッドは以下のコードを出力する Peach\Markup\Code オブジェクトを返します.

<?xml version="1.0" encoding="UTF-8"?>

それ以外は Peach\Markup\None オブジェクトを返します.

Returns

Peach\Markup\Component
XML 宣言をあらわす Code オブジェクトまたは None
public Peach\Markup\Component
# docType( )

文書型宣言をあらわす Code オブジェクトを返します. 返り値の Component が出力するコードは, このオブジェクトの初期化時に指定されたモード (あるいはコンストラクタの第 2 引数) に応じて異なる文書型宣言となります.

文書型宣言をあらわす Code オブジェクトを返します. 返り値の Component が出力するコードは, このオブジェクトの初期化時に指定されたモード (あるいはコンストラクタの第 2 引数) に応じて異なる文書型宣言となります.

Returns

Peach\Markup\Component
文書型宣言をあらわす Code オブジェクト. ただし初期化時に指定されていない場合は None
public Peach\Markup\HelperObject
# comment( string|Peach\Markup\Component $contents = null, string $prefix = "", string $suffix = "" )

指定された内容のコメントノードを作成します. 引数にノードを指定した場合, そのノードの内容をコメントアウトします.

指定された内容のコメントノードを作成します. 引数にノードを指定した場合, そのノードの内容をコメントアウトします.

第 2, 第 3 引数にコメントの接頭辞・接尾辞を含めることが出来ます.

Parameters

$contents
コメントにしたいテキストまたはノード
$prefix
コメントの接頭辞
$suffix
コメントの接尾辞

Returns

Peach\Markup\HelperObject
public Peach\Markup\HelperObject
# conditionalComment( string $cond, string|Peach\Markup\Component $contents = null )

IE 9 以前の Internet Explorer で採用されている条件付きコメントを生成します. 以下にサンプルを挙げます.

echo $htmlHelper->conditionalComment("lt IE 7", "He died on April 9, 2014.")->write();

このコードは次の文字列を出力します.

<!--[if lt IE 7]>He died on April 9, 2014.<![endif]-->

第 2 引数を省略した場合は空の条件付きコメントを生成します.

IE 9 以前の Internet Explorer で採用されている条件付きコメントを生成します. 以下にサンプルを挙げます.

echo $htmlHelper->conditionalComment("lt IE 7", "He died on April 9, 2014.")->write();

このコードは次の文字列を出力します.

<!--[if lt IE 7]>He died on April 9, 2014.<![endif]-->

第 2 引数を省略した場合は空の条件付きコメントを生成します.

Parameters

$cond
条件文 ("lt IE 7" など)
$contents
条件付きコメントで囲みたいテキストまたはノード

Returns

Peach\Markup\HelperObject
条件付きコメントを表現する HelperObject
public Peach\Markup\ContainerElement
# createSelectElement( string $current, array $candidates, array $attr = array() )

HTML の select 要素を生成します. 第 1 引数にはデフォルトで選択されている値, 第 2 引数には選択肢を配列で指定します. キーがラベル, 値がそのラベルに割り当てられたデータとなります.

HTML の select 要素を生成します. 第 1 引数にはデフォルトで選択されている値, 第 2 引数には選択肢を配列で指定します. キーがラベル, 値がそのラベルに割り当てられたデータとなります.

引数を二次元配列にすることで, 一次元目のキーを optgroup にすることが出来ます. 以下にサンプルを挙げます.

$candidates = array(
    "Fruit"   => array(
        "Apple"  => 1,
        "Orange" => 2,
        "Pear"   => 3,
        "Peach"  => 4,
    ),
    "Dessert" => array(
        "Chocolate" => 5,
        "Doughnut"  => 6,
        "Ice cream" => 7,
    ),
    "Others" => 8,
);
$select = Html::createSelectElement("6", $candidates, array("class" => "sample", "name" => "favorite"));

この要素を出力すると以下の結果が得られます.

<select class="sample" name="favorite">
    <optgroup label="Fruit">
        <option value="1">Apple</option>
        <option value="2">Orange</option>
        <option value="3">Pear</option>
        <option value="4">Peach</option>
    </optgroup>
    <optgroup label="Dessert">
        <option value="5">Chocolate</option>
        <option value="6" selected>Doughnut</option>
        <option value="7">Ice cream</option>
    </optgroup>
    <option value="8">Others</option>
</select>

Parameters

$current
デフォルト値
$candidates
選択肢の一覧
$attr
追加で指定する属性 (class, id, style など)

Returns

Peach\Markup\ContainerElement
HTML の select 要素
public Peach\Markup\HelperObject
# select( string $current, array $candidates, array $attr = array() )

HTML の select 要素を生成し, 結果を HelperObject として返します. 引数および処理内容は Html::createSelectElement() と全く同じですが, 生成された要素を HelperObject でラップするところが異なります.

HTML の select 要素を生成し, 結果を HelperObject として返します. 引数および処理内容は Html::createSelectElement() と全く同じですが, 生成された要素を HelperObject でラップするところが異なります.

Parameters

$current
デフォルト値
$candidates
選択肢の一覧
$attr
追加で指定する属性 (class, id, style など)

Returns

Peach\Markup\HelperObject

See

Peach\Markup\HtmlHelper::createSelectElement()
Methods inherited from Peach\Markup\AbstractHelper
createElement(), getParentHelper(), tag(), write()
Constants summary
string MODE_HTML4_STRICT

HTML 4.01 Strict のモードです.

HTML 4.01 Strict のモードです.

# "html4s"
string MODE_HTML4_TRANSITIONAL

HTML 4.01 Transitional のモードです.

HTML 4.01 Transitional のモードです.

# "html4t"
string MODE_XHTML1_STRICT

XHTML 1.0 Strict のモードです.

XHTML 1.0 Strict のモードです.

# "xhtml1s"
string MODE_XHTML1_TRANSITIONAL

XHTML 1.0 Transitional のモードです.

XHTML 1.0 Transitional のモードです.

# "xhtml1t"
string MODE_XHTML1_1

XHTML 1.1 のモードです.

XHTML 1.1 のモードです.

# "xhtml1_1"
string MODE_HTML5

HTML5 のモードです.

HTML5 のモードです.

# "html5"
PEACH2 API documentation generated by ApiGen