PEAR Manual
PrevNext

HTML_QuickForm::addGroup()

HTML_QuickForm::addGroup() -- Adds an element group

Synopsis

require_once 'HTML/QuickForm.php';

object &HTML_QuickForm::addGroup (array $elements [, string $name = NULL [, mixed $groupLabel = '' [, string $separator = NULL [, string $appendName = TRUE]]]])

Description

Adds an element group.

Parameter

array $elements

array of elements composing the group

string $name

(optional) group name

mixed $groupLabel

(optional) group label

mixed $separator

(optional) string or array of strings to separate elements

boolean $appendName

(optional) specify whether the group name should be used in the form element name: groupName[elementName] vs elementName

Return value

return reference to added group of elements

Throws

Table 31-1. Possible PEAR_Error values

Error codeError messageReasonSolution
QUICKFORM_INVALID_ELEMENT_NAMEElement '$elementName' already exists in HTML_QuickForm::addElement()Tried to add a group having a name of an existing elementChoose a different name for a group

Note

since 2.8

This function can not be called statically.

Example

Example 31-1. Using addGroup()

<?php

$group[] =& HTML_QuickForm::createElement('text', 'first', 'First');
$group[] =& HTML_QuickForm::createElement('text', 'last', 'Last');

$form->addGroup($group, 'name', 'Name:', ',&nbsp;');

?>
PrevHomeNext
HTML_QuickFormUpClass Summary HTML_QuickForm_group