Handles shared calendars. More...

Collaboration diagram for ilCalendarShared:

Public Member Functions
	__construct (int $a_calendar_id)

	getCalendarId ()

	getShared ()

	getUsers ()

	getRoles ()

	isShared (int $a_obj_id)

	isEditableForUser (int $a_user_id)

	share (int $a_obj_id, int $a_type, bool $a_writable=false)

	stopSharing (int $a_obj_id)

Static Public Member Functions
static	deleteByCalendar (int $a_cal_id)

static	deleteByUser (int $a_user_id)
	Delete all entries for a specific user. More...

static	isSharedWithUser (int $a_usr_id, int $a_calendar_id)
	is shared with user More...

static	getSharedCalendarsForUser (int $a_usr_id=0)

Data Fields
const	TYPE_USR = 1

const	TYPE_ROLE = 2

Protected Member Functions
	read ()

Protected Attributes
ilDBInterface	$db

ilRbacReview	$rbacreview

Private Attributes
int	$calendar_id

array	$shared = array()

array	$shared_users = array()

array	$shared_roles = array()

Detailed Description

Handles shared calendars.

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.ilCalendarShared.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarShared::__construct ( int $a_calendar_id )

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

    {
        global $DIC;
 
        $this->calendar_id = $a_calendar_id;
        $this->db = $DIC->database();
        $this->rbacreview = $DIC->rbac()->review();
        $this->read();
    }

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ deleteByCalendar()

static ilCalendarShared::deleteByCalendar ( int $a_cal_id )

static

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

                                                          : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $query = "DELETE FROM cal_shared WHERE cal_id = " . $ilDB->quote($a_cal_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $res.

◆ deleteByUser()

static ilCalendarShared::deleteByUser ( int $a_user_id )

static

Delete all entries for a specific user.

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

                                                       : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $query = "DELETE FROM cal_shared WHERE obj_id = " . $ilDB->quote($a_user_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $res.

◆ getCalendarId()

ilCalendarShared::getCalendarId ( )

Definition at line 155 of file class.ilCalendarShared.php.

                                   : int
    {
        return $this->calendar_id;
    }

References $calendar_id.

Referenced by read(), share(), and stopSharing().

Here is the caller graph for this function:

◆ getRoles()

ilCalendarShared::getRoles ( )

Definition at line 170 of file class.ilCalendarShared.php.

                              : array
    {
        return $this->shared_roles;
    }

References $shared_roles.

◆ getShared()

ilCalendarShared::getShared ( )

Definition at line 160 of file class.ilCalendarShared.php.

                               : array
    {
        return $this->shared;
    }

References $shared.

◆ getSharedCalendarsForUser()

static ilCalendarShared::getSharedCalendarsForUser ( int $a_usr_id = 0 )

static

Definition at line 106 of file class.ilCalendarShared.php.

                                                                       : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $ilUser = $DIC['ilUser'];
        $rbacreview = $DIC['rbacreview'];
 
        if (!$a_usr_id) {
            $a_usr_id = $ilUser->getId();
        }
 
        $query = "SELECT * FROM cal_shared " .
            "WHERE obj_type = " . $ilDB->quote(self::TYPE_USR, 'integer') . " " .
            "AND obj_id = " . $ilDB->quote($a_usr_id, 'integer') . " " .
            "ORDER BY create_date";
        $res = $ilDB->query($query);
        $calendars = array();
        $shared = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $calendars[] = (int) $row->cal_id;
 
            $shared[(int) $row->cal_id]['cal_id'] = (int) $row->cal_id;
            $shared[(int) $row->cal_id]['create_date'] = (string) $row->create_date;
            $shared[(int) $row->cal_id]['obj_type'] = (string) $row->obj_type;
        }
 
        $assigned_roles = $rbacreview->assignedRoles($ilUser->getId());
 
        $query = "SELECT * FROM cal_shared " .
            "WHERE obj_type = " . $ilDB->quote(self::TYPE_ROLE, 'integer') . " " .
            "AND " . $ilDB->in('obj_id', $assigned_roles, false, 'integer');
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if (in_array($row->cal_id, $calendars)) {
                continue;
            }
            if (ilCalendarCategories::_isOwner($ilUser->getId(), (int) $row->cal_id)) {
                continue;
            }
 
            $shared[(int) $row->cal_id]['cal_id'] = (int) $row->cal_id;
            $shared[(int) $row->cal_id]['create_date'] = (string) $row->create_date;
            $shared[(int) $row->cal_id]['obj_type'] = (string) $row->obj_type;
        }
        return $shared;
    }

References $DIC, $ilDB, $rbacreview, $res, $shared, ilCalendarCategories\_isOwner(), ilRbacReview\assignedRoles(), ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilCalendarSharedStatus\getOpenInvitations(), ilCalendarCategoryGUI\invitations(), and ilCalendarCategoryGUI\readPermissions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUsers()

ilCalendarShared::getUsers ( )

Definition at line 165 of file class.ilCalendarShared.php.

                              : array
    {
        return $this->shared_users;
    }

References $shared_users.

◆ isEditableForUser()

ilCalendarShared::isEditableForUser ( int $a_user_id )

Definition at line 180 of file class.ilCalendarShared.php.

                                                     : bool
    {
        foreach ($this->shared as $info) {
            if (!$info['writable']) {
                continue;
            }
 
            switch ($info['obj_type']) {
                case self::TYPE_USR:
                    if ($info['obj_id'] == $a_user_id) {
                        return true;
                    }
                    break;
 
                case self::TYPE_ROLE:
                    if ($this->rbacreview->isAssigned($a_user_id, $info['obj_id'])) {
                        return true;
                    }
                    break;
            }
        }
        return false;
    }

References $info, TYPE_ROLE, and TYPE_USR.

◆ isShared()

ilCalendarShared::isShared ( int $a_obj_id )

Definition at line 175 of file class.ilCalendarShared.php.

                                           : bool
    {
        return isset($this->shared[$a_obj_id]);
    }

Referenced by share(), and stopSharing().

Here is the caller graph for this function:

◆ isSharedWithUser()

static ilCalendarShared::isSharedWithUser	(	int	$a_usr_id,
		int	$a_calendar_id
	)

static

is shared with user

Definition at line 74 of file class.ilCalendarShared.php.

                                                                              : bool
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        $rbacreview = $DIC['rbacreview'];
 
        $query = 'SELECT * FROM cal_shared ' .
            "WHERE cal_id = " . $ilDB->quote($a_calendar_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $obj_ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_ids[(int) $row->obj_id] = (string) $row->obj_type;
        }
        $assigned_roles = $rbacreview->assignedRoles($a_usr_id);
        foreach ($obj_ids as $id => $type) {
            switch ($type) {
                case self::TYPE_USR:
                    if ($a_usr_id == $id) {
                        return true;
                    }
                    break;
                case self::TYPE_ROLE:
                    if (in_array($id, $assigned_roles)) {
                        return true;
                    }
                    break;
            }
        }
        return false;
    }

References $DIC, $id, $ilDB, $rbacreview, $res, ilRbacReview\assignedRoles(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), TYPE_ROLE, and TYPE_USR.

Referenced by ilCalendarCategoryGUI\acceptShared(), ilCalendarCategoryGUI\declineShared(), and ilCalendarCategoryGUI\unshare().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilCalendarShared::read ( )

protected

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

                             : void
    {
        $this->shared = $this->shared_users = $this->shared_roles = array();
        $query = "SELECT * FROM cal_shared WHERE cal_id = " . $this->db->quote($this->getCalendarId(), 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            switch ($row->obj_type) {
                case self::TYPE_USR:
                    $this->shared_users[(int) $row->obj_id]['obj_id'] = (int) $row->obj_id;
                    $this->shared_users[(int) $row->obj_id]['obj_type'] = (string) $row->obj_type;
                    $this->shared_users[(int) $row->obj_id]['create_date'] = (string) $row->create_date;
                    $this->shared_users[(int) $row->obj_id]['writable'] = (bool) $row->writable;
                    break;
 
                case self::TYPE_ROLE:
                    $this->shared_roles[(int) $row->obj_id]['obj_id'] = (int) $row->obj_id;
                    $this->shared_roles[(int) $row->obj_id]['obj_type'] = (string) $row->obj_type;
                    $this->shared_roles[(int) $row->obj_id]['create_date'] = (string) $row->create_date;
                    $this->shared_roles[(int) $row->obj_id]['writable'] = (bool) $row->writable;
                    break;
            }
 
            $this->shared[(int) $row->obj_id]['obj_id'] = (int) $row->obj_id;
            $this->shared[(int) $row->obj_id]['obj_type'] = (string) $row->obj_type;
            $this->shared[(int) $row->obj_id]['create_date'] = (string) $row->create_date;
            $this->shared[(int) $row->obj_id]['writable'] = (bool) $row->writable;
        }
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, getCalendarId(), ILIAS\Repository\int(), TYPE_ROLE, and TYPE_USR.

Referenced by __construct(), share(), and stopSharing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ share()

ilCalendarShared::share	(	int	$a_obj_id,
		int	$a_type,
		bool	$a_writable = `false`
	)

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

                                                                               : void
    {
        if ($this->isShared($a_obj_id)) {
            return;
        }
        $query = "INSERT INTO cal_shared (cal_id,obj_id,obj_type,create_date,writable) " .
            "VALUES ( " .
            $this->db->quote($this->getCalendarId(), 'integer') . ", " .
            $this->db->quote($a_obj_id, 'integer') . ", " .
            $this->db->quote($a_type, 'integer') . ", " .
            $this->db->now() . ", " .
            $this->db->quote((int) $a_writable, 'integer') . ' ' .
            ")";
 
        $res = $this->db->manipulate($query);
        $this->read();
    }

References $res, getCalendarId(), isShared(), and read().

Here is the call graph for this function:

◆ stopSharing()

ilCalendarShared::stopSharing ( int $a_obj_id )

Definition at line 222 of file class.ilCalendarShared.php.

                                              : void
    {
        if (!$this->isShared($a_obj_id)) {
            return;
        }
        $query = "DELETE FROM cal_shared WHERE cal_id = " . $this->db->quote($this->getCalendarId(), 'integer') . " " .
            "AND obj_id = " . $this->db->quote($a_obj_id, 'integer') . " ";
        $res = $this->db->manipulate($query);
 
        ilCalendarSharedStatus::deleteStatus($a_obj_id, $this->getCalendarId());
        $this->read();
    }

References $res, ilCalendarSharedStatus\deleteStatus(), getCalendarId(), isShared(), and read().

Here is the call graph for this function:

Field Documentation

◆ $calendar_id

int ilCalendarShared::$calendar_id

private

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

Referenced by getCalendarId().

◆ $db

ilDBInterface ilCalendarShared::$db

protected

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

◆ $rbacreview

ilRbacReview ilCalendarShared::$rbacreview

protected

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

Referenced by getSharedCalendarsForUser(), and isSharedWithUser().

◆ $shared

array ilCalendarShared::$shared = array()

private

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

Referenced by getShared(), and getSharedCalendarsForUser().

◆ $shared_roles

array ilCalendarShared::$shared_roles = array()

private

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

Referenced by getRoles().

◆ $shared_users

array ilCalendarShared::$shared_users = array()

private

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

Referenced by getUsers().

◆ TYPE_ROLE

const ilCalendarShared::TYPE_ROLE = 2

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

Referenced by isEditableForUser(), isSharedWithUser(), ilCalendarSharedListTableGUI\parse(), read(), and ilCalendarCategoryGUI\shareAssignRoles().

◆ TYPE_USR

const ilCalendarShared::TYPE_USR = 1

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

Referenced by isEditableForUser(), isSharedWithUser(), ilCalendarSharedListTableGUI\parse(), read(), and ilCalendarCategoryGUI\shareAssign().

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

components/ILIAS/Calendar/classes/class.ilCalendarShared.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteByCalendar()

◆ deleteByUser()

◆ getCalendarId()

◆ getRoles()

◆ getShared()

◆ getSharedCalendarsForUser()

◆ getUsers()

◆ isEditableForUser()

◆ isShared()

◆ isSharedWithUser()

◆ read()

◆ share()

◆ stopSharing()

Field Documentation

◆ $calendar_id

◆ $db

◆ $rbacreview

◆ $shared

◆ $shared_roles

◆ $shared_users

◆ TYPE_ROLE

◆ TYPE_USR