schedule for booking ressource More...

Collaboration diagram for ilBookingSchedule:

Public Member Functions
	__construct ($a_id=null)
	Constructor. More...

	setTitle ($a_title)
	Set object title. More...

	getTitle ()
	Get object title. More...

	setPoolId ($a_pool_id)
	Set booking pool id (aka parent obj ref id) More...

	getPoolId ()
	Get booking pool id. More...

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

	getRaster ()
	Get booking raster. More...

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

	getMinRental ()
	Get minimum rental time. More...

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

	getMaxRental ()
	Get maximum rental time. More...

	setAutoBreak ($a_break)
	Set break time. More...

	getAutoBreak ()
	Get break time. More...

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

	getDeadline ()
	Get deadline. More...

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

	getDefinition ()
	Get definition. More...

	setAvailabilityFrom (ilDateTime $a_date=null)
	Set availability start. More...

	getAvailabilityFrom ()
	Get availability start. More...

	setAvailabilityTo (ilDateTime $a_date=null)
	Set availability end. More...

	getAvailabilityTo ()
	Get availability end. More...

	save ()
	Create new entry in db. More...

	update ()
	Update entry in db. More...

	doClone ($a_pool_id)

	delete ()
	Delete single entry. More...

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

	setDefinitionBySlots (array $a_def)

Static Public Member Functions
static	hasExistingSchedules ($a_pool_id)
	Check if given pool has any defined schedules. More...

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

Protected Member Functions
	read ()
	Get dataset from db. More...

	saveDefinition ()
	Save current definition. More...

Protected Attributes
	$db

	$id

	$title

	$pool_id

	$raster

	$rent_min

	$rent_max

	$auto_break

	$deadline

	$definition

	$av_from

	$av_to

Detailed Description

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilBookingSchedule::__construct ( $a_id = null )

Constructor.

if id is given will read dataset from db

Parameters

int $a_id

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

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

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilBookingSchedule::delete ( )

Delete single entry.

Returns: bool

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

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

References $db, and $ilDB.

◆ doClone()

ilBookingSchedule::doClone ( $a_pool_id )

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

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

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

Here is the call graph for this function:

◆ getAutoBreak()

ilBookingSchedule::getAutoBreak ( )

Get break time.

Returns: int

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

    {
        return $this->auto_break;
    }

References $auto_break.

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

Here is the caller graph for this function:

◆ getAvailabilityFrom()

ilBookingSchedule::getAvailabilityFrom ( )

Get availability start.

Returns: ilDateTime

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

    {
        return $this->av_from;
    }

References $av_from.

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

Here is the caller graph for this function:

◆ getAvailabilityTo()

ilBookingSchedule::getAvailabilityTo ( )

Get availability end.

Returns: ilDateTime

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

    {
        return $this->av_to;
    }

References $av_to.

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

Here is the caller graph for this function:

◆ getDeadline()

ilBookingSchedule::getDeadline ( )

Get deadline.

Returns: int

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

    {
        return $this->deadline;
    }

References $deadline.

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

Here is the caller graph for this function:

◆ getDefinition()

ilBookingSchedule::getDefinition ( )

Get definition.

Returns: array

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

    {
        return $this->definition;
    }

References $definition.

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

Here is the caller graph for this function:

◆ getDefinitionBySlots()

ilBookingSchedule::getDefinitionBySlots ( )

Return definition grouped by slots (not days)

Returns: array

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

    {
        $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;
    }

References $def, $time, and getDefinition().

Here is the call graph for this function:

◆ getList()

static ilBookingSchedule::getList ( $a_pool_id )

static

Get list of booking objects for given pool.

Parameters

int $a_pool_id

Returns: array

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

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

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

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

Here is the caller graph for this function:

◆ getMaxRental()

ilBookingSchedule::getMaxRental ( )

Get maximum rental time.

Returns: int

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

    {
        return $this->rent_max;
    }

References $rent_max.

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

Here is the caller graph for this function:

◆ getMinRental()

ilBookingSchedule::getMinRental ( )

Get minimum rental time.

Returns: int

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

    {
        return $this->rent_min;
    }

References $rent_min.

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

Here is the caller graph for this function:

◆ getPoolId()

ilBookingSchedule::getPoolId ( )

Get booking pool id.

Returns: int

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

    {
        return $this->pool_id;
    }

References $pool_id.

Referenced by save(), and update().

Here is the caller graph for this function:

◆ getRaster()

ilBookingSchedule::getRaster ( )

Get booking raster.

Returns: int

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

    {
        return $this->raster;
    }

References $raster.

Referenced by doClone(), ilObjBookingPoolGUI\renderSlots(), save(), and update().

Here is the caller graph for this function:

◆ getTitle()

ilBookingSchedule::getTitle ( )

Get object title.

Returns: string

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

    {
        return $this->title;
    }

References $title.

Referenced by doClone(), and save().

Here is the caller graph for this function:

◆ hasExistingSchedules()

static ilBookingSchedule::hasExistingSchedules ( $a_pool_id )

static

Check if given pool has any defined schedules.

Parameters

int $a_pool_id

Returns: bool

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

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

References $DIC, and $ilDB.

◆ read()

ilBookingSchedule::read ( )

protected

Get dataset from db.

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilBookingSchedule::save ( )

Create new entry in db.

Returns: bool

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

    {
        $ilDB = $this->db;
 
        if ($this->id) {
            return false;
        }
 
        $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;
    }

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

Here is the call graph for this function:

◆ saveDefinition()

ilBookingSchedule::saveDefinition ( )

protected

Save current definition.

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

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

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

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAutoBreak()

ilBookingSchedule::setAutoBreak ( $a_break )

Set break time.

Parameters

int $a_break

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

    {
        $this->auto_break = (int) $a_break;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setAvailabilityFrom()

ilBookingSchedule::setAvailabilityFrom ( ilDateTime $a_date = null )

Set availability start.

Parameters

ilDateTime $a_date

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

    {
        $this->av_from = $a_date;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setAvailabilityTo()

ilBookingSchedule::setAvailabilityTo ( ilDateTime $a_date = null )

Set availability end.

Parameters

ilDateTime $a_date

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

    {
        $this->av_to = $a_date;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setDeadline()

ilBookingSchedule::setDeadline ( $a_deadline )

Set deadline.

Parameters

int $a_deadline

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

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

Referenced by read().

Here is the caller graph for this function:

◆ setDefinition()

ilBookingSchedule::setDefinition ( $a_definition )

Set definition.

Parameters

array $a_definition

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

    {
        $this->definition = $a_definition;
    }

Referenced by read(), and setDefinitionBySlots().

Here is the caller graph for this function:

◆ setDefinitionBySlots()

ilBookingSchedule::setDefinitionBySlots ( array $a_def )

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

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

References $time, and setDefinition().

Here is the call graph for this function:

◆ setMaxRental()

ilBookingSchedule::setMaxRental ( $a_max )

Set maximum rental time.

Parameters

int $a_max

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

    {
        $this->rent_max = (int) $a_max;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setMinRental()

ilBookingSchedule::setMinRental ( $a_min )

Set minimum rental time.

Parameters

int $a_min

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

    {
        $this->rent_min = (int) $a_min;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setPoolId()

ilBookingSchedule::setPoolId ( $a_pool_id )

Set booking pool id (aka parent obj ref id)

Parameters

int $a_pool_id

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

    {
        $this->pool_id = (int) $a_pool_id;
    }

◆ setRaster()

ilBookingSchedule::setRaster ( $a_raster )

Set booking raster (in minutes)

Parameters

int $a_raster

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

    {
        $this->raster = (int) $a_raster;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTitle()

ilBookingSchedule::setTitle ( $a_title )

Set object title.

Parameters

string $a_title

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

    {
        $this->title = $a_title;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilBookingSchedule::update ( )

Update entry in db.

Returns: bool

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

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