This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilBookingParticipant:

Public Member Functions
	__construct (int $a_user_id, int $a_booking_pool_id)

	getIsNew ()

Static Public Member Functions
static	getAssignableParticipants (int $a_bp_object_id)
	Get participants who can not have a reservation for this booking pool object id. More...

static	getList (int $a_booking_pool, array $a_filter=null, int $a_object_id=null)

static	getBookingPoolParticipants (int $a_booking_pool_id)
	Get all participants for a booking pool. More...

static	getUserFilter (int $a_pool_id)
	Get user data from db for an specific pool id. More...

Protected Member Functions
	read ()

	save ()

	isParticipantAssigned (int $a_booking_object_id, int $a_participant_id)
	Returns true if the participant has a reservation for this object. More...

Protected Attributes
ILIAS BookingManager InternalDomainService	$domain

ilLanguage	$lng

ilDBInterface	$db

int	$participant_id

int	$booking_pool_id

bool	$is_new

ilObjUser	$user

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Todo:: split up to manager and repo class

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingParticipant::__construct	(	int	$a_user_id,
		int	$a_booking_pool_id
	)

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

References $DIC, ilObject\_exists(), ILIAS\Repository\lng(), read(), save(), and ILIAS\Repository\user().

       {
         global $DIC;
 
         if (!ilObjUser::_exists($a_user_id)) {
             throw new ilException("User $a_user_id does not exist.");
         }
         if (!ilObjBookingPool::_exists($a_booking_pool_id)) {
             throw new ilException("Booking Pool $a_booking_pool_id does not exist.");
         }
 
         $this->lng = $DIC->language();
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->domain = $DIC->bookingManager()->internal()->domain();
 
         $this->participant_id = $a_user_id;
         $this->booking_pool_id = $a_booking_pool_id;
 
         // if read and not exists, store it in db.
         if (!$this->read()) {
             $this->save();
             $this->is_new = true;
         } else {
             $this->is_new = false;
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAssignableParticipants()

static ilBookingParticipant::getAssignableParticipants ( int $a_bp_object_id )

static

Get participants who can not have a reservation for this booking pool object id.

Parameters

int $a_bp_object_id booking pool object

Returns: array formatted data to display in gui table.

Definition at line 102 of file class.ilBookingParticipant.php.

References $res, ilObjUser\_lookupName(), ilBookingReservation\getMembersWithoutReservation(), ILIAS\Repository\int(), and ilBookingReservation\isBookingPoolLimitReachedByUser().

Referenced by ilBookingAssignParticipantsTableGUI\getItems().

      : array {
         $booking_object = new ilBookingObject($a_bp_object_id);
         $pool_id = $booking_object->getPoolId();
         $pool = new ilObjBookingPool($pool_id, false);
         $overall_limit = (int) $pool->getOverallLimit();
 
         $res = array();
 
         $members = ilBookingReservation::getMembersWithoutReservation($a_bp_object_id);
 
         foreach ($members as $member_id) {
             //check if the user reached the limit of booking in this booking pool.
             $total_reservations = ilBookingReservation::isBookingPoolLimitReachedByUser($member_id, $pool_id);
 
             if ($overall_limit === 0 || ($overall_limit > 0 && $total_reservations < $overall_limit)) {
                 $user_name = ilObjUser::_lookupName($member_id);
                 $name = $user_name['lastname'] . ", " . $user_name['firstname'];
                 $index = $a_bp_object_id . "_" . $member_id;
 
                 if (!isset($res[$index])) {
                     $res[$index] = array(
                         "user_id" => $member_id,
                         "object_title" => array($booking_object->getTitle()),
                         "name" => $name
                     );
                 } elseif (!in_array($booking_object->getTitle(), $res[$index]['object_title'], true)) {
                     $res[$index]['object_title'][] = $booking_object->getTitle();
                 }
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getBookingPoolParticipants()

static ilBookingParticipant::getBookingPoolParticipants ( int $a_booking_pool_id )

static

Get all participants for a booking pool.

Returns: int[]

Definition at line 224 of file class.ilBookingParticipant.php.

References $DIC, $ilDB, and $res.

      : array {
         global $DIC;
         $ilDB = $DIC->database();
         $sql = 'SELECT * FROM booking_member WHERE booking_pool_id = ' . $ilDB->quote($a_booking_pool_id, 'integer');
 
         $set = $ilDB->query($sql);
 
         $res = array();
         while ($row = $ilDB->fetchAssoc($set)) {
             $res[] = $row['user_id'];
         }
 
         return $res;
     }

◆ getIsNew()

ilBookingParticipant::getIsNew ( )

Definition at line 92 of file class.ilBookingParticipant.php.

References $is_new.

                               : bool
     {
         return $this->is_new;
     }

◆ getList()

static ilBookingParticipant::getList	(	int	$a_booking_pool,
		array	$a_filter = `null`,
		int	$a_object_id = `null`
	)

static

Definition at line 138 of file class.ilBookingParticipant.php.

References $DIC, $ilDB, $res, ilObjUser\_lookupName(), ILIAS\Repository\int(), and ilBookingReservation\STATUS_CANCELLED.

Referenced by ilBookingAssignParticipantsTableGUI\getItems(), and ilBookingParticipantsTableGUI\getItems().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
         $domain = $DIC->bookingManager()->internal()->domain();
 
         $res = array();
 
         $query = 'SELECT bm.user_id, bm.booking_pool_id, br.object_id, bo.title, br.status' .
             ' FROM booking_member bm' .
             ' LEFT JOIN booking_reservation br ON (bm.user_id = br.user_id)' .
             ' LEFT JOIN booking_object bo ON (br.object_id = bo.booking_object_id AND bo.pool_id = ' . $ilDB->quote($a_booking_pool, 'integer') . ')';
 
         $where = array('bm.booking_pool_id =' . $ilDB->quote($a_booking_pool, 'integer'));
         if ($a_object_id) {
             $where[] = 'br.object_id = ' . $ilDB->quote($a_object_id, 'integer');
         }
         if ($a_filter['title'] ?? false) {
             $where[] = '(' . $ilDB->like('title', 'text', '%' . $a_filter['title'] . '%') .
                 ' OR ' . $ilDB->like('description', 'text', '%' . $a_filter['title'] . '%') . ')';
         }
         if ($a_filter['user_id'] ?? false) {
             $where[] = 'bm.user_id = ' . $ilDB->quote($a_filter['user_id'], 'integer');
         }
 
         $query .= ' WHERE ' . implode(' AND ', $where);
 
         $set = $ilDB->query($query);
 
         while ($row = $ilDB->fetchAssoc($set)) {
             $status = $row['status'];
             //Nothing to show if the status is canceled when filtering by object
             if ($status == ilBookingReservation::STATUS_CANCELLED && $a_object_id) {
                 continue;
             }
 
             if (!$domain->profile()->exists((int) $row['user_id'])) {
                 continue;
             }
 
             $user_name = ilObjUser::_lookupName($row['user_id']);
             $name = $user_name['lastname'] . ", " . $user_name['firstname'];
             $index = $a_booking_pool . "_" . $row['user_id'];
 
             $title = (string) ($row['title'] ?? '');
             $object_id = (int) ($row['object_id'] ?? -1);
             if (!isset($res[$index])) {
                 $res[$index] = ['object_title' => [], 'obj_count' => 0, 'object_ids' => [], 'name' => $name];
 
                 if (
                     $status !== ilBookingReservation::STATUS_CANCELLED
                     && $title !== ''
                     && $object_id !== -1
                 ) {
                     $res[$index]['object_title'] = [$title];
                     $res[$index]['obj_count'] = 1;
                     $res[$index]['object_ids'][] = $object_id;
                 }
             } elseif ($title !== '' && (!in_array($title, $res[$index]['object_title'], true) && $status !== ilBookingReservation::STATUS_CANCELLED)) {
                 $res[$index]['object_title'][] = $title;
                 if (!isset($res[$index]['obj_count'])) {
                     $res[$index]['obj_count'] = 0;
                 }
                 $res[$index]['obj_count'] += 1;
                 $res[$index]['object_ids'][] = $object_id;
             }
             $res[$index]['user_id'] = $row['user_id'];
         }
 
         foreach ($res as $index => $val) {
             if (isset($row['object_id'])) {
                 $res[$index]['object_ids'][] = $row['object_id'];
             }
         }
 
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserFilter()

static ilBookingParticipant::getUserFilter ( int $a_pool_id )

static

Get user data from db for an specific pool id.

Returns: string[]

Definition at line 245 of file class.ilBookingParticipant.php.

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

Referenced by ilBookingParticipantsTableGUI\initFilter().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $res = [];
 
         $sql = "SELECT ud.usr_id,ud.lastname,ud.firstname,ud.login" .
             " FROM usr_data ud " .
             " RIGHT JOIN booking_member m ON (ud.usr_id = m.user_id)" .
             " WHERE ud.usr_id <> " . $ilDB->quote(ANONYMOUS_USER_ID, "integer") .
             " AND m.booking_pool_id = " . $ilDB->quote($a_pool_id, "integer") .
             " ORDER BY ud.lastname,ud.firstname";
 
         $set = $ilDB->query($sql);
         while ($row = $ilDB->fetchAssoc($set)) {
             $res[$row["usr_id"]] = $row["lastname"] . ", " . $row["firstname"] .
                 " (" . $row["login"] . ")";
         }
 
         return $res;
     }

Here is the caller graph for this function:

◆ isParticipantAssigned()

ilBookingParticipant::isParticipantAssigned	(	int	$a_booking_object_id,
		int	$a_participant_id
	)

protected

Returns true if the participant has a reservation for this object.

Definition at line 273 of file class.ilBookingParticipant.php.

References ilBookingReservation\getObjectReservationForUser().

      : bool {
         return count(ilBookingReservation::getObjectReservationForUser($a_booking_object_id, $a_participant_id)) > 0;
     }

Here is the call graph for this function:

◆ read()

ilBookingParticipant::read ( )

protected

Definition at line 63 of file class.ilBookingParticipant.php.

Referenced by __construct().

                              : ?int
     {
         $query = 'SELECT participant_id FROM booking_member' .
             ' WHERE user_id = ' . $this->db->quote($this->participant_id, 'integer') .
             ' AND booking_pool_id = ' . $this->db->quote($this->booking_pool_id, 'integer');
 
         $set = $this->db->query($query);
         $row = $this->db->fetchAssoc($set);
         if (empty($row)) {
             return null;
         }
         return (int) $row['participant_id'];
     }

Here is the caller graph for this function:

◆ save()

ilBookingParticipant::save ( )

protected

Definition at line 77 of file class.ilBookingParticipant.php.

References ILIAS\Repository\user().

Referenced by __construct().

                              : void
     {
         $assigner_id = $this->user->getId();
         $next_id = $this->db->nextId('booking_member');
 
         $query = 'INSERT INTO booking_member' .
             ' (participant_id, user_id, booking_pool_id, assigner_user_id)' .
             ' VALUES (' . $this->db->quote($next_id, 'integer') .
             ',' . $this->db->quote($this->participant_id, 'integer') .
             ',' . $this->db->quote($this->booking_pool_id, 'integer') .
             ',' . $this->db->quote($assigner_id, 'integer') . ')';
 
         $this->db->manipulate($query);
     }