ilMembershipRegistrationCodeUtils Class Reference

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

Collaboration diagram for ilMembershipRegistrationCodeUtils:

Static Public Member Functions
static	handleCode ($a_ref_id, $a_type, $a_code)
	Handle target parameter. More...
static	generateCode ()
	Generate new registration key. More...

Data Fields
const	CODE_LENGTH = 10

Static Protected Member Functions
static	useCode ($a_code, $a_endnode)
	Use a registration code and assign the logged in user to the (parent) course/group that offer the code. More...
static	lookupObjectsByCode ($a_code)
	Get all objects with enabled access codes. More...

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 13 of file class.ilMembershipRegistrationCodeUtils.php.

Member Function Documentation

generateCode()

static ilMembershipRegistrationCodeUtils::generateCode ( )

static

Generate new registration key.

Returns

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

References $code, and $map.

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

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

Here is the caller graph for this function:

handleCode()

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

static

Handle target parameter.

Parameters

object

$a_target

Returns

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

References $a_type, $DIC, $ilUser, $lng, $title, $tree, ilLink\_getLink(), 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 ilUtil\sendFailure().

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

    {
        global $DIC;

        $lng = $DIC['lng'];
        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];
        include_once './Services/Link/classes/class.ilLink.php';
        $lng->loadLanguageModule($a_type);
        try {
            self::useCode($a_code, $a_ref_id);
            $title = ilObject::_lookupTitle(ilObject::_lookupObjectId($a_ref_id));
            ilUtil::sendSuccess(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
                    ilUtil::sendSuccess($e->getMessage(), true);
                    break;
                case ilMembershipRegistrationException::OBJECT_IS_FULL://object is full
                    ilUtil::sendFailure($lng->txt($a_type . "_admission_link_failure_membership_limited"), true);
                    break;
                case ilMembershipRegistrationException::OUT_OF_REGISTRATION_PERIOD://out of registration period
                    ilUtil::sendFailure($lng->txt($a_type . "_admission_link_failure_registration_period"), true);
                    break;
                case ilMembershipRegistrationException::ADMISSION_LINK_INVALID://admission link is invalid
                    ilUtil::sendFailure($lng->txt($a_type . "_admission_link_failure_invalid_code"), true);
                    break;
                case ilMembershipRegistrationException::REGISTRATION_INVALID_OFFLINE:
                    ilUtil::sendFailure($lng->txt($a_type . '_admission_link_failure_offline'), true);
                    break;
                case ilMembershipRegistrationException::REGISTRATION_INVALID_AVAILABILITY:
                    ilUtil::sendFailure($lng->txt($a_type . '_admission_link_failure_availability'), true);
                    break;
                default:
                    ilUtil::sendFailure($e->getMessage(), true);
                    break;
            }
            $parent_id = $tree->getParentId($a_ref_id);
            ilUtil::redirect(ilLink::_getLink($parent_id));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupObjectsByCode()

static ilMembershipRegistrationCodeUtils::lookupObjectsByCode (   $a_code )

staticprotected

Get all objects with enabled access codes.

Parameters

string

$a_code

Returns

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

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

    {
        include_once './Modules/Group/classes/class.ilObjGroup.php';
        include_once './Modules/Course/classes/class.ilObjCourse.php';
        
        return array_merge(
            ilObjGroup::lookupObjectsByCode($a_code),
            ilObjCourse::lookupObjectsByCode($a_code)
        );
    }

Here is the call graph for this function:

useCode()

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

staticprotected

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

Todo:

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

Parameters

string	$a_code
int	$a_endnode	Reference id of node in tree

Returns

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

References $DIC, $factory, $ilUser, $tree, ilObject\_lookupObjId(), ilMembershipRegistrationException\ADMISSION_LINK_INVALID, ilCourseConstants\CRS_MEMBER, and IL_GRP_MEMBER.

    {
        global $DIC;

        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];
        
        $obj_ids = self::lookupObjectsByCode($a_code);

        if (!$obj_ids) {
            include_once './Services/Membership/exceptions/class.ilMembershipRegistrationException.php';
            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)) {
                $factory = new ilObjectFactory();
                $member_obj = $factory->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(), IL_GRP_MEMBER, true);
                }
            }
        }
    }

Here is the call graph for this function:

Field Documentation

CODE_LENGTH

const ilMembershipRegistrationCodeUtils::CODE_LENGTH = 10

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

---

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

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