icms_form_elements_Tray

Notice: Wiki was automatic generated from project sources as project API documentation. Do not edit manually!

icms_form_elements_Tray

A group of form elements

• Class name: icms_form_elements_Tray
• Namespace:
• Parent class: icms_form_Element

Properties

$_elements

private array $_elements = array()

array of form element objects

• Visibility: private

$_required

private array $_required = array()

required elements

• Visibility: private

$_delimeter

private string $_delimeter

HTML to separate the elements

• Visibility: private

Methods

__construct

mixed icms_form_elements_Tray::__construct(string caption, string delimeter, string name)

constructor

• Visibility: public

Arguments

• caption string - <p>Caption for the group.</p>
• delimeter string - <p>HTML to separate the elements</p>
• name string - <p>Name of tray</p>

isContainer

bool icms_form_elements_Tray::isContainer()

Is this element a container of other elements?

• Visibility: public

isRequired

bool icms_form_elements_Tray::isRequired()

Find out if there are required elements.

• Visibility: public

addElement

mixed icms_form_elements_Tray::addElement(\icms_form_Element formElement, bool required)

Add an element to the group

• Visibility: public

Arguments

• formElement icms_form_Element - <p>Form element to add</p>
• required bool - <p>Is required?</p>

getRequired

\icms_form_Element[] icms_form_elements_Tray::getRequired()

get an array of "required" form elements

• Visibility: public

getElements

\icms_form_Element[] icms_form_elements_Tray::getElements(bool recurse)

Get an array of the elements in this group

• Visibility: public

Arguments

• recurse bool - <p>get elements recursively?</p>

getDelimeter

string icms_form_elements_Tray::getDelimeter(bool encode)

Get the delimiter of this group

• Visibility: public

Arguments

• encode bool - <p>To sanitizer the text?</p>

render

string icms_form_elements_Tray::render()

prepare HTML to output this group

• Visibility: public