ilParticipant Class Reference

Base class for course and group participant. More...

Inheritance diagram for ilParticipant:

Collaboration diagram for ilParticipant:

Public Member Functions
	getUserId ()
	isBlocked ()
	isContact ()
	Check if user is contact for current object. More...
	isAssigned ()
	isMember ()
	isAdmin ()
	isTutor ()
	isParticipant ()
	getNumberOfMembers ()
	add (int $a_usr_id, int $a_role)
	delete (int $a_usr_id)
	deleteSubscriber (int $a_usr_id)
	addRecommendation ($a_usr_id)
	updateContact (int $a_usr_id, bool $a_contact)
	updateNotification (int $a_usr_id, bool $a_notification)
	checkLastAdmin (array $a_usr_ids)

Static Public Member Functions
static	updateMemberRoles (int $a_obj_id, int $a_usr_id, int $a_role_id, int $a_status)
static	getMembershipRoleType (int $a_role_id)
static	lookupStatusByMembershipRoleType (int $a_obj_id, int $a_usr_id, int $a_membership_role_type)

Protected Member Functions
	__construct (string $a_component_name, int $a_obj_id, int $a_usr_id)
	getComponent ()
	Get component name Used for event handling. More...
	readParticipant ()
	readParticipantStatus ()

Protected Attributes
const	MEMBERSHIP_ADMIN = 1
const	MEMBERSHIP_TUTOR = 2
const	MEMBERSHIP_MEMBER = 3
string	$type = ''
ilRecommendedContentManager	$recommended_content_manager
ilDBInterface	$db
ilRbacReview	$rbacReview
ilRbacAdmin	$rbacAdmin
ilObjectDataCache	$objectDataCache
ilAppEventHandler	$eventHandler

Private Attributes
int	$obj_id = 0
int	$usr_id = 0
int	$ref_id = 0
string	$component = ''
array	$roles = []
array	$role_data = []
bool	$participants = false
bool	$admins = false
bool	$tutors = false
bool	$members = false
int	$numMembers = null
array	$member_roles = []
array	$participants_status = array()

Detailed Description

Base class for course and group participant.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilParticipant::__construct ( string  $a_component_name, int  $a_obj_id, int  $a_usr_id  )

protected

Definition at line 57 of file class.ilParticipant.php.

References $DIC, ilObject\_getAllReferences(), ilObject\_lookupType(), readParticipant(), and readParticipantStatus().

    {
        global $DIC;

        $this->obj_id = $a_obj_id;
        $this->usr_id = $a_usr_id;
        $this->type = ilObject::_lookupType($a_obj_id);
        $ref_ids = ilObject::_getAllReferences($this->obj_id);
        $this->ref_id = current($ref_ids);
        $this->component = $a_component_name;

        $this->recommended_content_manager = new ilRecommendedContentManager();
        $this->db = $DIC->database();
        $this->rbacReview = $DIC->rbac()->review();
        $this->rbacAdmin = $DIC->rbac()->admin();
        $this->objectDataCache = $DIC['ilObjDataCache'];
        $this->eventHandler = $DIC->event();

        $this->readParticipant();
        $this->readParticipantStatus();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilParticipant::add	(	int	$a_usr_id,
		int	$a_role
	)

Definition at line 336 of file class.ilParticipant.php.

References addRecommendation(), deleteSubscriber(), ilWaitingList\deleteUserEntry(), getComponent(), ilParticipants\IL_CRS_ADMIN, ilParticipants\IL_CRS_MEMBER, ilParticipants\IL_CRS_TUTOR, ilParticipants\IL_GRP_ADMIN, and ilParticipants\IL_GRP_MEMBER.

                                                   : bool
    {
        if ($this->rbacReview->isAssignedToAtLeastOneGivenRole($a_usr_id, $this->roles)) {
            return false;
        }

        switch ($a_role) {
            case ilParticipants::IL_GRP_ADMIN:
            case ilParticipants::IL_CRS_ADMIN:
                $this->admins = true;
                break;

            case ilParticipants::IL_CRS_TUTOR:
                $this->tutors = true;
                break;

            case ilParticipants::IL_GRP_MEMBER:
            case ilParticipants::IL_CRS_MEMBER:
                $this->members = true;
                break;

        }

        $this->rbacAdmin->assignUser($this->role_data[$a_role], $a_usr_id);
        $this->addRecommendation($a_usr_id);

        // Delete subscription request
        $this->deleteSubscriber($a_usr_id);

        ilWaitingList::deleteUserEntry($a_usr_id, $this->obj_id);

        $this->eventHandler->raise(
            $this->getComponent(),
            "addParticipant",
            array(
                'obj_id' => $this->obj_id,
                'usr_id' => $a_usr_id,
                'role_id' => $a_role
            )
        );
        return true;
    }

Here is the call graph for this function:

addRecommendation()

ilParticipant::addRecommendation

(

$a_usr_id

)

Definition at line 409 of file class.ilParticipant.php.

Referenced by add().

                                                : void
    {
        // deactivated for now, see discussion at
        // https://docu.ilias.de/goto_docu_wiki_wpage_5620_1357.html
        //$this->recommended_content_manager->addObjectRecommendation($a_usr_id, $this->ref_id);
    }

Here is the caller graph for this function:

checkLastAdmin()

ilParticipant::checkLastAdmin

(

array

$a_usr_ids

)

Definition at line 453 of file class.ilParticipant.php.

References $data, $query, $res, ilParticipants\IL_CRS_ADMIN, and ilParticipants\IL_GRP_ADMIN.

                                                    : bool
    {
        $admin_role_id =
            $this->type === 'crs' ?
                $this->role_data[ilParticipants::IL_CRS_ADMIN] :
                $this->role_data[ilParticipants::IL_GRP_ADMIN];

        $query = "
                SELECT                  COUNT(rolesusers.usr_id) cnt
                
                FROM                    object_data rdata
                
                LEFT JOIN               rbac_ua  rolesusers             
                ON                              rolesusers.rol_id = rdata.obj_id
                
                WHERE                   rdata.obj_id = %s
                ";

        $query .= ' AND ' . $this->db->in('rolesusers.usr_id', $a_usr_ids, true, 'integer');
        $res = $this->db->queryF($query, array('integer'), array($admin_role_id));

        $data = $this->db->fetchAssoc($res);
        return $data['cnt'] > 0;
    }

delete()

ilParticipant::delete

(

int

$a_usr_id

)

Definition at line 379 of file class.ilParticipant.php.

References $query, $res, and getComponent().

                                         : void
    {
        $this->recommended_content_manager->removeObjectRecommendation($a_usr_id, $this->ref_id);
        foreach ($this->roles as $role_id) {
            $this->rbacAdmin->deassignUser($role_id, $a_usr_id);
        }

        $query = "DELETE FROM obj_members " .
            "WHERE usr_id = " . $this->db->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->obj_id, 'integer');
        $res = $this->db->manipulate($query);

        $this->eventHandler->raise(
            $this->getComponent(),
            "deleteParticipant",
            array(
                'obj_id' => $this->obj_id,
                'usr_id' => $a_usr_id
            )
        );
    }

Here is the call graph for this function:

deleteSubscriber()

ilParticipant::deleteSubscriber

(

int

$a_usr_id

)

Definition at line 401 of file class.ilParticipant.php.

References $query, and $res.

Referenced by add().

                                                   : void
    {
        $query = "DELETE FROM il_subscribers " .
            "WHERE usr_id = " . $this->db->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $this->db->quote($this->obj_id, 'integer') . " ";
        $res = $this->db->manipulate($query);
    }

Here is the caller graph for this function:

getComponent()

ilParticipant::getComponent ( )

protected

Get component name Used for event handling.

Definition at line 203 of file class.ilParticipant.php.

References $component.

Referenced by add(), and delete().

                                     : string
    {
        return $this->component;
    }

Here is the caller graph for this function:

getMembershipRoleType()

static ilParticipant::getMembershipRoleType ( int  $a_role_id )

static

Definition at line 154 of file class.ilParticipant.php.

References ilObject\_lookupTitle().

                                                                : int
    {
        $title = ilObject::_lookupTitle($a_role_id);
        switch (substr($title, 0, 8)) {
            case 'il_crs_a':
            case 'il_grp_a':
                return self::MEMBERSHIP_ADMIN;

            case 'il_crs_t':
                return self::MEMBERSHIP_TUTOR;

            case 'il_crs_m':
            default:
                return self::MEMBERSHIP_MEMBER;

        }
    }

Here is the call graph for this function:

getNumberOfMembers()

ilParticipant::getNumberOfMembers

(

)

Definition at line 251 of file class.ilParticipant.php.

References $numMembers.

                                        : int
    {
        if ($this->numMembers === null) {
            $this->numMembers = $this->rbacReview->getNumberOfAssignedUsers($this->member_roles);
        }
        return $this->numMembers;
    }

getUserId()

ilParticipant::getUserId

(

)

Definition at line 208 of file class.ilParticipant.php.

References $usr_id.

Referenced by isBlocked(), isContact(), and readParticipantStatus().

                               : int
    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

isAdmin()

ilParticipant::isAdmin

(

)

Definition at line 236 of file class.ilParticipant.php.

References $admins.

                             : bool
    {
        return $this->admins;
    }

isAssigned()

ilParticipant::isAssigned

(

)

Definition at line 226 of file class.ilParticipant.php.

References $participants.

                                : bool
    {
        return $this->participants;
    }

isBlocked()

ilParticipant::isBlocked

(

)

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

References getUserId().

                               : bool
    {
        return (bool) ($this->participants_status[$this->getUserId()]['blocked'] ?? false);
    }

Here is the call graph for this function:

isContact()

ilParticipant::isContact

(

)

Check if user is contact for current object.

Definition at line 221 of file class.ilParticipant.php.

References getUserId().

                               : bool
    {
        return (bool) ($this->participants_status[$this->getUserId()]['contact'] ?? false);
    }

Here is the call graph for this function:

isMember()

ilParticipant::isMember

(

)

Definition at line 231 of file class.ilParticipant.php.

References $members.

                              : bool
    {
        return $this->members;
    }

isParticipant()

ilParticipant::isParticipant

(

)

Definition at line 246 of file class.ilParticipant.php.

References $participants.

                                   : bool
    {
        return $this->participants;
    }

isTutor()

ilParticipant::isTutor

(

)

Definition at line 241 of file class.ilParticipant.php.

References $tutors.

                             : bool
    {
        return $this->tutors;
    }

lookupStatusByMembershipRoleType()

static ilParticipant::lookupStatusByMembershipRoleType ( int  $a_obj_id, int  $a_usr_id, int  $a_membership_role_type  )

static

Definition at line 172 of file class.ilParticipant.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilDBConstants\T_INTEGER.

     : int {
        global $DIC;

        $ilDB = $DIC->database();
        $query = 'SELECT * FROM obj_members ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
            'AND usr_id = ' . $ilDB->quote($a_usr_id, ilDBConstants::T_INTEGER) . ' ';
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            switch ($a_membership_role_type) {
                case self::MEMBERSHIP_ADMIN:
                    return (int) $row->admin;

                case self::MEMBERSHIP_TUTOR:
                    return (int) $row->tutor;

                case self::MEMBERSHIP_MEMBER:
                    return (int) $row->member;
            }
        }
        return 0;
    }

readParticipant()

ilParticipant::readParticipant ( )

protected

Definition at line 259 of file class.ilParticipant.php.

References ilParticipants\IL_CRS_ADMIN, ilParticipants\IL_CRS_MEMBER, ilParticipants\IL_CRS_TUTOR, ilParticipants\IL_GRP_ADMIN, and ilParticipants\IL_GRP_MEMBER.

Referenced by __construct().

                                        : void
    {
        $this->roles = $this->rbacReview->getRolesOfRoleFolder($this->ref_id, false);
        $this->member_roles = [];
        foreach ($this->roles as $role_id) {
            $title = $this->objectDataCache->lookupTitle($role_id);
            switch (substr($title, 0, 8)) {
                case 'il_crs_m':
                    $this->member_roles[] = $role_id;
                    $this->role_data[ilParticipants::IL_CRS_MEMBER] = $role_id;
                    if ($this->rbacReview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->members = true;
                    }
                    break;

                case 'il_crs_a':
                    $this->role_data[ilParticipants::IL_CRS_ADMIN] = $role_id;
                    if ($this->rbacReview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->admins = true;
                    }
                    break;

                case 'il_crs_t':
                    $this->role_data[ilParticipants::IL_CRS_TUTOR] = $role_id;
                    if ($this->rbacReview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->tutors = true;
                    }
                    break;

                case 'il_grp_a':
                    $this->role_data[ilParticipants::IL_GRP_ADMIN] = $role_id;
                    if ($this->rbacReview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->admins = true;
                    }
                    break;

                case 'il_grp_m':
                    $this->member_roles[] = $role_id;
                    $this->role_data[ilParticipants::IL_GRP_MEMBER] = $role_id;
                    if ($this->rbacReview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->members = true;
                    }
                    break;

                default:

                    $this->member_roles[] = $role_id;
                    if ($this->rbacReview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->members = true;
                    }
                    break;
            }
        }
    }

Here is the caller graph for this function:

readParticipantStatus()

ilParticipant::readParticipantStatus ( )

protected

Definition at line 320 of file class.ilParticipant.php.

References $query, $res, ilDBConstants\FETCHMODE_OBJECT, and getUserId().

Referenced by __construct().

                                              : void
    {
        $query = "SELECT * FROM obj_members " .
            "WHERE obj_id = " . $this->db->quote($this->obj_id, 'integer') . " " .
            'AND usr_id = ' . $this->db->quote($this->getUserId(), 'integer');

        $res = $this->db->query($query);
        $this->participants_status = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->participants_status[$this->getUserId()]['blocked'] = (bool) $row->blocked;
            $this->participants_status[$this->getUserId()]['notification'] = (bool) $row->notification;
            $this->participants_status[$this->getUserId()]['passed'] = (bool) $row->passed;
            $this->participants_status[$this->getUserId()]['contact'] = (bool) $row->contact;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateContact()

ilParticipant::updateContact	(	int	$a_usr_id,
		bool	$a_contact
	)

Definition at line 416 of file class.ilParticipant.php.

                                                                 : void
    {
        $this->db->manipulate(
            'UPDATE obj_members SET ' .
            'contact = ' . $this->db->quote($a_contact, 'integer') . ' ' .
            'WHERE obj_id = ' . $this->db->quote($this->obj_id, 'integer') . ' ' .
            'AND usr_id = ' . $this->db->quote($a_usr_id, 'integer')
        );
        $this->participants_status[$a_usr_id]['contact'] = $a_contact;
    }

updateMemberRoles()

static ilParticipant::updateMemberRoles ( int  $a_obj_id, int  $a_usr_id, int  $a_role_id, int  $a_status  )

static

Definition at line 79 of file class.ilParticipant.php.

References $DIC, $ilDB, $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilGroupAppEventListener\handleUserAssignments(), and ilCourseAppEventListener\handleUserAssignments().

                                                                                                         : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $a_membership_role_type = self::getMembershipRoleType($a_role_id);
        switch ($a_membership_role_type) {
            case self::MEMBERSHIP_ADMIN:
                $update_fields = array('admin' => array('integer', $a_status ? 1 : 0));
                $update_string = ('admin = ' . $ilDB->quote($a_status ? 1 : 0, 'integer'));
                break;

            case self::MEMBERSHIP_TUTOR:
                $update_fields = array('tutor' => array('integer', $a_status ? 1 : 0));
                $update_string = ('tutor = ' . $ilDB->quote($a_status ? 1 : 0, 'integer'));
                break;

            case self::MEMBERSHIP_MEMBER:
            default:
                $current_status = self::lookupStatusByMembershipRoleType($a_obj_id, $a_usr_id, $a_membership_role_type);

                if ($a_status) {
                    $new_status = $current_status + 1;
                }
                if (!$a_status) {
                    $new_status = $current_status - 1;
                    if ($new_status < 0) {
                        $new_status = 0;
                    }
                }

                $update_fields = array('member' => array('integer', $new_status));
                $update_string = ('member = ' . $ilDB->quote($new_status, 'integer'));
                break;
        }

        $query = 'SELECT count(*) num FROM obj_members  ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
            'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->query($query);

        $found = false;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($row->num) {
                $found = true;
            }
        }
        if (!$found) {
            $ilDB->replace(
                'obj_members',
                array(
                    'obj_id' => array('integer', $a_obj_id),
                    'usr_id' => array('integer', $a_usr_id)
                ),
                $update_fields
            );
        } else {
            $query = 'UPDATE obj_members SET ' .
                $update_string . ' ' .
                'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer');

            $ilDB->manipulate($query);
        }

        $query = 'DELETE from obj_members ' .
            'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
            'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer') . ' ' .
            'AND admin = ' . $ilDB->quote(0, 'integer') . ' ' .
            'AND tutor = ' . $ilDB->quote(0, 'integer') . ' ' .
            'AND member = ' . $ilDB->quote(0, 'integer');
        $ilDB->manipulate($query);
    }

Here is the caller graph for this function:

updateNotification()

ilParticipant::updateNotification	(	int	$a_usr_id,
		bool	$a_notification
	)

Definition at line 427 of file class.ilParticipant.php.

References $query, and $res.

                                                                           : void
    {
        $this->participants_status[$a_usr_id]['notification'] = $a_notification;

        $query = "SELECT * FROM obj_members " .
            "WHERE obj_id = " . $this->db->quote($this->obj_id, 'integer') . " " .
            "AND usr_id = " . $this->db->quote($a_usr_id, 'integer');
        $res = $this->db->query($query);
        if ($res->numRows()) {
            $query = "UPDATE obj_members SET " .
                "notification = " . $this->db->quote((int) $a_notification, 'integer') . " " .
                "WHERE obj_id = " . $this->db->quote($this->obj_id, 'integer') . " " .
                "AND usr_id = " . $this->db->quote($a_usr_id, 'integer');
        } else {
            $query = "INSERT INTO obj_members (notification,obj_id,usr_id,passed,blocked) " .
                "VALUES ( " .
                $this->db->quote((int) $a_notification, 'integer') . ", " .
                $this->db->quote($this->obj_id, 'integer') . ", " .
                $this->db->quote($a_usr_id, 'integer') . ", " .
                $this->db->quote(0, 'integer') . ", " .
                $this->db->quote(0, 'integer') .
                ") ON DUPLICATE KEY UPDATE notification = VALUES(notification)";
        }
        $this->db->manipulate($query);
    }

Field Documentation

$admins

bool ilParticipant::$admins = false

private

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

Referenced by isAdmin().

$component

string ilParticipant::$component = ''

private

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

Referenced by getComponent().

$db

ilDBInterface ilParticipant::$db

protected

Definition at line 51 of file class.ilParticipant.php.

$eventHandler

ilAppEventHandler ilParticipant::$eventHandler

protected

Definition at line 55 of file class.ilParticipant.php.

$member_roles

array ilParticipant::$member_roles = []

private

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

$members

bool ilParticipant::$members = false

private

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

Referenced by isMember().

$numMembers

int ilParticipant::$numMembers = null

private

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

Referenced by getNumberOfMembers().

$obj_id

int ilParticipant::$obj_id = 0

private

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

$objectDataCache

ilObjectDataCache ilParticipant::$objectDataCache

protected

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

$participants

bool ilParticipant::$participants = false

private

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

Referenced by isAssigned(), and isParticipant().

$participants_status

array ilParticipant::$participants_status = array()

private

Definition at line 48 of file class.ilParticipant.php.

$rbacAdmin

ilRbacAdmin ilParticipant::$rbacAdmin

protected

Definition at line 53 of file class.ilParticipant.php.

$rbacReview

ilRbacReview ilParticipant::$rbacReview

protected

Definition at line 52 of file class.ilParticipant.php.

$recommended_content_manager

ilRecommendedContentManager ilParticipant::$recommended_content_manager

protected

Definition at line 50 of file class.ilParticipant.php.

$ref_id

int ilParticipant::$ref_id = 0

private

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

$role_data

array ilParticipant::$role_data = []

private

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

$roles

array ilParticipant::$roles = []

private

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

$tutors

bool ilParticipant::$tutors = false

private

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

Referenced by isTutor().

$type

string ilParticipant::$type = ''

protected

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

$usr_id

int ilParticipant::$usr_id = 0

private

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

Referenced by getUserId().

MEMBERSHIP_ADMIN

const ilParticipant::MEMBERSHIP_ADMIN = 1

protected

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

MEMBERSHIP_MEMBER

const ilParticipant::MEMBERSHIP_MEMBER = 3

protected

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

MEMBERSHIP_TUTOR

const ilParticipant::MEMBERSHIP_TUTOR = 2

protected

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

---

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

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