pm_Form:: addVars Method

Adds an array of variables (pairs like {variable, value}) to the instance of class pm_Form.

Syntax

Parameters

vars

      An array of variables that should be added to the instance of class pm_Form.

Returns

A boolean which is true if the passed in array of variables has been merged with pm_Form::vars successfully, false otherwise.

Remarks

The function fails if the passed in parameter is not an array. In this case the function throws a special error and returns false.

The array of variables passed in via the vars parameter should be formatted as array(<variable> => <value>, …), e.g. array('TITLE' => 'Administering FTP', 'USER' => 'Admin'). The array of variables stored in the instance of class pm_Form should resolve all variables present in the template files added to array of templates of this pm_Form instance.