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)

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event happend, each object may decide how it reacts. More...

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

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

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

	read ($a_force_db=false)
	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 ()

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

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

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) 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...

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

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

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

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

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

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

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

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

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

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

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

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

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type 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...

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! 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...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

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

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

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

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

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

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

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

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

static	_lookupObjId ($a_id)

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

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

static	_lookupObjectId ($a_ref_id)
	lookup object id 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	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

	$ilias

	$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

	$obj_data_record
	object_data record More...

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

Protected Attributes
	$offline = true

	$public_log

	$schedule_type

	$overall_limit

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

References ilObject\ilObject(), and setScheduleType().

         {
                 $this->type = "book";
                 $this->setScheduleType(self::TYPE_FIX_SCHEDULE);
                 $this->ilObject($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 322 of file class.ilObjBookingPool.php.

References $ilDB, and $row.

Referenced by ilObjBookingPoolListGUI\getProperties().

         {
                 global $ilDB;
                 
                 $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 155 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 55 of file class.ilObjBookingPool.php.

References $ilDB, and getDBFields().

         {
                 global $ilDB;
                 
                 $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 115 of file class.ilObjBookingPool.php.

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

         {
                 global $ilDB;
 
                 $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:

◆ getDBFields()

ilObjBookingPool::getDBFields ( )

protected

Parse properties for sql statements.

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

References getOverallLimit(), 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())         
                 );
                 
                 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 352 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:

◆ getScheduleType()

ilObjBookingPool::getScheduleType ( )

Get schedule type.

Returns: int

Definition at line 311 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 293 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 275 of file class.ilObjBookingPool.php.

References $offline.

Referenced by cloneObject(), and getDBFields().

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

Here is the caller graph for this function:

◆ notify()

ilObjBookingPool::notify	(	$a_event,
		$a_ref_id,
		$a_parent_non_rbac_id,
		$a_node_id,
		$a_params = `0`
	)

notifys an object about an event occured Based on the event happend, each object may decide how it reacts.

If you are not required to handle any events related to your module, just delete this method. (For an example how this method is used, look at ilObjGroup)

Parameters

string	event
integer	reference id of object where the event occured
array	passes optional parameters if required

Returns: boolean

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

References $_GET, and ilObject\getType().

         {
                 global $tree;
                 
                 switch ($a_event)
                 {
                         case "link":
                                 
                                 //var_dump("<pre>",$a_params,"</pre>");
                                 //echo "Module name ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                         
                         case "cut":
                                 
                                 //echo "Module name ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                                 
                         case "copy":
                         
                                 //var_dump("<pre>",$a_params,"</pre>");
                                 //echo "Module name ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
 
                         case "paste":
                                 
                                 //echo "Module name ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                         
                         case "new":
                                 
                                 //echo "Module name ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
                                 //exit;
                                 break;
                 }
 
                 // At the beginning of the recursive process it avoids second call of the notify function with the same parameter
                 if ($a_node_id==$_GET["ref_id"])
                 {
                         $parent_obj =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                         $parent_type = $parent_obj->getType();
                         if($parent_type == $this->getType())
                         {
                                 $a_node_id = (int) $tree->getParentId($a_node_id);
                         }
                 }
                 
                 parent::notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$a_node_id,$a_params);
         }

Here is the call graph for this function:

◆ read()

ilObjBookingPool::read ( )

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

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

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

Here is the call graph for this function:

◆ setOffline()

ilObjBookingPool::setOffline ( $a_value = true )

Toggle offline property.

Parameters

bool $a_value

Definition at line 266 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 338 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 284 of file class.ilObjBookingPool.php.

Referenced by read().

     {
                 $this->public_log = (bool)$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 302 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 73 of file class.ilObjBookingPool.php.

References $ilDB, getDBFields(), and ilObject\getId().

         {
                 global $ilDB;
                 
                 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().

◆ $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 21 of file class.ilObjBookingPool.php.

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

◆ TYPE_NO_SCHEDULE

const ilObjBookingPool::TYPE_NO_SCHEDULE = 2

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

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

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()

◆ getDBFields()

◆ getOverallLimit()

◆ getScheduleType()

◆ hasPublicLog()

◆ isOffline()

◆ notify()

◆ read()

◆ setOffline()

◆ setOverallLimit()

◆ setPublicLog()

◆ setScheduleType()

◆ update()

Field Documentation

◆ $offline

◆ $overall_limit

◆ $public_log

◆ $schedule_type

◆ TYPE_FIX_SCHEDULE

◆ TYPE_NO_SCHEDULE