ilBookingObject Class Reference

a bookable ressource More...

Collaboration diagram for ilBookingObject:

Public Member Functions
	__construct ($a_id=null)
	Constructor. More...
	getId ()
	Get id. More...
	setTitle ($a_title)
	Set object title. More...
	getTitle ()
	Get object title. More...
	setDescription ($a_value)
	Set object description. More...
	getDescription ()
	Get object description. More...
	setPoolId ($a_pool_id)
	Set booking pool id. More...
	getPoolId ()
	Get booking pool id. More...
	setScheduleId ($a_schedule_id)
	Set booking schedule id. More...
	getScheduleId ()
	Get booking schedule id. More...
	setNrOfItems ($a_value)
	Set number of items. More...
	getNrOfItems ()
	Get number of items. More...
	setFile ($a_value)
	Set info file. More...
	getFile ()
	Get info file. More...
	getFileFullPath ()
	Get path to info file. More...
	uploadFile (array $a_upload)
	Upload new info file. More...
	deleteFile ()
	remove existing info file More...
	setPostText ($a_value)
	Set post text. More...
	getPostText ()
	Get post text. More...
	setPostFile ($a_value)
	Set post file. More...
	getPostFile ()
	Get post file. More...
	getPostFileFullPath ()
	Get path to post file. More...
	uploadPostFile (array $a_upload)
	Upload new post file. More...
	deletePostFile ()
	remove existing post file More...
	deleteFiles ()
	remove existing files More...
	save ()
	Create new entry in db. More...
	update ()
	Update entry in db. More...
	delete ()
	Delete single entry. More...
	doClone ($a_pool_id, $a_schedule_map=null)

Static Public Member Functions
static	initStorage ($a_id, $a_subdir=null)
	Init file system storage. More...
static	getList ($a_pool_id, $a_title=null)
	Get list of booking objects for given type. More...
static	getNumberOfObjectsForPool ($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. More...
static	lookupPoolId ($object_id)
	Lookup pool id. More...
static	lookupTitle ($object_id)
	Lookup pool id. More...

Protected Member Functions
	read ()
	Get dataset from db. More...
	getDBFields ()
	Parse properties for sql statements. More...

Protected Attributes
	$db
	$id
	$pool_id
	$title
	$description
	$nr_of_items
	$schedule_id
	$info_file
	$post_text
	$post_file

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilBookingObject::__construct

(

$a_id = null

)

Constructor.

if id is given will read dataset from db

Parameters

int

$a_id

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

References $DIC, 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()

ilBookingObject::delete

(

)

Delete single entry.

Returns

bool

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

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

    {
        $ilDB = $this->db;

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

Here is the call graph for this function:

deleteFile()

ilBookingObject::deleteFile

(

)

remove existing info file

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

References getFileFullPath(), and setFile().

Referenced by uploadFile().

    {
        if ($this->id) {
            $path = $this->getFileFullPath();
            if ($path) {
                @unlink($path);
                $this->setFile(null);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteFiles()

ilBookingObject::deleteFiles

(

)

remove existing files

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

References setFile(), and setPostFile().

Referenced by delete().

    {
        if ($this->id) {
            $storage = new ilFSStorageBooking($this->id);
            $storage->delete();
            
            $this->setFile(null);
            $this->setPostFile(null);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deletePostFile()

ilBookingObject::deletePostFile

(

)

remove existing post file

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

References getPostFileFullPath(), and setPostFile().

Referenced by uploadPostFile().

    {
        if ($this->id) {
            $path = $this->getPostFileFullPath();
            if ($path) {
                @unlink($path);
                $this->setPostFile(null);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doClone()

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

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

References $schedule_id, $source, getDescription(), getFile(), getId(), getNrOfItems(), getPostFile(), getPostText(), getScheduleId(), getTitle(), initStorage(), and ilUtil\rCopy().

    {
        $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]);
            }
        }
        
        $new_obj->save();
                
        // files
        $source = $this->initStorage($this->getId());
        $target = $new_obj->initStorage($new_obj->getId());
        ilUtil::rCopy($source, $target);
    }

Here is the call graph for this function:

getDBFields()

ilBookingObject::getDBFields ( )

protected

Parse properties for sql statements.

Returns

array

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

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

Referenced by save(), and update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getDescription()

ilBookingObject::getDescription

(

)

Get object description.

Returns

string

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

References $description.

Referenced by doClone(), and getDBFields().

    {
        return $this->description;
    }

Here is the caller graph for this function:

getFile()

ilBookingObject::getFile

(

)

Get info file.

Returns

string

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

References $info_file.

Referenced by doClone(), and getDBFields().

    {
        return $this->info_file;
    }

Here is the caller graph for this function:

getFileFullPath()

ilBookingObject::getFileFullPath

(

)

Get path to info file.

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

References $info_file, and initStorage().

Referenced by deleteFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getId()

ilBookingObject::getId

(

)

Get id.

Returns

int

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

References $id.

Referenced by doClone().

    {
        return $this->id;
    }

Here is the caller graph for this function:

getList()

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

static

Get list of booking objects for given type.

Parameters

int	$a_pool_id
string	$a_title

Returns

array

Definition at line 428 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().

    {
        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

(

)

Get number of items.

Returns

int

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

References $nr_of_items.

Referenced by doClone(), and getDBFields().

    {
        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.

Parameters

array

$a_obj_ids

Returns

array

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

References $DIC, and $ilDB.

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

    {
        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[$row["booking_object_id"]] = $row["nr_items"];
        }
        
        return $map;
    }

Here is the caller graph for this function:

getNumberOfObjectsForPool()

static ilBookingObject::getNumberOfObjectsForPool (   $a_pool_id )

static

Get number of booking objects for given booking pool id.

Parameters

int

$a_pool_id

Returns

int

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

References $DIC, and $ilDB.

Referenced by ilBookingParticipantsTableGUI\fillRow().

    {
        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 $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.

Parameters

int

$a_pool_id

Returns

array

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

References $DIC, and $ilDB.

Referenced by ilBookingReservation\isBookingPoolLimitReachedByUser().

                                                             : 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[] = $row['booking_object_id'];
        }

        return $objects;
    }

Here is the caller graph for this function:

getPoolId()

ilBookingObject::getPoolId

(

)

Get booking pool id.

Returns

int

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

References $pool_id.

Referenced by save().

    {
        return $this->pool_id;
    }

Here is the caller graph for this function:

getPostFile()

ilBookingObject::getPostFile

(

)

Get post file.

Returns

string

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

References $post_file.

Referenced by doClone(), and getDBFields().

    {
        return $this->post_file;
    }

Here is the caller graph for this function:

getPostFileFullPath()

ilBookingObject::getPostFileFullPath

(

)

Get path to post file.

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

References $post_file, and initStorage().

Referenced by deletePostFile().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPostText()

ilBookingObject::getPostText

(

)

Get post text.

Returns

string

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

References $post_text.

Referenced by doClone(), and getDBFields().

    {
        return $this->post_text;
    }

Here is the caller graph for this function:

getScheduleId()

ilBookingObject::getScheduleId

(

)

Get booking schedule id.

Returns

int

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

References $schedule_id.

Referenced by doClone(), and getDBFields().

    {
        return $this->schedule_id;
    }

Here is the caller graph for this function:

getTitle()

ilBookingObject::getTitle

(

)

Get object title.

Returns

string

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

References $title.

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

    {
        return $this->title;
    }

Here is the caller graph for this function:

initStorage()

static ilBookingObject::initStorage (   $a_id,   $a_subdir = null  )

static

Init file system storage.

Parameters

type	$a_id
type	$a_subdir

Returns

string

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

Referenced by doClone(), getFileFullPath(), getPostFileFullPath(), uploadFile(), and uploadPostFile().

    {
        $storage = new ilFSStorageBooking($a_id);
        $storage->create();
        
        $path = $storage->getAbsolutePath() . "/";
        
        if ($a_subdir) {
            $path .= $a_subdir . "/";
            
            if (!is_dir($path)) {
                mkdir($path);
            }
        }
                
        return $path;
    }

Here is the caller graph for this function:

lookupPoolId()

static ilBookingObject::lookupPoolId (   $object_id )

static

Lookup pool id.

Parameters

int

$object_id

Returns

int

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

References $db, and $DIC.

Referenced by ilBookingReservationsGUI\__construct(), ilObjBookingPoolGUI\__construct(), and ilBookingReservation\getMembersWithoutReservation().

    {
        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 caller graph for this function:

lookupTitle()

static ilBookingObject::lookupTitle (   $object_id )

static

Lookup pool id.

Parameters

int

$object_id

Returns

int

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

References $db, and $DIC.

Referenced by ilBookingPreferencesGUI\savePreferences().

    {
        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 caller graph for this function:

read()

ilBookingObject::read ( )

protected

Get dataset from db.

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

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

Referenced by __construct().

    {
        $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($row['title']);
            $this->setDescription($row['description']);
            $this->setPoolId($row['pool_id']);
            $this->setScheduleId($row['schedule_id']);
            $this->setNrOfItems($row['nr_items']);
            $this->setFile($row['info_file']);
            $this->setPostText($row['post_text']);
            $this->setPostFile($row['post_file']);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBookingObject::save

(

)

Create new entry in db.

Returns

bool

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

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

    {
        $ilDB = $this->db;

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

(

$a_value

)

Set object description.

Parameters

string

$a_value

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

Referenced by read().

    {
        $this->description = $a_value;
    }

Here is the caller graph for this function:

setFile()

ilBookingObject::setFile

(

$a_value

)

Set info file.

Parameters

string

$a_value

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

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

    {
        $this->info_file = $a_value;
    }

Here is the caller graph for this function:

setNrOfItems()

ilBookingObject::setNrOfItems

(

$a_value

)

Set number of items.

Parameters

int

$a_value

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

Referenced by read().

    {
        $this->nr_of_items = (int) $a_value;
    }

Here is the caller graph for this function:

setPoolId()

ilBookingObject::setPoolId

(

$a_pool_id

)

Set booking pool id.

Parameters

int

$a_pool_id

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

Referenced by read(), and ilBookingObjectGUI\save().

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

Here is the caller graph for this function:

setPostFile()

ilBookingObject::setPostFile

(

$a_value

)

Set post file.

Parameters

string

$a_value

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

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

    {
        $this->post_file = $a_value;
    }

Here is the caller graph for this function:

setPostText()

ilBookingObject::setPostText

(

$a_value

)

Set post text.

Parameters

string

$a_value

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

Referenced by read().

    {
        $this->post_text = $a_value;
    }

Here is the caller graph for this function:

setScheduleId()

ilBookingObject::setScheduleId

(

$a_schedule_id

)

Set booking schedule id.

Parameters

int

$a_schedule_id

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

Referenced by read().

    {
        $this->schedule_id = (int) $a_schedule_id;
    }

Here is the caller graph for this function:

setTitle()

ilBookingObject::setTitle

(

$a_title

)

Set object title.

Parameters

string

$a_title

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

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

update()

ilBookingObject::update

(

)

Update entry in db.

Returns

bool

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

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

    {
        $ilDB = $this->db;

        if (!$this->id) {
            return false;
        }
        
        $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.

Parameters

array

$a_upload

Returns

bool

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

References deleteFile(), initStorage(), ilUtil\moveUploadedFile(), and setFile().

    {
        if (!$this->id) {
            return false;
        }
        
        $this->deleteFile();
    
        $path = $this->initStorage($this->id, "file");
        $original = $a_upload["name"];
        if (ilUtil::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.

Parameters

array

$a_upload

Returns

bool

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

References deletePostFile(), initStorage(), ilUtil\moveUploadedFile(), and setPostFile().

    {
        if (!$this->id) {
            return false;
        }
        
        $this->deletePostFile();
    
        $path = $this->initStorage($this->id, "post");
        $original = $a_upload["name"];

        if (ilUtil::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

ilBookingObject::$db

protected

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

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

$description

ilBookingObject::$description

protected

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

Referenced by getDescription().

$id

ilBookingObject::$id

protected

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

Referenced by getId().

$info_file

ilBookingObject::$info_file

protected

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

Referenced by getFile(), and getFileFullPath().

$nr_of_items

ilBookingObject::$nr_of_items

protected

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

Referenced by getNrOfItems().

$pool_id

ilBookingObject::$pool_id

protected

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

Referenced by getPoolId().

$post_file

ilBookingObject::$post_file

protected

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

Referenced by getPostFile(), and getPostFileFullPath().

$post_text

ilBookingObject::$post_text

protected

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

Referenced by getPostText().

$schedule_id

ilBookingObject::$schedule_id

protected

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

Referenced by doClone(), and getScheduleId().

$title

ilBookingObject::$title

protected

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

Referenced by getTitle().

---

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

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