ilConsultationHourAppointments Class Reference

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

Collaboration diagram for ilConsultationHourAppointments:

Static Public Member Functions
static	getAppointmentIds (int $a_user_id, int $a_context_id=null, ?ilDateTime $a_start=null, ?int $a_type=null, bool $a_check_owner=true)
static	getAppointmentIdsByGroup (int $a_user_id, int $a_ch_group_id, ?ilDateTime $start=null)
	Get appointment ids by consultation hour group. More...
static	getAppointments (int $a_user_id)
	Get all appointments. More...
static	getManager (bool $a_as_name=false, bool $a_full_name=false, int $a_user_id=null)
	Get consultation hour manager for current user or specific user. More...
static	setManager (string $a_user_name)
	Set consultation hour manager for current user. More...
static	getManagedUsers ()
	Get all managed consultation hours users for current users. More...

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 Consultation hour appointments

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

getAppointmentIds()

static ilConsultationHourAppointments::getAppointmentIds ( int  $a_user_id, int  $a_context_id = null, ?ilDateTime  $a_start = null, ?int  $a_type = null, bool  $a_check_owner = true  )

static

Returns

int[]

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

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, ILIAS\Repository\int(), and ilCalendarCategory\TYPE_CH.

Referenced by ilConsultationHoursGUI\bookingList(), ilConsultationHourUtils\cancelBooking(), ilCalendarAppointmentGUI\cancelConfirmed(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), ilCalendarAppointmentPanelGUI\getHTML(), ilConsultationHoursGUI\initAppointmentIdsFromTableAction(), and ilCalendarEntry\parseDynamicTitle().

     : array {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$a_type) {
            $a_type = ilCalendarCategory::TYPE_CH;
        }
        $owner = ' ';
        if ($a_check_owner) {
            $owner = " AND be.obj_id = " . $ilDB->quote($a_user_id, 'integer');
        }

        $query = "SELECT ce.cal_id FROM cal_entries ce" .
            " JOIN cal_cat_assignments cca ON ce.cal_id = cca.cal_id" .
            " JOIN cal_categories cc ON cca.cat_id = cc.cat_id" .
            " JOIN booking_entry be ON ce.context_id  = be.booking_id" .
            " WHERE cc.obj_id = " . $ilDB->quote($a_user_id, 'integer') .
            $owner .
            " AND cc.type = " . $ilDB->quote($a_type, 'integer');

        if ($a_context_id) {
            $query .= " AND ce.context_id = " . $ilDB->quote($a_context_id, 'integer');
        }
        if ($a_start) {
            $query .= " AND ce.starta = " . $ilDB->quote($a_start->get(IL_CAL_DATETIME, '', 'UTC'), 'text');
        }
        $query .= (' ORDER BY ce.starta ASC');
        $res = $ilDB->query($query);
        $entries = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $entries[] = (int) $row->cal_id;
        }
        return $entries;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAppointmentIdsByGroup()

static ilConsultationHourAppointments::getAppointmentIdsByGroup ( int  $a_user_id, int  $a_ch_group_id, ?ilDateTime  $start = null  )

static

Get appointment ids by consultation hour group.

Returns

int[]

Todo:

check start time

Definition at line 78 of file class.ilConsultationHourAppointments.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, ILIAS\Repository\int(), and ilCalendarCategory\TYPE_CH.

     : array {
        global $DIC;

        $ilDB = $DIC->database();
        $type = ilCalendarCategory::TYPE_CH;
        $start_limit = '';
        if ($start instanceof ilDateTime) {
            $start_limit = 'AND ce.starta >= ' . $ilDB->quote($start->get(IL_CAL_DATETIME, '', 'UTC'), 'timestamp');
        }
        $query = 'SELECT ce.cal_id FROM cal_entries ce ' .
            'JOIN cal_cat_assignments ca ON ce.cal_id = ca.cal_id ' .
            'JOIN cal_categories cc ON ca.cat_id = cc.cat_id ' .
            'JOIN booking_entry be ON ce.context_id = be.booking_id ' .
            'WHERE cc.obj_id = ' . $ilDB->quote($a_user_id, 'integer') . ' ' .
            'AND cc.type = ' . $ilDB->quote($type, 'integer') . ' ' .
            'AND be.booking_group = ' . $ilDB->quote($a_ch_group_id, 'integer') . ' ' .
            $start_limit . ' ' .
            'ORDER BY ce.starta ';
        $res = $ilDB->query($query);
        $app_ids = [];
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $app_ids[] = (int) $row->cal_id;
        }
        return $app_ids;
    }

Here is the call graph for this function:

getAppointments()

static ilConsultationHourAppointments::getAppointments ( int  $a_user_id )

static

Get all appointments.

Returns

ilCalendarEntry[]

Definition at line 112 of file class.ilConsultationHourAppointments.php.

Referenced by ilConsultationHourUtils\getConsultationHourLinksForRepositoryObject(), ilCalendarBlockGUI\getHTML(), ilConsultationHoursTableGUI\parse(), and ILIAS\Calendar\ConsultationHours\BookingDataProvider\read().

                                                          : array
    {
        $entries = [];
        foreach (self::getAppointmentIds($a_user_id) as $app_id) {
            $entries[] = new ilCalendarEntry($app_id);
        }
        return $entries;
    }

Here is the caller graph for this function:

getManagedUsers()

static ilConsultationHourAppointments::getManagedUsers ( )

static

Get all managed consultation hours users for current users.

Returns

array

Definition at line 187 of file class.ilConsultationHourAppointments.php.

References $DIC, $ilDB, ilObjUser\_lookupLogin(), and ILIAS\Repository\int().

Referenced by ilConsultationHoursGUI\__construct(), and ilConsultationHoursGUI\setTabs().

                                            : array
    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilUser = $DIC->user();

        $all = array();
        $set = $ilDB->query('SELECT user_id FROM cal_ch_settings' .
            ' WHERE admin_id = ' . $ilDB->quote($ilUser->getId(), 'integer'));
        while ($row = $ilDB->fetchAssoc($set)) {
            $all[(int) $row['user_id']] = ilObjUser::_lookupLogin((int) $row['user_id']);
        }
        return $all;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getManager()

static ilConsultationHourAppointments::getManager ( bool  $a_as_name = false, bool  $a_full_name = false, int  $a_user_id = null  )

static

Get consultation hour manager for current user or specific user.

Returns

int | string

Definition at line 125 of file class.ilConsultationHourAppointments.php.

References $DIC, $ilDB, $user_id, ilObjUser\_lookupFullname(), and ilObjUser\_lookupLogin().

Referenced by ilConsultationHourUtils\bookAppointment(), ilAppointmentPresentationConsultationHoursGUI\collectPropertiesAndActions(), and ilConsultationHoursGUI\initSettingsForm().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilUser = $DIC->user();

        if (!$a_user_id) {
            $user_id = $ilUser->getId();
        } else {
            $user_id = $a_user_id;
        }

        $set = $ilDB->query('SELECT admin_id FROM cal_ch_settings' .
            ' WHERE user_id = ' . $ilDB->quote($user_id, 'integer'));
        $row = $ilDB->fetchAssoc($set);
        if ($row && $row['admin_id']) {
            if ($a_as_name && $a_full_name) {
                return ilObjUser::_lookupFullname((int) $row['admin_id']);
            } elseif ($a_as_name) {
                return ilObjUser::_lookupLogin((int) $row['admin_id']);
            }
            return (int) $row['admin_id'];
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setManager()

static ilConsultationHourAppointments::setManager ( string  $a_user_name )

static

Set consultation hour manager for current user.

Parameters

string

$a_user_name

Returns

bool

Definition at line 157 of file class.ilConsultationHourAppointments.php.

References $DIC, $ilDB, $user_id, and ilObjUser\_loginExists().

Referenced by ilConsultationHoursGUI\updateSettings().

                                                          : bool
    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilUser = $DIC->user();

        $user_id = false;
        if ($a_user_name) {
            $user_id = ilObjUser::_loginExists($a_user_name);
            if (!$user_id) {
                return false;
            }
        }

        $ilDB->manipulate('DELETE FROM cal_ch_settings' .
            ' WHERE user_id = ' . $ilDB->quote($ilUser->getId(), 'integer'));

        if ($user_id && $user_id != $ilUser->getId()) {
            $ilDB->manipulate('INSERT INTO cal_ch_settings (user_id, admin_id)' .
                ' VALUES (' . $ilDB->quote($ilUser->getId(), 'integer') . ',' .
                $ilDB->quote($user_id, 'integer') . ')');
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• components/ILIAS/Calendar/classes/ConsultationHours/class.ilConsultationHourAppointments.php