ilConsultationHourUtils Class Reference

Description of class. More...

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 ($a_usr_id, $a_app_id)
	Book an appointment. More...
static	cancelBooking ($a_usr_id, $a_app_id, $a_send_notification=true)
	Cancel a booking. More...
static	lookupManagedUsers ($a_usr_id)
	Lookup managed users. More...

Detailed Description

Description of class.

Author

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

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

Member Function Documentation

bookAppointment()

static ilConsultationHourUtils::bookAppointment (   $a_usr_id,   $a_app_id  )

static

Book an appointment.

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

Parameters

type	$a_usr_id
type	$a_app_id

Returns

bool

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

References $app, $DIC, $lng, ilLanguageFactory\_getLanguage(), ilCalendarCategoryAssignments\addAssignment(), ilBookingEntry\book(), ilCalendarUtil\initDefaultCalendarByType(), and ilCalendarCategory\TYPE_CH.

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

    {
        global $DIC;

        $lng = $DIC['lng'];

        // Create new default consultation hour calendar
        include_once './Services/Language/classes/class.ilLanguageFactory.php';
        $cal_lang = ilLanguageFactory::_getLanguage($lng->getDefaultLanguage());
        $cal_lang->loadLanguageModule('dateplaner');
        
        include_once './Services/Calendar/classes/class.ilCalendarUtil.php';
        include_once './Services/Calendar/classes/class.ilCalendarCategory.php';
        $ch = ilCalendarUtil::initDefaultCalendarByType(
            ilCalendarCategory::TYPE_CH,
            $a_usr_id,
            $cal_lang->txt('cal_ch_personal_ch'),
            true
        );
        
        // duplicate appointment
        include_once './Services/Calendar/classes/class.ilCalendarEntry.php';
        $app = new ilCalendarEntry($a_app_id);
        $personal_app = clone $app;
        $personal_app->save();

        // assign appointment to category
        include_once './Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
        $assignment = new ilCalendarCategoryAssignments($personal_app->getEntryId());
        $assignment->addAssignment($ch->getCategoryID());

        // book appointment
        include_once './Services/Booking/classes/class.ilBookingEntry.php';
        $booking = new ilBookingEntry($app->getContextId());
        $booking->book($app->getEntryId(), $a_usr_id);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

cancelBooking()

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

static

Cancel a booking.

Parameters

type	$a_usr_id
type	$a_app_id

Returns

bool

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

References $app, ilCalendarCategoryAssignments\_deleteByAppointmentId(), ilBookingEntry\cancelBooking(), ilConsultationHourAppointments\getAppointmentIds(), and ilCalendarCategory\TYPE_CH.

Referenced by ilConsultationHoursGUI\delete(), and ilConsultationHoursGUI\rejectBooking().

    {
        // Delete personal copy of appointment
        include_once './Services/Calendar/classes/class.ilCalendarEntry.php';
        $app = new ilCalendarEntry($a_app_id);
        
        include_once './Services/Calendar/classes/ConsultationHours/class.ilConsultationHourAppointments.php';
        $user_apps = ilConsultationHourAppointments::getAppointmentIds(
            $a_usr_id,
            $app->getContextId(),
            $app->getStart(),
            ilCalendarCategory::TYPE_CH,
            false
        );
        foreach ($user_apps as $uapp_id) {
            $uapp = new ilCalendarEntry($uapp_id);
            $uapp->delete();

            include_once './Services/Calendar/classes/class.ilCalendarCategoryAssignments.php';
            ilCalendarCategoryAssignments::_deleteByAppointmentId($uapp_id);
            
            break;
        }
        
        // 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);
        }
        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

Parameters

ilBookingEntry	$booking
ilDateTime	$start
ilDateTime	$end

Returns

int[]

Exceptions

ilDatabaseException

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

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

Referenced by ilConsultationHoursGUI\rewriteBookingIdsForAppointments().

    {
        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[] = $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 12 of file class.ilConsultationHourUtils.php.

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

Referenced by ilCalendarBlockGUI\addConsultationHourButtons().

    {
        global $DIC;

        $ctrl = $DIC->ctrl();
        $lng = $DIC->language();
        $logger = $DIC->logger()->cal();

        $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);
            foreach ($appointments as $entry) {
                // find next entry
                if (ilDateTime::_before($entry->getStart(), $now, IL_CAL_DAY)) {
                    continue;
                }
                $booking_entry = new ilBookingEntry($entry->getContextId());
                if (!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 ($next_entry instanceof \ilCalendarEntry) {
                $ctrl->setParameterByClass(end($ctrl_class_structure), 'seed', $next_entry->getStart()->get(IL_CAL_DATE));
            }
            $current_link = [
                'link' => $ctrl->getLinkTargetByClass($ctrl_class_structure, 'selectCHCalendarOfUser'),
                'txt' => str_replace("%1", ilObjUser::_lookupFullname($user_id), $lng->txt("cal_consultation_hours_for_user"))
            ];
            $links[] = $current_link;
        }
        // Reset control structure links
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'seed', '');
        $ctrl->setParameterByClass(end($ctrl_class_structure), 'ch_user_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.

Parameters

type

$a_usr_id

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

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

Referenced by ilBookingEntry\lookupManagedBookingsForObject().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $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[] = $row->user_id;
        }
        return $users;
    }

Here is the caller graph for this function:

---

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

• Services/Calendar/classes/ConsultationHours/class.ilConsultationHourUtils.php