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

Collaboration diagram for ilBookingEntry:

Public Member Functions
	__construct (int $a_booking_id=0)
	Constructor. More...

	getId ()

	setObjId (int $a_id)

	getObjId ()

	setDeadlineHours (int $a_hours)

	getDeadlineHours ()

	setNumberOfBookings (int $a_num)

	getNumberOfBookings ()

	setTargetObjIds (?array $a_obj_id)

	getTargetObjIds ()

	isTargetObjectVisible (int $a_ref_id)
	Check if target ref id is visible. More...

	save ()

	update ()

	delete ()

	isOwner (?int $a_user_id=null)
	check if current (or given) user is entry owner More...

	getCurrentNumberOfBookings (int $a_entry_id)
	get current number of bookings More...

	getCurrentBookings (int $a_entry_id)
	get current bookings More...

	hasBooked (int $a_entry_id, ?int $a_user_id=null)
	get current number of bookings More...

	isBookedOut (int $a_entry_id, bool $a_check_current_user=false)
	get current number of bookings More...

	isAppointmentBookableForUser (int $a_app_id, int $a_user_id)
	Check if a calendar appointment is bookable for a specific user. More...

	book (int $a_entry_id, ?int $a_user_id=null)
	book calendar entry for user More...

	cancelBooking (int $a_entry_id, ?int $a_user_id=null)
	cancel calendar booking for user More...

	deleteBooking (int $a_entry_id, int $a_user_id)
	Delete booking. More...

Static Public Member Functions
static	lookupBookingsOfUser (array $a_app_ids, int $a_usr_id, ?ilDateTime $start=null)
	Lookup bookings of user. More...

static	removeObsoleteEntries ()
	Remove unused booking entries. More...

static	getInstanceByCalendarEntryId (int $a_id)
	Get instance by calendar entry. More...

static	isBookable (array $a_obj_ids, ?int $a_target_obj_id=null)
	Which objects are bookable? More...

static	lookupBookableUsersForObject (array $a_obj_id, array $a_user_ids)
	Consultation hours are offered if 1) consultation hour owner is admin or tutor and no object assignment 2) object is assigned to consultation hour. More...

static	hasObjectBookingEntries (int $a_obj_id, int $a_usr_id)
	Check if object has assigned consultation hour appointments. More...

static	lookupBookingMessage (int $a_entry_id, int $a_usr_id)

static	writeBookingMessage (int $a_entry_id, int $a_usr_id, string $a_message)
	Write booking message. More...

static	lookupBookingsForAppointment (int $a_app_id)
	Lookup booked users for appointment. More...

static	lookupBookingsForObject (int $a_obj_id, int $a_usr_id)
	Lookup booking for an object and user. More...

static	lookupManagedBookingsForObject (int $a_obj_id, int $a_usr_id)
	Lookup bookings for own and managed consultation hours of an object. More...

Protected Member Functions
	setId (int $a_id)

	read ()

Protected Attributes
ilDBInterface	$db

ilObjUser	$user

Private Attributes
int	$id = 0

int	$obj_id = 0

int	$deadline = 0

int	$num_bookings = 1

array	$target_obj_ids = []

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 Booking definition

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingEntry::__construct ( int $a_booking_id = 0 )

Constructor.

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

References $DIC, getId(), read(), setId(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $this->setId($a_booking_id);
         if ($this->getId()) {
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ book()

ilBookingEntry::book	(	int	$a_entry_id,
		?int	$a_user_id = `null`
	)

book calendar entry for user

Definition at line 609 of file class.ilBookingEntry.php.

References hasBooked(), and ILIAS\Repository\user().

                                                                  : bool
     {
         if (!$a_user_id) {
             $a_user_id = $this->user->getId();
         }
 
         if (!$this->hasBooked($a_entry_id, $a_user_id)) {
             $this->db->manipulate('INSERT INTO booking_user (entry_id, user_id, tstamp)' .
                 ' VALUES (' . $this->db->quote($a_entry_id, 'integer') . ',' .
                 $this->db->quote($a_user_id, 'integer') . ',' . $this->db->quote(time(), 'integer') . ')');
         }
         return true;
     }

Here is the call graph for this function:

◆ cancelBooking()

ilBookingEntry::cancelBooking	(	int	$a_entry_id,
		?int	$a_user_id = `null`
	)

cancel calendar booking for user

Definition at line 626 of file class.ilBookingEntry.php.

References ilDateTime\_before(), deleteBooking(), hasBooked(), IL_CAL_UNIX, ilCalendarMailNotification\TYPE_BOOKING_CANCELLATION, and ILIAS\Repository\user().

                                                                           : bool
     {
         if (!$a_user_id) {
             $a_user_id = $this->user->getId();
         }
 
         // @todo do not send mails about past consultation hours
         $entry = new ilCalendarEntry($a_entry_id);
 
         $past = ilDateTime::_before($entry->getStart(), new ilDateTime(time(), IL_CAL_UNIX));
         if ($this->hasBooked($a_entry_id, $a_user_id) && !$past) {
             $mail = new ilCalendarMailNotification();
             $mail->setAppointmentId($a_entry_id);
             $mail->setRecipients(array($a_user_id));
             $mail->setType(ilCalendarMailNotification::TYPE_BOOKING_CANCELLATION);
             $mail->send();
         }
         $this->deleteBooking($a_entry_id, $a_user_id);
         return true;
     }

Here is the call graph for this function:

◆ delete()

ilBookingEntry::delete ( )

Definition at line 199 of file class.ilBookingEntry.php.

References getId().

                             : void
     {
         $query = "DELETE FROM booking_entry " .
             "WHERE booking_id = " . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
         $query = 'DELETE FROM booking_obj_assignment ' .
             'WHERE booking_id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

◆ deleteBooking()

ilBookingEntry::deleteBooking	(	int	$a_entry_id,
		int	$a_user_id
	)

Delete booking.

Definition at line 650 of file class.ilBookingEntry.php.

Referenced by cancelBooking().

                                                                   : bool
     {
         $query = 'DELETE FROM booking_user ' .
             'WHERE entry_id = ' . $this->db->quote($a_entry_id, 'integer') . ' ' .
             'AND user_id = ' . $this->db->quote($a_user_id, 'integer');
         $this->db->manipulate($query);
         return true;
     }

Here is the caller graph for this function:

◆ getCurrentBookings()

ilBookingEntry::getCurrentBookings ( int $a_entry_id )

get current bookings

Parameters

int $a_entry_id

Returns: int[]

Definition at line 450 of file class.ilBookingEntry.php.

References $res, and ILIAS\Repository\int().

Referenced by ilConsultationHoursGUI\deleteAppointments(), and ilConsultationHoursGUI\sendMailToSelectedUsers().

                                                        : array
     {
         $set = $this->db->query('SELECT user_id FROM booking_user' .
             ' WHERE entry_id = ' . $this->db->quote($a_entry_id, 'integer'));
         $res = array();
         while ($row = $this->db->fetchAssoc($set)) {
             $res[] = (int) $row['user_id'];
         }
         return $res;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentNumberOfBookings()

ilBookingEntry::getCurrentNumberOfBookings ( int $a_entry_id )

get current number of bookings

Definition at line 434 of file class.ilBookingEntry.php.

Referenced by ilConsultationHoursGUI\assignUsersToAppointment(), isAppointmentBookableForUser(), and isBookedOut().

                                                                : int
     {
         $set = $this->db->query('SELECT COUNT(*) AS counter FROM booking_user' .
             ' WHERE entry_id = ' . $this->db->quote($a_entry_id, 'integer'));
         $row = $this->db->fetchAssoc($set);
         if (is_array($row)) {
             return (int) $row['counter'];
         }
         return 0;
     }

Here is the caller graph for this function:

◆ getDeadlineHours()

ilBookingEntry::getDeadlineHours ( )

Definition at line 104 of file class.ilBookingEntry.php.

References $deadline.

Referenced by ilConsultationHoursGUI\edit(), isAppointmentBookableForUser(), isBookedOut(), save(), and update().

                                       : int
     {
         return $this->deadline;
     }

Here is the caller graph for this function:

◆ getId()

ilBookingEntry::getId ( )

Definition at line 83 of file class.ilBookingEntry.php.

References $id.

Referenced by __construct(), ilConsultationHoursGUI\createAppointments(), delete(), ilConsultationHourUtils\findCalendarAppointmentsForBooking(), read(), ilConsultationHoursGUI\rewriteBookingIdsForAppointments(), save(), and update().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getInstanceByCalendarEntryId()

static ilBookingEntry::getInstanceByCalendarEntryId ( int $a_id )

static

Get instance by calendar entry.

Parameters

int $id

Returns: ilBookingEntry|null

Definition at line 282 of file class.ilBookingEntry.php.

Referenced by ilConsultationHoursGUI\assignUsersToAppointment(), ilConsultationHoursGUI\deleteAppointments(), and ilConsultationHoursGUI\rewriteBookingIdsForAppointments().

                                                                   : ?ilBookingEntry
     {
         $cal_entry = new ilCalendarEntry($a_id);
         $booking_id = $cal_entry->getContextId();
         if ($booking_id) {
             return new self($booking_id);
         }
         return null;
     }

Here is the caller graph for this function:

◆ getNumberOfBookings()

ilBookingEntry::getNumberOfBookings ( )

Definition at line 114 of file class.ilBookingEntry.php.

References $num_bookings.

Referenced by ilConsultationHoursGUI\assignUsersToAppointment(), ilConsultationHoursGUI\edit(), isAppointmentBookableForUser(), isBookedOut(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\isFiltered(), save(), and update().

                                          : int
     {
         return $this->num_bookings;
     }

Here is the caller graph for this function:

◆ getObjId()

ilBookingEntry::getObjId ( )

Definition at line 94 of file class.ilBookingEntry.php.

References $obj_id.

Referenced by isBookedOut(), isOwner(), save(), and update().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getTargetObjIds()

ilBookingEntry::getTargetObjIds ( )

Returns: int[] | null

Definition at line 130 of file class.ilBookingEntry.php.

References $target_obj_ids.

Referenced by ilConsultationHoursGUI\edit(), and isTargetObjectVisible().

                                      : ?array
     {
         return $this->target_obj_ids;
     }

Here is the caller graph for this function:

◆ hasBooked()

ilBookingEntry::hasBooked	(	int	$a_entry_id,
		?int	$a_user_id = `null`
	)

get current number of bookings

Definition at line 536 of file class.ilBookingEntry.php.

References ILIAS\Repository\user().

Referenced by book(), cancelBooking(), and isBookedOut().

                                                                       : bool
     {
         if (!$a_user_id) {
             $a_user_id = $this->user->getId();
         }
 
         $query = 'SELECT COUNT(*) AS counter FROM booking_user' .
             ' WHERE entry_id = ' . $this->db->quote($a_entry_id, 'integer') .
             ' AND user_id = ' . $this->db->quote($a_user_id, 'integer');
         $set = $this->db->query($query);
         $row = $this->db->fetchAssoc($set);
         if (is_array($row)) {
             return (bool) $row['counter'];
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasObjectBookingEntries()

static ilBookingEntry::hasObjectBookingEntries	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Check if object has assigned consultation hour appointments.

Definition at line 376 of file class.ilBookingEntry.php.

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

Referenced by ilExportFieldsInfo\getSelectableFieldsInfo(), and ilMemberExportGUI\initSettingsForm().

                                                                                 : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $user_restriction = '';
         if ($a_usr_id) {
             $user_restriction = 'AND obj_id = ' . $ilDB->quote($a_usr_id, ilDBConstants::T_INTEGER) . ' ';
         }
 
         $query = 'SELECT be.booking_id FROM booking_entry be ' .
             'JOIN booking_obj_assignment bo ON be.booking_id = bo.booking_id ' .
             'WHERE bo.target_obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
             $user_restriction;
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ isAppointmentBookableForUser()

ilBookingEntry::isAppointmentBookableForUser	(	int	$a_app_id,
		int	$a_user_id
	)

Check if a calendar appointment is bookable for a specific user.

Definition at line 584 of file class.ilBookingEntry.php.

References ilDateTime\_after(), ANONYMOUS_USER_ID, getCurrentNumberOfBookings(), getDeadlineHours(), getNumberOfBookings(), IL_CAL_HOUR, and IL_CAL_UNIX.

                                                                                : bool
     {
         // #12025
         if ($a_user_id == ANONYMOUS_USER_ID) {
             return false;
         }
         // Check max bookings
         if ($this->getNumberOfBookings() <= $this->getCurrentNumberOfBookings($a_app_id)) {
             return false;
         }
 
         // Check deadline
         $dead_limit = new ilDateTime(time(), IL_CAL_UNIX);
         $dead_limit->increment(IL_CAL_HOUR, $this->getDeadlineHours());
 
         $entry = new ilCalendarEntry($a_app_id);
         if (ilDateTime::_after($dead_limit, $entry->getStart())) {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ isBookable()

static ilBookingEntry::isBookable	(	array	$a_obj_ids,
		?int	$a_target_obj_id = `null`
	)

static

Which objects are bookable?

Parameters

	int[]	$a_obj_ids
int \| null	$a_target_obj_id

Returns: int[]

Definition at line 298 of file class.ilBookingEntry.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

                                                                                      : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         if ($a_target_obj_id) {
             $query = 'SELECT DISTINCT(obj_id) FROM booking_entry be ' .
                 'JOIN booking_obj_assignment bo ON be.booking_id = bo.booking_id ' .
                 'WHERE ' . $ilDB->in('obj_id', $a_obj_ids, false, 'integer') . ' ' .
                 'AND bo.target_obj_id = ' . $ilDB->quote($a_target_obj_id, 'integer');
         } else {
             $query = 'SELECT DISTINCT(obj_id) FROM booking_entry be ' .
                 'WHERE ' . $ilDB->in('obj_id', $a_obj_ids, false, 'integer') . ' ';
         }
 
         $res = $ilDB->query($query);
         $all = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $all[] = (int) $row->obj_id;
         }
         return $all;
     }

Here is the call graph for this function:

◆ isBookedOut()

ilBookingEntry::isBookedOut	(	int	$a_entry_id,
		bool	$a_check_current_user = `false`
	)

get current number of bookings

Definition at line 556 of file class.ilBookingEntry.php.

References getCurrentNumberOfBookings(), getDeadlineHours(), getNumberOfBookings(), getObjId(), hasBooked(), IL_CAL_UNIX, and ILIAS\Repository\user().

                                                                                     : bool
     {
         if ($this->getNumberOfBookings() == $this->getCurrentNumberOfBookings($a_entry_id)) {
             // check against current user
             if ($a_check_current_user) {
                 if ($this->hasBooked($a_entry_id)) {
                     return false;
                 }
                 if ($this->user->getId() == $this->getObjId()) {
                     return false;
                 }
             }
             return true;
         }
 
         $deadline = $this->getDeadlineHours();
         if ($deadline) {
             $entry = new ilCalendarEntry($a_entry_id);
             if (time() + ($deadline * 60 * 60) > $entry->getStart()->get(IL_CAL_UNIX)) {
                 return true;
             }
         }
         return false;
     }

Here is the call graph for this function:

◆ isOwner()

ilBookingEntry::isOwner ( ?int $a_user_id = null )

check if current (or given) user is entry owner

Parameters

int | null $a_user_id

Returns: bool

Definition at line 238 of file class.ilBookingEntry.php.

References getObjId(), and ILIAS\Repository\user().

                                                    : bool
     {
         if (!$a_user_id) {
             $a_user_id = $this->user->getId();
         }
         if ($this->getObjId() == $a_user_id) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ isTargetObjectVisible()

ilBookingEntry::isTargetObjectVisible ( int $a_ref_id )

Check if target ref id is visible.

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

References ilObject\_lookupObjId(), and getTargetObjIds().

                                                         : bool
     {
         // no course/group filter
         if (!$this->getTargetObjIds()) {
             return true;
         }
 
         $obj_id = ilObject::_lookupObjId($a_ref_id);
         return in_array($obj_id, $this->getTargetObjIds());
     }

Here is the call graph for this function:

◆ lookupBookableUsersForObject()

static ilBookingEntry::lookupBookableUsersForObject	(	array	$a_obj_id,
		array	$a_user_ids
	)

static

Consultation hours are offered if 1) consultation hour owner is admin or tutor and no object assignment 2) object is assigned to consultation hour.

Parameters

int[]	$a_obj_ids
int[]	$a_user_ids

Returns: int[] user ids

Definition at line 329 of file class.ilBookingEntry.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilCalendarCategory\TYPE_CH.

Referenced by ilConsultationHourUtils\getConsultationHourLinksForRepositoryObject(), ilCalendarBlockGUI\getHTML(), and ilCalendarCategories\readAllConsultationHoursCalendarOfContainer().

                                                                                            : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = 'SELECT be.obj_id bobj FROM booking_entry be ' .
             'JOIN booking_obj_assignment bo ON be.booking_id = bo.booking_id ' .
             'JOIN cal_entries ce on be.booking_id = ce.context_id ' .
             'JOIN cal_cat_assignments cca on ce.cal_id = cca.cal_id ' .
             'JOIN cal_categories cc on cca.cat_id = cc.cat_id ' .
             'WHERE ' . $ilDB->in('be.obj_id', $a_user_ids, false, 'integer') . ' ' .
             'AND ' . $ilDB->in('bo.target_obj_id', $a_obj_id, false, 'integer') . ' ' .
             'AND cc.obj_id = be.obj_id ' .
             'AND cc.type = ' . $ilDB->quote(ilCalendarCategory::TYPE_CH, 'integer') . ' ';
 
         $res = $ilDB->query($query);
 
         $objs = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if (!in_array($row->bobj, $objs)) {
                 $objs[] = (int) $row->bobj;
             }
         }
 
         // non filtered booking entries
         $query = 'SELECT be.obj_id bobj FROM booking_entry be ' .
             'LEFT JOIN booking_obj_assignment bo ON be.booking_id = bo.booking_id ' .
             'JOIN cal_entries ce on be.booking_id = ce.context_id ' .
             'JOIN cal_cat_assignments cca on ce.cal_id = cca.cal_id ' .
             'JOIN cal_categories cc on cca.cat_id = cc.cat_id ' .
             'WHERE bo.booking_id IS NULL ' .
             'AND ' . $ilDB->in('be.obj_id', $a_user_ids, false, 'integer') . ' ' .
             'AND cc.obj_id = be.obj_id ' .
             'AND cc.type = ' . $ilDB->quote(ilCalendarCategory::TYPE_CH, 'integer') . ' ';
 
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if (!in_array($row->bobj, $objs)) {
                 $objs[] = (int) $row->bobj;
             }
         }
         return $objs;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupBookingMessage()

static ilBookingEntry::lookupBookingMessage	(	int	$a_entry_id,
		int	$a_usr_id
	)

static

Definition at line 399 of file class.ilBookingEntry.php.

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

Referenced by ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilConsultationHourBookingTableGUI\parse(), ILIAS\Calendar\ConsultationHours\BookingDataProvider\read(), and ilCalendarMailNotification\send().

                                                                                : string
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query = 'SELECT * from booking_user ' .
             'WHERE entry_id = ' . $ilDB->quote($a_entry_id, 'integer') . ' ' .
             'AND user_id = ' . $ilDB->quote($a_usr_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (string) $row->booking_message;
         }
         return '';
     }

Here is the caller graph for this function:

◆ lookupBookingsForAppointment()

static ilBookingEntry::lookupBookingsForAppointment ( int $a_app_id )

static

Lookup booked users for appointment.

Parameters

int $a_app_id

Returns: int[]

Definition at line 466 of file class.ilBookingEntry.php.

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilConsultationHourBookingTableGUI\parse().

                                                                       : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = 'SELECT user_id FROM booking_user ' .
             'WHERE entry_id = ' . $ilDB->quote($a_app_id, 'integer');
         $res = $ilDB->query($query);
         $users = [];
         while ($row = $ilDB->fetchObject($res)) {
             $users[] = (int) $row->user_id;
         }
         return $users;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupBookingsForObject()

static ilBookingEntry::lookupBookingsForObject	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Lookup booking for an object and user.

Parameters

int	$a_obj_id
int	$a_usr_id

Returns: array<int, array<{dt: int, dtend: int, owner: int}>>

Definition at line 487 of file class.ilBookingEntry.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\int(), ilDBConstants\T_INTEGER, and ilTimeZone\UTC.

                                                                                 : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = 'SELECT bu.user_id, starta, enda FROM booking_user bu ' .
             'JOIN cal_entries ca ON entry_id = ca.cal_id ' .
             'JOIN booking_entry be ON context_id = booking_id ' .
             'JOIN booking_obj_assignment bo ON be.booking_id = bo.booking_id ' .
             'WHERE bo.target_obj_id = ' . $ilDB->quote($a_obj_id, 'integer') . ' ' .
             'AND be.obj_id = ' . $ilDB->quote($a_usr_id, ilDBConstants::T_INTEGER) . ' ' .
             'ORDER BY starta';
         $res = $ilDB->query($query);
 
         $bookings = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $dt = new ilDateTime($row->starta, IL_CAL_DATETIME, ilTimeZone::UTC);
             $dt_end = new ilDateTime($row->enda, IL_CAL_DATETIME, ilTimeZone::UTC);
             $bookings[(int) $row->user_id][] = [
                 'dt' => $dt->get(IL_CAL_UNIX),
                 'dtend' => $dt_end->get(IL_CAL_UNIX),
                 'owner' => $a_usr_id
             ];
         }
         return $bookings;
     }

Here is the call graph for this function:

◆ lookupBookingsOfUser()

static ilBookingEntry::lookupBookingsOfUser	(	array	$a_app_ids,
		int	$a_usr_id,
		?ilDateTime	$start = `null`
	)

static

Lookup bookings of user.

Parameters

int[]
int
?ilDateTime

Returns: int[]

Definition at line 60 of file class.ilBookingEntry.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilConsultationHoursGUI\assignUsersToAppointment().

                                                                                                            : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = 'SELECT entry_id FROM booking_user ' .
             'WHERE ' . $ilDB->in('entry_id', $a_app_ids, false, 'integer') . ' ' .
             'AND user_id = ' . $ilDB->quote($a_usr_id, 'integer');
 
         $res = $ilDB->query($query);
 
         $booked_entries = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $booked_entries[] = (int) $row->entry_id;
         }
         return $booked_entries;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupManagedBookingsForObject()

static ilBookingEntry::lookupManagedBookingsForObject	(	int	$a_obj_id,
		int	$a_usr_id
	)

static

Lookup bookings for own and managed consultation hours of an object.

Returns: array<string, array<{dt: int, dtend: int, owner: int, explanation: string}>>

Definition at line 518 of file class.ilBookingEntry.php.

References ilObjUser\_lookupFullname(), and ilConsultationHourUtils\lookupManagedUsers().

Referenced by ilGroupParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), and ilMemberExport\write().

                                                                                        : array
     {
         $bookings = self::lookupBookingsForObject($a_obj_id, $a_usr_id);
         foreach (ilConsultationHourUtils::lookupManagedUsers($a_usr_id) as $managed_user_id) {
             foreach (self::lookupBookingsForObject($a_obj_id, $managed_user_id) as $booked_user => $booking) {
                 $fullname = ilObjUser::_lookupFullname($managed_user_id);
                 foreach ($booking as $booking_entry) {
                     $booking_entry['explanation'] = '(' . $fullname . ')';
                     $bookings[$booked_user][] = $booking_entry;
                 }
             }
         }
         return $bookings;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilBookingEntry::read ( )

protected

Definition at line 209 of file class.ilBookingEntry.php.

References $res, ilDBConstants\FETCHMODE_ASSOC, ilDBConstants\FETCHMODE_OBJECT, getId(), ILIAS\Repository\int(), setDeadlineHours(), setNumberOfBookings(), and setObjId().

Referenced by __construct().

                              : void
     {
         if (!$this->getId()) {
             return;
         }
 
         $query = "SELECT * FROM booking_entry " .
             "WHERE booking_id = " . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) {
             $this->setObjId((int) $row['obj_id']);
             $this->setDeadlineHours((int) $row['deadline']);
             $this->setNumberOfBookings((int) $row['num_bookings']);
         }
 
         $query = 'SELECT * FROM booking_obj_assignment ' .
             'WHERE booking_id = ' . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->query($query);
         $this->target_obj_ids = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->target_obj_ids[] = (int) $row->target_obj_id;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeObsoleteEntries()

static ilBookingEntry::removeObsoleteEntries ( )

static

Remove unused booking entries.

Definition at line 252 of file class.ilBookingEntry.php.

References $DIC, $ilDB, $q, and ilCalendarCategory\TYPE_CH.

Referenced by ilConsultationHoursGUI\deleteAppointments(), and ilConsultationHoursGUI\updateMulti().

                                                   : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $set = $ilDB->query('SELECT DISTINCT(context_id) FROM cal_entries e' .
             ' JOIN cal_cat_assignments a ON (e.cal_id = a.cal_id)' .
             ' JOIN cal_categories c ON (a.cat_id = c.cat_id) WHERE c.type = ' . $ilDB->quote(
                 ilCalendarCategory::TYPE_CH,
                 'integer'
             ));
 
         $used = array();
         while ($row = $ilDB->fetchAssoc($set)) {
             $used[] = $row['context_id'];
         }
         $ilDB->query($q = 'DELETE FROM booking_entry WHERE ' . $ilDB->in('booking_id', $used, true, 'integer'));
         $ilDB->query($q = 'DELETE FROM booking_obj_assignment WHERE ' . $ilDB->in(
             'booking_id',
             $used,
             true,
             'integer'
         ));
     }

Here is the caller graph for this function:

◆ save()

ilBookingEntry::save ( )

Definition at line 149 of file class.ilBookingEntry.php.

References getDeadlineHours(), getId(), getNumberOfBookings(), getObjId(), and setId().

Referenced by ilConsultationHoursGUI\createNewBookingEntry(), and ilConsultationHoursGUI\saveSequence().

                           : void
     {
         $this->setId($this->db->nextId('booking_entry'));
         $query = 'INSERT INTO booking_entry (booking_id,obj_id,deadline,num_bookings) ' .
             "VALUES ( " .
             $this->db->quote($this->getId(), 'integer') . ', ' .
             $this->db->quote($this->getObjId(), 'integer') . ', ' .
             $this->db->quote($this->getDeadlineHours(), 'integer') . ', ' .
             $this->db->quote($this->getNumberOfBookings(), 'integer') . ' ' .
             ") ";
         $this->db->manipulate($query);
 
         foreach ((array) $this->target_obj_ids as $obj_id) {
             $query = 'INSERT INTO booking_obj_assignment (booking_id, target_obj_id) ' .
                 'VALUES( ' .
                 $this->db->quote($this->getId(), 'integer') . ', ' .
                 $this->db->quote($obj_id, 'integer') . ' ' .
                 ')';
             $this->db->manipulate($query);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeadlineHours()

ilBookingEntry::setDeadlineHours ( int $a_hours )

Definition at line 99 of file class.ilBookingEntry.php.

Referenced by ilConsultationHoursGUI\createNewBookingEntry(), read(), and ilConsultationHoursGUI\saveSequence().

                                                   : void
     {
         $this->deadline = $a_hours;
     }

Here is the caller graph for this function:

◆ setId()

ilBookingEntry::setId ( int $a_id )

protected

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

Referenced by __construct(), and save().

                                        : void
     {
         $this->id = $a_id;
     }

Here is the caller graph for this function:

◆ setNumberOfBookings()

ilBookingEntry::setNumberOfBookings ( int $a_num )

Definition at line 109 of file class.ilBookingEntry.php.

Referenced by ilConsultationHoursGUI\createNewBookingEntry(), read(), and ilConsultationHoursGUI\saveSequence().

                                                    : void
     {
         $this->num_bookings = $a_num;
     }

Here is the caller graph for this function:

◆ setObjId()

ilBookingEntry::setObjId ( int $a_id )

Definition at line 89 of file class.ilBookingEntry.php.

Referenced by ilConsultationHoursGUI\createNewBookingEntry(), read(), and ilConsultationHoursGUI\saveSequence().

                                        : void
     {
         $this->obj_id = $a_id;
     }

Here is the caller graph for this function:

◆ setTargetObjIds()

ilBookingEntry::setTargetObjIds ( ?array $a_obj_id )

Parameters

int[]|null $a_obj_id

Definition at line 122 of file class.ilBookingEntry.php.

Referenced by ilConsultationHoursGUI\createNewBookingEntry(), and ilConsultationHoursGUI\saveSequence().

                                                      : void
     {
         $this->target_obj_ids = $a_obj_id;
     }

Here is the caller graph for this function:

◆ update()

ilBookingEntry::update ( )

Definition at line 171 of file class.ilBookingEntry.php.

References getDeadlineHours(), getId(), getNumberOfBookings(), and getObjId().

                             : void
     {
         if (!$this->getId()) {
             return;
         }
 
         $query = "UPDATE booking_entry SET " .
             " obj_id = " . $this->db->quote($this->getObjId(), 'integer') . ", " .
             " deadline = " . $this->db->quote($this->getDeadlineHours(), 'integer') . ", " .
             " num_bookings = " . $this->db->quote($this->getNumberOfBookings(), 'integer') . ' ' .
             'WHERE booking_id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
 
         // obj assignments
         $query = 'DELETE FROM booking_obj_assignment ' .
             'WHERE booking_id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
 
         foreach ((array) $this->target_obj_ids as $obj_id) {
             $query = 'INSERT INTO booking_obj_assignment (booking_id, target_obj_id) ' .
                 'VALUES( ' .
                 $this->db->quote($this->getId(), 'integer') . ', ' .
                 $this->db->quote($obj_id, 'integer') . ' ' .
                 ')';
             $this->db->manipulate($query);
         }
     }

Here is the call graph for this function:

◆ writeBookingMessage()

static ilBookingEntry::writeBookingMessage	(	int	$a_entry_id,
		int	$a_usr_id,
		string	$a_message
	)

static

Write booking message.

Definition at line 418 of file class.ilBookingEntry.php.

References $DIC, and $ilDB.

Referenced by ilConsultationHourUtils\bookAppointment().

                                                                                                  : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $query = 'UPDATE booking_user SET ' .
             'booking_message = ' . $ilDB->quote($a_message, 'text') . ' ' .
             'WHERE entry_id = ' . $ilDB->quote($a_entry_id, 'integer') . ' ' .
             'AND user_id = ' . $ilDB->quote($a_usr_id, 'integer');
 
         $ilDB->manipulate($query);
     }

Here is the caller graph for this function:

Field Documentation

◆ $db

ilDBInterface ilBookingEntry::$db

protected

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

◆ $deadline

int ilBookingEntry::$deadline = 0

private

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

Referenced by getDeadlineHours().

◆ $id

int ilBookingEntry::$id = 0

private

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

Referenced by getId().

◆ $num_bookings

int ilBookingEntry::$num_bookings = 1

private

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

Referenced by getNumberOfBookings().

◆ $obj_id

int ilBookingEntry::$obj_id = 0

private

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

Referenced by getObjId().

◆ $target_obj_ids

array ilBookingEntry::$target_obj_ids = []

private

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

Referenced by getTargetObjIds().

◆ $user

ilObjUser ilBookingEntry::$user

protected

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

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

components/ILIAS/Calendar/classes/Booking/class.ilBookingEntry.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ book()

◆ cancelBooking()

◆ delete()

◆ deleteBooking()

◆ getCurrentBookings()

◆ getCurrentNumberOfBookings()

◆ getDeadlineHours()

◆ getId()

◆ getInstanceByCalendarEntryId()

◆ getNumberOfBookings()

◆ getObjId()

◆ getTargetObjIds()

◆ hasBooked()

◆ hasObjectBookingEntries()

◆ isAppointmentBookableForUser()

◆ isBookable()

◆ isBookedOut()

◆ isOwner()

◆ isTargetObjectVisible()

◆ lookupBookableUsersForObject()

◆ lookupBookingMessage()

◆ lookupBookingsForAppointment()

◆ lookupBookingsForObject()

◆ lookupBookingsOfUser()

◆ lookupManagedBookingsForObject()

◆ read()

◆ removeObsoleteEntries()

◆ save()

◆ setDeadlineHours()

◆ setId()

◆ setNumberOfBookings()

◆ setObjId()

◆ setTargetObjIds()

◆ update()

◆ writeBookingMessage()

Field Documentation

◆ $db

◆ $deadline

◆ $id

◆ $num_bookings

◆ $obj_id

◆ $target_obj_ids

◆ $user