root/form/form.php

<?php

/*
 * Elgg Forms
 * Kevin Jardine
 * Radagast Solutions
 * http://radagast.biz
 *
 * The main function for rendering forms
 * and validating and storing form submissions.
 *
 */
 
// Load Elgg framework
@require_once("../../includes.php");
    
// Define context
define("context","form");

$form_error_msg = __gettext("Error: this form either does not exist or you do not have permission to view it.");
$form_error_title = __gettext("Error");

$action = optional_param('action','');
$preview = optional_param('preview','');

$form_id = optional_param('id',0,PARAM_INT);

$form = form_get_form_definition($form_id);

$form_values = optional_param('form_values','');

$preview_explanation = '<b>'.__gettext("Preview").':</b> '
    .__gettext("This is a form preview - submitting the results below will show what would be saved to the database,"
    ." but will not actually save the values.");

$fielderror = false;

if ($form) {
    if ((isloggedin() && run("users:flags:get", array("admin", $_SESSION['userid']))) || run("users:access_level_check",$form->access)) {
        $title = $form->title;
    
        if ($action == 'submit') {
            // process the form submission
            
            $result = form_validate($form,$form_values);
                 
            $fielderror = $result->problem;
            
            if ($fielderror) {
                $problem_fields = $result->data->problem_fields;
                $problem_field_titles = $result->data->problem_field_titles;
                $messages[] = __gettext("Error: please correct these missing or invalid fields:")." ".implode(", ",$problem_field_titles);
            } else {
                $body = form_save($result->data,$_SESSION['userid'],$preview);
                $body = '<p>'.$form->response_text.'</p>'.$body;
                if ($form->notification) {
                    $msg = "Someone has submitted the form '$title'\n\n"
                            ."To export the form results or turn form notification off, please login as a site administrator and visit:\n\n"
                            ."{$CFG->wwwroot}mod/form/index.php";
                    $subject = "Form submission for '$title'";
                    notify_user($form->owner, $subject, $msg);
                }
            }
        }
        
        if ($action != 'submit' || $fielderror) {    
        
            $body = '<p>'.$form->description.'</p>';
            if ($preview) {
                $body .= '<p>'.$preview_explanation.'</p>';
            }
                
            $body .= '<form action="'.$CFG->wwwroot.'mod/form/form.php" method="post">';
            foreach($form->fields as $field) {        
                 // copy array element with default to ''
                $flabel = !empty($field->title) ? $field->title : '';
                $fname  = !empty($field->internal_name) ? $field->internal_name : '';
                $ftype  = !empty($field->field_type) ? $field->field_type : '';
                $fblurb = !empty($field->description) ? $field->description : '';
                
                $value = new stdClass;
                if ($form_values && isset($form_values[$fname])) {
                    $value->value = $form_values[$fname];
                } else {
                    $value->value = "";
                }
                
                if (isset($problem_fields) && is_array($problem_fields) && in_array($fname,$problem_fields)) {
                    if ($field->required) {
                        $name = "<label for=\"$fname\"><b><span style=\"color:red\">* {$flabel}</span></b>";
                    } else {
                        $name = "<label for=\"$fname\"><b><span style=\"color:red\">{$flabel}</span></b>";
                    }
                } elseif ($field->required) {                    
                    $name = "<label for=\"$fname\"><b>* {$flabel}</b>";
                } else {
                    $name = "<label for=\"$fname\"><b>{$flabel}</b>";
                }
                if (!empty($fblurb)) {
                    $name .= "<br /><i>" . $fblurb . "</i>";
                }
                $name .= '</label>';
                
                if ($ftype == 'choices') {
                    $options1 = array();
                    $field_options = get_records_sql("SELECT * FROM {$CFG->prefix}form_fields_choice WHERE field_id = {$field->ident} AND group_id = 1 ORDER BY ident ASC");
                    if ($field_options) {
                        foreach($field_options AS $field_option) {
                            if ($field_option->label) {
                                $options1[$field_option->value] = $field_option->label;
                            } else {
                                $options1[] = $field_option->value;
                            }
                        }
                    }
                    if ($field->choice_type == 'radio_group') {
                        $options2 = array();
                        $field_options = get_records_sql("SELECT * FROM {$CFG->prefix}form_fields_choice WHERE field_id = {$field->ident} AND group_id = 2 ORDER BY ident ASC");
                        if ($field_options) {
                            foreach($field_options AS $field_option) {
                                if ($field_option->label) {
                                    $options2[$field_option->value] = $field_option->label;
                                } else {
                                    $options2[] = $field_option->value;
                                }
                            }
                        }
                    } else if ($field->choice_type == 'select') {
                        $display_type = 'profile_select';
                    } else {
                        if ($field->orientation == 'horizontal') {
                            $display_type = 'profile_'.$field->choice_type;
                        } else {
                            $display_type = 'profile_vertical_'.$field->choice_type;
                        }
                    }
                    
                    $ftype = 'display_type_'.$fname;
                    
                    //prfext_display($ftype,$display_type,$field->is_keyword_tag,$field->default_value,$options);
                    if ($field->choice_type == 'radio_group') {
                        prfext_display($ftype,'profile_radio_group',$field->is_keyword_tag,$field->default_value,array($options1,$options2));
                    } else { 
                        prfext_display($ftype,$display_type,$field->is_keyword_tag,$field->default_value,$options1);
                    }
                }           
                            
                $column1 = display_input_field(array("form_values[" . $fname . "]",$value->value,$ftype,$fname,@$value->ident,$page_owner));
                
                $body .= templates_draw(array(
                                               'context' => 'databoxvertical',
                                               'name'    => $name,
                                               'contents' => $column1
                                               ));
            }
            #TODO - make the submit button text configurable
            $buttonValue = __gettext("Submit"); // gettext variable
        
            $body .= <<< END
              <p>
                  <input type="hidden" name="action" value="submit" />
                  <input type="hidden" name="id" value="{$form->ident}" />
                  <input type="hidden" name="preview" value="$preview" />
                  <input type="submit" value="$buttonValue" />
              </p>
            </form>
END;
        }
    } else {
        $title = $form_error_title;
        $body = $form_error_msg;
    }

} else {
        $title = $form_error_title;
        $body = $form_error_msg;
}

// Output to the screen
$body = templates_draw(array(
                'context' => 'contentholder',
                'title' => $title,
                'body' => $body
            )
);

echo templates_page_draw( array(
                $title, $body
            )
);
            
// validate fields
// returns a list of problem fields and titles
// if there is an error, or the data ready for insertion otherwise

function form_validate($form,$form_values) {

    global $CFG;
        
    $missing_fields = array();
    $missing_field_titles = array();
    $invalid_fields = array();
    $invalid_field_titles = array();
    $validated_values = array();
    
    foreach($form->fields as $field) {
        $fd = new StdClass;
        $fname = $field->internal_name;
        $flabel = $field->title;
        $frequired = $field->required;
        $ftype = $field->field_type;
        if (isset($form_values[$fname])) {
            $value = trim($form_values[$fname]);
        }
      
        if (!empty($value)) {
            
            // non-empty field, so get it ready to save                      

            $fd->name   = $fname;
            $fd->value  = $value;
            $fd->profile = $field->profile;
            $fd->field_id = $field->ident;
            $fd->map_id = $field->map_id;
            $fd->form_id = $form->ident;
            $fd->field_type = $ftype;
            $fd->default_access = $field->default_access;
            
            // give plugins a chance to change or reject the value
            if ($field->profile) {                
                $fd = plugin_hook("profile_data","create",$fd);
            }
            
            if (!empty($fd) && !empty($fd->value)) {
                $fd = plugin_hook("form_data","create",$fd);
            }
        }
        if (!empty($fd) && !empty($fd->value)) {
                           
            // OK, we have a value, so validate it if there is a validation function
            $valid = true;
            
            if (isset($CFG->display_field_module[$ftype])) {
                $callback = $CFG->display_field_module[$ftype] . "_validate_input_field";
                if (!$callback($fd)) {
                    $invalid_fields[] = $fname;
                    $invalid_field_titles[] = $flabel;
                    $valid = false;
                }
            }
            if ($valid) {
                $validated_values[] = $fd;
            }
            
        } else {                
            if ($frequired) {
                $missing_fields[] = $fname;
                $missing_field_titles[] = $flabel;
            }
        }
    }
    $problem_fields = array_unique(array_merge($invalid_fields,$missing_fields));
    $problem_field_titles = array_unique(array_merge($invalid_field_titles,$missing_field_titles));
    
    $result = new stdClass;
    if ($problem_fields) {
        $result->problem = true;
        $result->data = new StdClass;
        $result->data->problem_fields = $problem_fields;
        $result->data->problem_field_titles = $problem_field_titles;
    } else {
        $result->problem = false;
        $result->data = $validated_values;
    }        
    
    return $result;
}

function form_save($validated_values,$owner,$preview) {
    global $CFG;
    
    $body = '';
    
    if (!$preview) {    
        delete_records('profile_data','owner',$owner);
        delete_records('tags','owner',$owner);
    } else {
        $body .= '<h2>'.__gettext("Form preview results").'</h2>';
    }
    
    $profile_field_text = __gettext("Profile field");
    $form_field_text = __gettext("Form field");
    $saved_text = __gettext("would be saved as");
                
    foreach($validated_values as $fd) {
        $fd->owner = $owner;
        if ($fd->profile & !$preview) {
            $pd_current = get_record_sql("SELECT * FROM {$CFG->prefix}profile_data WHERE owner = $owner and name = '{$fd->name}'");
            if ($pd_current) {
                delete_records('profile_data','owner',$owner,'name',$fd->name);
                delete_records('tags','owner',$owner,'ref',$pd_current->ident);
                $access = $pd_current->access;
            } else {
                $access = $fd->default_access;
            }
            $pd = new stdClass;
            $pd->name = $fd->name;
            $pd->value = $fd->value;
            $pd->owner = $owner;
            $pd->access = $access;
            $insert_id  = insert_record('profile_data',$pd);
            $pd->ident = $insert_id;
            $fd->profile_id = $insert_id;
            plugin_hook("profile_data","publish",$pd);
            
            // insert the keywords
            
            if ($fd->field_type == "keywords") {            
                insert_tags_from_string ($fd->value, $fd->name, $insert_id, $access, $owner);
            }
        } else {
            $fd->profile_id = 0;
        }
        
        if ($preview) {
            if ($fd->profile) {
                $field_desc = $profile_field_text;
            } else {
                $field_desc = $form_field_text;
            }
            $body .= '<hr>'."\n";
            $body .= '<p>'.$field_desc.' <b>'.$fd->name.'</b> '.$saved_text.':'.'</p>'."\n";
            $body .= '<p>'.$fd->value.'</p>'."\n";
        } else {                
            
            $fd->created = time();
            
            unset($fd->default_access);            
                
            delete_records('form_data','owner',$owner,'field_id',$fd->field_id);
            $insert_id  = insert_record('form_data',$fd);
            $fd->data_id = $insert_id;
            plugin_hook("form_data","publish",$fd);
        }
    }
    return $body;
}

?>