HTML_Common2
[ class tree: HTML_Common2 ] [ index: HTML_Common2 ] [ all elements ]

Class: HTML_Common2

Source Location: /HTML_Common2-2.1.0/HTML/Common2.php

Class Overview


Base class for HTML classes


Author(s):

Version:

  • Release: 2.1.0

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 59]
Base class for HTML classes

Implements methods for working with HTML attributes, parsing and generating attribute strings. Port of HTML_Common class for PHP4 originally written by Adam Daniel with contributions from numerous other developers.



[ Top ]


Class Variables

$attributes = array()

[line 65]

Associative array of attributes
  • Access: protected

Type:   array


[ Top ]

$watchedAttributes = array()

[line 73]

Changes to attributes in this list will be announced via onAttributeChange()

method rather than performed by HTML_Common2 class itself


Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 235]

HTML_Common2 __construct( [array|string $attributes = null])

Class constructor, sets default attributes
  • Access: public

Parameters:

array|string   $attributes     Array of attribute 'name' => 'value' pairs or HTML attribute string

[ Top ]

addClass   [line 436]

HTML_Common2 addClass( string|array $class)

Adds the given CSS class(es) to the element
  • Access: public

Parameters:

string|array   $class     Class name, multiple class names separated by whitespace, array of class names

[ Top ]

getAttribute   [line 269]

string|null 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 309]

array|string getAttributes( [bool $asString = false])

Returns the attribute array or string
  • Access: public

Parameters:

bool   $asString     Whether to return attributes as string

[ Top ]

getAttributesString   [line 219]

string getAttributesString( $attributes)

Creates HTML attribute string from array
  • Return: Attribute string
  • Access: protected

Parameters:

array   $attributes     Attribute array

[ Top ]

getComment   [line 410]

string getComment( )

Returns the comment associated with the element
  • Access: public

[ Top ]

getIndent   [line 387]

string getIndent( )

Returns the string to indent the element
  • Access: protected

[ Top ]

getIndentLevel   [line 377]

int getIndentLevel( )

Gets the indentation level
  • Access: public

[ Top ]

getOption   [line 133]

mixed getOption( [string $name = null])

Returns global option(s)
  • Return: Option value, null if option does not exist, array of all options if $name is not given
  • Access: public

Parameters:

string   $name     Option name

[ Top ]

hasClass   [line 422]

bool hasClass( string $class)

Checks whether the element has given CSS class
  • Access: public

Parameters:

string   $class     CSS Class name

[ Top ]

mergeAttributes   [line 326]

HTML_Common2 mergeAttributes( array|string $attributes)

Merges the existing attributes with the new ones
  • Access: public

Parameters:

array|string   $attributes     Array of attribute 'name' => 'value' pairs or HTML attribute string

[ Top ]

offsetExists   [line 516]

boolean offsetExists( string $offset)

Whether or not an offset (HTML attribute) exists

Parameters:

string   $offset     An offset to check for.

[ Top ]

offsetGet   [line 530]

string|null offsetGet( string $offset)

Returns the value at specified offset (i.e. attribute name)

Parameters:

string   $offset     The offset to retrieve.

[ Top ]

offsetSet   [line 545]

void offsetSet( string $offset, string $value)

Assigns a value to the specified offset (i.e. attribute name)

Parameters:

string   $offset     The offset to assign the value to
string   $value     The value to set

[ Top ]

offsetUnset   [line 564]

void offsetUnset( string $offset)

Unsets an offset (i.e. removes an attribute)

Parameters:

string   $offset     The offset to unset

[ Top ]

onAttributeChange   [line 504]

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 149]

array parseAttributes( string $attrString)

Parses the HTML attributes given as string
  • Return: An associative array of attributes
  • Access: protected

Parameters:

string   $attrString     HTML attribute string

[ Top ]

prepareAttributes   [line 182]

array prepareAttributes( string|array $attributes)

Creates a valid attribute array from either a string or an array
  • Return: An associative array of attributes
  • Access: protected

Parameters:

string|array   $attributes     Array of attributes or HTML attribute string

[ Top ]

removeAttribute   [line 346]

HTML_Common2 removeAttribute( string $attribute)

Removes an attribute
  • Access: public

Parameters:

string   $attribute     Name of attribute to remove

[ Top ]

removeAttributeArray   [line 207]

void removeAttributeArray( &$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 ]

removeClass   [line 462]

HTML_Common2 removeClass( string|array $class)

Removes the given CSS class(es) from the element
  • Access: public

Parameters:

string|array   $class     Class name, multiple class names separated by whitespace, array of class names

[ Top ]

setAttribute   [line 248]

HTML_Common2 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 283]

HTML_Common2 setAttributes( string|array $attributes)

Sets the attributes
  • Access: public

Parameters:

string|array   $attributes     Array of attribute 'name' => 'value' pairs or HTML attribute string

[ Top ]

setComment   [line 399]

HTML_Common2 setComment( string $comment)

Sets the comment for the element
  • Access: public

Parameters:

string   $comment     String to output as HTML comment

[ Top ]

setIndentLevel   [line 363]

HTML_Common2 setIndentLevel( int $level)

Sets the indentation level
  • Access: public

Parameters:

int   $level     Indentation level

[ Top ]

setOption   [line 110]

void setOption( string|array $nameOrOptions, [mixed $value = null])

Sets global option(s)
  • Access: public

Parameters:

string|array   $nameOrOptions     Option name or array ('option name' => 'option value')
mixed   $value     Option value, if first argument is not an array

[ Top ]

__toString   [line 489]

string __toString( )

Returns the HTML representation of the element

This magic method allows using the instances of HTML_Common2 in string contexts

  • Abstract:
  • Access: public

[ Top ]


Documentation generated on Sun, 08 Apr 2012 16:30:02 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.