ilObjBookingPool Class Reference

Class ilObjBookingPool. More...

Inheritance diagram for ilObjBookingPool:

Collaboration diagram for ilObjBookingPool:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor.
	create ()
	create object
	update ()
	update object data
	read ()
	delete ()
	delete object and all related data
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ...
	initDefaultRoles ()
	init default roles settings
	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.
	setOffline ($a_value=true)
	Toggle offline property.
	isOffline ()
	Get offline property.
	setPublicLog ($a_value=true)
	Toggle public log property.
	hasPublicLog ()
	Get public log property.
	setScheduleType ($a_value)
	Set schedule type.
	getScheduleType ()
	Get schedule type.
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	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.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.
	_lookupCreationDate ($a_id)
	Lookup creation date.

Static Public Member Functions
static	_lookupOnline ($a_obj_id)
	Check object status.
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
static	_lookupObjectId ($a_ref_id)
	lookup object id
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.
static	getLongDescriptions (array $a_obj_ids)
	Get long description data.
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns.

Data Fields
const	TYPE_FIX_SCHEDULE = 1
const	TYPE_NO_SCHEDULE = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 128
	max length of object title
	$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

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

Protected Attributes
	$offline
	$public_log
	$schedule_type

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

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

static ilObjBookingPool::_lookupOnline (   $a_obj_id )

static

Check object status.

Parameters

int

$a_obj_id

Returns

boolean

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

References $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:

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

Clone object permissions, put in tree ...

public

Parameters

int	target id
int	copy id for class.ilCopyWizardOptions()

Returns

object new object

Reimplemented from ilObject.

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

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

        {
                $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
                
                $new_obj->setOffline($this->isOffline());
                $new_obj->setScheduleType($this->getScheduleType());
                $new_obj->setPublicLog($this->hasPublicLog());
                
                $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:

ilObjBookingPool::create

(

)

create object

Returns

integer

Reimplemented from ilObject.

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

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

ilObjBookingPool::delete

(

)

delete object and all related data

Returns

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

Reimplemented from ilObject.

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

References ilObject\$id, $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:

ilObjBookingPool::getDBFields ( )

protected

Parse properties for sql statements.

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjBookingPool::getScheduleType

(

)

Get schedule type.

Returns

int

Definition at line 323 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:

ilObjBookingPool::hasPublicLog

(

)

Get public log property.

Returns

bool

Definition at line 305 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:

ilObjBookingPool::initDefaultRoles

(

)

init default roles settings

If your module does not require any default roles, delete this method (For an example how this method is used, look at ilObjForum)

Returns

array object IDs of created local roles.

Reimplemented from ilObject.

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

        {
                global $rbacadmin;
                
                // create a local role folder
                //$rfoldObj = $this->createRoleFolder("Local roles","Role Folder of forum obj_no.".$this->getId());

                // create moderator role and assign role to rolefolder...
                //$roleObj = $rfoldObj->createRole("Moderator","Moderator of forum obj_no.".$this->getId());
                //$roles[] = $roleObj->getId();

                //unset($rfoldObj);
                //unset($roleObj);

                return $roles ? $roles : array();
        }

ilObjBookingPool::isOffline

(

)

Get offline property.

Returns

bool

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

References $offline.

Referenced by cloneObject(), and getDBFields().

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

Here is the caller graph for this function:

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

Reimplemented from ilObject.

Definition at line 221 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:

ilObjBookingPool::read

(

)

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

References $row, ilObject\getId(), setOffline(), 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']);
                }
        }

Here is the call graph for this function:

ilObjBookingPool::setOffline

(

$a_value = true

)

Toggle offline property.

Parameters

bool

$a_value

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

Referenced by read().

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

Here is the caller graph for this function:

ilObjBookingPool::setPublicLog

(

$a_value = true

)

Toggle public log property.

Parameters

bool

$a_value

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

Referenced by read().

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

Here is the caller graph for this function:

ilObjBookingPool::setScheduleType

(

$a_value

)

Set schedule type.

Parameters

int

$a_value

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

Referenced by __construct(), and read().

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

Here is the caller graph for this function:

ilObjBookingPool::update

(

)

update object data

Returns

boolean

Reimplemented from ilObject.

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

References 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

ilObjBookingPool::$offline

protected

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

Referenced by isOffline().

ilObjBookingPool::$public_log

protected

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

Referenced by hasPublicLog().

ilObjBookingPool::$schedule_type

protected

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

Referenced by getScheduleType().

const ilObjBookingPool::TYPE_FIX_SCHEDULE = 1

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

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

const ilObjBookingPool::TYPE_NO_SCHEDULE = 2

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

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

---

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

• Modules/BookingManager/classes/class.ilObjBookingPool.php