ilObjSession Class Reference

Inheritance diagram for ilObjSession:

Collaboration diagram for ilObjSession:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor public.
	getPresentationTitle ()
	get title (overwritten from base class)
	getEventId ()
	sget event id
	setLocation ($a_location)
	set location
	getLocation ()
	get location
	setName ($a_name)
	set name
	getName ()
	get name
	setPhone ($a_phone)
	set phone
	getPhone ()
	get phone
	setEmail ($a_email)
	set email
	getEmail ()
	get email
	hasTutorSettings ()
	check if there any tutor settings
	setDetails ($a_details)
	set details
	getDetails ()
	get details
	enableRegistration ($a_registration)
	enable registration
	enabledRegistration ()
	is registration enabled
	getAppointments ()
	get appointments
	addAppointment ($appointment)
	add appointment
	setAppointments ($appointments)
	set appointments
	getFirstAppointment ()
	get first appointment
	getFiles ()
	get files
	validate ()
	validate
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone course (no member data)
	cloneSettings ($new_obj)
	clone settings
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone dependencies.
	create ()
	create new session
	update ()
	update object
	delete ()
	delete session and all related data
	read ()
	read session data
	initFiles ()
	init files
	prepareCalendarAppointments ($a_mode= 'create')
	Prepare calendar appointments.
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
	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
	_lookupObjIdByImportId ($a_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
	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)
	_getAllReferences ($a_id)
	get all reference ids of object
	_lookupTitle ($a_id)
	lookup object title
	_lookupDescription ($a_id)
	lookup object description
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_lookupObjId ($a_id)
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($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)
	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_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
	_lookupObjectId ($a_ref_id)
	lookup object id
	_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
	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
	createRoleFolder ()
	creates a local role folder
	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.
	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.
	cloneMetaData ($target_obj)
	Copy meta data.

Static Public Member Functions
static	_lookupRegistrationEnabled ($a_obj_id)
	lookup registration enabled
Static Public Member Functions inherited from ilObject
static	_getIdsForTitle ($title, $type= '')
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

Data Fields
const	CAL_REG_START = 1
Data Fields inherited from ilObject
	$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
	initAppointments ()
	init appointments

Protected Attributes
	$db
	$location
	$name
	$phone
	$email
	$details
	$registration
	$event_id
	$appointments
	$files = array()

Detailed Description

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

Constructor & Destructor Documentation

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 59 of file class.ilObjSession.php.

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

Member Function Documentation

static ilObjSession::_lookupRegistrationEnabled (   $a_obj_id )

static

lookup registration enabled

public

Parameters

@return

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

References $res, and DB_FETCHMODE_OBJECT.

Referenced by ilLPStatusEvent\_getStatusInfo().

        {
                global $ilDB;
                
                $query = "SELECT registration FROM event ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id)." ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return (bool) $row->registration;
                }
                return false;
        }

Here is the caller graph for this function:

ilObjSession::addAppointment

(

$appointment

)

add appointment

public

Parameters

object

ilSessionAppointment

Returns

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

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

ilObjSession::cloneDependencies	(		$a_target_id,
			$a_copy_id
	)

Clone dependencies.

Parameters

int	target id ref_id of new session
int	copy_id

Returns

Reimplemented from ilObject.

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

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

Clone course (no member data)

public

Parameters

int	target ref_id
int	copy id

Reimplemented from ilObject.

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

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

ilObjSession::cloneSettings

(

$new_obj

)

clone settings

public

Parameters

@return

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

References enabledRegistration(), getDetails(), getEmail(), getLocation(), getName(), and getPhone().

Referenced by cloneObject().

        {
                $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->enableRegistration($this->enabledRegistration());
                $new_obj->update();
                
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjSession::create

(

)

create new session

public

Reimplemented from ilObject.

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

References enabledRegistration(), getDetails(), getEmail(), ilObject\getId(), getLocation(), getName(), getPhone(), and prepareCalendarAppointments().

        {
                global $ilAppEventHandler;
        
                parent::create();
                
                $query = "INSERT INTO event SET ".
                        "obj_id = ".$this->db->quote($this->getId()).", ".
                        "location = ".$this->db->quote($this->getLocation()).",".
                        "tutor_name = ".$this->db->quote($this->getName()).", ".
                        "tutor_phone = ".$this->db->quote($this->getPhone()).", ".
                        "tutor_email = ".$this->db->quote($this->getEmail()).", ".
                        "details = ".$this->db->quote($this->getDetails()).",".
                        "registration = ".$this->db->quote($this->enabledRegistration())." ";

                $this->db->query($query);
                $this->event_id = $this->db->getLastInsertId();
                
                $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:

ilObjSession::delete

(

)

delete session and all related data

public

Returns

bool

Reimplemented from ilObject.

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

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

        {
                global $ilAppEventHandler;
                
                if(!parent::delete())
                {
                        return false;
                }
                $query = "DELETE FROM event ".
                        "WHERE obj_id = ".$this->db->quote($this->getId())." ";
                $this->db->query($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:

ilObjSession::enabledRegistration

(

)

is registration enabled

public

Returns

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

References $registration.

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

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

Here is the caller graph for this function:

ilObjSession::enableRegistration

(

$a_registration

)

enable registration

public

Parameters

@return

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

Referenced by read().

        {
                $this->registration = (bool) $a_registration;
        }

Here is the caller graph for this function:

ilObjSession::getAppointments

(

)

get appointments

public

Returns

array

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

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

ilObjSession::getDetails

(

)

get details

public

Returns

string details

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

References $details.

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

        {
                return $this->details;
        }

Here is the caller graph for this function:

ilObjSession::getEmail

(

)

get email

public

Returns

string email

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

ilObjSession::getEventId

(

)

sget event id

public

Returns

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

References $event_id.

Referenced by initFiles().

        {
                return $this->event_id;
        }

Here is the caller graph for this function:

ilObjSession::getFiles

(

)

get files

public

Parameters

@return

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

Referenced by delete().

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

Here is the caller graph for this function:

ilObjSession::getFirstAppointment

(

)

get first appointment

public

Returns

object ilSessionAppointment

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

ilObjSession::getLocation

(

)

get location

public

Returns

string location

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

References $location.

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

        {
                return $this->location;
        }

Here is the caller graph for this function:

ilObjSession::getName

(

)

get name

public

Returns

string name

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

ilObjSession::getPhone

(

)

get phone

public

Returns

string phone

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

ilObjSession::getPresentationTitle

(

)

get title (overwritten from base class)

public

Returns

Reimplemented from ilObject.

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

ilObjSession::hasTutorSettings

(

)

check if there any tutor settings

public

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

ilObjSession::initAppointments ( )

protected

init appointments

protected

Parameters

@return

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

ilObjSession::initFiles

(

)

init files

protected

Parameters

@return

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

ilObjSession::prepareCalendarAppointments

(

$a_mode = 'create'

)

Prepare calendar appointments.

public

Parameters

string

mode UPDATE|CREATE|DELETE

Returns

Definition at line 611 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());
                                $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:

ilObjSession::read

(

)

read session data

public

Parameters

@return

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

References $res, DB_FETCHMODE_OBJECT, enableRegistration(), ilObject\getId(), initAppointments(), initFiles(), setDetails(), setEmail(), setLocation(), setName(), and setPhone().

Referenced by cloneObject().

        {
                parent::read();
                
                $query = "SELECT * FROM event WHERE ".
                        "obj_id = ".$this->db->quote($this->getId())." ";
                $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->enableRegistration((bool) $row->registration);
                        $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:

ilObjSession::setAppointments

(

$appointments

)

set appointments

public

Parameters

array

ilSessionAppointments

Returns

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

References $appointments.

        {
                $this->appointments = $appointments;
        }

ilObjSession::setDetails

(

$a_details

)

set details

public

Parameters

string

details

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

Referenced by read().

        {
                $this->details = $a_details;
        }

Here is the caller graph for this function:

ilObjSession::setEmail

(

$a_email

)

set email

public

Parameters

string

email

Returns

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

Referenced by read().

        {
                $this->email = $a_email;
        }

Here is the caller graph for this function:

ilObjSession::setLocation

(

$a_location

)

set location

public

Parameters

string

location

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

Referenced by read().

        {
                $this->location = $a_location;
        }

Here is the caller graph for this function:

ilObjSession::setName

(

$a_name

)

set name

public

Parameters

string

name

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

Referenced by read().

        {
                $this->name = $a_name;
        }

Here is the caller graph for this function:

ilObjSession::setPhone

(

$a_phone

)

set phone

public

Parameters

string

phone

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

Referenced by read().

        {
                $this->phone = $a_phone;
        }

Here is the caller graph for this function:

ilObjSession::update

(

)

update object

public

Parameters

@return

bool success

Reimplemented from ilObject.

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

References enabledRegistration(), getDetails(), getEmail(), ilObject\getId(), getLocation(), getName(), getPhone(), and prepareCalendarAppointments().

        {
                global $ilAppEventHandler;

                if(!parent::update())
                {
                        return false;
                }
                $query = "UPDATE event SET ".
                        "location = ".$this->db->quote($this->getLocation()).",".
                        "tutor_name = ".$this->db->quote($this->getName()).", ".
                        "tutor_phone = ".$this->db->quote($this->getPhone()).", ".
                        "tutor_email = ".$this->db->quote($this->getEmail()).", ".
                        "details = ".$this->db->quote($this->getDetails()).", ".
                        "registration = ".$this->db->quote($this->enabledRegistration())." ".
                        "WHERE obj_id = ".$this->db->quote($this->getId())." ";

                $this->db->query($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:

ilObjSession::validate

(

)

validate

public

Parameters

@return

bool

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

References $ilErr, and ilObject\getTitle().

        {
                global $ilErr;
                
                if(!strlen($this->getTitle()))
                {
                        $ilErr->appendMessage($this->lng->txt('fill_out_all_required_fields'));
                        return false;
                }
                return true;
        }

Here is the call graph for this function:

Field Documentation

ilObjSession::$appointments

protected

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

Referenced by setAppointments().

ilObjSession::$db

protected

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

ilObjSession::$details

protected

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

Referenced by getDetails().

ilObjSession::$email

protected

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

Referenced by getEmail().

ilObjSession::$event_id

protected

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

Referenced by getEventId().

ilObjSession::$files = array()

protected

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

ilObjSession::$location

protected

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

Referenced by getLocation().

ilObjSession::$name

protected

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

Referenced by getName().

ilObjSession::$phone

protected

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

Referenced by getPhone().

ilObjSession::$registration

protected

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

Referenced by enabledRegistration().

const ilObjSession::CAL_REG_START = 1

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

---

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

• Modules/Session/classes/class.ilObjSession.php