ilConsultationHourUtils Class Reference

Collaboration diagram for ilConsultationHourUtils:

Static Public Member Functions
static	getConsultationHourLinksForRepositoryObject (int $ref_id, int $current_user_id, array $ctrl_class_structure)
static	findCalendarAppointmentsForBooking (ilBookingEntry $booking, ilDateTime $start, ilDateTime $end)
static	bookAppointment (int $a_usr_id, int $a_app_id, string $comment='')
	Book an appointment. More...
static	cancelBooking (int $a_usr_id, int $a_app_id, bool $a_send_notification=true)
	Cancel a booking. More...
static	lookupManagedUsers ($a_usr_id)
	Lookup managed users. More...

Detailed Description

Author

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

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

Member Function Documentation

bookAppointment()

static ilConsultationHourUtils::bookAppointment ( int  $a_usr_id, int  $a_app_id, string  $comment = ''  )

static

Book an appointment.

All checks (assignment possible, max booking) must be done before

Parameters

int	$a_usr_id
int	$a_app_id

Returns

bool

Definition at line 135 of file class.ilConsultationHourUtils.php.

References $comment, $DIC, $lng, ilLanguageFactory\_getLanguage(), ilCalendarCategoryAssignments\addAssignment(), ilConsultationHourAppointments\getManager(), ilCalendarUtil\initDefaultCalendarByType(), ilCalendarMailNotification\TYPE_BOOKING_CONFIRMATION, ilCalendarMailNotification\TYPE_BOOKING_CONFIRMATION_MANAGER, ilCalendarCategory\TYPE_CH, and ilBookingEntry\writeBookingMessage().

Referenced by ilConsultationHoursGUI\assignUsersToAppointment(), and ilCalendarAppointmentGUI\bookconfirmed().

                                                                                              : bool
    {
        global $DIC;

        $lng = $DIC->language();

        // Create new default consultation hour calendar
        $cal_lang = ilLanguageFactory::_getLanguage($lng->getDefaultLanguage());
        $cal_lang->loadLanguageModule('dateplaner');

        $ch = ilCalendarUtil::initDefaultCalendarByType(
            ilCalendarCategory::TYPE_CH,
            $a_usr_id,
            $cal_lang->txt('cal_ch_personal_ch'),
            true
        );

        // duplicate appointment
        $app = new ilCalendarEntry($a_app_id);
        $personal_app = clone $app;
        $personal_app->save();

        // assign appointment to category
        $assignment = new ilCalendarCategoryAssignments($personal_app->getEntryId());
        $assignment->addAssignment($ch->getCategoryID());

        // book appointment
        $booking = new ilBookingEntry($app->getContextId());
        $booking->book($app->getEntryId(), $a_usr_id);
        ilBookingEntry::writeBookingMessage(
            $app->getEntryId(),
            $a_usr_id,
            $comment
        );

        $mail = new ilCalendarMailNotification();
        $mail->setAppointmentId($app->getEntryId());
        $mail->setRecipients([$a_usr_id]);
        $mail->setType(ilCalendarMailNotification::TYPE_BOOKING_CONFIRMATION);
        $mail->send();

        $recipients = [$booking->getObjId()];
        $mail = new ilCalendarMailNotification();
        $mail->setAppointmentId($app->getEntryId());
        $mail->setBookerID($a_usr_id);
        $mail->setRecipients($recipients);
        $mail->setType(ilCalendarMailNotification::TYPE_BOOKING_CONFIRMATION_MANAGER);
        $mail->send();

        $manager = ilConsultationHourAppointments::getManager(
            false,
            false,
            $booking->getObjId()
        );
        if ($manager > 0) {
            $recipients = [$manager];
            $mail = new ilCalendarMailNotification();
            $mail->setAppointmentId($app->getEntryId());
            $mail->setBookerID($a_usr_id);
            $mail->setRecipients($recipients);
            $mail->setType(ilCalendarMailNotification::TYPE_BOOKING_CONFIRMATION_MANAGER);
            $mail->send();
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancelBooking()

static ilConsultationHourUtils::cancelBooking ( int  $a_usr_id, int  $a_app_id, bool  $a_send_notification = true  )

static

Cancel a booking.

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

References ilCalendarCategoryAssignments\_deleteByAppointmentId(), ilConsultationHourAppointments\getAppointmentIds(), and ilCalendarCategory\TYPE_CH.

Referenced by ilConsultationHoursGUI\cancelBooking(), ilCalendarAppointmentGUI\cancelConfirmed(), and ilConsultationHoursGUI\deleteAppointments().

                                                                                                        : bool
    {
        // Delete personal copy of appointment
        $app = new ilCalendarEntry($a_app_id);

        $user_apps = ilConsultationHourAppointments::getAppointmentIds(
            $a_usr_id,
            $app->getContextId(),
            $app->getStart(),
            ilCalendarCategory::TYPE_CH,
            false
        );

        // Delete booking entries
        // Send notification
        $booking = new ilBookingEntry($app->getContextId());
        if ($a_send_notification) {
            $booking->cancelBooking($a_app_id, $a_usr_id);
        } else {
            $booking->deleteBooking($a_app_id, $a_usr_id);
        }

        foreach ($user_apps as $uapp_id) {
            $uapp = new ilCalendarEntry($uapp_id);
            $uapp->delete();

            ilCalendarCategoryAssignments::_deleteByAppointmentId($uapp_id);

            break;
        }

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

findCalendarAppointmentsForBooking()

static ilConsultationHourUtils::findCalendarAppointmentsForBooking ( ilBookingEntry  $booking, ilDateTime  $start, ilDateTime  $end  )

static

Returns

int[]

Definition at line 98 of file class.ilConsultationHourUtils.php.

References $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, ilDateTime\get(), ilBookingEntry\getId(), IL_CAL_DATETIME, ILIAS\Repository\int(), ilDBConstants\T_TIMESTAMP, ilCalendarCategory\TYPE_CH, and ilTimeZone\UTC.

Referenced by ilConsultationHoursGUI\rewriteBookingIdsForAppointments().

     : array {
        global $DIC;

        $db = $DIC->database();

        $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 ' .
            'where context_id = ' . $db->quote($booking->getId(), 'integer') . ' ' .
            'and starta = ' . $db->quote(
                $start->get(IL_CAL_DATETIME, '', \ilTimeZone::UTC),
                \ilDBConstants::T_TIMESTAMP
            ) . ' ' .
            'and enda = ' . $db->quote(
                $end->get(IL_CAL_DATETIME, '', \ilTimeZone::UTC),
                \ilDBConstants::T_TIMESTAMP
            ) . ' ' .
            'and type = ' . $db->quote(\ilCalendarCategory::TYPE_CH, 'integer');
        $res = $db->query($query);

        $calendar_apppointments = [];
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            $calendar_apppointments[] = (int) $row->cal_id;
        }
        return $calendar_apppointments;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getConsultationHourLinksForRepositoryObject()

static ilConsultationHourUtils::getConsultationHourLinksForRepositoryObject ( int  $ref_id, int  $current_user_id, array  $ctrl_class_structure  )

static

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

References $DIC, $user_id, ilDateTime\_before(), ilCalendarCategoryAssignments\_lookupCategories(), ilObjUser\_lookupFullname(), ilObject\_lookupObjId(), ilConsultationHourAppointments\getAppointments(), ilParticipants\getInstance(), IL_CAL_DATE, IL_CAL_DAY, IL_CAL_UNIX, and ilBookingEntry\lookupBookableUsersForObject().

Referenced by ilConsultationHoursCalendarBlockGUI\getData().

     : array {
        global $DIC;

        $ctrl = $DIC->ctrl();
        $logger = $DIC->logger()->cal();
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'seed', '');
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'category_id', '');

        $obj_id = \ilObject::_lookupObjId($ref_id);
        $participants = \ilParticipants::getInstance($ref_id);
        $candidates = array_unique(array_merge(
            $participants->getAdmins(),
            $participants->getTutors()
        ));
        $users = \ilBookingEntry::lookupBookableUsersForObject([$obj_id], $candidates);
        $now = new \ilDateTime(time(), IL_CAL_UNIX);
        $links = [];
        foreach ($users as $user_id) {
            $next_entry = null;
            $appointments = \ilConsultationHourAppointments::getAppointments($user_id);
            $category_id = 0;
            foreach ($appointments as $entry) {
                // find next entry
                if (ilDateTime::_before($entry->getStart(), $now, IL_CAL_DAY)) {
                    continue;
                }
                $category_id = ilCalendarCategoryAssignments::_lookupCategories($entry->getEntryId())[0] ?? 0;
                $booking_entry = new ilBookingEntry($entry->getContextId());
                if (count($booking_entry->getTargetObjIds()) > 0 && !in_array($obj_id, $booking_entry->getTargetObjIds())) {
                    continue;
                }
                if (!$booking_entry->isAppointmentBookableForUser($entry->getEntryId(), $current_user_id)) {
                    continue;
                }
                $next_entry = $entry;
                break;
            }

            $ctrl->setParameterByClass(end($ctrl_class_structure), 'ch_user_id', $user_id);
            if ($category_id > 0) {
                $ctrl->setParameterByClass(end($ctrl_class_structure), 'category_id', $category_id);
            }
            if ($next_entry instanceof \ilCalendarEntry) {
                $arr = explode("-", $next_entry->getStart()->get(IL_CAL_DATE));
                $arr[2] = "01";
                $seed = implode("-", $arr);
                $ctrl->setParameterByClass(
                    end($ctrl_class_structure),
                    'seed',
                    $seed
                );
            }
            $current_link = [
                'link' => $ctrl->getLinkTargetByClass($ctrl_class_structure, 'selectCHCalendarOfUser'),
                'txt' => ilObjUser::_lookupFullname($user_id)
            ];
            $links[] = $current_link;
        }
        // Reset control structure links
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'seed', '');
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'ch_user_id', '');
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'category_id', '');
        return $links;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupManagedUsers()

static ilConsultationHourUtils::lookupManagedUsers (   $a_usr_id )

static

Lookup managed users.

Returns

int[]

Definition at line 242 of file class.ilConsultationHourUtils.php.

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

Referenced by ilBookingEntry\lookupManagedBookingsForObject().

                                                        : array
    {
        global $DIC;

        $ilDB = $DIC->database();
        $query = 'SELECT user_id FROM cal_ch_settings ' .
            'WHERE admin_id = ' . $ilDB->quote($a_usr_id, 'integer');
        $res = $ilDB->query($query);

        $users = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $users[] = (int) $row->user_id;
        }
        return $users;
    }

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.ilConsultationHourUtils.php