Inheritance diagram for ilObjSession:

Collaboration diagram for ilObjSession:

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

	getPresentationTitle ()
	get title (overwritten from base class) More...

	getEventId ()
	sget event id More...

	setLocation ($a_location)
	set location More...

	getLocation ()
	get location More...

	setName ($a_name)
	set name More...

	getName ()
	get name More...

	setPhone ($a_phone)
	set phone More...

	getPhone ()
	get phone More...

	setEmail ($a_email)
	set email More...

	getEmail ()
	get email More...

	hasTutorSettings ()
	check if there any tutor settings More...

	setDetails ($a_details)
	set details More...

	getDetails ()
	get details More...

	setRegistrationType ($a_type)

	getRegistrationType ()

	isRegistrationUserLimitEnabled ()

	enableRegistrationUserLimit ($a_limit)

	getRegistrationMaxUsers ()

	setRegistrationMaxUsers ($a_users)

	isRegistrationWaitingListEnabled ()

	enableRegistrationWaitingList ($a_stat)

	enabledRegistration ()
	is registration enabled More...

	getAppointments ()
	get appointments More...

	addAppointment ($appointment)
	add appointment More...

	setAppointments ($appointments)
	set appointments More...

	getFirstAppointment ()
	get first appointment More...

	getFiles ()
	get files More...

	validate ()
	validate More...

	cloneObject ($a_target_id, $a_copy_id=0)
	Clone course (no member data) More...

	cloneSettings (ilObjSession $new_obj)
	clone settings More...

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

	create ()
	create new session More...

	update ()
	update object More...

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

	read ()
	read session data More...

	initFiles ()
	init files More...

	prepareCalendarAppointments ($a_mode='create')
	Prepare calendar appointments. 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	_lookupRegistrationEnabled ($a_obj_id)
	lookup registration enabled More...

static	lookupSession ($a_obj_id)
	Get session data. 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	CAL_REG_START = 1

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
	initAppointments ()
	init appointments More...

Protected Attributes
	$db

	$location

	$name

	$phone

	$email

	$details

	$registration

	$event_id

	$reg_type = ilMembershipRegistrationSettings::TYPE_NONE

	$reg_limited = 0

	$reg_limited_users = 0

	$reg_waiting_list = 0

	$appointments

	$files = array()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Definition at line 47 of file class.ilObjSession.php.

References $ilDB.

         {
                 global $ilDB;
 
                 $this->db = $ilDB;
                 $this->type = "sess";
                 parent::__construct($a_id,$a_call_by_reference);
         }

Member Function Documentation

◆ _lookupRegistrationEnabled()

static ilObjSession::_lookupRegistrationEnabled ( $a_obj_id )

static

lookup registration enabled

public

Parameters

Definition at line 64 of file class.ilObjSession.php.

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and ilMembershipRegistrationSettings\TYPE_NONE.

Referenced by ilLPStatusEvent\_getStatusInfo(), and ilLPStatusEvent\determineStatus().

         {
                 global $ilDB;
                 
                 $query = "SELECT reg_type FROM event ".
                         "WHERE obj_id = ".$ilDB->quote($a_obj_id ,'integer')." ";
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                 {
                         return (bool) $row->reg_type != ilMembershipRegistrationSettings::TYPE_NONE;
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ addAppointment()

ilObjSession::addAppointment ( $appointment )

add appointment

public

Parameters

object ilSessionAppointment

Returns

Definition at line 330 of file class.ilObjSession.php.

         {
                 $this->appointments[] = $appointment;
         }

◆ cloneDependencies()

ilObjSession::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone dependencies.

Parameters

int	target id ref_id of new session
int	copy_id

Returns

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

References ilObject\getId().

         {
                 global $ilObjDataCache;
                 
                 parent::cloneDependencies($a_target_id,$a_copy_id);
 
                 $target_obj_id = $ilObjDataCache->lookupObjId($a_target_id);
                 
                 include_once('./Modules/Session/classes/class.ilEventItems.php');
                 $session_materials = new ilEventItems($target_obj_id);
                 $session_materials->cloneItems($this->getId(),$a_copy_id);
 
                 return true;
         }

Here is the call graph for this function:

◆ cloneObject()

ilObjSession::cloneObject	(	$a_target_id,
		$a_copy_id = `0`
	)

Clone course (no member data)

public

Parameters

int	target ref_id
int	copy id

Definition at line 390 of file class.ilObjSession.php.

References $file, $ilDB, $ilUser, cloneSettings(), getFirstAppointment(), ilObject\getId(), and read().

         {
                 global $ilDB,$ilUser,$ilAppEventHandler;
                 
                 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
                 
                 $this->read();
                 
                 // Copy settings
                 $this->cloneSettings($new_obj);
                 
                 // Clone appointment
                 $new_app = $this->getFirstAppointment()->cloneObject($new_obj->getId());
                 $new_obj->setAppointments(array($new_app));
                 $new_obj->update();
 
                 // Clone session files
                 foreach($this->files as $file)
                 {
                         $file->cloneFiles($new_obj->getEventId());
                 }
                 
                 // Raise update forn new appointments
                 
                 
         
                 // Copy learning progress settings
                 include_once('Services/Tracking/classes/class.ilLPObjSettings.php');
                 $obj_settings = new ilLPObjSettings($this->getId());
                 $obj_settings->cloneSettings($new_obj->getId());
                 unset($obj_settings);
                 
                 return $new_obj;
         }

Here is the call graph for this function:

◆ cloneSettings()

ilObjSession::cloneSettings ( ilObjSession $new_obj )

clone settings

public

Parameters

ilObjSession

Returns

Definition at line 432 of file class.ilObjSession.php.

References enableRegistrationUserLimit(), enableRegistrationWaitingList(), getDetails(), getEmail(), getLocation(), getName(), getPhone(), getRegistrationMaxUsers(), getRegistrationType(), isRegistrationUserLimitEnabled(), isRegistrationWaitingListEnabled(), setDetails(), setEmail(), setLocation(), setName(), setPhone(), setRegistrationMaxUsers(), setRegistrationType(), and update().

Referenced by cloneObject().

         {
                 // @var 
                 $new_obj->setLocation($this->getLocation());
                 $new_obj->setName($this->getName());
                 $new_obj->setPhone($this->getPhone());
                 $new_obj->setEmail($this->getEmail());
                 $new_obj->setDetails($this->getDetails());
                 
                 $new_obj->setRegistrationType($this->getRegistrationType());
                 $new_obj->enableRegistrationUserLimit($this->isRegistrationUserLimitEnabled());
                 $new_obj->enableRegistrationWaitingList($this->isRegistrationWaitingListEnabled());
                 $new_obj->setRegistrationMaxUsers($this->getRegistrationMaxUsers());
                 
                 $new_obj->update();
                 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilObjSession::create ( )

create new session

public

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

References $ilDB, $query, $res, enabledRegistration(), getDetails(), getEmail(), ilObject\getId(), getLocation(), getName(), getPhone(), getRegistrationMaxUsers(), getRegistrationType(), isRegistrationUserLimitEnabled(), isRegistrationWaitingListEnabled(), and prepareCalendarAppointments().

         {
                 global $ilDB;
                 global $ilAppEventHandler;
         
                 parent::create();
                 
                 $next_id = $ilDB->nextId('event');
                 $query = "INSERT INTO event (event_id,obj_id,location,tutor_name,tutor_phone,tutor_email,details,registration, ".
                         'reg_type, reg_limit_users, reg_limited,reg_waiting_list) '.
                         "VALUES( ".
                         $ilDB->quote($next_id,'integer').", ".
                         $this->db->quote($this->getId() ,'integer').", ".
                         $this->db->quote($this->getLocation() ,'text').",".
                         $this->db->quote($this->getName() ,'text').", ".
                         $this->db->quote($this->getPhone() ,'text').", ".
                         $this->db->quote($this->getEmail() ,'text').", ".
                         $this->db->quote($this->getDetails() ,'text').",".
                         $this->db->quote($this->enabledRegistration() ,'integer').", ".
                         $this->db->quote($this->getRegistrationType(),'integer').', '.
                         $this->db->quote($this->getRegistrationMaxUsers(),'integer').', '.
                         $this->db->quote($this->isRegistrationUserLimitEnabled(),'integer').', '.
                         $this->db->quote($this->isRegistrationWaitingListEnabled(),'integer').' '.
                         ")";
                 $res = $ilDB->manipulate($query);
                 $this->event_id = $next_id;
                 
                 $ilAppEventHandler->raise('Modules/Session',
                         'create',
                         array('object' => $this,
                                 'obj_id' => $this->getId(),
                                 'appointments' => $this->prepareCalendarAppointments('create')));
 
                 return $this->getId();
         }

Here is the call graph for this function:

◆ delete()

ilObjSession::delete ( )

delete session and all related data

public

Returns: bool

Definition at line 560 of file class.ilObjSession.php.

References $file, $ilDB, $query, $res, ilEventItems\_delete(), ilEventParticipants\_deleteByEvent(), ilSessionAppointment\_deleteBySession(), getFiles(), ilObject\getId(), and prepareCalendarAppointments().

         {
                 global $ilDB;
                 global $ilAppEventHandler;
                 
                 if(!parent::delete())
                 {
                         return false;
                 }
                 $query = "DELETE FROM event ".
                         "WHERE obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
                 $res = $ilDB->manipulate($query);
                 
                 include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                 ilSessionAppointment::_deleteBySession($this->getId());
                 
                 include_once('./Modules/Session/classes/class.ilEventItems.php');
                 ilEventItems::_delete($this->getId());
                 
                 include_once('./Modules/Session/classes/class.ilEventParticipants.php');
                 ilEventParticipants::_deleteByEvent($this->getId());
                 
                 foreach($this->getFiles() as $file)
                 {
                         $file->delete();
                 }
                 
                 $ilAppEventHandler->raise('Modules/Session',
                         'delete',
                         array('object' => $this,
                                 'obj_id' => $this->getId(),
                                 'appointments' => $this->prepareCalendarAppointments('delete')));
                 
                 
                 return true;
         }

Here is the call graph for this function:

◆ enabledRegistration()

ilObjSession::enabledRegistration ( )

is registration enabled

public

Returns

Definition at line 307 of file class.ilObjSession.php.

References ilMembershipRegistrationSettings\TYPE_NONE.

Referenced by create(), and update().

         {
                 return $this->reg_type != ilMembershipRegistrationSettings::TYPE_NONE;
         }

Here is the caller graph for this function:

◆ enableRegistrationUserLimit()

ilObjSession::enableRegistrationUserLimit ( $a_limit )

Definition at line 274 of file class.ilObjSession.php.

Referenced by cloneSettings(), and read().

         {
                 $this->reg_limited = $a_limit;
         }

Here is the caller graph for this function:

◆ enableRegistrationWaitingList()

ilObjSession::enableRegistrationWaitingList ( $a_stat )

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

Referenced by cloneSettings(), and read().

         {
                 $this->reg_waiting_list = $a_stat;
         }

Here is the caller graph for this function:

◆ getAppointments()

ilObjSession::getAppointments ( )

get appointments

public

Returns: array

Definition at line 318 of file class.ilObjSession.php.

         {
                 return $this->appointments ? $this->appointments : array();
         }

◆ getDetails()

ilObjSession::getDetails ( )

get details

public

Returns: string details

Definition at line 254 of file class.ilObjSession.php.

References $details.

Referenced by cloneSettings(), create(), and update().

         {
                 return $this->details;
         }

Here is the caller graph for this function:

◆ getEmail()

ilObjSession::getEmail ( )

get email

public

Returns: string email

Definition at line 219 of file class.ilObjSession.php.

References $email.

Referenced by cloneSettings(), create(), hasTutorSettings(), and update().

         {
                 return $this->email;
         }

Here is the caller graph for this function:

◆ getEventId()

ilObjSession::getEventId ( )

sget event id

public

Returns

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

References $event_id.

Referenced by initFiles().

         {
                 return $this->event_id;
         }

Here is the caller graph for this function:

◆ getFiles()

ilObjSession::getFiles ( )

get files

public

Parameters

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

Referenced by delete().

         {
                 return $this->files ? $this->files : array();
         }

Here is the caller graph for this function:

◆ getFirstAppointment()

ilObjSession::getFirstAppointment ( )

get first appointment

public

Returns: object ilSessionAppointment

Definition at line 353 of file class.ilObjSession.php.

Referenced by cloneObject(), getPresentationTitle(), and prepareCalendarAppointments().

         {
                 return is_object($this->appointments[0]) ? $this->appointments[0] : ($this->appointments[0] = new ilSessionAppointment());
         }

Here is the caller graph for this function:

◆ getLocation()

ilObjSession::getLocation ( )

get location

public

Returns: string location

Definition at line 152 of file class.ilObjSession.php.

References $location.

Referenced by cloneSettings(), create(), and update().

         {
                 return $this->location;
         }

Here is the caller graph for this function:

◆ getName()

ilObjSession::getName ( )

get name

public

Returns: string name

Definition at line 174 of file class.ilObjSession.php.

References $name.

Referenced by cloneSettings(), create(), hasTutorSettings(), and update().

         {
                 return $this->name;
         }

Here is the caller graph for this function:

◆ getPhone()

ilObjSession::getPhone ( )

get phone

public

Returns: string phone

Definition at line 196 of file class.ilObjSession.php.

References $phone.

Referenced by cloneSettings(), create(), hasTutorSettings(), and update().

         {
                 return $this->phone;
         }

Here is the caller graph for this function:

◆ getPresentationTitle()

ilObjSession::getPresentationTitle ( )

get title (overwritten from base class)

public

Returns

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

References ilDatePresentation\formatDate(), getFirstAppointment(), ilObject\getTitle(), and IL_CAL_UNIX.

         {
                 $date = new ilDate($this->getFirstAppointment()->getStart()->getUnixTime(),IL_CAL_UNIX);
                 if($this->getTitle())
                 {
                         return ilDatePresentation::formatDate($this->getFirstAppointment()->getStart()).': '.$this->getTitle();                 
                 }
                 else
                 {
                         return ilDatePresentation::formatDate($date);                   
                 }
 
         }

Here is the call graph for this function:

◆ getRegistrationMaxUsers()

ilObjSession::getRegistrationMaxUsers ( )

Definition at line 279 of file class.ilObjSession.php.

References $reg_limited_users.

Referenced by cloneSettings(), create(), and update().

         {
                 return $this->reg_limited_users;
         }

Here is the caller graph for this function:

◆ getRegistrationType()

ilObjSession::getRegistrationType ( )

Definition at line 264 of file class.ilObjSession.php.

References $reg_type.

Referenced by cloneSettings(), create(), and update().

         {
                 return $this->reg_type;
         }

Here is the caller graph for this function:

◆ hasTutorSettings()

ilObjSession::hasTutorSettings ( )

check if there any tutor settings

public

Definition at line 229 of file class.ilObjSession.php.

References getEmail(), getName(), and getPhone().

         {
                 return strlen($this->getName()) or 
                         strlen($this->getEmail()) or
                         strlen($this->getPhone());
         }

Here is the call graph for this function:

◆ initAppointments()

ilObjSession::initAppointments ( )

protected

init appointments

protected

Parameters

Definition at line 637 of file class.ilObjSession.php.

References ilSessionAppointment\_readAppointmentsBySession(), and ilObject\getId().

Referenced by read().

         {
                 // get assigned appointments
                 include_once('./Modules/Session/classes/class.ilSessionAppointment.php');
                 $this->appointments = ilSessionAppointment::_readAppointmentsBySession($this->getId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFiles()

ilObjSession::initFiles ( )

init files

protected

Parameters

Definition at line 651 of file class.ilObjSession.php.

References ilSessionFile\_readFilesByEvent(), and getEventId().

Referenced by read().

         {
                 include_once('./Modules/Session/classes/class.ilSessionFile.php');
                 $this->files = ilSessionFile::_readFilesByEvent($this->getEventId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRegistrationUserLimitEnabled()

ilObjSession::isRegistrationUserLimitEnabled ( )

Definition at line 269 of file class.ilObjSession.php.

References $reg_limited.

Referenced by cloneSettings(), create(), and update().

         {
                 return $this->reg_limited;
         }

Here is the caller graph for this function:

◆ isRegistrationWaitingListEnabled()

ilObjSession::isRegistrationWaitingListEnabled ( )

Definition at line 289 of file class.ilObjSession.php.

References $reg_waiting_list.

Referenced by cloneSettings(), create(), and update().

         {
                 return $this->reg_waiting_list;
         }

Here is the caller graph for this function:

◆ lookupSession()

static ilObjSession::lookupSession ( $a_obj_id )

static

Get session data.

Parameters

object $a_obj_id

Returns

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

References $data, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilObjSessionListGUI\getProperties().

         {
                 global $ilDB;
                 
                 $query = "SELECT * FROM event ".
                         "WHERE obj_id = ".$ilDB->quote($a_obj_id);
                 $res = $ilDB->query($query);
                 while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                 {
                         $data['location']       = $row->location ? $row->location : '';
                         $data['details']        = $row->details ? $row->details : '';
                         $data['name']           = $row->tutor_name ? $row->tutor_name : '';
                         $data['email']          = $row->tutor_email ? $row->tutor_email : '';
                         $data['phone']          = $row->tutor_phone ? $row->tutor_phone : '';
                 }
                 return (array) $data;
         }

Here is the caller graph for this function:

◆ prepareCalendarAppointments()

ilObjSession::prepareCalendarAppointments ( $a_mode = 'create' )

Prepare calendar appointments.

public

Parameters

string mode UPDATE|CREATE|DELETE

Returns

Definition at line 665 of file class.ilObjSession.php.

References getFirstAppointment(), ilObject\getLongDescription(), ilObject\getTitle(), and IL_CAL_TRANSLATION_NONE.

Referenced by create(), delete(), and update().

         {
                 include_once('./Services/Calendar/classes/class.ilCalendarAppointmentTemplate.php');
                 
                 switch($a_mode)
                 {
                         case 'create':
                         case 'update':
 
                                 $app = new ilCalendarAppointmentTemplate(self::CAL_REG_START);
                                 $app->setTranslationType(IL_CAL_TRANSLATION_NONE);
                                 $app->setTitle($this->getTitle() ? $this->getTitle() : $this->lng->txt('obj_sess'));
                                 $app->setDescription($this->getLongDescription());
                                 
                                 $sess_app = $this->getFirstAppointment();
                                 $app->setFullday($sess_app->isFullday());
                                 $app->setStart($sess_app->getStart());
                                 $app->setEnd($sess_app->getEnd());
                                 $apps[] = $app;
 
                                 return $apps;
                                 
                         case 'delete':
                                 // Nothing to do: The category and all assigned appointments will be deleted.
                                 return array();
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObjSession::read ( )

read session data

public

Parameters

Definition at line 604 of file class.ilObjSession.php.

References $query, $res, $row, DB_FETCHMODE_OBJECT, enableRegistrationUserLimit(), enableRegistrationWaitingList(), ilObject\getId(), initAppointments(), initFiles(), setDetails(), setEmail(), setLocation(), setName(), setPhone(), setRegistrationMaxUsers(), and setRegistrationType().

Referenced by cloneObject().

         {
                 parent::read();
                 
                 $query = "SELECT * FROM event WHERE ".
                         "obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
                 $res = $this->db->query($query);
                 
                 while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                 {
                         $this->setLocation($row->location);
                         $this->setName($row->tutor_name);
                         $this->setPhone($row->tutor_phone);
                         $this->setEmail($row->tutor_email);
                         $this->setDetails($row->details);
                         $this->setRegistrationType($row->reg_type);
                         $this->enableRegistrationUserLimit($row->reg_limited);
                         $this->enableRegistrationWaitingList($row->reg_waiting_list);
                         $this->setRegistrationMaxUsers($row->reg_limit_users);
                         $this->event_id = $row->event_id;
                 }
 
                 $this->initAppointments();
                 $this->initFiles();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAppointments()

ilObjSession::setAppointments ( $appointments )

set appointments

public

Parameters

array ilSessionAppointments

Returns

Definition at line 342 of file class.ilObjSession.php.

References $appointments.

         {
                 $this->appointments = $appointments;
         }

◆ setDetails()

ilObjSession::setDetails ( $a_details )

set details

public

Parameters

string details

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

Referenced by cloneSettings(), and read().

         {
                 $this->details = $a_details;
         }

Here is the caller graph for this function:

◆ setEmail()

ilObjSession::setEmail ( $a_email )

set email

public

Parameters

string email

Returns

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

Referenced by cloneSettings(), and read().

         {
                 $this->email = $a_email;
         }

Here is the caller graph for this function:

◆ setLocation()

ilObjSession::setLocation ( $a_location )

set location

public

Parameters

string location

Definition at line 141 of file class.ilObjSession.php.

Referenced by cloneSettings(), and read().

         {
                 $this->location = $a_location;
         }

Here is the caller graph for this function:

◆ setName()

ilObjSession::setName ( $a_name )

set name

public

Parameters

string name

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

Referenced by cloneSettings(), and read().

         {
                 $this->name = $a_name;
         }

Here is the caller graph for this function:

◆ setPhone()

ilObjSession::setPhone ( $a_phone )

set phone

public

Parameters

string phone

Definition at line 185 of file class.ilObjSession.php.

Referenced by cloneSettings(), and read().

         {
                 $this->phone = $a_phone;
         }

Here is the caller graph for this function:

◆ setRegistrationMaxUsers()

ilObjSession::setRegistrationMaxUsers ( $a_users )

Definition at line 284 of file class.ilObjSession.php.

Referenced by cloneSettings(), and read().

         {
                 $this->reg_limited_users = $a_users;
         }

Here is the caller graph for this function:

◆ setRegistrationType()

ilObjSession::setRegistrationType ( $a_type )

Definition at line 259 of file class.ilObjSession.php.

Referenced by cloneSettings(), and read().

         {
                 $this->reg_type = $a_type;
         }

Here is the caller graph for this function:

◆ update()

ilObjSession::update ( )

update object

public

Parameters

Definition at line 523 of file class.ilObjSession.php.

References $ilDB, $query, $res, enabledRegistration(), getDetails(), getEmail(), ilObject\getId(), getLocation(), getName(), getPhone(), getRegistrationMaxUsers(), getRegistrationType(), isRegistrationUserLimitEnabled(), isRegistrationWaitingListEnabled(), and prepareCalendarAppointments().

Referenced by cloneSettings().

         {
                 global $ilDB;
                 global $ilAppEventHandler;
 
                 if(!parent::update())
                 {
                         return false;
                 }
                 $query = "UPDATE event SET ".
                         "location = ".$this->db->quote($this->getLocation() ,'text').",".
                         "tutor_name = ".$this->db->quote($this->getName() ,'text').", ".
                         "tutor_phone = ".$this->db->quote($this->getPhone() ,'text').", ".
                         "tutor_email = ".$this->db->quote($this->getEmail() ,'text').", ".
                         "details = ".$this->db->quote($this->getDetails() ,'text').", ".
                         "registration = ".$this->db->quote($this->enabledRegistration() ,'integer').", ".
                         "reg_type = ".$this->db->quote($this->getRegistrationType() ,'integer').", ".
                         "reg_limited = ".$this->db->quote($this->isRegistrationUserLimitEnabled() ,'integer').", ".
                         "reg_limit_users = ".$this->db->quote($this->getRegistrationMaxUsers() ,'integer').", ".
                         "reg_waiting_list = ".$this->db->quote($this->isRegistrationWaitingListEnabled(),'integer')." ".
                         "WHERE obj_id = ".$this->db->quote($this->getId() ,'integer')." ";
                 $res = $ilDB->manipulate($query);
                 
                 $ilAppEventHandler->raise('Modules/Session',
                         'update',
                         array('object' => $this,
                                 'obj_id' => $this->getId(),
                                 'appointments' => $this->prepareCalendarAppointments('update')));
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validate()

ilObjSession::validate ( )

validate

public

Parameters

Definition at line 377 of file class.ilObjSession.php.

         {
                 return true;
         }

Field Documentation

◆ $appointments

ilObjSession::$appointments

protected

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

Referenced by setAppointments().

◆ $db

ilObjSession::$db

protected

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

◆ $details

ilObjSession::$details

protected

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

Referenced by getDetails().

◆ $email

ilObjSession::$email

protected

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

Referenced by getEmail().

◆ $event_id

ilObjSession::$event_id

protected

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

Referenced by getEventId().

◆ $files

ilObjSession::$files = array()

protected

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

◆ $location

ilObjSession::$location

protected

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

Referenced by getLocation().

◆ $name

ilObjSession::$name

protected

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

Referenced by getName().

◆ $phone

ilObjSession::$phone

protected

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

Referenced by getPhone().

◆ $reg_limited

ilObjSession::$reg_limited = 0

protected

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

Referenced by isRegistrationUserLimitEnabled().

◆ $reg_limited_users

ilObjSession::$reg_limited_users = 0

protected

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

Referenced by getRegistrationMaxUsers().

◆ $reg_type

ilObjSession::$reg_type = ilMembershipRegistrationSettings::TYPE_NONE

protected

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

Referenced by getRegistrationType().

◆ $reg_waiting_list

ilObjSession::$reg_waiting_list = 0

protected

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

Referenced by isRegistrationWaitingListEnabled().

◆ $registration

ilObjSession::$registration

protected

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

◆ CAL_REG_START

const ilObjSession::CAL_REG_START = 1

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

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

Modules/Session/classes/class.ilObjSession.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _lookupRegistrationEnabled()

◆ addAppointment()

◆ cloneDependencies()

◆ cloneObject()

◆ cloneSettings()

◆ create()

◆ delete()

◆ enabledRegistration()

◆ enableRegistrationUserLimit()

◆ enableRegistrationWaitingList()

◆ getAppointments()

◆ getDetails()

◆ getEmail()

◆ getEventId()

◆ getFiles()

◆ getFirstAppointment()

◆ getLocation()

◆ getName()

◆ getPhone()

◆ getPresentationTitle()

◆ getRegistrationMaxUsers()

◆ getRegistrationType()

◆ hasTutorSettings()

◆ initAppointments()

◆ initFiles()

◆ isRegistrationUserLimitEnabled()

◆ isRegistrationWaitingListEnabled()

◆ lookupSession()

◆ prepareCalendarAppointments()

◆ read()

◆ setAppointments()

◆ setDetails()

◆ setEmail()

◆ setLocation()

◆ setName()

◆ setPhone()

◆ setRegistrationMaxUsers()

◆ setRegistrationType()

◆ update()

◆ validate()

Field Documentation

◆ $appointments

◆ $db

◆ $details

◆ $email

◆ $event_id

◆ $files

◆ $location

◆ $name

◆ $phone

◆ $reg_limited

◆ $reg_limited_users

◆ $reg_type

◆ $reg_waiting_list

◆ $registration

◆ CAL_REG_START