JavaScript Editor Javascript validator     Web page editor 


HTML_QuickForm::addGroupRule() -- Adds a validation rule for the given group


require_once 'HTML/QuickForm.php';

void HTML_QuickForm::addGroupRule (string $group, mixed $arg1 [, string $type = '' [, string $format = '' [, int $howmany = 0 [, string $validation = 'server' [, bool $reset = FALSE]]]]])


Adds a validation rule for the given group of elements

Only groups with a name can be assigned a validation rule. Use addGroupRule() when you need to validate elements inside the group. Also use addRule() if you need to validate the group as a whole.


string $group

Form group name

mixed $arg1

Array for multiple elements or error message string for one element. If this is the array, its structure is the following:
array (
    'element name or index' => array(
        array(rule data),
        array(rule data)
    'element name or index' => array(
        array(rule data),
        array(rule data)
rule data here matches the parameters' order and meaning for addRule() method.

Note: If this parameter is an array, all the subsequent parameters are ignored. You should pass all the modifiers for the rules being added within this array (see the example below).

string $type

(optional) Rule type. Use getRegisteredRules() to get types. You can also pass a classname for a descendant of HTML_QuickForm_Rule or an instance of such class.

string $format

(optional) Required for extra rule data

integer $howmany

(optional) How many valid elements should be in the group

string $validation

(optional)Where to perform validation: "server", "client"

boolean $reset

Client-side: whether to reset the element's value to its original state if validation failed.


Table 47-1. Possible PEAR_Error values

Error codeError messageReasonSolution
QUICKFORM_NONEXIST_ELEMENTGroup '$group' does not exist in HTML_QuickForm::addGroupRule()Tried to add a rule for a non-existant groupCheck the group name spelling
QUICKFORM_NONEXIST_ELEMENTElement '$elementIndex' not found in group '$group' in HTML_QuickForm::addGroupRule()$arg1 is an array and contains an index for an element not present in a groupCheck the element index spelling
QUICKFORM_INVALID_RULERule '$type' is not registered in HTML_QuickForm::addGroupRule()Rule is not known to QuickFormCheck rule type spelling or use HTML_QuickForm::registerRule().


since 2.5

This function can not be called statically.


JavaScript Editor Javascript validator     Web page editor