function setFocus(){
$("#evaluation_title").focus();
}
$(document).ready(function () {
setFocus();
});
';*/
/**
* Class EvalForm
*
* Extends FormValidator with add&edit forms for evaluations
* @author Stijn Konings
* @package chamilo.gradebook
*/
class EvalForm extends FormValidator
{
const TYPE_ADD = 1;
const TYPE_EDIT = 2;
const TYPE_MOVE = 3;
const TYPE_RESULT_ADD = 4;
const TYPE_RESULT_EDIT = 5;
const TYPE_ALL_RESULTS_EDIT = 6;
const TYPE_ADD_USERS_TO_EVAL = 7;
private $evaluation_object;
private $result_object;
private $extra;
/**
* Builds a form containing form items based on a given parameter
* @param int form_type 1=add, 2=edit,3=move,4=result_add
* @param obj cat_obj the category object
* @param obj res_obj the result object
* @param string form name
* @param method
* @param action
*/
public function __construct($form_type, $evaluation_object, $result_object, $form_name, $method = 'post', $action = null, $extra1 = null, $extra2 = null)
{
parent::__construct($form_name, $method, $action);
if (isset($evaluation_object)) {
$this->evaluation_object = $evaluation_object;
}
if (isset($result_object)) {
$this->result_object = $result_object;
}
if (isset($extra1)) {
$this->extra = $extra1;
}
switch ($form_type) {
case self :: TYPE_EDIT:
$this->build_editing_form();
break;
case self :: TYPE_ADD:
$this->build_add_form();
break;
case self :: TYPE_MOVE:
$this->build_editing_form();
break;
case self :: TYPE_RESULT_ADD:
$this->build_result_add_form();
break;
case self :: TYPE_RESULT_EDIT:
$this->build_result_edit_form();
break;
case self :: TYPE_ALL_RESULTS_EDIT:
$this->build_all_results_edit_form();
break;
case self :: TYPE_ADD_USERS_TO_EVAL:
$this->build_add_user_to_eval();
break;
}
$this->setDefaults();
}
/**
* This form will build a form to add users to an evaluation
*/
protected function build_add_user_to_eval()
{
$this->addElement('header', get_lang('ChooseUser'));
$select = $this->addElement('select', 'firstLetterUser', get_lang('FirstLetter'), null, array(
'onchange' => 'document.add_users_to_evaluation.submit()'
));
$select->addOption('', '');
for ($i = 65; $i <= 90; $i ++) {
$letter = chr($i);
if (isset($this->extra) && $this->extra == $letter) {
$select->addOption($letter, $letter, 'selected');
} else {
$select->addOption($letter, $letter);
}
}
$select = $this->addElement('select', 'add_users', null, null, array(
'multiple' => 'multiple',
'size' => '15',
'style' => 'width:250px'
));
foreach ($this->evaluation_object->get_not_subscribed_students() as $user) {
if ((!isset($this->extra)) || empty($this->extra) || api_strtoupper(api_substr($user[1], 0, 1)) == $this->extra) {
$select->addoption($user[1] . ' ' . $user[2] . ' (' . $user[3] . ')', $user[0]);
}
}
$this->addButtonCreate(get_lang('AddUserToEval'), 'submit_button');
}
/**
* This function builds a form to edit all results in an evaluation
*/
protected function build_all_results_edit_form()
{
//extra field for check on maxvalue
$this->addElement('hidden', 'maxvalue', $this->evaluation_object->get_max());
$this->addElement('hidden', 'minvalue', 0);
$this->addElement('header', get_lang('EditResult'));
$renderer = & $this->defaultRenderer();
// set new form template
$form_template = '
';
$renderer->setFormTemplate($form_template);
if (api_is_western_name_order()) {
$renderer->setHeaderTemplate(
'
' . get_lang('OfficialCode') . ' |
' . get_lang('UserName') . ' |
' . get_lang('FirstName') . ' |
' . get_lang('LastName') . ' |
' . get_lang('Qualify') . ' |
'
);
} else {
$renderer->setHeaderTemplate(
'
' . get_lang('OfficialCode') . ' |
' . get_lang('UserName') . ' |
' . get_lang('LastName') . ' |
' . get_lang('FirstName') . ' |
' . get_lang('Qualify') . ' |
'
);
}
$template_submit = '
|
{element}
{error}
|
';
$results_and_users = array();
foreach ($this->result_object as $result) {
$user = api_get_user_info($result->get_user_id());
$results_and_users[] = array('result' => $result, 'user' => $user);
}
usort($results_and_users, array('EvalForm', 'sort_by_user'));
$defaults = array();
foreach ($results_and_users as $result_and_user) {
$user = $result_and_user['user'];
$result = $result_and_user['result'];
$renderer = &$this->defaultRenderer();
$this->addText('score[' . $result->get_id() . ']', $this->build_stud_label($user['user_id'], $user['username'], $user['lastname'], $user['firstname']), false, array('class' => "span2",
'maxlength' => 5));
$this->addRule('score[' . $result->get_id() . ']', get_lang('OnlyNumbers'), 'numeric');
$this->addRule(array(
'score[' . $result->get_id() . ']', 'maxvalue'), get_lang('OverMax'), 'compare', '<=');
$this->addRule(array(
'score[' . $result->get_id() . ']', 'minvalue'), get_lang('UnderMin'), 'compare', '>=');
$defaults['score[' . $result->get_id() . ']'] = $result->get_score();
if (api_is_western_name_order()) {
$user_info = '' . $user['firstname'] . ' | ';
$user_info .= '' . $user['lastname'] . ' | ';
} else {
$user_info = '' . $user['lastname'] . ' | ';
$user_info .= '' . $user['firstname'] . ' | ';
}
$template = '
' . $user['official_code'] . ' |
' . $user['username'] . ' |
' . $user_info . '
{element} / ' . $this->evaluation_object->get_max() . '
{error}
|
';
$renderer->setElementTemplate($template, 'score[' . $result->get_id() . ']');
}
$this->setDefaults($defaults);
$this->addButtonSave(get_lang('EditResult'), 'submit');
$renderer->setElementTemplate($template_submit, 'submit');
}
/**
* This function builds a form to move an item to another category
*
*/
protected function build_move_form()
{
$renderer = & $this->defaultRenderer();
$renderer->setCustomElementTemplate('{element} ');
$this->addElement('static', null, null, '"' . $this->evaluation_object->get_name() . '" ');
$this->addElement('static', null, null, get_lang('MoveTo') . ' : ');
$select = $this->addElement('select', 'move_cat', null, null);
$line = '';
foreach ($this->evaluation_object->get_target_categories() as $cat) {
for ($i = 0; $i < $cat[2]; $i++) {
$line .= '—';
}
$select->addoption($line . ' ' . $cat[1], $cat[0]);
$line = '';
}
$this->addButtonSave(get_lang('Ok'), 'submit');
}
/**
* Builds a result form containing inputs for all students with a given course_code
*/
protected function build_result_add_form()
{
$renderer = & $this->defaultRenderer();
$renderer->setFormTemplate(
''
);
$tblusers = GradebookUtils::get_users_in_course($this->evaluation_object->get_course_code());
$nr_users = 0;
//extra field for check on maxvalue
$this->addElement('hidden', 'maxvalue', $this->evaluation_object->get_max());
$this->addElement('hidden', 'minvalue', 0);
$this->addElement('header', get_lang('AddResult'));
if (api_is_western_name_order()) {
$renderer->setHeaderTemplate(
'
' . get_lang('OfficialCode') . ' |
' . get_lang('UserName') . ' |
' . get_lang('FirstName') . ' |
' . get_lang('LastName') . ' |
' . get_lang('Qualify') . ' |
'
);
} else {
$renderer->setHeaderTemplate(
'
' . get_lang('OfficialCode') . ' |
' . get_lang('UserName') . ' |
' . get_lang('LastName') . ' |
' . get_lang('FirstName') . ' |
' . get_lang('Qualify') . ' |
'
);
}
$firstUser = true;
foreach ($tblusers as $user) {
$element_name = 'score[' . $user[0] . ']';
$scoreColumnProperties = array('class' => 'span1', 'maxlength' => 5);
if ($firstUser) {
$scoreColumnProperties['autofocus'] = '';
$firstUser = false;
}
//user_id, user.username, lastname, firstname
$this->addText($element_name, $this->build_stud_label($user[0], $user[1], $user[2], $user[3]), false, $scoreColumnProperties);
$this->addRule($element_name, get_lang('OnlyNumbers'), 'numeric');
$this->addRule(array($element_name, 'maxvalue'), get_lang('OverMax'), 'compare', '<=');
$this->addRule(array($element_name, 'minvalue'), get_lang('UnderMin'), 'compare', '>=');
if (api_is_western_name_order()) {
$user_info = '' . $user[3] . ' | ';
$user_info .= '' . $user[2] . ' | ';
} else {
$user_info = '' . $user[2] . ' | ';
$user_info .= '' . $user[3] . ' | ';
}
$nr_users++;
$template = '
' . $user[4] . ' |
' . $user[1] . ' |
' . $user_info . '
{element} / ' . $this->evaluation_object->get_max() . '
{error}
|
';
$renderer->setElementTemplate($template, $element_name);
}
$this->addElement('hidden', 'nr_users', $nr_users);
$this->addElement('hidden', 'evaluation_id', $this->result_object->get_evaluation_id());
$this->addButtonSave(get_lang('AddResult'), 'submit');
$template_submit = '
|
{element}
{error}
|
';
$renderer->setElementTemplate($template_submit, 'submit');
}
/**
* Builds a form to edit a result
*/
protected function build_result_edit_form()
{
$this->setDefaults(array(
'score' => $this->result_object->get_score(),
'maximum' => $this->evaluation_object->get_max()
));
$userinfo = api_get_user_info($this->result_object->get_user_id());
$renderer = & $this->defaultRenderer();
$renderer->setCustomElementTemplate('{element} ');
$this->addElement('label', get_lang('User'), $userinfo['complete_name']);
$this->addText('score', array(get_lang('Score'), null, '/ ' . $this->evaluation_object->get_max()), false, array(
'size' => '4',
'class' => 'span1',
'maxlength' => '5'
));
/* $this->addText('maximum', null, false, array (
'size' => '4',
'maxlength' => '5',
'disabled' => 'disabled'
)); */
$this->addButtonSave(get_lang('Edit'), 'submit');
$this->addElement('hidden', 'minvalue', 0);
$this->addElement('hidden', 'hid_user_id', $this->result_object->get_user_id());
$this->addElement('hidden', 'maxvalue', $this->evaluation_object->get_max());
$this->addRule('score', get_lang('OnlyNumbers'), 'numeric', null, 'client');
$this->addRule(array(
'score',
'maxvalue'
), get_lang('OverMax'), 'compare', '<=', 'client');
$this->addRule(array(
'score',
'minvalue'
), get_lang('UnderMin'), 'compare', '>=', 'client');
}
/**
* Builds a form to add an evaluation
*/
protected function build_add_form()
{
$this->setDefaults(array('hid_user_id' => $this->evaluation_object->get_user_id(),
'hid_category_id' => $this->evaluation_object->get_category_id(),
'hid_course_code' => $this->evaluation_object->get_course_code(), 'created_at' => api_get_utc_datetime()));
$this->build_basic_form(0);
if ($this->evaluation_object->get_course_code() == null) {
$this->addElement('checkbox', 'adduser', null, get_lang('AddUserToEval'));
} else {
$this->addElement('checkbox', 'addresult', null, get_lang('AddResult'));
}
$this->addButtonCreate(get_lang('AddAssessment'), 'submit');
}
/**
* Builds a form to edit an evaluation
*/
protected function build_editing_form()
{
$parent_cat = Category :: load($this->evaluation_object->get_category_id());
//@TODO $weight_mask is replaced?
if ($parent_cat[0]->get_parent_id() == 0) {
$weight_mask = $this->evaluation_object->get_weight();
} else {
$cat = Category :: load($parent_cat[0]->get_parent_id());
$global_weight = $cat[0]->get_weight();
$weight_mask = $global_weight * $this->evaluation_object->get_weight() / $parent_cat[0]->get_weight();
}
$weight = $weight_mask = $this->evaluation_object->get_weight();
$this->setDefaults(array('hid_id' => $this->evaluation_object->get_id(),
'name' => $this->evaluation_object->get_name(),
'description' => $this->evaluation_object->get_description(),
'hid_user_id' => $this->evaluation_object->get_user_id(),
'hid_course_code' => $this->evaluation_object->get_course_code(),
'hid_category_id' => $this->evaluation_object->get_category_id(),
'created_at' => api_get_utc_datetime($this->evaluation_object->get_date()),
'weight' => $weight,
'weight_mask' => $weight_mask,
'max' => $this->evaluation_object->get_max(),
'visible' => $this->evaluation_object->is_visible()));
$id_current = isset($this->id) ? $this->id : null;
$this->addElement('hidden', 'hid_id', $id_current);
$this->build_basic_form(1);
$this->addButtonSave(get_lang('ModifyEvaluation'), 'submit');
}
/**
* Builds a basic form that is used in add and edit
*/
private function build_basic_form($edit = 0)
{
$form_title = get_lang('NewEvaluation');
if (!empty($_GET['editeval']) && $_GET['editeval'] == 1) {
$form_title = get_lang('EditEvaluation');
}
$this->addElement('header', $form_title);
$this->addElement('hidden', 'zero', 0);
$this->addElement('hidden', 'hid_user_id');
$this->addElement('hidden', 'hid_course_code');
$this->addText('name', get_lang('EvaluationName'), true, array(
'class' => 'span3',
'maxlength' => '50',
'id' => 'evaluation_title'
));
$cat_id = $this->evaluation_object->get_category_id();
$session_id = api_get_session_id();
$course_code = api_get_course_id();
$all_categories = Category :: load(null, null, $course_code, null, null, $session_id, false);
if (count($all_categories) == 1) {
$this->addElement('hidden', 'hid_category_id', $cat_id);
} else {
$select_gradebook = $this->addElement('select', 'hid_category_id', get_lang('SelectGradebook'), array(), array('id' => 'hid_category_id'));
$this->addRule('hid_category_id', get_lang('ThisFieldIsRequired'), 'nonzero');
$default_weight = 0;
if (!empty($all_categories)) {
foreach ($all_categories as $my_cat) {
if ($my_cat->get_course_code() == api_get_course_id()) {
$grade_model_id = $my_cat->get_grade_model_id();
if (empty($grade_model_id)) {
if ($my_cat->get_parent_id() == 0) {
$default_weight = $my_cat->get_weight();
$select_gradebook->addoption(get_lang('Default'), $my_cat->get_id());
$cats_added[] = $my_cat->get_id();
} else {
$select_gradebook->addoption($my_cat->get_name(), $my_cat->get_id());
$cats_added[] = $my_cat->get_id();
}
} else {
$select_gradebook->addoption(get_lang('Select'), 0);
}
if ($this->evaluation_object->get_category_id() == $my_cat->get_id()) {
$default_weight = $my_cat->get_weight();
}
}
}
}
}
$this->addText('weight_mask', array(get_lang('Weight'), null, ' [0 .. ' . $all_categories[0]->get_weight() . '] '), true, array(
'size' => '4',
'maxlength' => '5',
'class' => 'span1'
));
/* $this->addText('weight', array(null, null, '/ '.$default_weight.''), true, array (
'size' => '4',
'maxlength' => '5',
'class' => 'span1'
)); */
if ($edit) {
if (!$this->evaluation_object->has_results()) {
$this->addText('max', get_lang('QualificationNumeric'), true, array(
'class' => 'span1',
'maxlength' => '5'
));
} else {
$this->addText('max', array(get_lang('QualificationNumeric'), get_lang('CannotChangeTheMaxNote')), false, array(
'class' => 'span1',
'maxlength' => '5',
'disabled' => 'disabled'
));
}
} else {
$this->addText('max', get_lang('QualificationNumeric'), true, array(
'class' => 'span1',
'maxlength' => '5'
));
$default_max = api_get_setting('gradebook_default_weight');
$defaults['max'] = isset($default_max) ? $default_max : 100;
$this->setDefaults($defaults);
}
$this->addElement('textarea', 'description', get_lang('Description'));
$this->addRule('hid_category_id', get_lang('ThisFieldIsRequired'), 'required');
$this->addElement('checkbox', 'visible', null, get_lang('Visible'));
$this->addRule('weight_mask', get_lang('OnlyNumbers'), 'numeric');
$this->addRule(array('weight_mask', 'zero'), get_lang('NegativeValue'), 'compare', '>=');
$this->addRule('max', get_lang('OnlyNumbers'), 'numeric');
$this->addRule(array('max', 'zero'), get_lang('NegativeValue'), 'compare', '>=');
$setting = api_get_setting('tool_visible_by_default_at_creation');
$visibility_default = 1;
if (isset($setting['gradebook']) && $setting['gradebook'] == 'false') {
$visibility_default = 0;
}
$this->setDefaults(array('visible' => $visibility_default));
}
function display()
{
parent :: display();
}
function setDefaults($defaults = array(), $filter = null)
{
parent :: setDefaults($defaults, $filter);
}
private function build_stud_label($id, $username, $lastname, $firstname)
{
$opendocurl_start = '';
$opendocurl_end = '';
// evaluation's origin is a link
if ($this->evaluation_object->get_category_id() < 0) {
$link = LinkFactory :: get_evaluation_link($this->evaluation_object->get_id());
$doc_url = $link->get_view_url($id);
if ($doc_url != null) {
$opendocurl_start .= '';
$opendocurl_end = '';
}
}
return $opendocurl_start . api_get_person_name($firstname, $lastname) . ' (' . $username . ')' . $opendocurl_end;
}
function sort_by_user($item1, $item2)
{
$user1 = $item1['user'];
$user2 = $item2['user'];
if (api_sort_by_first_name()) {
$result = api_strcmp($user1['firstname'], $user2['firstname']);
if ($result == 0) {
return api_strcmp($user1['lastname'], $user2['lastname']);
}
} else {
$result = api_strcmp($user1['lastname'], $user2['lastname']);
if ($result == 0) {
return api_strcmp($user1['firstname'], $user2['firstname']);
}
}
return $result;
}
}