Inheritance diagram for ilObjBookingPool:

Collaboration diagram for ilObjBookingPool:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	create ()
	create object More...

	update ()
	update object data More...

	read ()

	delete ()
	delete object and all related data More...

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)

	setOffline ($a_value=true)
	Toggle offline property. More...

	isOffline ()
	Get offline property. More...

	setPublicLog ($a_value=true)
	Toggle public log property. More...

	hasPublicLog ()
	Get public log property. More...

	setScheduleType ($a_value)
	Set schedule type. More...

	getScheduleType ()
	Get schedule type. More...

	setOverallLimit ($a_value=null)
	Set overall / global booking limit. More...

	getOverallLimit ()
	Get overall / global booking limit. More...

	setReservationFilterPeriod ($a_value=null)
	Set reservation filter period default. More...

	getReservationFilterPeriod ()
	Get reservation filter period default. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

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

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	_lookupOnline ($a_obj_id)
	Check object status. More...

static	getAdvancedMDFields ($a_ref_id)

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

static	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_lookupOwner ($a_id)
	lookup object owner More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

static	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...

static	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

static	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

static	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

static	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

static	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ( $a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	_lookupCreationDate ($a_id)
	Lookup creation date. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
const	TYPE_FIX_SCHEDULE = 1

const	TYPE_NO_SCHEDULE = 2

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Protected Member Functions
	getDBFields ()
	Parse properties for sql statements. More...

Protected Attributes
	$offline = true

	$public_log

	$schedule_type

	$overall_limit

	$reservation_period

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Class ilObjBookingPool.

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 13 of file class.ilObjBookingPool.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjBookingPool::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

int	$a_id	reference_id or object_id
bool	$a_call_by_reference	treat the id as reference_id (true) or object_id (false)

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

References $DIC, and setScheduleType().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->type = "book";
         $this->setScheduleType(self::TYPE_FIX_SCHEDULE);
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _lookupOnline()

static ilObjBookingPool::_lookupOnline ( $a_obj_id )

static

Check object status.

Parameters

int $a_obj_id

Returns: boolean

Definition at line 255 of file class.ilObjBookingPool.php.

References $DIC, $ilDB, and $row.

Referenced by ilObjBookingPoolListGUI\getProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $set = $ilDB->query("SELECT pool_offline" .
             " FROM booking_settings" .
             " WHERE booking_pool_id = " . $ilDB->quote($a_obj_id, "integer"));
         $row = $ilDB->fetchAssoc($set);
         return !(bool) $row["pool_offline"];
     }

Here is the caller graph for this function:

◆ cloneObject()

ilObjBookingPool::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

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

References ilCopyWizardOptions\_getInstance(), ilObject\getId(), ilBookingSchedule\getList(), ilBookingObject\getList(), getOverallLimit(), getScheduleType(), hasPublicLog(), and isOffline().

     {
         $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
 
         //copy online status if object is not the root copy object
         $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
 
         if (!$cp_options->isRootNode($this->getRefId())) {
             $new_obj->setOffline($this->isOffline());
         }
 
         $new_obj->setScheduleType($this->getScheduleType());
         $new_obj->setPublicLog($this->hasPublicLog());
         $new_obj->setOverallLimit($this->getOverallLimit());
         
         $smap = null;
         if ($this->getScheduleType() == self::TYPE_FIX_SCHEDULE) {
             // schedules
             include_once "Modules/BookingManager/classes/class.ilBookingSchedule.php";
             foreach (ilBookingSchedule::getList($this->getId()) as $item) {
                 $schedule = new ilBookingSchedule($item["booking_schedule_id"]);
                 $smap[$item["booking_schedule_id"]] = $schedule->doClone($new_obj->getId());
             }
         }
         
         // objects
         include_once "Modules/BookingManager/classes/class.ilBookingObject.php";
         foreach (ilBookingObject::getList($this->getId()) as $item) {
             $bobj = new ilBookingObject($item["booking_object_id"]);
             $bobj->doClone($new_obj->getId(), $smap);
         }
         
         $new_obj->update();
         
         return $new_obj;
     }

Here is the call graph for this function:

◆ create()

ilObjBookingPool::create ( )

create object

Returns: integer

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

References ilObject\$db, $ilDB, array, and getDBFields().

     {
         $ilDB = $this->db;
         
         $new_id = parent::create();
         
         $fields = $this->getDBFields();
         $fields["booking_pool_id"] = array("integer", $new_id);
 
         $ilDB->insert("booking_settings", $fields);
 
         return $new_id;
     }

Here is the call graph for this function:

◆ delete()

ilObjBookingPool::delete ( )

delete object and all related data

Returns: boolean true if all object data were removed; false if only a references were removed

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

References ilObject\$db, ilObject\$id, $ilDB, $row, array, and ilObject\getId().

     {
         $ilDB = $this->db;
 
         $id = $this->getId();
 
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         // put here your module specific stuff
         
         $ilDB->manipulate('DELETE FROM booking_settings' .
                 ' WHERE booking_pool_id = ' . $ilDB->quote($id, 'integer'));
 
         $ilDB->manipulate('DELETE FROM booking_schedule' .
                 ' WHERE pool_id = ' . $ilDB->quote($id, 'integer'));
         
         $objects = array();
         $set = $ilDB->query('SELECT booking_object_id FROM booking_object' .
             ' WHERE pool_id = ' . $ilDB->quote($id, 'integer'));
         while ($row = $ilDB->fetchAssoc($set)) {
             $objects[] = $row['booking_object_id'];
         }
 
         if (sizeof($objects)) {
             $ilDB->manipulate('DELETE FROM booking_reservation' .
                     ' WHERE ' . $ilDB->in('object_id', $objects, '', 'integer'));
         }
 
         $ilDB->manipulate('DELETE FROM booking_object' .
             ' WHERE pool_id = ' . $ilDB->quote($id, 'integer'));
 
         return true;
     }

Here is the call graph for this function:

◆ getAdvancedMDFields()

static ilObjBookingPool::getAdvancedMDFields ( $a_ref_id )

static

Definition at line 319 of file class.ilObjBookingPool.php.

References $def, ilAdvancedMDRecord\_getSelectedRecordsByObject(), array, and ilAdvancedMDFieldDefinition\getInstancesByRecordId().

Referenced by ilBookingObjectsTableGUI\__construct(), and ilBookingReservationsTableGUI\__construct().

     {
         $fields = array();
         
         include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDRecord.php');
         $recs = ilAdvancedMDRecord::_getSelectedRecordsByObject("book", $a_ref_id, "bobj");
 
         foreach ($recs as $record_obj) {
             include_once('Services/AdvancedMetaData/classes/class.ilAdvancedMDFieldDefinition.php');
             foreach (ilAdvancedMDFieldDefinition::getInstancesByRecordId($record_obj->getRecordId()) as $def) {
                 $fields[$def->getFieldId()] = array(
                     "id" => $def->getFieldId(),
                     "title" => $def->getTitle(),
                     "type" => $def->getType()
                 );
             }
         }
 
         return $fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDBFields()

ilObjBookingPool::getDBFields ( )

protected

Parse properties for sql statements.

Definition at line 43 of file class.ilObjBookingPool.php.

References array, getOverallLimit(), getReservationFilterPeriod(), getScheduleType(), hasPublicLog(), and isOffline().

Referenced by create(), and update().

     {
         $fields = array(
             "schedule_type" => array("integer", $this->getScheduleType()),
             "pool_offline" => array("integer", $this->isOffline()),
             "public_log" => array("integer", $this->hasPublicLog()),
             "ovlimit" => array("integer", $this->getOverallLimit()),
             "rsv_filter_period" => array("integer", $this->getReservationFilterPeriod())
         );
         
         return $fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOverallLimit()

ilObjBookingPool::getOverallLimit ( )

Get overall / global booking limit.

Returns: int $a_value

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

References $overall_limit.

Referenced by cloneObject(), and getDBFields().

     {
         return $this->overall_limit;
     }

Here is the caller graph for this function:

◆ getReservationFilterPeriod()

ilObjBookingPool::getReservationFilterPeriod ( )

Get reservation filter period default.

Returns: int

Definition at line 309 of file class.ilObjBookingPool.php.

References $reservation_period.

Referenced by getDBFields().

     {
         return $this->reservation_period;
     }

Here is the caller graph for this function:

◆ getScheduleType()

ilObjBookingPool::getScheduleType ( )

Get schedule type.

Returns: int

Definition at line 244 of file class.ilObjBookingPool.php.

References $schedule_type.

Referenced by cloneObject(), and getDBFields().

     {
         return $this->schedule_type;
     }

Here is the caller graph for this function:

◆ hasPublicLog()

ilObjBookingPool::hasPublicLog ( )

Get public log property.

Returns: bool

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

References $public_log.

Referenced by cloneObject(), and getDBFields().

     {
         return (bool) $this->public_log;
     }

Here is the caller graph for this function:

◆ isOffline()

ilObjBookingPool::isOffline ( )

Get offline property.

Returns: bool

Definition at line 208 of file class.ilObjBookingPool.php.

References $offline.

Referenced by cloneObject(), and getDBFields().

     {
         return (bool) $this->offline;
     }

Here is the caller graph for this function:

◆ read()

ilObjBookingPool::read ( )

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

References ilObject\$db, $ilDB, $row, ilObject\getId(), setOffline(), setOverallLimit(), setPublicLog(), setReservationFilterPeriod(), and setScheduleType().

     {
         $ilDB = $this->db;
         
         parent::read();
 
         // put here object specific stuff
         if ($this->getId()) {
             $set = $ilDB->query('SELECT * FROM booking_settings' .
                 ' WHERE booking_pool_id = ' . $ilDB->quote($this->getId(), 'integer'));
             $row = $ilDB->fetchAssoc($set);
             $this->setOffline($row['pool_offline']);
             $this->setPublicLog($row['public_log']);
             $this->setScheduleType($row['schedule_type']);
             $this->setOverallLimit($row['ovlimit']);
             $this->setReservationFilterPeriod($row['rsv_filter_period']);
         }
     }

Here is the call graph for this function:

◆ setOffline()

ilObjBookingPool::setOffline ( $a_value = true )

Toggle offline property.

Parameters

bool $a_value

Definition at line 199 of file class.ilObjBookingPool.php.

Referenced by read().

     {
         $this->offline = (bool) $a_value;
     }

Here is the caller graph for this function:

◆ setOverallLimit()

ilObjBookingPool::setOverallLimit ( $a_value = null )

Set overall / global booking limit.

Parameters

int $a_value

Definition at line 273 of file class.ilObjBookingPool.php.

Referenced by read().

     {
         if ($a_value !== null) {
             $a_value = (int) $a_value;
         }
         $this->overall_limit = $a_value;
     }

Here is the caller graph for this function:

◆ setPublicLog()

ilObjBookingPool::setPublicLog ( $a_value = true )

Toggle public log property.

Parameters

bool $a_value

Definition at line 217 of file class.ilObjBookingPool.php.

Referenced by read().

     {
         $this->public_log = (bool) $a_value;
     }

Here is the caller graph for this function:

◆ setReservationFilterPeriod()

ilObjBookingPool::setReservationFilterPeriod ( $a_value = null )

Set reservation filter period default.

Parameters

int $a_value

Definition at line 296 of file class.ilObjBookingPool.php.

Referenced by read().

     {
         if ($a_value !== null) {
             $a_value = (int) $a_value;
         }
         $this->reservation_period = $a_value;
     }

Here is the caller graph for this function:

◆ setScheduleType()

ilObjBookingPool::setScheduleType ( $a_value )

Set schedule type.

Parameters

int $a_value

Definition at line 235 of file class.ilObjBookingPool.php.

Referenced by __construct(), and read().

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

Here is the caller graph for this function:

◆ update()

ilObjBookingPool::update ( )

update object data

Returns: boolean

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

References ilObject\$db, $ilDB, array, getDBFields(), ilObject\getId(), and League\Flysystem\Adapter\Polyfill\update().

     {
         $ilDB = $this->db;
         
         if (!parent::update()) {
             return false;
         }
 
         // put here object specific stuff
         if ($this->getId()) {
             $ilDB->update(
                 "booking_settings",
                 $this->getDBFields(),
                 array("booking_pool_id" => array("integer", $this->getId()))
             );
         }
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $offline

ilObjBookingPool::$offline = true

protected

Definition at line 16 of file class.ilObjBookingPool.php.

Referenced by isOffline().

◆ $overall_limit

ilObjBookingPool::$overall_limit

protected

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

Referenced by getOverallLimit().

◆ $public_log

ilObjBookingPool::$public_log

protected

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

Referenced by hasPublicLog().

◆ $reservation_period

ilObjBookingPool::$reservation_period

protected

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

Referenced by getReservationFilterPeriod().

◆ $schedule_type

ilObjBookingPool::$schedule_type

protected

Definition at line 18 of file class.ilObjBookingPool.php.

Referenced by getScheduleType().

◆ TYPE_FIX_SCHEDULE

const ilObjBookingPool::TYPE_FIX_SCHEDULE = 1

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

Referenced by ilObjBookingPoolGUI\bookObject(), ilObjBookingPoolGUI\initEditCustomForm(), and ilObjBookingPoolGUI\setHelpId().

◆ TYPE_NO_SCHEDULE

const ilObjBookingPool::TYPE_NO_SCHEDULE = 2

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

Referenced by ilBookingObjectGUI\__construct(), ilObjBookingPoolGUI\applyLogFilterObject(), ilObjBookingPoolGUI\confirmedBookingObject(), ilObjBookingPoolGUI\initEditCustomForm(), ilObjBookingPoolGUI\logDetailsObject(), ilObjBookingPoolGUI\logObject(), ilObjBookingPoolGUI\resetLogFilterObject(), ilObjBookingPoolGUI\rsvCancelObject(), ilObjBookingPoolGUI\rsvConfirmCancelObject(), ilObjBookingPoolGUI\setTabs(), and ilObjBookingPoolGUI\showNoScheduleMessage().

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

Modules/BookingManager/classes/class.ilObjBookingPool.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookupOnline()

◆ cloneObject()

◆ create()

◆ delete()

◆ getAdvancedMDFields()

◆ getDBFields()

◆ getOverallLimit()

◆ getReservationFilterPeriod()

◆ getScheduleType()

◆ hasPublicLog()

◆ isOffline()

◆ read()

◆ setOffline()

◆ setOverallLimit()

◆ setPublicLog()

◆ setReservationFilterPeriod()

◆ setScheduleType()

◆ update()

Field Documentation

◆ $offline

◆ $overall_limit

◆ $public_log

◆ $reservation_period

◆ $schedule_type

◆ TYPE_FIX_SCHEDULE

◆ TYPE_NO_SCHEDULE