ilUnitConfigurationGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilUnitConfigurationGUI:

Collaboration diagram for ilUnitConfigurationGUI:

Public Member Functions
	__construct (ilUnitConfigurationRepository $repository)
	getUnitCategoryOverviewCommand ()
	isCRUDContext ()
	getUniqueId ()
	executeCommand ()
	deleteUnits ()

Protected Member Functions
	getDefaultCommand ()
	showUnitCategories (array $categories)
	getCategoryById (int $id, bool $for_CRUD=true)
	handleSubtabs ()
	checkPermissions (string $cmd)
	confirmDeleteUnit ()
	confirmDeleteUnits (array $unit_ids=null)
	saveOrder ()
	saveUnit ()
	showUnitModificationForm ()
	addUnit ()
	showUnitCreationForm ()
	initUnitForm (assFormulaQuestionUnitCategory $category=null, assFormulaQuestionUnit $unit=null)
	confirmDeleteCategory ()
	confirmDeleteCategories (array $category_ids=null)
	deleteCategories ()
	initUnitCategoryForm (assFormulaQuestionUnitCategory $cat=null)
	addCategory ()
	showUnitCategoryCreationForm ()
	saveCategory ()
	showUnitCategoryModificationForm ()

Protected Attributes
ilUnitConfigurationRepository	$repository
ILIAS TestQuestionPool InternalRequestService	$request
ilPropertyFormGUI	$unit_cat_form = null
ilPropertyFormGUI	$unit_form = null
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrlInterface	$ctrl

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilUnitConfigurationGUI

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

Constructor & Destructor Documentation

__construct()

ilUnitConfigurationGUI::__construct

(

ilUnitConfigurationRepository

$repository

)

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

References $DIC, $lng, $repository, $tpl, ILIAS\Repository\ctrl(), getDefaultCommand(), getUniqueId(), getUnitCategoryOverviewCommand(), isCRUDContext(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and showUnitCategories().

    {
        global $DIC;

        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $tpl = $DIC->ui()->mainTemplate();
        $this->request = $DIC->testQuestionPool()->internal()->request();

        $this->repository = $repository;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        $this->tpl = $tpl;

        $this->lng->loadLanguageModule('assessment');
    }

Here is the call graph for this function:

Member Function Documentation

addCategory()

ilUnitConfigurationGUI::addCategory ( )

protected

Definition at line 700 of file class.ilUnitConfigurationGUI.php.

References Vendor\Package\$e, getDefaultCommand(), getUnitCategoryOverviewCommand(), initUnitCategoryForm(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                    : void
    {
        if (!$this->isCRUDContext()) {
            $this->{$this->getDefaultCommand()}();
            return;
        }

        $this->initUnitCategoryForm();
        if ($this->unit_cat_form->checkInput()) {
            try {
                $category = new assFormulaQuestionUnitCategory();
                $category->setCategory($this->unit_cat_form->getInput('category_name'));
                $this->repository->saveNewUnitCategory($category);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));

                $this->{$this->getUnitCategoryOverviewCommand()}();
                return;
            } catch (ilException $e) {
                $this->unit_cat_form->getItemByPostVar('category_name')->setAlert($this->lng->txt($e->getMessage()));
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            }
        }

        $this->unit_cat_form->setValuesByPost();

        $this->tpl->setContent($this->unit_cat_form->getHtml());
    }

Here is the call graph for this function:

addUnit()

ilUnitConfigurationGUI::addUnit ( )

protected

Definition at line 324 of file class.ilUnitConfigurationGUI.php.

References getCategoryById(), initUnitForm(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        $category = $this->getCategoryById($this->request->int('category_id'));

        $this->initUnitForm($category);
        if ($this->unit_form->checkInput()) {
            $unit = new assFormulaQuestionUnit();
            $unit->setUnit($this->unit_form->getInput('unit_title'));
            $unit->setCategory($category->getId());

            $this->repository->createNewUnit($unit);

            $unit->setBaseUnit((int) $this->unit_form->getInput('base_unit'));
            $unit->setFactor((float) $this->unit_form->getInput('factor'));

            $this->repository->saveUnit($unit);

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
            $this->showUnitsOfCategory();
            return;
        }

        $this->unit_form->setValuesByPost();

        $this->tpl->setContent($this->unit_form->getHtml());
    }

Here is the call graph for this function:

checkPermissions()

ilUnitConfigurationGUI::checkPermissions ( string  $cmd )

protected

Definition at line 76 of file class.ilUnitConfigurationGUI.php.

Referenced by executeCommand().

                                                    : void
    {
    }

Here is the caller graph for this function:

confirmDeleteCategories()

ilUnitConfigurationGUI::confirmDeleteCategories ( array  $category_ids = null )

protected

Parameters

int[]|null

$category_ids

Returns

void

Exceptions

ilCtrlException

Definition at line 533 of file class.ilUnitConfigurationGUI.php.

References Vendor\Package\$e, $errors, $message, ILIAS\Repository\ctrl(), getDefaultCommand(), getUnitCategoryOverviewCommand(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

Referenced by confirmDeleteCategory().

                                                                          : void
    {
        if (!$this->isCRUDContext()) {
            $this->{$this->getDefaultCommand()}();
            return;
        }

        $category_ids = $category_ids ?? $this->request->getUnitCategoryIds();
        if (count($category_ids) === 0) {
            $this->{$this->getUnitCategoryOverviewCommand()}();
            return;
        }

        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, 'deleteCategories'));
        $confirmation->setConfirm($this->lng->txt('confirm'), 'deleteCategories');
        $confirmation->setCancel($this->lng->txt('cancel'), $this->getUnitCategoryOverviewCommand());

        $errors = [];
        $num_to_confirm = 0;
        foreach ($category_ids as $category_id) {
            try {
                $category = $this->repository->getUnitCategoryById($category_id);
            } catch (ilException $e) {
                continue;
            }

            if (!$this->repository->isCRUDAllowed($category_id)) {
                $errors[] = $category->getDisplayString() . ' - ' . $this->lng->txt('change_adm_categories_not_allowed');
                continue;
            }

            $possible_error = $this->repository->checkDeleteCategory($category_id);
            if (is_string($possible_error) && $possible_error !== '') {
                $errors[] = $category->getDisplayString() . ' - ' . $possible_error;
                continue;
            }

            $confirmation->addItem('category_ids[]', (string) $category->getId(), $category->getDisplayString());
            ++$num_to_confirm;
        }

        if ($errors) {
            $num_errors = count($errors);

            $error_message = array_map(static function (string $message): string {
                return '<li>' . $message . '</li>';
            }, $errors);
            if ($num_errors === 1) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_cat_deletion_errors_f_s') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            } else {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_cat_deletion_errors_f') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            }
        }

        if ($num_to_confirm) {
            if ($num_to_confirm === 1) {
                $confirmation->setHeaderText($this->lng->txt('un_sure_delete_categories_s'));
            } else {
                $confirmation->setHeaderText($this->lng->txt('un_sure_delete_categories'));
            }

            $this->tpl->setContent($confirmation->getHTML());
        } else {
            $this->{$this->getUnitCategoryOverviewCommand()}();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteCategory()

ilUnitConfigurationGUI::confirmDeleteCategory ( )

protected

Definition at line 518 of file class.ilUnitConfigurationGUI.php.

References confirmDeleteCategories(), and getUnitCategoryOverviewCommand().

                                              : void
    {
        if (!$this->request->isset('category_id')) {
            $this->{$this->getUnitCategoryOverviewCommand()}();
            return;
        }

        $this->confirmDeleteCategories([$this->request->int('category_id')]);
    }

Here is the call graph for this function:

confirmDeleteUnit()

ilUnitConfigurationGUI::confirmDeleteUnit ( )

protected

Definition at line 97 of file class.ilUnitConfigurationGUI.php.

References confirmDeleteUnits().

                                          : void
    {
        if (!$this->request->isset('unit_id')) {
            $this->showUnitsOfCategory();
            return;
        }

        $this->confirmDeleteUnits([$this->request->int('unit_id')]);
    }

Here is the call graph for this function:

confirmDeleteUnits()

ilUnitConfigurationGUI::confirmDeleteUnits ( array  $unit_ids = null )

protected

Parameters

int[]|null

$unit_ids

Returns

void

Exceptions

ilCtrlException

Definition at line 112 of file class.ilUnitConfigurationGUI.php.

References Vendor\Package\$e, $errors, $message, ILIAS\Repository\ctrl(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

Referenced by confirmDeleteUnit().

                                                                 : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        $unit_ids = $unit_ids ?? $this->request->getUnitIds();
        if (count($unit_ids) === 0) {
            $this->showUnitsOfCategory();
            return;
        }

        $this->ctrl->setParameter($this, 'category_id', $this->request->int('category_id'));
        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, 'deleteUnits'));
        $confirmation->setConfirm($this->lng->txt('confirm'), 'deleteUnits');
        $confirmation->setCancel($this->lng->txt('cancel'), 'showUnitsOfCategory');

        $errors = [];
        $num_to_confirm = 0;
        foreach ($unit_ids as $unit_id) {
            try {
                $unit = $this->repository->getUnit((int) $unit_id);
                if (!$unit) {
                    continue;
                }

                if ($check_result = $this->repository->checkDeleteUnit($unit->getId())) {
                    $errors[] = $unit->getDisplayString() . ' - ' . $check_result;
                    continue;
                }

                $confirmation->addItem('unit_ids[]', (string) $unit->getId(), $unit->getDisplayString());
                ++$num_to_confirm;
            } catch (ilException $e) {
                continue;
            }
        }

        if ($errors) {
            $num_errors = count($errors);

            $error_message = array_map(static function (string $message): string {
                return '<li>' . $message . '</li>';
            }, $errors);
            if ($num_errors === 1) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_unit_deletion_errors_f_s') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            } else {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_unit_deletion_errors_f') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            }
        }

        if ($num_to_confirm) {
            if ($num_to_confirm === 1) {
                $confirmation->setHeaderText($this->lng->txt('un_sure_delete_units_s'));
            } else {
                $confirmation->setHeaderText($this->lng->txt('un_sure_delete_units'));
            }

            $this->tpl->setContent($confirmation->getHTML());
        } else {
            $this->showUnitsOfCategory();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteCategories()

ilUnitConfigurationGUI::deleteCategories ( )

protected

Definition at line 607 of file class.ilUnitConfigurationGUI.php.

References Vendor\Package\$e, $errors, $message, getDefaultCommand(), getUnitCategoryOverviewCommand(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                         : void
    {
        if (!$this->isCRUDContext()) {
            $this->{$this->getDefaultCommand()}();
            return;
        }

        $category_ids = $this->request->getUnitCategoryIds();
        if (count($category_ids) === 0) {
            $this->{$this->getUnitCategoryOverviewCommand()}();
            return;
        }

        $errors = [];
        $num_deleted = 0;
        foreach ($category_ids as $category_id) {
            try {
                $category = $this->repository->getUnitCategoryById($category_id);
            } catch (ilException $e) {
                continue;
            }

            if (!$this->repository->isCRUDAllowed($category_id)) {
                $errors[] = $category->getDisplayString() . ' - ' . $this->lng->txt('change_adm_categories_not_allowed');
                continue;
            }

            $possible_error = $this->repository->deleteCategory($category_id);
            if (is_string($possible_error) && $possible_error !== '') {
                $errors[] = $category->getDisplayString() . ' - ' . $possible_error;
                continue;
            }

            ++$num_deleted;
        }

        if ($errors) {
            $num_errors = count($errors);

            $error_message = array_map(static function (string $message): string {
                return '<li>' . $message . '</li>';
            }, $errors);
            if ($num_errors === 1) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_cat_deletion_errors_p_s') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            } else {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_cat_deletion_errors_p') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            }
        }

        if ($num_deleted) {
            if ($num_deleted === 1) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('un_deleted_categories_s'));
            } else {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('un_deleted_categories'));
            }
        }

        $this->{$this->getUnitCategoryOverviewCommand()}();
    }

Here is the call graph for this function:

deleteUnits()

ilUnitConfigurationGUI::deleteUnits

(

)

Definition at line 184 of file class.ilUnitConfigurationGUI.php.

References Vendor\Package\$e, $errors, $message, isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                 : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        $unit_ids = $this->request->getUnitIds();
        if (count($unit_ids) === 0) {
            $this->showUnitsOfCategory();
            return;
        }

        $errors = [];
        $num_deleted = 0;
        foreach ($unit_ids as $unit_id) {
            try {
                $unit = $this->repository->getUnit($unit_id);
                if (!$unit) {
                    continue;
                }

                $check_result = $this->repository->deleteUnit($unit->getId());
                if (!is_null($check_result)) {
                    $errors[] = $unit->getDisplayString() . ' - ' . $check_result;
                    continue;
                }

                ++$num_deleted;
            } catch (ilException $e) {
                continue;
            }
        }

        if ($errors) {
            $num_errors = count($errors);

            $error_message = array_map(static function (string $message): string {
                return '<li>' . $message . '</li>';
            }, $errors);
            if ($num_errors === 1) {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_unit_deletion_errors_p_s') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            } else {
                $this->tpl->setOnScreenMessage(
                    'failure',
                    $this->lng->txt('un_unit_deletion_errors_p') . '<ul>' . implode('', $error_message) . '<ul>'
                );
            }
        }

        if ($num_deleted) {
            if ($num_deleted === 1) {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('un_deleted_units_s'));
            } else {
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('un_deleted_units'));
            }
        }

        $this->showUnitsOfCategory();
    }

Here is the call graph for this function:

executeCommand()

ilUnitConfigurationGUI::executeCommand

(

)

Definition at line 80 of file class.ilUnitConfigurationGUI.php.

References checkPermissions(), ILIAS\Repository\ctrl(), getDefaultCommand(), and handleSubtabs().

Referenced by ilLocalUnitConfigurationGUI\getUniqueId().

                                    : void
    {
        $cmd = $this->ctrl->getCmd($this->getDefaultCommand());
        $this->checkPermissions($cmd);
        switch ($cmd) {
            case 'confirmImportGlobalCategories':
                $category_ids = $this->request->raw('category_ids');
                $this->$cmd($category_ids);
                break;
            default:
                $this->$cmd();
                break;
        }

        $this->handleSubtabs();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCategoryById()

ilUnitConfigurationGUI::getCategoryById ( int  $id, bool  $for_CRUD = true  )

protected

Definition at line 61 of file class.ilUnitConfigurationGUI.php.

References ILIAS\Repository\ctrl(), getDefaultCommand(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

Referenced by addUnit(), initUnitForm(), saveCategory(), saveUnit(), showUnitCategoryModificationForm(), showUnitCreationForm(), and showUnitModificationForm().

                                                                      : assFormulaQuestionUnitCategory
    {
        $category = $this->repository->getUnitCategoryById($id);
        if ($for_CRUD && $category->getQuestionFi() !== $this->repository->getConsumerId()) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('change_adm_categories_not_allowed'), true);
            $this->ctrl->redirect($this, $this->getDefaultCommand());
        }

        return $category;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultCommand()

ilUnitConfigurationGUI::getDefaultCommand ( )

abstractprotected

Referenced by __construct(), addCategory(), confirmDeleteCategories(), deleteCategories(), executeCommand(), getCategoryById(), saveCategory(), showUnitCategoryCreationForm(), and showUnitCategoryModificationForm().

Here is the caller graph for this function:

getUniqueId()

ilUnitConfigurationGUI::getUniqueId ( )

abstract

Referenced by __construct().

Here is the caller graph for this function:

getUnitCategoryOverviewCommand()

ilUnitConfigurationGUI::getUnitCategoryOverviewCommand ( )

abstract

Referenced by __construct(), addCategory(), confirmDeleteCategories(), confirmDeleteCategory(), deleteCategories(), initUnitCategoryForm(), initUnitForm(), and saveCategory().

Here is the caller graph for this function:

handleSubtabs()

ilUnitConfigurationGUI::handleSubtabs ( )

protected

Definition at line 72 of file class.ilUnitConfigurationGUI.php.

Referenced by executeCommand().

                                      : void
    {
    }

Here is the caller graph for this function:

initUnitCategoryForm()

ilUnitConfigurationGUI::initUnitCategoryForm ( assFormulaQuestionUnitCategory  $cat = null )

protected

Definition at line 673 of file class.ilUnitConfigurationGUI.php.

References $unit_cat_form, ILIAS\Repository\ctrl(), getUnitCategoryOverviewCommand(), and ILIAS\Repository\lng().

Referenced by addCategory(), saveCategory(), showUnitCategoryCreationForm(), and showUnitCategoryModificationForm().

                                                                                       : ilPropertyFormGUI
    {
        if ($this->unit_cat_form instanceof ilPropertyFormGUI) {
            return $this->unit_cat_form;
        }

        $this->unit_cat_form = new ilPropertyFormGUI();

        $title = new ilTextInputGUI($this->lng->txt('title'), 'category_name');
        $title->setRequired(true);
        $this->unit_cat_form->addItem($title);

        if (null === $cat) {
            $this->unit_cat_form->setTitle($this->lng->txt('new_category'));
            $this->unit_cat_form->setFormAction($this->ctrl->getFormAction($this, 'addCategory'));
            $this->unit_cat_form->addCommandButton('addCategory', $this->lng->txt('save'));
        } else {
            $this->ctrl->setParameter($this, 'category_id', $cat->getId());
            $this->unit_cat_form->addCommandButton('saveCategory', $this->lng->txt('save'));
            $this->unit_cat_form->setFormAction($this->ctrl->getFormAction($this, 'saveCategory'));
            $this->unit_cat_form->setTitle(sprintf($this->lng->txt('selected_category'), $cat->getDisplayString()));
        }

        $this->unit_cat_form->addCommandButton($this->getUnitCategoryOverviewCommand(), $this->lng->txt('cancel'));
        return $this->unit_cat_form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUnitForm()

ilUnitConfigurationGUI::initUnitForm ( assFormulaQuestionUnitCategory  $category = null, assFormulaQuestionUnit  $unit = null  )

protected

Definition at line 374 of file class.ilUnitConfigurationGUI.php.

References $data, $DIC, $unit_form, ILIAS\Repository\ctrl(), getCategoryById(), assFormulaQuestionUnit\getId(), getUnitCategoryOverviewCommand(), isCRUDContext(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), ilFormPropertyGUI\setRequired(), and showUnitCategories().

Referenced by addUnit(), saveUnit(), showUnitCreationForm(), and showUnitModificationForm().

     : ilPropertyFormGUI {
        if ($this->unit_form instanceof ilPropertyFormGUI) {
            return $this->unit_form;
        }

        $unit_in_use = false;
        if ($unit instanceof assFormulaQuestionUnit && $this->repository->isUnitInUse($unit->getId())) {
            $unit_in_use = true;
        }

        $this->unit_form = new ilPropertyFormGUI();

        $title = new ilTextInputGUI($this->lng->txt('unit'), 'unit_title');
        $title->setDisabled($unit_in_use);
        $title->setRequired(true);
        $this->unit_form->addItem($title);

        $baseunit = new ilSelectInputGUI($this->lng->txt('baseunit'), 'base_unit');
        $items = $this->repository->getCategorizedUnits();
        $options = [];
        $category_name = '';
        $new_category = false;
        foreach ($items as $item) {
            if (
                $unit instanceof assFormulaQuestionUnit &&
                $unit->getId() === $item->getId()
            ) {
                continue;
            }

            if ($item instanceof assFormulaQuestionUnitCategory) {
                if ($category_name !== $item->getDisplayString()) {
                    $new_category = true;
                    $category_name = $item->getDisplayString();
                }
                continue;
            }

            $options[$item->getId()] = $item->getDisplayString() . ($new_category ? ' (' . $category_name . ')' : '');
            $new_category = false;
        }
        $baseunit->setDisabled($unit_in_use);
        $baseunit->setOptions([0 => $this->lng->txt('no_selection')] + $options);
        $this->unit_form->addItem($baseunit);

        $factor = new ilNumberInputGUI($this->lng->txt('factor'), 'factor');
        $factor->setRequired(true);
        $factor->setSize(3);
        $factor->setMinValue(0);
        $factor->allowDecimals(true);
        $factor->setDisabled($unit_in_use);
        $this->unit_form->addItem($factor);

        $this->ctrl->setParameterByClass(get_class($this), 'category_id', $this->request->int('category_id'));
        if (null === $unit) {
            $this->unit_form->setTitle($this->lng->txt('new_unit'));
            $this->unit_form->setFormAction($this->ctrl->getFormAction($this, 'addUnit'));
            $this->unit_form->addCommandButton('addUnit', $this->lng->txt('save'));
        } else {
            $this->ctrl->setParameter($this, 'unit_id', $unit->getId());
            if ($unit_in_use) {
                $this->unit_form->setFormAction($this->ctrl->getFormAction($this, 'showUnitsOfCategory'));
            } else {
                $this->unit_form->addCommandButton('saveUnit', $this->lng->txt('save'));
                $this->unit_form->setFormAction($this->ctrl->getFormAction($this, 'saveUnit'));
            }
            $this->unit_form->setTitle(sprintf(
                $this->lng->txt('un_sel_cat_sel_unit'),
                $category->getDisplayString(),
                $unit->getDisplayString()
            ));
        }
        $this->ctrl->clearParameterByClass(get_class($this), 'category_id');

        $this->unit_form->addCommandButton('showUnitsOfCategory', $this->lng->txt('cancel'));
        return $this->unit_form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isCRUDContext()

ilUnitConfigurationGUI::isCRUDContext ( )

abstract

Referenced by __construct(), addCategory(), addUnit(), confirmDeleteCategories(), confirmDeleteUnits(), deleteCategories(), deleteUnits(), initUnitForm(), saveCategory(), saveOrder(), saveUnit(), showUnitCategoryCreationForm(), showUnitCategoryModificationForm(), showUnitCreationForm(), and showUnitModificationForm().

Here is the caller graph for this function:

saveCategory()

ilUnitConfigurationGUI::saveCategory ( )

protected

Definition at line 740 of file class.ilUnitConfigurationGUI.php.

References Vendor\Package\$e, getCategoryById(), getDefaultCommand(), getUnitCategoryOverviewCommand(), initUnitCategoryForm(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                     : void
    {
        if (!$this->isCRUDContext()) {
            $this->{$this->getDefaultCommand()}();
            return;
        }

        $category = $this->getCategoryById($this->request->int('category_id'));

        $this->initUnitCategoryForm($category);
        if ($this->unit_cat_form->checkInput()) {
            try {
                $category->setCategory($this->unit_cat_form->getInput('category_name'));
                $this->repository->saveCategory($category);
                $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));

                $this->{$this->getUnitCategoryOverviewCommand()}();
                return;
            } catch (ilException $e) {
                $this->unit_cat_form->getItemByPostVar('category_name')->setAlert($this->lng->txt($e->getMessage()));
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            }
        }

        $this->unit_cat_form->setValuesByPost();

        $this->tpl->setContent($this->unit_cat_form->getHtml());
    }

Here is the call graph for this function:

saveOrder()

ilUnitConfigurationGUI::saveOrder ( )

protected

Definition at line 248 of file class.ilUnitConfigurationGUI.php.

References $id, ILIAS\Repository\int(), isCRUDContext(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Deck\repository().

                                  : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        if (!$this->request->isset('sequence') || !is_array($this->request->raw('sequence'))) {
            $this->showUnitsOfCategory();
            return;
        }

        $sequences = $this->request->raw('sequence');
        foreach ($sequences as $id => $sequence) {
            $sorting_value = str_replace(',', '.', $sequence);
            $sorting_value = (int) $sorting_value * 100;
            $this->repository->saveUnitOrder((int) $id, $sorting_value);
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
        $this->showUnitsOfCategory();
    }

Here is the call graph for this function:

saveUnit()

ilUnitConfigurationGUI::saveUnit ( )

protected

Definition at line 271 of file class.ilUnitConfigurationGUI.php.

References getCategoryById(), initUnitForm(), ILIAS\Repository\int(), isCRUDContext(), ILIAS\Repository\lng(), ILIAS\UI\examples\Deck\repository(), and showUnitModificationForm().

                                 : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        $category = $this->getCategoryById($this->request->int('category_id'));
        $unit = $this->repository->getUnit($this->request->int('unit_id'));

        if ($this->repository->isUnitInUse($unit->getId())) {
            $this->showUnitModificationForm();
            return;
        }

        $this->initUnitForm($category, $unit);
        if ($this->unit_form->checkInput()) {
            $unit->setUnit($this->unit_form->getInput('unit_title'));
            $unit->setFactor((float) $this->unit_form->getInput('factor'));
            $unit->setBaseUnit((int) $this->unit_form->getInput('base_unit') !== $unit->getId() ? (int) $this->unit_form->getInput('base_unit') : 0);
            $unit->setCategory($category->getId());
            $this->repository->saveUnit($unit);

            $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'));
            $this->showUnitsOfCategory();
            return;
        }

        $this->unit_form->setValuesByPost();

        $this->tpl->setContent($this->unit_form->getHtml());
    }

Here is the call graph for this function:

showUnitCategories()

ilUnitConfigurationGUI::showUnitCategories ( array  $categories )

abstractprotected

Referenced by __construct(), and initUnitForm().

Here is the caller graph for this function:

showUnitCategoryCreationForm()

ilUnitConfigurationGUI::showUnitCategoryCreationForm ( )

protected

Definition at line 728 of file class.ilUnitConfigurationGUI.php.

References getDefaultCommand(), initUnitCategoryForm(), and isCRUDContext().

                                                     : void
    {
        if (!$this->isCRUDContext()) {
            $this->{$this->getDefaultCommand()}();
            return;
        }

        $this->initUnitCategoryForm();

        $this->tpl->setContent($this->unit_cat_form->getHtml());
    }

Here is the call graph for this function:

showUnitCategoryModificationForm()

ilUnitConfigurationGUI::showUnitCategoryModificationForm ( )

protected

Definition at line 769 of file class.ilUnitConfigurationGUI.php.

References getCategoryById(), getDefaultCommand(), initUnitCategoryForm(), and isCRUDContext().

                                                         : void
    {
        if (!$this->isCRUDContext()) {
            $this->{$this->getDefaultCommand()}();
            return;
        }

        $category = $this->getCategoryById($this->request->int('category_id'));

        $this->initUnitCategoryForm($category);
        $this->unit_cat_form->setValuesByArray([
            'category_name' => $category->getCategory()
        ]);

        $this->tpl->setContent($this->unit_cat_form->getHtml());
    }

Here is the call graph for this function:

showUnitCreationForm()

ilUnitConfigurationGUI::showUnitCreationForm ( )

protected

Definition at line 356 of file class.ilUnitConfigurationGUI.php.

References getCategoryById(), initUnitForm(), isCRUDContext(), and ILIAS\Repository\lng().

                                             : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        $category = $this->getCategoryById($this->request->int('category_id'));

        $this->initUnitForm($category);
        $this->unit_form->setValuesByArray([
            'factor' => 1,
            'unit_title' => $this->lng->txt('unit_placeholder')
        ]);

        $this->tpl->setContent($this->unit_form->getHtml());
    }

Here is the call graph for this function:

showUnitModificationForm()

ilUnitConfigurationGUI::showUnitModificationForm ( )

protected

Definition at line 304 of file class.ilUnitConfigurationGUI.php.

References getCategoryById(), initUnitForm(), isCRUDContext(), and ILIAS\UI\examples\Deck\repository().

Referenced by saveUnit().

                                                 : void
    {
        if (!$this->isCRUDContext()) {
            $this->showUnitsOfCategory();
            return;
        }

        $category = $this->getCategoryById($this->request->int('category_id'));
        $unit = $this->repository->getUnit($this->request->int('unit_id'));

        $this->initUnitForm($category, $unit);
        $this->unit_form->setValuesByArray([
            'factor' => $unit->getFactor(),
            'unit_title' => $unit->getUnit(),
            'base_unit' => $unit->getBaseUnit() !== $unit->getId() ? $unit->getBaseUnit() : 0
        ]);

        $this->tpl->setContent($this->unit_form->getHtml());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrlInterface ilUnitConfigurationGUI::$ctrl

protected

Definition at line 32 of file class.ilUnitConfigurationGUI.php.

$lng

ilLanguage ilUnitConfigurationGUI::$lng

protected

Definition at line 31 of file class.ilUnitConfigurationGUI.php.

Referenced by __construct().

$repository

ilUnitConfigurationRepository ilUnitConfigurationGUI::$repository

protected

Definition at line 26 of file class.ilUnitConfigurationGUI.php.

Referenced by __construct(), and ilLocalUnitConfigurationGUI\handleSubtabs().

$request

ILIAS TestQuestionPool InternalRequestService ilUnitConfigurationGUI::$request

protected

Definition at line 27 of file class.ilUnitConfigurationGUI.php.

$tpl

ilGlobalTemplateInterface ilUnitConfigurationGUI::$tpl

protected

Definition at line 30 of file class.ilUnitConfigurationGUI.php.

Referenced by __construct().

$unit_cat_form

ilPropertyFormGUI ilUnitConfigurationGUI::$unit_cat_form = null

protected

Definition at line 28 of file class.ilUnitConfigurationGUI.php.

Referenced by initUnitCategoryForm().

$unit_form

ilPropertyFormGUI ilUnitConfigurationGUI::$unit_form = null

protected

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

Referenced by initUnitForm().

---

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

• Modules/TestQuestionPool/classes/class.ilUnitConfigurationGUI.php