Class: Cnz_Html_Element

Source Location: /Html/Element.php

Child classes:

Cnz_Html_Form_Abstract: HTML Form Abstract class

Cnz_Html_Form_Item: HTML Form Item class

Cnz_Html_Template: HTML Template class

Cnz_Html_Head: HTML Head class

Cnz_Html_Document: HTML Document class

Cnz_Html_Menu: HTML Menu class

Cnz_Html_Table: HTML Table class

Cnz_Html_Menu_Item: HTML Menu Item class

Cnz_Html_Table_Button: HTML Table Button class

Class Details

[line 94]
HTML Element class

This is an abstract base class for all high-level HTML display elements. Its primary function is to generate the configuration section names and style names in a standardized way.

The configuration section name is generated as

   HtmlType[-name]

where type is third field of class name and name is the element name passed to the constructor. For example, Cnz_Html_Form_Checkbox with a name of pay would yield HtmlFormPay.

The style name is generated as

   type[Subtype][-name][-suffix]

This design allows for a single default configuration section and/or style, with the ability to override the defaults for special elements.

Some elements will have special style suffixes (e.g., hilighted table rows). For example, a highlighted table row with the custom name team would have the following returned by genStyles().

   table table-team table-hilight table-team-hilight

Subtypes are only used for situations where the same HTML tag has different structural roles in the same complex element. For example, a form will use a div block to format the label for a field as well as the field itself, but different styling will normally be desired for these. For example, a form label with the custom name pay would have the following returned by genStyles().

   formLabel formLabel-pay

This allows the definition of default styles with overrides for named tables and special cases. Remember that the order of the style names in the class attribute is irrelevant. The order in the style sheet is what matters. The more specific styles should occur below the more general styles.

HTML id values can also be generated with genId(). This is generated as

   type[-name]

Tags:

Type:

string

[ Top ]

Class Methods

constructor __construct [line 152]

void __construct(
[
&$options = array()], array
$options)

Option fields:

string name Element name Cnz_Element master Master element string filename Configuration filename boolean config Has custom configuration boolean style Has custom style

Configuration fields: none

Parameters:

array	$options	Associative array of common options.
array	&$options

[ Top ]

method display [line 134]

void display(
[string
$style = NULL])

Tags:

abstract:
access:	public

Overridden in child classes as:

Cnz_Html_Form_Abstract::display()

Cnz_Html_Form_Group::display()

Cnz_Html_Form::display()

Cnz_Html_Form_Password::display()

Cnz_Html_Form_Select::display()

Cnz_Html_Form_Checkbox::display()

Cnz_Html_Form_Radio::display()

Cnz_Html_Form_File::display()

Cnz_Html_Form_Text::display()

Cnz_Html_Form_Hidden::display()

Cnz_Html_Form_Textarea::display()

Cnz_Html_Template::display()

Cnz_Html_Head::display()

Cnz_Html_Document::display()

Cnz_Html_Menu::display()

Cnz_Html_Table::display()

Cnz_Html_Menu_Item::display()

Cnz_Html_Table_Button::display()

Parameters:

string

$style

Value for outermost style attribute

[ Top ]

method genId [line 210]

string genId(
[string
$number = NULL])

Generates the id attribute value.

Tags:

return:	Value for use with HTML id attribute
access:	protected

Parameters:

string

$number

[ Top ]

method genStyles [line 236]

string genStyles(
[string
$subtype = NULL], [string
$suffix = NULL])

Generates the class attribute value.

Tags:

return:	List of styles for use with HTML class attribute
access:	protected

Parameters:

string	$subtype	Style name subtype
string	$suffix	Style name suffix

[ Top ]

method getName [line 123]

string getName(
)

Tags:

return:	Name
access:	public

Overridden in child classes as:

Cnz_Html_Table_Button::getName()

[ Top ]

Class Constants

CONFIG_PREFIX = 'Html'

[line 96]

[ Top ]

STYLE_SEPARATOR = '-'

[line 97]

[ Top ]

Documentation generated on Thu, 19 Jul 2007 15:02:01 -0400 by phpDocumentor 1.4.0RC2

Class: Cnz_Html_Element

Class Overview

Author(s):

Variables

Constants

Methods

Child classes:

Class Details

Tags:

Class Variables

$config = NULL

Tags:

$configFile = NULL

Tags:

$configSection = NULL

Tags:

$customConfigFlag = false

Tags:

$customStyleFlag = false

Tags:

$master = NULL

Tags:

$name = NULL

Tags:

Class Methods

constructor __construct [line 152]

Tags:

Parameters:

method display [line 134]

Tags:

Parameters:

method genId [line 210]

Tags:

Parameters:

method genStyles [line 236]

Tags:

Parameters:

method getName [line 123]

Tags:

Class Constants

CONFIG_PREFIX = 'Html'

STYLE_SEPARATOR = '-'