MDL-44182 mod_survey: unified @package use
[moodle.git] / mod / survey / view.php
1 <?php
3 // This file is part of Moodle - http://moodle.org/
4 //
5 // Moodle is free software: you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License as published by
7 // the Free Software Foundation, either version 3 of the License, or
8 // (at your option) any later version.
9 //
10 // Moodle is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 // GNU General Public License for more details.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
18 /**
19  * This file is responsible for displaying the survey
20  *
21  * @package   mod_survey
22  * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
23  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26     require_once("../../config.php");
27     require_once("lib.php");
29     $id = required_param('id', PARAM_INT);    // Course Module ID
31     if (! $cm = get_coursemodule_from_id('survey', $id)) {
32         print_error('invalidcoursemodule');
33     }
35     if (! $course = $DB->get_record("course", array("id"=>$cm->course))) {
36         print_error('coursemisconf');
37     }
39     $PAGE->set_url('/mod/survey/view.php', array('id'=>$id));
40     require_login($course, false, $cm);
41     $context = context_module::instance($cm->id);
43     require_capability('mod/survey:participate', $context);
45     if (! $survey = $DB->get_record("survey", array("id"=>$cm->instance))) {
46         print_error('invalidsurveyid', 'survey');
47     }
48     $trimmedintro = trim($survey->intro);
49     if (empty($trimmedintro)) {
50         $tempo = $DB->get_field("survey", "intro", array("id"=>$survey->template));
51         $survey->intro = get_string($tempo, "survey");
52     }
54     if (! $template = $DB->get_record("survey", array("id"=>$survey->template))) {
55         print_error('invalidtmptid', 'survey');
56     }
58 // Update 'viewed' state if required by completion system
59 require_once($CFG->libdir . '/completionlib.php');
60 $completion = new completion_info($course);
61 $completion->set_module_viewed($cm);
63     $showscales = ($template->name != 'ciqname');
65     $strsurvey = get_string("modulename", "survey");
66     $PAGE->set_title($survey->name);
67     $PAGE->set_heading($course->fullname);
68     echo $OUTPUT->header();
69     echo $OUTPUT->heading($survey->name);
71 /// Check to see if groups are being used in this survey
72     if ($groupmode = groups_get_activity_groupmode($cm)) {   // Groups are being used
73         $currentgroup = groups_get_activity_group($cm);
74     } else {
75         $currentgroup = 0;
76     }
77     $groupingid = $cm->groupingid;
79     if (has_capability('mod/survey:readresponses', $context) or ($groupmode == VISIBLEGROUPS)) {
80         $currentgroup = 0;
81     }
83     if (has_capability('mod/survey:readresponses', $context)) {
84         $numusers = survey_count_responses($survey->id, $currentgroup, $groupingid);
85         echo "<div class=\"reportlink\"><a href=\"report.php?id=$cm->id\">".
86               get_string("viewsurveyresponses", "survey", $numusers)."</a></div>";
87     } else if (!$cm->visible) {
88         notice(get_string("activityiscurrentlyhidden"));
89     }
91     if (!is_enrolled($context)) {
92         echo $OUTPUT->notification(get_string("guestsnotallowed", "survey"));
93     }
96 //  Check the survey hasn't already been filled out.
98     if (survey_already_done($survey->id, $USER->id)) {
100         add_to_log($course->id, "survey", "view graph", "view.php?id=$cm->id", $survey->id, $cm->id);
101         $numusers = survey_count_responses($survey->id, $currentgroup, $groupingid);
103         if ($showscales) {
104             echo $OUTPUT->box(get_string("surveycompleted", "survey"));
105             echo $OUTPUT->box(get_string("peoplecompleted", "survey", $numusers));
106             echo '<div class="resultgraph">';
107             survey_print_graph("id=$cm->id&amp;sid=$USER->id&amp;group=$currentgroup&amp;type=student.png");
108             echo '</div>';
110         } else {
112             echo $OUTPUT->box(format_module_intro('survey', $survey, $cm->id), 'generalbox', 'intro');
113             echo $OUTPUT->spacer(array('height'=>30, 'width'=>1), true);  // should be done with CSS instead
115             $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions));
116             $questionorder = explode(",", $survey->questions);
117             foreach ($questionorder as $key => $val) {
118                 $question = $questions[$val];
119                 if ($question->type == 0 or $question->type == 1) {
120                     if ($answer = survey_get_user_answer($survey->id, $question->id, $USER->id)) {
121                         $table = new html_table();
122                         $table->head = array(get_string($question->text, "survey"));
123                         $table->align = array ("left");
124                         $table->data[] = array(s($answer->answer1));//no html here, just plain text
125                         echo html_writer::table($table);
126                         echo $OUTPUT->spacer(array('height'=>30, 'width'=>1), true);
127                     }
128                 }
129             }
130         }
132         echo $OUTPUT->footer();
133         exit;
134     }
136 //  Start the survey form
137     add_to_log($course->id, "survey", "view form", "view.php?id=$cm->id", $survey->id, $cm->id);
139     echo "<form method=\"post\" action=\"save.php\" id=\"surveyform\">";
140     echo '<div>';
141     echo "<input type=\"hidden\" name=\"id\" value=\"$id\" />";
142     echo "<input type=\"hidden\" name=\"sesskey\" value=\"".sesskey()."\" />";
144     echo $OUTPUT->box(format_module_intro('survey', $survey, $cm->id), 'generalbox boxaligncenter bowidthnormal', 'intro');
145     echo '<div>'. get_string('allquestionrequireanswer', 'survey'). '</div>';
147 // Get all the major questions and their proper order
148     if (! $questions = $DB->get_records_list("survey_questions", "id", explode(',', $survey->questions))) {
149         print_error('cannotfindquestion', 'survey');
150     }
151     $questionorder = explode( ",", $survey->questions);
153 // Cycle through all the questions in order and print them
155     global $qnum;  //TODO: ugly globals hack for survey_print_*()
156     global $checklist; //TODO: ugly globals hack for survey_print_*()
157     $qnum = 0;
158     $checklist = array();
159     foreach ($questionorder as $key => $val) {
160         $question = $questions["$val"];
161         $question->id = $val;
163         if ($question->type >= 0) {
165             if ($question->text) {
166                 $question->text = get_string($question->text, "survey");
167             }
169             if ($question->shorttext) {
170                 $question->shorttext = get_string($question->shorttext, "survey");
171             }
173             if ($question->intro) {
174                 $question->intro = get_string($question->intro, "survey");
175             }
177             if ($question->options) {
178                 $question->options = get_string($question->options, "survey");
179             }
181             if ($question->multi) {
182                 survey_print_multi($question);
183             } else {
184                 survey_print_single($question);
185             }
186         }
187     }
189     if (!is_enrolled($context)) {
190         echo '</div>';
191         echo "</form>";
192         echo $OUTPUT->footer();
193         exit;
194     }
196     $checkarray = Array('questions'=>Array());
197     if (!empty($checklist)) {
198        foreach ($checklist as $question => $default) {
199            $checkarray['questions'][] = Array('question'=>$question, 'default'=>$default);
200        }
201     }
202     $PAGE->requires->data_for_js('surveycheck', $checkarray);
203     $module = array(
204         'name'      => 'mod_survey',
205         'fullpath'  => '/mod/survey/survey.js',
206         'requires'  => array('yui2-event'),
207     );
208     $PAGE->requires->string_for_js('questionsnotanswered', 'survey');
209     $PAGE->requires->js_init_call('M.mod_survey.init', $checkarray, true, $module);
211     echo '<br />';
212     echo '<input type="submit" value="'.get_string("clicktocontinue", "survey").'" />';
213     echo '</div>';
214     echo "</form>";
216     echo $OUTPUT->footer();