ilGroupRegistrationGUI Class Reference

GUI class for group registrations. More...

Inheritance diagram for ilGroupRegistrationGUI:

Collaboration diagram for ilGroupRegistrationGUI:

Public Member Functions
	__construct (ilObject $a_container)
	executeCommand ()
Public Member Functions inherited from ilRegistrationGUI
	__construct (ilObject $a_container)
	getContainer ()
	getRefId ()
	cancel ()
	cancel subscription More...
	show (?ilPropertyFormGUI $form=null)
	join ()

Protected Member Functions
	getFormTitle ()
	fillInformations ()
	fillRegistrationPeriod ()
	show information about the registration period More...
	fillMaxMembers ()
	fill max member information protected More...
	fillRegistrationType ()
	addCommandButtons ()
	Add group specific command buttons. More...
	validate ()
	validate join request protected More...
	add ()
	add user More...
	initParticipants ()
	Init course participants. More...
	initWaitingList ()
	isWaitingListActive ()
Protected Member Functions inherited from ilRegistrationGUI
	isRegistrationPossible ()
	enableRegistration (bool $a_status)
	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 ()
	showCustomFields ()
	validateAgreement ()
	validateCustomFields ()
	setAccepted (bool $a_status)
	validate ()
	initForm ()
	addCommandButtons ()
	updateSubscriptionRequest ()
	cancelSubscriptionRequest ()

Additional Inherited Members
Protected Attributes inherited from ilRegistrationGUI
int	$ref_id
int	$obj_id
string	$type
string	$join_error = ''
bool	$registration_possible = true
ILIAS HTTP GlobalHttpState	$http
ILIAS Refinery Factory	$refinery
ilPrivacySettings	$privacy
ilObject	$container
ilParticipants	$participants
ilWaitingList	$waiting_list
ilPropertyFormGUI	$form = null
ilObjUser	$user
ilTabsGUI	$tabs
ilTree	$tree
ilRbacReview	$rbacreview
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilAccessHandler	$access

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 35 of file class.ilGroupRegistrationGUI.php.

Constructor & Destructor Documentation

__construct()

ilGroupRegistrationGUI::__construct

(

ilObject

$a_container

)

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

References ILIAS\MetaData\Repository\Validation\Data\__construct().

    {
        parent::__construct($a_container);
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilGroupRegistrationGUI::add ( )

protected

add user

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

References ilRegistrationGUI\$waiting_list, ilGroupWaitingList\addToList(), ilForumNotification\checkForumsExistsInsert(), ilSession\clear(), ILIAS\Repository\ctrl(), ilSession\get(), ilGroupConstants\GRP_REGISTRATION_REQUEST, ILIAS\FileDelivery\http(), ilParticipants\IL_GRP_MEMBER, ILIAS\Repository\lng(), ilUtil\redirect(), ILIAS\Repository\refinery(), ilRegistrationGUI\setAccepted(), ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION, ilGroupMembershipMailNotification\TYPE_NOTIFICATION_REGISTRATION_REQUEST, ilGroupMembershipMailNotification\TYPE_SUBSCRIBE_MEMBER, ilGroupMembershipMailNotification\TYPE_WAITING_LIST_MEMBER, and ILIAS\Repository\user().

                            : void
    {
        // set agreement accepted
        $this->setAccepted(true);

        $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($this->user->getId());
            $info = sprintf(
                $this->lng->txt('grp_added_to_list'),
                $this->container->getTitle(),
                $waiting_list->getPosition($this->user->getId())
            );

            $this->participants->sendNotification(
                ilGroupMembershipMailNotification::TYPE_WAITING_LIST_MEMBER,
                $this->user->getId()
            );
            $this->tpl->setOnScreenMessage('success', $info, true);
            $this->ctrl->setParameterByClass(
                "ilrepositorygui",
                "ref_id",
                $this->tree->getParentId($this->container->getRefId())
            );
            $this->ctrl->redirectByClass("ilrepositorygui", "");
        }

        switch ($this->container->getRegistrationType()) {
            case ilGroupConstants::GRP_REGISTRATION_REQUEST:

                $this->participants->addSubscriber($this->user->getId());
                $this->participants->updateSubscriptionTime($this->user->getId(), time());
                $subject = '';
                if ($this->http->wrapper()->post()->has('subject')) {
                    $subject = $this->http->wrapper()->post()->retrieve(
                        'subject',
                        $this->refinery->kindlyTo()->string()
                    );
                }
                $this->participants->updateSubject($this->user->getId(), $subject);
                $this->participants->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION_REQUEST,
                    $this->user->getId()
                );

                $this->tpl->setOnScreenMessage('success', $this->lng->txt("application_completed"), true);
                $this->ctrl->setParameterByClass(
                    "ilrepositorygui",
                    "ref_id",
                    $this->tree->getParentId($this->container->getRefId())
                );
                $this->ctrl->redirectByClass("ilrepositorygui", "");
                break;

            default:

                $this->participants->add($this->user->getId(), ilParticipants::IL_GRP_MEMBER);
                $this->participants->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_NOTIFICATION_REGISTRATION,
                    $this->user->getId()
                );
                $this->participants->sendNotification(
                    ilGroupMembershipMailNotification::TYPE_SUBSCRIBE_MEMBER,
                    $this->user->getId()
                );

                ilForumNotification::checkForumsExistsInsert($this->container->getRefId(), $this->user->getId());

                $pending_goto = ilSession::get('pending_goto');
                if (!$pending_goto) {
                    $this->tpl->setOnScreenMessage('success', $this->lng->txt("grp_registration_completed"), true);
                    $this->ctrl->returnToParent($this);
                } else {
                    $tgt = $pending_goto;
                    ilSession::clear('pending_goto');
                    ilUtil::redirect($tgt);
                }
                break;
        }
    }

Here is the call graph for this function:

addCommandButtons()

ilGroupRegistrationGUI::addCommandButtons ( )

protected

Add group specific command buttons.

Returns

void

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

References ILIAS\Repository\form(), ilGroupConstants\GRP_REGISTRATION_REQUEST, ilRegistrationGUI\isRegistrationPossible(), and ILIAS\Repository\lng().

                                          : void
    {
        parent::addCommandButtons();
        switch ($this->container->getRegistrationType()) {
            case ilGroupConstants::GRP_REGISTRATION_REQUEST:
                if ($this->participants->isSubscriber($this->user->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;
                    }
                    $this->form->clearCommandButtons();
                    $this->form->addCommandButton('join', $this->lng->txt('grp_join_request'));
                    $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
                }
                break;
        }
    }

Here is the call graph for this function:

executeCommand()

ilGroupRegistrationGUI::executeCommand

(

)

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilRegistrationGUI\getWaitingList(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);

        if (!$this->access->checkAccess('join', '', $this->getRefId())) {
            $this->ctrl->redirectByClass(ilObjGroupGUI::class, 'infoScreen');
        }

        if ($this->getWaitingList()->isOnList($this->user->getId())) {
            $this->tabs->activateTab('leave');
        }

        switch ($next_class) {
            default:
                $cmd = $this->ctrl->getCmd("show");
                $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

fillInformations()

ilGroupRegistrationGUI::fillInformations ( )

protected

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

References ILIAS\Repository\form(), ILIAS\Repository\lng(), and ilUtil\makeClickable().

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

Here is the call graph for this function:

fillMaxMembers()

ilGroupRegistrationGUI::fillMaxMembers ( )

protected

fill max member information protected

Returns

void

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

References ilRegistrationGUI\$tpl, ilRegistrationGUI\$waiting_list, ilRegistrationGUI\enableRegistration(), ILIAS\Repository\form(), ilGlobalTemplateInterface\get(), ilRegistrationGUI\getContainer(), ilWaitingList\getCountUsers(), ILIAS\Survey\Mode\getId(), ilWaitingList\getPosition(), ilRegistrationGUI\getWaitingList(), ilWaitingList\isOnList(), ILIAS\Repository\lng(), ilObjGroupAccess\lookupRegistrationInfo(), ilGlobalTemplateInterface\setVariable(), and ILIAS\Repository\user().

                                       : void
    {
        $alert = '';
        if (!$this->container->isMembershipLimited()) {
            return;
        }

        $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());
            $tpl->setVariable('TXT_FREE', $this->lng->txt('mem_free_places') . ":");

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

            $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($this->user->getId())) {
                    $tpl->setVariable('TXT_WAIT', $this->lng->txt('mem_waiting_list_position'));
                    $tpl->setVariable('NUM_WAIT', $waiting_list->getPosition($this->user->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());
                    }
                }
            }

            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($this->user->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);
            $this->tpl->setOnScreenMessage('failure', $alert);
        }
        $this->form->addItem($max);
    }

Here is the call graph for this function:

fillRegistrationPeriod()

ilGroupRegistrationGUI::fillRegistrationPeriod ( )

protected

show information about the registration period

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

References ilRegistrationGUI\$tpl, ilDateTime\_after(), ilDateTime\_before(), ilRegistrationGUI\enableRegistration(), ILIAS\Repository\form(), ilDatePresentation\formatDate(), ilGlobalTemplateInterface\get(), IL_CAL_UNIX, ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().

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

        $start = $this->container->getRegistrationStart();
        $end = $this->container->getRegistrationEnd();

        $warning = '';
        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);
            $this->tpl->setOnScreenMessage('failure', $warning);
        }
        $this->form->addItem($reg);
    }

Here is the call graph for this function:

fillRegistrationType()

ilGroupRegistrationGUI::fillRegistrationType ( )

protected

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

References $txt, ilRegistrationGUI\enableRegistration(), ILIAS\Repository\form(), ilRegistrationGUI\getWaitingList(), ilGroupConstants\GRP_REGISTRATION_DEACTIVATED, ilGroupConstants\GRP_REGISTRATION_DIRECT, ilGroupConstants\GRP_REGISTRATION_PASSWORD, ilGroupConstants\GRP_REGISTRATION_REQUEST, ILIAS\FileDelivery\http(), isWaitingListActive(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

                                             : void
    {
        if ($this->getWaitingList()->isOnList($this->user->getId())) {
            return;
        }

        switch ($this->container->getRegistrationType()) {
            case ilGroupConstants::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 ilGroupConstants::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 ilGroupConstants::GRP_REGISTRATION_REQUEST:

                // no "request" info if waiting list is active
                if ($this->isWaitingListActive()) {
                    return;
                }

                $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');
                $subject = '';
                if ($this->http->wrapper()->post()->has('subject')) {
                    $subject = $this->http->wrapper()->post()->retrieve(
                        'subject',
                        $this->refinery->kindlyTo()->string()
                    );
                }
                $sub->setValue($subject);
                $sub->setInfo($this->lng->txt('group_req_registration_msg'));
                $sub->setCols(40);
                $sub->setRows(5);
                if ($this->participants->isSubscriber($this->user->getId())) {
                    $sub_data = $this->participants->getSubscriberData($this->user->getId());
                    $sub->setValue($sub_data['subject']);
                    $sub->setInfo('');
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt('grp_already_assigned'));
                    $this->enableRegistration(false);
                }
                $txt->addSubItem($sub);
                $this->form->addItem($txt);
                break;

            case ilGroupConstants::GRP_REGISTRATION_DIRECT:

                // no "direct registration" info if waiting list is active
                if ($this->isWaitingListActive()) {
                    return;
                }

                $txt = new ilNonEditableValueGUI($this->lng->txt('mem_reg_type'));
                $txt->setValue($this->lng->txt('group_req_direct'));

                $this->form->addItem($txt);
                break;
        }
    }

Here is the call graph for this function:

getFormTitle()

ilGroupRegistrationGUI::getFormTitle ( )

protected

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

References ilRegistrationGUI\getWaitingList(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                     : string
    {
        if ($this->getWaitingList()->isOnList($this->user->getId())) {
            return $this->lng->txt('member_status');
        }
        return $this->lng->txt('grp_registration');
    }

Here is the call graph for this function:

initParticipants()

ilGroupRegistrationGUI::initParticipants ( )

protected

Init course participants.

protected

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

References ilRegistrationGUI\$participants, and ilGroupParticipants\_getInstanceByObjId().

                                         : ilParticipants
    {
        $this->participants = ilGroupParticipants::_getInstanceByObjId($this->obj_id);
        return $this->participants;
    }

Here is the call graph for this function:

initWaitingList()

ilGroupRegistrationGUI::initWaitingList ( )

protected

See also

ilRegistrationGUI::initWaitingList() protected

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

References ilRegistrationGUI\$waiting_list.

                                        : ilWaitingList
    {
        $this->waiting_list = new ilGroupWaitingList($this->container->getId());
        return $this->waiting_list;
    }

isWaitingListActive()

ilGroupRegistrationGUI::isWaitingListActive ( )

protected

See also

ilRegistrationGUI::isWaitingListActive()

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

References ilRegistrationGUI\getWaitingList().

Referenced by fillRegistrationType().

                                            : bool
    {
        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());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validate()

ilGroupRegistrationGUI::validate ( )

protected

validate join request protected

Returns

bool

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

References ANONYMOUS_USER_ID, ilGroupConstants\GRP_REGISTRATION_PASSWORD, ILIAS\FileDelivery\http(), ilRegistrationGUI\isRegistrationPossible(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\user(), ilRegistrationGUI\validateAgreement(), and ilRegistrationGUI\validateCustomFields().

                                 : bool
    {
        if ($this->user->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() == ilGroupConstants::GRP_REGISTRATION_PASSWORD) {
            $password = '';
            if ($this->http->wrapper()->post()->has('grp_passw')) {
                $password = $this->http->wrapper()->post()->retrieve(
                    'grp_passw',
                    $this->refinery->kindlyTo()->string()
                );
            }
            if (!strlen($password)) {
                $this->join_error = $this->lng->txt('err_wrong_password');
                return false;
            }
            if (strcmp($password, $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;
    }

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