Public Member Functions
	ilCourseRegisterGUI ($a_course_id)
&	executeCommand ()
	execute command
	cancel ()
	subscribe ()
	showRegistrationForm ()
	__initCourseObject ()
	__initWaitingList ()
	__validateStatus ()
	__formatPath ($a_path_arr)
Data Fields
	$ctrl
	$ilias
	$tree
	$ilErr
	$lng
	$tpl
	$course_obj
	$course_id
	$user_id
	$validation = true

Detailed Description

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

Member Function Documentation

ilCourseRegisterGUI::__formatPath ( $ a_path_arr )

Definition at line 463 of file class.ilCourseRegisterGUI.php.

References $counter, and $data.

        {
                $counter = 0;
                foreach($a_path_arr as $data)
                {
                        if(!$counter++)
                        {
                                continue;
                        }
                        if($counter++ > 2)
                        {
                                $path .= " -> ";
                        }
                        $path .= $data['title'];
                }

                return $path;
        }

ilCourseRegisterGUI::__initCourseObject ( )

Definition at line 365 of file class.ilCourseRegisterGUI.php.

References exit, and ilObjectFactory::getInstanceByRefId().

Referenced by ilCourseRegisterGUI().

        {
                if(!$this->course_obj =& ilObjectFactory::getInstanceByRefId($this->course_id,false))
                {
                        $this->ilErr->raiseError("ilCourseRegisterGUI: cannot create course object",$this->ilErr->MESSAGE);
                        exit;
                }
                $this->course_obj->initCourseMemberObject();

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseRegisterGUI::__initWaitingList ( )

Definition at line 377 of file class.ilCourseRegisterGUI.php.

Referenced by ilCourseRegisterGUI().

        {
                include_once 'course/classes/class.ilCourseWaitingList.php';

                $this->waiting_list =& new ilCourseWaitingList($this->course_obj->getId());

                return true;
        }

Here is the caller graph for this function:

ilCourseRegisterGUI::__validateStatus ( )

Definition at line 386 of file class.ilCourseRegisterGUI.php.

References ilObjCourseGrouping::_checkGroupingDependencies().

Referenced by showRegistrationForm().

        {
                include_once 'course/classes/class.ilObjCourseGrouping.php';

                $allow_subscription = true;

                $this->course_obj->setMessage('');

                if($this->course_obj->members_obj->isAssigned($this->user_id))
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_user_already_assigned"));
                        $allow_subscription = false;
                }
                if($this->course_obj->members_obj->isBlocked($this->user_id))
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_user_blocked"));
                        $allow_subscription = false;
                }
                if($this->course_obj->members_obj->isSubscriber($this->user_id))
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_user_already_subscribed"));
                        $allow_subscription = false;
                }
                if($this->course_obj->getSubscriptionLimitationType() == IL_CRS_SUBSCRIPTION_DEACTIVATED)
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_subscription_deactivated"));
                        $allow_subscription = false;

                        return false;
                }
                if(!$this->course_obj->getSubscriptionUnlimitedStatus() and
                   ( time() < $this->course_obj->getSubscriptionStart()))
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_subscription_start_later"));
                        $allow_subscription = false;
                }
                if(!$this->course_obj->getSubscriptionUnlimitedStatus() and
                   ( time() > $this->course_obj->getSubscriptionEnd()))
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_subscription_end_earlier"));
                        $allow_subscription = false;
                }
                if(!ilObjCourseGrouping::_checkGroupingDependencies($this->course_obj))
                {
                        $allow_subscription = false;
                }
                if($this->waiting_list->isOnList($this->user_id) and $allow_subscription)
                {
                        $this->course_obj->appendMessage($this->lng->txt('crs_already_assigned_to_list'));
                        $allow_subscription = false;
                }
                elseif($this->course_obj->getSubscriptionMaxMembers() and 
                           (($this->course_obj->members_obj->getCountMembers() + $this->course_obj->members_obj->getCountSubscribers()) 
                                >= $this->course_obj->getSubscriptionMaxMembers()) and
                           $allow_subscription)
                {
                        $this->course_obj->appendMessage($this->lng->txt("crs_reg_subscription_max_members_reached"));
                        if($this->course_obj->enabledWaitingList())
                        {
                                $this->course_obj->appendMessage($this->lng->txt('crs_set_on_waiting_list'));
                        }
                        else
                        {
                                $allow_subscription = false;
                        }
                }
                elseif($this->waiting_list->getCountUsers() 
                           and $allow_subscription
                           and $this->course_obj->enabledWaitingList())
                {
                        $this->course_obj->appendMessage($this->lng->txt('crs_set_on_waiting_list'));
                }
                return $allow_subscription;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseRegisterGUI::cancel ( )

Definition at line 94 of file class.ilCourseRegisterGUI.php.

References ilUtil::redirect(), and sendInfo().

        {
                sendInfo($this->lng->txt("action_aborted"),true);

                ilUtil::redirect('repository.php?ref_id='.$this->tree->getParentId($this->course_id));
        }

Here is the call graph for this function:

& ilCourseRegisterGUI::executeCommand ( )

execute command

Definition at line 73 of file class.ilCourseRegisterGUI.php.

References $cmd.

        {
                global $ilTabs;

                $ilTabs->setTabActive('join');

                switch($cmd = $this->ctrl->getCmd())
                {
                        case '':
                                $this->ctrl->returnToParent($this);
                                break;

                        case 'archive':
                        case 'join':
                        case 'view':
                                $cmd = "showRegistrationForm";
                                break;
                }
                $this->$cmd();
        }

ilCourseRegisterGUI::ilCourseRegisterGUI ( $ a_course_id )

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

References $ilCtrl, $ilErr, $ilias, $lng, $tpl, $tree, __initCourseObject(), and __initWaitingList().

        {
                global $ilCtrl,$lng,$ilErr,$ilias,$tpl,$tree;

                $this->ctrl =& $ilCtrl;
                $this->ctrl->saveParameter($this,array("ref_id"));

                $this->ilErr =& $ilErr;
                $this->lng =& $lng;
                $this->tpl =& $tpl;
                $this->tree =& $tree;

                $this->user_id = $ilias->account->getId();

                $this->course_id = $a_course_id;
                $this->__initCourseObject();
                $this->__initWaitingList();
        }

Here is the call graph for this function:

ilCourseRegisterGUI::showRegistrationForm ( )

Definition at line 230 of file class.ilCourseRegisterGUI.php.

References __validateStatus(), ilObjCourseGrouping::_getGroupingItemsAsString(), ilFormat::formatUnixTime(), ilUtil::getImagePath(), and sendInfo().

Referenced by subscribe().

        {
                $really_submit = true;
                if($this->validation)
                {
                        $really_submit = $this->__validateStatus();
                }

                if($this->course_obj->getMessage())
                {
                        sendInfo($this->course_obj->getMessage());
                }

                $this->tpl->addBlockFile("ADM_CONTENT", "adm_content", "tpl.crs_subscription.html","course");
                $this->tpl->setVariable("FORMACTION",$this->ctrl->getFormActionByClass("ilObjCourseGUI"));
                
                $this->tpl->setVariable("TYPE_IMG",ilUtil::getImagePath("icon_crs.gif"));
                $this->tpl->setVariable("ALT_IMG",$this->lng->txt("obj_crs"));
                $this->tpl->setVariable("TITLE",$this->lng->txt("crs_registration"));

                if(strlen($this->course_obj->getSyllabus()))
                {
                        $this->tpl->setVariable("TXT_SYLLABUS",$this->lng->txt("crs_syllabus"));
                        $this->tpl->setVariable("SYLLABUS",nl2br($this->course_obj->getSyllabus()));
                }

                $this->tpl->setVariable("TXT_INFO_REG",$this->lng->txt("crs_info_reg"));


                // Waiting list
                if($this->course_obj->getSubscriptionMaxMembers() and $this->course_obj->enabledWaitingList())
                {
                        $this->tpl->setCurrentBlock("waiting_list");
                        $this->tpl->setVariable("TXT_WAITING_LIST",$this->lng->txt('crs_free_places'));

                        $free_places = $this->course_obj->getSubscriptionMaxMembers() - 
                                $this->course_obj->members_obj->getCountMembers() -
                                $this->course_obj->members_obj->getCountSubscribers();

                        $free_places = $free_places >= 0 ? $free_places : 0;
                        $this->tpl->setVariable("FREE_PLACES",$free_places);
                        $this->tpl->parseCurrentBlock();

                        if($this->waiting_list->isOnList($this->user_id))
                        {
                                $this->tpl->setCurrentBlock("waiting_list_info");
                                $this->tpl->setVariable("TXT_WAITING_LIST_INFO",$this->lng->txt('crs_youre_position'));
                                $this->tpl->setVariable("POSITION",$this->waiting_list->getPosition($this->user_id));
                                $this->tpl->parseCurrentBlock();
                        }
                        else
                        {
                                $this->tpl->setCurrentBlock("waiting_list_info");
                                $this->tpl->setVariable("TXT_WAITING_LIST_INFO",$this->lng->txt('crs_persons_on_waiting_list'));
                                $this->tpl->setVariable("POSITION",$this->waiting_list->getCountUsers());
                                $this->tpl->parseCurrentBlock();
                        }

                }
                if($courses = ilObjCourseGrouping::_getGroupingItemsAsString($this->course_obj))
                {
                        $this->tpl->setVariable("INFO_REG_PRE",$this->lng->txt('crs_grp_info_reg').$courses.'<br>');
                }

                if($this->course_obj->getSubscriptionLimitationType() != IL_CRS_SUBSCRIPTION_DEACTIVATED)
                {
                        switch($this->course_obj->getSubscriptionType())
                        {
                                case $this->course_obj->SUBSCRIPTION_CONFIRMATION:
                                        $this->tpl->setVariable("INFO_REG",$this->lng->txt("crs_info_reg_confirmation"));
                                        break;
                                case $this->course_obj->SUBSCRIPTION_DIRECT:
                                        $this->tpl->setVariable("INFO_REG",$this->lng->txt("crs_info_reg_direct"));
                                        break;
                                case $this->course_obj->SUBSCRIPTION_PASSWORD:
                                        $this->tpl->setVariable("INFO_REG",$this->lng->txt("crs_info_reg_password"));
                                        break;
                        }

                        $this->tpl->setCurrentBlock("reg_until");
                        $this->tpl->setVariable("TXT_REG_UNTIL",$this->lng->txt("crs_reg_until"));

                        if($this->course_obj->getSubscriptionUnlimitedStatus())
                        {
                                $this->tpl->setVariable("REG_UNTIL",$this->lng->txt("crs_unlimited"));
                        }
                        else if($this->course_obj->getSubscriptionStart() < time())
                        {
                                $this->tpl->setVariable("FROM",$this->lng->txt("crs_to"));
                                $this->tpl->setVariable("REG_UNTIL",ilFormat::formatUnixTime($this->course_obj->getSubscriptionEnd(),true));
                        }
                        else if($this->course_obj->getSubscriptionStart() > time())
                        {
                                $this->tpl->setVariable("FROM",$this->lng->txt("crs_from"));
                                $this->tpl->setVariable("REG_UNTIL",ilFormat::formatUnixTime($this->course_obj->getSubscriptionStart(),true));
                        }
                        $this->tpl->parseCurrentBlock();
                }
                else
                {
                        // Deactivated
                        $this->tpl->setVariable("INFO_REG",$this->lng->txt("crs_info_reg_deactivated"));
                }

                if($this->course_obj->getSubscriptionType() == $this->course_obj->SUBSCRIPTION_PASSWORD and
                   $this->course_obj->inSubscriptionTime())
                {
                        $this->tpl->setCurrentBlock("pass");
                        $this->tpl->setVariable("TXT_PASSWORD",$this->lng->txt("crs_access_password"));
                        $this->tpl->parseCurrentBlock();
                }

                $this->tpl->setVariable("TXT_CANCEL",$this->lng->txt("cancel"));

                if($really_submit)
                {
                        $this->tpl->setCurrentBlock("go");
                        $this->tpl->setVariable("CMD_SUBMIT","subscribe");
                        if ($this->course_obj->getSubscriptionType() == $this->course_obj->SUBSCRIPTION_CONFIRMATION)
                        {
                                $this->tpl->setVariable("TXT_SUBMIT",$this->lng->txt("request_membership"));
                        }
                        else
                        {
                                $this->tpl->setVariable("TXT_SUBMIT",$this->lng->txt("join"));
                        }
                        $this->tpl->parseCurrentBlock();
                }
                        

                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilCourseRegisterGUI::subscribe ( )

Definition at line 101 of file class.ilCourseRegisterGUI.php.

References $_POST, $ilErr, ilObjectFactory::getInstanceByObjId(), ilUtil::redirect(), sendInfo(), showRegistrationForm(), and ilObjUser::updateActiveRoles().

        {
                global $ilAccess,$ilErr;

                if(!$ilAccess->checkAccess("join","",$this->course_obj->getRefId(),'crs'))
                {
                        $ilErr->raiseError($this->lng->txt("msg_no_perm_read"),$ilErr->MESSAGE);
                }

                if($this->course_obj->getSubscriptionMaxMembers())
                {
                        $free = $this->course_obj->getSubscriptionMaxMembers() - 
                                $this->course_obj->members_obj->getCountMembers() - $this->course_obj->members_obj->getCountSubscribers();
                        $free = $free > 0 ? true : false;
                }
                if($this->course_obj->getSubscriptionMaxMembers() and
                   !$free and
                   !$this->course_obj->enabledWaitingList())
                {
                        $ilErr->raiseError($this->lng->txt("crs_reg_subscription_max_members_reached"),$ilErr->MESSAGE);
                }

                if($this->course_obj->getSubscriptionMaxMembers() and (!$free or $this->waiting_list->getCountUsers()))
                {
                        #if((($this->course_obj->getSubscriptionMaxMembers() <= $this->course_obj->members_obj->getCountMembers())
                        #       and $this->course_obj->getSubscriptionMaxMembers() != 0) or
                        #   $this->waiting_list->getCountUsers())
                        // First check password
                        if($this->course_obj->getSubscriptionType() == $this->course_obj->SUBSCRIPTION_PASSWORD)
                        {
                                if($this->course_obj->getSubscriptionPassword() != $_POST["password"])
                                {
                                        sendInfo($this->lng->txt("crs_password_not_valid"));
                                        $this->validation = false;
                                        $this->showRegistrationForm();

                                        return false;
                                }
                        }


                        include_once 'course/classes/class.ilCourseWaitingList.php';

                        if(!$this->waiting_list->isOnList($this->user_id))
                        {
                                $this->waiting_list->addToList($this->user_id);
                                
                                $info = sprintf($this->lng->txt('crs_added_to_list'),$this->waiting_list->getPosition($this->user_id));
                                sendInfo($info,true);

                                ilUtil::redirect('repository.php?ref_id='.$this->tree->getParentId($this->course_id));
                        }
                        else
                        {
                                sendInfo($this->lng->txt('crs_already_assigned_to_list'),true);
                                ilUtil::redirect('repository.php?ref_id='.$this->tree->getParentId($this->course_id));
                        }                               
                }

                if($this->course_obj->getSubscriptionLimitationType() == IL_CRS_SUBSCRIPTION_DEACTIVATED)
                {
                        $this->ilErr->raiseError($this->lng->txt("err_unknown_error"),$this->ilErr->MESSAGE);
                }

                switch($this->course_obj->getSubscriptionType())
                {
                        case $this->course_obj->SUBSCRIPTION_DIRECT:
                                
                                $tmp_obj =& ilObjectFactory::getInstanceByObjId($this->user_id);

                                if($this->course_obj->members_obj->add($tmp_obj,$this->course_obj->members_obj->ROLE_MEMBER))
                                {
                                        $this->course_obj->members_obj->sendNotification($this->course_obj->members_obj->NOTIFY_ADMINS,$this->user_id);
                                        ilObjUser::updateActiveRoles($this->user_id);
                                        sendInfo($this->lng->txt("crs_subscription_successful"),true);
                                        
                                        ilUtil::redirect('repository.php?ref_id='.$this->tree->getParentId($this->course_id));
                                }
                                else
                                {
                                        sendInfo("err_unknown_error");
                                        $this->showRegistrationForm();
                                }
                                break;

                        case $this->course_obj->SUBSCRIPTION_CONFIRMATION:

                                if($this->course_obj->members_obj->addSubscriber($this->user_id))
                                {
                                        $this->course_obj->members_obj->sendNotification($this->course_obj->members_obj->NOTIFY_SUBSCRIPTION_REQUEST,
                                                                                                                                         $this->user_id);
                                        sendInfo($this->lng->txt("crs_subscription_requested"),true);
                                        $this->ctrl->setParameterByClass("ilRepositoryGUI","ref_id",$this->tree->getParentId($this->course_id));

                                        ilUtil::redirect('repository.php?ref_id='.$this->tree->getParentId($this->course_id));
                                }
                                else
                                {
                                        sendInfo("err_unknown_error");
                                        $this->showRegistrationForm();
                                }
                                break;

                        case $this->course_obj->SUBSCRIPTION_PASSWORD:

                                $tmp_obj =& ilObjectFactory::getInstanceByObjId($this->user_id);

                                if($this->course_obj->getSubscriptionPassword() != $_POST["password"])
                                {
                                        sendInfo($this->lng->txt("crs_password_not_valid"),true);
                                        $this->showRegistrationForm();
                                }
                                else if($this->course_obj->members_obj->add($tmp_obj,$this->course_obj->members_obj->ROLE_MEMBER))
                                {
                                        $this->course_obj->members_obj->sendNotification($this->course_obj->members_obj->NOTIFY_ADMINS,$this->user_id);
                                        ilObjUser::updateActiveRoles($this->user_id);
                                        sendInfo($this->lng->txt("crs_subscription_successful"),true);

                                        ilUtil::redirect('repository.php?ref_id='.$this->tree->getParentId($this->course_id));
                                }
                                else
                                {
                                        sendInfo("err_unknown_error");
                                        $this->showRegistrationForm();
                                }
                                break;
                }
        }