ilExcCriteriaGUI Class Reference

Class ilExcCriteriaGUI. More...

Collaboration diagram for ilExcCriteriaGUI:

Public Member Functions
	__construct ($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
	$cat_id

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 ilExcCriteriaGUI:

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

Constructor & Destructor Documentation

__construct()

ilExcCriteriaGUI::__construct

(

$a_cat_id

)

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

        {
                $this->cat_id = $a_cat_id;
        }

Member Function Documentation

add()

ilExcCriteriaGUI::add ( ilPropertyFormGUI  $a_form = null )

protected

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

References $ilCtrl, $tpl, ilExcCriteria\getInstanceByType(), and initForm().

        {
                global $tpl, $ilCtrl;
                
                $new_type = trim($_REQUEST["type"]);            
                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 87 of file class.ilExcCriteriaGUI.php.

References $_POST, $ilCtrl, $lng, $tpl, ilExcCriteria\getInstancesByParentId(), and ilUtil\sendInfo().

        {
                global $ilCtrl, $lng, $tpl;
                
                $ids = $_POST["id"];
                if(!sizeof($ids))
                {
                        ilUtil::sendInfo($lng->txt("select_one"), true);
                        $ilCtrl->redirect($this, "view");
                }
                
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $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 248 of file class.ilExcCriteriaGUI.php.

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

        {
                global $ilCtrl;
                
                $new_type = trim($_REQUEST["type"]);            
                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 116 of file class.ilExcCriteriaGUI.php.

References $_POST, $ilCtrl, $lng, ilExcCriteria\getInstancesByParentId(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $lng;
                
                $ids = $_POST["id"];
                if(!sizeof($ids))
                {                       
                        $ilCtrl->redirect($this, "view");
                }
                
                foreach(ilExcCriteria::getInstancesByParentId($this->cat_id) as $item)
                {
                        if(in_array($item->getId(), $ids))
                        {
                                $item->delete();
                        }
                }
                
                ilUtil::sendSuccess($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 280 of file class.ilExcCriteriaGUI.php.

References $tpl, exportForm(), getCurrentCritera(), and initForm().

        {
                global $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 23 of file class.ilExcCriteriaGUI.php.

References $cmd, and $ilCtrl.

        {               
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("view");
        
                switch($next_class)
                {                       
                        default:
                                $this->$cmd();
                                break;
                }
        }

exportForm()

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

protected

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

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

Referenced by edit().

        {
                $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 262 of file class.ilExcCriteriaGUI.php.

References $cat_id, $ilCtrl, and ilExcCriteria\getInstanceById().

Referenced by edit(), and update().

        {
                global $ilCtrl;
                
                $id = (int)$_REQUEST["crit_id"];
                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");
        }                       

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 215 of file class.ilExcCriteriaGUI.php.

References $ilCtrl, $lng, ilExcCriteria\getId(), ilExcCriteria\importCustomForm(), initForm(), ilExcCriteria\save(), ilUtil\sendSuccess(), ilExcCriteria\setDescription(), ilExcCriteria\setParent(), ilExcCriteria\setRequired(), ilExcCriteria\setTitle(), and ilExcCriteria\update().

Referenced by create(), and update().

        {
                global $ilCtrl, $lng;
                
                $is_edit = (bool)$a_crit_obj->getId();
                
                $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();
                        }
                        
                        ilUtil::sendSuccess($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 143 of file class.ilExcCriteriaGUI.php.

References $ilCtrl, $lng, $title, ilExcCriteria\getId(), ilExcCriteria\getTranslatedType(), ilExcCriteria\initCustomForm(), and ilNonEditableValueGUI\setValue().

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

        {
                global $ilCtrl, $lng;
                
                include_once "Services/Form/classes/class.ilPropertyFormGUI.php";               
                $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 65 of file class.ilExcCriteriaGUI.php.

References $_POST, $ilCtrl, $lng, ilExcCriteria\getInstancesByParentId(), and ilUtil\sendSuccess().

        {
                global $ilCtrl, $lng;
                
                $all_cat = ilExcCriteria::getInstancesByParentId($this->cat_id);
                                
                $pos = 0;
                asort($_POST["pos"]);
                foreach(array_keys($_POST["pos"]) as $id)
                {       
                        if(array_key_exists($id, $all_cat))
                        {                               
                                $pos += 10;
                                $all_cat[$id]->setPosition($pos);
                                $all_cat[$id]->update();
                        }
                }
                
                ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                $ilCtrl->redirect($this, "view");
        }

Here is the call graph for this function:

update()

ilExcCriteriaGUI::update ( )

protected

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

References getCurrentCritera(), and importForm().

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

Here is the call graph for this function:

view()

ilExcCriteriaGUI::view ( )

protected

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

References $ilCtrl, $lng, $tbl, $tpl, ilSubmitButton\getInstance(), ilExcCriteria\getTypesMap(), and ilSelectInputGUI\setOptions().

        {
                global $ilToolbar, $ilCtrl, $lng, $tpl;
        
                $ilToolbar->setFormAction($ilCtrl->getFormAction($this, "add"));
                        
                include_once "Services/Form/classes/class.ilSelectInputGUI.php";
                $types = new ilSelectInputGUI($lng->txt("type"), "type");
                $types->setOptions(ilExcCriteria::getTypesMap());
                $ilToolbar->addStickyItem($types);
                
                include_once "Services/UIComponent/Button/classes/class.ilSubmitButton.php";
                $button = ilSubmitButton::getInstance();
                $button->setCaption("exc_add_criteria");
                $button->setCommand("add");                     
                $ilToolbar->addStickyItem($button);
                
                include_once "Modules/Exercise/classes/class.ilExcCriteriaTableGUI.php";
                $tbl = new ilExcCriteriaTableGUI($this, "view", $this->cat_id);
                $tpl->setContent($tbl->getHTML());
        }

Here is the call graph for this function:

Field Documentation

$cat_id

ilExcCriteriaGUI::$cat_id

protected

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

Referenced by getCurrentCritera().

---

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

• Modules/Exercise/classes/class.ilExcCriteriaGUI.php