root/form/lib.php

<?php
function form_pagesetup() {
    global $CFG;
    global $PAGE;
    
    if (defined("context") && context == "admin") {
        if (isloggedin() && run("users:flags:get", array("admin", $_SESSION['userid']))) {
        
        // set up admin page link
        
            $PAGE->menu_sub[] = array ( 'name' => 'form:admin',
                                        'html' => "<a href=\"{$CFG->wwwroot}mod/form/index.php\">"
                                        . gettext("Manage forms") . '</a>');
        }
    }
}

function form_init() {
    global $METATABLES,$CFG;
    
    if (!in_array($CFG->prefix . "forms", $METATABLES) || !in_array($CFG->prefix . "form_fields", $METATABLES) || !in_array($CFG->prefix . "form_fields_choice", $METATABLES)) {
        if (file_exists($CFG->dirroot . "mod/form/$CFG->dbtype.sql")) {
            modify_database($CFG->dirroot . "mod/form/$CFG->dbtype.sql");
        } else {
            error("Error: Your database ($CFG->dbtype) is not yet supported by the Form module.");
        }
        print_continue("index.php");
        exit;
    }
}

function form_get_field_form($form_id,$field=null,$field_name = '') {
    
    global $CFG,$metatags;
    
    // this include is inside the function to avoid putting a huge amount of source code
    // inside lib.php
     
    include('field_form_definition.php');
    
    return $body;
}

function form_get_form_form($form = null) {
    global $CFG;
    
    $view_all_link_text = __gettext("View all forms");
    
    $edit_msg = __gettext('Edit');
    $remove_msg = __gettext('Remove');
    $remove_confirm_msg = __gettext("Are you sure that you want to remove this field from this form?");
    $moveup_msg = __gettext('Move Up');
    $movedown_msg = __gettext('Move Down');
    
    $img_template = '<img border="0" width="16" height="16" alt="%s" title="%s" src="'.$CFG->wwwroot.'mod/widget/images/%s" />';
    $edit_img = sprintf($img_template,$edit_msg,$edit_msg,"16-em-pencil.png");
    $remove_img = sprintf($img_template,$remove_msg,$remove_msg,"16-em-cross.png");
    $moveup_img = sprintf($img_template,$moveup_msg,$moveup_msg,"16-em-open.png");
    $movedown_img = sprintf($img_template,$movedown_msg,$movedown_msg,"16-em-down.png");
    
    $field_template = <<<END
<a href="{$CFG->wwwroot}mod/form/manage_field.php?action=edit&id=%s">$edit_img</a> |
<a onclick="return confirm('$remove_confirm_msg')" href="{$CFG->wwwroot}mod/form/manage_field.php?action=remove&id=%s">$remove_img</a> |
<a href="{$CFG->wwwroot}mod/form/manage_field.php?action=move&id=%s&direction=up">$moveup_img</a> |
<a href="{$CFG->wwwroot}mod/form/manage_field.php?action=move&id=%s&direction=down">$movedown_img</a>
%s
<br />
END;
    
    if ($form) {
        $action = 'change';
        $manage_form_title = __gettext("Manage form data");
        $explanation = _gettext("You can manage all aspects of this form using the fields below.");
        $form_manage_button = __gettext("Change form");
        $form_id = $form->ident;
        $form_name = $form->name;
        $form_title = $form->title;
        $description = $form->description;
        $response_text = $form->response_text;
        $access = $form->access;
        $notification = $form->notification;
        $field_list = '<h1>'.__gettext("Current fields").'</h1><br />';
        if (isset($form->fields) && count($form->fields) > 0 ) {
            foreach ($form->fields AS $field) {
                $ident = $field->map_id;
                $field_list .= sprintf( $field_template,$ident,$ident,$ident,$ident,
                    $field->title . ' ('.$field->internal_name.': '.$field->field_type.')');
            }
            $field_list .= '<br />';
        } else {
            $field_list .= '<p>'.__gettext("None").'.</p>';
        }
       
        
        /* buttons and links:
         *
         * preview form (link)
         * add existing field (input box for field name)
         * copy existing field (copies field definition) (input boxes for field name)
         * add new field (input box for field name)
         */     
         
         $preview_link_text = __gettext("Preview this form");
         $public_link_text = __gettext("Public link for this form");

         $add_existing_button = __gettext("Add existing field");
         $add_existing_field_description = __gettext("Enter the name of an existing field to add it to this form.");
         $copy_existing_button = __gettext("Copy existing field");
         $copy_existing_field_description = __gettext("Enter the name of an existing field and the name of the new "
            ."field to create a copy that will be added to this form.");
         $add_new_button = __gettext("Add new field");
         $add_new_description = __gettext("Enter the name of a new field to add it to this form.");
         $existing_label = __gettext("Existing field name");
         $new_label = __gettext("New field name");
         
         $add_fields_title = __gettext("Add fields");
         $add_existing_title = __gettext("Add existing field");
         $copy_existing_title = __gettext("Copy existing field");  
         $add_new_title =  __gettext("Add new field");
         
         $links = <<<END
         <p><a href="{$CFG->wwwroot}mod/form/form.php?id=$form_id&preview=true">$preview_link_text</a>
         | <a href="{$CFG->wwwroot}mod/form/form.php?id=$form_id">$public_link_text</a>
         | <a href="{$CFG->wwwroot}mod/form/index.php">$view_all_link_text</a>
         </p>
END;
         
         $buttons = <<<END
         <h1>$add_fields_title</h1>
         <br />
         <form action="{$CFG->wwwroot}mod/form/manage_field.php" method="post">
         <h2>$add_new_title</h2>
         <input type="hidden" name="form_id" value="$form_id">
         <input type="hidden" name="action" value="add_new">
         <label class="labelclass" for="new_field_name">$new_label</label>
         <input class="standard" type="text" name="new_field_name" value="">
         <p class="description">$add_new_description</p>
         <input type="submit" name="submit" value="$add_new_button">
         </form>
         <br />
         <form action="{$CFG->wwwroot}mod/form/manage_field.php" method="post">
         <h2>$add_existing_title</h2>
         <input type="hidden" name="form_id" value="$form_id">
         <input type="hidden" name="action" value="add_existing">
         <label class="labelclass" for="existing_field_name">$existing_label</label>
         <input class="standard" type="text" name="existing_field_name" value="">
         <p class="description">$add_existing_field_description</p>
         <input type="submit" name="submit" value="$add_existing_button">
         </form>
         <br />
         <form action="{$CFG->wwwroot}mod/form/manage_field.php" method="post">
         <h2>$copy_existing_title</h2>
         <input type="hidden" name="form_id" value="$form_id">
         <input type="hidden" name="action" value="copy_existing">
         <label class="labelclass" for="existing_field_name">$existing_label</label>
         <input class="standard" type="text" name="existing_field_name" value="">
         <label class="labelclass" for="new_field_name">$new_label</label>
         <input class="standard" type="text" name="new_field_name" value="">
         <p class="description">$copy_existing_field_description</p>
         <input type="submit" name="submit" value="$copy_existing_button">
         </form>
         <br /><br />
END;
    } else {
        $action = 'add';
        $manage_form_title = '';
        $explanation = _gettext("Enter the information below and press the Create form button to create this form."
            ." Once the form has been created, you will be able to add fields to it.");
        $form_manage_button = __gettext("Create form");
        $form_id = 0;
        $form_name = '';
        $form_title = '';
        $description = '';
        $response_text = '';
        $access = $CFG->default_access;
        $notification = 0;
        $field_list = '';
        $buttons = '';
        $links = <<<END
         <p><a href="{$CFG->wwwroot}mod/form/index.php">$view_all_link_text</a></p>
END;
    }
    
    $access_select = run("display:access_level_select",array("access",$access));
    
    $form_name_label = __gettext("Form name");
    $form_name_description = __gettext("Enter an internal name for this form (no blanks, only letters, names and/or underscores)");
    $form_title_label = __gettext("Form title");
    $form_title_description = __gettext("Enter a brief title that will appear as a heading at the top of the form.");
    $description_label = __gettext("Description");
    $form_description_description = __gettext("Enter a sentence or two of text that will be displayed at the top of your form to explain its purpose.");
    $response_text_label = __gettext("Response text");
    $response_description = __gettext("Enter the content that will be displayed after the form has been submitted."); 
    $access_label = __gettext("Access");
    $access_description = __gettext("The access determines who is allowed to see this form.");
    $notification_label = __gettext("Notification");
    $notification_description = __gettext("Tick this box to receive a notification each time someone submits this form.");
    if ($notification) {
        $notification_checked = 'checked';
    } else {
        $notification_checked = '';
    }
                  
    
    $body = <<<END
    <style>
div.invisible {
    display: none;
}
div.visibleright {
    float:right;
    width: 100px;
}

label.labelclass {
    display:block;
    font-weight:bold;
}

p.description {
    font-size: 0.9em;
    margin-top: 0px;
}

span.option_value_header {
    font-weight: bold;
    width: 150px;
    display: block;
    float: left;
}

span.option_label_header {
    font-weight: bold;
    width: 300px;
    margin-left: 10px;
}

input.option_value_input {
    width:150px;
}

input.option_label_input {
    margin-left:10px;
    width:300px;
}

textarea.smalltextarea {
    width:350px;
    height: 100px;
}   
</style>
$links
<p>$explanation</p>
$buttons
$field_list
<form action="{$CFG->wwwroot}/mod/form/manage_form.php" method="post">
<h1>$manage_form_title</h1>
<input type="hidden" name="form_id" value="$form_id">
<input type="hidden" name="action" value="$action">
<label class="labelclass" for="form_name">$form_name_label</label>
<input type="text" class="standard" name="form_name" value="$form_name">
<p class="description">$form_name_description</p>
<label class="labelclass" for="form_title">$form_title_label</label>
<input type="text" class="standard" name="form_title" value="$form_title">
<p class="description">$form_title_description</p>
<label class="labelclass" for="form_title">$description_label</label>
<textarea class="smalltextarea" name="description">$description</textarea>
<p class="description">$form_description_description</p>
<label class="labelclass" for="response_text">$response_text_label</label>
<textarea class="smalltextarea" name="response_text">$response_text</textarea>
<p class="description">$response_description</p>
<label class="labelclass" for="access">$access_label</label>
$access_select
<p class="description">$access_description</p>
<label class="labelclass" for="notification">$notification_label</label>
<input type="checkbox" name="notification" value="1" $notification_checked>
<p class="description">$notification_description</p>
<br />
<input type="submit" name="submit" value="$form_manage_button">
</form>
END;

return $body;
        
}

function form_get_field_definition($field_id) {
    
    global $CFG;
    
    // get the main field data
    
    $field = get_record('form_fields','ident',$field_id);
    
    // get the choice data, if any
    
    if (isset($field) && $field->field_type == 'choices') {
        $field->options1 = get_records_sql("SELECT * FROM {$CFG->prefix}form_fields_choice WHERE field_id = $field_id AND group_id = 1 ORDER BY ident ASC");
        $field->options2 = get_records_sql("SELECT * FROM {$CFG->prefix}form_fields_choice WHERE field_id = $field_id AND group_id = 2 ORDER BY ident ASC");
    }
    
    return $field;
}

function form_set_field_definition() {
    $action = optional_param('action','');
    $field = new stdClass;
    $field->form_id = optional_param('form_id',0,PARAM_INT);
    if ($action == 'change') {
        $field->ident = optional_param('field_id',0,PARAM_INT);
    }
    $field->internal_name = optional_param('internal_name','');
    $field->title = optional_param('title','');
    $field->description = optional_param('description','');
    $field->required = optional_param('required',0,PARAM_INT);
    $field->profile = optional_param('profile',0,PARAM_INT);
    $field->category = optional_param('category','');
    $field->field_type = optional_param('field_type','');
    $field->invisible = optional_param('invisible',0,PARAM_INT);
    $field->col = optional_param('column','');
    $field->default_access = optional_param('default_access','');
    $field->choice_type = optional_param('choice_type','');
    $field->orientation = optional_param('orientation','');
    $field->default_value = optional_param('default_value','');
    $field->is_keyword_tag = optional_param('is_keyword_tag',0,PARAM_INT);
    
    if ($field->field_type == 'contact') {
        $field->field_type = optional_param('contact_type','');
    }
    
    if ($action == 'change') {
        update_record('form_fields',$field);
        delete_records('form_fields_choice','field_id',$field->ident);
    } else {
        $field->ident = insert_record('form_fields',$field);
        $map = new stdClass;
        $map->field_id = $field->ident;
        $map->form_id = $field->form_id;
        $map->display_order = 100000;
        insert_record('form_fields_map',$map);
        form_reorder($field->form_id);
    }
    
    $number_of_options1 = optional_param('number_of_options1',0,PARAM_INT);
    
    for ($i = 0; $i < $number_of_options1; $i++) {
        $option = new stdClass;
        $option->field_id = $field->ident;
        $option->group_id = 1;
        $option->value = optional_param('option_1_'.$i.'_value','');
        $option->label = optional_param('option_1_'.$i.'_label','');
        if ($option->value) {
            insert_record('form_fields_choice',$option);
        }
    }
    
    $number_of_options2 = optional_param('number_of_options2',0,PARAM_INT);
    
    for ($i = 0; $i < $number_of_options2; $i++) {
        $option = new stdClass;
        $option->field_id = $field->ident;
        $option->group_id = 2;
        $option->value = optional_param('option_2_'.$i.'_value','');
        $option->label = optional_param('option_2_'.$i.'_label','');
        if ($option->value) {
            insert_record('form_fields_choice',$option);
        }
    }        
}

function form_reorder($form_id) {
    $maps = form_get_maps($form_id);
    $order = array();
    $i = 1;
    foreach($maps as $map) {
        $order[$map->ident] = $i * 10;
        $i++;
    }
    foreach($order as $ident => $display_order) {
        $map = new StdClass;
        $map->display_order = $display_order;
        $map->ident = $ident;
        update_record('form_fields_map',$map);
    }
}

function form_get_maps($form_id) {
    return get_records('form_fields_map','form_id',$form_id,'display_order ASC');
}

// Move a form/field map up
function form_field_moveup($map) {
    $map->display_order = $map->display_order - 11;
    update_record('form_fields_map',$map);
    form_reorder($map->form_id);
}

// Move a form/field map down
function form_field_movedown($map) {
    $map->display_order = $map->display_order + 11;
    update_record('form_fields_map',$map);
    form_reorder($map->form_id);
}

/*
 * - includes an array of field_id keys $field_id => array($internal_name => $title)
 *
 */

function form_get_form_definition($form_id) {
    global $CFG;
    
    // get the main form data
    
    $form = get_record('forms','ident',$form_id);
    
    if ($form) {
        $fields_from_database = get_records_sql("SELECT f.*, m.ident AS map_id FROM {$CFG->prefix}form_fields f INNER JOIN {$CFG->prefix}form_fields_map m ".
            "ON (f.ident = m.field_id) WHERE m.form_id = $form_id ORDER by m.display_order ASC");
    }
    
    $fields = array();
    
    if (!empty($fields_from_database)) {    
        foreach ($fields_from_database AS $field) {
            $fields[] =  $field;
        }
    }
    $form->fields = $fields;
    
    return $form;
}

function form_set_form_definition() {
    $action = optional_param('action','');
    $form = new stdClass;

    $form->name = optional_param('form_name','');
    $form->title = optional_param('form_title','');
    $form->description = optional_param('description','');
    $form->response_text = optional_param('response_text','');
    $form->access = optional_param('access','');
    $form->notification = optional_param('notification',0,PARAM_INT);
    if ($action == 'change') {
        $form->ident = optional_param('form_id',0,PARAM_INT);
        update_record('forms',$form);
    } else if ($action == 'add') {
        $form->created = time();
        $form->owner = $_SESSION['userid'];
        $form->ident = insert_record('forms',$form);
    }
    
    return $form;
}

function form_handle_profile() {
    global $data;
    if (!isset($data['profile:details'])) {
        
        // get the registration field ids, if any
        $registration_field_ids = array();
        $registration_form_id = get_field('forms','ident','name','registration');
        if (isset($registration_form_id)) {
            $registration_form = form_get_form_definition($registration_form_id);
            if (isset($registration_form) && isset($registration_form->fields)) {
                foreach($registration_form->fields AS $field) {
                     $registration_field_ids[] = $field->ident;
                 }
             }
         }
         
         // get the profile form and fields
         
        $profile_form_id = get_field('forms','ident','name','profile');
        if (isset($profile_form_id)) {
            $profile_form = form_get_form_definition($profile_form_id);
        }
        if (isset($profile_form) && isset($profile_form->fields)) {
            foreach ($profile_form->fields AS $field) {
                if ($field->profile) {
                    form_export_profile_data($field,'person',$registration_field_ids);
                }                    
            }
        }
        
         // get the community profile form and fields
         
        $profile_form_id = get_field('forms','ident','name'