ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilBookingReservation Class Reference

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

+ Collaboration diagram for ilBookingReservation:

Public Member Functions

 __construct (?int $a_id=null)
 
 getId ()
 
 setObjectId (int $a_object_id)
 
 getObjectId ()
 
 setUserId (int $a_user_id)
 
 getUserId ()
 
 setMessage (string $message)
 
 getMessage ()
 
 setAssignerId (int $a_assigner_id)
 Set assigner user id. More...
 
 getAssignerId ()
 
 setFrom (int $a_from)
 Set booking from date. More...
 
 getFrom ()
 
 setTo (int $a_to)
 Set booking to date. More...
 
 getTo ()
 
 setStatus (?int $a_status)
 Set booking status. More...
 
 getStatus ()
 Get booking status. More...
 
 setGroupId (int $a_group_id)
 
 getGroupId ()
 
 setContextObjId (int $a_val)
 
 getContextObjId ()
 
 save ()
 
 update ()
 
 delete ()
 
 getCalendarEntry ()
 

Static Public Member Functions

static isValidStatus (int $a_status)
 
static getAvailableObject (array $a_ids, int $a_from, int $a_to, bool $a_return_single=true, bool $a_return_counter=false)
 Check if any of given objects are bookable. More...
 
static isObjectAvailableInPeriod (int $a_obj_id, ilBookingSchedule $a_schedule, ?int $a_from, ?int $a_to)
 
static isBookingPoolLimitReachedByUser (int $a_user_id, int $a_pool_id)
 
static getMembersWithoutReservation (int $a_object_id)
 
static isObjectAvailableNoSchedule (int $a_obj_id)
 
static numAvailableFromObjectNoSchedule (int $a_obj_id)
 
static getNumAvailablesNoSchedule (int $a_obj_id)
 
static getCurrentOrUpcomingReservation (int $a_object_id)
 Get details about object reservation. More...
 
static getObjectReservationForUser (int $a_object_id, int $a_user_id)
 
static getList (array $a_object_ids, int $a_limit=10, int $a_offset=0, array $filter=[])
 List all reservations. More...
 
static getUserFilter (array $a_object_ids)
 Get all users who have reservations for object(s) More...
 
static changeStatus (array $a_ids, int $a_status)
 Batch update reservation status. More...
 
static getCancelDetails (int $a_obj_id, int $a_user_id, int $a_from, int $a_to)
 Get reservation ids from aggregated id for cancellation. More...
 

Data Fields

const STATUS_IN_USE = 2
 
const STATUS_CANCELLED = 5
 

Protected Member Functions

 read ()
 

Protected Attributes

ilDBInterface $db
 
int $id = 0
 
int $object_id = 0
 
int $user_id = 0
 
int $from = 0
 
int $to = 0
 
int $status = 0
 
int $group_id = 0
 
int $assigner_id = 0
 
int $context_obj_id = 0
 
string $message = ""
 
ILIAS BookingManager Reservations ReservationDBRepository $repo
 

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 a booking reservation

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingReservation::__construct ( ?int  $a_id = null)

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

43 {
44 global $DIC;
45
46 $this->db = $DIC->database();
47 $this->id = (int) $a_id;
48
49 $this->repo = $DIC->bookingManager()
50 ->internal()
51 ->repo()
52 ->reservation();
53 $this->read();
54 }
global $DIC
Definition: shib_login.php:26

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

+ Here is the call graph for this function:

Member Function Documentation

◆ changeStatus()

static ilBookingReservation::changeStatus ( array  $a_ids,
int  $a_status 
)
static

Batch update reservation status.

Parameters
int[]$a_idsreservation ids
int$a_status
Returns
int number of changed entries

Definition at line 604 of file class.ilBookingReservation.php.

607 : int {
608 global $DIC;
609
610 $ilDB = $DIC->database();
611
612 if (self::isValidStatus($a_status)) {
613 return $ilDB->manipulate('UPDATE booking_reservation' .
614 ' SET status = ' . $ilDB->quote($a_status, 'integer') .
615 ' WHERE ' . $ilDB->in('booking_reservation_id', $a_ids, '', 'integer'));
616 }
617 return 0;
618 }

References $ilDB.

Referenced by ilBookingReservationsGUI\changeStatusObject().

+ Here is the caller graph for this function:

◆ delete()

ilBookingReservation::delete ( )

Definition at line 239 of file class.ilBookingReservation.php.

239 : void
240 {
241 $this->repo->delete($this->id);
242 }

◆ getAssignerId()

ilBookingReservation::getAssignerId ( )

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

99 : int
100 {
101 return $this->assigner_id;
102 }

References $assigner_id.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getAvailableObject()

static ilBookingReservation::getAvailableObject ( array  $a_ids,
int  $a_from,
int  $a_to,
bool  $a_return_single = true,
bool  $a_return_counter = false 
)
static

Check if any of given objects are bookable.

Definition at line 248 of file class.ilBookingReservation.php.

254 : array {
255 global $DIC;
256
258
259 $repo = $DIC->bookingManager()->internal()->repo()->reservation();
260
261 $blocked = $counter = array();
262 foreach ($repo->getNumberOfReservations($a_ids, $a_from, $a_to) as $row) {
263 if ($row['cnt'] >= $nr_map[$row['object_id']]) {
264 $blocked[] = $row['object_id'];
265 } elseif ($a_return_counter) {
266 $counter[$row['object_id']] = $nr_map[$row['object_id']] - (int) $row['cnt'];
267 }
268 }
269
270 // #17868 - validate against schedule availability
271 foreach ($a_ids as $obj_id) {
272 $bobj = new ilBookingObject($obj_id);
273 if ($bobj->getScheduleId()) {
274 $schedule = new ilBookingSchedule($bobj->getScheduleId());
275
276 $av_from = ($schedule->getAvailabilityFrom() && !$schedule->getAvailabilityFrom()->isNull())
277 ? $schedule->getAvailabilityFrom()->get(IL_CAL_UNIX)
278 : null;
279 $av_to = ($schedule->getAvailabilityTo() && !$schedule->getAvailabilityTo()->isNull())
280 ? $schedule->getAvailabilityTo()->get(IL_CAL_UNIX)
281 : null;
282
283 if (($av_from && $a_from < $av_from) ||
284 ($av_to && $a_to > $av_to)) {
285 $blocked[] = $obj_id;
286 unset($counter[$obj_id]);
287 }
288 }
289 }
290
291 $available = array_diff($a_ids, $blocked);
292 if (count($available)) {
293 if ($a_return_counter) {
294 foreach ($a_ids as $id) {
295 if (!isset($counter[$id])) {
296 $counter[$id] = $nr_map[$id];
297 }
298 }
299 return $counter;
300 }
301 if ($a_return_single) {
302 return array_shift($available);
303 }
304 return $available;
305 }
306 return [];
307 }
const IL_CAL_UNIX
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
static getNrOfItemsForObjects(array $a_obj_ids)
Get nr of available items for a set of object ids.
ILIAS BookingManager Reservations ReservationDBRepository $repo
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
$counter

Referenced by ILIAS\BookingManager\BookingProcess\BookingProcessManager\getRecurrenceMissingAvailability().

+ Here is the caller graph for this function:

◆ getCalendarEntry()

ilBookingReservation::getCalendarEntry ( )

Definition at line 621 of file class.ilBookingReservation.php.

621 : int
622 {
624
625 $set = $ilDB->query("SELECT ce.cal_id FROM cal_entries ce" .
626 " JOIN cal_cat_assignments cca ON ce.cal_id = cca.cal_id" .
627 " JOIN cal_categories cc ON cca.cat_id = cc.cat_id" .
628 " JOIN booking_reservation br ON ce.context_id = br.booking_reservation_id" .
629 " WHERE cc.obj_id = " . $ilDB->quote($this->getUserId(), 'integer') .
630 " AND br.user_id = " . $ilDB->quote($this->getUserId(), 'integer') .
631 " AND cc.type = " . $ilDB->quote(ilCalendarCategory::TYPE_BOOK, 'integer') .
632 " AND ce.context_id = " . $ilDB->quote($this->getId(), 'integer'));
633 $row = $ilDB->fetchAssoc($set);
634 return (int) ($row["cal_id"] ?? 0);
635 }

References $ilDB, and ilCalendarCategory\TYPE_BOOK.

◆ getCancelDetails()

static ilBookingReservation::getCancelDetails ( int  $a_obj_id,
int  $a_user_id,
int  $a_from,
int  $a_to 
)
static

Get reservation ids from aggregated id for cancellation.

Returns
int[]

Definition at line 641 of file class.ilBookingReservation.php.

646 : array {
647 global $DIC;
648
649 $ilDB = $DIC->database();
650
651 $res = array();
652
653 $sql = "SELECT booking_reservation_id" .
654 " FROM booking_reservation" .
655 " WHERE object_id = " . $ilDB->quote($a_obj_id, "integer") .
656 " AND user_id = " . $ilDB->quote($a_user_id, "integer") .
657 " AND date_from = " . $ilDB->quote($a_from, "integer") .
658 " AND date_to = " . $ilDB->quote($a_to, "integer") .
659 " AND (status IS NULL" .
660 " OR status <> " . $ilDB->quote(self::STATUS_CANCELLED, "integer") . ")";
661 $set = $ilDB->query($sql);
662 while ($row = $ilDB->fetchAssoc($set)) {
663 $res[] = (int) $row["booking_reservation_id"];
664 }
665
666 return $res;
667 }
$res
Definition: ltiservices.php:69

Referenced by ilBookingReservationsGUI\redirectMailToBooker(), ilBookingReservationsGUI\rsvConfirmCancel(), ilBookingReservationsGUI\rsvConfirmDelete(), and ilBookingReservationsGUI\rsvDelete().

+ Here is the caller graph for this function:

◆ getContextObjId()

ilBookingReservation::getContextObjId ( )
Returns
int context object id (e.g. course id)

Definition at line 177 of file class.ilBookingReservation.php.

177 : int
178 {
180 }

References $context_obj_id.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getCurrentOrUpcomingReservation()

static ilBookingReservation::getCurrentOrUpcomingReservation ( int  $a_object_id)
static

Get details about object reservation.

Definition at line 465 of file class.ilBookingReservation.php.

467 : array {
468 global $DIC;
469
470 $ilDB = $DIC->database();
471
472 $now = $ilDB->quote(time(), 'integer');
473
474 $ilDB->setLimit(1);
475 $set = $ilDB->query('SELECT user_id, status, date_from, date_to' .
476 ' FROM booking_reservation' .
477 ' WHERE ((date_from <= ' . $now . ' AND date_to >= ' . $now . ')' .
478 ' OR date_from > ' . $now . ')' .
479 ' AND (status <> ' . $ilDB->quote(self::STATUS_CANCELLED, 'integer') .
480 ' OR STATUS IS NULL) AND object_id = ' . $ilDB->quote($a_object_id, 'integer') .
481 ' ORDER BY date_from');
482 return $ilDB->fetchAssoc($set);
483 }

◆ getFrom()

ilBookingReservation::getFrom ( )

Definition at line 112 of file class.ilBookingReservation.php.

112 : int
113 {
114 return $this->from;
115 }

References $from.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getGroupId()

ilBookingReservation::getGroupId ( )

Definition at line 161 of file class.ilBookingReservation.php.

161 : int
162 {
163 return $this->group_id;
164 }

References $group_id.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getId()

ilBookingReservation::getId ( )

Definition at line 56 of file class.ilBookingReservation.php.

56 : int
57 {
58 return $this->id;
59 }

References $id.

◆ getList()

static ilBookingReservation::getList ( array  $a_object_ids,
int  $a_limit = 10,
int  $a_offset = 0,
array  $filter = [] 
)
static

List all reservations.

Returns
array<string, array>

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

517 : array {
518 global $DIC;
519
520 $ilDB = $DIC->database();
521
522 $sql = 'SELECT r.*,o.title' .
523 ' FROM booking_reservation r' .
524 ' JOIN booking_object o ON (o.booking_object_id = r.object_id)';
525
526 $count_sql = 'SELECT COUNT(*) AS counter' .
527 ' FROM booking_reservation r' .
528 ' JOIN booking_object o ON (o.booking_object_id = r.object_id)';
529
530 $where = array($ilDB->in('r.object_id', $a_object_ids, '', 'integer'));
531 if (isset($filter['status'])) {
532 if ($filter['status'] > 0) {
533 $where[] = 'status = ' . $ilDB->quote($filter['status'], 'integer');
534 } else {
535 $where[] = '(status != ' . $ilDB->quote(-$filter['status'], 'integer') .
536 ' OR status IS NULL)';
537 }
538 }
539 if (isset($filter['from'])) {
540 $where[] = 'date_from >= ' . $ilDB->quote($filter['from'], 'integer');
541 }
542 if (isset($filter['to'])) {
543 $where[] = 'date_to <= ' . $ilDB->quote($filter['to'], 'integer');
544 }
545 if (count($where)) {
546 $sql .= ' WHERE ' . implode(' AND ', $where);
547 $count_sql .= ' WHERE ' . implode(' AND ', $where);
548 }
549
550 $set = $ilDB->query($count_sql);
551 $row = $ilDB->fetchAssoc($set);
552 $counter = $row['counter'];
553
554 $sql .= ' ORDER BY date_from DESC, booking_reservation_id DESC';
555
556 $ilDB->setLimit($a_limit, $a_offset);
557 $set = $ilDB->query($sql);
558 $res = array();
559 while ($row = $ilDB->fetchAssoc($set)) {
560 $res[] = $row;
561 }
562
563 return array('data' => $res, 'counter' => $counter);
564 }

Referenced by ilBookingObjectsTableGUI\getItems().

+ Here is the caller graph for this function:

◆ getMembersWithoutReservation()

static ilBookingReservation::getMembersWithoutReservation ( int  $a_object_id)
static
Returns
int[]

Definition at line 404 of file class.ilBookingReservation.php.

406 : array {
407 global $DIC;
408 $ilDB = $DIC->database();
409
410 $pool_id = ilBookingObject::lookupPoolId($a_object_id);
411
412 $res = array();
413 $query = 'SELECT DISTINCT bm.user_id user_id' .
414 ' FROM booking_member bm' .
415 ' WHERE bm.booking_pool_id = ' . $ilDB->quote($pool_id, 'integer') .
416 ' AND bm.user_id NOT IN (' .
417 'SELECT user_id' .
418 ' FROM booking_reservation' .
419 ' WHERE object_id = ' . $ilDB->quote($a_object_id, 'integer') .
420 ' AND (status IS NULL OR status <> ' . self::STATUS_CANCELLED . '))';
421
422 $set = $ilDB->query($query);
423
424 while ($row = $ilDB->fetchAssoc($set)) {
425 $res[] = (int) $row['user_id'];
426 }
427
428 return $res;
429 }
static lookupPoolId(int $object_id)

◆ getMessage()

ilBookingReservation::getMessage ( )

Definition at line 86 of file class.ilBookingReservation.php.

86 : string
87 {
88 return $this->message;
89 }

References $message.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getNumAvailablesNoSchedule()

static ilBookingReservation::getNumAvailablesNoSchedule ( int  $a_obj_id)
static

Definition at line 442 of file class.ilBookingReservation.php.

442 : int
443 {
444 global $DIC;
445
446 $ilDB = $DIC->database();
447
448 $all = ilBookingObject::getNrOfItemsForObjects(array($a_obj_id));
449 $all = $all[$a_obj_id];
450
451 $set = $ilDB->query('SELECT COUNT(*) cnt' .
452 ' FROM booking_reservation r' .
453 ' JOIN booking_object o ON (o.booking_object_id = r.object_id)' .
454 ' WHERE (status IS NULL OR status <> ' . $ilDB->quote(self::STATUS_CANCELLED, 'integer') . ')' .
455 ' AND r.object_id = ' . $ilDB->quote($a_obj_id, 'integer'));
456 $cnt = $ilDB->fetchAssoc($set);
457 $cnt = (int) $cnt['cnt'];
458
459 return $all - $cnt; // #11864
460 }

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

+ Here is the call graph for this function:

◆ getObjectId()

ilBookingReservation::getObjectId ( )

Definition at line 66 of file class.ilBookingReservation.php.

66 : int
67 {
68 return $this->object_id;
69 }

References $object_id.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getObjectReservationForUser()

static ilBookingReservation::getObjectReservationForUser ( int  $a_object_id,
int  $a_user_id 
)
static
Returns
int[] booking reservation ids

Definition at line 488 of file class.ilBookingReservation.php.

491 : ?array {
492 global $DIC;
493
494 $ilDB = $DIC->database();
495
496 $set = $ilDB->query('SELECT booking_reservation_id FROM booking_reservation' .
497 ' WHERE user_id = ' . $ilDB->quote($a_user_id, 'integer') .
498 ' AND object_id = ' . $ilDB->quote($a_object_id, 'integer') .
499 ' AND (status <> ' . $ilDB->quote(self::STATUS_CANCELLED, 'integer') .
500 ' OR STATUS IS NULL)');
501 $res = array();
502 while ($row = $ilDB->fetchAssoc($set)) {
503 $res[] = (int) $row['booking_reservation_id'];
504 }
505 return $res;
506 }

Referenced by ilBookingProcessWithoutScheduleGUI\confirmedBooking(), ilBookingAssignObjectsTableGUI\getItems(), ilBookingReservationsGUI\rsvCancelUser(), and ilBookingPrefBasedBookGatewayRepository\storeBookings().

+ Here is the caller graph for this function:

◆ getStatus()

ilBookingReservation::getStatus ( )

Get booking status.

Definition at line 146 of file class.ilBookingReservation.php.

146 : ?int
147 {
148 return $this->status;
149 }

References $status.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getTo()

ilBookingReservation::getTo ( )

Definition at line 125 of file class.ilBookingReservation.php.

125 : int
126 {
127 return $this->to;
128 }

References $to.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ getUserFilter()

static ilBookingReservation::getUserFilter ( array  $a_object_ids)
static

Get all users who have reservations for object(s)

Parameters
int[]$a_object_ids
Returns
array<int,string> user id => user name

Definition at line 573 of file class.ilBookingReservation.php.

575 : array {
576 global $DIC;
577
578 $ilDB = $DIC->database();
579
580 $res = array();
581
582 $sql = "SELECT ud.usr_id,ud.lastname,ud.firstname,ud.login" .
583 " FROM usr_data ud " .
584 " LEFT JOIN booking_reservation r ON (r.user_id = ud.usr_id)" .
585 " WHERE ud.usr_id <> " . $ilDB->quote(ANONYMOUS_USER_ID, "integer") .
586 " AND " . $ilDB->in("r.object_id", $a_object_ids, "", "integer") .
587 " ORDER BY ud.lastname,ud.firstname";
588 $set = $ilDB->query($sql);
589 while ($row = $ilDB->fetchAssoc($set)) {
590 $res[$row["usr_id"]] = $row["lastname"] . ", " . $row["firstname"] .
591 " (" . $row["login"] . ")";
592 }
593
594 return $res;
595 }
const ANONYMOUS_USER_ID
Definition: constants.php:27

◆ getUserId()

ilBookingReservation::getUserId ( )

Definition at line 76 of file class.ilBookingReservation.php.

76 : int
77 {
78 return $this->user_id;
79 }

References $user_id.

Referenced by save(), and update().

+ Here is the caller graph for this function:

◆ isBookingPoolLimitReachedByUser()

static ilBookingReservation::isBookingPoolLimitReachedByUser ( int  $a_user_id,
int  $a_pool_id 
)
static

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

382 : int {
383 global $DIC;
384 $ilDB = $DIC->database();
385 $object_manager = $DIC->bookingManager()->internal()->domain()
386 ->objects($a_pool_id);
387
388 $booking_pool_objects = $object_manager->getObjectIds();
389
390 $query = "SELECT count(user_id) total" .
391 " FROM booking_reservation" .
392 " WHERE " . $ilDB->in('object_id', $booking_pool_objects, false, 'integer') .
393 " AND user_id = " . $a_user_id .
394 " AND (status IS NULL OR status <> " . self::STATUS_CANCELLED . ')';
395 $res = $ilDB->query($query);
396 $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
397
398 return (int) $row['total'];
399 }

◆ isObjectAvailableInPeriod()

static ilBookingReservation::isObjectAvailableInPeriod ( int  $a_obj_id,
ilBookingSchedule  $a_schedule,
?int  $a_from,
?int  $a_to 
)
static

Definition at line 309 of file class.ilBookingReservation.php.

314 : bool {
315 global $DIC;
316
317 if (!$a_from) {
318 $a_from = time();
319 }
320 if (!$a_to) {
321 $a_to = strtotime("+1year", $a_from);
322 }
323
324 if ($a_from > $a_to) {
325 return false;
326 }
327
328 // all nr of reservations in period that are not over yet (to >= now)
329 $repo = $DIC->bookingManager()->internal()->repo()->reservation();
330 $res = $repo->getNumberOfReservations([$a_obj_id], $a_from, $a_to, true);
331 $booked_in_period = (int) ($res[$a_obj_id]["cnt"] ?? 0);
332
333 $per_slot = ilBookingObject::getNrOfItemsForObjects(array($a_obj_id));
334 $per_slot = $per_slot[$a_obj_id];
335
336 // max available nr of items per (week)day
337 $schedule_slots = array();
338 $definition = $a_schedule->getDefinition();
339 $map = array_flip(array("su", "mo", "tu", "we", "th", "fr", "sa"));
340 foreach ($definition as $day => $day_slots) {
341 $schedule_slots[$map[$day]] = $day_slots;
342 }
343
344 $av_from = ($a_schedule->getAvailabilityFrom() && !$a_schedule->getAvailabilityFrom()->isNull())
345 ? $a_schedule->getAvailabilityFrom()->get(IL_CAL_UNIX)
346 : null;
347 $av_to = ($a_schedule->getAvailabilityTo() && !$a_schedule->getAvailabilityTo()->isNull())
348 ? strtotime($a_schedule->getAvailabilityTo()->get(IL_CAL_DATE) . " 23:59:59")
349 : null;
350
351 // sum up max available (to >= now) items in period per (week)day
352 $available_in_period = 0;
353 $loop = 0;
354 while ($a_from < $a_to &&
355 ++$loop < 1000) {
356 // any slots for current weekday?
357 $day_slots = $schedule_slots[date("w", $a_from)] ?? false;
358 if ($day_slots) {
359 foreach ($day_slots as $slot) {
360 // convert slot to current datetime
361 $slot = explode("-", $slot);
362 $slot_from = strtotime(date("Y-m-d", $a_from) . " " . $slot[0]);
363 $slot_to = strtotime(date("Y-m-d", $a_from) . " " . $slot[1]);
364 // slot has to be in the future and part of schedule availability
365 if ($slot_from >= $av_from &&
366 ($slot_to <= $av_to || is_null($av_to)) &&
367 $slot_to > time()) {
368 $available_in_period += $per_slot;
369 }
370 }
371 }
372
373 $a_from += (60 * 60 * 24);
374 }
375 return $available_in_period - $booked_in_period > 0;
376 }
const IL_CAL_DATE

Referenced by ilBookingObjectsTableGUI\getItems().

+ Here is the caller graph for this function:

◆ isObjectAvailableNoSchedule()

static ilBookingReservation::isObjectAvailableNoSchedule ( int  $a_obj_id)
static

Definition at line 431 of file class.ilBookingReservation.php.

431 : bool
432 {
433 $available = self::getNumAvailablesNoSchedule($a_obj_id);
434 return (bool) $available; // #11864
435 }
static getNumAvailablesNoSchedule(int $a_obj_id)

Referenced by ilBookingProcessWithoutScheduleGUI\confirmedBooking(), and ilBookingPrefBasedBookGatewayRepository\storeBookings().

+ Here is the caller graph for this function:

◆ isValidStatus()

static ilBookingReservation::isValidStatus ( int  $a_status)
static

Definition at line 151 of file class.ilBookingReservation.php.

151 : bool
152 {
153 return in_array($a_status, array(self::STATUS_IN_USE, self::STATUS_CANCELLED));
154 }

◆ numAvailableFromObjectNoSchedule()

static ilBookingReservation::numAvailableFromObjectNoSchedule ( int  $a_obj_id)
static

Definition at line 437 of file class.ilBookingReservation.php.

437 : int
438 {
439 return self::getNumAvailablesNoSchedule($a_obj_id);
440 }

Referenced by ilBookingAssignParticipantsTableGUI\__construct(), ilBookingProcessWithoutScheduleGUI\bookMultipleParticipants(), and ilBookingAssignObjectsTableGUI\getItems().

+ Here is the caller graph for this function:

◆ read()

ilBookingReservation::read ( )
protected

Definition at line 182 of file class.ilBookingReservation.php.

182 : void
183 {
184 if ($this->id) {
185 $row = $this->repo->getForId($this->id);
186 $this->setUserId($row['user_id']);
187 $this->setAssignerId((int) $row['assigner_id']);
188 $this->setObjectId($row['object_id']);
189 $this->setFrom($row['date_from']);
190 $this->setTo($row['date_to']);
191 $this->setStatus($row['status']);
192 $this->setGroupId((int) $row['group_id']);
193 $this->setContextObjId((int) $row['context_obj_id']);
194 $this->setMessage((string) $row['message']);
195 }
196 }
setAssignerId(int $a_assigner_id)
Set assigner user id.
setTo(int $a_to)
Set booking to date.
setStatus(?int $a_status)
Set booking status.
setFrom(int $a_from)
Set booking from date.

References setAssignerId(), setContextObjId(), setFrom(), setGroupId(), setMessage(), setObjectId(), setStatus(), setTo(), and setUserId().

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ save()

ilBookingReservation::save ( )

Definition at line 198 of file class.ilBookingReservation.php.

198 : bool
199 {
200 if ($this->id) {
201 return false;
202 }
203
204 $this->id = $this->repo->create(
205 $this->getUserId(),
206 $this->getAssignerId(),
207 $this->getObjectId(),
208 $this->getContextObjId(),
209 $this->getFrom(),
210 $this->getTo(),
211 $this->getStatus(),
212 $this->getGroupId(),
213 $this->getMessage()
214 );
215 return ($this->id > 0);
216 }

References getAssignerId(), getContextObjId(), getFrom(), getGroupId(), getMessage(), getObjectId(), getStatus(), getTo(), and getUserId().

+ Here is the call graph for this function:

◆ setAssignerId()

ilBookingReservation::setAssignerId ( int  $a_assigner_id)

Set assigner user id.

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

94 : void
95 {
96 $this->assigner_id = $a_assigner_id;
97 }

Referenced by read().

+ Here is the caller graph for this function:

◆ setContextObjId()

ilBookingReservation::setContextObjId ( int  $a_val)
Parameters
int$a_valcontext object id (e.g. course id)

Definition at line 169 of file class.ilBookingReservation.php.

169 : void
170 {
171 $this->context_obj_id = $a_val;
172 }

Referenced by read().

+ Here is the caller graph for this function:

◆ setFrom()

ilBookingReservation::setFrom ( int  $a_from)

Set booking from date.

Definition at line 107 of file class.ilBookingReservation.php.

107 : void
108 {
109 $this->from = $a_from;
110 }

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Referenced by read().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setGroupId()

ilBookingReservation::setGroupId ( int  $a_group_id)

Definition at line 156 of file class.ilBookingReservation.php.

156 : void
157 {
158 $this->group_id = $a_group_id;
159 }

Referenced by read().

+ Here is the caller graph for this function:

◆ setMessage()

ilBookingReservation::setMessage ( string  $message)

Definition at line 81 of file class.ilBookingReservation.php.

81 : void
82 {
83 $this->message = $message;
84 }

References $message.

Referenced by read().

+ Here is the caller graph for this function:

◆ setObjectId()

ilBookingReservation::setObjectId ( int  $a_object_id)

Definition at line 61 of file class.ilBookingReservation.php.

61 : void
62 {
63 $this->object_id = $a_object_id;
64 }

Referenced by read().

+ Here is the caller graph for this function:

◆ setStatus()

ilBookingReservation::setStatus ( ?int  $a_status)

Set booking status.

Definition at line 133 of file class.ilBookingReservation.php.

133 : void
134 {
135 if ($a_status === null) {
136 $this->status = 0;
137 }
138 if (self::isValidStatus((int) $a_status)) {
139 $this->status = (int) $a_status;
140 }
141 }

References ILIAS\Repository\int().

Referenced by read().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setTo()

ilBookingReservation::setTo ( int  $a_to)

Set booking to date.

Definition at line 120 of file class.ilBookingReservation.php.

120 : void
121 {
122 $this->to = $a_to;
123 }
to(\GdImage $image, ?int $quality=null)
Currently this is the only way to make a FileStream from a GD image resource.

References ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\to().

Referenced by read().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setUserId()

ilBookingReservation::setUserId ( int  $a_user_id)

Definition at line 71 of file class.ilBookingReservation.php.

71 : void
72 {
73 $this->user_id = $a_user_id;
74 }

Referenced by read().

+ Here is the caller graph for this function:

◆ update()

ilBookingReservation::update ( )

Definition at line 218 of file class.ilBookingReservation.php.

218 : bool
219 {
220 if (!$this->id) {
221 return false;
222 }
223
224 $this->repo->update(
225 $this->id,
226 $this->getUserId(),
227 $this->getAssignerId(),
228 $this->getObjectId(),
229 $this->getContextObjId(),
230 $this->getFrom(),
231 $this->getTo(),
232 $this->getStatus(),
233 $this->getGroupId(),
234 $this->getMessage()
235 );
236 return true;
237 }

References getAssignerId(), getContextObjId(), getFrom(), getGroupId(), getMessage(), getObjectId(), getStatus(), getTo(), and getUserId().

+ Here is the call graph for this function:

Field Documentation

◆ $assigner_id

int ilBookingReservation::$assigner_id = 0
protected

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

Referenced by getAssignerId().

◆ $context_obj_id

int ilBookingReservation::$context_obj_id = 0
protected

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

Referenced by getContextObjId().

◆ $db

ilDBInterface ilBookingReservation::$db
protected

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

◆ $from

int ilBookingReservation::$from = 0
protected

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

Referenced by getFrom().

◆ $group_id

int ilBookingReservation::$group_id = 0
protected

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

Referenced by getGroupId().

◆ $id

int ilBookingReservation::$id = 0
protected

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

Referenced by getId().

◆ $message

string ilBookingReservation::$message = ""
protected

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

Referenced by getMessage(), and setMessage().

◆ $object_id

int ilBookingReservation::$object_id = 0
protected

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

Referenced by getObjectId().

◆ $repo

ILIAS BookingManager Reservations ReservationDBRepository ilBookingReservation::$repo
protected

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

◆ $status

int ilBookingReservation::$status = 0
protected

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

Referenced by getStatus().

◆ $to

int ilBookingReservation::$to = 0
protected

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

Referenced by getTo().

◆ $user_id

int ilBookingReservation::$user_id = 0
protected

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

Referenced by getUserId().

◆ STATUS_CANCELLED

◆ STATUS_IN_USE

const ilBookingReservation::STATUS_IN_USE = 2

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