UIElement Class Reference

Inheritance diagram for UIElement:
CalendarField Captcha CheckBox CustomElement EmailField EmptyElement Label MultiSelectBox PercentField RadioBox SelectBox SubmitButton TextareaField TextField UIElementArray

List of all members.

Public Member Functions

 UIElement ($id, $name, $value, $validations)
 parent ()
 insertBefore ($element)
 insertAfter ($element)
 remove ()
 hide ()
 attr ($attr, $value=null)
 render ()
 reset ()
 registerValidation ($validation)
 validate ($value=false)
 setPOST ($index)
 isValidationSet ($validation)

Public Attributes

 $parent
 $id
 $name
 $value
 $default
 $tooltip
 $validations
 $extraValidations
 $attr
 $colspan = 1

Protected Member Functions

 renderAttr ()

Member Function Documentation

UIElement::attr ( attr,
value = null 
)

Sets the value of an attribute If the $value is null, the value of the attr is instead returned

Parameters:
string $attr The attribute to set/return
string $value The value of the attribute
Returns:
Returns the value of the attribute
UIElement::hide (  ) 

Hides the html in the dom for this UIElement

UIElement::insertAfter ( element  ) 

Inserts another UIElement before this UIElement

Parameters:
UIElement $element
UIElement::insertBefore ( element  ) 

Inserts another UIElement before this UIElement

Parameters:
UIElement $element The UIElement to insert
UIElement::isValidationSet ( validation  ) 

Checks whether a validation is set or not

Parameters:
int $validation Which validation to check for (use constants ie. VALIDATE_NOSPACES)
Returns:
boolean Whether or not the validation is set or not
UIElement::parent (  ) 

Returns this UIElement's parent

Returns:
UIElement this UIElement's parent
UIElement::registerValidation ( validation  ) 

Registers a validation for this UIElements

Parameters:
UIValidation $validation The UIValidation to use
UIElement::remove (  ) 

Removes this UIElement from it's parent

UIElement::renderAttr (  )  [protected]

Returns a string for the attributes as html attributes

Returns:
string The attributes as html attributes
UIElement::reset (  ) 

Resets the UIElement's value to the default, and unsets the $_POST variable's index

Reimplemented in UIElementArray.

UIElement::setPOST ( index  ) 

Sets the specified POST value to this UIElement's value (used for preparing API calls)

Parameters:
string $index The POST value to set
UIElement::validate ( value = false  ) 

Returns an array containing all the failed validations if $value is false, then use the $this->value, otherwise use $value

Parameters:
boolean $value Whether or not to use $this->value or $value
Returns:
array An Array containing all the failed validations

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

Generated on 9 Jan 2025 for The Forum by  doxygen 1.6.1