get_string('publishanonymous', 'choice'), CHOICE_PUBLISH_NAMES => get_string('publishnames', 'choice')); $CHOICE_SHOWRESULTS = array (CHOICE_SHOWRESULTS_NOT => get_string('publishnot', 'choice'), CHOICE_SHOWRESULTS_AFTER_ANSWER => get_string('publishafteranswer', 'choice'), CHOICE_SHOWRESULTS_AFTER_CLOSE => get_string('publishafterclose', 'choice'), CHOICE_SHOWRESULTS_ALWAYS => get_string('publishalways', 'choice')); $CHOICE_DISPLAY = array (CHOICE_DISPLAY_HORIZONTAL => get_string('displayhorizontal', 'choice'), CHOICE_DISPLAY_VERTICAL => get_string('displayvertical','choice')); /// Standard functions ///////////////////////////////////////////////////////// function choice_user_outline($course, $user, $mod, $choice) { if ($answer = get_record('choice_answers', 'choiceid', $choice->id, 'userid', $user->id)) { $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'"; $result->time = $answer->timemodified; return $result; } return NULL; } function choice_user_complete($course, $user, $mod, $choice) { if ($answer = get_record('choice_answers', "choiceid", $choice->id, "userid", $user->id)) { $result->info = "'".format_string(choice_get_option_text($choice, $answer->optionid))."'"; $result->time = $answer->timemodified; echo get_string("answered", "choice").": $result->info. ".get_string("updated", '', userdate($result->time)); } else { print_string("notanswered", "choice"); } } function choice_add_instance($choice) { // Given an object containing all the necessary data, // (defined by the form in mod.html) this function // will create a new instance and return the id number // of the new instance. $choice->timemodified = time(); if (empty($choice->timerestrict)) { $choice->timeopen = 0; $choice->timeclose = 0; } //insert answers if ($choice->id = insert_record("choice", $choice)) { foreach ($choice->option as $key => $value) { $value = trim($value); if (isset($value) && $value <> '') { $option = new object(); $option->text = $value; $option->choiceid = $choice->id; if (isset($choice->limit[$key])) { $option->maxanswers = $choice->limit[$key]; } $option->timemodified = time(); insert_record("choice_options", $option); } } } return $choice->id; } function choice_update_instance($choice) { // Given an object containing all the necessary data, // (defined by the form in mod.html) this function // will update an existing instance with new data. $choice->id = $choice->instance; $choice->timemodified = time(); if (empty($choice->timerestrict)) { $choice->timeopen = 0; $choice->timeclose = 0; } //update, delete or insert answers foreach ($choice->option as $key => $value) { $value = trim($value); $option = new object(); $option->text = $value; $option->choiceid = $choice->id; if (isset($choice->limit[$key])) { $option->maxanswers = $choice->limit[$key]; } $option->timemodified = time(); if (isset($choice->optionid[$key]) && !empty($choice->optionid[$key])){//existing choice record $option->id=$choice->optionid[$key]; if (isset($value) && $value <> '') { update_record("choice_options", $option); } else { //empty old option - needs to be deleted. delete_records("choice_options", "id", $option->id); } } else { if (isset($value) && $value <> '') { insert_record("choice_options", $option); } } } return update_record('choice', $choice); } function choice_show_form($choice, $user, $cm, $allresponses) { //$cdisplay is an array of the display info for a choice $cdisplay[$optionid]->text - text name of option. // ->maxanswers -maxanswers for this option // ->full - whether this option is full or not. 0=not full, 1=full $cdisplay = array(); $aid = 0; $choicefull = false; $cdisplay = array(); if ($choice->limitanswers) { //set choicefull to true by default if limitanswers. $choicefull = true; } $context = get_context_instance(CONTEXT_MODULE, $cm->id); foreach ($choice->option as $optionid => $text) { if (isset($text)) { //make sure there are no dud entries in the db with blank text values. $cdisplay[$aid]->optionid = $optionid; $cdisplay[$aid]->text = $text; $cdisplay[$aid]->maxanswers = $choice->maxanswers[$optionid]; if (isset($allresponses[$optionid])) { $cdisplay[$aid]->countanswers = count($allresponses[$optionid]); } else { $cdisplay[$aid]->countanswers = 0; } if ($current = get_record('choice_answers', 'choiceid', $choice->id, 'userid', $user->id, 'optionid', $optionid)) { $cdisplay[$aid]->checked = ' checked="checked" '; } else { $cdisplay[$aid]->checked = ''; } if ( $choice->limitanswers && ($cdisplay[$aid]->countanswers >= $cdisplay[$aid]->maxanswers) && (empty($cdisplay[$aid]->checked)) ) { $cdisplay[$aid]->disabled = ' disabled="disabled" '; } else { $cdisplay[$aid]->disabled = ''; if ($choice->limitanswers && ($cdisplay[$aid]->countanswers < $cdisplay[$aid]->maxanswers)) { $choicefull = false; //set $choicefull to false - as the above condition hasn't been set. } } $aid++; } } switch ($choice->display) { case CHOICE_DISPLAY_HORIZONTAL: echo ""; foreach ($cdisplay as $cd) { echo ""; } echo ""; echo "
"; echo "optionid."\" alt=\"".strip_tags(format_text($cd->text))."\"". $cd->checked.$cd->disabled." />"; if (!empty($cd->disabled)) { echo format_text($cd->text."
".get_string('full', 'choice').""); } else { echo format_text($cd->text); } echo "
"; break; case CHOICE_DISPLAY_VERTICAL: $displayoptions->para = false; echo ""; foreach ($cdisplay as $cd) { echo ""; } else if ($choice->limitanswers && ($cd->countanswers >= $cd->maxanswers)) { //if limitanswers and answers exceeded, display "full" beside the choice. echo " ".get_string('full', 'choice').""; } echo ""; echo ""; } echo "
"; echo "optionid."\" alt=\"".strip_tags(format_text($cd->text))."\"". $cd->checked.$cd->disabled." />"; echo format_text($cd->text. ' ', FORMAT_MOODLE, $displayoptions); //display text for option. if ($choice->limitanswers && ($choice->showresults==CHOICE_SHOWRESULTS_ALWAYS) ){ //if limit is enabled, and show results always has been selected, display info beside each choice. echo ""; if (!empty($cd->disabled)) { echo get_string('full', 'choice'); } elseif(!empty($cd->checked)) { //currently do nothing - maybe some text could be added here to signfy that the choice has been 'selected' } elseif ($cd->maxanswers-$cd->countanswers==1) { echo ($cd->maxanswers - $cd->countanswers); echo " ".get_string('spaceleft', 'choice'); } else { echo ($cd->maxanswers - $cd->countanswers); echo " ".get_string('spacesleft', 'choice'); } echo "
"; break; } //show save choice button echo '
'; echo "id\" />"; echo ""; if (has_capability('mod/choice:choose', $context, $user->id, false)) { //don't show save button if the logged in user is the guest user. if ($choicefull) { print_string('choicefull', 'choice'); echo "
"; } else { echo ""; } if ($choice->allowupdate && $aaa = get_record('choice_answers', 'choiceid', $choice->id, 'userid', $user->id)) { echo "
".get_string("removemychoice","choice").""; } } else { print_string('havetologin', 'choice'); } echo "
"; } function choice_user_submit_response($formanswer, $choice, $userid, $courseid, $cm) { $current = get_record('choice_answers', 'choiceid', $choice->id, 'userid', $userid); $context = get_context_instance(CONTEXT_MODULE, $cm->id); $countanswers=0; if($choice->limitanswers) { // Find out whether groups are being used and enabled if (groups_get_activity_groupmode($cm) > 0) { $currentgroup = groups_get_activity_group($cm); } else { $currentgroup = 0; } if($currentgroup) { // If groups are being used, retrieve responses only for users in // current group global $CFG; $answers = get_records_sql(" SELECT ca.* FROM {$CFG->prefix}choice_answers ca INNER JOIN {$CFG->prefix}groups_members gm ON ca.userid=gm.userid WHERE optionid=$formanswer AND gm.groupid=$currentgroup"); } else { // Groups are not used, retrieve all answers for this option ID $answers = get_records("choice_answers", "optionid", $formanswer); } if ($answers) { foreach ($answers as $a) { //only return enrolled users. if (has_capability('mod/choice:choose', $context, $a->userid, false)) { $countanswers++; } } } $maxans = $choice->maxanswers[$formanswer]; } if (!($choice->limitanswers && ($countanswers >= $maxans) )) { if ($current) { $newanswer = $current; $newanswer->optionid = $formanswer; $newanswer->timemodified = time(); if (! update_record("choice_answers", $newanswer)) { error("Could not update your choice because of a database error"); } add_to_log($courseid, "choice", "choose again", "view.php?id=$cm->id", $choice->id, $cm->id); } else { $newanswer = NULL; $newanswer->choiceid = $choice->id; $newanswer->userid = $userid; $newanswer->optionid = $formanswer; $newanswer->timemodified = time(); if (! insert_record("choice_answers", $newanswer)) { error("Could not save your choice"); } add_to_log($courseid, "choice", "choose", "view.php?id=$cm->id", $choice->id, $cm->id); } } else { if (!($current->optionid==$formanswer)) { //check to see if current choice already selected - if not display error error("this choice is full!"); } } } function choice_show_reportlink($user, $cm) { $responsecount =0; foreach($user as $optionid => $userlist) { if ($optionid) { $responsecount += count($userlist); } } echo ''; } function choice_show_results($choice, $course, $cm, $allresponses, $forcepublish='') { global $CFG, $COLUMN_HEIGHT; print_heading(get_string("responses", "choice")); if (empty($forcepublish)) { //alow the publish setting to be overridden $forcepublish = $choice->publish; } if (empty($allresponses)) { print_heading(get_string("nousersyet")); return false; } $totalresponsecount = 0; foreach ($allresponses as $optionid => $userlist) { if ($choice->showunanswered || $optionid) { $totalresponsecount += count($userlist); } } $context = get_context_instance(CONTEXT_MODULE, $cm->id); $hascapfullnames = has_capability('moodle/site:viewfullnames', $context); $viewresponses = has_capability('mod/choice:readresponses', $context); switch ($forcepublish) { case CHOICE_PUBLISH_NAMES: echo '
'; if ($viewresponses) { echo '
'; echo '
'; echo ''; echo ''; echo ''; } echo ""; echo ""; $columncount = array(); // number of votes in each column if ($choice->showunanswered) { $columncount[0] = 0; echo ""; } $count = 1; foreach ($choice->option as $optionid => $optiontext) { $columncount[$optionid] = 0; // init counters echo ""; $count++; } echo ""; if ($choice->showunanswered) { echo ""; } $count = 0; foreach ($choice->option as $optionid => $optiontext) { echo ''; } echo ""; $count = 0; if ($choice->showunanswered) { echo ""; } foreach ($choice->option as $optionid => $optiontext) { echo ""; $count++; } echo ""; /// Print "Select all" etc. if ($viewresponses and has_capability('mod/choice:deleteresponses',$context)) { echo ''; } echo "
"; print_string('notanswered', 'choice'); echo ""; echo format_string($optiontext); echo "
"; // added empty row so that when the next iteration is empty, // we do not get
erro from w3c validator // MDL-7861 echo ""; if (!empty($allresponses[0])) { foreach ($allresponses[0] as $user) { echo ""; echo ""; } } echo "
"; print_user_picture($user->id, $course->id, $user->picture); echo ""; echo "wwwroot/user/view.php?id=$user->id&course=$course->id\">"; echo fullname($user, $hascapfullnames); echo ""; echo "
'; // added empty row so that when the next iteration is empty, // we do not get
erro from w3c validator // MDL-7861 echo ''; if (isset($allresponses[$optionid])) { foreach ($allresponses[$optionid] as $user) { $columncount[$optionid] += 1; echo ''; } } $count++; echo '
'; if ($viewresponses and has_capability('mod/choice:deleteresponses',$context)) { echo ''; } echo ''; print_user_picture($user->id, $course->id, $user->picture); echo ''; echo "wwwroot/user/view.php?id=$user->id&course=$course->id\">"; echo fullname($user, $hascapfullnames); echo ''; echo '
"; if ($choice->limitanswers) { echo get_string("taken", "choice").":"; echo $columncount[$optionid]; echo "
"; echo get_string("limit", "choice").":"; $choice_option = get_record("choice_options", "id", $optionid); echo $choice_option->maxanswers; } else { if (isset($columncount[$optionid])) { echo $columncount[$optionid]; } } echo "
'; echo ''.get_string('selectall', 'quiz').' / '; echo ''.get_string('selectnone', 'quiz').' '; echo '  '; $options = array('delete' => get_string('delete')); echo choose_from_menu($options, 'action', '', get_string('withselected', 'quiz'), 'if(this.selectedIndex > 0) submitFormById(\'attemptsform\');', '', true); echo ''; echo ''; echo '
"; if ($viewresponses) { echo "
"; } break; case CHOICE_PUBLISH_ANONYMOUS: echo ""; echo ""; $maxcolumn = 0; if ($choice->showunanswered) { echo ""; $column[0] = 0; foreach ($allresponses[0] as $user) { $column[0]++; } $maxcolumn = $column[0]; } $count = 1; foreach ($choice->option as $optionid => $optiontext) { echo ""; $column[$optionid] = 0; if (isset($allresponses[$optionid])) { $column[$optionid] = count($allresponses[$optionid]); if ($column[$optionid] > $maxcolumn) { $maxcolumn = $column[$optionid]; } } else { $column[$optionid] = 0; } } echo ""; $height = 0; if ($choice->showunanswered) { if ($maxcolumn) { $height = $COLUMN_HEIGHT * ((float)$column[0] / (float)$maxcolumn); } echo ""; } $count = 1; foreach ($choice->option as $optionid => $optiontext) { if ($maxcolumn) { $height = $COLUMN_HEIGHT * ((float)$column[$optionid] / (float)$maxcolumn); } echo ""; $count++; } echo ""; if ($choice->showunanswered) { echo ''; } $count = 1; foreach ($choice->option as $optionid => $optiontext) { echo ""; $count++; } echo "
"; print_string('notanswered', 'choice'); echo ""; echo format_string($optiontext); echo "
"; echo "\"\""; echo ""; echo "\"\""; echo "
'; if (!$choice->limitanswers) { echo $column[0]; echo '
('.format_float(((float)$column[0]/(float)$totalresponsecount)*100.0,1).'%)'; } echo '
"; if ($choice->limitanswers) { echo get_string("taken", "choice").":"; echo $column[$optionid].'
'; echo get_string("limit", "choice").":"; $choice_option = get_record("choice_options", "id", $optionid); echo $choice_option->maxanswers; } else { echo $column[$optionid]; echo '
('.format_float(((float)$column[$optionid]/(float)$totalresponsecount)*100.0,1).'%)'; } echo "
"; break; } } function choice_delete_responses($attemptids, $choiceid) { if(!is_array($attemptids) || empty($attemptids)) { return false; } foreach($attemptids as $num => $attemptid) { if(empty($attemptid)) { unset($attemptids[$num]); } } foreach($attemptids as $attemptid) { if ($todelete = get_record('choice_answers', 'choiceid', $choiceid, 'userid', $attemptid)) { delete_records('choice_answers', 'choiceid', $choiceid, 'userid', $attemptid); } } return true; } function choice_delete_instance($id) { // Given an ID of an instance of this module, // this function will permanently delete the instance // and any data that depends on it. if (! $choice = get_record("choice", "id", "$id")) { return false; } $result = true; if (! delete_records("choice_answers", "choiceid", "$choice->id")) { $result = false; } if (! delete_records("choice_options", "choiceid", "$choice->id")) { $result = false; } if (! delete_records("choice", "id", "$choice->id")) { $result = false; } return $result; } function choice_get_participants($choiceid) { //Returns the users with data in one choice //(users with records in choice_responses, students) global $CFG; //Get students $students = get_records_sql("SELECT DISTINCT u.id, u.id FROM {$CFG->prefix}user u, {$CFG->prefix}choice_answers a WHERE a.choiceid = '$choiceid' and u.id = a.userid"); //Return students array (it contains an array of unique users) return ($students); } function choice_get_option_text($choice, $id) { // Returns text string which is the answer that matches the id if ($result = get_record("choice_options", "id", $id)) { return $result->text; } else { return get_string("notanswered", "choice"); } } function choice_get_choice($choiceid) { // Gets a full choice record if ($choice = get_record("choice", "id", $choiceid)) { if ($options = get_records("choice_options", "choiceid", $choiceid, "id")) { foreach ($options as $option) { $choice->option[$option->id] = $option->text; $choice->maxanswers[$option->id] = $option->maxanswers; } return $choice; } } return false; } function choice_get_view_actions() { return array('view','view all','report'); } function choice_get_post_actions() { return array('choose','choose again'); } /** * Implementation of the function for printing the form elements that control * whether the course reset functionality affects the choice. * @param $mform form passed by reference */ function choice_reset_course_form_definition(&$mform) { $mform->addElement('header', 'choiceheader', get_string('modulenameplural', 'choice')); $mform->addElement('advcheckbox', 'reset_choice', get_string('removeresponses','choice')); } /** * Course reset form defaults. */ function choice_reset_course_form_defaults($course) { return array('reset_choice'=>1); } /** * Actual implementation of the rest coures functionality, delete all the * choice responses for course $data->courseid. * @param $data the data submitted from the reset course. * @return array status array */ function choice_reset_userdata($data) { global $CFG; $componentstr = get_string('modulenameplural', 'choice'); $status = array(); if (!empty($data->reset_choice)) { $choicessql = "SELECT ch.id FROM {$CFG->prefix}choice ch WHERE ch.course={$data->courseid}"; delete_records_select('choice_answers', "choiceid IN ($choicessql)"); $status[] = array('component'=>$componentstr, 'item'=>get_string('removeresponses', 'choice'), 'error'=>false); } /// updating dates - shift may be negative too if ($data->timeshift) { shift_course_mod_dates('choice', array('timeopen', 'timeclose'), $data->timeshift, $data->courseid); $status[] = array('component'=>$componentstr, 'item'=>get_string('datechanged'), 'error'=>false); } return $status; } function choice_get_response_data($choice, $cm, $groupmode) { global $CFG, $USER; $context = get_context_instance(CONTEXT_MODULE, $cm->id); /// Get the current group if ($groupmode > 0) { $currentgroup = groups_get_activity_group($cm); } else { $currentgroup = 0; } /// Initialise the returned array, which is a matrix: $allresponses[responseid][userid] = responseobject $allresponses = array(); /// First get all the users who have access here /// To start with we assume they are all "unanswered" then move them later $allresponses[0] = get_users_by_capability($context, 'mod/choice:choose', 'u.id, u.picture, u.firstname, u.lastname, u.idnumber', 'u.lastname ASC,u.firstname ASC', '', '', $currentgroup, '', false, true); /// Get all the recorded responses for this choice $rawresponses = get_records('choice_answers', 'choiceid', $choice->id); /// Use the responses to move users into the correct column if ($rawresponses) { foreach ($rawresponses as $response) { if (isset($allresponses[0][$response->userid])) { // This person is enrolled and in correct group $allresponses[0][$response->userid]->timemodified = $response->timemodified; $allresponses[$response->optionid][$response->userid] = clone($allresponses[0][$response->userid]); unset($allresponses[0][$response->userid]); // Remove from unanswered column } } } if (empty($allresponses[0])) { unset($allresponses[0]); } return $allresponses; } /** * Returns all other caps used in module */ function choice_get_extra_capabilities() { return array('moodle/site:accessallgroups'); } ?>