view_userform.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * Prints a particular instance of surveypro
 *
 * @package    mod_surveypro
 * @copyright  2013 onwards kordan <kordan@mclink.it>
 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

require_once(dirname(dirname(dirname(__FILE__))).'/config.php');
require_once($CFG->dirroot.'/mod/surveypro/locallib.php');
require_once($CFG->dirroot.'/mod/surveypro/classes/view_userform.class.php');
require_once($CFG->dirroot.'/mod/surveypro/forms/remoteuser/out_form.php');

$id = optional_param('id', 0, PARAM_INT); // course_module ID, or
$s = optional_param('s', 0, PARAM_INT);  // surveypro instance ID

if (!empty($id)) {
    $cm = get_coursemodule_from_id('surveypro', $id, 0, false, MUST_EXIST);
    $course = $DB->get_record('course', array('id' => $cm->course), '*', MUST_EXIST);
    $surveypro = $DB->get_record('surveypro', array('id' => $cm->instance), '*', MUST_EXIST);
} else {
    $surveypro = $DB->get_record('surveypro', array('id' => $s), '*', MUST_EXIST);
    $course = $DB->get_record('course', array('id' => $surveypro->course), '*', MUST_EXIST);
    $cm = get_coursemodule_from_instance('surveypro', $surveypro->id, $course->id, false, MUST_EXIST);
}

require_course_login($course, true, $cm);

$context = context_module::instance($cm->id);
$formpage = optional_param('formpage', 0, PARAM_INT); // form page number
$view = optional_param('view', SURVEYPRO_NOVIEW, PARAM_INT);
$submissionid = optional_param('submissionid', 0, PARAM_INT);

// -----------------------------
// calculations
// -----------------------------
$userformman = new mod_surveypro_userformmanager($cm, $context, $surveypro);
$userformman->set_submissionid($submissionid);
$userformman->set_view($view);
$userformman->set_formpage($formpage);

$userformman->prevent_direct_user_input();
$userformman->trigger_event($view);

$userformman->surveypro_add_custom_css();

// redirect if no items were created and you are supposed to create them
if ($userformman->canaccessadvanceditems) {
    if (!$userformman->hasinputitems) {
        if (($formpage == 0) || ($formpage == 1)) {
            $paramurl = array('id' => $cm->id);
            $returnurl = new moodle_url('/mod/surveypro/items_manage.php', $paramurl);
            redirect($returnurl);
        }
    }
}

$pageallowesubmission = ($userformman->modulepage != SURVEYPRO_SUBMISSION_READONLY);
$pageallowesubmission = $pageallowesubmission && ($userformman->modulepage != SURVEYPRO_ITEMS_PREVIEW);

// -----------------------------
// define $user_form return url
$paramurl = array('id' => $cm->id, 'view' => $view);
$formurl = new moodle_url('/mod/surveypro/view_userform.php', $paramurl);
// end of: define $user_form return url
// -----------------------------

// -----------------------------
// prepare params for the form
$formparams = new stdClass();
$formparams->cmid = $cm->id;
$formparams->surveypro = $surveypro;
$formparams->submissionid = $submissionid;
$formparams->firstpageright = $userformman->firstpageright;
$formparams->maxassignedpage = $userformman->maxassignedpage;
$formparams->canaccessadvanceditems = $userformman->canaccessadvanceditems; // Help selecting the fields to show
$formparams->formpage = $userformman->formpage;
$formparams->modulepage = $userformman->modulepage; // this is the page to get corresponding fields
$formparams->readonly = ($userformman->modulepage == SURVEYPRO_SUBMISSION_READONLY);
$formparams->preview = ($view == SURVEYPRO_PREVIEWSURVEYFORM);
// end of: prepare params for the form
// -----------------------------

// if ($view == SURVEYPRO_READONLYRESPONSE) {$editable = false} else {$editable = true}
$userform = new mod_surveypro_submissionform($formurl, $formparams, 'post', '', array('id' => 'userentry'), ($view != SURVEYPRO_READONLYRESPONSE));

// -----------------------------
// manage form submission
if ($userform->is_cancelled()) {
    $localparamurl = array('id' => $cm->id, 'view' => $view, 'cover' => 0);
    $redirecturl = new moodle_url('/mod/surveypro/view.php', $localparamurl);
    redirect($redirecturl, get_string('usercanceled', 'surveypro'));
}

if ($userformman->formdata = $userform->get_data()) {
    // SAVE unless the "previous" button has been pressed
    //             and "pause"    button has been pressed
    $prevbutton = (isset($userformman->formdata->prevbutton) && ($userformman->formdata->prevbutton));
    $pausebutton = (isset($userformman->formdata->pausebutton) && ($userformman->formdata->pausebutton));

    if (!$prevbutton && !$pausebutton) {
        if ($userformman->modulepage != SURVEYPRO_ITEMS_PREVIEW) {
            $userformman->save_user_data(); // <-- SAVE SAVE SAVE SAVE
            $userformman->notifypeople();
        }
    }

    // if "pause" button has been pressed, redirect
    if ($pausebutton) {
        $localparamurl = array('id' => $cm->id, 'view' => $view, 'cover' => 0);
        $redirecturl = new moodle_url('/mod/surveypro/view.php', $localparamurl);
        redirect($redirecturl); // -> go somewhere
    }

    $paramurl['submissionid'] = $userformman->submissionid;

    // if "previous" button has been pressed, redirect
    if ($prevbutton) {
        $userformman->next_not_empty_page(false, $userformman->formpage, $userformman->modulepage);
        $paramurl['formpage'] = $userformman->firstpageleft;
        $redirecturl = new moodle_url('/mod/surveypro/view_userform.php', $paramurl);
        redirect($redirecturl); // -> go to the first non empty previous page of the form
    }

    $nextbutton = (isset($userformman->formdata->nextbutton) && ($userformman->formdata->nextbutton));
    if ($nextbutton) {
        $userformman->next_not_empty_page(true, $userformman->formpage, $userformman->modulepage);
        // ok, I am leaving page $userformman->formpage
        // to go to page $userformman->firstpageright
        // I need to delete all the answer that were (maybe) written during a previous walk along the surveypro.
        // Data of each item in a page between ($userformman->formpage+1) and ($userformman->formpage-1) included, must be deleted
        $userformman->drop_jumped_saved_data();

        $paramurl['formpage'] = $userformman->firstpageright;
        $redirecturl = new moodle_url('/mod/surveypro/view_userform.php', $paramurl);
        redirect($redirecturl); // -> go to the first non empty next page of the form
    }
}
// end of: manage form submission
// -----------------------------

// -----------------------------
// output starts here
// -----------------------------
$paramurl = array('s' => $surveypro->id, 'view' => $view);
$url = new moodle_url('/mod/surveypro/view_userform.php', $paramurl);
$PAGE->set_url($url);
$PAGE->set_context($context);
$PAGE->set_cm($cm);
$PAGE->set_title($surveypro->name);
$PAGE->set_heading($course->shortname);

// make bold the navigation menu/link that refers to me
navigation_node::override_active_url($url);

// other things you may want to set - remove if not needed
// $PAGE->set_cacheable(false);
// $PAGE->set_focuscontrol('some-html-id');

echo $OUTPUT->header();

$moduletab = $userformman->moduletab; // needed by tabs.php
$modulepage = $userformman->modulepage; // needed by tabs.php
require_once($CFG->dirroot.'/mod/surveypro/tabs.php');

// -----------------------------
// if surveypro is without items, alert and stop
if (!$userformman->canaccessadvanceditems) {
    if (!$userformman->hasinputitems) {
        $userformman->noitem_stopexecution();
    }
}
// end of: if surveypro is without items, alert and stop
// -----------------------------

// -----------------------------
// is the user allowed to submit one more surveypro?
if ($pageallowesubmission) {
    if (!$userformman->submissions_allowed()) {
        $userformman->submissions_exceeded_stopexecution();
    }
    // } else {
    // I am editing an "in progress" submission
    // you are always allowed to carry on with your "in progress" submission
}
// end of: is the user allowed to submit one more surveypro?
// -----------------------------

// -----------------------------
// manage the thanks page
if ($pageallowesubmission) {
    $userformman->manage_thanks_page();
}
// end of: manage the thanks page
// -----------------------------

// -----------------------------
// display an alert to explain why buttons are missing
$userformman->message_preview_mode();
// end of: display an alert to explain why buttons are missing
// -----------------------------

// -----------------------------
// display orientation text: page xx of yy
$userformman->display_page_x_of_y();
// end of: display orientation text: page xx of yy
// -----------------------------

// -----------------------------
// calculate prefill for fields and prepare standard editors and filemanager
// if sumission already exists
$prefill = $userformman->get_prefill_data();
$prefill['formpage'] = $userformman->formpage;
// end of: calculate prefill for fields and prepare standard editors and filemanager
// -----------------------------

$userform->set_data($prefill);
$userform->display();

// -----------------------------
// if surveypro is multipage and $userformman->modulepage == SURVEYPRO_READONLYRESPONSE
// I need to add navigation buttons manually
// because the surveypro is not displayed as a form but as a simple list of graphic user items
$userformman->add_readonly_browsing_buttons();
// -----------------------------

// -----------------------------
// display an alert to explain why buttons are missing
$userformman->message_preview_mode();
// end of: display an alert to explain why buttons are missing
// -----------------------------

// Finish the page
echo $OUTPUT->footer();