Stores registration keys for key based registration on courses and groups. More...

Collaboration diagram for ilMembershipRegistrationCodeUtils:

Static Public Member Functions
static	handleCode (int $a_ref_id, string $a_type, string $a_code)

static	generateCode ()
	Generate new registration key. More...

Static Protected Member Functions
static	useCode (string $a_code, int $a_endnode)
	Use a registration code and assign the logged in user to the (parent) course/group that offer the code. More...

static	lookupObjectsByCode (string $a_code)
	Get all objects with enabled access codes. More...

Protected Attributes
const	CODE_LENGTH = 10

Detailed Description

Stores registration keys for key based registration on courses and groups.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 27 of file class.ilMembershipRegistrationCodeUtils.php.

Member Function Documentation

◆ generateCode()

static ilMembershipRegistrationCodeUtils::generateCode ( )

static

Generate new registration key.

Definition at line 115 of file class.ilMembershipRegistrationCodeUtils.php.

                                         : string
    {
        // missing : 01iloO
        $map = "23456789abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ";
 
        $code = "";
        $max = strlen($map) - 1;
        for ($loop = 1; $loop <= self::CODE_LENGTH; $loop++) {
            $code .= $map[random_int(0, $max)];
        }
        return $code;
    }

References CODE_LENGTH.

Referenced by ilObjCourse\__createDefaultSettings(), ilObjCourse\cloneSettings(), ilObjCourseGUI\initEditForm(), and ilObjGroupGUI\initForm().

Here is the caller graph for this function:

◆ handleCode()

static ilMembershipRegistrationCodeUtils::handleCode	(	int	$a_ref_id,
		string	$a_type,
		string	$a_code
	)

static

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

                                                                                    : void
    {
        global $DIC;
        $main_tpl = $DIC->ui()->mainTemplate();
 
        $lng = $DIC->language();
        $tree = $DIC->repositoryTree();
 
        $lng->loadLanguageModule($a_type);
        try {
            self::useCode($a_code, $a_ref_id);
            $title = ilObject::_lookupTitle(ilObject::_lookupObjectId($a_ref_id));
            $main_tpl->setOnScreenMessage('success', sprintf($lng->txt($a_type . "_admission_link_success_registration"), $title), true);
            ilUtil::redirect(ilLink::_getLink($a_ref_id));
        } catch (ilMembershipRegistrationException $e) {
            switch ($e->getCode()) {
                case ilMembershipRegistrationException::ADDED_TO_WAITINGLIST://added to waiting list
                    $main_tpl->setOnScreenMessage('success', $e->getMessage(), true);
                    break;
                case ilMembershipRegistrationException::OBJECT_IS_FULL://object is full
                    $main_tpl->setOnScreenMessage('failure', $lng->txt($a_type . "_admission_link_failure_membership_limited"), true);
                    break;
                case ilMembershipRegistrationException::OUT_OF_REGISTRATION_PERIOD://out of registration period
                    $main_tpl->setOnScreenMessage('failure', $lng->txt($a_type . "_admission_link_failure_registration_period"), true);
                    break;
                case ilMembershipRegistrationException::ADMISSION_LINK_INVALID://admission link is invalid
                    $main_tpl->setOnScreenMessage('failure', $lng->txt($a_type . "_admission_link_failure_invalid_code"), true);
                    break;
                case ilMembershipRegistrationException::REGISTRATION_INVALID_OFFLINE:
                    $main_tpl->setOnScreenMessage('failure', $lng->txt($a_type . '_admission_link_failure_offline'), true);
                    break;
                case ilMembershipRegistrationException::REGISTRATION_INVALID_AVAILABILITY:
                    $main_tpl->setOnScreenMessage('failure', $lng->txt($a_type . '_admission_link_failure_availability'), true);
                    break;
                default:
                    $main_tpl->setOnScreenMessage('failure', $e->getMessage(), true);
                    break;
            }
            $parent_id = $tree->getParentId($a_ref_id);
            ilUtil::redirect(ilLink::_getLink($parent_id));
        }
    }

References $DIC, Vendor\Package\$e, $lng, ilObject\_lookupObjectId(), ilObject\_lookupTitle(), ilMembershipRegistrationException\ADDED_TO_WAITINGLIST, ilMembershipRegistrationException\ADMISSION_LINK_INVALID, ilMembershipRegistrationException\OBJECT_IS_FULL, ilMembershipRegistrationException\OUT_OF_REGISTRATION_PERIOD, ilUtil\redirect(), ilMembershipRegistrationException\REGISTRATION_INVALID_AVAILABILITY, ilMembershipRegistrationException\REGISTRATION_INVALID_OFFLINE, and useCode().

Referenced by ilObjCourseGUI\_goto(), ilObjGroupGUI\_goto(), and ilObjLearningSequence\_goto().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupObjectsByCode()

static ilMembershipRegistrationCodeUtils::lookupObjectsByCode ( string $a_code )

staticprotected

Get all objects with enabled access codes.

Returns: int[]

Definition at line 132 of file class.ilMembershipRegistrationCodeUtils.php.

                                                                 : array
    {
        return array_merge(
            ilObjGroup::lookupObjectsByCode($a_code),
            ilObjCourse::lookupObjectsByCode($a_code)
        );
    }

References ilObjCourse\lookupObjectsByCode(), and ilObjGroup\lookupObjectsByCode().

Referenced by useCode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ useCode()

static ilMembershipRegistrationCodeUtils::useCode	(	string	$a_code,
		int	$a_endnode
	)

staticprotected

Use a registration code and assign the logged in user to the (parent) course/group that offer the code.

Parameters

int $a_endnode Reference id of node in tree

Exceptions

ilDatabaseException
ilMembershipRegistrationException
ilObjectNotFoundException

Todo:: : throw an error if registration fails (max members, availibility...)

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

                                                                     : void
    {
        global $DIC;
 
        $tree = $DIC->repositoryTree();
        $ilUser = $DIC->user();
 
        $obj_ids = self::lookupObjectsByCode($a_code);
 
        if (!$obj_ids) {
            throw new ilMembershipRegistrationException(
                'Admission code is not valid',
                ilMembershipRegistrationException::ADMISSION_LINK_INVALID
            );
        }
 
        foreach ($tree->getPathId($a_endnode) as $ref_id) {
            if (in_array(ilObject::_lookupObjId($ref_id), $obj_ids)) {
                $member_obj = ilObjectFactory::getInstanceByRefId($ref_id, false);
                if ($member_obj instanceof ilObjCourse) {
                    $member_obj->register($ilUser->getId(), ilCourseConstants::CRS_MEMBER);
                }
                if ($member_obj instanceof ilObjGroup) {
                    $member_obj->register($ilUser->getId(), ilParticipants::IL_GRP_MEMBER, true);
                }
            }
        }
    }