From 198db4f823bb05becfcaa03c7877c024c4c286c2 Mon Sep 17 00:00:00 2001 From: Yannick Warnier Date: Sat, 19 Apr 2014 18:06:36 -0500 Subject: [PATCH] Minor - Improved phpdoc and code alignment - refs #6720 --- main/exercice/unique_answer.class.php | 690 ++++++++++++++++---------- 1 file changed, 426 insertions(+), 264 deletions(-) diff --git a/main/exercice/unique_answer.class.php b/main/exercice/unique_answer.class.php index 4dd09fd6a1..467ccc476b 100644 --- a/main/exercice/unique_answer.class.php +++ b/main/exercice/unique_answer.class.php @@ -1,352 +1,487 @@ type = UNIQUE_ANSWER; - $this -> isContent = $this-> getIsContent(); - } - - /** - * function which redefines Question::createAnswersForm - * @param the formvalidator instance - * @param the answers number to display - */ - function createAnswersForm ($form) + /** + * Constructor + */ + public function UniqueAnswer() { - // Getting the exercise list - $obj_ex = $_SESSION['objExercise']; - - $editor_config = array('ToolbarSet' => 'TestProposedAnswer', 'Width' => '100%', 'Height' => '125'); - - //this line define how many question by default appear when creating a choice question - $nb_answers = isset($_POST['nb_answers']) ? (int) $_POST['nb_answers'] : 4; // The previous default value was 2. See task #1759. - $nb_answers += (isset($_POST['lessAnswers']) ? -1 : (isset($_POST['moreAnswers']) ? 1 : 0)); - - /* - Types of Feedback - $feedback_option[0]=get_lang('Feedback'); - $feedback_option[1]=get_lang('DirectFeedback'); - $feedback_option[2]=get_lang('NoFeedback'); - */ - - $feedback_title=''; - $comment_title=''; + //this is highly important + parent::question(); + $this->type = UNIQUE_ANSWER; + $this->isContent = $this->getIsContent(); + } - if ($obj_ex->selectFeedbackType() == EXERCISE_FEEDBACK_TYPE_DIRECT) { + /** + * function which redefines Question::createAnswersForm + * @param the formvalidator instance + * @param the answers number to display + */ + public function createAnswersForm($form) + { + // Getting the exercise list + $obj_ex = $_SESSION['objExercise']; + + $editor_config = array( + 'ToolbarSet' => 'TestProposedAnswer', + 'Width' => '100%', + 'Height' => '125' + ); + + //this line defines how many questions by default appear when creating a choice question + // The previous default value was 2. See task #1759. + $nb_answers = isset($_POST['nb_answers']) ? (int)$_POST['nb_answers'] : 4; + $nb_answers += (isset($_POST['lessAnswers']) ? -1 : (isset($_POST['moreAnswers']) ? 1 : 0)); + + /* + Types of Feedback + $feedback_option[0]=get_lang('Feedback'); + $feedback_option[1]=get_lang('DirectFeedback'); + $feedback_option[2]=get_lang('NoFeedback'); + */ + + $feedback_title = ''; + $comment_title = ''; + + if ($obj_ex->selectFeedbackType() == EXERCISE_FEEDBACK_TYPE_DIRECT) { //Scenario - $editor_config['Width'] = '250'; - $editor_config['Height'] = '110'; - $comment_title = ''.get_lang('Comment').''; - $feedback_title = ''.get_lang('Scenario').''; - } - else { - $comment_title = ''.get_lang('Comment').''; + $editor_config['Width'] = '250'; + $editor_config['Height'] = '110'; + $comment_title = '' . get_lang( + 'Comment' + ) . ''; + $feedback_title = '' . get_lang( + 'Scenario' + ) . ''; + } else { + $comment_title = '' . get_lang('Comment') . ''; } - $html=' + $html = '
- '.$comment_title.' - '.$feedback_title.' + ' . $comment_title . ' + ' . $feedback_title . ' '; - $form -> addElement ('label', get_lang('Answers').'
', $html); - - $defaults = array(); - $correct = 0; - if(!empty($this -> id)) { - $answer = new Answer($this -> id); - $answer -> read(); - if(count($answer->nbrAnswers)>0 && !$form->isSubmitted()) { - $nb_answers = $answer->nbrAnswers; - } - } - $form -> addElement('hidden', 'nb_answers'); - - //Feedback SELECT - $question_list = $obj_ex->selectQuestionList(); - $select_question=array(); - $select_question[0] = get_lang('SelectTargetQuestion'); - - require_once '../newscorm/learnpathList.class.php'; - if (is_array($question_list)) { - foreach ($question_list as $key=>$questionid) { - //To avoid warning messages - if (!is_numeric($questionid)) { - continue; - } - $question = Question::read($questionid); - $select_question[$questionid]='Q'.$key.' :'.cut($question->selectTitle(),20); - } - } - $select_question[-1] = get_lang('ExitTest'); - - $list = new LearnpathList(api_get_user_id()); - $flat_list = $list->get_flat_list(); - $select_lp_id=array(); - $select_lp_id[0]=get_lang('SelectTargetLP'); - - foreach ($flat_list as $id => $details) { - $select_lp_id[$id] = cut($details['lp_name'],20); - } - - $temp_scenario = array(); + $form->addElement( + 'label', + get_lang('Answers') . '
', + $html + ); + + $defaults = array(); + $correct = 0; + if (!empty($this->id)) { + $answer = new Answer($this->id); + $answer->read(); + if (count($answer->nbrAnswers) > 0 && !$form->isSubmitted()) { + $nb_answers = $answer->nbrAnswers; + } + } + $form->addElement('hidden', 'nb_answers'); + + //Feedback SELECT + $question_list = $obj_ex->selectQuestionList(); + $select_question = array(); + $select_question[0] = get_lang('SelectTargetQuestion'); + + require_once '../newscorm/learnpathList.class.php'; + if (is_array($question_list)) { + foreach ($question_list as $key => $questionid) { + //To avoid warning messages + if (!is_numeric($questionid)) { + continue; + } + $question = Question::read($questionid); + $select_question[$questionid] = 'Q' . $key . ' :' . cut( + $question->selectTitle(), + 20 + ); + } + } + $select_question[-1] = get_lang('ExitTest'); + + $list = new LearnpathList(api_get_user_id()); + $flat_list = $list->get_flat_list(); + $select_lp_id = array(); + $select_lp_id[0] = get_lang('SelectTargetLP'); + + foreach ($flat_list as $id => $details) { + $select_lp_id[$id] = cut($details['lp_name'], 20); + } + + $temp_scenario = array(); if ($nb_answers < 1) { $nb_answers = 1; - Display::display_normal_message(get_lang('YouHaveToCreateAtLeastOneAnswer')); + Display::display_normal_message( + get_lang('YouHaveToCreateAtLeastOneAnswer') + ); } - for ($i = 1 ; $i <= $nb_answers ; ++$i) { - $form -> addElement ('html', ''); + for ($i = 1; $i <= $nb_answers; ++$i) { + $form->addElement('html', ''); if (isset($answer) && is_object($answer)) { if ($answer->correct[$i]) { $correct = $i; } - $defaults['answer['.$i.']'] = $answer->answer[$i]; - $defaults['comment['.$i.']'] = $answer->comment[$i]; - $defaults['weighting['.$i.']'] = float_format($answer->weighting[$i], 1); + $defaults['answer[' . $i . ']'] = $answer->answer[$i]; + $defaults['comment[' . $i . ']'] = $answer->comment[$i]; + $defaults['weighting[' . $i . ']'] = float_format( + $answer->weighting[$i], + 1 + ); - $item_list=explode('@@',$answer -> destination[$i]); + $item_list = explode('@@', $answer->destination[$i]); - $try = $item_list[0]; - $lp = $item_list[1]; + $try = $item_list[0]; + $lp = $item_list[1]; $list_dest = $item_list[2]; - $url = $item_list[3]; + $url = $item_list[3]; - if ($try==0) { + if ($try == 0) { $try_result = 0; } else { $try_result = 1; } - if ($url==0) { - $url_result=''; + if ($url == 0) { + $url_result = ''; } else { $url_result = $url; } - $temp_scenario['url'.$i] = $url_result; - $temp_scenario['try'.$i] = $try_result; - $temp_scenario['lp'.$i] = $lp; - $temp_scenario['destination'.$i]= $list_dest; + $temp_scenario['url' . $i] = $url_result; + $temp_scenario['try' . $i] = $try_result; + $temp_scenario['lp' . $i] = $lp; + $temp_scenario['destination' . $i] = $list_dest; } else { - $defaults['answer[1]'] = get_lang('DefaultUniqueAnswer1'); - $defaults['weighting[1]'] = 10; - $defaults['answer[2]'] = get_lang('DefaultUniqueAnswer2'); - $defaults['weighting[2]'] = 0; + $defaults['answer[1]'] = get_lang('DefaultUniqueAnswer1'); + $defaults['weighting[1]'] = 10; + $defaults['answer[2]'] = get_lang('DefaultUniqueAnswer2'); + $defaults['weighting[2]'] = 0; - $temp_scenario['destination'.$i] = array('0'); - $temp_scenario['lp'.$i] = array('0'); + $temp_scenario['destination' . $i] = array('0'); + $temp_scenario['lp' . $i] = array('0'); } $defaults['scenario'] = $temp_scenario; $renderer = $form->defaultRenderer(); - $renderer->setElementTemplate('', 'correct'); - $renderer->setElementTemplate('', 'counter['.$i.']'); - $renderer->setElementTemplate('', 'answer['.$i.']'); - $renderer->setElementTemplate('', 'comment['.$i.']'); - $renderer->setElementTemplate('', 'weighting['.$i.']'); - - $answer_number = $form->addElement('text', 'counter['.$i.']',null,' value = "'.$i.'"'); + $renderer->setElementTemplate( + '', + 'correct' + ); + $renderer->setElementTemplate( + '', + 'counter[' . $i . ']' + ); + $renderer->setElementTemplate( + '', + 'answer[' . $i . ']' + ); + $renderer->setElementTemplate( + '', + 'comment[' . $i . ']' + ); + $renderer->setElementTemplate( + '', + 'weighting[' . $i . ']' + ); + + $answer_number = $form->addElement( + 'text', + 'counter[' . $i . ']', + null, + ' value = "' . $i . '"' + ); $answer_number->freeze(); - $form->addElement('radio', 'correct', null, null, $i, 'class="checkbox" style="margin-left: 0em;"'); - $form->addElement('html_editor', 'answer['.$i.']', null, 'style="vertical-align:middle"', $editor_config); - - $form->addRule('answer['.$i.']', get_lang('ThisFieldIsRequired'), 'required'); - - if ($obj_ex->selectFeedbackType() == EXERCISE_FEEDBACK_TYPE_DIRECT) { - $form->addElement('html_editor', 'comment['.$i.']', null, 'style="vertical-align:middle"', $editor_config); + $form->addElement( + 'radio', + 'correct', + null, + null, + $i, + 'class="checkbox" style="margin-left: 0em;"' + ); + $form->addElement( + 'html_editor', + 'answer[' . $i . ']', + null, + 'style="vertical-align:middle"', + $editor_config + ); + + $form->addRule( + 'answer[' . $i . ']', + get_lang('ThisFieldIsRequired'), + 'required' + ); + + if ($obj_ex->selectFeedbackType() == EXERCISE_FEEDBACK_TYPE_DIRECT + ) { + $form->addElement( + 'html_editor', + 'comment[' . $i . ']', + null, + 'style="vertical-align:middle"', + $editor_config + ); // Direct feedback //Adding extra feedback fields $group = array(); - $group['try'.$i] = $form->createElement('checkbox', 'try'.$i, null , get_lang('TryAgain')); - $group['lp'.$i] = $form->createElement('select', 'lp'.$i, get_lang('SeeTheory').': ', $select_lp_id); - $group['destination'.$i]= $form->createElement('select', 'destination'.$i, get_lang('GoToQuestion').': ' , $select_question); - $group['url'.$i] = $form->createElement('text', 'url'.$i, get_lang('Other').': ', array('class'=>'span2', 'placeholder' => get_lang('Other'))); + $group['try' . $i] = $form->createElement( + 'checkbox', + 'try' . $i, + null, + get_lang('TryAgain') + ); + $group['lp' . $i] = $form->createElement( + 'select', + 'lp' . $i, + get_lang('SeeTheory') . ': ', + $select_lp_id + ); + $group['destination' . $i] = $form->createElement( + 'select', + 'destination' . $i, + get_lang('GoToQuestion') . ': ', + $select_question + ); + $group['url' . $i] = $form->createElement( + 'text', + 'url' . $i, + get_lang('Other') . ': ', + array( + 'class' => 'span2', + 'placeholder' => get_lang('Other') + ) + ); $form->addGroup($group, 'scenario'); - $renderer->setElementTemplate(''); + $form->addElement( + 'text', + 'weighting[' . $i . ']', + null, + array('class' => "span1", 'value' => '0') + ); + $form->addElement('html', ''); } - $form -> addElement ('html', '
- '.get_lang('Number').' + ' . get_lang('Number') . ' - '.get_lang('True').' + ' . get_lang('True') . ' - '.get_lang('Answer').' + ' . get_lang('Answer') . ' - '.get_lang('Weighting').' + ' . get_lang('Weighting') . '
{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}		{error}
{element}', 'scenario'); + $renderer->setElementTemplate( + '		{error}
{element}', + 'scenario' + ); + } else { + $form->addElement( + 'html_editor', + 'comment[' . $i . ']', + null, + 'style="vertical-align:middle"', + $editor_config + ); } - else { - $form->addElement('html_editor', 'comment['.$i.']', null, 'style="vertical-align:middle"', $editor_config); - } - $form->addElement('text', 'weighting['.$i.']', null, array('class' => "span1", 'value' => '0')); - $form->addElement ('html', '
'); - $form -> addElement ('html', '
'); + $form->addElement('html', ''); + $form->addElement('html', '
'); + + $navigator_info = api_get_navigator(); + + global $text, $class; + + //ie6 fix + if ($obj_ex->edit_exercise_in_lp == true) { + if ($navigator_info['name'] == 'Internet Explorer' && $navigator_info['version'] == '6') { + $form->addElement( + 'submit', + 'lessAnswers', + get_lang('LessAnswer'), + 'class="btn minus"' + ); + $form->addElement( + 'submit', + 'moreAnswers', + get_lang('PlusAnswer'), + 'class="btn plus"' + ); + $form->addElement( + 'submit', + 'submitQuestion', + $text, + 'class="' . $class . '"' + ); + } else { + //setting the save button here and not in the question class.php + $form->addElement( + 'style_submit_button', + 'lessAnswers', + get_lang('LessAnswer'), + 'class="btn minus"' + ); + $form->addElement( + 'style_submit_button', + 'moreAnswers', + get_lang('PlusAnswer'), + 'class="btn plus"' + ); + $form->addElement( + 'style_submit_button', + 'submitQuestion', + $text, + 'class="' . $class . '"' + ); + } + } + $renderer->setElementTemplate('{element} ', 'submitQuestion'); + $renderer->setElementTemplate('{element} ', 'lessAnswers'); + $renderer->setElementTemplate('{element} ', 'moreAnswers'); - $navigator_info = api_get_navigator(); + $form->addElement('html', ''); - global $text, $class; + //We check the first radio button to be sure a radio button will be check + if ($correct == 0) { + $correct = 1; + } + $defaults['correct'] = $correct; - //ie6 fix - if ($obj_ex->edit_exercise_in_lp == true) { - if ($navigator_info['name']=='Internet Explorer' && $navigator_info['version']=='6') { - $form->addElement('submit', 'lessAnswers', get_lang('LessAnswer'),'class="btn minus"'); - $form->addElement('submit', 'moreAnswers', get_lang('PlusAnswer'),'class="btn plus"'); - $form->addElement('submit','submitQuestion',$text, 'class="'.$class.'"'); - } else { - //setting the save button here and not in the question class.php - $form->addElement('style_submit_button', 'lessAnswers', get_lang('LessAnswer'),'class="btn minus"'); - $form->addElement('style_submit_button', 'moreAnswers', get_lang('PlusAnswer'),'class="btn plus"'); - $form->addElement('style_submit_button', 'submitQuestion',$text, 'class="'.$class.'"'); - } - } - $renderer->setElementTemplate('{element} ','submitQuestion'); - $renderer->setElementTemplate('{element} ','lessAnswers'); - $renderer->setElementTemplate('{element} ','moreAnswers'); + if (!empty($this->id)) { + $form->setDefaults($defaults); + } else { + if ($this->isContent == 1) { + $form->setDefaults($defaults); + } + } + $form->setConstants(array('nb_answers' => $nb_answers)); + } - $form->addElement('html', ''); - //We check the first radio button to be sure a radio button will be check - if ($correct==0) { - $correct=1; - } - $defaults['correct'] = $correct; - - if (!empty($this -> id)) { - $form -> setDefaults($defaults); - } else { - if ($this -> isContent == 1) { - $form -> setDefaults($defaults); - } - } - $form->setConstants(array('nb_answers' => $nb_answers)); - } - - - /** - * Receives the unique answer question type creation form data and creates + /** + * Receives the unique answer question type creation form data and creates * or updates the answers from that question - * @param FormValidator $form - */ - function processAnswersCreation($form) + * @param FormValidator $form + */ + public function processAnswersCreation($form) { - $questionWeighting = $nbrGoodAnswers = 0; - $correct = $form->getSubmitValue('correct'); - $objAnswer = new Answer($this->id); - $nb_answers = $form->getSubmitValue('nb_answers'); + $questionWeighting = $nbrGoodAnswers = 0; + $correct = $form->getSubmitValue('correct'); + $objAnswer = new Answer($this->id); + $nb_answers = $form->getSubmitValue('nb_answers'); - for ($i=1 ; $i <= $nb_answers ; $i++) { - $answer = trim($form -> getSubmitValue('answer['.$i.']')); - $comment = trim($form -> getSubmitValue('comment['.$i.']')); - $weighting = trim($form -> getSubmitValue('weighting['.$i.']')); + for ($i = 1; $i <= $nb_answers; $i++) { + $answer = trim($form->getSubmitValue('answer[' . $i . ']')); + $comment = trim($form->getSubmitValue('comment[' . $i . ']')); + $weighting = trim($form->getSubmitValue('weighting[' . $i . ']')); - $scenario = $form -> getSubmitValue('scenario'); + $scenario = $form->getSubmitValue('scenario'); - //$list_destination = $form -> getSubmitValue('destination'.$i); - //$destination_str = $form -> getSubmitValue('destination'.$i); + //$list_destination = $form -> getSubmitValue('destination'.$i); + //$destination_str = $form -> getSubmitValue('destination'.$i); - $try = $scenario['try'.$i]; - $lp = $scenario['lp'.$i]; - $destination = $scenario['destination'.$i]; - $url = trim($scenario['url'.$i]); + $try = $scenario['try' . $i]; + $lp = $scenario['lp' . $i]; + $destination = $scenario['destination' . $i]; + $url = trim($scenario['url' . $i]); - /* - How we are going to parse the destination value + /* + How we are going to parse the destination value - here we parse the destination value which is a string - 1@@3@@2;4;4;@@http://www.chamilo.org + here we parse the destination value which is a string + 1@@3@@2;4;4;@@http://www.chamilo.org - where: try_again@@lp_id@@selected_questions@@url + where: try_again@@lp_id@@selected_questions@@url - try_again = is 1 || 0 - lp_id = id of a learning path (0 if dont select) - selected_questions= ids of questions - url= an url + try_again = is 1 || 0 + lp_id = id of a learning path (0 if dont select) + selected_questions= ids of questions + url= an url - $destination_str=''; - foreach ($list_destination as $destination_id) - { - $destination_str.=$destination_id.';'; - }*/ + $destination_str=''; + foreach ($list_destination as $destination_id) + { + $destination_str.=$destination_id.';'; + }*/ - $goodAnswer = ($correct == $i) ? true : false; + $goodAnswer = ($correct == $i) ? true : false; - if ($goodAnswer) { - $nbrGoodAnswers++; - $weighting = abs($weighting); - if($weighting > 0) { + if ($goodAnswer) { + $nbrGoodAnswers++; + $weighting = abs($weighting); + if ($weighting > 0) { $questionWeighting += $weighting; } - } + } - if (empty($try)) { - $try = 0; + if (empty($try)) { + $try = 0; } - if (empty($lp)) { - $lp = 0; - } + if (empty($lp)) { + $lp = 0; + } - if (empty($destination)) { - $destination=0; - } + if (empty($destination)) { + $destination = 0; + } - if ($url=='') { - $url=0; - } + if ($url == '') { + $url = 0; + } - //1@@1;2;@@2;4;4;@@http://www.chamilo.org - $dest = $try.'@@'.$lp.'@@'.$destination.'@@'.$url; - $objAnswer->createAnswer($answer, $goodAnswer, $comment, $weighting, $i, null, null, $dest); + //1@@1;2;@@2;4;4;@@http://www.chamilo.org + $dest = $try . '@@' . $lp . '@@' . $destination . '@@' . $url; + $objAnswer->createAnswer( + $answer, + $goodAnswer, + $comment, + $weighting, + $i, + null, + null, + $dest + ); } - // saves the answers into the data base + // saves the answers into the data base $objAnswer->save(); // sets the total weighting of the question $this->updateWeighting($questionWeighting); $this->save(); - } + } /** * Helper function to print the column titles in the answers edition form @@ -355,15 +490,18 @@ class UniqueAnswer extends Question * @param null $score The maximum score for the question * @return string HTML string for a table header + a wrapper before it */ - function return_header($feedback_type = null, $counter = null, $score = null) - { - $header = parent::return_header($feedback_type, $counter, $score); - $header .= ' + public function return_header( + $feedback_type = null, + $counter = null, + $score = null + ) { + $header = parent::return_header($feedback_type, $counter, $score); + $header .= '
- - - '; - $header .= ''; + + + '; + $header .= ''; $header .= ''; return $header; @@ -375,11 +513,17 @@ class UniqueAnswer extends Question * @param int $question_id The question ID (to which the answer is attached) * @param string $title The text of the answer * @param string $comment The feedback for the answer - * @param float $score The score you get when picking this answer - * @param int $correct Whether this answer is considered *the* correct one (this is the unique answer type) + * @param float|null $score The score you get when picking this answer + * @param int|null $correct Whether this answer is considered *the* correct one (this is the unique answer type) */ - function addAnswer($id, $question_id, $title, $comment, $score = 0, $correct = 0) - { + public function addAnswer( + $id, + $question_id, + $title, + $comment, + $score = 0.0, + $correct = 0 + ) { $tbl_quiz_answer = Database::get_course_table(TABLE_QUIZ_ANSWER); $tbl_quiz_question = Database::get_course_table(TABLE_QUIZ_QUESTION); $course_id = api_get_course_int_id(); @@ -394,17 +538,35 @@ class UniqueAnswer extends Question WHERE c_id = $course_id AND question_id = $question_id"; - $rs_max = Database::query($sql); + $rs_max = Database::query($sql); $row_max = Database::fetch_object($rs_max); $position = $row_max->max_position + 1; // Insert a new answer - $sql = "INSERT INTO $tbl_quiz_answer (c_id, id, question_id,answer,correct,comment,ponderation,position,destination) - VALUES ($course_id, $id, $question_id, '".$title."', $correct, '".$comment."', '$score', $position, '0@@0@@0@@0')"; + $sql = "INSERT INTO $tbl_quiz_answer ( + c_id, + id, + question_id, + answer, + correct, + comment, + ponderation, + position, + destination + ) VALUES ( + $course_id, + $id, + $question_id, + '" . $title . "', + $correct, + '" . $comment . "', + '$score', $position, + '0@@0@@0@@0' + )"; Database::query($sql); if ($correct) { $sql = "UPDATE $tbl_quiz_question SET ponderation = (ponderation + $score) - WHERE c_id = $course_id AND id = ".$question_id; + WHERE c_id = $course_id AND id = " . $question_id; Database::query($sql); } }
'.get_lang("Choice").''. get_lang("ExpectedChoice").''. get_lang("Answer").''.get_lang("Comment").'' . get_lang("Choice") . '' . get_lang("ExpectedChoice") . '' . get_lang("Answer") . '' . get_lang("Comment") . '