Inheritance diagram for ilSessionAppointment:

Collaboration diagram for ilSessionAppointment:

Public Member Functions
	__construct ($a_appointment_id=null)
	Consructor. More...

	isFullday ()
	is fullday More...

	getStart ()
	get start More...

	setStart ($a_start)
	set start More...

	getEnd ()
	get end More...

	setEnd ($a_end)
	set end More...

	setAppointmentId ($a_appointment_id)

	getAppointmentId ()

	setSessionId ($a_session_id)

	getSessionId ()

	setStartingTime ($a_starting_time)

	getStartingTime ()

	setEndingTime ($a_ending_time)

	getEndingTime ()

	toggleFullTime ($a_status)

	enabledFullTime ()

	formatTime ()

	_timeToString ($start, $end)

	appointmentToString ()

	cloneObject ($new_id)
	clone appointment More...

	create ()

	update ()

	delete ()

	validate ()

	__read ()

	isFullday ()
	is fullday More...

Static Public Member Functions
static	_lookupAppointment ($a_obj_id)
	lookup appointment More...

static	lookupNextSessionByCourse ($a_ref_id)
	@access public More...

static	lookupLastSessionByCourse ($a_ref_id)
	@access public More...

static	_appointmentToString ($start, $end, $fulltime)

static	_delete ($a_appointment_id)

static	_deleteBySession ($a_event_id)

static	_readAppointmentsBySession ($a_event_id)

	getStart ()
	Interface method get start. More...

	getEnd ()
	Interface method get end. More...

Data Fields
	$ilErr

	$ilDB

	$tree

	$lng

	$starting_time = null

	$ending_time = null

Protected Attributes
	$start = null

	$end = null

Detailed Description

class ilSessionAppointment

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilSessionAppointment::__construct ( $a_appointment_id = null )

Consructor.

Parameters

int $a_appointment_id

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

    {
        global $DIC;
 
        $ilErr = $DIC['ilErr'];
        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];
        $tree = $DIC['tree'];
 
        $this->ilErr = $ilErr;
        $this->db = $ilDB;
        $this->lng = $lng;
 
        $this->appointment_id = $a_appointment_id;
        $this->__read();
    }

References $DIC, $ilDB, $ilErr, $lng, $tree, and __read().

Here is the call graph for this function:

Member Function Documentation

◆ __read()

ilSessionAppointment::__read ( )

Definition at line 441 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if (!$this->getAppointmentId()) {
            return null;
        }
 
        $query = "SELECT * FROM event_appointment " .
            "WHERE appointment_id = " . $ilDB->quote($this->getAppointmentId(), 'integer') . " ";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setSessionId($row->event_id);
            $this->toggleFullTime($row->fulltime);
            
            if ($this->isFullday()) {
                $this->start = new ilDate($row->e_start, IL_CAL_DATETIME);
                $this->end = new ilDate($row->e_end, IL_CAL_DATETIME);
            } else {
                $this->start = new ilDateTime($row->e_start, IL_CAL_DATETIME, 'UTC');
                $this->end = new ilDateTime($row->e_end, IL_CAL_DATETIME, 'UTC');
            }
            $this->starting_time = $this->start->getUnixTime();
            $this->ending_time = $this->end->getUnixTime();
        }
        return true;
    }

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getAppointmentId(), IL_CAL_DATETIME, isFullday(), setSessionId(), and toggleFullTime().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _appointmentToString()

static ilSessionAppointment::_appointmentToString	(	$start,
		$end,
		$fulltime
	)

static

Definition at line 297 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $lng = $DIC['lng'];
 
        if ($fulltime) {
            return ilDatePresentation::formatPeriod(
                new ilDate($start, IL_CAL_UNIX),
                #new ilDate($end,IL_CAL_UNIX)).' ('.$lng->txt('event_full_time_info').')';
                new ilDate($end, IL_CAL_UNIX)
            );
        } else {
            return ilDatePresentation::formatPeriod(
                new ilDateTime($start, IL_CAL_UNIX),
                new ilDateTime($end, IL_CAL_UNIX)
            );
        }
    }

References $DIC, $end, $lng, $start, ilDatePresentation\formatPeriod(), and IL_CAL_UNIX.

Referenced by ilCourseContentGUI\__renderItem(), ilCourseContentGUI\__renderUserItem(), appointmentToString(), ilCourseContentGUI\editTimings(), ilRepositoryExplorerGUI\getNodeContent(), ilObjSessionListGUI\getTitle(), ilObjectCopySelectionTableGUI\parseSource(), ilTimingsManageTableGUI\parseTitle(), ilTimingsPersonalTableGUI\parseTitle(), ilContainerContentGUI\renderCard(), and ilSessionMailTemplateParticipantContext\resolveSpecificPlaceholder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _delete()

static ilSessionAppointment::_delete ( $a_appointment_id )

static

Definition at line 388 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "DELETE FROM event_appointment " .
            "WHERE appointment_id = " . $ilDB->quote($a_appointment_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        return true;
    }

References $DIC, $ilDB, $query, and $res.

Referenced by delete().

Here is the caller graph for this function:

◆ _deleteBySession()

static ilSessionAppointment::_deleteBySession ( $a_event_id )

static

Definition at line 401 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "DELETE FROM event_appointment " .
            "WHERE event_id = " . $ilDB->quote($a_event_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
 
        return true;
    }

References $DIC, $ilDB, $query, and $res.

Referenced by ilObjSession\delete().

Here is the caller graph for this function:

◆ _lookupAppointment()

static ilSessionAppointment::_lookupAppointment ( $a_obj_id )

static

lookup appointment

@access public

Parameters

int obj_id

Definition at line 56 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM event_appointment " .
            "WHERE event_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $info['fullday'] = $row->fulltime;
            
            $date = new ilDateTime($row->e_start, IL_CAL_DATETIME, 'UTC');
            $info['start'] = $date->getUnixTime();
            $date = new ilDateTime($row->e_end, IL_CAL_DATETIME, 'UTC');
            $info['end'] = $date->getUnixTime();
            
            return $info;
        }
        return array();
    }

References $DIC, $ilDB, $info, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and IL_CAL_DATETIME.

Referenced by ilCourseContentGUI\__renderItem(), ilCourseContentGUI\__renderUserItem(), ilLPStatusEvent\_getStatusInfo(), ilObjectActivation\addAdditionalSubItemInformation(), ilLPStatusEvent\determineStatus(), ilCourseContentGUI\editTimings(), ilObjSessionListGUI\getAppointmentInfo(), ilRepositoryExplorerGUI\getNodeContent(), ilObjectCopySelectionTableGUI\parseSource(), ilTimingsManageTableGUI\parseTitle(), ilTimingsPersonalTableGUI\parseTitle(), ilContainerContentGUI\renderCard(), and ilSessionMailTemplateParticipantContext\resolveSpecificPlaceholder().

Here is the caller graph for this function:

◆ _readAppointmentsBySession()

static ilSessionAppointment::_readAppointmentsBySession ( $a_event_id )

static

Definition at line 414 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM event_appointment " .
            "WHERE event_id = " . $ilDB->quote($a_event_id, 'integer') . " " .
            "ORDER BY starting_time";
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $appointments[] = new ilSessionAppointment($row->appointment_id);
        }
        return is_array($appointments) ? $appointments : array();
    }

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjSession\initAppointments().

Here is the caller graph for this function:

◆ _timeToString()

ilSessionAppointment::_timeToString	(	$start,
		$end
	)

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

    {
        global $DIC;
 
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
 
        $start = date($this->lng->txt('lang_timeformat_no_sec'), $start);
        $end = date($this->lng->txt('lang_timeformat_no_sec'), $end);
        
        return $start . ' - ' . $end;
    }

References $DIC, $end, $ilUser, $lng, and $start.

Referenced by formatTime().

Here is the caller graph for this function:

◆ appointmentToString()

ilSessionAppointment::appointmentToString ( )

Definition at line 317 of file class.ilSessionAppointment.php.

    {
        return ilSessionAppointment::_appointmentToString($this->getStartingTime(), $this->getEndingTime(), $this->enabledFullTime());
    }

References _appointmentToString(), enabledFullTime(), getEndingTime(), and getStartingTime().

Here is the call graph for this function:

◆ cloneObject()

ilSessionAppointment::cloneObject ( $new_id )

clone appointment

@access public

Parameters

return

Definition at line 329 of file class.ilSessionAppointment.php.

    {
        $new_app = new ilSessionAppointment();
        $new_app->setSessionId($new_id);
        $new_app->setStartingTime($this->getStartingTime());
        $new_app->setEndingTime($this->getEndingTime());
        $new_app->toggleFullTime($this->isFullday());
        $new_app->create();
        return $new_app;
    }

References getEndingTime(), getStartingTime(), and isFullday().

Here is the call graph for this function:

◆ create()

ilSessionAppointment::create ( )

Definition at line 340 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if (!$this->getSessionId()) {
            return false;
        }
        $next_id = $ilDB->nextId('event_appointment');
        $query = "INSERT INTO event_appointment (appointment_id,event_id,e_start,e_end,fulltime) " .
            "VALUES( " .
            $ilDB->quote($next_id, 'integer') . ", " .
            $ilDB->quote($this->getSessionId(), 'integer') . ", " .
            $ilDB->quote($this->getStart()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
            $ilDB->quote($this->getEnd()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
            $ilDB->quote($this->enabledFullTime(), 'integer') . " " .
            ")";
        $this->appointment_id = $next_id;
        $res = $ilDB->manipulate($query);
        
        return true;
    }

References $DIC, $ilDB, $query, $res, enabledFullTime(), getEnd(), getSessionId(), getStart(), and IL_CAL_DATETIME.

Here is the call graph for this function:

◆ delete()

ilSessionAppointment::delete ( )

Definition at line 383 of file class.ilSessionAppointment.php.

    {
        return ilSessionAppointment::_delete($this->getAppointmentId());
    }

References _delete(), and getAppointmentId().

Here is the call graph for this function:

◆ enabledFullTime()

ilSessionAppointment::enabledFullTime ( )

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

    {
        return $this->fulltime;
    }

Referenced by appointmentToString(), create(), isFullday(), and update().

Here is the caller graph for this function:

◆ formatTime()

ilSessionAppointment::formatTime ( )

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

    {
        return ilSessionAppointment::_timeToString($this->getStartingTime(), $this->getEndingTime());
    }

References _timeToString(), getEndingTime(), and getStartingTime().

Here is the call graph for this function:

◆ getAppointmentId()

ilSessionAppointment::getAppointmentId ( )

Definition at line 236 of file class.ilSessionAppointment.php.

    {
        return $this->appointment_id;
    }

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

Here is the caller graph for this function:

◆ getEnd()

ilSessionAppointment::getEnd ( )

get end

@access public

Returns: ilDateTime

Implements ilDatePeriod.

Definition at line 215 of file class.ilSessionAppointment.php.

    {
        return $this->end ? $this->end : $this->end = new ilDateTime(date('Y-m-d') . ' 16:00:00', IL_CAL_DATETIME);
    }

References IL_CAL_DATETIME.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getEndingTime()

ilSessionAppointment::getEndingTime ( )

Definition at line 265 of file class.ilSessionAppointment.php.

    {
        return isset($this->ending_time) ? $this->ending_time : mktime(16, 0, 0, date('n', time()), date('d', time()), date('Y', time()));
    }

Referenced by appointmentToString(), cloneObject(), and formatTime().

Here is the caller graph for this function:

◆ getSessionId()

ilSessionAppointment::getSessionId ( )

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

    {
        return $this->session_id;
    }

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getStart()

ilSessionAppointment::getStart ( )

get start

@access public

Parameters

return ilDateTime

Implements ilDatePeriod.

Definition at line 193 of file class.ilSessionAppointment.php.

    {
        return $this->start ? $this->start : $this->start = new ilDateTime(date('Y-m-d') . ' 08:00:00', IL_CAL_DATETIME);
    }

References IL_CAL_DATETIME.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getStartingTime()

ilSessionAppointment::getStartingTime ( )

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

    {
        return isset($this->starting_time) ? $this->starting_time : mktime(8, 0, 0, date('n', time()), date('d', time()), date('Y', time()));
    }

Referenced by appointmentToString(), cloneObject(), and formatTime().

Here is the caller graph for this function:

◆ isFullday()

ilSessionAppointment::isFullday ( )

is fullday

@access public

Parameters

return

Implements ilDatePeriod.

Definition at line 181 of file class.ilSessionAppointment.php.

    {
        return $this->enabledFullTime();
    }

References enabledFullTime().

Referenced by __read(), and cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupLastSessionByCourse()

static ilSessionAppointment::lookupLastSessionByCourse ( $a_ref_id )

static

@access public

Parameters

return

Definition at line 146 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $tree = $DIC['tree'];
        $ilDB = $DIC['ilDB'];
        
        $sessions = $tree->getChildsByType($a_ref_id, 'sess');
        $obj_ids = array();
        foreach ($sessions as $tree_data) {
            $obj_ids[] = $tree_data['obj_id'];
        }
        if (!count($obj_ids)) {
            return false;
        }
        $query = "SELECT event_id FROM event_appointment " .
            "WHERE e_start < " . $ilDB->now() . " " .
            "AND " . $ilDB->in('event_id', $obj_ids, false, 'integer') . " " .
            "ORDER BY e_start DESC ";
        $ilDB->setLimit(1);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $event_id = $row->event_id;
        }
        return isset($event_id) ? $event_id : 0;
    }

References $DIC, $ilDB, $query, $res, $row, $tree, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilContainerByTypeContentGUI\initDetails(), ilContainerSessionsContentGUI\initDetails(), and ilContainerSimpleContentGUI\initDetails().

Here is the caller graph for this function:

◆ lookupNextSessionByCourse()

static ilSessionAppointment::lookupNextSessionByCourse ( $a_ref_id )

static

@access public

Parameters

return array

Definition at line 86 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $tree = $DIC['tree'];
        $ilDB = $DIC['ilDB'];
        
        
        $sessions = $tree->getChildsByType($a_ref_id, 'sess');
        $obj_ids = array();
        foreach ($sessions as $tree_data) {
            $obj_ids[] = $tree_data['obj_id'];
        }
        if (!count($obj_ids)) {
            return false;
        }
 
        // Try to read the next sessions within the next 24 hours
        $now = new ilDate(time(), IL_CAL_UNIX);
        $tomorrow = clone $now;
        $tomorrow->increment(IL_CAL_DAY, 2);
        
        $query = "SELECT event_id FROM event_appointment " .
            "WHERE e_start > " . $ilDB->quote($now->get(IL_CAL_DATE, 'timestamp')) . ' ' .
            "AND e_start < " . $ilDB->quote($tomorrow->get(IL_CAL_DATE, 'timestamp')) . ' ' .
            "AND " . $ilDB->in('event_id', $obj_ids, false, 'integer') . ' ' .
            "ORDER BY e_start ";
            
        $event_ids = array();
            
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $event_ids[] = $row->event_id;
        }
        
        if (count($event_ids)) {
            return $event_ids;
        }
        
        // Alternativ: get next event.
        $query = "SELECT event_id FROM event_appointment " .
            "WHERE e_start > " . $ilDB->now() . " " .
            "AND " . $ilDB->in('event_id', $obj_ids, false, 'integer') . " " .
            "ORDER BY e_start ";
        $ilDB->setLimit(1);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $event_id = $row->event_id;
        }
        return isset($event_id) ? array($event_id) : array();
    }

References $DIC, $ilDB, $query, $res, $row, $tree, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATE, IL_CAL_DAY, and IL_CAL_UNIX.

Referenced by ilContainerByTypeContentGUI\initDetails(), ilContainerSessionsContentGUI\initDetails(), and ilContainerSimpleContentGUI\initDetails().

Here is the caller graph for this function:

◆ setAppointmentId()

ilSessionAppointment::setAppointmentId ( $a_appointment_id )

Definition at line 232 of file class.ilSessionAppointment.php.

    {
        $this->appointment_id = $a_appointment_id;
    }

◆ setEnd()

ilSessionAppointment::setEnd ( $a_end )

set end

@access public

Parameters

object $date ilDateTime

Returns

Definition at line 227 of file class.ilSessionAppointment.php.

    {
        $this->end = $a_end;
    }

◆ setEndingTime()

ilSessionAppointment::setEndingTime ( $a_ending_time )

Definition at line 260 of file class.ilSessionAppointment.php.

    {
        $this->ending_time = $a_ending_time;
        $this->end = new ilDateTime($this->ending_time, IL_CAL_UNIX);
    }

References IL_CAL_UNIX.

◆ setSessionId()

ilSessionAppointment::setSessionId ( $a_session_id )

Definition at line 241 of file class.ilSessionAppointment.php.

    {
        $this->session_id = $a_session_id;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ setStart()

ilSessionAppointment::setStart ( $a_start )

set start

@access public

Parameters

object $data ilDateTime

Definition at line 204 of file class.ilSessionAppointment.php.

    {
        $this->start = $a_start;
    }

◆ setStartingTime()

ilSessionAppointment::setStartingTime ( $a_starting_time )

Definition at line 250 of file class.ilSessionAppointment.php.

    {
        $this->starting_time = $a_starting_time;
        $this->start = new ilDateTime($this->starting_time, IL_CAL_UNIX);
    }

References IL_CAL_UNIX.

◆ toggleFullTime()

ilSessionAppointment::toggleFullTime ( $a_status )

Definition at line 270 of file class.ilSessionAppointment.php.

    {
        $this->fulltime = $a_status;
    }

Referenced by __read().

Here is the caller graph for this function:

◆ update()

ilSessionAppointment::update ( )

Definition at line 364 of file class.ilSessionAppointment.php.

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
        
        if (!$this->getSessionId()) {
            return false;
        }
        $query = "UPDATE event_appointment " .
            "SET event_id = " . $ilDB->quote($this->getSessionId(), 'integer') . ", " .
            "e_start = " . $ilDB->quote($this->getStart()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
            "e_end = " . $ilDB->quote($this->getEnd()->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp') . ", " .
            "fulltime = " . $ilDB->quote($this->enabledFullTime(), 'integer') . " " .
            "WHERE appointment_id = " . $ilDB->quote($this->getAppointmentId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);
        return true;
    }

References $DIC, $ilDB, $query, $res, enabledFullTime(), getAppointmentId(), getEnd(), getSessionId(), getStart(), and IL_CAL_DATETIME.

Here is the call graph for this function:

◆ validate()

ilSessionAppointment::validate ( )

Definition at line 431 of file class.ilSessionAppointment.php.

    {
        if ($this->starting_time > $this->ending_time) {
            $this->ilErr->appendMessage($this->lng->txt('event_etime_smaller_stime'));
            return false;
        }
        return true;
    }