Docs For Class Taglib

Taglib_CustomElement __construct(
Taglib_CustomElement
$parent, [array
$attrs = array()])

コンストラクタです。

親のエレメントを渡した場合、作成されたインスタンスは指定された親エレメントの子エレメントリストに追加されます。

Tags:

access:

public

Overridden in child classes as:

Taglib_RootElement::__construct(): コンストラクタです。

Parameters:

Taglib_CustomElement	$parent	親エレメント
array	$attrs	属性が格納された配列

[ Top ]

string doBody(
)

開始タグと終了タグに挟まれた範囲によって生成されるHTMLを返します。

一般に開始タグと終了タグに挟まれた範囲はエレメントが保持している子エレメントの出力結果の総和になります。従ってdoBodyメソッドは実装上の手間を省くために最低限で一般的な処理を用意しています。

特殊な実装を行いたい場合のみ、doBodyメソッドをオーバライドして下さい。

Tags:

return:	生成された開始タグと終了タグに挟まれた範囲に相当するHTML
access:	public

Overridden in child classes as:

Taglib_Text::doBody(): 開始タグと終了タグに挟まれた範囲によって生成されるHTMLを返します。

[ Top ]

string doEndTag(
)

エレメントの終了タグによって生成されるHTMLを返します。

Tags:

return:	生成された終了タグに相当するHTML
abstract:
access:	public

Overridden in child classes as:

Taglib_RootElement::doEndTag(): エレメントの終了タグによって生成されるHTMLを返します。

Taglib_Text::doEndTag(): エレメントの終了タグによって生成されるHTMLを返します。

[ Top ]

string doStartTag(
)

エレメントの開始タグによって生成されるHTMLを返します。

Tags:

return:	生成された開始タグに相当するHTML
abstract:
access:	public

Overridden in child classes as:

Taglib_RootElement::doStartTag(): エレメントの開始タグによって生成されるHTMLを返します。

Taglib_Text::doStartTag(): エレメントの開始タグによって生成されるHTMLを返します。

[ Top ]

mixed getAttr(
string
$attr, [mixed
$def = false])

開始タグに記述されている属性値を取得します。

開始タグに記述されている、指定の属性名の属性値を取得します。属性名は内部的には全て小文字で扱われていることに注意して下さい。これは即ち世間一般のXMLと異なり属性名に大文字と小文字の区別がないことを表します。

指定の属性名の属性値が見付からない場合には$def引数の値を返します。

Tags:

return:	属性値
access:	public

Parameters:

string	$attr	属性名
mixed	$def	属性値が見付からなかった場合の値

[ Top ]

Taglib_CustomElement getChild(
int
$index)

子エレメントを取得します。

指定のインデックス番目の子エレメントを返します。インデックスは0xA欠etChildCount()-1の範囲で指定します。インデックス範囲が不正の場合、EIlligalParameterException例外が発生します。

Tags:

return:	子エレメント
access:	public

Parameters:

int

$index

子エレメントのインデックス

[ Top ]

int getChildCount(
)

エレメントが保持している子エレメントの個数を返します。

Tags:

return:	子エレメントの個数
access:	public

[ Top ]

string getName(
)

エレメント名を取得します。

Tags:

return:	エレメント名
access:	public

[ Top ]

string getNamespace(
)

名前空間を取得します。

Tags:

return:	名前空間
access:	public

[ Top ]

Taglib_CustomElement getParent(
)

親のエレメントを返します。

エレメントを保持している親のエレメントを返します。親エレメントが存在しない（ルート要素）の場合にはnullを返します。

Tags:

return:	親のエレメント
access:	public

[ Top ]

void match(
string
$namespace, string
$name)

エレメントが指定の名前空間のエレメント名と一致するか否かを判定して返します。

Tags:

access:

public

Parameters:

string	$namespace	名前空間
string	$name	エレメント名

[ Top ]

string perform(
)

カスタムエレメントによって生成されるHTMLを返します。

一般にカスタムエレメントが生成するHTMLは開始タグが生成するHTMLと、終了タグが生成するHTML、そしてタグに挟まれた範囲によって生成されるHTMLの総和です。 performメソッドはdoStartTag、doBody、doEndTagメソッドが返す値を順次文字列に結合して、その結果を返します。

Tags:

return:	生成されたエレメントによって生成されるHTML
access:	public

[ Top ]

void setAttr(
string
$attr, mixed
$value)

属性値を設定します。

属性名は内部的には全て小文字で扱われていることに注意して下さい。これは即ち世間一般のXMLと異なり属性名に大文字と小文字の区別がないことを表します。

Tags:

access:

public

Parameters:

string	$attr	属性名
mixed	$value	属性値

[ Top ]

void setName(
string
$name)

エレメント名を設定します。

Tags:

access:

public

Parameters:

string

$name

エレメント名

[ Top ]

void setNamespace(
string
$namespace)

名前空間を設定します。

Tags:

access:

public

Parameters:

string

$namespace

名前空間

[ Top ]

Class: Taglib_CustomElement

Class Overview

Author(s):

Methods

Child classes:

Class Details

Tags:

Class Methods

constructor __construct [line 84]

Tags:

Parameters:

method doBody [line 271]

Tags:

method doEndTag [line 285]

Tags:

method doStartTag [line 259]

Tags:

method getAttr [line 212]

Tags:

Parameters:

method getChild [line 137]

Tags:

Parameters:

method getChildCount [line 122]

Tags:

method getName [line 171]

Tags:

method getNamespace [line 151]

Tags:

method getParent [line 112]

Tags:

method match [line 192]

Tags:

Parameters:

method perform [line 245]

Tags:

method setAttr [line 231]

Tags:

Parameters:

method setName [line 181]

Tags:

Parameters:

method setNamespace [line 161]

Tags:

Parameters: