Booking definition. More...

Collaboration diagram for ilBookingEntry:

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

	getId ()
	Get id. More...

	setBookingGroup ($a_id)

	getBookingGroup ()

	setObjId ($a_id)
	Set obj id. More...

	getObjId ()
	get obj id More...

	setDeadlineHours ($a_hours)
	set deadline hours More...

	getDeadlineHours ()
	get deadline hours More...

	setNumberOfBookings ($a_num)
	set number of bookings More...

	getNumberOfBookings ()
	get number of bookings More...

	setTargetObjIds ($a_obj_id)
	set target object id More...

	getTargetObjIds ()
	get target object id More...

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

	save ()
	Save a new booking entry. More...

	update ()
	Update an existing booking entry. More...

	delete ()
	Delete. More...

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

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

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

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

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

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

	book ($a_entry_id, $a_user_id=false)
	book calendar entry for user More...

	cancelBooking ($a_entry_id, $a_user_id=false)
	cancel calendar booking for user More...

	deleteBooking ($a_entry_id, $a_user_id)
	Delete booking @global type $ilDB. More...

Static Public Member Functions
static	resetGroup ($a_group_id)
	Reset booking group (in case of deletion) @global type $ilDB. More...

static	lookupBookingsOfUser ($a_app_ids, $a_usr_id, ilDateTime $start=null)
	Lookup bookings if user. More...

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

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

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

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

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

static	lookupBookingMessage ($a_entry_id, $a_usr_id)

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

static	lookupBookingsForAppointment ($a_app_id)
	Lookup booked users for appointment @global type $ilDB. More...

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

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

Protected Member Functions
	setId ($a_id)
	Set id. More...

	read ()
	Read settings from db. More...

Protected Attributes
	$db

	$user

Private Attributes
	$id = 0

	$obj_id = 0

	$deadline = 0

	$num_bookings = 1

	$target_obj_ids = array()

	$booking_group = 0

Detailed Description

Booking definition.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingEntry::__construct ( $a_booking_id = 0 )

Constructor.

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ book()

ilBookingEntry::book	(	$a_entry_id,
		$a_user_id = `false`
	)

book calendar entry for user

Parameters

int	$a_entry_id
int	$a_user_id

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

    {
        $ilUser = $this->user;
        $ilDB = $this->db;
        
        if (!$a_user_id) {
            $a_user_id = $ilUser->getId();
        }
 
        if (!$this->hasBooked($a_entry_id, $a_user_id)) {
            $ilDB->manipulate('INSERT INTO booking_user (entry_id, user_id, tstamp)' .
                ' VALUES (' . $ilDB->quote($a_entry_id, 'integer') . ',' .
                $ilDB->quote($a_user_id, 'integer') . ',' . $ilDB->quote(time(), 'integer') . ')');
 
            include_once 'Services/Calendar/classes/class.ilCalendarMailNotification.php';
            $mail = new ilCalendarMailNotification();
            $mail->setAppointmentId($a_entry_id);
            $mail->setRecipients(array($a_user_id));
            $mail->setType(ilCalendarMailNotification::TYPE_BOOKING_CONFIRMATION);
            $mail->send();
        }
        return true;
    }

References $db, $ilDB, $ilUser, $user, hasBooked(), and ilCalendarMailNotification\TYPE_BOOKING_CONFIRMATION.

Here is the call graph for this function:

◆ cancelBooking()

ilBookingEntry::cancelBooking	(	$a_entry_id,
		$a_user_id = `false`
	)

cancel calendar booking for user

Parameters

int	$a_entry_id
int	$a_user_id

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

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

References $db, $ilDB, $ilUser, $user, ilDateTime\_before(), deleteBooking(), hasBooked(), IL_CAL_UNIX, and ilCalendarMailNotification\TYPE_BOOKING_CANCELLATION.

Here is the call graph for this function:

◆ delete()

ilBookingEntry::delete ( )

Delete.

Returns

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

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

References $db, $ilDB, $query, and getId().

Here is the call graph for this function:

◆ deleteBooking()

ilBookingEntry::deleteBooking	(	$a_entry_id,
		$a_user_id
	)

Delete booking @global type $ilDB.

Parameters

type	$a_entry_id
type	$a_user_id

Returns: boolean

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

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

References $db, $ilDB, and $query.

Referenced by cancelBooking().

Here is the caller graph for this function:

◆ getBookingGroup()

ilBookingEntry::getBookingGroup ( )

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

    {
        return $this->booking_group;
    }

References $booking_group.

Referenced by isAppointmentBookableForUser(), save(), and update().

Here is the caller graph for this function:

◆ getCurrentBookings()

ilBookingEntry::getCurrentBookings ( $a_entry_id )

get current bookings

Parameters

int $a_entry_id

Returns: array

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

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

References $db, $ilDB, and $res.

◆ getCurrentNumberOfBookings()

ilBookingEntry::getCurrentNumberOfBookings ( $a_entry_id )

get current number of bookings

Parameters

int $a_entry_id

Returns: int

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

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

References $db, and $ilDB.

Referenced by isAppointmentBookableForUser(), and isBookedOut().

Here is the caller graph for this function:

◆ getDeadlineHours()

ilBookingEntry::getDeadlineHours ( )

get deadline hours

Returns

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

    {
        return $this->deadline;
    }

References $deadline.

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

Here is the caller graph for this function:

◆ getId()

ilBookingEntry::getId ( )

Get id.

Returns

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

    {
        return $this->id;
    }

References $id.

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

Here is the caller graph for this function:

◆ getInstanceByCalendarEntryId()

static ilBookingEntry::getInstanceByCalendarEntryId ( $a_id )

static

Get instance by calendar entry.

Parameters

int $id

Returns: ilBookingEntry

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

    {
        include_once 'Services/Calendar/classes/class.ilCalendarEntry.php';
        $cal_entry = new ilCalendarEntry($a_id);
        $booking_id = $cal_entry->getContextId();
        if ($booking_id) {
            return new self($booking_id);
        }
    }

Referenced by ilConsultationHoursGUI\assignUsersToAppointment(), ilConsultationHoursGUI\assignUsersToGroup(), ilConsultationHoursGUI\delete(), and ilConsultationHoursGUI\rewriteBookingIdsForAppointments().

Here is the caller graph for this function:

◆ getNumberOfBookings()

ilBookingEntry::getNumberOfBookings ( )

get number of bookings

Returns

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

    {
        return $this->num_bookings;
    }

References $num_bookings.

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

Here is the caller graph for this function:

◆ getObjId()

ilBookingEntry::getObjId ( )

get obj id

Returns

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

    {
        return $this->obj_id;
    }

References $obj_id.

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

Here is the caller graph for this function:

◆ getTargetObjIds()

ilBookingEntry::getTargetObjIds ( )

get target object id

Returns: int

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

    {
        return $this->target_obj_ids;
    }

References $target_obj_ids.

Referenced by isTargetObjectVisible().

Here is the caller graph for this function:

◆ hasBooked()

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

get current number of bookings

Parameters

int	$a_entry_id
int	$a_user_id

Returns: bool

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

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

References $db, $ilDB, $ilUser, $query, and $user.

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

Here is the caller graph for this function:

◆ hasObjectBookingEntries()

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

static

Check if object has assigned consultation hour appointments.

Parameters

type	$a_obj_id
type	$a_usr_id

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

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

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

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

Here is the caller graph for this function:

◆ isAppointmentBookableForUser()

ilBookingEntry::isAppointmentBookableForUser	(	$a_app_id,
		$a_user_id
	)

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

Parameters

type	$a_cal_entry_id
type	$a_user_id

Returns: bool

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

    {
        // #12025
        if ($a_user_id == ANONYMOUS_USER_ID) {
            return false;
        }
        
        // Check max bookings
        if ($this->getNumberOfBookings() <= $this->getCurrentNumberOfBookings($a_app_id)) {
            #$GLOBALS['ilLog']->write(__METHOD__.': Number of bookings exceeded');
            return false;
        }
 
        // Check deadline
        $dead_limit = new ilDateTime(time(), IL_CAL_UNIX);
        $dead_limit->increment(IL_CAL_HOUR, $this->getDeadlineHours());
        
        include_once 'Services/Calendar/classes/class.ilCalendarEntry.php';
        $entry = new ilCalendarEntry($a_app_id);
        if (ilDateTime::_after($dead_limit, $entry->getStart())) {
            #$GLOBALS['ilLog']->write(__METHOD__.': Deadline reached');
            return false;
        }
        
        // Check group restrictions
        if (!$this->getBookingGroup()) {
            #$GLOBALS['ilLog']->write(__METHOD__.': No booking group');
            return true;
        }
        include_once './Services/Calendar/classes/ConsultationHours/class.ilConsultationHourAppointments.php';
        $group_apps = ilConsultationHourAppointments::getAppointmentIdsByGroup(
            $this->getObjId(),
            $this->getBookingGroup()
        );
        
        // Number of bookings in group
        $bookings = self::lookupBookingsOfUser($group_apps, $a_user_id);
        
        include_once './Services/Calendar/classes/ConsultationHours/class.ilConsultationHourGroups.php';
        #$GLOBALS['ilLog']->write(__METHOD__.': '.ilConsultationHourGroups::lookupMaxBookings($this->getBookingGroup()));
        
        if (count($bookings) >= ilConsultationHourGroups::lookupMaxBookings($this->getBookingGroup())) {
            #$GLOBALS['ilLog']->write(__METHOD__.': Personal booking limit reached');
            return false;
        }
        #$GLOBALS['ilLog']->write(__METHOD__.': Is bookable!');
        return true;
    }

References ilDateTime\_after(), ilConsultationHourAppointments\getAppointmentIdsByGroup(), getBookingGroup(), getCurrentNumberOfBookings(), getDeadlineHours(), getNumberOfBookings(), getObjId(), IL_CAL_HOUR, IL_CAL_UNIX, lookupBookingsOfUser(), and ilConsultationHourGroups\lookupMaxBookings().

Here is the call graph for this function:

◆ isBookable()

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

static

Which objects are bookable?

Parameters

array	$a_obj_ids
int	$a_target_obj_id

Returns: array

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

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

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

◆ isBookedOut()

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

get current number of bookings

Parameters

int	$a_entry_id	(calendar entry)
bool	$a_check_current_user

Returns: bool

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

    {
        $ilUser = $this->user;
 
        if ($this->getNumberOfBookings() == $this->getCurrentNumberOfBookings($a_entry_id)) {
            // check against current user
            if ($a_check_current_user) {
                if ($this->hasBooked($a_entry_id)) {
                    return false;
                }
                if ($ilUser->getId() == $this->getObjId()) {
                    return false;
                }
            }
            return true;
        }
 
        $deadline = $this->getDeadlineHours();
        if ($deadline) {
            include_once 'Services/Calendar/classes/class.ilCalendarEntry.php';
            $entry = new ilCalendarEntry($a_entry_id);
            if (time() + ($deadline * 60 * 60) > $entry->getStart()->get(IL_CAL_UNIX)) {
                return true;
            }
        }
        return false;
    }

References $deadline, $ilUser, $user, getCurrentNumberOfBookings(), getDeadlineHours(), getNumberOfBookings(), hasBooked(), and IL_CAL_UNIX.

Here is the call graph for this function:

◆ isOwner()

ilBookingEntry::isOwner ( $a_user_id = null )

check if current (or given) user is entry owner

Parameters

int $a_user_id

Returns: bool

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

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

References $ilUser, $user, and getObjId().

Here is the call graph for this function:

◆ isTargetObjectVisible()

ilBookingEntry::isTargetObjectVisible ( $a_ref_id )

Check if target ref id is visible.

Parameters

type $a_ref_id

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

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

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

Here is the call graph for this function:

◆ lookupBookableUsersForObject()

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

static

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

Parameters

type	$a_obj_ids
type	$a_user_ids

Returns: array user ids

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

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, and ilCalendarCategory\TYPE_CH.

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

Here is the caller graph for this function:

◆ lookupBookingMessage()

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

static

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

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

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

Referenced by ilConsultationHourBookingTableGUI\parse().

Here is the caller graph for this function:

◆ lookupBookingsForAppointment()

static ilBookingEntry::lookupBookingsForAppointment ( $a_app_id )

static

Lookup booked users for appointment @global type $ilDB.

Parameters

type $a_app_id

Returns: type

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

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

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

Referenced by ilConsultationHoursGUI\confirmDelete(), and ilConsultationHourBookingTableGUI\parse().

Here is the caller graph for this function:

◆ lookupBookingsForObject()

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

static

Lookup booking for an object and user.

Parameters

type	$a_obj_id
type	$a_usr_id

Returns: array

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

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by lookupManagedBookingsForObject().

Here is the caller graph for this function:

◆ lookupBookingsOfUser()

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

static

Lookup bookings if user.

Parameters

type	$a_app_ids
type	$a_usr_id

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

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

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

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

Here is the caller graph for this function:

◆ lookupManagedBookingsForObject()

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

static

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

Parameters

type	$a_obj_id
type	$a_usr_id

Returns: array

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

    {
        $bookings = self::lookupBookingsForObject($a_obj_id, $a_usr_id);
        include_once './Services/Calendar/classes/ConsultationHours/class.ilConsultationHourUtils.php';
        foreach (ilConsultationHourUtils::lookupManagedUsers($a_usr_id) as $managed_user_id) {
            foreach (self::lookupBookingsForObject($a_obj_id, $managed_user_id) as $booked_user => $booking) {
                $fullname = ilObjUser::_lookupFullname($managed_user_id);
                foreach ($booking as $booking_entry) {
                    $booking_entry['explanation'] = '(' . $fullname . ')';
                    $bookings[$booked_user][] = $booking_entry;
                }
            }
        }
        return $bookings;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilBookingEntry::read ( )

protected

Read settings from db.

Returns

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

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

References $db, $ilDB, $query, $res, ilDBConstants\FETCHMODE_ASSOC, ilDBConstants\FETCHMODE_OBJECT, getId(), setBookingGroup(), setDeadlineHours(), setNumberOfBookings(), and setObjId().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeObsoleteEntries()

static ilBookingEntry::removeObsoleteEntries ( )

static

Remove unused booking entries.

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

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

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

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

Here is the caller graph for this function:

◆ resetGroup()

static ilBookingEntry::resetGroup ( $a_group_id )

static

Reset booking group (in case of deletion) @global type $ilDB.

Parameters

type $a_group_id

Returns: boolean

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $query = 'UPDATE booking_entry SET booking_group = ' . $ilDB->quote(0, 'integer') . ' ' .
                'WHERE booking_group = ' . $ilDB->quote($a_group_id, 'integer');
        $ilDB->manipulate($query);
        return true;
    }

References $DIC, $ilDB, and $query.

Referenced by ilConsultationHourGroup\delete().

Here is the caller graph for this function:

◆ save()

ilBookingEntry::save ( )

Save a new booking entry.

Returns

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

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

References $db, $ilDB, $obj_id, $query, getBookingGroup(), getDeadlineHours(), getId(), getNumberOfBookings(), getObjId(), and setId().

Here is the call graph for this function:

◆ setBookingGroup()

ilBookingEntry::setBookingGroup ( $a_id )

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

    {
        $this->booking_group = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDeadlineHours()

ilBookingEntry::setDeadlineHours ( $a_hours )

set deadline hours

Parameters

int $a_hours

Returns

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

    {
        $this->deadline = (int) $a_hours;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setId()

ilBookingEntry::setId ( $a_id )

protected

Set id.

Parameters

int $a_id

Returns

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

    {
        $this->id = (int) $a_id;
    }

Referenced by __construct(), and save().

Here is the caller graph for this function:

◆ setNumberOfBookings()

ilBookingEntry::setNumberOfBookings ( $a_num )

set number of bookings

Parameters

int $a_num

Returns

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

    {
        $this->num_bookings = (int) $a_num;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setObjId()

ilBookingEntry::setObjId ( $a_id )

Set obj id.

Parameters

int $a_id

Returns

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

    {
        $this->obj_id = (int) $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTargetObjIds()

ilBookingEntry::setTargetObjIds ( $a_obj_id )

set target object id

Parameters

int $a_obj_id

Returns

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

    {
        $this->target_obj_ids = $a_obj_id;
    }

◆ update()

ilBookingEntry::update ( )

Update an existing booking entry.

Returns

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

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

References $db, $ilDB, $obj_id, $query, getBookingGroup(), getDeadlineHours(), getId(), getNumberOfBookings(), and getObjId().

Here is the call graph for this function:

◆ writeBookingMessage()

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

static

Write booking message.

Parameters

type	$a_entry_id
type	$a_usr_id
type	$a_message

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
        
        $query = 'UPDATE booking_user SET ' .
                'booking_message = ' . $ilDB->quote($a_message, 'text') . ' ' .
                'WHERE entry_id = ' . $ilDB->quote($a_entry_id, 'integer') . ' ' .
                'AND user_id = ' . $ilDB->quote($a_usr_id, 'integer');
        
        $GLOBALS['ilLog']->write(__METHOD__ . ': ' . $query);
        
        $ilDB->manipulate($query);
        return true;
    }

References $DIC, $GLOBALS, $ilDB, and $query.

Referenced by ilCalendarAppointmentGUI\bookconfirmed().

Here is the caller graph for this function:

Field Documentation

◆ $booking_group

ilBookingEntry::$booking_group = 0

private

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

Referenced by getBookingGroup().

◆ $db

ilBookingEntry::$db

protected

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

Referenced by book(), cancelBooking(), delete(), deleteBooking(), getCurrentBookings(), getCurrentNumberOfBookings(), hasBooked(), read(), save(), and update().

◆ $deadline

ilBookingEntry::$deadline = 0

private

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

Referenced by getDeadlineHours(), and isBookedOut().

◆ $id

ilBookingEntry::$id = 0

private

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

Referenced by getId().

◆ $num_bookings

ilBookingEntry::$num_bookings = 1

private

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

Referenced by getNumberOfBookings().

◆ $obj_id

ilBookingEntry::$obj_id = 0

private

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

Referenced by getObjId(), isTargetObjectVisible(), save(), and update().

◆ $target_obj_ids

ilBookingEntry::$target_obj_ids = array()

private

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

Referenced by getTargetObjIds().

◆ $user

ilBookingEntry::$user

protected

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

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

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

Services/Booking/classes/class.ilBookingEntry.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ book()

◆ cancelBooking()

◆ delete()

◆ deleteBooking()

◆ getBookingGroup()

◆ getCurrentBookings()

◆ getCurrentNumberOfBookings()

◆ getDeadlineHours()

◆ getId()

◆ getInstanceByCalendarEntryId()

◆ getNumberOfBookings()

◆ getObjId()

◆ getTargetObjIds()

◆ hasBooked()

◆ hasObjectBookingEntries()

◆ isAppointmentBookableForUser()

◆ isBookable()

◆ isBookedOut()

◆ isOwner()

◆ isTargetObjectVisible()

◆ lookupBookableUsersForObject()

◆ lookupBookingMessage()

◆ lookupBookingsForAppointment()

◆ lookupBookingsForObject()

◆ lookupBookingsOfUser()

◆ lookupManagedBookingsForObject()

◆ read()

◆ removeObsoleteEntries()

◆ resetGroup()

◆ save()

◆ setBookingGroup()

◆ setDeadlineHours()

◆ setId()

◆ setNumberOfBookings()

◆ setObjId()

◆ setTargetObjIds()

◆ update()

◆ writeBookingMessage()

Field Documentation

◆ $booking_group

◆ $db

◆ $deadline

◆ $id

◆ $num_bookings

◆ $obj_id

◆ $target_obj_ids

◆ $user