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

Collaboration diagram for ilBookingSchedule:

Public Member Functions
	__construct (int $a_id=null)

	setTitle (string $a_title)

	getTitle ()

	setPoolId (int $a_pool_id)

	getPoolId ()

	setRaster (int $a_raster)
	Set booking raster (in minutes) More...

	getRaster ()

	setMinRental (int $a_min)
	Set minimum rental time. More...

	getMinRental ()

	setMaxRental (int $a_max)
	Set maximum rental time. More...

	getMaxRental ()

	setAutoBreak (int $a_break)

	getAutoBreak ()

	setDeadline (int $a_deadline)
	Set deadline. More...

	getDeadline ()

	setDefinition (array $a_definition)
	Set definition. More...

	getDefinition ()

	setAvailabilityFrom (?ilDateTime $a_date=null)

	getAvailabilityFrom ()

	setAvailabilityTo (?ilDateTime $a_date=null)

	getAvailabilityTo ()

	save ()

	update ()

	doClone (int $a_pool_id)

	delete ()

	getDefinitionBySlots ()
	Return definition grouped by slots (not days) More...

	setDefinitionBySlots (array $a_def)

Static Public Member Functions
static	lookupPoolId (int $schedule_id)

static	hasExistingSchedules (int $a_pool_id)
	Check if given pool has any defined schedules. More...

static	getList (int $a_pool_id)
	Get list of booking objects for given pool. More...

Protected Member Functions
	read ()

	saveDefinition ()
	Save current definition (slots) More...

Protected Attributes
ilDBInterface	$db

int	$id = 0

string	$title = ""

int	$pool_id = 0

int	$raster = 0

int	$rent_min = 0

int	$rent_max = 0

int	$auto_break = 0

int	$deadline = 0

array	$definition

ilDateTime	$av_from = null

ilDateTime	$av_to = null

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 schedule for booking ressource

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.ilBookingSchedule.php.

Constructor & Destructor Documentation

◆ __construct()

ilBookingSchedule::__construct ( int $a_id = null )

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

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

       {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->id = (int) $a_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilBookingSchedule::delete ( )

Definition at line 372 of file class.ilBookingSchedule.php.

References $db, and $ilDB.

                             : int
     {
         $ilDB = $this->db;
 
         if ($this->id) {
             return $ilDB->manipulate('DELETE FROM booking_schedule' .
                 ' WHERE booking_schedule_id = ' . $ilDB->quote($this->id, 'integer'));
         }
         return 0;
     }

◆ doClone()

ilBookingSchedule::doClone ( int $a_pool_id )

Definition at line 267 of file class.ilBookingSchedule.php.

References getAutoBreak(), getAvailabilityFrom(), getAvailabilityTo(), getDeadline(), getDefinition(), getMaxRental(), getMinRental(), getRaster(), and getTitle().

                                            : int
     {
         $new_obj = new self();
         $new_obj->setPoolId($a_pool_id);
         $new_obj->setTitle($this->getTitle());
         $new_obj->setRaster($this->getRaster());
         $new_obj->setMinRental($this->getMinRental());
         $new_obj->setMaxRental($this->getMaxRental());
         $new_obj->setAutoBreak($this->getAutoBreak());
         $new_obj->setDeadline($this->getDeadline());
         $new_obj->setDefinition($this->getDefinition());
         $new_obj->setAvailabilityFrom($this->getAvailabilityFrom());
         $new_obj->setAvailabilityTo($this->getAvailabilityTo());
         return $new_obj->save();
     }

Here is the call graph for this function:

◆ getAutoBreak()

ilBookingSchedule::getAutoBreak ( )

Definition at line 118 of file class.ilBookingSchedule.php.

References $auto_break.

Referenced by doClone(), and save().

                                   : int
     {
         return $this->auto_break;
     }

Here is the caller graph for this function:

◆ getAvailabilityFrom()

ilBookingSchedule::getAvailabilityFrom ( )

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

References $av_from.

Referenced by ilBookingProcessGUI\book(), doClone(), ilBookingReservation\getAvailableObject(), ilBookingReservation\isObjectAvailableInPeriod(), save(), and update().

                                          : ?ilDateTime
     {
         return $this->av_from;
     }

Here is the caller graph for this function:

◆ getAvailabilityTo()

ilBookingSchedule::getAvailabilityTo ( )

Definition at line 167 of file class.ilBookingSchedule.php.

References $av_to.

Referenced by ilBookingProcessGUI\book(), doClone(), ilBookingReservation\isObjectAvailableInPeriod(), save(), and update().

                                        : ?ilDateTime
     {
         return $this->av_to;
     }

Here is the caller graph for this function:

◆ getDeadline()

ilBookingSchedule::getDeadline ( )

Definition at line 131 of file class.ilBookingSchedule.php.

References $deadline.

Referenced by ilBookingProcessGUI\book(), doClone(), and save().

                                  : int
     {
         return $this->deadline;
     }

Here is the caller graph for this function:

◆ getDefinition()

ilBookingSchedule::getDefinition ( )

Definition at line 145 of file class.ilBookingSchedule.php.

References $definition.

Referenced by ilBookingProcessGUI\book(), doClone(), getDefinitionBySlots(), ilBookingReservation\isObjectAvailableInPeriod(), and saveDefinition().

                                    : array
     {
         return $this->definition;
     }

Here is the caller graph for this function:

◆ getDefinitionBySlots()

ilBookingSchedule::getDefinitionBySlots ( )

Return definition grouped by slots (not days)

Definition at line 386 of file class.ilBookingSchedule.php.

References getDefinition().

                                           : array
     {
         $def = $this->getDefinition();
         $slots = array();
         foreach ($def as $day => $times) {
             foreach ($times as $time) {
                 $slots[$time][] = $day;
             }
         }
         foreach ($slots as $time => $days) {
             $slots[$time] = array_unique($days);
         }
         ksort($slots);
         return $slots;
     }

Here is the call graph for this function:

◆ getList()

static ilBookingSchedule::getList ( int $a_pool_id )

static

Get list of booking objects for given pool.

Definition at line 347 of file class.ilBookingSchedule.php.

References $DIC, $ilDB, and $res.

Referenced by ilObjBookingPool\cloneObject(), ilBookingSchedulesTableGUI\getItems(), ilBookingReservationsTableGUI\initFilter(), ilBookingObjectGUI\initForm(), and ilObjBookingPoolGUI\showNoScheduleMessage().

                                                   : array
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query('SELECT s.booking_schedule_id,s.title,' .
             'MAX(o.schedule_id) AS object_has_schedule' .
             ' FROM booking_schedule s' .
             ' LEFT JOIN booking_object o ON (s.booking_schedule_id = o.schedule_id)' .
             ' WHERE s.pool_id = ' . $ilDB->quote($a_pool_id, 'integer') .
             ' GROUP BY s.booking_schedule_id,s.title' .
             ' ORDER BY s.title');
         $res = array();
         while ($row = $ilDB->fetchAssoc($set)) {
             if (!$row['object_has_schedule']) {
                 $row['is_used'] = false;
             } else {
                 $row['is_used'] = true;
             }
             $res[] = $row;
         }
         return $res;
     }

Here is the caller graph for this function:

◆ getMaxRental()

ilBookingSchedule::getMaxRental ( )

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

References $rent_max.

Referenced by doClone(), and save().

                                   : int
     {
         return $this->rent_max;
     }

Here is the caller graph for this function:

◆ getMinRental()

ilBookingSchedule::getMinRental ( )

Definition at line 93 of file class.ilBookingSchedule.php.

References $rent_min.

Referenced by doClone(), and save().

                                   : int
     {
         return $this->rent_min;
     }

Here is the caller graph for this function:

◆ getPoolId()

ilBookingSchedule::getPoolId ( )

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

References $pool_id.

Referenced by save().

                                : int
     {
         return $this->pool_id;
     }

Here is the caller graph for this function:

◆ getRaster()

ilBookingSchedule::getRaster ( )

Definition at line 79 of file class.ilBookingSchedule.php.

References $raster.

Referenced by ilBookingProcessGUI\book(), doClone(), and save().

                                : int
     {
         return $this->raster;
     }

Here is the caller graph for this function:

◆ getTitle()

ilBookingSchedule::getTitle ( )

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

References $title.

Referenced by doClone(), and save().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ hasExistingSchedules()

static ilBookingSchedule::hasExistingSchedules ( int $a_pool_id )

static

Check if given pool has any defined schedules.

Definition at line 332 of file class.ilBookingSchedule.php.

References $DIC, and $ilDB.

Referenced by ilBookingGatewayGUI\checkBookingPoolsForSchedules().

                                                                : bool
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query("SELECT booking_schedule_id" .
             " FROM booking_schedule" .
             " WHERE pool_id = " . $ilDB->quote($a_pool_id, 'integer'));
         return (bool) $ilDB->numRows($set);
     }

Here is the caller graph for this function:

◆ lookupPoolId()

static ilBookingSchedule::lookupPoolId ( int $schedule_id )

static

Definition at line 314 of file class.ilBookingSchedule.php.

References $DIC, and $ilDB.

Referenced by ilBookingScheduleGUI\__construct().

                                                          : int
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query("SELECT pool_id " .
             " FROM booking_schedule" .
             " WHERE booking_schedule_id = " . $ilDB->quote($schedule_id, 'integer'));
         if ($rec = $ilDB->fetchAssoc($set)) {
             return (int) $rec['pool_id'];
         }
         return 0;
     }

Here is the caller graph for this function:

◆ read()

ilBookingSchedule::read ( )

protected

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

References $db, $ilDB, IL_CAL_UNIX, setAutoBreak(), setAvailabilityFrom(), setAvailabilityTo(), setDeadline(), setDefinition(), setMaxRental(), setMinRental(), setRaster(), and setTitle().

Referenced by __construct().

                              : void
     {
         $ilDB = $this->db;
 
         if ($this->id) {
             $set = $ilDB->query('SELECT title,raster,rent_min,rent_max,auto_break,' .
                 'deadline,av_from,av_to' .
                 ' FROM booking_schedule' .
                 ' WHERE booking_schedule_id = ' . $ilDB->quote($this->id, 'integer'));
             $row = $ilDB->fetchAssoc($set);
             $this->setTitle($row['title'] ?? "");
             $this->setDeadline($row['deadline'] ?? 0);
             $this->setAvailabilityFrom($row['av_from'] ? new ilDateTime($row['av_from'], IL_CAL_UNIX) : null);
             $this->setAvailabilityTo($row['av_to'] ? new ilDateTime($row['av_to'], IL_CAL_UNIX) : null);
             if ($row['raster']) {
                 $this->setRaster($row['raster']);
                 $this->setMinRental($row['rent_min']);
                 $this->setMaxRental($row['rent_max']);
                 $this->setAutoBreak($row['auto_break']);
             }
 
             // load definition
             $definition = array();
             $set = $ilDB->query('SELECT day_id,slot_id,times' .
                 ' FROM booking_schedule_slot' .
                 ' WHERE booking_schedule_id = ' . $ilDB->quote($this->id, 'integer'));
             while ($row = $ilDB->fetchAssoc($set)) {
                 $definition[$row["day_id"]][$row["slot_id"]] = $row["times"];
             }
             $this->setDefinition($definition);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilBookingSchedule::save ( )

Definition at line 205 of file class.ilBookingSchedule.php.

References $db, $id, $ilDB, getAutoBreak(), getAvailabilityFrom(), getAvailabilityTo(), getDeadline(), getMaxRental(), getMinRental(), getPoolId(), getRaster(), getTitle(), IL_CAL_UNIX, and saveDefinition().

                           : ?int
     {
         $ilDB = $this->db;
 
         if ($this->id) {
             return null;
         }
 
         $this->id = $ilDB->nextId('booking_schedule');
 
         $av_from = ($this->getAvailabilityFrom() && !$this->getAvailabilityFrom()->isNull())
             ? $this->getAvailabilityFrom()->get(IL_CAL_UNIX)
             : null;
         $av_to = ($this->getAvailabilityTo() && !$this->getAvailabilityTo()->isNull())
             ? $this->getAvailabilityTo()->get(IL_CAL_UNIX)
             : null;
 
         $ilDB->manipulate('INSERT INTO booking_schedule' .
             ' (booking_schedule_id,title,pool_id,raster,rent_min,rent_max,auto_break,' .
             'deadline,av_from,av_to)' .
             ' VALUES (' . $ilDB->quote($this->id, 'integer') . ',' . $ilDB->quote($this->getTitle(), 'text') .
             ',' . $ilDB->quote($this->getPoolId(), 'integer') . ',' . $ilDB->quote($this->getRaster(), 'integer') .
             ',' . $ilDB->quote($this->getMinRental(), 'integer') . ',' . $ilDB->quote($this->getMaxRental(), 'integer') .
             ',' . $ilDB->quote($this->getAutoBreak(), 'integer') . ',' . $ilDB->quote($this->getDeadline(), 'integer') .
             ',' . $ilDB->quote($av_from, 'integer') . ',' . $ilDB->quote($av_to, 'integer') . ')');
 
         $this->saveDefinition();
 
         return $this->id;
     }

Here is the call graph for this function:

◆ saveDefinition()

ilBookingSchedule::saveDefinition ( )

protected

Save current definition (slots)

Definition at line 286 of file class.ilBookingSchedule.php.

References $db, $ilDB, and getDefinition().

Referenced by save(), and update().

                                        : bool
     {
         $ilDB = $this->db;
 
         if (!$this->id) {
             return false;
         }
 
         $ilDB->manipulate('DELETE FROM booking_schedule_slot' .
             ' WHERE booking_schedule_id = ' . $ilDB->quote($this->id, 'integer'));
 
         $definition = $this->getDefinition();
         if ($definition) {
             foreach ($definition as $day_id => $slots) {
                 foreach ($slots as $slot_id => $times) {
                     $fields = array(
                         "booking_schedule_id" => array('integer', $this->id),
                         "day_id" => array('text', $day_id),
                         "slot_id" => array('integer', $slot_id),
                         "times" => array('text', $times)
                         );
                     $ilDB->insert('booking_schedule_slot', $fields);
                 }
             }
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoBreak()

ilBookingSchedule::setAutoBreak ( int $a_break )

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

Referenced by read().

                                               : void
     {
         $this->auto_break = $a_break;
     }

Here is the caller graph for this function:

◆ setAvailabilityFrom()

ilBookingSchedule::setAvailabilityFrom ( ?ilDateTime $a_date = null )

Definition at line 150 of file class.ilBookingSchedule.php.

Referenced by ilBookingScheduleGUI\formToObject(), and read().

      : void {
         $this->av_from = $a_date;
     }

Here is the caller graph for this function:

◆ setAvailabilityTo()

ilBookingSchedule::setAvailabilityTo ( ?ilDateTime $a_date = null )

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

Referenced by ilBookingScheduleGUI\formToObject(), and read().

      : void {
         $this->av_to = $a_date;
     }

Here is the caller graph for this function:

◆ setDeadline()

ilBookingSchedule::setDeadline ( int $a_deadline )

Set deadline.

Definition at line 126 of file class.ilBookingSchedule.php.

Referenced by ilBookingScheduleGUI\formToObject(), and read().

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

Here is the caller graph for this function:

◆ setDefinition()

ilBookingSchedule::setDefinition ( array $a_definition )

Set definition.

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

Referenced by read(), and setDefinitionBySlots().

      : void {
         $this->definition = $a_definition;
     }

Here is the caller graph for this function:

◆ setDefinitionBySlots()

ilBookingSchedule::setDefinitionBySlots ( array $a_def )

Definition at line 402 of file class.ilBookingSchedule.php.

References setDefinition().

Referenced by ilBookingScheduleGUI\formToObject().

                                                       : void
     {
         $slots = array();
         foreach ($a_def as $time => $days) {
             foreach ($days as $day) {
                 $slots[$day][] = $time;
             }
         }
         $this->setDefinition($slots);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMaxRental()

ilBookingSchedule::setMaxRental ( int $a_max )

Set maximum rental time.

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

Referenced by read().

      : void {
         $this->rent_max = $a_max;
     }

Here is the caller graph for this function:

◆ setMinRental()

ilBookingSchedule::setMinRental ( int $a_min )

Set minimum rental time.

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

Referenced by read().

      : void {
         $this->rent_min = $a_min;
     }

Here is the caller graph for this function:

◆ setPoolId()

ilBookingSchedule::setPoolId ( int $a_pool_id )

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

Referenced by ilBookingScheduleGUI\formToObject().

      : void {
         $this->pool_id = $a_pool_id;
     }

Here is the caller graph for this function:

◆ setRaster()

ilBookingSchedule::setRaster ( int $a_raster )

Set booking raster (in minutes)

Definition at line 73 of file class.ilBookingSchedule.php.

Referenced by read().

      : void {
         $this->raster = $a_raster;
     }

Here is the caller graph for this function:

◆ setTitle()

ilBookingSchedule::setTitle ( string $a_title )

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

Referenced by ilBookingScheduleGUI\formToObject(), and read().

      : void {
         $this->title = $a_title;
     }

Here is the caller graph for this function:

◆ update()

ilBookingSchedule::update ( )

Definition at line 236 of file class.ilBookingSchedule.php.

References $db, $ilDB, getAvailabilityFrom(), getAvailabilityTo(), IL_CAL_UNIX, and saveDefinition().

                             : bool
     {
         $ilDB = $this->db;
 
         if (!$this->id) {
             return false;
         }
 
         $av_from = ($this->getAvailabilityFrom() && !$this->getAvailabilityFrom()->isNull())
             ? $this->getAvailabilityFrom()->get(IL_CAL_UNIX)
             : null;
         $av_to = ($this->getAvailabilityTo() && !$this->getAvailabilityTo()->isNull())
             ? $this->getAvailabilityTo()->get(IL_CAL_UNIX)
             : null;
 
         $ilDB->manipulate('UPDATE booking_schedule' .
             ' SET title = ' . $ilDB->quote($this->getTitle(), 'text') .
             ', pool_id = ' . $ilDB->quote($this->getPoolId(), 'integer') .
             ', raster = ' . $ilDB->quote($this->getRaster(), 'integer') .
             ', rent_min = ' . $ilDB->quote($this->getMinRental(), 'integer') .
             ', rent_max = ' . $ilDB->quote($this->getMaxRental(), 'integer') .
             ', auto_break = ' . $ilDB->quote($this->getAutoBreak(), 'integer') .
             ', deadline = ' . $ilDB->quote($this->getDeadline(), 'integer') .
             ', av_from = ' . $ilDB->quote($av_from, 'integer') .
             ', av_to = ' . $ilDB->quote($av_to, 'integer') .
             ' WHERE booking_schedule_id = ' . $ilDB->quote($this->id, 'integer'));
 
         $this->saveDefinition();
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $auto_break

int ilBookingSchedule::$auto_break = 0

protected

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

Referenced by getAutoBreak().

◆ $av_from

ilDateTime ilBookingSchedule::$av_from = null

protected

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

Referenced by getAvailabilityFrom().

◆ $av_to

ilDateTime ilBookingSchedule::$av_to = null

protected

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

Referenced by getAvailabilityTo().

◆ $db

ilDBInterface ilBookingSchedule::$db

protected

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

Referenced by delete(), read(), save(), saveDefinition(), and update().

◆ $deadline

int ilBookingSchedule::$deadline = 0

protected

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

Referenced by getDeadline().

◆ $definition

array ilBookingSchedule::$definition

protected

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

Referenced by getDefinition().

◆ $id

int ilBookingSchedule::$id = 0

protected

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

Referenced by save().

◆ $pool_id

int ilBookingSchedule::$pool_id = 0

protected

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

Referenced by getPoolId().

◆ $raster

int ilBookingSchedule::$raster = 0

protected

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

Referenced by getRaster().

◆ $rent_max

int ilBookingSchedule::$rent_max = 0

protected

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

Referenced by getMaxRental().

◆ $rent_min

int ilBookingSchedule::$rent_min = 0

protected

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

Referenced by getMinRental().

◆ $title

string ilBookingSchedule::$title = ""

protected

Definition at line 27 of file class.ilBookingSchedule.php.

Referenced by getTitle().

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

Modules/BookingManager/Schedule/class.ilBookingSchedule.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ doClone()

◆ getAutoBreak()

◆ getAvailabilityFrom()

◆ getAvailabilityTo()

◆ getDeadline()

◆ getDefinition()

◆ getDefinitionBySlots()

◆ getList()

◆ getMaxRental()

◆ getMinRental()

◆ getPoolId()

◆ getRaster()

◆ getTitle()

◆ hasExistingSchedules()

◆ lookupPoolId()

◆ read()

◆ save()

◆ saveDefinition()

◆ setAutoBreak()

◆ setAvailabilityFrom()

◆ setAvailabilityTo()

◆ setDeadline()

◆ setDefinition()

◆ setDefinitionBySlots()

◆ setMaxRental()

◆ setMinRental()

◆ setPoolId()

◆ setRaster()

◆ setTitle()

◆ update()

Field Documentation

◆ $auto_break

◆ $av_from

◆ $av_to

◆ $db

◆ $deadline

◆ $definition

◆ $id

◆ $pool_id

◆ $raster

◆ $rent_max

◆ $rent_min

◆ $title