ilGroupRegistrationGUI Class Reference

GUI class for group registrations. More...

Inheritance diagram for ilGroupRegistrationGUI:

Collaboration diagram for ilGroupRegistrationGUI:

Public Member Functions
	__construct ($a_container)
	Constructor. More...
	executeCommand ()
	Execute command. More...
Public Member Functions inherited from ilRegistrationGUI
	__construct ($a_container)
	Constructor. More...
	getContainer ()
	Parent object. More...
	getRefId ()
	Get ref. More...
	cancel ()
	cancel subscription More...
	show (ilPropertyFormGUI $form=null)
	show registration form More...
	join ()
	join More...

Protected Member Functions
	getFormTitle ()
	get form title More...
	fillInformations ()
	fill informations More...
	fillRegistrationPeriod ()
	show informations about the registration period More...
	fillMaxMembers ()
	fill max member informations More...
	fillRegistrationType ()
	fill registration procedure More...
	addCommandButtons ()
	Add group specific command buttons. More...
	validate ()
	validate join request More...
	add ()
	add user More...
	initParticipants ()
	Init course participants. More...
	initWaitingList ()
	isWaitingListActive ()
Protected Member Functions inherited from ilRegistrationGUI
	isRegistrationPossible ()
	check if registration is possible More...
	enableRegistration ($a_status)
	set registration disabled More...
	initParticipants ()
	Init participants object (course or group participants) More...
	initWaitingList ()
	Init waiting list (course or group waiting list) More...
	isWaitingListActive ()
	Check if the waiting list is active Maximum of members exceeded or any user on the waiting list. More...
	getWaitingList ()
	Get waiting list object. More...
	leaveWaitingList ()
	getFormTitle ()
	Get title for property form. More...
	fillInformations ()
	fill informations More...
	fillRegistrationPeriod ()
	show informations about the registration period More...
	fillMaxMembers ()
	show informations about the maximum number of user. More...
	fillRegistrationType ()
	show informations about registration procedure More...
	fillMembershipLimitation ()
	Show membership limitations. More...
	fillAgreement ()
	Show user agreement. More...
	showCustomFields ()
	Show course defined fields. More...
	validateAgreement ()
	Check Agreement. More...
	validateCustomFields ()
	Check required course fields. More...
	setAccepted ($a_status)
	Set Agreement accepted. More...
	validate ()
	validate join request More...
	initForm ()
	init registration form More...
	addCommandButtons ()
	Add command buttons. More...
	updateSubscriptionRequest ()
	Update subscription message. More...
	cancelSubscriptionRequest ()

Additional Inherited Members
Protected Attributes inherited from ilRegistrationGUI
	$privacy = null
	$container = null
	$ref_id
	$obj_id
	$participants
	$waiting_list = null
	$form
	$registration_possible = true
	$join_error = ''
	$tpl
	$lng
	$ctrl

Detailed Description

GUI class for group registrations.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilGroupRegistrationGUI::__construct

(

$a_container

)

Constructor.

@access public

Parameters

object

container object

Reimplemented from ilRegistrationGUI.

Definition at line 44 of file class.ilGroupRegistrationGUI.php.

    {
        parent::__construct($a_container);
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

add()

ilGroupRegistrationGUI::add ( )

protected

add user

@access protected

Parameters

return

Definition at line 437 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        $tree = $DIC['tree'];
        $rbacreview = $DIC['rbacreview'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        
        // set aggreement accepted
        $this->setAccepted(true);
        
        include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
        $free = max(0, $this->container->getMaxMembers() - $this->participants->getCountMembers());
        $waiting_list = new ilGroupWaitingList($this->container->getId());
        if (
                $this->container->isMembershipLimited() and
                $this->container->isWaitingListEnabled() and
                (!$free or $waiting_list->getCountUsers())) {
            $waiting_list->addToList($ilUser->getId());
            $info = sprintf(
                $this->lng->txt('grp_added_to_list'),
                $this->container->getTitle(),
                $waiting_list->getPosition($ilUser->getId())
            );
                
            $this->participants->sendNotification(
                ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER,
                $ilUser->getId()
            );
            ilUtil::sendSuccess($info, true);
            $ilCtrl->setParameterByClass(
                "ilrepositorygui",
                "ref_id",
                $tree->getParentId($this->container->getRefId())
            );
            $ilCtrl->redirectByClass("ilrepositorygui", "");
        }
                
 
        switch ($this->container->getRegistrationType()) {
            case GRP_REGISTRATION_REQUEST:
                
                $this->participants->addSubscriber($ilUser->getId());
                $this->participants->updateSubscriptionTime($ilUser->getId(), time());
                $this->participants->updateSubject($ilUser->getId(), ilUtil::stripSlashes($_POST['subject']));
                
                $this->participants->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST,
                    $ilUser->getId()
                );
 
                ilUtil::sendSuccess($this->lng->txt("application_completed"), true);
                $ilCtrl->setParameterByClass(
                    "ilrepositorygui",
                    "ref_id",
                    $tree->getParentId($this->container->getRefId())
                );
                $ilCtrl->redirectByClass("ilrepositorygui", "");
                break;
            
            default:
                
                $this->participants->add($ilUser->getId(), IL_GRP_MEMBER);
                $this->participants->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION,
                    $ilUser->getId()
                );
                $this->participants->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER,
                    $ilUser->getId()
                );
 
                include_once './Modules/Forum/classes/class.ilForumNotification.php';
                ilForumNotification::checkForumsExistsInsert($this->container->getRefId(), $ilUser->getId());
                    
                if (!$_SESSION["pending_goto"]) {
                    ilUtil::sendSuccess($this->lng->txt("grp_registration_completed"), true);
                    $this->ctrl->returnToParent($this);
                } else {
                    $tgt = $_SESSION["pending_goto"];
                    unset($_SESSION["pending_goto"]);
                    ilUtil::redirect($tgt);
                }
                break;
        }
    }

References $_POST, $_SESSION, $DIC, $ilCtrl, $ilUser, ilRegistrationGUI\$lng, ilRegistrationGUI\$waiting_list, ilForumNotification\checkForumsExistsInsert(), GRP_REGISTRATION_REQUEST, IL_GRP_MEMBER, ilUtil\redirect(), ilRegistrationGUI\setAccepted(), ilUtil\stripSlashes(), ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST, ilGroupMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER, and ilGroupMembershipMailNotification\TYPE_WAITING_LIST_MEMBER.

Here is the call graph for this function:

addCommandButtons()

ilGroupRegistrationGUI::addCommandButtons ( )

protected

Add group specific command buttons.

Returns

Reimplemented from ilRegistrationGUI.

Definition at line 358 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        parent::addCommandButtons();
        
 
        switch ($this->container->getRegistrationType()) {
            case GRP_REGISTRATION_REQUEST:
                if ($this->participants->isSubscriber($ilUser->getId())) {
                    $this->form->clearCommandButtons();
                    $this->form->addCommandButton('updateSubscriptionRequest', $this->lng->txt('grp_update_subscr_request'));
                    $this->form->addCommandButton('cancelSubscriptionRequest', $this->lng->txt('grp_cancel_subscr_request'));
                } else {
                    if (!$this->isRegistrationPossible()) {
                        return false;
                    }
                    $this->form->clearCommandButtons();
                    $this->form->addCommandButton('join', $this->lng->txt('grp_join_request'));
                    $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
                }
                break;
        }
        return true;
    }

References $DIC, $ilUser, GRP_REGISTRATION_REQUEST, and ilRegistrationGUI\isRegistrationPossible().

Here is the call graph for this function:

executeCommand()

ilGroupRegistrationGUI::executeCommand

(

)

Execute command.

@access public

Definition at line 54 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        $ilTabs = $DIC['ilTabs'];
        
        $next_class = $this->ctrl->getNextClass($this);
        
        if ($this->getWaitingList()->isOnList($ilUser->getId())) {
            $ilTabs->activateTab('leave');
        }
 
        switch ($next_class) {
            default:
                $cmd = $this->ctrl->getCmd("show");
                $this->$cmd();
                break;
        }
        return true;
    }

References $DIC, $ilUser, and ilRegistrationGUI\getWaitingList().

Here is the call graph for this function:

fillInformations()

ilGroupRegistrationGUI::fillInformations ( )

protected

fill informations

@access protected

Parameters

return

Reimplemented from ilRegistrationGUI.

Definition at line 102 of file class.ilGroupRegistrationGUI.php.

    {
        if ($this->container->getInformation()) {
            $imp = new ilNonEditableValueGUI($this->lng->txt('crs_important_info'), '', true);
            $value = nl2br(ilUtil::makeClickable($this->container->getInformation(), true));
            $imp->setValue($value);
            $this->form->addItem($imp);
        }
    }

References ilUtil\makeClickable().

Here is the call graph for this function:

fillMaxMembers()

ilGroupRegistrationGUI::fillMaxMembers ( )

protected

fill max member informations

@access protected

Returns

Reimplemented from ilRegistrationGUI.

Definition at line 175 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        if (!$this->container->isMembershipLimited()) {
            return true;
        }
        
        $tpl = new ilTemplate('tpl.max_members_form.html', true, true, 'Services/Membership');
 
        if ($this->container->getMinMembers()) {
            $tpl->setVariable('TXT_MIN', $this->lng->txt('mem_min_users'));
            $tpl->setVariable('NUM_MIN', $this->container->getMinMembers());
        }
        
        if ($this->container->getMaxMembers()) {
            $tpl->setVariable('TXT_MAX', $this->lng->txt('mem_max_users'));
            $tpl->setVariable('NUM_MAX', $this->container->getMaxMembers());
 
            include_once './Modules/Group/classes/class.ilObjGroupAccess.php';
            $reg_info = ilObjGroupAccess::lookupRegistrationInfo($this->getContainer()->getId());
            $free = $reg_info['reg_info_free_places'];
 
 
            if ($free) {
                $tpl->setVariable('NUM_FREE', $free);
            } else {
                $tpl->setVariable('WARN_FREE', $free);
            }
 
            include_once('./Modules/Group/classes/class.ilGroupWaitingList.php');
            $waiting_list = new ilGroupWaitingList($this->container->getId());
 
            if (
                    $this->container->isWaitingListEnabled() and
                    $this->container->isMembershipLimited() and
                    (!$free or $waiting_list->getCountUsers())) {
                if ($waiting_list->isOnList($ilUser->getId())) {
                    $tpl->setVariable('TXT_WAIT', $this->lng->txt('mem_waiting_list_position'));
                    $tpl->setVariable('NUM_WAIT', $waiting_list->getPosition($ilUser->getId()));
                } else {
                    $tpl->setVariable('TXT_WAIT', $this->lng->txt('mem_waiting_list'));
                    if ($free and $waiting_list->getCountUsers()) {
                        $tpl->setVariable('WARN_WAIT', $waiting_list->getCountUsers());
                    } else {
                        $tpl->setVariable('NUM_WAIT', $waiting_list->getCountUsers());
                    }
                }
            }
 
            $alert = '';
            if (
                    !$free and
                    !$this->container->isWaitingListEnabled()) {
                // Disable registration
                $this->enableRegistration(false);
                $alert = $this->lng->txt('mem_alert_no_places');
            } elseif (
                    $this->container->isWaitingListEnabled() and
                    $this->container->isMembershipLimited() and
                    $waiting_list->isOnList($ilUser->getId())) {
                // Disable registration
                $this->enableRegistration(false);
            } elseif (
                    !$free and
                    $this->container->isWaitingListEnabled() and
                    $this->container->isMembershipLimited()) {
                $alert = $this->lng->txt('grp_warn_no_max_set_on_waiting_list');
            } elseif (
                    $free and
                    $this->container->isWaitingListEnabled() and
                    $this->container->isMembershipLimited() and
                    $this->getWaitingList()->getCountUsers()) {
                $alert = $this->lng->txt('grp_warn_wl_set_on_waiting_list');
            }
        }
        
        $max = new ilCustomInputGUI($this->lng->txt('mem_participants'));
        $max->setHtml($tpl->get());
        if (strlen($alert)) {
            #$max->setAlert($alert);
            ilUtil::sendFailure($alert);
        }
        $this->form->addItem($max);
    }

References $DIC, $ilUser, ilRegistrationGUI\$tpl, ilRegistrationGUI\$waiting_list, ilRegistrationGUI\enableRegistration(), ilRegistrationGUI\getContainer(), ilObjGroupAccess\lookupRegistrationInfo(), and ilUtil\sendFailure().

Here is the call graph for this function:

fillRegistrationPeriod()

ilGroupRegistrationGUI::fillRegistrationPeriod ( )

protected

show informations about the registration period

@access protected

Reimplemented from ilRegistrationGUI.

Definition at line 117 of file class.ilGroupRegistrationGUI.php.

    {
        include_once('./Services/Calendar/classes/class.ilDateTime.php');
        $now = new ilDateTime(time(), IL_CAL_UNIX, 'UTC');
 
        if ($this->container->isRegistrationUnlimited()) {
            $reg = new ilNonEditableValueGUI($this->lng->txt('mem_reg_period'));
            $reg->setValue($this->lng->txt('mem_unlimited'));
            $this->form->addItem($reg);
            return true;
        }
        
        $start = $this->container->getRegistrationStart();
        $end = $this->container->getRegistrationEnd();
        
        
        if (ilDateTime::_before($now, $start)) {
            $tpl = new ilTemplate('tpl.registration_period_form.html', true, true, 'Services/Membership');
            $tpl->setVariable('TXT_FIRST', $this->lng->txt('mem_start'));
            $tpl->setVariable('FIRST', ilDatePresentation::formatDate($start));
            
            $tpl->setVariable('TXT_END', $this->lng->txt('mem_end'));
            $tpl->setVariable('END', ilDatePresentation::formatDate($end));
            
            $warning = $this->lng->txt('mem_reg_not_started');
        } elseif (ilDateTime::_after($now, $end)) {
            $tpl = new ilTemplate('tpl.registration_period_form.html', true, true, 'Services/Membership');
            $tpl->setVariable('TXT_FIRST', $this->lng->txt('mem_start'));
            $tpl->setVariable('FIRST', ilDatePresentation::formatDate($start));
            
            $tpl->setVariable('TXT_END', $this->lng->txt('mem_end'));
            $tpl->setVariable('END', ilDatePresentation::formatDate($end));
            
            $warning = $this->lng->txt('mem_reg_expired');
        } else {
            $tpl = new ilTemplate('tpl.registration_period_form.html', true, true, 'Services/Membership');
            $tpl->setVariable('TXT_FIRST', $this->lng->txt('mem_end'));
            $tpl->setVariable('FIRST', ilDatePresentation::formatDate($end));
        }
        
        $reg = new ilCustomInputGUI($this->lng->txt('mem_reg_period'));
        $reg->setHtml($tpl->get());
        if (strlen($warning)) {
            // Disable registration
            $this->enableRegistration(false);
            #$reg->setAlert($warning);
            ilUtil::sendFailure($warning);
        }
        $this->form->addItem($reg);
        return true;
    }

References ilRegistrationGUI\$tpl, ilDateTime\_after(), ilDateTime\_before(), ilRegistrationGUI\enableRegistration(), ilDatePresentation\formatDate(), IL_CAL_UNIX, and ilUtil\sendFailure().

Here is the call graph for this function:

fillRegistrationType()

ilGroupRegistrationGUI::fillRegistrationType ( )

protected

fill registration procedure

@access protected

Parameters

return

Reimplemented from ilRegistrationGUI.

Definition at line 270 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        if ($this->getWaitingList()->isOnList($ilUser->getId())) {
            return true;
        }
        
        switch ($this->container->getRegistrationType()) {
            case GRP_REGISTRATION_DEACTIVATED:
                $reg = new ilNonEditableValueGUI($this->lng->txt('mem_reg_type'));
                $reg->setValue($this->lng->txt('grp_reg_disabled'));
                #$reg->setAlert($this->lng->txt('grp_reg_deactivated_alert'));
                $this->form->addItem($reg);
        
                // Disable registration
                $this->enableRegistration(false);
                
                break;
                
            case GRP_REGISTRATION_PASSWORD:
                $txt = new ilNonEditableValueGUI($this->lng->txt('mem_reg_type'));
                $txt->setValue($this->lng->txt('grp_pass_request'));
                    
 
                $pass = new ilTextInputGUI($this->lng->txt('passwd'), 'grp_passw');
                $pass->setInputType('password');
                $pass->setSize(12);
                $pass->setMaxLength(32);
                #$pass->setRequired(true);
                $pass->setInfo($this->lng->txt('group_password_registration_msg'));
                
                $txt->addSubItem($pass);
                $this->form->addItem($txt);
                break;
                
            case GRP_REGISTRATION_REQUEST:
                
                // no "request" info if waiting list is active
                if ($this->isWaitingListActive()) {
                    return true;
                }
                    
                $txt = new ilNonEditableValueGUI($this->lng->txt('mem_reg_type'));
                $txt->setValue($this->lng->txt('grp_reg_request'));
            
                $sub = new ilTextAreaInputGUI($this->lng->txt('grp_reg_subject'), 'subject');
                $sub->setValue($_POST['subject']);
                $sub->setInfo($this->lng->txt('group_req_registration_msg'));
                $sub->setCols(40);
                $sub->setRows(5);
                if ($this->participants->isSubscriber($ilUser->getId())) {
                    $sub_data = $this->participants->getSubscriberData($ilUser->getId());
                    $sub->setValue($sub_data['subject']);
                    $sub->setInfo('');
                    ilUtil::sendFailure($this->lng->txt('grp_already_assigned'));
                    $this->enableRegistration(false);
                }
                $txt->addSubItem($sub);
                $this->form->addItem($txt);
                break;
                
            case GRP_REGISTRATION_DIRECT:
 
                // no "direct registration" info if waiting list is active
                if ($this->isWaitingListActive()) {
                    return true;
                }
 
                $txt = new ilNonEditableValueGUI($this->lng->txt('mem_reg_type'));
                $txt->setValue($this->lng->txt('group_req_direct'));
                
                $this->form->addItem($txt);
                break;
 
            default:
                return true;
        }
        
        return true;
    }

References $_POST, $DIC, $ilUser, $pass, $txt, ilRegistrationGUI\enableRegistration(), ilRegistrationGUI\getWaitingList(), GRP_REGISTRATION_DEACTIVATED, GRP_REGISTRATION_DIRECT, GRP_REGISTRATION_PASSWORD, GRP_REGISTRATION_REQUEST, isWaitingListActive(), and ilUtil\sendFailure().

Here is the call graph for this function:

getFormTitle()

ilGroupRegistrationGUI::getFormTitle ( )

protected

get form title

@access protected

Returns

string title

Reimplemented from ilRegistrationGUI.

Definition at line 83 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        
        if ($this->getWaitingList()->isOnList($ilUser->getId())) {
            return $this->lng->txt('member_status');
        }
        return $this->lng->txt('grp_registration');
    }

References $DIC, $ilUser, and ilRegistrationGUI\getWaitingList().

Here is the call graph for this function:

initParticipants()

ilGroupRegistrationGUI::initParticipants ( )

protected

Init course participants.

@access protected

Reimplemented from ilRegistrationGUI.

Definition at line 532 of file class.ilGroupRegistrationGUI.php.

    {
        include_once('./Modules/Group/classes/class.ilGroupParticipants.php');
        $this->participants = ilGroupParticipants::_getInstanceByObjId($this->obj_id);
    }

References ilGroupParticipants\_getInstanceByObjId().

Here is the call graph for this function:

initWaitingList()

ilGroupRegistrationGUI::initWaitingList ( )

protected

See also

ilRegistrationGUI::initWaitingList() @access protected

Reimplemented from ilRegistrationGUI.

Definition at line 542 of file class.ilGroupRegistrationGUI.php.

    {
        include_once './Modules/Group/classes/class.ilGroupWaitingList.php';
        $this->waiting_list = new ilGroupWaitingList($this->container->getId());
    }

isWaitingListActive()

ilGroupRegistrationGUI::isWaitingListActive ( )

protected

See also

ilRegistrationGUI::isWaitingListActive()

Reimplemented from ilRegistrationGUI.

Definition at line 551 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        static $active = null;
        
        if ($active !== null) {
            return $active;
        }
        if (!$this->container->getMaxMembers()) {
            return $active = false;
        }
        if (
                !$this->container->isWaitingListEnabled() or
                !$this->container->isMembershipLimited()) {
            return $active = false;
        }
 
        $free = max(0, $this->container->getMaxMembers() - $this->participants->getCountMembers());
        return $active = (!$free or $this->getWaitingList()->getCountUsers());
    }

References $DIC, $ilUser, and ilRegistrationGUI\getWaitingList().

Referenced by fillRegistrationType().

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

ilGroupRegistrationGUI::validate ( )

protected

validate join request

@access protected

Returns

Reimplemented from ilRegistrationGUI.

Definition at line 393 of file class.ilGroupRegistrationGUI.php.

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
    
        if ($ilUser->getId() == ANONYMOUS_USER_ID) {
            $this->join_error = $this->lng->txt('permission_denied');
            return false;
        }
        
        if (!$this->isRegistrationPossible()) {
            $this->join_error = $this->lng->txt('mem_error_preconditions');
            return false;
        }
        if ($this->container->getRegistrationType() == GRP_REGISTRATION_PASSWORD) {
            if (!strlen($pass = ilUtil::stripSlashes($_POST['grp_passw']))) {
                $this->join_error = $this->lng->txt('err_wrong_password');
                return false;
            }
            if (strcmp($pass, $this->container->getPassword()) !== 0) {
                $this->join_error = $this->lng->txt('err_wrong_password');
                return false;
            }
        }
        if (!$this->validateCustomFields()) {
            $this->join_error = $this->lng->txt('fill_out_all_required_fields');
            return false;
        }
        if (!$this->validateAgreement()) {
            $this->join_error = $this->lng->txt($this->type . '_agreement_required');
            return false;
        }
        
        return true;
    }

References $_POST, $DIC, $ilUser, $pass, GRP_REGISTRATION_PASSWORD, ilRegistrationGUI\isRegistrationPossible(), ilUtil\stripSlashes(), ilRegistrationGUI\validateAgreement(), and ilRegistrationGUI\validateCustomFields().

Here is the call graph for this function:

---

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

• Modules/Group/classes/class.ilGroupRegistrationGUI.php