ElementInterface Interface Reference

Inheritance diagram for ElementInterface:

Public Member Functions
	attr ($name=NULL)
	option ()
	content ()
	source ()
	outerSource ()

Detailed Description

A tag occurrence as processed by tag plugins.

Definition at line 13 of file ElementInterface.php.

Member Function Documentation

attr

(

$name = NULL

)

Retrieve a particular attribute of the element.

[tag NAME=VALUE]...[/tag]

Parameters

string

$name

The name of the attribute, or NULL.

Returns

string | array The value of this attribute, or NULL if it isn't set. If no name was given, all attributes are returned in an array.

Implemented in Element.

Referenced by TemplateTagPlugin\process(), XBBCodeTestPlugin\process(), ImageTagPlugin\process(), and TableTagPlugin\process().

content

(

)

Retrieve the content of the tag.

[tag]CONTENT[/tag]

All BBCode inside this content will already be rendered.

Returns

string The tag content.

Implemented in Element.

Referenced by TemplateTagPlugin\process(), XBBCodeTestPlugin\process(), ImageTagPlugin\process(), and TableTagPlugin\process().

option

(

)

Retrieve the option-type attribute of the element.

[tag=OPTION]...[/tag]

Returns

string The value of the option.

Implemented in Element.

Referenced by TemplateTagPlugin\process().

outerSource

(

)

Retrieve the complete source, including the opening and closing tags.

Returns

string The tag source.

Implemented in Element.

Referenced by TemplateTagPlugin\process(), and NullTagPlugin\process().

source

(

)

Retrieve the content source of the tag.

[tag]CONTENT[/tag]

This is the content of the tag before rendering.

Returns

string The tag content source.

Implemented in Element.

Referenced by TemplateTagPlugin\process().

---

The documentation for this interface was generated from the following file:

• xbbcode/src/ElementInterface.php