ilBookingObject 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 ilBookingObject:

Public Member Functions
	__construct (int $a_id=null)
	getId ()
	setTitle (string $a_title)
	getTitle ()
	setDescription (string $a_value)
	getDescription ()
	setPoolId (int $a_pool_id)
	getPoolId ()
	setScheduleId (?int $a_schedule_id)
	getScheduleId ()
	setNrOfItems (int $a_value)
	getNrOfItems ()
	setFile (string $a_value)
	getFile ()
	getFileFullPath ()
	uploadFile (array $a_upload)
	Upload new info file. More...
	deleteFile ()
	setPostText (string $a_value)
	getPostText ()
	setPostFile (string $a_value)
	getPostFile ()
	getPostFileFullPath ()
	uploadPostFile (array $a_upload)
	Upload new post file. More...
	deletePostFile ()
	deleteFiles ()
	save ()
	update ()
	delete ()
	Delete single entry. More...
	deleteReservationsAndCalEntries (int $object_id)
	doClone (int $a_pool_id, array $a_schedule_map=null)

Static Public Member Functions
static	initStorage (int $a_id, string $a_subdir="")
	Init file system storage. More...
static	getList (int $a_pool_id, string $a_title=null)
	Get list of booking objects. More...
static	getNumberOfObjectsForPool (int $a_pool_id)
	Get number of booking objects for given booking pool id. More...
static	getObjectsForPool (int $a_pool_id)
	Get all booking pool object ids from an specific booking pool. More...
static	getNrOfItemsForObjects (array $a_obj_ids)
	Get nr of available items for a set of object ids. More...
static	lookupPoolId (int $object_id)
static	lookupTitle (int $object_id)

Protected Member Functions
	read ()
	getDBFields ()

Protected Attributes
ILIAS BookingManager InternalRepoService	$repo
ilDBInterface	$db
int	$id = 0
int	$pool_id = 0
string	$title = ""
string	$description = ""
int	$nr_of_items = 0
int	$schedule_id = null
string	$info_file = ""
string	$post_text = ""
string	$post_file = ""

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 A bookable 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.ilBookingObject.php.

Constructor & Destructor Documentation

__construct()

ilBookingObject::__construct

(

int

$a_id = null

)

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

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

      {
        global $DIC;

        $this->db = $DIC->database();
        $this->id = (int) $a_id;
        $this->read();
        $this->repo = $DIC->bookingManager()->internal()->repo();
    }

Here is the call graph for this function:

Member Function Documentation

delete()

ilBookingObject::delete

(

)

Delete single entry.

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

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

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

        if ($this->id) {
            $this->deleteFiles();

            return $ilDB->manipulate('DELETE FROM booking_object' .
                ' WHERE booking_object_id = ' . $ilDB->quote($this->id, 'integer'));
        }
        return 0;
    }

Here is the call graph for this function:

deleteFile()

ilBookingObject::deleteFile

(

)

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

References $path, getFileFullPath(), and setFile().

Referenced by uploadFile().

                                : void
    {
        if ($this->id) {
            $path = $this->getFileFullPath();
            if ($path) {
                if (is_file($path)) {
                    unlink($path);
                }
                $this->setFile("");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteFiles()

ilBookingObject::deleteFiles

(

)

Definition at line 224 of file class.ilBookingObject.php.

References setFile(), and setPostFile().

Referenced by delete().

                                 : void
    {
        if ($this->id) {
            $storage = new ilFSStorageBooking($this->id);
            $storage->delete();

            $this->setFile("");
            $this->setPostFile("");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deletePostFile()

ilBookingObject::deletePostFile

(

)

Definition at line 211 of file class.ilBookingObject.php.

References $path, getPostFileFullPath(), and setPostFile().

Referenced by uploadPostFile().

                                    : void
    {
        if ($this->id) {
            $path = $this->getPostFileFullPath();
            if ($path) {
                if (is_file($path)) {
                    unlink($path);
                }
                $this->setPostFile("");
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteReservationsAndCalEntries()

ilBookingObject::deleteReservationsAndCalEntries

(

int

$object_id

)

Definition at line 415 of file class.ilBookingObject.php.

References ilCalendarEntry\delete().

                                                                   : void
    {
        $reservation_db = $this->repo->reservation();
        $reservation_ids = $reservation_db->getReservationIdsByBookingObjectId($object_id);

        foreach ($reservation_ids as $reservation_id) {
            $reservation = new ilBookingReservation($reservation_id);
            $entry = new ilCalendarEntry($reservation->getCalendarEntry());
            $reservation_db->delete($reservation_id);
            $entry->delete();
        }
    }

Here is the call graph for this function:

doClone()

ilBookingObject::doClone	(	int	$a_pool_id,
		array	$a_schedule_map = null
	)

Definition at line 452 of file class.ilBookingObject.php.

References getDescription(), getFile(), getId(), getNrOfItems(), getPostFile(), getPostText(), getScheduleId(), getTitle(), and ilFileUtils\rCopy().

     : void {
        $new_obj = new self();
        $new_obj->setPoolId($a_pool_id);
        $new_obj->setTitle($this->getTitle());
        $new_obj->setDescription($this->getDescription());
        $new_obj->setNrOfItems($this->getNrOfItems());
        $new_obj->setFile($this->getFile());
        $new_obj->setPostText($this->getPostText());
        $new_obj->setPostFile($this->getPostFile());

        if ($a_schedule_map) {
            $schedule_id = $this->getScheduleId();
            if ($schedule_id) {
                $new_obj->setScheduleId($a_schedule_map[$schedule_id] ?? null);
            }
        }

        $new_obj->save();

        // files
        $source = self::initStorage($this->getId());
        $target = $new_obj::initStorage($new_obj->getId());
        ilFileUtils::rCopy($source, $target);
    }

Here is the call graph for this function:

getDBFields()

ilBookingObject::getDBFields ( )

protected

Returns

string[][]

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

References getDescription(), getFile(), getNrOfItems(), getPostFile(), getPostText(), getScheduleId(), and getTitle().

Referenced by save(), and update().

                                    : array
    {
        return array(
            'title' => array('text', $this->getTitle()),
            'description' => array('text', $this->getDescription()),
            'schedule_id' => array('text', $this->getScheduleId()),
            'nr_items' => array('text', $this->getNrOfItems()),
            'info_file' => array('text', $this->getFile()),
            'post_text' => array('text', $this->getPostText()),
            'post_file' => array('text', $this->getPostFile())
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

ilBookingObject::getDescription

(

)

Definition at line 68 of file class.ilBookingObject.php.

References $description.

Referenced by doClone(), and getDBFields().

                                    : string
    {
        return $this->description;
    }

Here is the caller graph for this function:

getFile()

ilBookingObject::getFile

(

)

Definition at line 108 of file class.ilBookingObject.php.

References $info_file.

Referenced by doClone(), and getDBFields().

                             : string
    {
        return $this->info_file;
    }

Here is the caller graph for this function:

getFileFullPath()

ilBookingObject::getFileFullPath

(

)

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

References $info_file, and $path.

Referenced by deleteFile().

                                     : string
    {
        if ($this->id && $this->info_file) {
            $path = self::initStorage($this->id, "file");
            return $path . $this->info_file;
        }
        return "";
    }

Here is the caller graph for this function:

getId()

ilBookingObject::getId

(

)

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

References $id.

Referenced by doClone().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getList()

static ilBookingObject::getList ( int  $a_pool_id, string  $a_title = null  )

static

Get list of booking objects.

Definition at line 331 of file class.ilBookingObject.php.

References $DIC, $ilDB, and $res.

Referenced by ilBookingPreferencesManager\calculateBookings(), ilObjBookingPool\cloneObject(), ilBookingAssignObjectsTableGUI\getItems(), ilBookingObjectsTableGUI\getItems(), ilObjBookingPoolGUI\initEditCustomForm(), ilBookingParticipantsTableGUI\initFilter(), ilBookingReservationsTableGUI\initFilter(), ilBookingPreferencesGUI\initPreferenceForm(), ilBookingPreferencesGUI\listPreferenceOptions(), ilBookingPreferencesManager\readBookings(), ilBookingScheduleGUI\render(), and ilBookingReservationsGUI\rsvConfirmCancel().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $sql = 'SELECT *' .
            ' FROM booking_object' .
            ' WHERE pool_id = ' . $ilDB->quote($a_pool_id, 'integer');

        if ($a_title) {
            $sql .= ' AND (' . $ilDB->like('title', 'text', '%' . $a_title . '%') .
                ' OR ' . $ilDB->like('description', 'text', '%' . $a_title . '%') . ')';
        }

        $sql .= ' ORDER BY title';

        $set = $ilDB->query($sql);
        $res = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = $row;
        }
        return $res;
    }

Here is the caller graph for this function:

getNrOfItems()

ilBookingObject::getNrOfItems

(

)

Definition at line 98 of file class.ilBookingObject.php.

References $nr_of_items.

Referenced by doClone(), and getDBFields().

                                  : int
    {
        return $this->nr_of_items;
    }

Here is the caller graph for this function:

getNrOfItemsForObjects()

static ilBookingObject::getNrOfItemsForObjects ( array  $a_obj_ids )

static

Get nr of available items for a set of object ids.

Parameters

int[]

$a_obj_ids

Returns

int[]

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

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

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

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        $map = array();

        $set = $ilDB->query("SELECT booking_object_id,nr_items" .
            " FROM booking_object" .
            " WHERE " . $ilDB->in("booking_object_id", $a_obj_ids, "", "integer"));
        while ($row = $ilDB->fetchAssoc($set)) {
            $map[(int) $row["booking_object_id"]] = (int) $row["nr_items"];
        }

        return $map;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNumberOfObjectsForPool()

static ilBookingObject::getNumberOfObjectsForPool ( int  $a_pool_id )

static

Get number of booking objects for given booking pool id.

Definition at line 361 of file class.ilBookingObject.php.

References $DIC, and $ilDB.

Referenced by ilBookingParticipantsTableGUI\fillRow().

     : int {
        global $DIC;

        $ilDB = $DIC->database();

        $sql = 'SELECT count(*) as count' .
            ' FROM booking_object' .
            ' WHERE pool_id = ' . $ilDB->quote($a_pool_id, 'integer');
        $set = $ilDB->query($sql);
        $rec = $ilDB->fetchAssoc($set);

        return (int) $rec["count"];
    }

Here is the caller graph for this function:

getObjectsForPool()

static ilBookingObject::getObjectsForPool ( int  $a_pool_id )

static

Get all booking pool object ids from an specific booking pool.

Definition at line 380 of file class.ilBookingObject.php.

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

     : array {
        global $DIC;
        $ilDB = $DIC->database();

        $set = $ilDB->query("SELECT booking_object_id" .
            " FROM booking_object" .
            " WHERE pool_id = " . $ilDB->quote($a_pool_id, 'integer'));

        $objects = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $objects[] = (int) $row['booking_object_id'];
        }

        return $objects;
    }

Here is the call graph for this function:

getPoolId()

ilBookingObject::getPoolId

(

)

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

References $pool_id.

Referenced by save().

                               : int
    {
        return $this->pool_id;
    }

Here is the caller graph for this function:

getPostFile()

ilBookingObject::getPostFile

(

)

Definition at line 173 of file class.ilBookingObject.php.

References $post_file.

Referenced by doClone(), and getDBFields().

                                 : string
    {
        return $this->post_file;
    }

Here is the caller graph for this function:

getPostFileFullPath()

ilBookingObject::getPostFileFullPath

(

)

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

References $path, and $post_file.

Referenced by deletePostFile().

                                         : string
    {
        if ($this->id && $this->post_file) {
            $path = self::initStorage($this->id, "post");
            return $path . $this->post_file;
        }
        return "";
    }

Here is the caller graph for this function:

getPostText()

ilBookingObject::getPostText

(

)

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

References $post_text.

Referenced by doClone(), and getDBFields().

                                 : string
    {
        return $this->post_text;
    }

Here is the caller graph for this function:

getScheduleId()

ilBookingObject::getScheduleId

(

)

Definition at line 88 of file class.ilBookingObject.php.

References $schedule_id.

Referenced by doClone(), and getDBFields().

                                   : ?int
    {
        return $this->schedule_id;
    }

Here is the caller graph for this function:

getTitle()

ilBookingObject::getTitle

(

)

Definition at line 58 of file class.ilBookingObject.php.

References $title.

Referenced by doClone(), getDBFields(), and ilBookingReservationsGUI\rsvConfirmCancelAggregationForm().

                              : string
    {
        return $this->title;
    }

Here is the caller graph for this function:

initStorage()

static ilBookingObject::initStorage ( int  $a_id, string  $a_subdir = ""  )

static

Init file system storage.

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

References $path.

     : string {
        $storage = new ilFSStorageBooking($a_id);
        $storage->create();

        $path = $storage->getAbsolutePath() . "/";

        if ($a_subdir) {
            $path .= $a_subdir . "/";

            if (!is_dir($path) && !mkdir($path)) {
                throw new \RuntimeException(sprintf('Directory "%s" was not created', $path));
            }
        }

        return $path;
    }

lookupPoolId()

static ilBookingObject::lookupPoolId ( int  $object_id )

static

Definition at line 480 of file class.ilBookingObject.php.

References $DIC, ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

Referenced by ilBookingReservationsGUI\__construct(), ILIAS\BookingManager\BookingProcess\BookingProcessManager\bookSingle(), and ilBookingReservation\getMembersWithoutReservation().

                                                       : int
    {
        global $DIC;

        $db = $DIC->database();
        $set = $db->queryF(
            "SELECT pool_id FROM booking_object " .
            " WHERE booking_object_id = %s ",
            array("integer"),
            array($object_id)
        );
        $rec = $db->fetchAssoc($set);
        return (int) $rec["pool_id"];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupTitle()

static ilBookingObject::lookupTitle ( int  $object_id )

static

Definition at line 495 of file class.ilBookingObject.php.

References $DIC, ilDBInterface\fetchAssoc(), and ilDBInterface\queryF().

Referenced by ilBookingPreferencesGUI\savePreferences().

                                                      : string
    {
        global $DIC;

        $db = $DIC->database();
        $set = $db->queryF(
            "SELECT title FROM booking_object " .
            " WHERE booking_object_id = %s ",
            array("integer"),
            array($object_id)
        );
        $rec = $db->fetchAssoc($set);
        return $rec["title"];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilBookingObject::read ( )

protected

Definition at line 258 of file class.ilBookingObject.php.

References $db, $ilDB, setDescription(), setFile(), setNrOfItems(), setPoolId(), setPostFile(), setPostText(), setScheduleId(), and setTitle().

Referenced by __construct().

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

        if ($this->id) {
            $set = $ilDB->query('SELECT *' .
                ' FROM booking_object' .
                ' WHERE booking_object_id = ' . $ilDB->quote($this->id, 'integer'));
            $row = $ilDB->fetchAssoc($set);
            $this->setTitle((string) $row['title']);
            $this->setDescription((string) $row['description']);
            $this->setPoolId((int) $row['pool_id']);
            $this->setScheduleId($row['schedule_id']);
            $this->setNrOfItems((int) $row['nr_items']);
            $this->setFile((string) $row['info_file']);
            $this->setPostText((string) $row['post_text']);
            $this->setPostFile((string) $row['post_file']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBookingObject::save

(

)

Definition at line 294 of file class.ilBookingObject.php.

References $db, $ilDB, getDBFields(), and getPoolId().

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

        if ($this->id) {
            return null;
        }

        $this->id = $ilDB->nextId('booking_object');

        $fields = $this->getDBFields();
        $fields['booking_object_id'] = array('integer', $this->id);
        $fields['pool_id'] = array('integer', $this->getPoolId());

        return $ilDB->insert('booking_object', $fields);
    }

Here is the call graph for this function:

setDescription()

ilBookingObject::setDescription

(

string

$a_value

)

Definition at line 63 of file class.ilBookingObject.php.

Referenced by read().

                                                   : void
    {
        $this->description = $a_value;
    }

Here is the caller graph for this function:

setFile()

ilBookingObject::setFile

(

string

$a_value

)

Definition at line 103 of file class.ilBookingObject.php.

Referenced by deleteFile(), deleteFiles(), read(), and uploadFile().

                                            : void
    {
        $this->info_file = $a_value;
    }

Here is the caller graph for this function:

setNrOfItems()

ilBookingObject::setNrOfItems

(

int

$a_value

)

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

Referenced by read().

                                              : void
    {
        $this->nr_of_items = $a_value;
    }

Here is the caller graph for this function:

setPoolId()

ilBookingObject::setPoolId

(

int

$a_pool_id

)

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

Referenced by read().

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

Here is the caller graph for this function:

setPostFile()

ilBookingObject::setPostFile

(

string

$a_value

)

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

Referenced by deleteFiles(), deletePostFile(), read(), and uploadPostFile().

                                                : void
    {
        $this->post_file = $a_value;
    }

Here is the caller graph for this function:

setPostText()

ilBookingObject::setPostText

(

string

$a_value

)

Definition at line 158 of file class.ilBookingObject.php.

Referenced by read().

                                                : void
    {
        $this->post_text = $a_value;
    }

Here is the caller graph for this function:

setScheduleId()

ilBookingObject::setScheduleId

(

?int

$a_schedule_id

)

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

Referenced by read().

                                                      : void
    {
        $this->schedule_id = $a_schedule_id;
    }

Here is the caller graph for this function:

setTitle()

ilBookingObject::setTitle

(

string

$a_title

)

Definition at line 53 of file class.ilBookingObject.php.

Referenced by read().

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

Here is the caller graph for this function:

update()

ilBookingObject::update

(

)

Definition at line 311 of file class.ilBookingObject.php.

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

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

        if (!$this->id) {
            return null;
        }

        $fields = $this->getDBFields();

        return $ilDB->update(
            'booking_object',
            $fields,
            array('booking_object_id' => array('integer', $this->id))
        );
    }

Here is the call graph for this function:

uploadFile()

ilBookingObject::uploadFile

(

array

$a_upload

)

Upload new info file.

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

References $path, deleteFile(), ilFileUtils\moveUploadedFile(), and setFile().

                                               : bool
    {
        if (!$this->id) {
            return false;
        }

        $this->deleteFile();

        $path = self::initStorage($this->id, "file");
        $original = $a_upload["name"];
        if (ilFileUtils::moveUploadedFile($a_upload["tmp_name"], $original, $path . $original)) {
            chmod($path . $original, 0770);

            $this->setFile($original);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

uploadPostFile()

ilBookingObject::uploadPostFile

(

array

$a_upload

)

Upload new post file.

Definition at line 190 of file class.ilBookingObject.php.

References $path, deletePostFile(), ilFileUtils\moveUploadedFile(), and setPostFile().

                                                   : bool
    {
        if (!$this->id) {
            return false;
        }

        $this->deletePostFile();

        $path = self::initStorage($this->id, "post");
        $original = $a_upload["name"];

        if (ilFileUtils::moveUploadedFile($a_upload["tmp_name"], $original, $path . $original)) {
            chmod($path . $original, 0770);

            $this->setPostFile($original);
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilBookingObject::$db

protected

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

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

$description

string ilBookingObject::$description = ""

protected

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

Referenced by getDescription().

$id

int ilBookingObject::$id = 0

protected

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

Referenced by getId().

$info_file

string ilBookingObject::$info_file = ""

protected

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

Referenced by getFile(), and getFileFullPath().

$nr_of_items

int ilBookingObject::$nr_of_items = 0

protected

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

Referenced by getNrOfItems().

$pool_id

int ilBookingObject::$pool_id = 0

protected

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

Referenced by getPoolId().

$post_file

string ilBookingObject::$post_file = ""

protected

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

Referenced by getPostFile(), and getPostFileFullPath().

$post_text

string ilBookingObject::$post_text = ""

protected

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

Referenced by getPostText().

$repo

ILIAS BookingManager InternalRepoService ilBookingObject::$repo

protected

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

$schedule_id

int ilBookingObject::$schedule_id = null

protected

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

Referenced by getScheduleId().

$title

string ilBookingObject::$title = ""

protected

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

Referenced by getTitle().

---

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

• Modules/BookingManager/Objects/class.ilBookingObject.php