ilSessionAppointment Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilSessionAppointment:

Collaboration diagram for ilSessionAppointment:

Public Member Functions
	__construct (int $a_appointment_id=0)
	isFullday ()
	is event a fullday period More...
	getStart ()
	Get start of date period. More...
	setStart (ilDateTime $a_start)
	getEnd ()
	Get end of period. More...
	setEnd (ilDateTime $a_end)
	setAppointmentId (int $a_appointment_id)
	getAppointmentId ()
	setSessionId (int $a_session_id)
	getSessionId ()
	setStartingTime (int $a_starting_time)
	getStartingTime ()
	setEndingTime (int $a_ending_time)
	getEndingTime ()
	toggleFullTime (bool $a_status)
	enabledFullTime ()
	formatTime ()
	timeToString (int $start, int $end)
	appointmentToString ()
	cloneObject (int $new_id)
	create ()
	update ()
	delete ()
	validate ()

Static Public Member Functions
static	_lookupAppointment (int $a_obj_id)
static	lookupNextSessionByCourse (int $a_ref_id)
static	lookupLastSessionByCourse (int $a_ref_id)
static	_appointmentToString (int $start, int $end, bool $fulltime)
static	_delete (int $a_appointment_id)
static	_deleteBySession (int $a_event_id)
static	_readAppointmentsBySession (int $a_event_id)

Protected Member Functions
	__read ()

Protected Attributes
ilErrorHandling	$ilErr
ilDBInterface	$db
ilTree	$tree
ilLanguage	$lng
ilDateTime	$start = null
ilDateTime	$end = null
int	$starting_time = 0
int	$ending_time = 0
bool	$fulltime = false
int	$appointment_id = 0
int	$session_id = 0

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 30 of file class.ilSessionAppointment.php.

Constructor & Destructor Documentation

__construct()

ilSessionAppointment::__construct

(

int

$a_appointment_id = 0

)

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

References $DIC, __read(), and ILIAS\Repository\lng().

    {
        global $DIC;

        $this->ilErr = $DIC['ilErr'];
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();

        $this->appointment_id = $a_appointment_id;
        $this->__read();
    }

Here is the call graph for this function:

Member Function Documentation

__read()

ilSessionAppointment::__read ( )

protected

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

References $db, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, getAppointmentId(), IL_CAL_DATETIME, ILIAS\Repository\int(), isFullday(), setSessionId(), and toggleFullTime().

Referenced by __construct().

                               : ?bool
    {
        $ilDB = $this->db;

        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((int) $row->event_id);
            $this->toggleFullTime((bool) $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 = (int) $this->start->getUnixTime();
            $this->ending_time = (int) $this->end->getUnixTime();
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_appointmentToString()

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

static

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

References $DIC, ilDatePresentation\formatPeriod(), IL_CAL_UNIX, and ilLanguage\txt().

Referenced by ilCourseContentGUI\__renderUserItem(), ilObjectListGUI\getAsCard(), ilRepositoryExplorerGUI\getNodeContent(), ilObjSessionListGUI\getTitle(), ilObjectCopySelectionTableGUI\parseSource(), ilTimingsPersonalTableGUI\parseTitle(), ilTimingsManageTableGUI\parseTitle(), and ilSessionMailTemplateParticipantContext\resolveSpecificPlaceholder().

                                                                                     : string
    {
        global $DIC;

        $lng = $DIC->language();

        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)
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_delete()

static ilSessionAppointment::_delete ( int  $a_appointment_id )

static

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

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

                                                         : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "DELETE FROM event_appointment " .
            "WHERE appointment_id = " . $ilDB->quote($a_appointment_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);

        return true;
    }

_deleteBySession()

static ilSessionAppointment::_deleteBySession ( int  $a_event_id )

static

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

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

Referenced by ilObjSession\delete().

                                                            : bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "DELETE FROM event_appointment " .
            "WHERE event_id = " . $ilDB->quote($a_event_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);

        return true;
    }

Here is the caller graph for this function:

_lookupAppointment()

static ilSessionAppointment::_lookupAppointment ( int  $a_obj_id )

static

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

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

Referenced by ilCourseContentGUI\__renderUserItem(), ilLPStatusEvent\_getStatusInfo(), ilObjectActivation\addAdditionalSubItemInformation(), ilLPStatusEvent\determineStatus(), ilObjSessionListGUI\getAppointmentInfo(), ilObjectListGUI\getAsCard(), ilRepositoryExplorerGUI\getNodeContent(), ilObjectCopySelectionTableGUI\parseSource(), ilTimingsPersonalTableGUI\parseTitle(), ilTimingsManageTableGUI\parseTitle(), ilSessionMailTemplateParticipantContext\resolveSpecificPlaceholder(), and ilRepositoryExplorerGUI\sortChilds().

                                                            : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $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 [];
    }

Here is the caller graph for this function:

_readAppointmentsBySession()

static ilSessionAppointment::_readAppointmentsBySession ( int  $a_event_id )

static

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

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

Referenced by ilObjSession\initAppointments().

                                                                      : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT * FROM event_appointment " .
            "WHERE event_id = " . $ilDB->quote($a_event_id, 'integer') . " " .
            "ORDER BY starting_time";

        $res = $ilDB->query($query);
        $appointments = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $appointments[] = new ilSessionAppointment((int) $row->appointment_id);
        }
        return $appointments;
    }

Here is the caller graph for this function:

appointmentToString()

ilSessionAppointment::appointmentToString

(

)

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

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

                                         : string
    {
        return self::_appointmentToString($this->getStartingTime(), $this->getEndingTime(), $this->isFullday());
    }

Here is the call graph for this function:

cloneObject()

ilSessionAppointment::cloneObject

(

int

$new_id

)

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

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

                                            : self
    {
        $new_app = new ilSessionAppointment();
        $new_app->setSessionId($new_id);
        $new_app->setStartingTime($this->getStartingTime());
        $new_app->setEndingTime($this->getEndingTime());
        $new_app->toggleFullTime($this->enabledFullTime());
        $new_app->create();

        return $new_app;
    }

Here is the call graph for this function:

create()

ilSessionAppointment::create

(

)

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

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

                            : bool
    {
        $ilDB = $this->db;

        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((int) $this->enabledFullTime(), 'integer') . " " .
            ")";
        $this->appointment_id = $next_id;
        $res = $ilDB->manipulate($query);

        return true;
    }

Here is the call graph for this function:

delete()

ilSessionAppointment::delete

(

)

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

References getAppointmentId().

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

Here is the call graph for this function:

enabledFullTime()

ilSessionAppointment::enabledFullTime

(

)

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

References $fulltime.

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

                                     : bool
    {
        return $this->fulltime;
    }

Here is the caller graph for this function:

formatTime()

ilSessionAppointment::formatTime

(

)

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

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

                                : string
    {
        return $this->timeToString($this->getStartingTime(), $this->getEndingTime());
    }

Here is the call graph for this function:

getAppointmentId()

ilSessionAppointment::getAppointmentId

(

)

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

References $appointment_id.

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

                                      : int
    {
        return $this->appointment_id;
    }

Here is the caller graph for this function:

getEnd()

ilSessionAppointment::getEnd

(

)

Get end of period.

Implements ilDatePeriod.

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

References IL_CAL_DATETIME.

Referenced by create(), and update().

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

Here is the caller graph for this function:

getEndingTime()

ilSessionAppointment::getEndingTime

(

)

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

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

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

Here is the caller graph for this function:

getSessionId()

ilSessionAppointment::getSessionId

(

)

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

References $session_id.

Referenced by create(), and update().

                                  : int
    {
        return $this->session_id;
    }

Here is the caller graph for this function:

getStart()

ilSessionAppointment::getStart

(

)

Get start of date period.

Implements ilDatePeriod.

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

References IL_CAL_DATETIME.

Referenced by create(), and update().

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

Here is the caller graph for this function:

getStartingTime()

ilSessionAppointment::getStartingTime

(

)

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

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

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

Here is the caller graph for this function:

isFullday()

ilSessionAppointment::isFullday

(

)

is event a fullday period

Implements ilDatePeriod.

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

References enabledFullTime().

Referenced by __read(), and appointmentToString().

                               : bool
    {
        return $this->enabledFullTime();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupLastSessionByCourse()

static ilSessionAppointment::lookupLastSessionByCourse ( int  $a_ref_id )

static

Returns

bool|int

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilTree\getChildsByType(), and ILIAS\Repository\int().

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

    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilDB = $DIC->database();

        $sessions = $tree->getChildsByType($a_ref_id, 'sess');
        $obj_ids = [];
        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, 0);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $event_id = (int) $row->event_id;
        }
        return $event_id ?? 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupNextSessionByCourse()

static ilSessionAppointment::lookupNextSessionByCourse ( int  $a_ref_id )

static

Returns

array|bool

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, ilTree\getChildsByType(), IL_CAL_DATE, IL_CAL_DAY, and IL_CAL_UNIX.

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

    {
        global $DIC;

        $tree = $DIC->repositoryTree();
        $ilDB = $DIC->database();


        $sessions = $tree->getChildsByType($a_ref_id, 'sess');
        $obj_ids = [];
        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 = [];

        $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, 0);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $event_id = $row->event_id;
        }
        return isset($event_id) ? [$event_id] : [];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAppointmentId()

ilSessionAppointment::setAppointmentId

(

int

$a_appointment_id

)

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

                                                           : void
    {
        $this->appointment_id = $a_appointment_id;
    }

setEnd()

ilSessionAppointment::setEnd

(

ilDateTime

$a_end

)

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

                                             : void
    {
        $this->end = $a_end;
    }

setEndingTime()

ilSessionAppointment::setEndingTime

(

int

$a_ending_time

)

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

References IL_CAL_UNIX.

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

setSessionId()

ilSessionAppointment::setSessionId

(

int

$a_session_id

)

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

Referenced by __read().

                                                   : void
    {
        $this->session_id = $a_session_id;
    }

Here is the caller graph for this function:

setStart()

ilSessionAppointment::setStart

(

ilDateTime

$a_start

)

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

                                                 : void
    {
        $this->start = $a_start;
    }

setStartingTime()

ilSessionAppointment::setStartingTime

(

int

$a_starting_time

)

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

References IL_CAL_UNIX.

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

timeToString()

ilSessionAppointment::timeToString	(	int	$start,
		int	$end
	)

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

References $end, $lng, $start, and ilLanguage\txt().

Referenced by formatTime().

                                                      : string
    {
        $lng = $this->lng;

        $start = date($lng->txt('lang_timeformat_no_sec'), $start);
        $end = date($lng->txt('lang_timeformat_no_sec'), $end);

        return $start . ' - ' . $end;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

toggleFullTime()

ilSessionAppointment::toggleFullTime

(

bool

$a_status

)

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

Referenced by __read().

                                                  : void
    {
        $this->fulltime = $a_status;
    }

Here is the caller graph for this function:

update()

ilSessionAppointment::update

(

)

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

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

                            : bool
    {
        $ilDB = $this->db;

        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((int) $this->enabledFullTime(), 'integer') . " " .
            "WHERE appointment_id = " . $ilDB->quote($this->getAppointmentId(), 'integer') . " ";
        $res = $ilDB->manipulate($query);

        return true;
    }

Here is the call graph for this function:

validate()

ilSessionAppointment::validate

(

)

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

Field Documentation

$appointment_id

int ilSessionAppointment::$appointment_id = 0

protected

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

Referenced by getAppointmentId().

$db

ilDBInterface ilSessionAppointment::$db

protected

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

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

$end

ilDateTime ilSessionAppointment::$end = null

protected

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

Referenced by timeToString().

$ending_time

int ilSessionAppointment::$ending_time = 0

protected

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

$fulltime

bool ilSessionAppointment::$fulltime = false

protected

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

Referenced by enabledFullTime().

$ilErr

ilErrorHandling ilSessionAppointment::$ilErr

protected

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

$lng

ilLanguage ilSessionAppointment::$lng

protected

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

Referenced by timeToString().

$session_id

int ilSessionAppointment::$session_id = 0

protected

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

Referenced by getSessionId().

$start

ilDateTime ilSessionAppointment::$start = null

protected

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

Referenced by timeToString().

$starting_time

int ilSessionAppointment::$starting_time = 0

protected

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

$tree

ilTree ilSessionAppointment::$tree

protected

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

---

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

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