ilExcCriteriaGUI Class Reference

Class ilExcCriteriaGUI. More...

Collaboration diagram for ilExcCriteriaGUI:

Public Member Functions
	__construct (int $a_cat_id)
	executeCommand ()

Protected Member Functions
	view ()
	saveOrder ()
	confirmDeletion ()
	delete ()
	initForm (ilExcCriteria $a_crit_obj)
	add (?ilPropertyFormGUI $a_form=null)
	exportForm (ilExcCriteria $a_crit_obj, ilPropertyFormGUI $a_form)
	importForm (ilExcCriteria $a_crit_obj)
	create ()
	getCurrentCritera ()
	edit (?ilPropertyFormGUI $a_form=null)
	update ()

Protected Attributes
ILIAS Exercise InternalGUIService	$gui
ilCtrl	$ctrl
ilToolbarGUI	$toolbar
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
int	$cat_id
GUIRequest	$request

Detailed Description

Class ilExcCriteriaGUI.

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilExcCriteriaGUI:

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

Constructor & Destructor Documentation

__construct()

ilExcCriteriaGUI::__construct

(

int

$a_cat_id

)

Definition at line 38 of file class.ilExcCriteriaGUI.php.

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        $this->lng = $DIC->language();
        $this->tpl = $DIC["tpl"];
        $this->cat_id = $a_cat_id;
        $this->request = $DIC->exercise()->internal()->gui()->request();
        $this->gui = $DIC->exercise()->internal()->gui();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilExcCriteriaGUI::add ( ?ilPropertyFormGUI  $a_form = null )

protected

Definition at line 205 of file class.ilExcCriteriaGUI.php.

References $ctrl, $tpl, ilExcCriteria\getInstanceByType(), initForm(), ilCtrl\redirect(), and ILIAS\UICore\GlobalTemplate\setContent().

                                                             : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;

        $new_type = $this->request->getCriteriaType();
        if (!$new_type) {
            $ilCtrl->redirect($this, "view");
        }

        $ilCtrl->setParameter($this, "type", $new_type);

        if (!$a_form) {
            $crit_obj = ilExcCriteria::getInstanceByType($new_type);
            $a_form = $this->initForm($crit_obj);
        }

        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

confirmDeletion()

ilExcCriteriaGUI::confirmDeletion ( )

protected

Definition at line 114 of file class.ilExcCriteriaGUI.php.

References $ctrl, $lng, $tpl, ilExcCriteria\getInstancesByParentId(), ILIAS\UICore\GlobalTemplate\setContent(), ILIAS\UICore\GlobalTemplate\setOnScreenMessage(), and ilLanguage\txt().

                                        : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;

        $ids = $this->request->getCriteriaIds();
        if (count($ids) == 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("select_one"), true);
            $ilCtrl->redirect($this, "view");
        }

        $confirmation_gui = new ilConfirmationGUI();
        $confirmation_gui->setFormAction($ilCtrl->getFormAction($this, "delete"));
        $confirmation_gui->setHeaderText($lng->txt("exc_criteria_deletion_confirmation"));
        $confirmation_gui->setCancel($lng->txt("cancel"), "view");
        $confirmation_gui->setConfirm($lng->txt("delete"), "delete");

        foreach (ilExcCriteria::getInstancesByParentId($this->cat_id) as $item) {
            if (in_array($item->getId(), $ids)) {
                $confirmation_gui->addItem("id[]", $item->getId(), $item->getTitle());
            }
        }

        $tpl->setContent($confirmation_gui->getHTML());
    }

Here is the call graph for this function:

create()

ilExcCriteriaGUI::create ( )

protected

Definition at line 267 of file class.ilExcCriteriaGUI.php.

References $ctrl, ilExcCriteria\getInstanceByType(), importForm(), and ilCtrl\redirect().

                               : void
    {
        $ilCtrl = $this->ctrl;

        $new_type = $this->request->getCriteriaType();
        if (!$new_type) {
            $ilCtrl->redirect($this, "view");
        }

        $crit_obj = ilExcCriteria::getInstanceByType($new_type);
        $this->importForm($crit_obj);
    }

Here is the call graph for this function:

delete()

ilExcCriteriaGUI::delete ( )

protected

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

References $ctrl, $lng, ilExcCriteria\getInstancesByParentId(), and ilLanguage\txt().

                               : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $ids = $this->request->getCriteriaIds();
        if (count($ids) == 0) {
            $ilCtrl->redirect($this, "view");
        }

        foreach (ilExcCriteria::getInstancesByParentId($this->cat_id) as $item) {
            if (in_array($item->getId(), $ids)) {
                $item->delete();
            }
        }

        $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $ilCtrl->redirect($this, "view");
    }

Here is the call graph for this function:

edit()

ilExcCriteriaGUI::edit ( ?ilPropertyFormGUI  $a_form = null )

protected

Definition at line 298 of file class.ilExcCriteriaGUI.php.

References $tpl, exportForm(), getCurrentCritera(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                                                              : void
    {
        $tpl = $this->tpl;

        $crit_obj = $this->getCurrentCritera();

        if (!$a_form) {
            $a_form = $this->initForm($crit_obj);
            $this->exportForm($crit_obj, $a_form);
        }

        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilExcCriteriaGUI::executeCommand

(

)

Definition at line 51 of file class.ilExcCriteriaGUI.php.

References $ctrl, and ilCtrl\getNextClass().

                                    : void
    {
        $ilCtrl = $this->ctrl;

        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd("view");

        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

exportForm()

ilExcCriteriaGUI::exportForm ( ilExcCriteria  $a_crit_obj, ilPropertyFormGUI  $a_form  )

protected

Definition at line 225 of file class.ilExcCriteriaGUI.php.

References ilExcCriteria\exportCustomForm(), ilExcCriteria\getDescription(), ilPropertyFormGUI\getItemByPostVar(), ilExcCriteria\getTitle(), and ilExcCriteria\isRequired().

Referenced by edit().

     : void {
        $a_form->getItemByPostVar("title")->setValue($a_crit_obj->getTitle());
        $a_form->getItemByPostVar("desc")->setValue($a_crit_obj->getDescription());
        $a_form->getItemByPostVar("req")->setChecked($a_crit_obj->isRequired());

        $a_crit_obj->exportCustomForm($a_form);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCurrentCritera()

ilExcCriteriaGUI::getCurrentCritera ( )

protected

Definition at line 280 of file class.ilExcCriteriaGUI.php.

References $cat_id, $ctrl, $id, ilExcCriteria\getInstanceById(), and null.

Referenced by edit(), and update().

                                          : ?ilExcCriteria
    {
        $ilCtrl = $this->ctrl;

        $id = $this->request->getCritId();
        if ($id) {
            $crit_obj = ilExcCriteria::getInstanceById($id);
            if ($crit_obj->getParent() == $this->cat_id) {
                $ilCtrl->setParameter($this, "crit_id", $id);
                return $crit_obj;
            }
        }

        $ilCtrl->redirect($this, "view");

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importForm()

ilExcCriteriaGUI::importForm ( ilExcCriteria  $a_crit_obj )

protected

Definition at line 236 of file class.ilExcCriteriaGUI.php.

References $ctrl, $lng, ilExcCriteria\getId(), ilExcCriteria\importCustomForm(), initForm(), ilExcCriteria\save(), ilExcCriteria\setDescription(), ilExcCriteria\setParent(), ilExcCriteria\setRequired(), ilExcCriteria\setTitle(), ilLanguage\txt(), and ilExcCriteria\update().

Referenced by create(), and update().

     : void {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $is_edit = (bool) $a_crit_obj->getId();
        $ilCtrl->setParameter($this, "type", $this->request->getCriteriaType());
        $form = $this->initForm($a_crit_obj);
        if ($form->checkInput()) {
            $a_crit_obj->setTitle($form->getInput("title"));
            $a_crit_obj->setDescription($form->getInput("desc"));
            $a_crit_obj->setRequired($form->getInput("req"));

            $a_crit_obj->importCustomForm($form);

            if (!$is_edit) {
                $a_crit_obj->setParent($this->cat_id);
                $a_crit_obj->save();
            } else {
                $a_crit_obj->update();
            }

            $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
            $ilCtrl->redirect($this, "view");
        }

        $form->setValuesByPost();
        $this->{$is_edit ? "edit" : "add"}($form);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilExcCriteriaGUI::initForm ( ilExcCriteria  $a_crit_obj )

protected

Definition at line 166 of file class.ilExcCriteriaGUI.php.

References $ctrl, $lng, XapiProxy\$req, ilExcCriteria\getId(), ilExcCriteria\getTranslatedType(), ilExcCriteria\initCustomForm(), and ilLanguage\txt().

Referenced by add(), edit(), and importForm().

                                                          : ilPropertyFormGUI
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $form = new ilPropertyFormGUI();

        $is_edit = (bool) $a_crit_obj->getId();
        if (!$is_edit) {
            $form->setFormAction($ilCtrl->getFormAction($this, "create"));
            $form->setTitle($lng->txt("exc_criteria_create_form"));
            $form->addCommandButton("create", $lng->txt("create"));
        } else {
            $form->setFormAction($ilCtrl->getFormAction($this, "update"));
            $form->setTitle($lng->txt("exc_criteria_update_form"));
            $form->addCommandButton("update", $lng->txt("save"));
        }

        $form->addCommandButton("view", $lng->txt("cancel"));

        $type = new ilNonEditableValueGUI($lng->txt("type"));
        $type->setValue($a_crit_obj->getTranslatedType());
        $form->addItem($type);

        $title = new ilTextInputGUI($lng->txt("title"), "title");
        $title->setRequired(true);
        $form->addItem($title);

        $desc = new ilTextAreaInputGUI($lng->txt("description"), "desc");
        $form->addItem($desc);

        $req = new ilCheckboxInputGUI($lng->txt("required_field"), "req");
        $form->addItem($req);

        $a_crit_obj->initCustomForm($form);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveOrder()

ilExcCriteriaGUI::saveOrder ( )

protected

Definition at line 92 of file class.ilExcCriteriaGUI.php.

References $ctrl, $id, $lng, ilExcCriteria\getInstancesByParentId(), and ilLanguage\txt().

                                  : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $all_cat = ilExcCriteria::getInstancesByParentId($this->cat_id);

        $pos = 0;
        $req_positions = $this->request->getPositions();
        asort($req_positions);
        foreach (array_keys($req_positions) as $id) {
            if (array_key_exists($id, $all_cat)) {
                $pos += 10;
                $all_cat[$id]->setPosition($pos);
                $all_cat[$id]->update();
            }
        }

        $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
        $ilCtrl->redirect($this, "view");
    }

Here is the call graph for this function:

update()

ilExcCriteriaGUI::update ( )

protected

Definition at line 312 of file class.ilExcCriteriaGUI.php.

References getCurrentCritera(), and importForm().

                               : void
    {
        $crit_obj = $this->getCurrentCritera();
        $this->importForm($crit_obj);
    }

Here is the call graph for this function:

view()

ilExcCriteriaGUI::view ( )

protected

Definition at line 70 of file class.ilExcCriteriaGUI.php.

References $ctrl, $lng, $toolbar, $tpl, ilExcCriteria\getTypesMap(), ILIAS\UICore\GlobalTemplate\setContent(), ilSelectInputGUI\setOptions(), and ilLanguage\txt().

                             : void
    {
        $ilToolbar = $this->toolbar;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $tpl = $this->tpl;

        $ilToolbar->setFormAction($ilCtrl->getFormAction($this, "add"));

        $types = new ilSelectInputGUI($lng->txt("type"), "type");
        $types->setOptions(ilExcCriteria::getTypesMap());
        $ilToolbar->addStickyItem($types);

        $this->gui->button(
            $lng->txt("exc_add_criteria"),
            "add"
        )->submit()->toToolbar(true);

        $tbl = new ilExcCriteriaTableGUI($this, "view", $this->cat_id);
        $tpl->setContent($tbl->getHTML());
    }

Here is the call graph for this function:

Field Documentation

$cat_id

int ilExcCriteriaGUI::$cat_id

protected

Definition at line 35 of file class.ilExcCriteriaGUI.php.

Referenced by getCurrentCritera().

$ctrl

ilCtrl ilExcCriteriaGUI::$ctrl

protected

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

Referenced by add(), confirmDeletion(), create(), delete(), executeCommand(), getCurrentCritera(), importForm(), initForm(), saveOrder(), and view().

$gui

ILIAS Exercise InternalGUIService ilExcCriteriaGUI::$gui

protected

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

$lng

ilLanguage ilExcCriteriaGUI::$lng

protected

Definition at line 33 of file class.ilExcCriteriaGUI.php.

Referenced by confirmDeletion(), delete(), importForm(), initForm(), saveOrder(), and view().

$request

GUIRequest ilExcCriteriaGUI::$request

protected

Definition at line 36 of file class.ilExcCriteriaGUI.php.

$toolbar

ilToolbarGUI ilExcCriteriaGUI::$toolbar

protected

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

Referenced by view().

$tpl

ilGlobalTemplateInterface ilExcCriteriaGUI::$tpl

protected

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

Referenced by add(), confirmDeletion(), edit(), and view().

---

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

• components/ILIAS/Exercise/PeerReview/Criteria/class.ilExcCriteriaGUI.php