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 ()
	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
ilBookingReservationDBRepository	$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 40 of file class.ilBookingReservation.php.

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

      {
        global $DIC;

        $this->db = $DIC->database();
        $this->id = (int) $a_id;

        $f = new ilBookingReservationDBRepositoryFactory();
        $this->repo = $f->getRepo();

        $this->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_ids reservation ids
int	$a_status

Returns

int number of changed entries

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

References $DIC, and $ilDB.

Referenced by ilBookingReservationsGUI\changeStatusObject().

     : int {
        global $DIC;

        $ilDB = $DIC->database();

        if (self::isValidStatus($a_status)) {
            return $ilDB->manipulate('UPDATE booking_reservation' .
                ' SET status = ' . $ilDB->quote($a_status, 'integer') .
                ' WHERE ' . $ilDB->in('booking_reservation_id', $a_ids, '', 'integer'));
        }
        return 0;
    }

Here is the caller graph for this function:

delete()

ilBookingReservation::delete

(

)

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

                            : void
    {
        $this->repo->delete($this->id);
    }

getAssignerId()

ilBookingReservation::getAssignerId

(

)

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

References $assigner_id.

Referenced by save(), and update().

                                   : int
    {
        return $this->assigner_id;
    }

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 233 of file class.ilBookingReservation.php.

References Vendor\Package\$f, $id, ilBookingSchedule\getAvailabilityFrom(), ilBookingObject\getNrOfItemsForObjects(), ilBookingReservationDBRepository\getNumberOfReservations(), IL_CAL_UNIX, and ILIAS\Repository\int().

Referenced by ilBookingProcessGUI\book(), ilBookingProcessGUI\confirmedBooking(), and ilBookingProcessGUI\confirmedBookingNumbers().

     : array {
        $nr_map = ilBookingObject::getNrOfItemsForObjects($a_ids);

        $f = new ilBookingReservationDBRepositoryFactory();
        $repo = $f->getRepo();

        $blocked = $counter = array();
        foreach ($repo->getNumberOfReservations($a_ids, $a_from, $a_to) as $row) {
            if ($row['cnt'] >= $nr_map[$row['object_id']]) {
                $blocked[] = $row['object_id'];
            } elseif ($a_return_counter) {
                $counter[$row['object_id']] = $nr_map[$row['object_id']] - (int) $row['cnt'];
            }
        }

        // #17868 - validate against schedule availability
        foreach ($a_ids as $obj_id) {
            $bobj = new ilBookingObject($obj_id);
            if ($bobj->getScheduleId()) {
                $schedule = new ilBookingSchedule($bobj->getScheduleId());

                $av_from = ($schedule->getAvailabilityFrom() && !$schedule->getAvailabilityFrom()->isNull())
                    ? $schedule->getAvailabilityFrom()->get(IL_CAL_UNIX)
                    : null;
                $av_to = ($schedule->getAvailabilityTo() && !$schedule->getAvailabilityTo()->isNull())
                    ? $schedule->getAvailabilityTo()->get(IL_CAL_UNIX)
                    : null;

                if (($av_from && $a_from < $av_from) ||
                    ($av_to && $a_to > $av_to)) {
                    $blocked[] = $obj_id;
                    unset($counter[$obj_id]);
                }
            }
        }

        $available = array_diff($a_ids, $blocked);
        if (count($available)) {
            if ($a_return_counter) {
                foreach ($a_ids as $id) {
                    if (!isset($counter[$id])) {
                        $counter[$id] = $nr_map[$id];
                    }
                }
                return $counter;
            }
            if ($a_return_single) {
                return array_shift($available);
            }
            return $available;
        }
        return [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCalendarEntry()

ilBookingReservation::getCalendarEntry

(

)

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

References $db, $ilDB, getId(), and ilCalendarCategory\TYPE_BOOK.

                                      : int
    {
        $ilDB = $this->db;

        $set = $ilDB->query("SELECT ce.cal_id FROM cal_entries ce" .
            " JOIN cal_cat_assignments cca ON ce.cal_id = cca.cal_id" .
            " JOIN cal_categories cc ON cca.cat_id = cc.cat_id" .
            " JOIN booking_reservation br ON ce.context_id  = br.booking_reservation_id" .
            " WHERE cc.obj_id = " . $ilDB->quote($this->getUserId(), 'integer') .
            " AND br.user_id = " . $ilDB->quote($this->getUserId(), 'integer') .
            " AND cc.type = " . $ilDB->quote(ilCalendarCategory::TYPE_BOOK, 'integer') .
            " AND ce.context_id = " . $ilDB->quote($this->getId(), 'integer'));
        $row = $ilDB->fetchAssoc($set);
        return (int) ($row["cal_id"] ?? 0);
    }

Here is the call graph for this function:

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 622 of file class.ilBookingReservation.php.

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

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

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $res = array();

        $sql = "SELECT booking_reservation_id" .
            " FROM booking_reservation" .
            " WHERE object_id = " . $ilDB->quote($a_obj_id, "integer") .
            " AND user_id = " . $ilDB->quote($a_user_id, "integer") .
            " AND date_from = " . $ilDB->quote($a_from, "integer") .
            " AND date_to = " . $ilDB->quote($a_to, "integer") .
            " AND (status IS NULL" .
            " OR status <> " . $ilDB->quote(self::STATUS_CANCELLED, "integer") . ")";
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row["booking_reservation_id"];
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContextObjId()

ilBookingReservation::getContextObjId

(

)

Returns

int context object id (e.g. course id)

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

References $context_obj_id.

Referenced by save(), and update().

                                     : int
    {
        return $this->context_obj_id;
    }

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 446 of file class.ilBookingReservation.php.

References $DIC, and $ilDB.

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $now = $ilDB->quote(time(), 'integer');

        $ilDB->setLimit(1);
        $set = $ilDB->query('SELECT user_id, status, date_from, date_to' .
            ' FROM booking_reservation' .
            ' WHERE ((date_from <= ' . $now . ' AND date_to >= ' . $now . ')' .
            ' OR date_from > ' . $now . ')' .
            ' AND (status <> ' . $ilDB->quote(self::STATUS_CANCELLED, 'integer') .
            ' OR STATUS IS NULL) AND object_id = ' . $ilDB->quote($a_object_id, 'integer') .
            ' ORDER BY date_from');
        return $ilDB->fetchAssoc($set);
    }

getFrom()

ilBookingReservation::getFrom

(

)

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

References $from.

Referenced by save(), and update().

                             : int
    {
        return $this->from;
    }

Here is the caller graph for this function:

getGroupId()

ilBookingReservation::getGroupId

(

)

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

References $group_id.

Referenced by save(), and update().

                                : int
    {
        return $this->group_id;
    }

Here is the caller graph for this function:

getId()

ilBookingReservation::getId

(

)

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

References $id.

Referenced by getCalendarEntry().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

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 493 of file class.ilBookingReservation.php.

References $DIC, $ilDB, and $res.

Referenced by ilBookingPrefBasedBookGatewayRepository\getBookings(), and ilBookingObjectsTableGUI\getItems().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $sql = 'SELECT r.*,o.title' .
            ' FROM booking_reservation r' .
            ' JOIN booking_object o ON (o.booking_object_id = r.object_id)';

        $count_sql = 'SELECT COUNT(*) AS counter' .
            ' FROM booking_reservation r' .
            ' JOIN booking_object o ON (o.booking_object_id = r.object_id)';

        $where = array($ilDB->in('r.object_id', $a_object_ids, '', 'integer'));
        if (isset($filter['status'])) {
            if ($filter['status'] > 0) {
                $where[] = 'status = ' . $ilDB->quote($filter['status'], 'integer');
            } else {
                $where[] = '(status != ' . $ilDB->quote(-$filter['status'], 'integer') .
                    ' OR status IS NULL)';
            }
        }
        if (isset($filter['from'])) {
            $where[] = 'date_from >= ' . $ilDB->quote($filter['from'], 'integer');
        }
        if (isset($filter['to'])) {
            $where[] = 'date_to <= ' . $ilDB->quote($filter['to'], 'integer');
        }
        if (count($where)) {
            $sql .= ' WHERE ' . implode(' AND ', $where);
            $count_sql .= ' WHERE ' . implode(' AND ', $where);
        }

        $set = $ilDB->query($count_sql);
        $row = $ilDB->fetchAssoc($set);
        $counter = $row['counter'];

        $sql .= ' ORDER BY date_from DESC, booking_reservation_id DESC';

        $ilDB->setLimit($a_limit, $a_offset);
        $set = $ilDB->query($sql);
        $res = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }

        return array('data' => $res, 'counter' => $counter);
    }

Here is the caller graph for this function:

getMembersWithoutReservation()

static ilBookingReservation::getMembersWithoutReservation ( int  $a_object_id )

static

Returns

int[]

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

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

Referenced by ilBookingParticipant\getAssignableParticipants().

     : array {
        global $DIC;
        $ilDB = $DIC->database();

        $pool_id = ilBookingObject::lookupPoolId($a_object_id);

        $res = array();
        $query = 'SELECT DISTINCT bm.user_id user_id' .
            ' FROM booking_member bm' .
            ' WHERE bm.booking_pool_id = ' . $ilDB->quote($pool_id, 'integer') .
            ' AND bm.user_id NOT IN (' .
            'SELECT user_id' .
            ' FROM booking_reservation' .
            ' WHERE object_id = ' . $ilDB->quote($a_object_id, 'integer') .
            ' AND (status IS NULL OR status <> ' . self::STATUS_CANCELLED . '))';

        $set = $ilDB->query($query);

        while ($row = $ilDB->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:

getNumAvailablesNoSchedule()

static ilBookingReservation::getNumAvailablesNoSchedule ( int  $a_obj_id )

static

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

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

Referenced by ilBookingPreferencesManager\calculateBookings().

                                                                    : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $all = ilBookingObject::getNrOfItemsForObjects(array($a_obj_id));
        $all = $all[$a_obj_id];

        $set = $ilDB->query('SELECT COUNT(*) cnt' .
            ' FROM booking_reservation r' .
            ' JOIN booking_object o ON (o.booking_object_id = r.object_id)' .
            ' WHERE (status IS NULL OR status <> ' . $ilDB->quote(self::STATUS_CANCELLED, 'integer') . ')' .
            ' AND r.object_id = ' . $ilDB->quote($a_obj_id, 'integer'));
        $cnt = $ilDB->fetchAssoc($set);
        $cnt = (int) $cnt['cnt'];

        return $all - $cnt; // #11864
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectId()

ilBookingReservation::getObjectId

(

)

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

References $object_id.

Referenced by save(), and update().

                                 : int
    {
        return $this->object_id;
    }

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 469 of file class.ilBookingReservation.php.

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

Referenced by ilBookingProcessGUI\confirmedBooking(), ilBookingProcessGUI\deliverPostFile(), ilBookingProcessGUI\displayPostInfo(), ilBookingAssignObjectsTableGUI\getItems(), ilBookingParticipant\isParticipantAssigned(), ilBookingReservationsGUI\rsvCancelUser(), and ilBookingPrefBasedBookGatewayRepository\storeBookings().

     : ?array {
        global $DIC;

        $ilDB = $DIC->database();

        $set = $ilDB->query('SELECT booking_reservation_id FROM booking_reservation' .
            ' WHERE user_id = ' . $ilDB->quote($a_user_id, 'integer') .
            ' AND object_id = ' . $ilDB->quote($a_object_id, 'integer') .
            ' AND (status <> ' . $ilDB->quote(self::STATUS_CANCELLED, 'integer') .
            ' OR STATUS IS NULL)');
        $res = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row['booking_reservation_id'];
        }
        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getStatus()

ilBookingReservation::getStatus

(

)

Get booking status.

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

References $status.

Referenced by save(), and update().

                               : ?int
    {
        return $this->status;
    }

Here is the caller graph for this function:

getTo()

ilBookingReservation::getTo

(

)

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

References $to.

Referenced by save(), and update().

                           : int
    {
        return $this->to;
    }

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 554 of file class.ilBookingReservation.php.

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

Referenced by ilBookingReservationsTableGUI\initFilter().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $res = array();

        $sql = "SELECT ud.usr_id,ud.lastname,ud.firstname,ud.login" .
            " FROM usr_data ud " .
            " LEFT JOIN booking_reservation r ON (r.user_id = ud.usr_id)" .
            " WHERE ud.usr_id <> " . $ilDB->quote(ANONYMOUS_USER_ID, "integer") .
            " AND " . $ilDB->in("r.object_id", $a_object_ids, "", "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:

getUserId()

ilBookingReservation::getUserId

(

)

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

References $user_id.

Referenced by save(), and update().

                               : int
    {
        return $this->user_id;
    }

Here is the caller graph for this function:

isBookingPoolLimitReachedByUser()

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

static

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_ASSOC, and ilBookingObject\getObjectsForPool().

Referenced by ilBookingParticipant\getAssignableParticipants().

     : int {
        global $DIC;
        $ilDB = $DIC->database();

        $booking_pool_objects = ilBookingObject::getObjectsForPool($a_pool_id);

        $query = "SELECT count(user_id) total" .
            " FROM booking_reservation" .
            " WHERE " . $ilDB->in('object_id', $booking_pool_objects, false, 'integer') .
            " AND user_id = " . $a_user_id .
            " AND (status IS NULL OR status <> " . self::STATUS_CANCELLED . ')';
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_ASSOC);

        return (int) $row['total'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isObjectAvailableInPeriod()

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

static

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

References Vendor\Package\$f, $res, ilBookingSchedule\getAvailabilityFrom(), ilBookingSchedule\getAvailabilityTo(), ilBookingSchedule\getDefinition(), ilBookingObject\getNrOfItemsForObjects(), ilBookingReservationDBRepository\getNumberOfReservations(), IL_CAL_DATE, IL_CAL_UNIX, and ILIAS\Repository\int().

Referenced by ilBookingObjectsTableGUI\getItems().

     : bool {
        if (!$a_from) {
            $a_from = time();
        }
        if (!$a_to) {
            $a_to = strtotime("+1year", $a_from);
        }

        if ($a_from > $a_to) {
            return false;
        }

        // all nr of reservations in period that are not over yet (to >= now)
        $f = new ilBookingReservationDBRepositoryFactory();
        $repo = $f->getRepo();
        $res = $repo->getNumberOfReservations([$a_obj_id], $a_from, $a_to, true);
        $booked_in_period = (int) ($res[$a_obj_id]["cnt"] ?? 0);

        $per_slot = ilBookingObject::getNrOfItemsForObjects(array($a_obj_id));
        $per_slot = $per_slot[$a_obj_id];

        // max available nr of items per (week)day
        $schedule_slots = array();
        $definition = $a_schedule->getDefinition();
        $map = array_flip(array("su", "mo", "tu", "we", "th", "fr", "sa"));
        foreach ($definition as $day => $day_slots) {
            $schedule_slots[$map[$day]] = $day_slots;
        }

        $av_from = ($a_schedule->getAvailabilityFrom() && !$a_schedule->getAvailabilityFrom()->isNull())
            ? $a_schedule->getAvailabilityFrom()->get(IL_CAL_UNIX)
            : null;
        $av_to = ($a_schedule->getAvailabilityTo() && !$a_schedule->getAvailabilityTo()->isNull())
            ? strtotime($a_schedule->getAvailabilityTo()->get(IL_CAL_DATE) . " 23:59:59")
            : null;

        // sum up max available (to >= now) items in period per (week)day
        $available_in_period = 0;
        $loop = 0;
        while ($a_from < $a_to &&
            ++$loop < 1000) {
            // any slots for current weekday?
            $day_slots = $schedule_slots[date("w", $a_from)] ?? false;
            if ($day_slots) {
                foreach ($day_slots as $slot) {
                    // convert slot to current datetime
                    $slot = explode("-", $slot);
                    $slot_from = strtotime(date("Y-m-d", $a_from) . " " . $slot[0]);
                    $slot_to = strtotime(date("Y-m-d", $a_from) . " " . $slot[1]);
                    // slot has to be in the future and part of schedule availability
                    if ($slot_from >= $av_from &&
                        ($slot_to <= $av_to || is_null($av_to)) &&
                        $slot_to > time()) {
                        $available_in_period += $per_slot;
                    }
                }
            }

            $a_from += (60 * 60 * 24);
        }
        return $available_in_period - $booked_in_period > 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isObjectAvailableNoSchedule()

static ilBookingReservation::isObjectAvailableNoSchedule ( int  $a_obj_id )

static

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

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

                                                                     : bool
    {
        $available = self::getNumAvailablesNoSchedule($a_obj_id);
        return (bool) $available; // #11864
    }

Here is the caller graph for this function:

isValidStatus()

static ilBookingReservation::isValidStatus ( int  $a_status )

static

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

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

numAvailableFromObjectNoSchedule()

static ilBookingReservation::numAvailableFromObjectNoSchedule ( int  $a_obj_id )

static

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

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

                                                                          : int
    {
        return self::getNumAvailablesNoSchedule($a_obj_id);
    }

Here is the caller graph for this function:

read()

ilBookingReservation::read ( )

protected

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

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

Referenced by __construct().

                             : void
    {
        if ($this->id) {
            $row = $this->repo->getForId($this->id);
            $this->setUserId($row['user_id']);
            $this->setAssignerId((int) $row['assigner_id']);
            $this->setObjectId($row['object_id']);
            $this->setFrom($row['date_from']);
            $this->setTo($row['date_to']);
            $this->setStatus($row['status']);
            $this->setGroupId((int) $row['group_id']);
            $this->setContextObjId((int) $row['context_obj_id']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBookingReservation::save

(

)

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

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

                          : bool
    {
        if ($this->id) {
            return false;
        }

        $this->id = $this->repo->create(
            $this->getUserId(),
            $this->getAssignerId(),
            $this->getObjectId(),
            $this->getContextObjId(),
            $this->getFrom(),
            $this->getTo(),
            $this->getStatus(),
            $this->getGroupId()
        );
        return ($this->id > 0);
    }

Here is the call graph for this function:

setAssignerId()

ilBookingReservation::setAssignerId

(

int

$a_assigner_id

)

Set assigner user id.

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

Referenced by read().

                                                     : void
    {
        $this->assigner_id = $a_assigner_id;
    }

Here is the caller graph for this function:

setContextObjId()

ilBookingReservation::setContextObjId

(

int

$a_val

)

Parameters

int

$a_val

context object id (e.g. course id)

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

Referenced by read().

                                               : void
    {
        $this->context_obj_id = $a_val;
    }

Here is the caller graph for this function:

setFrom()

ilBookingReservation::setFrom

(

int

$a_from

)

Set booking from date.

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

Referenced by read().

                                        : void
    {
        $this->from = $a_from;
    }

Here is the caller graph for this function:

setGroupId()

ilBookingReservation::setGroupId

(

int

$a_group_id

)

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

Referenced by read().

                                               : void
    {
        $this->group_id = $a_group_id;
    }

Here is the caller graph for this function:

setObjectId()

ilBookingReservation::setObjectId

(

int

$a_object_id

)

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

Referenced by read().

                                                 : void
    {
        $this->object_id = $a_object_id;
    }

Here is the caller graph for this function:

setStatus()

ilBookingReservation::setStatus

(

?int

$a_status

)

Set booking status.

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

References ILIAS\Repository\int().

Referenced by ilCalendarAppointmentGUI\cancelConfirmed(), and read().

                                             : void
    {
        if ($a_status === null) {
            $this->status = 0;
        }
        if (self::isValidStatus((int) $a_status)) {
            $this->status = (int) $a_status;
        }
    }

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 108 of file class.ilBookingReservation.php.

Referenced by read().

                                    : void
    {
        $this->to = $a_to;
    }

Here is the caller graph for this function:

setUserId()

ilBookingReservation::setUserId

(

int

$a_user_id

)

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

Referenced by read().

                                             : void
    {
        $this->user_id = $a_user_id;
    }

Here is the caller graph for this function:

update()

ilBookingReservation::update

(

)

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

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

                            : bool
    {
        if (!$this->id) {
            return false;
        }

        $this->repo->update(
            $this->id,
            $this->getUserId(),
            $this->getAssignerId(),
            $this->getObjectId(),
            $this->getContextObjId(),
            $this->getFrom(),
            $this->getTo(),
            $this->getStatus(),
            $this->getGroupId()
        );
        return true;
    }

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.

Referenced by getCalendarEntry().

$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 getAvailableObject(), and getId().

$object_id

int ilBookingReservation::$object_id = 0

protected

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

Referenced by getObjectId().

$repo

ilBookingReservationDBRepository ilBookingReservation::$repo

protected

Definition at line 38 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

const ilBookingReservation::STATUS_CANCELLED = 5

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

Referenced by ilCalendarAppointmentGUI\cancelConfirmed(), ilBookingObjectsTableGUI\fillRow(), ilBookingReservationsTableGUI\fillRow(), ilBookingReservationsTableGUI\fillRowCSV(), ilBookingReservationsTableGUI\fillRowExcel(), ilBookingPrefBasedBookGatewayRepository\getBookings(), ilBookingReservationsTableGUI\getCurrentFilter(), ilBookingObjectsTableGUI\getItems(), ilBookingInfoScreenAdapter\getList(), ilBookingParticipant\getList(), ilBookingReservationDBRepository\getListByDate(), ilBookingReservationDBRepository\getNumberOfReservations(), ilBookingReservationsTableGUI\initFilter(), ilBookingReservationDBRepository\preloadByContextIds(), ilBookingReservationsGUI\rsvCancel(), and ilBookingReservationsGUI\rsvCancelUser().

STATUS_IN_USE

const ilBookingReservation::STATUS_IN_USE = 2

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

Referenced by ilBookingReservationsTableGUI\fillRow(), ilBookingReservationsTableGUI\fillRowCSV(), and ilBookingReservationsTableGUI\fillRowExcel().

---

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

• Modules/BookingManager/Reservations/class.ilBookingReservation.php