ilMarkSchemaGUI Class Reference

Collaboration diagram for ilMarkSchemaGUI:

Public Member Functions
	executeCommand ()
	Controller method. More...

Protected Member Functions
	ensureMarkSchemaCanBeEdited ()
	ensureEctsGradesCanBeEdited ()
	addMarkStep ()
	Add a new mark step to the tests marks. More...
	saveMarkSchemaFormData ()
	Save the mark schema POST data when the form was submitted. More...
	addSimpleMarkSchema ()
	Add a simple mark schema to the tests marks. More...
	deleteMarkSteps ()
	Delete selected mark steps. More...
	saveMarks ()
	Save the mark schema. More...
	showMarkSchema (ilPropertyFormGUI $ects_form=null)
	Display mark schema. More...
	populateEctsForm (ilPropertyFormGUI $form)
	getEctsForm ()
	saveEctsForm ()

Protected Attributes
	$object
	$lng
	$ctrl
	$tpl
	$toolbar

Private Member Functions
	objectSupportsEctsGrades ()

Detailed Description

Definition at line 9 of file class.ilMarkSchemaGUI.php.

Member Function Documentation

addMarkStep()

ilMarkSchemaGUI::addMarkStep ( )

protected

Add a new mark step to the tests marks.

Definition at line 93 of file class.ilMarkSchemaGUI.php.

References ensureMarkSchemaCanBeEdited(), saveMarkSchemaFormData(), and showMarkSchema().

        {
                $this->ensureMarkSchemaCanBeEdited();

                $this->saveMarkSchemaFormData();
                $this->object->getMarkSchema()->addMarkStep();
                $this->showMarkSchema();
        }

Here is the call graph for this function:

addSimpleMarkSchema()

ilMarkSchemaGUI::addSimpleMarkSchema ( )

protected

Add a simple mark schema to the tests marks.

Definition at line 125 of file class.ilMarkSchemaGUI.php.

References ensureMarkSchemaCanBeEdited(), and showMarkSchema().

        {
                $this->ensureMarkSchemaCanBeEdited();

                $this->object->getMarkSchema()->createSimpleSchema(
                        $this->lng->txt('failed_short'), $this->lng->txt('failed_official'),
                        0, 0,
                        $this->lng->txt('passed_short'), $this->lng->txt('passed_official'),
                        50, 1
                );
                $this->showMarkSchema();
        }

Here is the call graph for this function:

deleteMarkSteps()

ilMarkSchemaGUI::deleteMarkSteps ( )

protected

Delete selected mark steps.

Definition at line 141 of file class.ilMarkSchemaGUI.php.

References $_POST, array, ensureMarkSchemaCanBeEdited(), saveMarkSchemaFormData(), ilUtil\sendInfo(), and showMarkSchema().

        {
                $this->ensureMarkSchemaCanBeEdited();

                if(!isset($_POST['marks']) || !is_array($_POST['marks']))
                {
                        $this->showMarkSchema();
                        return;
                }

                $this->saveMarkSchemaFormData();
                $delete_mark_steps = array();
                foreach($_POST['marks'] as $mark_step_id)
                {
                        $delete_mark_steps[] = $mark_step_id;
                }

                if(count($delete_mark_steps))
                {
                        $this->object->getMarkSchema()->deleteMarkSteps($delete_mark_steps);
                }
                else
                {
                        ilUtil::sendInfo($this->lng->txt('tst_delete_missing_mark'));
                }

                $this->showMarkSchema();
        }

Here is the call graph for this function:

ensureEctsGradesCanBeEdited()

ilMarkSchemaGUI::ensureEctsGradesCanBeEdited ( )

protected

Definition at line 81 of file class.ilMarkSchemaGUI.php.

References object, and ilUtil\sendFailure().

Referenced by saveEctsForm().

        {
                if(!$this->object->canEditEctsGrades())
                {
                        ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
                        $this->ctrl->redirect($this, 'showMarkSchema');
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureMarkSchemaCanBeEdited()

ilMarkSchemaGUI::ensureMarkSchemaCanBeEdited ( )

protected

Definition at line 69 of file class.ilMarkSchemaGUI.php.

References object, and ilUtil\sendFailure().

Referenced by addMarkStep(), addSimpleMarkSchema(), deleteMarkSteps(), and saveMarks().

        {
                if(!$this->object->canEditMarks())
                {
                        ilUtil::sendFailure($this->lng->txt('permission_denied'), true);
                        $this->ctrl->redirect($this, 'showMarkSchema');
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilMarkSchemaGUI::executeCommand

(

)

Controller method.

Definition at line 60 of file class.ilMarkSchemaGUI.php.

References $cmd.

        {
                $cmd = $this->ctrl->getCmd('showMarkSchema');
                $this->$cmd();
        }

getEctsForm()

ilMarkSchemaGUI::getEctsForm ( )

protected

Returns

ilPropertyFormGUI

Definition at line 283 of file class.ilMarkSchemaGUI.php.

References ilFormPropertyGUI\setDisabled(), and ilFormPropertyGUI\setInfo().

Referenced by saveEctsForm(), and showMarkSchema().

        {
                require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';

                $disabled = !$this->object->canEditEctsGrades();

                $form = new ilPropertyFormGUI();
                $form->setFormAction($this->ctrl->getFormAction($this, 'saveEctsForm'));
                $form->setTitle($this->lng->txt('ects_output_of_ects_grades'));

                $allow_ects_marks = new ilCheckboxInputGUI($this->lng->txt('ects_allow_ects_grades'), 'ectcs_status');
                $allow_ects_marks->setDisabled($disabled);
                for($i = ord('a'); $i <= ord('e'); $i++)
                {
                        $mark = chr($i);

                        $mark_step = new ilNumberInputGUI(chr($i - 32), 'ects_grade_' . $mark);
                        $mark_step->setInfo(
                                $this->lng->txt('ects_grade_desc_prefix') . ' ' . $this->lng->txt('ects_grade_' . $mark . '_desc')
                        );
                        $mark_step->setSize(5);
                        $mark_step->allowDecimals(true);
                        $mark_step->setMinValue(0, true);
                        $mark_step->setMaxValue(100, true);
                        $mark_step->setSuffix($this->lng->txt('percentile'));
                        $mark_step->setRequired(true);
                        $mark_step->setDisabled($disabled);
                        $allow_ects_marks->addSubItem($mark_step);
                }
                
                $mark_step = new ilNonEditableValueGUI('F', 'ects_grade_f');
                $mark_step->setInfo(
                        $this->lng->txt('ects_grade_desc_prefix') . ' ' . $this->lng->txt('ects_grade_f_desc')
                );
                $allow_ects_marks->addSubItem($mark_step);

                $use_ects_fx = new ilCheckboxInputGUI($this->lng->txt('use_ects_fx'), 'use_ects_fx');
                $use_ects_fx->setDisabled($disabled);
                $allow_ects_marks->addSubItem($use_ects_fx);
                
                $mark_step = new ilNonEditableValueGUI('FX', 'ects_grade_fx');
                $mark_step->setInfo(
                        $this->lng->txt('ects_grade_desc_prefix') . ' ' . $this->lng->txt('ects_grade_fx_desc')
                );
                $use_ects_fx->addSubItem($mark_step);
                
                $threshold = new ilNumberInputGUI($this->lng->txt('ects_fx_threshold'), 'ects_fx_threshold');
                $threshold->setInfo($this->lng->txt('ects_fx_threshold_info'));
                $threshold->setSuffix($this->lng->txt('percentile'));
                $threshold->allowDecimals(true);
                $threshold->setSize(5);
                $threshold->setRequired(true);
                $threshold->setDisabled($disabled);
                $use_ects_fx->addSubItem($threshold);
                

                $form->addItem($allow_ects_marks);

                if(!$disabled)
                {
                        $form->addCommandButton('saveEctsForm', $this->lng->txt('save'));
                }

                return $form;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

objectSupportsEctsGrades()

ilMarkSchemaGUI::objectSupportsEctsGrades ( )

private

Returns

boolean

Definition at line 204 of file class.ilMarkSchemaGUI.php.

Referenced by showMarkSchema().

        {
                require_once 'Modules/Test/interfaces/interface.ilEctsGradesEnabled.php';
                return $this->object instanceof ilEctsGradesEnabled;
        }

Here is the caller graph for this function:

populateEctsForm()

ilMarkSchemaGUI::populateEctsForm ( ilPropertyFormGUI  $form )

protected

Parameters

ilPropertyFormGUI

$form

Definition at line 262 of file class.ilMarkSchemaGUI.php.

References $data, array, object, and ilPropertyFormGUI\setValuesByArray().

Referenced by showMarkSchema().

        {
                $data = array();

                $data['ectcs_status']      = $this->object->getECTSOutput();
                $data['use_ects_fx']       = preg_match('/\d+/', $this->object->getECTSFX());
                $data['ects_fx_threshold'] = $this->object->getECTSFX();

                $ects_grades = $this->object->getECTSGrades();
                for($i = ord('a'); $i <= ord('e'); $i++)
                {
                        $mark = chr($i);
                        $data['ects_grade_' . $mark] = $ects_grades[chr($i - 32)];
                }

                $form->setValuesByArray($data);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

saveEctsForm()

ilMarkSchemaGUI::saveEctsForm ( )

protected

Definition at line 352 of file class.ilMarkSchemaGUI.php.

References array, ensureEctsGradesCanBeEdited(), getEctsForm(), ilUtil\sendSuccess(), and showMarkSchema().

        {
                $this->ensureEctsGradesCanBeEdited();

                $ects_form = $this->getEctsForm();
                if(!$ects_form->checkInput())
                {
                        $ects_form->setValuesByPost();
                        $this->showMarkSchema($ects_form);
                        return;
                }

                $grades = array();
                for($i = ord('a'); $i <= ord('e'); $i++)
                {
                        $mark = chr($i);
                        $grades[chr($i - 32)] = $ects_form->getInput('ects_grade_' . $mark);
                }

                $this->object->setECTSGrades($grades);
                $this->object->setECTSOutput((int)$ects_form->getInput('ectcs_status'));
                $this->object->setECTSFX(
                        $ects_form->getInput('use_ects_fx') && preg_match('/\d+/', $ects_form->getInput('ects_fx_threshold')) ?
                        $ects_form->getInput('ects_fx_threshold'):
                        NULL
                );

                $this->object->saveECTSStatus();

                ilUtil::sendSuccess($this->lng->txt('saved_successfully'));
                $ects_form->setValuesByPost();
                $this->showMarkSchema($ects_form);
        }

Here is the call graph for this function:

saveMarks()

ilMarkSchemaGUI::saveMarks ( )

protected

Save the mark schema.

Definition at line 173 of file class.ilMarkSchemaGUI.php.

References $result, ensureMarkSchemaCanBeEdited(), object, saveMarkSchemaFormData(), ilUtil\sendFailure(), and ilUtil\sendSuccess().

        {
                $this->ensureMarkSchemaCanBeEdited();

                try
                {
                        $this->saveMarkSchemaFormData();
                        $result = $this->object->checkMarks();
                }
                catch(Exception $e)
                {
                        $result = $this->lng->txt('mark_schema_invalid');
                }

                if(is_string($result))
                {
                        ilUtil::sendFailure($this->lng->txt($result), true);
                }
                else
                {
                        $this->object->getMarkSchema()->saveToDb($this->object->getMarkSchemaForeignId());
                        $this->object->onMarkSchemaSaved();
                        ilUtil::sendSuccess($this->lng->txt('saved_successfully'), true);
                }

                $this->ctrl->redirect($this);
        }

Here is the call graph for this function:

saveMarkSchemaFormData()

ilMarkSchemaGUI::saveMarkSchemaFormData ( )

protected

Save the mark schema POST data when the form was submitted.

Definition at line 105 of file class.ilMarkSchemaGUI.php.

References $_POST, and ilUtil\stripSlashes().

Referenced by addMarkStep(), deleteMarkSteps(), and saveMarks().

        {
                $this->object->getMarkSchema()->flush();
                foreach($_POST as $key => $value)
                {
                        if(preg_match('/mark_short_(\d+)/', $key, $matches))
                        {
                                $this->object->getMarkSchema()->addMarkStep(
                                        ilUtil::stripSlashes($_POST["mark_short_$matches[1]"]),
                                        ilUtil::stripSlashes($_POST["mark_official_$matches[1]"]),
                                        ilUtil::stripSlashes($_POST["mark_percentage_$matches[1]"]),
                                        ilUtil::stripSlashes($_POST["passed_$matches[1]"])
                                );
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

showMarkSchema()

ilMarkSchemaGUI::showMarkSchema ( ilPropertyFormGUI  $ects_form = null )

protected

Display mark schema.

Parameters

ilPropertyFormGUI

$ects_form

Definition at line 214 of file class.ilMarkSchemaGUI.php.

References array, ilButton\BUTTON_TYPE_SUBMIT, getEctsForm(), ilSubmitButton\getInstance(), ilButton\getInstance(), object, objectSupportsEctsGrades(), populateEctsForm(), and ilUtil\sendInfo().

Referenced by addMarkStep(), addSimpleMarkSchema(), deleteMarkSteps(), and saveEctsForm().

        {
                if(!$this->object->canEditMarks())
                {
                        ilUtil::sendInfo($this->lng->txt('cannot_edit_marks'));
                }

                $this->toolbar->setFormAction($this->ctrl->getFormAction($this, 'showMarkSchema'));

                require_once 'Modules/Test/classes/tables/class.ilMarkSchemaTableGUI.php';
                $mark_schema_table = new ilMarkSchemaTableGUI($this, 'showMarkSchema', '', $this->object);

                if($this->object->canEditMarks())
                {
                        require_once 'Services/UIComponent/Button/classes/class.ilSubmitButton.php';
                        $create_simple_mark_schema_button = ilSubmitButton::getInstance();
                        $create_simple_mark_schema_button->setCaption($this->lng->txt('tst_mark_create_simple_mark_schema'), false);
                        $create_simple_mark_schema_button->setCommand('addSimpleMarkSchema');
                        $this->toolbar->addButtonInstance($create_simple_mark_schema_button);

                        require_once 'Services/UIComponent/Button/classes/class.ilButton.php';
                        $create_new_mark_step_button = ilButton::getInstance();
                        $create_new_mark_step_button->setCaption($this->lng->txt('tst_mark_create_new_mark_step'), false);
                        $create_new_mark_step_button->setButtonType(ilButton::BUTTON_TYPE_SUBMIT);
                        $create_new_mark_step_button->setForm('form_' . $mark_schema_table->getId());
                        $create_new_mark_step_button->setName('addMarkStep');
                        $this->toolbar->addButtonInstance($create_new_mark_step_button);
                }


                $content_parts = array($mark_schema_table->getHTML());

                if($this->objectSupportsEctsGrades() && $this->object->canShowEctsGrades())
                {
                        if(!($ects_form instanceof ilPropertyFormGUI))
                        {
                                $ects_form = $this->getEctsForm();
                                $this->populateEctsForm($ects_form);
                        }
                        $content_parts[] = $ects_form->getHTML();
                }

                $this->tpl->setContent(implode('<br />', $content_parts));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilMarkSchemaGUI::$ctrl

protected

Definition at line 24 of file class.ilMarkSchemaGUI.php.

$lng

ilMarkSchemaGUI::$lng

protected

Definition at line 19 of file class.ilMarkSchemaGUI.php.

$object

ilMarkSchemaGUI::$object

protected

Definition at line 14 of file class.ilMarkSchemaGUI.php.

$toolbar

ilMarkSchemaGUI::$toolbar

protected

Definition at line 34 of file class.ilMarkSchemaGUI.php.

$tpl

ilMarkSchemaGUI::$tpl

protected

Definition at line 29 of file class.ilMarkSchemaGUI.php.

---

The documentation for this class was generated from the following file:

• Modules/Test/classes/class.ilMarkSchemaGUI.php