ilObjCourseGroupingGUI Class Reference

Class ilObjCourseGroupingGUI. More...

Collaboration diagram for ilObjCourseGroupingGUI:

Public Member Functions
	__construct (ilObject $content_obj, int $a_obj_id=0)
	executeCommand ()
	__initGroupingObject ()
	getContentType ()
	listGroupings ()
	askDeleteGrouping ()
	deleteGrouping ()
	create (?ilPropertyFormGUI $a_form=null)
	initForm (bool $a_create)
	add ()
	edit (?ilPropertyFormGUI $a_form=null)
	update ()
	selectCourse ()
	assignCourse ()

Protected Attributes
ilGlobalTemplateInterface	$tpl
ilCtrlInterface	$ctrl
ilLanguage	$lng
ilErrorHandling	$error
ilAccessHandler	$access
ilTabsGUI	$tabs
ilToolbarGUI	$toolbar
GlobalHttpState	$http
Factory	$refinery

Private Attributes
ilObjCourseGrouping	$grp_obj
int	$id
ilObject	$content_obj
string	$content_type = ''

Detailed Description

Class ilObjCourseGroupingGUI.

Author

your name <your email>="">

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

Constructor & Destructor Documentation

__construct()

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

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

References $content_obj, $DIC, __initGroupingObject(), ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->tpl = $DIC->ui()->mainTemplate();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->error = $DIC['ilErr'];
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC->toolbar();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();

        $this->content_obj = $content_obj;
        $this->content_type = ilObject::_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 77 of file class.ilObjCourseGroupingGUI.php.

Referenced by __construct().

                                          : void
    {
        $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 create(), ILIAS\Repository\ctrl(), initForm(), and ILIAS\Repository\lng().

                         : void
    {
        $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'));

            $this->grp_obj->create($this->content_obj->getRefId(), $this->content_obj->getId());
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('crs_grp_added_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 102 of file class.ilObjCourseGroupingGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), listGroupings(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                       : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $grouping = [];
        if ($this->http->wrapper()->post()->has('grouping')) {
            $grouping = $this->http->wrapper()->post()->retrieve(
                'grouping',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        if (!count($grouping)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('crs_grouping_select_one'));
            $this->listGroupings();
            return;
        }

        // display confirmation message
        $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 ($grouping as $grouping_id) {
            $tmp_obj = new ilObjCourseGrouping($grouping_id);
            $cgui->addItem("grouping[]", $grouping_id, $tmp_obj->getTitle());
        }
        $this->tpl->setContent($cgui->getHTML());
    }

Here is the call graph for this function:

assignCourse()

ilObjCourseGroupingGUI::assignCourse

(

)

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), getContentType(), ilObjectFactory\getInstanceByRefId(), ILIAS\FileDelivery\http(), listGroupings(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                  : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        if (!$this->id) {
            $this->listGroupings();
            return;
        }

        // delete all existing conditions
        $condh = new ilConditionHandler();
        $condh->deleteByObjId($this->id);

        $added = 0;
        $container_ids = [];
        if ($this->http->wrapper()->post()->has('crs_ids')) {
            $container_ids = $this->http->wrapper()->post()->retrieve(
                'crs_ids',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        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;
            }
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'edit');
    }

Here is the call graph for this function:

create()

ilObjCourseGroupingGUI::create

(

?ilPropertyFormGUI

$a_form = null

)

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

References ILIAS\Repository\access(), initForm(), and ILIAS\Repository\lng().

Referenced by add().

                                                             : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        if (!$a_form) {
            $a_form = $this->initForm(true);
        }

        $this->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 139 of file class.ilObjCourseGroupingGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                    : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
        $grouping = [];
        if ($this->http->wrapper()->post()->has('grouping')) {
            $grouping = $this->http->wrapper()->post()->retrieve(
                'grouping',
                $this->refinery->kindlyTo()->listOf(
                    $this->refinery->kindlyTo()->int()
                )
            );
        }

        foreach ($grouping as $grouping_id) {
            $tmp_obj = new ilObjCourseGrouping((int) $grouping_id);
            $tmp_obj->delete();
        }

        $this->tpl->setOnScreenMessage('success', $this->lng->txt('crs_grouping_deleted'), true);
        $this->ctrl->redirect($this, 'listGroupings');
    }

Here is the call graph for this function:

edit()

ilObjCourseGroupingGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

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

References ILIAS\Repository\access(), initForm(), and ILIAS\Repository\lng().

Referenced by update().

                                                           : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }
        if (!$a_form) {
            $a_form = $this->initForm(false);
        }
        $this->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 67 of file class.ilObjCourseGroupingGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\tabs().

                                    : void
    {
        $this->tabs->setTabActive('crs_groupings');
        $cmd = $this->ctrl->getCmd();
        if (!$cmd = $this->ctrl->getCmd()) {
            $cmd = "edit";
        }
        $this->$cmd();
    }

Here is the call graph for this function:

getContentType()

ilObjCourseGroupingGUI::getContentType

(

)

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

References $content_type.

Referenced by assignCourse().

                                    : string
    {
        return $this->content_type;
    }

Here is the caller graph for this function:

initForm()

ilObjCourseGroupingGUI::initForm

(

bool

$a_create

)

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

References ilObject\_lookupTitle(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

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

                                            : ilPropertyFormGUI
    {
        $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($this->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 ($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 87 of file class.ilObjCourseGroupingGUI.php.

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

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

                                   : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $this->toolbar->addButton(
            $this->lng->txt('crs_add_grouping'),
            $this->ctrl->getLinkTarget($this, 'create')
        );

        $table = new ilCourseGroupingTableGUI($this, 'listGroupings', $this->content_obj);
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

selectCourse()

ilObjCourseGroupingGUI::selectCourse

(

)

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), listGroupings(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

                                  : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        if (!$this->id) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('crs_grp_no_grouping_id_given'));
            $this->listGroupings();
            return;
        }

        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('back'),
            $this->ctrl->getLinkTarget($this, 'edit')
        );
        $tmp_grouping = new ilObjCourseGrouping($this->id);
        $table = new ilCourseGroupingAssignmentTableGUI($this, 'selectCourse', $this->content_obj, $tmp_grouping);
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

update()

ilObjCourseGroupingGUI::update

(

)

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), edit(), ILIAS\FileDelivery\http(), initForm(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                            : void
    {
        if (!$this->access->checkAccess('write', '', $this->content_obj->getRefId())) {
            $this->error->raiseError($this->lng->txt('permission_denied'), $this->error->MESSAGE);
        }

        $obj_id = 0;
        if ($this->http->wrapper()->query()->has('obj_id')) {
            $obj_id = $this->http->wrapper()->query()->retrieve(
                'obj_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        $form = $this->initForm(false);
        if ($form->checkInput()) {
            $tmp_grouping = new ilObjCourseGrouping($obj_id);
            $tmp_grouping->setTitle($form->getInput('title'));
            $tmp_grouping->setDescription($form->getInput('description'));
            $tmp_grouping->setUniqueField($form->getInput('unique'));
            $tmp_grouping->update();

            $this->tpl->setOnScreenMessage('success', $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

$access

ilAccessHandler ilObjCourseGroupingGUI::$access

protected

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

$content_obj

ilObject ilObjCourseGroupingGUI::$content_obj

private

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

Referenced by __construct().

$content_type

string ilObjCourseGroupingGUI::$content_type = ''

private

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

Referenced by getContentType().

$ctrl

ilCtrlInterface ilObjCourseGroupingGUI::$ctrl

protected

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

$error

ilErrorHandling ilObjCourseGroupingGUI::$error

protected

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

$grp_obj

ilObjCourseGrouping ilObjCourseGroupingGUI::$grp_obj

private

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

$http

GlobalHttpState ilObjCourseGroupingGUI::$http

protected

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

$id

int ilObjCourseGroupingGUI::$id

private

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

$lng

ilLanguage ilObjCourseGroupingGUI::$lng

protected

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

$refinery

Factory ilObjCourseGroupingGUI::$refinery

protected

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

$tabs

ilTabsGUI ilObjCourseGroupingGUI::$tabs

protected

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

$toolbar

ilToolbarGUI ilObjCourseGroupingGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilObjCourseGroupingGUI::$tpl

protected

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

---

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

• components/ILIAS/Course/classes/class.ilObjCourseGroupingGUI.php