Docs For Class HTML

__construct (Constructor) [line 193]

HTML_Common2 __construct(
[mixed
$attributes = null])

Class constructor, sets default attributes

Access: public

Parameters:

mixed $attributes — Array of attribute 'name' => 'value' pairs or HTML attribute string

[ Top ]

display [line 374]

void display(
)

Displays the element

Deprecated: Deprecated, using echo $obj; will work just as well
Access: public

[ Top ]

getAttribute [line 223]

string getAttribute(
string
$name)

Returns the value of an attribute

Return: Attribute value, null if attribute does not exist
Access: public

Parameters:

string $name — Attribute name

[ Top ]

getAttributes [line 258]

mixed getAttributes(
[bool
$asString = false])

Returns the attribute array or string

Return: Either an array or string of attributes
Access: public

Parameters:

bool $asString — Whether to return attributes as string

[ Top ]

getAttributesString [line 176]

string getAttributesString(
array
$attributes)

Creates HTML attribute string from array

Return: Attribute string
Access: protected

Parameters:

array $attributes — Attribute array

[ Top ]

getComment [line 346]

string getComment(
)

Returns the comment associated with the element

Access: public

[ Top ]

getIndent [line 326]

string getIndent(
)

Returns the string to indent the element

Access: protected

[ Top ]

getIndentLevel [line 316]

int getIndentLevel(
)

Gets the indentation level

Access: public

[ Top ]

getOption [line 95]

mixed getOption(
string
$name)

Gets a global option

Return: Option value, null if option does not exist
Access: public

Parameters:

string $name — Option name

[ Top ]

mergeAttributes [line 272]

void mergeAttributes(
mixed
$attributes)

Merges the existing attributes with the new ones

Access: public

Parameters:

mixed $attributes — Array of attribute 'name' => 'value' pairs or HTML attribute string

[ Top ]

onAttributeChange [line 392]

void onAttributeChange(
string
$name, [string
$value = null])

Called if trying to change an attribute with name in $watchedAttributes

This method is called for each attribute whose name is in the $watchedAttributes array and which is being changed by setAttribute(), setAttributes() or mergeAttributes() or removed via removeAttribute(). Note that the operation for the attribute is not carried on after calling this method, it is the responsibility of this method to change or remove (or not) the attribute.

Access: protected

Parameters:

string	`$name`	—	Attribute name
string	`$value`	—	Attribute value, null if attribute is being removed

[ Top ]

parseAttributes [line 106]

array parseAttributes(
string
$attrString)

Parses the HTML attributes given as string

Return: An associative aray of attributes
Access: protected

Parameters:

string $attrString — HTML attribute string

[ Top ]

prepareAttributes [line 138]

array prepareAttributes(
mixed
$attributes)

Creates a valid attribute array from either a string or an array

Return: An associative aray of attributes
Access: protected

Parameters:

mixed $attributes — Array of attributes or HTML attribute string

[ Top ]

removeAttribute [line 289]

void removeAttribute(
string
$attribute)

Removes an attribute

Access: public

Parameters:

string $attribute — Name of attribute to remove

[ Top ]

removeAttributeArray [line 162]

void removeAttributeArray(
array
&$attributes, string
$name)

Removes an attribute from an attribute array

Access: protected

Parameters:

array	`&$attributes`	—	Attribute array
string	`$name`	—	Name of attribute to remove

[ Top ]

setAttribute [line 204]

void setAttribute(
string
$name, [string
$value = null])

Sets the value of the attribute

Access: public

Parameters:

string	`$name`	—	Attribute name
string	`$value`	—	Attribute value (will be set to $name if omitted)

[ Top ]

setAttributes [line 234]

void setAttributes(
mixed
$attributes)

Sets the attributes

Access: public

Parameters:

mixed $attributes — Array of attribute 'name' => 'value' pairs or HTML attribute string

[ Top ]

setComment [line 336]

void setComment(
string
$comment)

Sets the comment for the element

Access: public

Parameters:

string $comment —

[ Top ]

setIndentLevel [line 303]

void setIndentLevel(
int
$level)

Sets the indentation level

Access: public

Parameters:

int $level —

[ Top ]

setOption [line 80]

void setOption(
string
$name, mixed
$value)

Sets a global option

Access: public

Parameters:

string	`$name`	—	Option name
mixed	`$value`	—	Option value

[ Top ]

toHtml [line 356]

string toHtml(
)

Returns the HTML representation of the element

Abstract:
Access: public

[ Top ]

__toString [line 364]

string __toString(
)

A magic method to let the object work with echo and print constructs

See: toHtml()
Access: public

[ Top ]

Class: HTML_Common2

Class Overview

Author(s):

Version:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$attributes = array()

$watchedAttributes = array()

Method Detail

__construct (Constructor) [line 193]

Parameters:

display [line 374]

getAttribute [line 223]

Parameters:

getAttributes [line 258]

Parameters:

getAttributesString [line 176]

Parameters:

getComment [line 346]

getIndent [line 326]

getIndentLevel [line 316]

getOption [line 95]

Parameters:

mergeAttributes [line 272]

Parameters:

onAttributeChange [line 392]

Parameters:

parseAttributes [line 106]

Parameters:

prepareAttributes [line 138]

Parameters:

removeAttribute [line 289]

Parameters:

removeAttributeArray [line 162]

Parameters:

setAttribute [line 204]

Parameters:

setAttributes [line 234]

Parameters:

setComment [line 336]

Parameters:

setIndentLevel [line 303]

Parameters:

setOption [line 80]

Parameters:

toHtml [line 356]

__toString [line 364]