ilObjCourseGroupingGUI Class Reference

Class ilObjCourseGroupingGUI. More...

Collaboration diagram for ilObjCourseGroupingGUI:

Public Member Functions
	__construct ($content_obj, $a_obj_id=0)
	Constructor public. More...
	executeCommand ()
	__initGroupingObject ()
	getContentType ()
	listGroupings ()
	askDeleteGrouping ()
	deleteGrouping ()
	create ($a_form=null)
	initForm ($a_create)
	add ()
	edit ($a_form=null)
	update ()
	selectCourse ()
	assignCourse ()

Data Fields
	$content_obj
	$tpl
	$ctrl
	$lng

Detailed Description

Class ilObjCourseGroupingGUI.

Author

your name <your email>="">

Version

$Id$

Definition at line 13 of file class.ilObjCourseGroupingGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjCourseGroupingGUI::__construct	(		$content_obj,
			$a_obj_id = 0
	)

Constructor public.

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

References $content_obj, $DIC, $ilCtrl, $lng, $tpl, and __initGroupingObject().

    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $ilCtrl = $DIC['ilCtrl'];
        $lng = $DIC['lng'];
        $ilObjDataCache = $DIC['ilObjDataCache'];

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

        $this->type = "crsg";
        $this->content_obj = $content_obj;
        $this->content_type = $ilObjDataCache->lookupType($this->content_obj->getId());

        $this->id = $a_obj_id;
        $this->ctrl->saveParameter($this, 'obj_id');

        $this->__initGroupingObject();
    }

Here is the call graph for this function:

Member Function Documentation

__initGroupingObject()

ilObjCourseGroupingGUI::__initGroupingObject

(

)

Definition at line 63 of file class.ilObjCourseGroupingGUI.php.

Referenced by __construct().

    {
        include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';

        $this->grp_obj = new ilObjCourseGrouping($this->id);
    }

Here is the caller graph for this function:

add()

ilObjCourseGroupingGUI::add

(

)

Definition at line 232 of file class.ilObjCourseGroupingGUI.php.

References $form, create(), initForm(), and ilUtil\sendFailure().

    {
        $form = $this->initForm(true);
        if ($form->checkInput()) {
            $this->grp_obj->setTitle($form->getInput('title'));
            $this->grp_obj->setDescription($form->getInput('description'));
            $this->grp_obj->setUniqueField($form->getInput('unique'));
            
            if ($this->grp_obj->create($this->content_obj->getRefId(), $this->content_obj->getId())) {
                ilUtil::sendSuccess($this->lng->txt('crs_grp_added_grouping'), true);
            } else {
                ilUtil::sendFailure($this->lng->txt('crs_grp_err_adding_grouping'), true);
            }
            
            $this->ctrl->redirect($this, 'listGroupings');
        }

        $form->setValuesByPost();
        $this->create($form);
    }

Here is the call graph for this function:

askDeleteGrouping()

ilObjCourseGroupingGUI::askDeleteGrouping

(

)

Definition at line 99 of file class.ilObjCourseGroupingGUI.php.

References $_POST, $DIC, $ilErr, $tpl, listGroupings(), and ilUtil\sendFailure().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $tpl = $DIC['tpl'];

        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }

        if (empty($_POST['grouping'])) {
            ilUtil::sendFailure($this->lng->txt('crs_grouping_select_one'));
            $this->listGroupings();
            
            return false;
        }

        // display confirmation message
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($this->ctrl->getFormAction($this));
        $cgui->setHeaderText($this->lng->txt("crs_grouping_delete_sure"));
        $cgui->setCancel($this->lng->txt("cancel"), "listGroupings");
        $cgui->setConfirm($this->lng->txt("delete"), "deleteGrouping");

        // list objects that should be deleted
        foreach ($_POST['grouping'] as $grouping_id) {
            $tmp_obj = new ilObjCourseGrouping($grouping_id);
            $cgui->addItem("grouping[]", $grouping_id, $tmp_obj->getTitle());
        }

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

Here is the call graph for this function:

assignCourse()

ilObjCourseGroupingGUI::assignCourse

(

)

Definition at line 335 of file class.ilObjCourseGroupingGUI.php.

References $_GET, $_POST, $DIC, $ilErr, $ilUser, $tree, getContentType(), ilObjectFactory\getInstanceByRefId(), and listGroupings().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];

        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }

        if (!$_GET['obj_id']) {
            $this->listGroupings();
            return false;
        }
    
        // delete all existing conditions
        include_once './Services/Conditions/classes/class.ilConditionHandler.php';
        $condh = new ilConditionHandler();
        $condh->deleteByObjId((int) $_GET['obj_id']);

        $added = 0;
        $container_ids = is_array($_POST['crs_ids']) ? $_POST['crs_ids'] : array();
        foreach ($container_ids as $course_ref_id) {
            $tmp_crs = ilObjectFactory::getInstanceByRefId($course_ref_id);
            $tmp_condh = new ilConditionHandler();
            $tmp_condh->enableAutomaticValidation(false);

            $tmp_condh->setTargetRefId($course_ref_id);
            $tmp_condh->setTargetObjId($tmp_crs->getId());
            $tmp_condh->setTargetType($this->getContentType());
            $tmp_condh->setTriggerRefId(0);
            $tmp_condh->setTriggerObjId($this->id);
            $tmp_condh->setTriggerType('crsg');
            $tmp_condh->setOperator('not_member');
            $tmp_condh->setValue($this->grp_obj->getUniqueField());

            if (!$tmp_condh->checkExists()) {
                $tmp_condh->storeCondition();
                ++$added;
            }
        }
        
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'edit');
    }

Here is the call graph for this function:

create()

ilObjCourseGroupingGUI::create

(

$a_form = null

)

Definition at line 155 of file class.ilObjCourseGroupingGUI.php.

References $DIC, $ilErr, $tpl, and initForm().

Referenced by add().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $tpl = $DIC['tpl'];
        
        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }
        
        if (!$a_form) {
            $a_form = $this->initForm(true);
        }
        
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteGrouping()

ilObjCourseGroupingGUI::deleteGrouping

(

)

Definition at line 135 of file class.ilObjCourseGroupingGUI.php.

References $_POST, $DIC, and $ilErr.

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];

        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }

        foreach ($_POST['grouping'] as $grouping_id) {
            $tmp_obj = new ilObjCourseGrouping((int) $grouping_id);
            $tmp_obj->delete();
        }
        
        ilUtil::sendSuccess($this->lng->txt('crs_grouping_deleted'), true);
        $this->ctrl->redirect($this, 'listGroupings');
    }

edit()

ilObjCourseGroupingGUI::edit

(

$a_form = null

)

Definition at line 253 of file class.ilObjCourseGroupingGUI.php.

References $DIC, $ilErr, $tpl, and initForm().

Referenced by update().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $tpl = $DIC['tpl'];

        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }
        
        if (!$a_form) {
            $a_form = $this->initForm(false);
        }
        
        $tpl->setContent($a_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilObjCourseGroupingGUI::executeCommand

(

)

Definition at line 47 of file class.ilObjCourseGroupingGUI.php.

References $DIC.

    {
        global $DIC;

        $ilTabs = $DIC['ilTabs'];

        $ilTabs->setTabActive('crs_groupings');

        $cmd = $this->ctrl->getCmd();
        if (!$cmd = $this->ctrl->getCmd()) {
            $cmd = "edit";
        }
        $this->$cmd();
    }

getContentType()

ilObjCourseGroupingGUI::getContentType

(

)

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

Referenced by assignCourse().

    {
        return $this->content_type;
    }

Here is the caller graph for this function:

initForm()

ilObjCourseGroupingGUI::initForm

(

$a_create

)

Definition at line 174 of file class.ilObjCourseGroupingGUI.php.

References $form, PHPMailer\PHPMailer\$options, $title, ilObject\_lookupTitle(), and ilFormPropertyGUI\setRequired().

Referenced by add(), create(), edit(), and update().

    {
        include_once "Services/Form/classes/class.ilPropertyFormGUI.php";
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        
        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setRequired(true);
        $form->addItem($title);
        
        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $form->addItem($desc);
        
        $options = array('login' => 'login',
                         'email' => 'email',
                         'matriculation' => 'matriculation');

        foreach ($options as $value => $caption) {
            $options[$value] = $this->lng->txt($caption);
        }
        $uniq = new ilSelectInputGUI($this->lng->txt('unambiguousness'), 'unique');
        $uniq->setRequired(true);
        $uniq->setOptions($options);
        $form->addItem($uniq);
                
        if ($a_create) {
            $form->setTitle($this->lng->txt('crs_add_grouping'));
            $form->addCommandButton('add', $this->lng->txt('btn_add'));
        } else {
            $grouping = new ilObjCourseGrouping($_REQUEST['obj_id']);
            $title->setValue($grouping->getTitle());
            $desc->setValue($grouping->getDescription());
            $uniq->setValue($grouping->getUniqueField());
                    
            $ass = new ilCustomInputGUI($this->lng->txt('groupings_assigned_obj_' . $this->getContentType()));
            $form->addItem($ass);
            
            // assignments
            $items = array();
            foreach ($grouping->getAssignedItems() as $cond_data) {
                $items[] = ilObject::_lookupTitle($cond_data['target_obj_id']);
            }
            if (count($items)) {
                $ass->setHtml(implode("<br />", $items));
            } else {
                $ass->setHtml($this->lng->txt('crs_grp_no_courses_assigned'));
            }
            
            $form->setTitle($this->lng->txt('edit_grouping'));
            $form->addCommandButton('update', $this->lng->txt('save'));
            $form->addCommandButton('selectCourse', $this->lng->txt('grouping_change_assignment'));
        }
        
        $form->addCommandButton('listGroupings', $this->lng->txt('cancel'));
        
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

listGroupings()

ilObjCourseGroupingGUI::listGroupings

(

)

Definition at line 75 of file class.ilObjCourseGroupingGUI.php.

References $DIC, $ilErr, $table, and $tpl.

Referenced by askDeleteGrouping(), assignCourse(), and selectCourse().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $ilToolbar = $DIC['ilToolbar'];
        $tpl = $DIC['tpl'];

        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }
        
        $ilToolbar->addButton(
            $this->lng->txt('crs_add_grouping'),
            $this->ctrl->getLinkTarget($this, 'create')
        );

        include_once 'Modules/Course/classes/class.ilCourseGroupingTableGUI.php';
        $table = new ilCourseGroupingTableGUI($this, 'listGroupings', $this->content_obj);
        
        $tpl->setContent($table->getHTML());
    }

Here is the caller graph for this function:

selectCourse()

ilObjCourseGroupingGUI::selectCourse

(

)

Definition at line 300 of file class.ilObjCourseGroupingGUI.php.

References $_GET, $DIC, $ilErr, $table, $tpl, listGroupings(), and ilUtil\sendFailure().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];

        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }

        if (!$_GET['obj_id']) {
            ilUtil::sendFailure($this->lng->txt('crs_grp_no_grouping_id_given'));
            $this->listGroupings();
            return false;
        }
        
        $ilTabs->clearTargets();
        $ilTabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'edit')
        );

        $tmp_grouping = new ilObjCourseGrouping((int) $_GET['obj_id']);
        
        include_once 'Modules/Course/classes/class.ilCourseGroupingAssignmentTableGUI.php';
        $table = new ilCourseGroupingAssignmentTableGUI($this, 'selectCourse', $this->content_obj, $tmp_grouping);
        
        $tpl->setContent($table->getHTML());
        
        return true;
    }

Here is the call graph for this function:

update()

ilObjCourseGroupingGUI::update

(

)

Definition at line 272 of file class.ilObjCourseGroupingGUI.php.

References $DIC, $form, $ilErr, edit(), and initForm().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        $ilAccess = $DIC['ilAccess'];
        $ilObjDataCache = $DIC['ilObjDataCache'];
        
        if (!$ilAccess->checkAccess('write', '', $this->content_obj->getRefId())) {
            $ilErr->raiseError($this->lng->txt('permission_denied'), $ilErr->MESSAGE);
        }

        $form = $this->initForm(false);
        if ($form->checkInput()) {
            $tmp_grouping = new ilObjCourseGrouping($_REQUEST['obj_id']);
            $tmp_grouping->setTitle($form->getInput('title'));
            $tmp_grouping->setDescription($form->getInput('description'));
            $tmp_grouping->setUniqueField($form->getInput('unique'));
            $tmp_grouping->update();

            ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'listGroupings');
        }
        
        $form->setValuesByPost();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$content_obj

ilObjCourseGroupingGUI::$content_obj

Definition at line 15 of file class.ilObjCourseGroupingGUI.php.

Referenced by __construct().

$ctrl

ilObjCourseGroupingGUI::$ctrl

Definition at line 17 of file class.ilObjCourseGroupingGUI.php.

$lng

ilObjCourseGroupingGUI::$lng

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

Referenced by __construct().

$tpl

ilObjCourseGroupingGUI::$tpl

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

Referenced by __construct(), askDeleteGrouping(), create(), edit(), listGroupings(), and selectCourse().

---

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

• Modules/Course/classes/class.ilObjCourseGroupingGUI.php