ilRegistrationGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilRegistrationGUI:

Collaboration diagram for ilRegistrationGUI:

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

Protected Member Functions
	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 ()

Protected Attributes
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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Base class for Course and Group registration

Author

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

Definition at line 26 of file class.ilRegistrationGUI.php.

Constructor & Destructor Documentation

__construct()

ilRegistrationGUI::__construct

(

ilObject

$a_container

)

Definition at line 49 of file class.ilRegistrationGUI.php.

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilPrivacySettings\getInstance(), ilObject\getRefId(), ILIAS\FileDelivery\http(), initParticipants(), initWaitingList(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->tabs = $DIC->tabs();
        $this->tree = $DIC->repositoryTree();
        $this->rbacreview = $DIC->rbac()->review();

        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('crs');
        $this->lng->loadLanguageModule('grp');
        $this->lng->loadLanguageModule('ps');
        $this->lng->loadLanguageModule('membership');

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->access = $DIC->access();

        $this->container = $a_container;
        $this->ref_id = $this->container->getRefId();
        $this->obj_id = ilObject::_lookupObjId($this->ref_id);
        $this->type = ilObject::_lookupType($this->obj_id);

        $this->initParticipants();
        $this->initWaitingList();

        $this->privacy = ilPrivacySettings::getInstance();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
    }

Here is the call graph for this function:

Member Function Documentation

addCommandButtons()

ilRegistrationGUI::addCommandButtons ( )

protected

Todo:

get rid of $this->form

Definition at line 457 of file class.ilRegistrationGUI.php.

References ILIAS\Repository\form(), getWaitingList(), isRegistrationPossible(), isWaitingListActive(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Referenced by initForm().

                                          : void
    {
        if (
            $this->isRegistrationPossible() &&
            $this->isWaitingListActive() &&
            !$this->getWaitingList()->isOnList($this->user->getId())
        ) {
            $this->form->addCommandButton('join', $this->lng->txt('mem_add_to_wl'));
            $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
        } elseif ($this->isRegistrationPossible() && !$this->getWaitingList()->isOnList($this->user->getId())) {
            $this->form->addCommandButton('join', $this->lng->txt('join'));
            $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
        }
        if ($this->getWaitingList()->isOnList($this->user->getId())) {
            $this->tpl->setOnScreenMessage('question', sprintf(
                $this->lng->txt($this->container->getType() . '_cancel_waiting_list'),
                $this->container->getTitle()
            ));
            $this->form->addCommandButton('leaveWaitingList', $this->lng->txt('leave_waiting_list'));
            $this->form->addCommandButton('cancel', $this->lng->txt('cancel'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancel()

ilRegistrationGUI::cancel

(

)

cancel subscription

Definition at line 380 of file class.ilRegistrationGUI.php.

References ILIAS\Repository\ctrl().

                            : void
    {
        $this->ctrl->setParameterByClass(
            "ilrepositorygui",
            "ref_id",
            $this->tree->getParentId($this->container->getRefId())
        );
        $this->ctrl->redirectByClass("ilrepositorygui", "");
    }

Here is the call graph for this function:

cancelSubscriptionRequest()

ilRegistrationGUI::cancelSubscriptionRequest ( )

protected

Definition at line 500 of file class.ilRegistrationGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                                  : void
    {
        $this->participants->deleteSubscriber($this->user->getId());
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('sub_request_deleted'), true);

        $this->ctrl->setParameterByClass(
            "ilrepositorygui",
            "ref_id",
            $this->tree->getParentId($this->container->getRefId())
        );
        $this->ctrl->redirectByClass("ilrepositorygui", "");
    }

Here is the call graph for this function:

enableRegistration()

ilRegistrationGUI::enableRegistration ( bool  $a_status )

protected

Definition at line 96 of file class.ilRegistrationGUI.php.

References initParticipants(), initWaitingList(), and isWaitingListActive().

Referenced by ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), fillMembershipLimitation(), ilCourseRegistrationGUI\fillRegistrationPeriod(), ilGroupRegistrationGUI\fillRegistrationPeriod(), ilCourseRegistrationGUI\fillRegistrationType(), and ilGroupRegistrationGUI\fillRegistrationType().

                                                         : void
    {
        $this->registration_possible = $a_status;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillAgreement()

ilRegistrationGUI::fillAgreement ( )

protected

Definition at line 213 of file class.ilRegistrationGUI.php.

References ilExportFieldsInfo\_getInstanceByType(), ilCourseDefinedFieldDefinition\_hasFields(), ilObject\_lookupType(), ilMemberAgreementGUI\addAgreement(), ilMemberAgreementGUI\addCustomFields(), ilMemberAgreementGUI\addExportFieldInfo(), ILIAS\Repository\form(), isRegistrationPossible(), and ILIAS\Repository\lng().

Referenced by initForm().

                                      : void
    {
        if (!$this->isRegistrationPossible()) {
            return;
        }

        if (!$this->privacy->confirmationRequired($this->type) && !ilCourseDefinedFieldDefinition::_hasFields($this->container->getId())) {
            return;
        }

        $this->lng->loadLanguageModule('ps');

        $fields_info = ilExportFieldsInfo::_getInstanceByType(ilObject::_lookupType($this->container->getId()));

        if (!count($fields_info->getExportableFields())) {
            return;
        }
        $section = new ilFormSectionHeaderGUI();
        $section->setTitle($this->lng->txt($this->type . '_usr_agreement'));
        $this->form->addItem($section);

        ilMemberAgreementGUI::addExportFieldInfo($this->form, $this->obj_id, $this->type);

        ilMemberAgreementGUI::addCustomFields($this->form, $this->obj_id, $this->type);

        // Checkbox agreement
        if ($this->privacy->confirmationRequired($this->type)) {
            ilMemberAgreementGUI::addAgreement($this->form, $this->obj_id, $this->type);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillInformations()

ilRegistrationGUI::fillInformations ( )

abstractprotected

fill informations

Referenced by initForm(), and leaveWaitingList().

Here is the caller graph for this function:

fillMaxMembers()

ilRegistrationGUI::fillMaxMembers ( )

abstractprotected

show informations about the maximum number of user.

Referenced by initForm(), and leaveWaitingList().

Here is the caller graph for this function:

fillMembershipLimitation()

ilRegistrationGUI::fillMembershipLimitation ( )

protected

Show membership limitations.

Definition at line 168 of file class.ilRegistrationGUI.php.

References ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingItems(), ilObject\_getIcon(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ILIAS\Repository\access(), ILIAS\Repository\ctrl(), enableRegistration(), ILIAS\Repository\form(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilCustomInputGUI\setHtml().

Referenced by initForm().

                                                 : void
    {
        if (!$items = ilObjCourseGrouping::_getGroupingItems($this->container)) {
            return;
        }
        $mem = new ilCustomInputGUI($this->lng->txt('groupings'));
        $tpl = new ilTemplate('tpl.membership_limitation_form.html', true, true, 'Services/Membership');
        $tpl->setVariable('LIMIT_INTRO', $this->lng->txt($this->type . '_grp_info_reg'));
        foreach ($items as $ref_id) {
            $obj_id = ilObject::_lookupObjId($ref_id);
            $type = ilObject::_lookupType($obj_id);
            $title = ilObject::_lookupTitle($obj_id);

            if ($this->access->checkAccess('visible', '', $ref_id, $type)) {
                $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
                $tpl->setVariable(
                    'LINK_ITEM',
                    $this->ctrl->getLinkTargetByClass("ilrepositorygui", "")
                );
                $get_ref_id = $this->http->wrapper()->query()->retrieve(
                    'ref_id',
                    $this->refinery->byTrying([
                        $this->refinery->kindlyTo()->int(),
                        $this->refinery->always(0)
                    ])
                );

                $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $get_ref_id);
                $tpl->setVariable('ITEM_LINKED_TITLE', $title);
            } else {
                $tpl->setVariable('ITEM_TITLE');
            }
            $tpl->setCurrentBlock('items');
            $tpl->setVariable('TYPE_ICON', ilObject::_getIcon($obj_id, 'tiny', $type));
            $tpl->setVariable('ALT_ICON', $this->lng->txt('obj_' . $type));
            $tpl->parseCurrentBlock();
        }
        $mem->setHtml($tpl->get());
        if (!ilObjCourseGrouping::_checkGroupingDependencies($this->container)) {
            $mem->setAlert($this->container->getMessage());
            $this->enableRegistration(false);
        }
        $this->form->addItem($mem);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fillRegistrationPeriod()

ilRegistrationGUI::fillRegistrationPeriod ( )

abstractprotected

show informations about the registration period

Referenced by initForm(), and leaveWaitingList().

Here is the caller graph for this function:

fillRegistrationType()

ilRegistrationGUI::fillRegistrationType ( )

abstractprotected

show informations about registration procedure

Referenced by initForm(), and leaveWaitingList().

Here is the caller graph for this function:

getContainer()

ilRegistrationGUI::getContainer

(

)

Definition at line 81 of file class.ilRegistrationGUI.php.

References $container.

Referenced by ilCourseRegistrationGUI\fillMaxMembers(), and ilGroupRegistrationGUI\fillMaxMembers().

                                  : ilObject
    {
        return $this->container;
    }

Here is the caller graph for this function:

getFormTitle()

ilRegistrationGUI::getFormTitle ( )

abstractprotected

Get title for property form.

Referenced by initForm(), and leaveWaitingList().

Here is the caller graph for this function:

getRefId()

ilRegistrationGUI::getRefId

(

)

Definition at line 86 of file class.ilRegistrationGUI.php.

References $ref_id.

                              : int
    {
        return $this->ref_id;
    }

getWaitingList()

ilRegistrationGUI::getWaitingList ( )

protected

Get waiting list object.

Definition at line 121 of file class.ilRegistrationGUI.php.

References $waiting_list.

Referenced by addCommandButtons(), ilCourseRegistrationGUI\executeCommand(), ilGroupRegistrationGUI\executeCommand(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillRegistrationType(), ilCourseRegistrationGUI\getFormTitle(), ilGroupRegistrationGUI\getFormTitle(), ilCourseRegistrationGUI\isWaitingListActive(), ilGroupRegistrationGUI\isWaitingListActive(), and leaveWaitingList().

                                       : ilWaitingList
    {
        return $this->waiting_list;
    }

Here is the caller graph for this function:

initForm()

ilRegistrationGUI::initForm ( )

protected

Todo:

get rid $this->form

Definition at line 426 of file class.ilRegistrationGUI.php.

References $form, addCommandButtons(), ILIAS\Repository\ctrl(), fillAgreement(), fillInformations(), fillMaxMembers(), fillMembershipLimitation(), fillRegistrationPeriod(), fillRegistrationType(), ILIAS\Repository\form(), getFormTitle(), and isRegistrationPossible().

Referenced by join(), and show().

                                 : ilPropertyFormGUI
    {
        if (is_object($this->form)) {
            return $this->form;
        }

        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'join'));
        $this->form->setTitle($this->getFormTitle());

        $this->fillInformations();
        $this->fillMembershipLimitation();
        if ($this->isRegistrationPossible()) {
            $this->fillRegistrationPeriod();
        }
        if ($this->isRegistrationPossible() || $this->participants->isSubscriber($this->user->getId())) {
            $this->fillRegistrationType();
        }
        if ($this->isRegistrationPossible()) {
            $this->fillMaxMembers();
        }
        if ($this->isRegistrationPossible()) {
            $this->fillAgreement();
        }
        $this->addCommandButtons();
        return $this->form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initParticipants()

ilRegistrationGUI::initParticipants ( )

abstractprotected

Init participants object (course or group participants)

Referenced by __construct(), and enableRegistration().

Here is the caller graph for this function:

initWaitingList()

ilRegistrationGUI::initWaitingList ( )

abstractprotected

Init waiting list (course or group waiting list)

Referenced by __construct(), and enableRegistration().

Here is the caller graph for this function:

isRegistrationPossible()

ilRegistrationGUI::isRegistrationPossible ( )

protected

Definition at line 91 of file class.ilRegistrationGUI.php.

References $registration_possible.

Referenced by ilCourseRegistrationGUI\addCommandButtons(), ilGroupRegistrationGUI\addCommandButtons(), addCommandButtons(), fillAgreement(), initForm(), ilCourseRegistrationGUI\validate(), and ilGroupRegistrationGUI\validate().

                                               : bool
    {
        return $this->registration_possible;
    }

Here is the caller graph for this function:

isWaitingListActive()

ilRegistrationGUI::isWaitingListActive ( )

abstractprotected

Check if the waiting list is active Maximum of members exceeded or any user on the waiting list.

Referenced by addCommandButtons(), and enableRegistration().

Here is the caller graph for this function:

join()

ilRegistrationGUI::join

(

)

Definition at line 402 of file class.ilRegistrationGUI.php.

References ILIAS\UI\examples\Symbol\Glyph\Add\add(), ilPropertyFormGUI\checkInput(), initForm(), ILIAS\Repository\lng(), ilPropertyFormGUI\setValuesByPost(), show(), and validate().

                          : void
    {
        $form = $this->initForm();
        if (!$form->checkInput() || !$this->validate()) {
            $form->setValuesByPost();
            if ($this->join_error) {
                $this->tpl->setOnScreenMessage('failure', $this->join_error);
            } else {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
            }
            $this->show($form);
            return;
        }
        $this->add();
    }

Here is the call graph for this function:

leaveWaitingList()

ilRegistrationGUI::leaveWaitingList ( )

protected

Definition at line 126 of file class.ilRegistrationGUI.php.

References $message, ILIAS\Repository\ctrl(), fillInformations(), fillMaxMembers(), fillRegistrationPeriod(), fillRegistrationType(), getFormTitle(), getWaitingList(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                         : void
    {
        $this->getWaitingList()->removeFromList($this->user->getId());
        $parent = $this->tree->getParentId($this->container->getRefId());

        $message = sprintf(
            $this->lng->txt($this->container->getType() . '_removed_from_waiting_list'),
            $this->container->getTitle()
        );
        $this->tpl->setOnScreenMessage('success', $message, true);
        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $parent);
        $this->ctrl->redirectByClass("ilrepositorygui", "");
    }

Here is the call graph for this function:

setAccepted()

ilRegistrationGUI::setAccepted ( bool  $a_status )

protected

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

References ilCourseDefinedFieldDefinition\_hasFields(), ilMemberAgreement\setAccepted(), and ILIAS\Repository\user().

Referenced by ilCourseRegistrationGUI\add(), ilGroupRegistrationGUI\add(), and ilCourseRegistrationGUI\validate().

                                                  : void
    {
        if (!$this->privacy->confirmationRequired($this->type) && !ilCourseDefinedFieldDefinition::_hasFields($this->container->getId())) {
            return;
        }

        $agreement = new ilMemberAgreement($this->user->getId(), $this->container->getId());
        $agreement->setAccepted($a_status);
        $agreement->setAcceptanceTime(time());
        $agreement->save();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

show()

ilRegistrationGUI::show

(

?ilPropertyFormGUI

$form = null

)

Definition at line 390 of file class.ilRegistrationGUI.php.

References ILIAS\Repository\form(), ilSession\get(), initForm(), and ILIAS\Repository\lng().

Referenced by ilCourseRegistrationGUI\add(), and join().

                                                         : void
    {
        if (!$form instanceof ilPropertyFormGUI) {
            $this->initForm();
        }
        $pending_goto = (string) ilSession::get('pending_goto');
        if ($pending_goto) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt("reg_goto_parent_membership_info"));
        }
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showCustomFields()

ilRegistrationGUI::showCustomFields ( )

protected

Definition at line 244 of file class.ilRegistrationGUI.php.

References ilCourseDefinedFieldDefinition\_getFields(), ILIAS\Repository\form(), ILIAS\FileDelivery\http(), ilCourseDefinedFieldDefinition\IL_CDF_TYPE_SELECT, ilCourseDefinedFieldDefinition\IL_CDF_TYPE_TEXT, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilNonEditableValueGUI\setValue().

                                         : void
    {
        if (!count($cdf_fields = ilCourseDefinedFieldDefinition::_getFields($this->container->getId()))) {
            return;
        }

        $cdf_values = $this->http->wrapper()->post()->retrieve(
            'cdf',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->dictOf(
                    $this->refinery->kindlyTo()->string()
                ),
                $this->refinery->always([])
            ])
        );

        $cdf = new ilNonEditableValueGUI($this->lng->txt('ps_crs_user_fields'));
        $cdf->setValue($this->lng->txt($this->type . '_ps_cdf_info'));
        $cdf->setRequired(true);
        foreach ($cdf_fields as $field_obj) {
            switch ($field_obj->getType()) {
                case ilCourseDefinedFieldDefinition::IL_CDF_TYPE_SELECT:
                    $select = new ilSelectInputGUI($field_obj->getName(), 'cdf[' . $field_obj->getId() . ']');
                    $select->setValue($cdf_values[$field_obj->getId()] ?? '');
                    $select->setOptions($field_obj->prepareSelectBox());
                    if ($field_obj->isRequired()) {
                        $select->setRequired(true);
                    }
                    $cdf->addSubItem($select);
                    break;

                case ilCourseDefinedFieldDefinition::IL_CDF_TYPE_TEXT:
                    $text = new ilTextInputGUI($field_obj->getName(), 'cdf[' . $field_obj->getId() . ']');
                    $text->setValue($cdf_values[$field_obj->getId()] ?? '');
                    $text->setSize(32);
                    $text->setMaxLength(255);
                    if ($field_obj->isRequired()) {
                        $text->setRequired(true);
                    }
                    $cdf->addSubItem($text);
                    break;
            }
        }
        $this->form->addItem($cdf);
    }

Here is the call graph for this function:

updateSubscriptionRequest()

ilRegistrationGUI::updateSubscriptionRequest ( )

protected

Definition at line 480 of file class.ilRegistrationGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilUtil\stripSlashes(), and ILIAS\Repository\user().

                                                  : void
    {
        $subject = $this->http->wrapper()->post()->retrieve(
            'subject',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );

        $this->participants->updateSubject($this->user->getId(), ilUtil::stripSlashes($subject));
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('sub_request_saved'), true);
        $this->ctrl->setParameterByClass(
            "ilrepositorygui",
            "ref_id",
            $this->tree->getParentId($this->container->getRefId())
        );
        $this->ctrl->redirectByClass("ilrepositorygui", "");
    }

Here is the call graph for this function:

validate()

ilRegistrationGUI::validate ( )

protected

Definition at line 418 of file class.ilRegistrationGUI.php.

Referenced by join().

                                 : bool
    {
        return true;
    }

Here is the caller graph for this function:

validateAgreement()

ilRegistrationGUI::validateAgreement ( )

protected

Definition at line 290 of file class.ilRegistrationGUI.php.

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

Referenced by ilCourseRegistrationGUI\validate(), and ilGroupRegistrationGUI\validate().

                                          : bool
    {
        $agreement = $this->http->wrapper()->post()->retrieve(
            'agreement',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always(null)
            ])
        );

        if ($agreement) {
            return true;
        }
        if (!$this->privacy->confirmationRequired($this->type)) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validateCustomFields()

ilRegistrationGUI::validateCustomFields ( )

protected

Definition at line 309 of file class.ilRegistrationGUI.php.

References ilCourseDefinedFieldDefinition\_getFields(), ILIAS\FileDelivery\http(), ilCourseDefinedFieldDefinition\IL_CDF_TYPE_SELECT, ilCourseDefinedFieldDefinition\IL_CDF_TYPE_TEXT, ILIAS\Repository\int(), ILIAS\Repository\refinery(), ilCourseUserData\setValue(), and ILIAS\Repository\user().

Referenced by ilCourseRegistrationGUI\validate(), and ilGroupRegistrationGUI\validate().

                                             : bool
    {
        $required_fullfilled = true;
        $value = '';
        foreach (ilCourseDefinedFieldDefinition::_getFields($this->container->getId()) as $field_obj) {
            switch ($field_obj->getType()) {
                case ilCourseDefinedFieldDefinition::IL_CDF_TYPE_SELECT:
                    $cdf_value = $this->http->wrapper()->post()->retrieve(
                        'cdf_' . $field_obj->getId(),
                        $this->refinery->byTrying([
                            $this->refinery->kindlyTo()->string(),
                            $this->refinery->always('')
                        ])
                    );

                    // Split value id from post
                    $cdf_parts = explode('_', $cdf_value);
                    $option_id = (int) ($cdf_parts[1] ?? 0);

                    $open_answer_indexes = $field_obj->getValueOptions();
                    if (in_array($option_id, $open_answer_indexes)) {
                        $value = $this->http->wrapper()->post()->retrieve(
                            'cdf_oa_' . $field_obj->getId() . '_' . $option_id,
                            $this->refinery->byTrying([
                                $this->refinery->kindlyTo()->string(),
                                $this->refinery->always('')
                            ])
                        );
                    } else {
                        $value = $field_obj->getValueById((int) $option_id);
                    }
                    break;

                case ilCourseDefinedFieldDefinition::IL_CDF_TYPE_TEXT:
                    $value = $this->http->wrapper()->post()->retrieve(
                        'cdf_' . $field_obj->getId(),
                        $this->refinery->byTrying([
                            $this->refinery->kindlyTo()->string(),
                            $this->refinery->always('')
                        ])
                    );
                    break;
            }

            $course_user_data = new ilCourseUserData($this->user->getId(), $field_obj->getId());
            $course_user_data->setValue($value);
            $course_user_data->update();

            // #14220
            if ($field_obj->isRequired() && $value === "") {
                $required_fullfilled = false;
            }
        }
        return $required_fullfilled;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilRegistrationGUI::$access

protected

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

$container

ilObject ilRegistrationGUI::$container

protected

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

Referenced by getContainer().

$ctrl

ilCtrl ilRegistrationGUI::$ctrl

protected

Definition at line 46 of file class.ilRegistrationGUI.php.

$form

ilPropertyFormGUI ilRegistrationGUI::$form = null

protected

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

Referenced by initForm().

$http

ILIAS HTTP GlobalHttpState ilRegistrationGUI::$http

protected

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

$join_error

string ilRegistrationGUI::$join_error = ''

protected

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

$lng

ilLanguage ilRegistrationGUI::$lng

protected

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

$obj_id

int ilRegistrationGUI::$obj_id

protected

Definition at line 29 of file class.ilRegistrationGUI.php.

$participants

ilParticipants ilRegistrationGUI::$participants

protected

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

Referenced by ilCourseRegistrationGUI\initParticipants(), and ilGroupRegistrationGUI\initParticipants().

$privacy

ilPrivacySettings ilRegistrationGUI::$privacy

protected

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

$rbacreview

ilRbacReview ilRegistrationGUI::$rbacreview

protected

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

$ref_id

int ilRegistrationGUI::$ref_id

protected

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

Referenced by getRefId().

$refinery

ILIAS Refinery Factory ilRegistrationGUI::$refinery

protected

Definition at line 34 of file class.ilRegistrationGUI.php.

$registration_possible

bool ilRegistrationGUI::$registration_possible = true

protected

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

Referenced by isRegistrationPossible().

$tabs

ilTabsGUI ilRegistrationGUI::$tabs

protected

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

$tpl

ilGlobalTemplateInterface ilRegistrationGUI::$tpl

protected

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

Referenced by ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), ilCourseRegistrationGUI\fillRegistrationPeriod(), and ilGroupRegistrationGUI\fillRegistrationPeriod().

$tree

ilTree ilRegistrationGUI::$tree

protected

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

$type

string ilRegistrationGUI::$type

protected

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

$user

ilObjUser ilRegistrationGUI::$user

protected

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

$waiting_list

ilWaitingList ilRegistrationGUI::$waiting_list

protected

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

Referenced by ilCourseRegistrationGUI\add(), ilGroupRegistrationGUI\add(), ilCourseRegistrationGUI\fillMaxMembers(), ilGroupRegistrationGUI\fillMaxMembers(), getWaitingList(), ilCourseRegistrationGUI\initWaitingList(), and ilGroupRegistrationGUI\initWaitingList().

---

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

• Services/Membership/classes/class.ilRegistrationGUI.php