ilBookingReservationDBRepository Class Reference

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

Collaboration diagram for ilBookingReservationDBRepository:

Public Member Functions
	__construct (ilDBInterface $db, ?array $preload_context_obj_ids=null)
	Do not call this constructor directly, use ilBookingReservationDBRepositoryFactory instead. More...
	getForId (int $id)
	Get reservation data for id. More...
	create (int $user_id, int $assigner_id, int $object_id, int $context_obj_id, int $from, int $to, int $status, int $group_id)
	update (int $id, int $user_id, int $assigner_id, int $object_id, int $context_obj_id, int $from, int $to, int $status, int $group_id)
	delete (int $id)
	getNewGroupId ()
	getNumberOfReservations (array $ids, int $from, int $to, bool $only_not_over_yet=false)
	Get number of uncancelled reservations in time frame. More...
	getListByDate (bool $a_has_schedule, array $a_object_ids=null, array $filter=null, array $a_pool_ids=null)
	List all reservations by date. More...
	getCachedContextObjBookingInfo (int $context_obj_id)
	Get context object properties info. More...
	getReservationIdsByBookingObjectId (int $booking_object_id)

Protected Member Functions
	preloadByContextIds (array $context_obj_ids)
	Preload reservation information for context obj ids. More...

Protected Attributes
ilDBInterface	$db
array	$preloaded_by_context_list = 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 Repo class for reservations Acts on tables booking_reservation (rw), booking_reservation_group (rw) and booking_object (r)

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilBookingReservationDBRepository::__construct	(	ilDBInterface	$db,
		?array	$preload_context_obj_ids = null
	)

Do not call this constructor directly, use ilBookingReservationDBRepositoryFactory instead.

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

References $db, and preloadByContextIds().

      {
        if (is_array($preload_context_obj_ids)) {
            $this->preloadByContextIds($preload_context_obj_ids);
        }
        $this->db = $db;
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilBookingReservationDBRepository::create	(	int	$user_id,
		int	$assigner_id,
		int	$object_id,
		int	$context_obj_id,
		int	$from,
		int	$to,
		int	$status,
		int	$group_id
	)

Returns

int new reservation id

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

References $db, $id, and $ilDB.

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

        $id = $ilDB->nextId('booking_reservation');
        $ilDB->manipulate('INSERT INTO booking_reservation' .
            ' (booking_reservation_id,user_id,assigner_id,object_id,context_obj_id,date_from,date_to,status,group_id)' .
            ' VALUES (' . $ilDB->quote($id, 'integer') .
            ',' . $ilDB->quote($user_id, 'integer') .
            ',' . $ilDB->quote($assigner_id, 'integer') .
            ',' . $ilDB->quote($object_id, 'integer') .
            ',' . $ilDB->quote($context_obj_id, 'integer') .
            ',' . $ilDB->quote($from, 'integer') .
            ',' . $ilDB->quote($to, 'integer') .
            ',' . $ilDB->quote($status, 'integer') .
            ',' . $ilDB->quote($group_id, 'integer') . ')');
        return $id;
    }

delete()

ilBookingReservationDBRepository::delete

(

int

$id

)

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

References $db, $id, and $ilDB.

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

        if ($id) {
            $ilDB->manipulate('DELETE FROM booking_reservation' .
                ' WHERE booking_reservation_id = ' . $ilDB->quote($id, 'integer'));
        }
    }

getCachedContextObjBookingInfo()

ilBookingReservationDBRepository::getCachedContextObjBookingInfo

(

int

$context_obj_id

)

Get context object properties info.

Exceptions

ilBookingReservationException

Definition at line 321 of file class.ilBookingReservationDBRepository.php.

Referenced by ilBookingInfoListItemPropertiesAdapter\appendProperties().

     : array {
        if (!is_array($this->preloaded_by_context_list)) {
            throw new ilBookingReservationException("Repo not initilialized.");
        }
        return array_filter($this->preloaded_by_context_list, static function ($row) use ($context_obj_id) {
            return ($row["context_obj_id"] == $context_obj_id);
        });
    }

Here is the caller graph for this function:

getForId()

ilBookingReservationDBRepository::getForId

(

int

$id

)

Get reservation data for id.

Returns

string[]

Definition at line 47 of file class.ilBookingReservationDBRepository.php.

References $db, and $ilDB.

                                     : array
    {
        $ilDB = $this->db;
        $set = $ilDB->query('SELECT *' .
            ' FROM booking_reservation' .
            ' WHERE booking_reservation_id = ' . $ilDB->quote($id, 'integer'));
        return $ilDB->fetchAssoc($set);
    }

getListByDate()

ilBookingReservationDBRepository::getListByDate	(	bool	$a_has_schedule,
		array	$a_object_ids = null,
		array	$filter = null,
		array	$a_pool_ids = null
	)

List all reservations by date.

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

References $db, $ilDB, $res, ilObjUser\_lookupName(), and ilBookingReservation\STATUS_CANCELLED.

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

        $res = array();

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

        $where = [];
        if ($a_pool_ids !== null) {
            $where = array($ilDB->in('pool_id', $a_pool_ids, '', 'integer'));
        }

        if ($a_object_ids !== null) {
            $where = array($ilDB->in('object_id', $a_object_ids, '', 'integer'));
        }

        if (isset($filter['context_obj_ids']) && count($filter['context_obj_ids']) > 0) {
            $where = array($ilDB->in('context_obj_id', $filter['context_obj_ids'], '', 'integer'));
        }

        if ($filter['status'] ?? false) {
            if ($filter['status'] > 0) {
                $where[] = 'status = ' . $ilDB->quote($filter['status'], 'integer');
            } else {
                $where[] = '(status != ' . $ilDB->quote(-$filter['status'], 'integer') .
                    ' OR status IS NULL)';
            }
        }
        if (isset($filter['title']) && is_string($filter['title'])) {
            $where[] = '(' . $ilDB->like('title', 'text', '%' . $filter['title'] . '%') .
                ' OR ' . $ilDB->like('description', 'text', '%' . $filter['title'] . '%') . ')';
        }
        if ($a_has_schedule) {
            if (isset($filter['from']) && (int) $filter['from'] > 0) {
                $where[] = 'date_from >= ' . $ilDB->quote($filter['from'], 'integer');
            }
            if (isset($filter['to']) && (int) $filter['to'] > 0) {
                $where[] = 'date_to <= ' . $ilDB->quote($filter['to'], 'integer');
            }
            if (!isset($filter['past']) || !$filter['past']) {
                $where[] = 'date_to > ' . $ilDB->quote(time(), 'integer');
            }
        }
        if (isset($filter['user_id']) && is_numeric($filter['user_id'])) { // #16584
            $where[] = 'user_id = ' . $ilDB->quote($filter['user_id'], 'integer');
        }
        if (count($where) > 0) {
            $sql .= ' WHERE ' . implode(' AND ', $where);
        }

        if ($a_has_schedule) {
            $sql .= ' ORDER BY date_from DESC';
        } else {
            // #16155 - could be cancelled and re-booked
            $sql .= ' ORDER BY status';
        }
        $set = $ilDB->query($sql);
        while ($row = $ilDB->fetchAssoc($set)) {
            $obj_id = $row["object_id"];
            $user_id = $row["user_id"];

            if ($a_has_schedule) {
                $slot = $row["date_from"] . "_" . $row["date_to"];
                $idx = $obj_id . "_" . $user_id . "_" . $slot;
            } else {
                $idx = $obj_id . "_" . $user_id;
            }
            $idx .= "_" . $row["context_obj_id"];

            if ($a_has_schedule && ($filter["slot"] ?? false)) {
                $slot_idx = date("w", $row["date_from"]) . "_" . date("H:i", $row["date_from"]) .
                    "-" . date("H:i", $row["date_to"] + 1);
                if ($filter["slot"] != $slot_idx) {
                    continue;
                }
            }

            if (!isset($res[$idx])) {
                $uname = ilObjUser::_lookupName($user_id);

                $res[$idx] = array(
                    "object_id" => $obj_id
                ,"title" => $row["title"]
                ,"pool_id" => $row["pool_id"]
                ,"context_obj_id" => (int) $row["context_obj_id"]
                ,"user_id" => $user_id
                ,"counter" => 1
                ,"user_name" => $uname["lastname"] . ", " . $uname["firstname"] // #17862
                ,"login" => $uname["login"]
                );

                if ($a_has_schedule) {
                    $res[$idx]["booking_reservation_id"] = $idx;
                    $res[$idx]["date"] = date("Y-m-d", $row["date_from"]);
                    $res[$idx]["slot"] = date("H:i", $row["date_from"]) . " - " .
                        date("H:i", $row["date_to"] + 1);
                    $res[$idx]["week"] = date("W", $row["date_from"]);
                    $res[$idx]["weekday"] = date("w", $row["date_from"]);
                    $res[$idx]["can_be_cancelled"] = ($row["status"] != ilBookingReservation::STATUS_CANCELLED &&
                        $row["date_from"] > time());
                    $res[$idx]["_sortdate"] = $row["date_from"];

                    // this currently means: has any cancelled reservations (it is not grouped by this info)
                    $res[$idx]["status"] = $row["status"];
                } else {
                    $res[$idx]["booking_reservation_id"] = $row["booking_reservation_id"];
                    $res[$idx]["status"] = $row["status"];
                    $res[$idx]["can_be_cancelled"] = ($row["status"] != ilBookingReservation::STATUS_CANCELLED);
                }
            } else {
                $res[$idx]["counter"]++;
            }
        }

        return $res;
    }

Here is the call graph for this function:

getNewGroupId()

ilBookingReservationDBRepository::getNewGroupId

(

)

Returns

int group id

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

                                   : int
    {
        return $this->db->nextId('booking_reservation_group');
    }

getNumberOfReservations()

ilBookingReservationDBRepository::getNumberOfReservations	(	array	$ids,
		int	$from,
		int	$to,
		bool	$only_not_over_yet = false
	)

Get number of uncancelled reservations in time frame.

Parameters

int[]

$ids booking object ids

Definition at line 136 of file class.ilBookingReservationDBRepository.php.

References $db, $ilDB, $res, and ilBookingReservation\STATUS_CANCELLED.

Referenced by ilBookingReservation\getAvailableObject(), and ilBookingReservation\isObjectAvailableInPeriod().

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

        $from = $ilDB->quote($from, 'integer');
        $to = $ilDB->quote($to, 'integer');

        $date = $only_not_over_yet
            ? ' AND date_to > ' . $ilDB->quote(time(), "integer")
            : "";

        $set = $ilDB->query('SELECT count(*) cnt, object_id' .
            ' FROM booking_reservation' .
            ' WHERE ' . $ilDB->in('object_id', $ids, '', 'integer') . $date .
            ' AND (status IS NULL OR status <> ' . $ilDB->quote(
                ilBookingReservation::STATUS_CANCELLED,
                'integer'
            ) . ')' .
            ' AND date_from <= ' . $to . ' AND date_to >= ' . $from .
            ' GROUP BY object_id');
        $res = [];
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[$row["object_id"]] = $row;
        }
        return $res;
    }

Here is the caller graph for this function:

getReservationIdsByBookingObjectId()

ilBookingReservationDBRepository::getReservationIdsByBookingObjectId

(

int

$booking_object_id

)

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

References ILIAS\Repository\int().

                                                                              : array
    {
        $set = $this->db->queryF(
            "SELECT booking_reservation_id FROM booking_reservation " .
            " WHERE object_id = %s ",
            ["integer"],
            [$booking_object_id]
        );
        $ret = [];
        while ($row = $this->db->fetchAssoc($set)) {
            $ret[] = (int) $row['booking_reservation_id'];
        }

        return $ret;
    }

Here is the call graph for this function:

preloadByContextIds()

ilBookingReservationDBRepository::preloadByContextIds ( array  $context_obj_ids )

protected

Preload reservation information for context obj ids.

Parameters

int[]

$context_obj_ids

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

References Vendor\Package\$f, ilArrayUtil\sortArray(), ilArrayUtil\stableSortArray(), and ilBookingReservation\STATUS_CANCELLED.

Referenced by __construct().

     : void {
        $filter = ["context_obj_ids" => ($context_obj_ids)];
        $filter['past'] = true;
        $filter['status'] = -ilBookingReservation::STATUS_CANCELLED;
        $f = new ilBookingReservationDBRepositoryFactory();
        $repo = $f->getRepo();
        $list = $repo->getListByDate(true, null, $filter);
        $list = ilArrayUtil::sortArray($list, "slot", "asc", true);
        $list = ilArrayUtil::stableSortArray($list, "date", "asc", true);
        $list = ilArrayUtil::stableSortArray($list, "object_id", "asc", true);
        $this->preloaded_by_context_list = ilArrayUtil::stableSortArray($list, "pool_id", "asc", true);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilBookingReservationDBRepository::update	(	int	$id,
		int	$user_id,
		int	$assigner_id,
		int	$object_id,
		int	$context_obj_id,
		int	$from,
		int	$to,
		int	$status,
		int	$group_id
	)

Returns

int number of affected records

Definition at line 89 of file class.ilBookingReservationDBRepository.php.

References $db, and $ilDB.

     : int {
        $ilDB = $this->db;
        return $ilDB->manipulate('UPDATE booking_reservation' .
            ' SET object_id = ' . $ilDB->quote($object_id, 'text') .
            ', user_id = ' . $ilDB->quote($user_id, 'integer') .
            ', assigner_id = ' . $ilDB->quote($assigner_id, 'integer') .
            ', date_from = ' . $ilDB->quote($from, 'integer') .
            ', date_to = ' . $ilDB->quote($to, 'integer') .
            ', status = ' . $ilDB->quote($status, 'integer') .
            ', group_id = ' . $ilDB->quote($group_id, 'integer') .
            ', context_obj_id = ' . $ilDB->quote($context_obj_id, 'integer') .
            ' WHERE booking_reservation_id = ' . $ilDB->quote($id, 'integer'));
    }

Field Documentation

$db

ilDBInterface ilBookingReservationDBRepository::$db

protected

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

Referenced by __construct(), create(), delete(), getForId(), getListByDate(), getNumberOfReservations(), and update().

$preloaded_by_context_list

array ilBookingReservationDBRepository::$preloaded_by_context_list = null

protected

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

---

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

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