. /** * Moodle renderer used to display special elements of the lesson module * * @package mod_choice * @copyright 2010 Rossiani Wijaya * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later **/ define ('DISPLAY_HORIZONTAL_LAYOUT', 0); define ('DISPLAY_VERTICAL_LAYOUT', 1); class mod_choice_renderer extends plugin_renderer_base { /** * Returns HTML to display choices of option * @param object $options * @param int $coursemoduleid * @param bool $vertical * @return string */ public function display_options($options, $coursemoduleid, $vertical = false, $multiple = false) { $layoutclass = 'horizontal'; if ($vertical) { $layoutclass = 'vertical'; } $target = new moodle_url('/mod/choice/view.php'); $attributes = array('method'=>'POST', 'action'=>$target, 'class'=> $layoutclass); $disabled = empty($options['previewonly']) ? array() : array('disabled' => 'disabled'); $html = html_writer::start_tag('form', $attributes); $html .= html_writer::start_tag('ul', array('class'=>'choices' )); $availableoption = count($options['options']); $choicecount = 0; foreach ($options['options'] as $option) { $choicecount++; $html .= html_writer::start_tag('li', array('class'=>'option')); if ($multiple) { $option->attributes->name = 'answer[]'; $option->attributes->type = 'checkbox'; } else { $option->attributes->name = 'answer'; $option->attributes->type = 'radio'; } $option->attributes->id = 'choice_'.$choicecount; $labeltext = $option->text; if (!empty($option->attributes->disabled)) { $labeltext .= ' ' . get_string('full', 'choice'); $availableoption--; } $html .= html_writer::empty_tag('input', (array)$option->attributes + $disabled); $html .= html_writer::tag('label', $labeltext, array('for'=>$option->attributes->id)); $html .= html_writer::end_tag('li'); } $html .= html_writer::tag('li','', array('class'=>'clearfloat')); $html .= html_writer::end_tag('ul'); $html .= html_writer::tag('div', '', array('class'=>'clearfloat')); $html .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=>sesskey())); $html .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'action', 'value'=>'makechoice')); $html .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=>$coursemoduleid)); if (empty($options['previewonly'])) { if (!empty($options['hascapability']) && ($options['hascapability'])) { if ($availableoption < 1) { $html .= html_writer::tag('label', get_string('choicefull', 'choice')); } else { $html .= html_writer::empty_tag('input', array('type' => 'submit', 'value' => get_string('savemychoice', 'choice'), 'class' => 'button')); } if (!empty($options['allowupdate']) && ($options['allowupdate'])) { $url = new moodle_url('view.php', array('id' => $coursemoduleid, 'action' => 'delchoice', 'sesskey' => sesskey())); $html .= html_writer::link($url, get_string('removemychoice', 'choice')); } } else { $html .= html_writer::tag('label', get_string('havetologin', 'choice')); } } $html .= html_writer::end_tag('ul'); $html .= html_writer::end_tag('form'); return $html; } /** * Returns HTML to display choices result * @param object $choices * @param bool $forcepublish * @return string */ public function display_result($choices, $forcepublish = false) { if (empty($forcepublish)) { //allow the publish setting to be overridden $forcepublish = $choices->publish; } $displaylayout = $choices->display; if ($forcepublish) { //CHOICE_PUBLISH_NAMES return $this->display_publish_name_vertical($choices); } else { //CHOICE_PUBLISH_ANONYMOUS'; if ($displaylayout == DISPLAY_HORIZONTAL_LAYOUT) { return $this->display_publish_anonymous_horizontal($choices); } return $this->display_publish_anonymous_vertical($choices); } } /** * Returns HTML to display choices result * @param object $choices * @param bool $forcepublish * @return string */ public function display_publish_name_vertical($choices) { global $PAGE; $html =''; $html .= html_writer::tag('h3',format_string(get_string("responses", "choice"))); $attributes = array('method'=>'POST'); $attributes['action'] = new moodle_url($PAGE->url); $attributes['id'] = 'attemptsform'; if ($choices->viewresponsecapability) { $html .= html_writer::start_tag('form', $attributes); $html .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'id', 'value'=> $choices->coursemoduleid)); $html .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'sesskey', 'value'=> sesskey())); $html .= html_writer::empty_tag('input', array('type'=>'hidden', 'name'=>'mode', 'value'=>'overview')); } $table = new html_table(); $table->cellpadding = 0; $table->cellspacing = 0; $table->attributes['class'] = 'results names '; $table->tablealign = 'center'; $table->summary = get_string('responsesto', 'choice', format_string($choices->name)); $table->data = array(); $count = 0; ksort($choices->options); $columns = array(); $celldefault = new html_table_cell(); $celldefault->attributes['class'] = 'data'; // This extra cell is needed in order to support accessibility for screenreader. MDL-30816 $accessiblecell = new html_table_cell(); $accessiblecell->scope = 'row'; $accessiblecell->text = get_string('choiceoptions', 'choice'); $columns['options'][] = $accessiblecell; $usernumberheader = clone($celldefault); $usernumberheader->header = true; $usernumberheader->attributes['class'] = 'header data'; $usernumberheader->text = get_string('numberofuser', 'choice'); $columns['usernumber'][] = $usernumberheader; foreach ($choices->options as $optionid => $options) { $celloption = clone($celldefault); $cellusernumber = clone($celldefault); $cellusernumber->style = 'text-align: center;'; $celltext = ''; if ($choices->showunanswered && $optionid == 0) { $celltext = format_string(get_string('notanswered', 'choice')); } else if ($optionid > 0) { $celltext = format_string($choices->options[$optionid]->text); } $numberofuser = 0; if (!empty($options->user) && count($options->user) > 0) { $numberofuser = count($options->user); } $celloption->text = $celltext; $cellusernumber->text = $numberofuser; $columns['options'][] = $celloption; $columns['usernumber'][] = $cellusernumber; } $table->head = $columns['options']; $table->data[] = new html_table_row($columns['usernumber']); $columns = array(); // This extra cell is needed in order to support accessibility for screenreader. MDL-30816 $accessiblecell = new html_table_cell(); $accessiblecell->text = get_string('userchoosethisoption', 'choice'); $accessiblecell->header = true; $accessiblecell->scope = 'row'; $accessiblecell->attributes['class'] = 'header data'; $columns[] = $accessiblecell; foreach ($choices->options as $optionid => $options) { $cell = new html_table_cell(); $cell->attributes['class'] = 'data'; if ($choices->showunanswered || $optionid > 0) { if (!empty($options->user)) { $optionusers = ''; foreach ($options->user as $user) { $data = ''; if (empty($user->imagealt)){ $user->imagealt = ''; } $userfullname = fullname($user, $choices->fullnamecapability); if ($choices->viewresponsecapability && $choices->deleterepsonsecapability && $optionid > 0) { $attemptaction = html_writer::label($userfullname, 'attempt-user'.$user->id, false, array('class' => 'accesshide')); $attemptaction .= html_writer::checkbox('attemptid[]', $user->answerid, '', null, array('id' => 'attempt-user'.$user->id)); $data .= html_writer::tag('div', $attemptaction, array('class'=>'attemptaction')); } $userimage = $this->output->user_picture($user, array('courseid'=>$choices->courseid)); $data .= html_writer::tag('div', $userimage, array('class'=>'image')); $userlink = new moodle_url('/user/view.php', array('id'=>$user->id,'course'=>$choices->courseid)); $name = html_writer::tag('a', $userfullname, array('href'=>$userlink, 'class'=>'username')); $data .= html_writer::tag('div', $name, array('class'=>'fullname')); $data .= html_writer::tag('div','', array('class'=>'clearfloat')); $optionusers .= html_writer::tag('div', $data, array('class'=>'user')); } $cell->text = $optionusers; } } $columns[] = $cell; $count++; } $row = new html_table_row($columns); $table->data[] = $row; $html .= html_writer::tag('div', html_writer::table($table), array('class'=>'response')); $actiondata = ''; if ($choices->viewresponsecapability && $choices->deleterepsonsecapability) { $selecturl = new moodle_url('#'); $selectallactions = new component_action('click',"checkall"); $selectall = new action_link($selecturl, get_string('selectall'), $selectallactions); $actiondata .= $this->output->render($selectall) . ' / '; $deselectallactions = new component_action('click',"checknone"); $deselectall = new action_link($selecturl, get_string('deselectall'), $deselectallactions); $actiondata .= $this->output->render($deselectall); $actiondata .= html_writer::tag('label', ' ' . get_string('withselected', 'choice') . ' ', array('for'=>'menuaction')); $actionurl = new moodle_url($PAGE->url, array('sesskey'=>sesskey(), 'action'=>'delete_confirmation()')); $select = new single_select($actionurl, 'action', array('delete'=>get_string('delete')), null, array(''=>get_string('chooseaction', 'choice')), 'attemptsform'); $actiondata .= $this->output->render($select); } $html .= html_writer::tag('div', $actiondata, array('class'=>'responseaction')); if ($choices->viewresponsecapability) { $html .= html_writer::end_tag('form'); } return $html; } /** * Returns HTML to display choices result * @param object $choices * @return string */ public function display_publish_anonymous_vertical($choices) { global $CHOICE_COLUMN_HEIGHT; $html = ''; $table = new html_table(); $table->cellpadding = 5; $table->cellspacing = 0; $table->attributes['class'] = 'results anonymous '; $table->summary = get_string('responsesto', 'choice', format_string($choices->name)); $table->data = array(); $count = 0; ksort($choices->options); $columns = array(); $rows = array(); $headercelldefault = new html_table_cell(); $headercelldefault->scope = 'row'; $headercelldefault->header = true; $headercelldefault->attributes = array('class'=>'header data'); // column header $tableheader = clone($headercelldefault); $tableheader->text = html_writer::tag('div', get_string('choiceoptions', 'choice'), array('class' => 'accesshide')); $rows['header'][] = $tableheader; // graph row header $graphheader = clone($headercelldefault); $graphheader->text = html_writer::tag('div', get_string('responsesresultgraphheader', 'choice'), array('class' => 'accesshide')); $rows['graph'][] = $graphheader; // user number row header $usernumberheader = clone($headercelldefault); $usernumberheader->text = get_string('numberofuser', 'choice'); $rows['usernumber'][] = $usernumberheader; // user percentage row header $userpercentageheader = clone($headercelldefault); $userpercentageheader->text = get_string('numberofuserinpercentage', 'choice'); $rows['userpercentage'][] = $userpercentageheader; $contentcelldefault = new html_table_cell(); $contentcelldefault->attributes = array('class'=>'data'); foreach ($choices->options as $optionid => $option) { // calculate display length $height = $percentageamount = $numberofuser = 0; $usernumber = $userpercentage = ''; if (!empty($option->user)) { $numberofuser = count($option->user); } if($choices->numberofuser > 0) { $height = ($CHOICE_COLUMN_HEIGHT * ((float)$numberofuser / (float)$choices->numberofuser)); $percentageamount = ((float)$numberofuser/(float)$choices->numberofuser)*100.0; } $displaygraph = html_writer::tag('img','', array('style'=>'height:'.$height.'px;width:49px;', 'alt'=>'', 'src'=>$this->output->pix_url('column', 'choice'))); // header $headercell = clone($contentcelldefault); $headercell->text = $option->text; $rows['header'][] = $headercell; // Graph $graphcell = clone($contentcelldefault); $graphcell->attributes = array('class'=>'graph vertical data'); $graphcell->text = $displaygraph; $rows['graph'][] = $graphcell; $usernumber .= html_writer::tag('div', ' '.$numberofuser.'', array('class'=>'numberofuser', 'title'=> get_string('numberofuser', 'choice'))); $userpercentage .= html_writer::tag('div', format_float($percentageamount,1). '%', array('class'=>'percentage')); // number of user $usernumbercell = clone($contentcelldefault); $usernumbercell->text = $usernumber; $rows['usernumber'][] = $usernumbercell; // percentage of user $numbercell = clone($contentcelldefault); $numbercell->text = $userpercentage; $rows['userpercentage'][] = $numbercell; } $table->head = $rows['header']; $trgraph = new html_table_row($rows['graph']); $trusernumber = new html_table_row($rows['usernumber']); $truserpercentage = new html_table_row($rows['userpercentage']); $table->data = array($trgraph, $trusernumber, $truserpercentage); $header = html_writer::tag('h3',format_string(get_string("responses", "choice"))); $html .= html_writer::tag('div', $header, array('class'=>'responseheader')); $html .= html_writer::tag('div', html_writer::table($table), array('class'=>'response')); return $html; } /** * Returns HTML to display choices result * @param object $choices * @return string */ public function display_publish_anonymous_horizontal($choices) { global $CHOICE_COLUMN_WIDTH; $table = new html_table(); $table->cellpadding = 5; $table->cellspacing = 0; $table->attributes['class'] = 'results anonymous '; $table->summary = get_string('responsesto', 'choice', format_string($choices->name)); $table->data = array(); $columnheaderdefault = new html_table_cell(); $columnheaderdefault->scope = 'col'; $tableheadertext = clone($columnheaderdefault); $tableheadertext->text = get_string('choiceoptions', 'choice'); $tableheadernumber = clone($columnheaderdefault); $tableheadernumber->text = get_string('numberofuser', 'choice'); $tableheaderpercentage = clone($columnheaderdefault); $tableheaderpercentage->text = get_string('numberofuserinpercentage', 'choice'); $tableheadergraph = clone($columnheaderdefault); $tableheadergraph->text = get_string('responsesresultgraphheader', 'choice'); $table->head = array($tableheadertext, $tableheadernumber, $tableheaderpercentage, $tableheadergraph); $count = 0; ksort($choices->options); $columndefault = new html_table_cell(); $columndefault->attributes['class'] = 'data'; $colheaderdefault = new html_table_cell(); $colheaderdefault->scope = 'row'; $colheaderdefault->header = true; $colheaderdefault->attributes['class'] = 'header data'; $rows = array(); foreach ($choices->options as $optionid => $options) { $colheader = clone($colheaderdefault); $colheader->text = $options->text; $graphcell = clone($columndefault); $datacellnumber = clone($columndefault); $datacellpercentage = clone($columndefault); $numberofuser = $width = $percentageamount = 0; if (!empty($options->user)) { $numberofuser = count($options->user); } if($choices->numberofuser > 0) { $width = ($CHOICE_COLUMN_WIDTH * ((float)$numberofuser / (float)$choices->numberofuser)); $percentageamount = ((float)$numberofuser/(float)$choices->numberofuser)*100.0; } $attributes = array(); $attributes['style'] = 'height:50px; width:'.$width.'px'; $attributes['alt'] = ''; $attributes['src'] = $this->output->pix_url('row', 'choice'); $displaydiagram = html_writer::tag('img','', $attributes); $graphcell->text = $displaydiagram; $graphcell->attributes = array('class'=>'graph horizontal'); if($choices->numberofuser > 0) { $percentageamount = ((float)$numberofuser/(float)$choices->numberofuser)*100.0; } $datacellnumber->text = $numberofuser; $datacellpercentage->text = format_float($percentageamount,1). '%'; $row = new html_table_row(); $row->cells = array($colheader, $datacellnumber, $datacellpercentage, $graphcell); $rows[] = $row; } $table->data = $rows; $html = ''; $header = html_writer::tag('h3',format_string(get_string("responses", "choice"))); $html .= html_writer::tag('div', $header, array('class'=>'responseheader')); $html .= html_writer::table($table); return $html; } }