ilBookingReservation Class Reference

a booking reservation More...

Collaboration diagram for ilBookingReservation:

Public Member Functions
	__construct ($a_id=null)
	Constructor. More...
	getId ()
	Get id. More...
	setObjectId ($a_object_id)
	Set object id. More...
	getObjectId ()
	Get object id. More...
	setUserId ($a_user_id)
	Set booking user id. More...
	getUserId ()
	Get booking user id. More...
	setAssignerId ($a_assigner_id)
	Set assigner user id. More...
	getAssignerId ()
	Get assigner user id. More...
	setFrom ($a_from)
	Set booking from date. More...
	getFrom ()
	Get booking from date. More...
	setTo ($a_to)
	Set booking to date. More...
	getTo ()
	Get booking to date. More...
	setStatus ($a_status)
	Set booking status. More...
	getStatus ()
	Get booking status. More...
	setGroupId ($a_group_id)
	Set group id. More...
	getGroupId ()
	Get group id. More...
	setContextObjId ($a_val)
	Set context object id. More...
	getContextObjId ()
	Get context object id. More...
	save ()
	Create new entry in db. More...
	update ()
	Update entry in db. More...
	delete ()
	Delete single entry. More...
	getCalendarEntry ()

Static Public Member Functions
static	isValidStatus ($a_status)
	Check if given status is valid. More...
static	getAvailableObject (array $a_ids, $a_from, $a_to, $a_return_single=true, $a_return_counter=false)
	Check if any of given objects are bookable. More...
static	isObjectAvailableInPeriod ($a_obj_id, ilBookingSchedule $a_schedule, $a_from, $a_to)
static	isBookingPoolLimitReachedByUser (int $a_user_id, int $a_pool_id)
static	getMembersWithoutReservation (int $a_object_id)
static	isObjectAvailableNoSchedule ($a_obj_id)
static	numAvailableFromObjectNoSchedule ($a_obj_id)
static	getNumAvailablesNoSchedule ($a_obj_id)
static	getCurrentOrUpcomingReservation ($a_object_id)
	Get details about object reservation. More...
static	getObjectReservationForUser ($a_object_id, $a_user_id, $a_multi=false)
static	getList ($a_object_ids, $a_limit=10, $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, $a_status)
	Batch update reservation status. More...
static	getCancelDetails ($a_obj_id, $a_user_id, $a_from, $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 ()
	Get dataset from db. More...

Protected Attributes
	$db
	$id
	$object_id
	$user_id
	$from
	$to
	$status
	$group_id
	$assigner_id
	$context_obj_id = 0
	$repo

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilBookingReservation::__construct

(

$a_id = null

)

Constructor.

if id is given will read dataset from db

Parameters

int

$a_id

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

References $DIC, Vendor\Package\$f, 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,   $a_status  )

static

Batch update reservation status.

Parameters

array	$a_ids
int	$a_status

Returns

bool

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

References $DIC, and $ilDB.

Referenced by ilBookingReservationsGUI\changeStatusObject().

    {
        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'));
        }
    }

Here is the caller graph for this function:

delete()

ilBookingReservation::delete

(

)

Delete single entry.

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

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

getAssignerId()

ilBookingReservation::getAssignerId

(

)

Get assigner user id.

Returns

int

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

References $assigner_id.

Referenced by save(), and update().

    {
        return $this->assigner_id;
    }

Here is the caller graph for this function:

getAvailableObject()

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

static

Check if any of given objects are bookable.

Parameters

array	$a_ids
int	$a_from
int	$a_to
int	$a_return_single

Returns

int

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

References Vendor\Package\$f, $id, $repo, ilBookingSchedule\getAvailabilityFrom(), ilBookingObject\getNrOfItemsForObjects(), IL_CAL_DATE, and IL_CAL_UNIX.

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

    {
        $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']] = (int) $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())
                    ? strtotime($schedule->getAvailabilityTo()->get(IL_CAL_DATE) . " 23:59:59")
                    : 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 (sizeof($available)) {
            if ($a_return_counter) {
                foreach ($a_ids as $id) {
                    if (!isset($counter[$id])) {
                        $counter[$id] = (int) $nr_map[$id];
                    }
                }
                return $counter;
            } elseif ($a_return_single) {
                return array_shift($available);
            } else {
                return $available;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCalendarEntry()

ilBookingReservation::getCalendarEntry

(

)

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

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

    {
        $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 $row["cal_id"];
    }

Here is the call graph for this function:

getCancelDetails()

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

static

Get reservation ids from aggregated id for cancellation.

Parameters

int	$a_obj_id
int	$a_user_id
int	$a_from
int	$a_to

Returns

array

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

References $DIC, $ilDB, and $res.

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

    {
        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[] = $row["booking_reservation_id"];
        }
        
        return $res;
    }

Here is the caller graph for this function:

getContextObjId()

ilBookingReservation::getContextObjId

(

)

Get context object id.

Returns

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

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

References $context_obj_id.

Referenced by save(), and update().

    {
        return $this->context_obj_id;
    }

Here is the caller graph for this function:

getCurrentOrUpcomingReservation()

static ilBookingReservation::getCurrentOrUpcomingReservation (   $a_object_id )

static

Get details about object reservation.

Parameters

int

$a_object_id

Returns

array

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

References $DIC, and $ilDB.

    {
        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');
        $row = $ilDB->fetchAssoc($set);
        return $row;
    }

getFrom()

ilBookingReservation::getFrom

(

)

Get booking from date.

Returns

int

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

References $from.

Referenced by save(), and update().

    {
        return $this->from;
    }

Here is the caller graph for this function:

getGroupId()

ilBookingReservation::getGroupId

(

)

Get group id.

Returns

int

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

References $group_id.

Referenced by save(), and update().

    {
        return $this->group_id;
    }

Here is the caller graph for this function:

getId()

ilBookingReservation::getId

(

)

Get id.

Returns

int

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

References $id.

Referenced by getCalendarEntry().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getList()

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

static

List all reservations.

Parameters

array	$a_object_ids
int	$a_limit
int	$a_offset
array	$a_offset

Returns

array

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

References $DIC, $ilDB, and $res.

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

    {
        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 ($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 ($filter['from']) {
            $where[] = 'date_from >= ' . $ilDB->quote($filter['from'], 'integer');
        }
        if ($filter['to']) {
            $where[] = 'date_to <= ' . $ilDB->quote($filter['to'], 'integer');
        }
        if (sizeof($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

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

References $DIC, $ilDB, $query, $res, ilBookingObject\lookupPoolId(), and STATUS_CANCELLED.

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 <> ' . ilBookingReservation::STATUS_CANCELLED . '))';

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

        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $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 (   $a_obj_id )

static

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

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

Referenced by ilBookingPreferencesManager\calculateBookings().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $all = ilBookingObject::getNrOfItemsForObjects(array($a_obj_id));
        $all = (int) $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 (int) $all - $cnt; // #11864
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getObjectId()

ilBookingReservation::getObjectId

(

)

Get object id.

Returns

int

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

References $object_id.

Referenced by save(), and update().

    {
        return $this->object_id;
    }

Here is the caller graph for this function:

getObjectReservationForUser()

static ilBookingReservation::getObjectReservationForUser (   $a_object_id,   $a_user_id,   $a_multi = false  )

static

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

References $DIC, $ilDB, and $res.

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

    {
        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)');
        if (!$a_multi) {
            $row = $ilDB->fetchAssoc($set);
            return $row['booking_reservation_id'];
        } else {
            $res = array();
            while ($row = $ilDB->fetchAssoc($set)) {
                $res[] = $row['booking_reservation_id'];
            }
            return $res;
        }
    }

Here is the caller graph for this function:

getStatus()

ilBookingReservation::getStatus

(

)

Get booking status.

Returns

int

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

References $status.

Referenced by save(), and update().

    {
        return $this->status;
    }

Here is the caller graph for this function:

getTo()

ilBookingReservation::getTo

(

)

Get booking to date.

Returns

int

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

References $to.

Referenced by save(), and update().

    {
        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

array

$a_object_ids

Returns

array

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

References $DIC, $ilDB, and $res.

Referenced by ilBookingReservationsTableGUI\initFilter().

    {
        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

(

)

Get booking user id.

Returns

int

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

References $user_id.

Referenced by save(), and update().

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

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

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 <> " . ilBookingReservation::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 (   $a_obj_id, ilBookingSchedule  $a_schedule,   $a_from,   $a_to  )

static

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

References $DIC, Vendor\Package\$f, $ilDB, $repo, $res, ilBookingSchedule\getAvailabilityFrom(), ilBookingSchedule\getAvailabilityTo(), ilBookingSchedule\getDefinition(), ilBookingObject\getNrOfItemsForObjects(), IL_CAL_DATE, and IL_CAL_UNIX.

Referenced by ilBookingObjectsTableGUI\getItems().

    {
        global $DIC;

        $ilDB = $DIC->database();
            
        if (!$a_from) {
            $a_from = time();
        }
        if (!$a_to) {
            $a_to = strtotime("+1year", $a_from);
        }
        
        if ($a_from > $a_to) {
            return;
        }

        // 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"];

        $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)];
            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_to > time() &&
                        $slot_from >= $av_from &&
                        ($slot_to <= $av_to || is_null($av_to))) {
                        $available_in_period += $per_slot;
                    }
                }
            }
            
            $a_from += (60 * 60 * 24);
        }
        if ($available_in_period - $booked_in_period > 0) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isObjectAvailableNoSchedule()

static ilBookingReservation::isObjectAvailableNoSchedule (   $a_obj_id )

static

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

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

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

Here is the caller graph for this function:

isValidStatus()

static ilBookingReservation::isValidStatus (   $a_status )

static

Check if given status is valid.

Parameters

int

$a_status

Returns

bool

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

Referenced by setStatus().

    {
        if (in_array($a_status, array(self::STATUS_IN_USE, self::STATUS_CANCELLED))) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

numAvailableFromObjectNoSchedule()

static ilBookingReservation::numAvailableFromObjectNoSchedule (   $a_obj_id )

static

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

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

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

Here is the caller graph for this function:

read()

ilBookingReservation::read ( )

protected

Get dataset from db.

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

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

Referenced by __construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBookingReservation::save

(

)

Create new entry in db.

Returns

bool

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

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

    {
        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

(

$a_assigner_id

)

Set assigner user id.

Parameters

$a_assigner_id

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

Referenced by read().

    {
        $this->assigner_id = (int) $a_assigner_id;
    }

Here is the caller graph for this function:

setContextObjId()

ilBookingReservation::setContextObjId

(

$a_val

)

Set context object id.

Parameters

int

$a_val

context object id (e.g. course id)

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

Referenced by read().

    {
        $this->context_obj_id = $a_val;
    }

Here is the caller graph for this function:

setFrom()

ilBookingReservation::setFrom

(

$a_from

)

Set booking from date.

Parameters

int

$a_from

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

Referenced by read().

    {
        $this->from = (int) $a_from;
    }

Here is the caller graph for this function:

setGroupId()

ilBookingReservation::setGroupId

(

$a_group_id

)

Set group id.

Parameters

int

$a_group_id

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

Referenced by read().

    {
        $this->group_id = $a_group_id;
    }

Here is the caller graph for this function:

setObjectId()

ilBookingReservation::setObjectId

(

$a_object_id

)

Set object id.

Parameters

int

$a_object_id

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

Referenced by read().

    {
        $this->object_id = $a_object_id;
    }

Here is the caller graph for this function:

setStatus()

ilBookingReservation::setStatus

(

$a_status

)

Set booking status.

Parameters

int

$a_status

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

References isValidStatus().

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

    {
        if ($a_status === null) {
            $this->status = null;
        }
        if ($this->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

(

$a_to

)

Set booking to date.

Parameters

int

$a_to

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

Referenced by read().

    {
        $this->to = (int) $a_to;
    }

Here is the caller graph for this function:

setUserId()

ilBookingReservation::setUserId

(

$a_user_id

)

Set booking user id.

Parameters

int

$a_user_id

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

Referenced by read().

    {
        $this->user_id = (int) $a_user_id;
    }

Here is the caller graph for this function:

update()

ilBookingReservation::update

(

)

Update entry in db.

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

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

    {
        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

ilBookingReservation::$assigner_id

protected

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

Referenced by getAssignerId().

$context_obj_id

ilBookingReservation::$context_obj_id = 0

protected

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

Referenced by getContextObjId().

$db

ilBookingReservation::$db

protected

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

Referenced by getCalendarEntry().

$from

ilBookingReservation::$from

protected

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

Referenced by getFrom().

$group_id

ilBookingReservation::$group_id

protected

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

Referenced by getGroupId().

$id

ilBookingReservation::$id

protected

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

Referenced by getAvailableObject(), and getId().

$object_id

ilBookingReservation::$object_id

protected

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

Referenced by getObjectId().

$repo

ilBookingReservation::$repo

protected

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

Referenced by getAvailableObject(), and isObjectAvailableInPeriod().

$status

ilBookingReservation::$status

protected

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

Referenced by getStatus().

$to

ilBookingReservation::$to

protected

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

Referenced by getTo().

$user_id

ilBookingReservation::$user_id

protected

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

Referenced by getUserId().

STATUS_CANCELLED

const ilBookingReservation::STATUS_CANCELLED = 5

Definition at line 34 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(), getMembersWithoutReservation(), ilBookingReservationDBRepository\getNumberOfReservations(), ilBookingReservationsTableGUI\initFilter(), isBookingPoolLimitReachedByUser(), ilBookingReservationDBRepository\preloadByContextIds(), ilBookingReservationsGUI\rsvCancel(), and ilBookingReservationsGUI\rsvCancelUser().

STATUS_IN_USE

const ilBookingReservation::STATUS_IN_USE = 2

Definition at line 33 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/classes/class.ilBookingReservation.php