ilParticipant Class Reference

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

Inheritance diagram for ilParticipant:

Collaboration diagram for ilParticipant:

Public Member Functions
	getUserId ()
	get user id More...
	isBlocked ()
	isContact ()
	Check if user is contact for current object. More...
	isAssigned ()
	isMember ()
	isAdmin ()
	isTutor ()
	isParticipant ()
	getNumberOfMembers ()
	add ($a_usr_id, $a_role)
	Add user to course/group. More...
	delete ($a_usr_id)
	Drop user from all roles. More...
	deleteSubscriber ($a_usr_id)
	Delete subsciber. More...
	addRecommendation ($a_usr_id)
	Add desktop item. More...
	updateContact ($a_usr_id, $a_contact)
	ilDB $ilDB More...
	updateNotification ($a_usr_id, $a_notification)
	Update notification status. More...
	checkLastAdmin ($a_usr_ids)
	Check if user for deletion are last admins. More...

Static Public Member Functions
static	updateMemberRoles ($a_obj_id, $a_usr_id, $a_role_id, $a_status)
	Update member roles ilDB $ilDB. More...
static	getMembershipRoleType ($a_role_id)
static	lookupStatusByMembershipRoleType ($a_obj_id, $a_usr_id, $a_membership_role_type)
	lookup assignment status ilDB $ilDB More...

Data Fields
const	MEMBERSHIP_ADMIN = 1
const	MEMBERSHIP_TUTOR = 2
const	MEMBERSHIP_MEMBER = 3

Protected Member Functions
	__construct ($a_component_name, $a_obj_id, $a_usr_id)
	Singleton Constructor. More...
	getComponent ()
	Get component name Used for event handling. More...
	readParticipant ()
	Read participant. More...
	readParticipantStatus ()
	Read participant status ilDB $ilDB. More...

Protected Attributes
	$type = ''
	$recommended_content_manager

Private Attributes
	$obj_id = 0
	$usr_id = 0
	$ref_id = 0
	$component = ''
	$participants = false
	$admins = false
	$tutors = false
	$members = false
	$numMembers = null
	$member_roles = []
	$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 34 of file class.ilParticipant.php.

Constructor & Destructor Documentation

__construct()

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

protected

Singleton Constructor.

protected

Parameters

int	obj_id of container

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
        
        $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->readParticipant();
        $this->readParticipantStatus();
    }

Here is the call graph for this function:

Member Function Documentation

add()

ilParticipant::add	(		$a_usr_id,
			$a_role
	)

Add user to course/group.

public

Parameters

int	user id
int	role IL_CRS_ADMIN || IL_CRS_TUTOR || IL_CRS_MEMBER

global ilRbacReview $rbacreview

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

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

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $ilLog = $DIC->logger()->mmbr();
        $ilAppEventHandler = $DIC['ilAppEventHandler'];
        $rbacreview = $DIC['rbacreview'];
        

        if ($rbacreview->isAssignedToAtLeastOneGivenRole($a_usr_id, $this->roles)) {
            return false;
        }
        
        switch ($a_role) {
            case IL_CRS_ADMIN:
                $this->admins = true;
                break;

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

            case IL_CRS_MEMBER:
                $this->members = true;
                break;
                
            case IL_GRP_ADMIN:
                $this->admins = true;
                break;
                
            case IL_GRP_MEMBER:
                $this->members = true;
                break;
        }

        $rbacadmin->assignUser($this->role_data[$a_role], $a_usr_id);
        $this->addRecommendation($a_usr_id);
        
        // Delete subscription request
        $this->deleteSubscriber($a_usr_id);
        
        include_once './Services/Membership/classes/class.ilWaitingList.php';
        ilWaitingList::deleteUserEntry($a_usr_id, $this->obj_id);

        $ilLog->debug(': Raise new event: ' . $this->getComponent() . ' addParticipant');
        $ilAppEventHandler->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

)

Add desktop item.

public

Parameters

int

usr_id

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

Referenced by add().

    {
        // 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);
        return true;
    }

Here is the caller graph for this function:

checkLastAdmin()

ilParticipant::checkLastAdmin

(

$a_usr_ids

)

Check if user for deletion are last admins.

public

Parameters

array

array of user ids for deletion

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

References $data, $DIC, $ilDB, $query, $res, IL_CRS_ADMIN, and IL_GRP_ADMIN.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $admin_role_id =
            $this->type == 'crs' ?
            $this->role_data[IL_CRS_ADMIN] :
            $this->role_data[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 ' . $ilDB->in('rolesusers.usr_id', $a_usr_ids, true, 'integer');
        $res = $ilDB->queryF($query, array('integer'), array($admin_role_id));

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

delete()

ilParticipant::delete

(

$a_usr_id

)

Drop user from all roles.

public

Parameters

int

usr_id

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

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

    {
        global $DIC;

        $rbacadmin = $DIC['rbacadmin'];
        $ilDB = $DIC['ilDB'];
        $ilAppEventHandler = $DIC['ilAppEventHandler'];

        $this->recommended_content_manager->removeObjectRecommendation($a_usr_id, $this->ref_id);

        foreach ($this->roles as $role_id) {
            $rbacadmin->deassignUser($role_id, $a_usr_id);
        }
        
        $query = "DELETE FROM obj_members " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($this->obj_id, 'integer');
        $res = $ilDB->manipulate($query);
        
        $ilAppEventHandler->raise(
            $this->getComponent(),
            "deleteParticipant",
            array(
                    'obj_id' => $this->obj_id,
                    'usr_id' => $a_usr_id)
        );
        return true;
    }

Here is the call graph for this function:

deleteSubscriber()

ilParticipant::deleteSubscriber

(

$a_usr_id

)

Delete subsciber.

public

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

References $DIC, $ilDB, $query, and $res.

Referenced by add().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

        return true;
    }

Here is the caller graph for this function:

getComponent()

ilParticipant::getComponent ( )

protected

Get component name Used for event handling.

Returns

type

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

References $component.

Referenced by add(), and delete().

    {
        return $this->component;
    }

Here is the caller graph for this function:

getMembershipRoleType()

static ilParticipant::getMembershipRoleType (   $a_role_id )

static

Parameters

type

$a_role_id

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

References ilObject\_lookupTitle().

    {
        $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 290 of file class.ilParticipant.php.

References $DIC, and $numMembers.

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];

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

getUserId()

ilParticipant::getUserId

(

)

get user id

Returns

int

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

References $usr_id.

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

    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

isAdmin()

ilParticipant::isAdmin

(

)

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

References $admins.

    {
        return $this->admins;
    }

isAssigned()

ilParticipant::isAssigned

(

)

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

References $participants.

    {
        return (bool) $this->participants;
    }

isBlocked()

ilParticipant::isBlocked

(

)

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

References getUserId().

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

Here is the call graph for this function:

isContact()

ilParticipant::isContact

(

)

Check if user is contact for current object.

Returns

bool

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

References getUserId().

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

Here is the call graph for this function:

isMember()

ilParticipant::isMember

(

)

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

References $members.

    {
        return (bool) $this->members;
    }

isParticipant()

ilParticipant::isParticipant

(

)

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

References $participants.

    {
        return (bool) $this->participants;
    }

isTutor()

ilParticipant::isTutor

(

)

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

References $tutors.

    {
        return (bool) $this->tutors;
    }

lookupStatusByMembershipRoleType()

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

static

lookup assignment status ilDB $ilDB

Parameters

type	$a_obj_id
type	$a_usr_id
type	$a_membership_role_type

Returns

int

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = 'SELECT * FROM obj_members ' .
                'WHERE obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($a_usr_id) . ' ';
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            switch ($a_membership_role_type) {
                case self::MEMBERSHIP_ADMIN:
                    return $row->admin;
                    
                case self::MEMBERSHIP_TUTOR:
                    return $row->tutor;
                    
                case self::MEMBERSHIP_MEMBER:
                    return $row->member;
            }
        }
        return 0;
    }

readParticipant()

ilParticipant::readParticipant ( )

protected

Read participant.

Returns

void

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

References $DIC, IL_CRS_ADMIN, IL_CRS_MEMBER, IL_CRS_TUTOR, IL_GRP_ADMIN, and IL_GRP_MEMBER.

Referenced by __construct().

    {
        global $DIC;

        $rbacreview = $DIC['rbacreview'];
        $ilObjDataCache = $DIC['ilObjDataCache'];

        $this->roles = $rbacreview->getRolesOfRoleFolder($this->ref_id, false);

        $users = array();
        $this->participants = array();
        $this->members = $this->admins = $this->tutors = array();
        $this->member_roles = [];

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

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

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

                case 'il_grp_a':
                    $this->role_data[IL_GRP_ADMIN] = $role_id;
                    if ($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[IL_GRP_MEMBER] = $role_id;
                    if ($rbacreview->isAssigned($this->getUserId(), $role_id)) {
                        $this->participants = true;
                        $this->members = true;
                    }
                    break;

                default:

                    $this->member_roles[] = $role_id;
                    if ($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

Read participant status ilDB $ilDB.

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

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

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

        $res = $ilDB->query($query);
        $this->participants_status = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->participants_status[$this->getUserId()]['blocked'] = $row->blocked;
            $this->participants_status[$this->getUserId()]['notification'] = $row->notification;
            $this->participants_status[$this->getUserId()]['passed'] = $row->passed;
            // cognos-blu-patch: begin
            $this->participants_status[$this->getUserId()]['contact'] = $row->contact;
            // cognos-blu-patch: end
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateContact()

ilParticipant::updateContact	(		$a_usr_id,
			$a_contact
	)

ilDB $ilDB

Parameters

type	$a_usr_id
type	$a_contact

Returns

boolean

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

References $DIC, and $ilDB.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $ilDB->manipulate(
            'UPDATE obj_members SET ' .
                'contact = ' . $ilDB->quote($a_contact, 'integer') . ' ' .
                'WHERE obj_id = ' . $ilDB->quote($this->obj_id, 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($a_usr_id, 'integer')
        );
        
        $this->participants_status[$a_usr_id]['contact'] = $a_contact;
        return true;
    }

updateMemberRoles()

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

static

Update member roles ilDB $ilDB.

Parameters

type	$a_obj_id
type	$a_role_id
type	$a_status

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

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

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

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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	(		$a_usr_id,
			$a_notification
	)

Update notification status.

public

Parameters

int	usr_id
bool	passed

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

References $DIC, $ilDB, $query, and $res.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->participants_status[$a_usr_id]['notification'] = (int) $a_notification;

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

Field Documentation

$admins

ilParticipant::$admins = false

private

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

Referenced by isAdmin().

$component

ilParticipant::$component = ''

private

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

Referenced by getComponent().

$member_roles

ilParticipant::$member_roles = []

private

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

$members

ilParticipant::$members = false

private

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

Referenced by isMember().

$numMembers

ilParticipant::$numMembers = null

private

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

Referenced by getNumberOfMembers().

$obj_id

ilParticipant::$obj_id = 0

private

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

$participants

ilParticipant::$participants = false

private

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

Referenced by isAssigned(), and isParticipant().

$participants_status

ilParticipant::$participants_status = array()

private

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

$recommended_content_manager

ilParticipant::$recommended_content_manager

protected

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

$ref_id

ilParticipant::$ref_id = 0

private

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

$tutors

ilParticipant::$tutors = false

private

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

Referenced by isTutor().

$type

ilParticipant::$type = ''

protected

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

$usr_id

ilParticipant::$usr_id = 0

private

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

Referenced by getUserId().

MEMBERSHIP_ADMIN

const ilParticipant::MEMBERSHIP_ADMIN = 1

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

MEMBERSHIP_MEMBER

const ilParticipant::MEMBERSHIP_MEMBER = 3

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

MEMBERSHIP_TUTOR

const ilParticipant::MEMBERSHIP_TUTOR = 2

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

---

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

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