Consultation hours editor. More...

Collaboration diagram for ilConsultationHoursGUI:

Public Member Functions
	__construct ()
	Constructor. More...

	executeCommand ()

	getUserId ()

	assignUsersToAppointments (array $users)
	Assign users to multiple appointments. More...

	assignUsersToAppointment (array $users, int $a_app=0, bool $a_redirect=true)
	Assign users to an appointment. More...

	edit ()

	showProfile ()
	show public profile of given user More...

	settings ()
	display settings gui More...

	updateSettings ()
	save settings More...

Data Fields
const	VIEW_MODE_PERIOD_UPCOMING = 'upcoming'

const	VIEW_MODE_PERIOD_PAST = 'past'

const	VIEW_MODE_PERIOD_ALL = 'all'

const	VIEW_MODE_STATUS_BOOKED = 'booked'

const	VIEW_MODE_STATUS_OPEN = 'open'

const	VIEW_MODE_STATUS_ALL = 'all'

Protected Member Functions
	initSearchAssignmentToAppointments ($a_default=false)

	initAppointmentIdsFromTableAction ()

	initAppointmentIdsFromQuery ()

	initAppointmentIdsFromPost ()

	initAppointmentIdsFromPostString ()

	initBookingUsersFromPost ()

	initBookingUsersFromQuery ()

	searchUsersForAppointments ()

	sendInfoAboutUnassignedUsers (array $unassigned)
	Send info message about unassigned users. More...

	bookingList ()
	Show list of bookings. More...

	confirmDeleteBooking ()
	Show delete booking confirmation. More...

	confirmRejectBooking (bool $a_send_notification=true)
	Show delete booking confirmation. More...

	createSequence ()
	Create new sequence. More...

	initFormSequence (int $a_mode)

	saveSequence ()
	Save new sequence. More...

	createAppointments (ilBookingEntry $booking)
	Create calendar appointments. More...

	setTabs ()

	createNewBookingEntry (ilPropertyFormGUI $validate_form)

	rewriteBookingIdsForAppointments (ilBookingEntry $booking, array $appointments, ilPropertyFormGUI $form)

	updateMulti ()
	Update multiple sequence items. More...

	getProfileBackUrl ()
	Build context-sensitive profile back url. More...

	initSettingsForm ()
	build settings form More...

	appointments ()

	handleBookingTableActions ()

	sendMailToSelectedUsers ()

	confirmCancelBooking (bool $with_notification=true)

	deleteBooking ()

	cancelBooking (bool $with_notification=true)

	confirmDeleteAppointments ()

	deleteAppointments ()

	initSequenceCreation ()

	renderViewControl ()

	initViewMode ()

Protected Attributes
const	MODE_CREATE = 1

const	MODE_UPDATE = 2

const	MODE_MULTI = 3

const	MAX_APPOINTMENTS_PER_SEQUENCE = 1000

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilObjUser	$global_user

ilHelpGUI	$help

ilTabsGUI	$tabs

ilToolbarGUI	$toolbar

RefineryFactory	$refinery

GlobalHttpState	$http

Private Attributes
UIFactory	$ui_factory

UIRenderer	$ui_renderer

int	$user_id

bool	$search_assignment_to_appointments = false

ilBookingEntry	$booking = null

ilPropertyFormGUI	$form = null

string	$vm_period = ''

string	$vm_status = ''

Detailed Description

Consultation hours editor.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilConsultationHoursGUI::__construct ( )

Constructor.

Definition at line 77 of file class.ilConsultationHoursGUI.php.

References $DIC, $user_id, ILIAS\Repository\ctrl(), ilConsultationHourAppointments\getManagedUsers(), ILIAS\Repository\help(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
 
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         $user_id = 0;
         if ($this->http->wrapper()->query()->has('user_id')) {
             $user_id = $this->http->wrapper()->query()->retrieve(
                 'user_id',
                 $this->refinery->kindlyTo()->int()
             );
         }
         if ($user_id) {
             if (in_array($user_id, array_keys(ilConsultationHourAppointments::getManagedUsers()))) {
                 $this->user_id = $user_id;
             } else {
                 $user_id = false;
             }
         }
         if (!$user_id) {
             $this->user_id = $DIC->user()->getId();
         }
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->help = $DIC->help();
         $this->tabs = $DIC->tabs();
         $this->toolbar = $DIC->toolbar();
         $this->global_user = $DIC->user();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
     }

Here is the call graph for this function:

Member Function Documentation

◆ appointments()

ilConsultationHoursGUI::appointments ( )

protected

Definition at line 929 of file class.ilConsultationHoursGUI.php.

References getUserId(), initViewMode(), and renderViewControl().

Referenced by cancelBooking(), confirmCancelBooking(), deleteAppointments(), edit(), and sendMailToSelectedUsers().

                                      : void
     {
         $this->initViewMode();
         $table = new BookingTableGUI(
             new BookingDataProvider($this->getUserId(), $this->vm_period, $this->vm_status)
         );
         $this->tpl->setContent(
             $this->renderViewControl() .
             $table->render()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignUsersToAppointment()

ilConsultationHoursGUI::assignUsersToAppointment	(	array	$users,
		int	$a_app = `0`,
		bool	$a_redirect = `true`
	)

Assign users to an appointment.

Parameters

array	$users
int	$a_app
bool	$a_redirect

Returns: int[] $unassigned_users

Exceptions

ilCtrlException

Definition at line 326 of file class.ilConsultationHoursGUI.php.

References ilConsultationHourUtils\bookAppointment(), ILIAS\Repository\ctrl(), ilBookingEntry\getCurrentNumberOfBookings(), ilBookingEntry\getInstanceByCalendarEntryId(), ilBookingEntry\getNumberOfBookings(), initAppointmentIdsFromPost(), initAppointmentIdsFromQuery(), initBookingUsersFromPost(), ILIAS\Repository\lng(), ilBookingEntry\lookupBookingsOfUser(), and sendInfoAboutUnassignedUsers().

Referenced by assignUsersToAppointments().

                                                                                                    : array
     {
         if ($a_app) {
             $app = $a_app;
         } elseif ($this->initBookingUsersFromPost() !== []) {
             $app = $this->initAppointmentIdsFromPost();
             $app = current($app);
         } elseif ($this->initAppointmentIdsFromQuery() !== []) {
             $app = $this->initAppointmentIdsFromQuery();
             $app = current($app);
         }
         if (!count($users)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             return [];
         }
         $booking = ilBookingEntry::getInstanceByCalendarEntryId($app);
         $assigned_users = array();
         foreach ($users as $user) {
             if ($booking->getCurrentNumberOfBookings($app) >= $booking->getNumberOfBookings()) {
                 break;
             }
             if (!ilBookingEntry::lookupBookingsOfUser((array) $app, $user)) {
                 ilConsultationHourUtils::bookAppointment($user, $app);
                 $assigned_users[] = $user;
             }
         }
         $unassigned_users = array_diff($users, $assigned_users);
         if ($a_redirect) {
             $this->sendInfoAboutUnassignedUsers($unassigned_users);
             $this->ctrl->redirect($this, 'appointments');
         } else {
             return $unassigned_users;
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignUsersToAppointments()

ilConsultationHoursGUI::assignUsersToAppointments ( array $users )

Assign users to multiple appointments.

Definition at line 303 of file class.ilConsultationHoursGUI.php.

References assignUsersToAppointment(), ILIAS\Repository\ctrl(), ilSession\get(), and sendInfoAboutUnassignedUsers().

     {
         $unassigned_users = [];
         $ch_apps = (array) (ilSession::get('ch_apps') ?? []);
         foreach ($ch_apps as $app) {
             $unassigned_users = array_unique(array_merge(
                 $unassigned_users,
                 $this->assignUsersToAppointment($users, $app, false)
             ));
         }
 
         $this->sendInfoAboutUnassignedUsers($unassigned_users);
         $this->ctrl->redirect($this, 'appointments');
     }

Here is the call graph for this function:

◆ bookingList()

ilConsultationHoursGUI::bookingList ( )

protected

Show list of bookings.

Definition at line 372 of file class.ilConsultationHoursGUI.php.

References ilConsultationHourAppointments\getAppointmentIds(), getUserId(), and ILIAS\Repository\help().

Referenced by confirmRejectBooking().

                                     : void
     {
         $this->help->setScreenId("consultation_hours");
 
         $btable = new ilConsultationHourBookingTableGUI($this, 'bookingList', $this->getUserId());
         $btable->parse(ilConsultationHourAppointments::getAppointmentIds($this->getUserId()));
         $this->tpl->setContent($btable->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancelBooking()

ilConsultationHoursGUI::cancelBooking ( bool $with_notification = true )

protected

Definition at line 1033 of file class.ilConsultationHoursGUI.php.

References $data, appointments(), ilConsultationHourUtils\cancelBooking(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by deleteBooking().

                                                                     : void
     {
         $appointment_id = $this->http->wrapper()->query()->retrieve(
             'appointment_id',
             $this->refinery->byTrying(
                 [
                     $this->refinery->kindlyTo()->int(),
                     $this->refinery->always(0)
                 ]
             )
         );
         if (!$appointment_id) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->appointments();
             return;
         }
 
         $entry = new ilCalendarEntry($appointment_id);
         $booking = new ilBookingEntry($entry->getContextId());
         $cancel = new \ILIAS\Calendar\ConsultationHours\BookingCancellationGUI(
             $this,
             $entry,
             $booking,
             $with_notification ?
                 \ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::TYPE_CANCEL :
                 \ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::TYPE_DELETE
         );
         $data = $cancel->renderModal()->withRequest($this->http->request())->getData();
         foreach ((array) $data['bookings'] as $user => $checked) {
             if ($checked) {
                 ilConsultationHourUtils::cancelBooking(
                     $user,
                     $appointment_id,
                     $with_notification
                 );
             }
         }
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('cal_ch_canceled_bookings'), true);
         $this->ctrl->redirect($this, 'appointments');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmCancelBooking()

ilConsultationHoursGUI::confirmCancelBooking ( bool $with_notification = true )

protected

Definition at line 997 of file class.ilConsultationHoursGUI.php.

References appointments(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), initAppointmentIdsFromTableAction(), and ILIAS\Repository\lng().

Referenced by handleBookingTableActions().

                                                                            : void
     {
         $appointment_ids = $this->initAppointmentIdsFromTableAction();
         if ($appointment_ids === []) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->appointments();
             return;
         }
 
         $appointment = end($appointment_ids);
         $this->ctrl->setParameter($this, 'appointment_id', $appointment);
         $entry = new ilCalendarEntry($appointment);
         $booking = new ilBookingEntry($entry->getContextId());
 
         $cancel = new \ILIAS\Calendar\ConsultationHours\BookingCancellationGUI(
             $this,
             $entry,
             $booking,
             $with_notification ?
                 \ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::TYPE_CANCEL :
                 \ILIAS\Calendar\ConsultationHours\BookingCancellationGUI::TYPE_DELETE
         );
         $modal = $cancel->renderModal();
         $output = $this->ui_renderer->renderAsync($modal);
         $this->http->saveResponse($this->http->response()->withBody(
             Streams::ofString($output)
         ));
         $this->http->sendResponse();
         $this->http->close();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteAppointments()

ilConsultationHoursGUI::confirmDeleteAppointments ( )

protected

Definition at line 1074 of file class.ilConsultationHoursGUI.php.

References ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ILIAS\FileDelivery\http(), initAppointmentIdsFromTableAction(), and ILIAS\Repository\lng().

Referenced by handleBookingTableActions().

                                                   : void
     {
         $appointment_ids = $this->initAppointmentIdsFromTableAction();
         if (!count($appointment_ids)) {
             $output = $this->ui_factory->messageBox()->failure($this->lng->txt('select_one'));
         } else {
             $items = [];
             foreach ($appointment_ids as $appointment) {
                 $entry = new ilCalendarEntry($appointment);
                 $items[] = $this->ui_factory->modal()->interruptiveItem()->standard(
                     (string) $appointment,
                     ilDatePresentation::formatDate($entry->getStart()) . ', ' . $entry->getTitle()
                 );
             }
 
             $output = $this->ui_factory->modal()->interruptive(
                 $this->lng->txt('confirm'),
                 $this->lng->txt('cal_ch_delete_app_booking_info'),
                 $this->ctrl->getFormAction($this, 'deleteAppointments')
             )->withAffectedItems($items);
         }
 
         $rendered_output = $this->ui_renderer->renderAsync($output);
         $this->http->saveResponse($this->http->response()->withBody(
             Streams::ofString($rendered_output)
         ));
         $this->http->sendResponse();
         $this->http->close();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteBooking()

ilConsultationHoursGUI::confirmDeleteBooking ( )

protected

Show delete booking confirmation.

Definition at line 384 of file class.ilConsultationHoursGUI.php.

References confirmRejectBooking().

                                              : void
     {
         $this->confirmRejectBooking(false);
     }

Here is the call graph for this function:

◆ confirmRejectBooking()

ilConsultationHoursGUI::confirmRejectBooking ( bool $a_send_notification = true )

protected

Show delete booking confirmation.

Definition at line 392 of file class.ilConsultationHoursGUI.php.

References bookingList(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilUserUtil\getNamePresentation(), initBookingUsersFromPost(), initBookingUsersFromQuery(), and ILIAS\Repository\lng().

Referenced by confirmDeleteBooking().

                                                                              : void
     {
         $bookusers = [];
         if ($this->initBookingUsersFromPost() !== []) {
             $bookusers = $this->initBookingUsersFromPost();
         } elseif ($this->initBookingUsersFromQuery() !== []) {
             $bookusers = $this->initBookingUsersFromQuery();
         }
 
         if ($bookusers === []) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->bookingList();
             return;
         }
 
         $confirm = new ilConfirmationGUI();
         $confirm->setFormAction($this->ctrl->getFormAction($this));
 
         if ($a_send_notification) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('cal_ch_cancel_booking_info'));
             $confirm->setHeaderText($this->lng->txt('cal_ch_cancel_booking_sure'));
             $confirm->setConfirm($this->lng->txt('cal_ch_reject_booking'), 'rejectBooking');
         } else {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('cal_ch_delete_booking_info'));
             $confirm->setHeaderText($this->lng->txt('cal_ch_delete_booking_sure'));
             $confirm->setConfirm($this->lng->txt('cal_ch_delete_booking'), 'deleteBooking');
         }
 
         $confirm->setCancel($this->lng->txt('cancel'), 'bookingList');
 
         foreach ($bookusers as $bookuser) {
             $ids = explode('_', $bookuser);
 
             $entry = new ilCalendarEntry((int) $ids[0]);
             $confirm->addItem(
                 'bookuser[]',
                 $bookuser,
                 ilUserUtil::getNamePresentation(
                     $ids[1],
                     true,
                     false,
                     '',
                     true,
                     true
                 ) . ', ' . ilDatePresentation::formatDate($entry->getStart())
             );
         }
         $this->tpl->setContent($confirm->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createAppointments()

ilConsultationHoursGUI::createAppointments ( ilBookingEntry $booking )

protected

Create calendar appointments.

Definition at line 610 of file class.ilConsultationHoursGUI.php.

References ilCalendarCategoryAssignments\addAssignment(), ilCalendarRecurrenceCalculator\calculateDateList(), ILIAS\Repository\form(), ilBookingEntry\getId(), getUserId(), ilDateTime\HOUR, ilCalendarUtil\initDefaultCalendarByType(), ILIAS\Repository\lng(), ilDateTime\MINUTE, ilCalendarEntry\TRANSLATION_SYSTEM, ilCalendarCategory\TYPE_CH, ilDateList\TYPE_DATETIME, and ilDateTime\YEAR.

Referenced by saveSequence().

                                                                   : void
     {
         $concurrent_dates = new ilDateList(ilDateList::TYPE_DATETIME);
         $start = clone $this->form->getItemByPostVar('st')->getDate();
         for ($i = 0; $i < $this->form->getItemByPostVar('ap')->getValue(); $i++) {
             $concurrent_dates->add(clone $start);
 
             $start->increment(ilDateTime::MINUTE, $this->form->getItemByPostVar('du')->getMinutes());
             $start->increment(ilDateTime::HOUR, $this->form->getItemByPostVar('du')->getHours());
             #$start = new ilDateTime(,IL_CAL_UNIX);
         }
 
         $def_cat = ilCalendarUtil::initDefaultCalendarByType(
             ilCalendarCategory::TYPE_CH,
             $this->getUserId(),
             $this->lng->txt('cal_ch_personal_ch'),
             true
         );
 
         // Add calendar appointment for each
 
         $num_appointments = 0;
         foreach ($concurrent_dates as $dt) {
             if ($num_appointments >= self::MAX_APPOINTMENTS_PER_SEQUENCE) {
                 break;
             }
 
             $end = clone $dt;
             $end->increment(ilDateTime::MINUTE, $this->form->getItemByPostVar('du')->getMinutes());
             $end->increment(ilDateTime::HOUR, $this->form->getItemByPostVar('du')->getHours());
 
             $calc = new ilCalendarRecurrenceCalculator(
                 new ilBookingPeriod($dt, $end),
                 $this->form->getItemByPostVar('frequence')->getRecurrence()
             );
 
             // Calculate with one year limit
             $limit = clone $dt;
             $limit->increment(ilDateTime::YEAR, 1);
 
             $date_list = $calc->calculateDateList($dt, $limit);
 
             $num = 0;
             foreach ($date_list as $app_start) {
                 $app_end = clone $app_start;
                 $app_end->increment(ilDateTime::MINUTE, $this->form->getItemByPostVar('du')->getMinutes());
                 $app_end->increment(ilDateTime::HOUR, $this->form->getItemByPostVar('du')->getHours());
 
                 $entry = new ilCalendarEntry();
                 $entry->setContextId($booking->getId());
                 $entry->setTitle($this->form->getInput('ti'));
                 $entry->setSubtitle("#consultationhour#"); // dynamic, see ilCalendarEntry
                 $entry->setDescription($this->form->getInput('de'));
                 $entry->setLocation($this->form->getInput('lo'));
                 $entry->setStart($app_start);
                 $entry->setEnd($app_end);
 
                 $entry->setTranslationType(ilCalendarEntry::TRANSLATION_SYSTEM);
                 $entry->save();
 
                 $cat_assign = new ilCalendarCategoryAssignments($entry->getEntryId());
                 $cat_assign->addAssignment($def_cat->getCategoryID());
 
                 $num_appointments++;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createNewBookingEntry()

ilConsultationHoursGUI::createNewBookingEntry ( ilPropertyFormGUI $validate_form )

protected

Definition at line 746 of file class.ilConsultationHoursGUI.php.

References $booking, $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Repository\form(), ILIAS\Repository\lng(), null, ilBookingEntry\save(), ilBookingEntry\setDeadlineHours(), ilBookingEntry\setNumberOfBookings(), ilBookingEntry\setObjId(), and ilBookingEntry\setTargetObjIds().

Referenced by updateMulti().

                                                                               : ?ilBookingEntry
     {
         $booking = new \ilBookingEntry();
         $booking->setObjId($this->user_id);
         $booking->setNumberOfBookings((int) $this->form->getInput('bo'));
 
         $deadline = $this->form->getInput('dead');
         $deadline = $deadline['dd'] * 24 + $deadline['hh'];
         $booking->setDeadlineHours($deadline);
 
         $tgt = array_map('intval', explode(',', (string) $this->form->getInput('tgt')));
         $obj_ids = [];
         foreach ($tgt as $ref_id) {
             if ($ref_id === 0) {
                 continue;
             }
             $obj_id = ilObject::_lookupObjId($ref_id);
             $type = ilObject::_lookupType($obj_id);
             $valid_types = ['crs', 'grp'];
             if (!$obj_id or !in_array($type, $valid_types)) {
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cal_ch_unknown_repository_object'));
                 return null;
             }
             $obj_ids[] = $obj_id;
         }
         $booking->setTargetObjIds($obj_ids);
         $booking->save();
         return $booking;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createSequence()

ilConsultationHoursGUI::createSequence ( )

protected

Create new sequence.

Definition at line 445 of file class.ilConsultationHoursGUI.php.

References ILIAS\Repository\form(), IL_CAL_UNIX, and initFormSequence().

                                        : void
     {
         $this->initFormSequence(self::MODE_CREATE);
 
         $this->booking = new ilBookingEntry();
         $this->form->getItemByPostVar('bo')->setValue((string) $this->booking->getNumberOfBookings());
         $this->form->getItemByPostVar('ap')->setValue("1");
         $this->form->getItemByPostVar('du')->setMinutes(15);
         $this->form->getItemByPostVar('st')->setDate(
             new ilDateTime(mktime(8, 0, 0, (int) date('n', time()), (int) date('d', time()), (int) date('Y', time())), IL_CAL_UNIX)
         );
         $this->tpl->setContent($this->form->getHTML());
     }

Here is the call graph for this function:

◆ deleteAppointments()

ilConsultationHoursGUI::deleteAppointments ( )

protected

Definition at line 1104 of file class.ilConsultationHoursGUI.php.

References $user_id, ilCalendarCategoryAssignments\_deleteByAppointmentId(), appointments(), ilConsultationHourUtils\cancelBooking(), ILIAS\Repository\ctrl(), ilBookingEntry\getCurrentBookings(), ilBookingEntry\getInstanceByCalendarEntryId(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilBookingEntry\removeObsoleteEntries().

                                            : void
     {
         $appointment_ids = $this->http->wrapper()->post()->retrieve(
             'interruptive_items',
             $this->refinery->byTrying(
                 [
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                     $this->refinery->always([])
                 ]
             )
         );
         if (!count($appointment_ids)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->appointments();
             return;
         }
 
         foreach ($appointment_ids as $appointment_id) {
             // cancel booking for users
             $booking = ilBookingEntry::getInstanceByCalendarEntryId($appointment_id);
             if ($booking) {
                 foreach ($booking->getCurrentBookings($appointment_id) as $user_id) {
                     ilConsultationHourUtils::cancelBooking($user_id, $appointment_id, false);
                 }
             }
             // remove calendar entries
             $entry = new ilCalendarEntry($appointment_id);
             $entry->delete();
             ilCalendarCategoryAssignments::_deleteByAppointmentId($appointment_id);
         }
         ilBookingEntry::removeObsoleteEntries();
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('cal_deleted_app'), true);
         $this->ctrl->redirect($this, 'appointments');
     }

Here is the call graph for this function:

◆ deleteBooking()

ilConsultationHoursGUI::deleteBooking ( )

protected

Definition at line 1028 of file class.ilConsultationHoursGUI.php.

References cancelBooking().

                                       : void
     {
         $this->cancelBooking(false);
     }

Here is the call graph for this function:

◆ edit()

ilConsultationHoursGUI::edit ( )

Definition at line 700 of file class.ilConsultationHoursGUI.php.

References ilObject\_getAllReferences(), appointments(), ILIAS\Repository\form(), ilBookingEntry\getDeadlineHours(), ilBookingEntry\getNumberOfBookings(), ilBookingEntry\getTargetObjIds(), initAppointmentIdsFromPostString(), initAppointmentIdsFromTableAction(), initFormSequence(), and ILIAS\Repository\lng().

Referenced by handleBookingTableActions(), and updateMulti().

                           : void
     {
         $apps = $this->initAppointmentIdsFromTableAction();
         if (!count($apps)) {
             if ($this->initAppointmentIdsFromPostString() !== []) {
                 $apps = $this->initAppointmentIdsFromPostString();
             }
         }
 
         // first read from hidden input
         if (!count($apps)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->appointments();
             return;
         }
 
         $this->initFormSequence(self::MODE_MULTI);
         $hidden = new ilHiddenInputGUI('apps_string');
         $hidden->setValue(implode(';', $apps));
         $this->form->addItem($hidden);
 
         $first = $apps;
         $first = array_shift($apps);
         $entry = new ilCalendarEntry($first);
 
         $this->form->getItemByPostVar('ti')->setValue($entry->getTitle());
         $this->form->getItemByPostVar('lo')->setValue($entry->getLocation());
         $this->form->getItemByPostVar('de')->setValue($entry->getDescription());
 
         $booking = new ilBookingEntry($entry->getContextId());
 
         $this->form->getItemByPostVar('bo')->setValue((string) $booking->getNumberOfBookings());
 
         $ref_ids = array();
         foreach ($booking->getTargetObjIds() as $obj_id) {
             $refs = ilObject::_getAllReferences($obj_id);
             $ref_ids[] = end($refs);
         }
         $this->form->getItemByPostVar('tgt')->setValue(implode(',', $ref_ids));
 
         $deadline = $booking->getDeadlineHours();
         $this->form->getItemByPostVar('dead')->setDays((int) floor($deadline / 24));
         $this->form->getItemByPostVar('dead')->setHours($deadline % 24);
         $this->tpl->setContent($this->form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilConsultationHoursGUI::executeCommand ( )

Definition at line 210 of file class.ilConsultationHoursGUI.php.

References $user_id, ILIAS\Repository\ctrl(), getProfileBackUrl(), ILIAS\Repository\help(), initAppointmentIdsFromPost(), initAppointmentIdsFromQuery(), initSearchAssignmentToAppointments(), ILIAS\Repository\lng(), and setTabs().

                                     : void
     {
         $this->help->setScreenIdComponent("cal");
         switch ($this->ctrl->getNextClass($this)) {
             case "ilpublicuserprofilegui":
                 #22168 don't send the current user if no GET user_id
                 //$profile = new ilPublicUserProfileGUI($this->user_id);
                 $profile = new ilPublicUserProfileGUI();
                 $profile->setBackUrl($this->getProfileBackUrl());
                 $ret = $this->ctrl->forwardCommand($profile);
                 $this->tpl->setContent($ret);
                 break;
 
             case 'ilrepositorysearchgui':
                 $rep_search = new ilRepositorySearchGUI();
                 if ($this->initSearchAssignmentToAppointments()) {
                     $rep_search->setCallback(
                         $this,
                         'assignUsersToAppointments',
                         array()
                     );
                     $this->ctrl->setParameter($this, 'assignM', 1);
                     $this->ctrl->setReturn($this, 'appointments');
                 } elseif (count($this->initAppointmentIdsFromPost())) {
                     $rep_search->setCallback(
                         $this,
                         'assignUsersToAppointment',
                         array()
                     );
                     $this->ctrl->saveParameter($this, 'apps');
                     $this->ctrl->setReturn($this, 'appointments');
                 } elseif ($this->initAppointmentIdsFromQuery()) {
                     $rep_search->setCallback(
                         $this,
                         'assignUsersToAppointment',
                         array()
                     );
                     $this->ctrl->saveParameter($this, 'apps');
                     $this->ctrl->setReturn($this, 'appointments');
                 }
                 $this->ctrl->forwardCommand($rep_search);
                 break;
 
             default:
                 $this->tpl->setTitle($this->lng->txt("cal_ch_form_header")); // #12220
 
                 $this->setTabs();
                 if ($this->global_user->getId() != $this->user_id) {
                     $this->ctrl->setParameter($this, 'user_id', $this->user_id);
                 }
                 $cmd = $this->ctrl->getCmd('appointments');
                 $this->$cmd();
         }
     }

Here is the call graph for this function:

◆ getProfileBackUrl()

ilConsultationHoursGUI::getProfileBackUrl ( )

protected

Build context-sensitive profile back url.

Definition at line 860 of file class.ilConsultationHoursGUI.php.

References $url, ILIAS\Repository\ctrl(), and ILIAS\FileDelivery\http().

Referenced by executeCommand(), and showProfile().

                                           : string
     {
         // from repository
         if ($this->http->wrapper()->query()->has('ref_id')) {
             $url = $this->ctrl->getLinkTargetByClass('ilCalendarMonthGUI');
         } // from panel
         elseif ($this->http->wrapper()->query()->has('panel')) {
             $url = $this->ctrl->getLinkTargetByClass('ilCalendarPresentationGUI');
         } // from appointments
         else {
             $url = $this->ctrl->getLinkTarget($this, 'appointments');
         }
         return $url;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserId()

ilConsultationHoursGUI::getUserId ( )

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

References $user_id.

Referenced by appointments(), bookingList(), createAppointments(), initAppointmentIdsFromTableAction(), saveSequence(), and setTabs().

                                : int
     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ handleBookingTableActions()

ilConsultationHoursGUI::handleBookingTableActions ( )

protected

Definition at line 942 of file class.ilConsultationHoursGUI.php.

References confirmCancelBooking(), confirmDeleteAppointments(), ILIAS\Repository\ctrl(), edit(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), searchUsersForAppointments(), and sendMailToSelectedUsers().

                                                   : void
     {
         $action = $this->http->wrapper()->query()->retrieve(
             BookingTableGUI::ACTION_TOKEN_NS,
             $this->refinery->byTrying(
                 [
                     $this->refinery->kindlyTo()->string(),
                     $this->refinery->always('')
                 ]
             )
         );
         match ($action) {
             'edit' => $this->edit(),
             'searchUsersForAppointments' => $this->searchUsersForAppointments(),
             'confirmDeleteAppointments' => $this->confirmDeleteAppointments(),
             'confirmCancelBooking' => $this->confirmCancelBooking(true),
             'confirmDeleteBooking' => $this->confirmCancelBooking(false),
             'sendMail' => $this->sendMailToSelectedUsers(),
             default => $this->ctrl->redirect($this, 'appointments')
         };
     }

Here is the call graph for this function:

◆ initAppointmentIdsFromPost()

ilConsultationHoursGUI::initAppointmentIdsFromPost ( )

protected

Definition at line 153 of file class.ilConsultationHoursGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by assignUsersToAppointment(), and executeCommand().

                                                    : array
     {
         if ($this->http->wrapper()->post()->has('apps')) {
             return $this->http->wrapper()->post()->retrieve(
                 'apps',
                 $this->refinery->kindlyTo()->dictOf(
                     $this->refinery->kindlyTo()->int()
                 )
             );
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAppointmentIdsFromPostString()

ilConsultationHoursGUI::initAppointmentIdsFromPostString ( )

protected

Definition at line 166 of file class.ilConsultationHoursGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by edit(), and updateMulti().

                                                          : array
     {
         if ($this->http->wrapper()->post()->has('apps_string')) {
             $app_string = $this->http->wrapper()->post()->retrieve(
                 'apps_string',
                 $this->refinery->kindlyTo()->string()
             );
             return array_map('intval', explode(';', $app_string));
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAppointmentIdsFromQuery()

ilConsultationHoursGUI::initAppointmentIdsFromQuery ( )

protected

Definition at line 145 of file class.ilConsultationHoursGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by assignUsersToAppointment(), and executeCommand().

                                                     : array
     {
         if ($this->http->wrapper()->query()->has('apps')) {
             return [$this->http->wrapper()->query()->retrieve('apps', $this->refinery->kindlyTo()->int())];
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAppointmentIdsFromTableAction()

ilConsultationHoursGUI::initAppointmentIdsFromTableAction ( )

protected

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

References ilConsultationHourAppointments\getAppointmentIds(), getUserId(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmCancelBooking(), confirmDeleteAppointments(), edit(), searchUsersForAppointments(), and sendMailToSelectedUsers().

                                                           : array
     {
         $current_user_id = $this->getUserId();
         return $this->http->wrapper()->query()->retrieve(
             BookingTableGUI::ID_TOKEN_NS,
             $this->refinery->byTrying(
                 [
                     $this->refinery->custom()->transformation(function ($value) use ($current_user_id) {
                         if ($value !== ['ALL_OBJECTS']) {
                             throw new Exception('Invalid token');
                         }
                         return ilConsultationHourAppointments::getAppointmentIds($current_user_id);
                     }),
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                     $this->refinery->always([])
                 ]
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBookingUsersFromPost()

ilConsultationHoursGUI::initBookingUsersFromPost ( )

protected

Returns: string[]

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by assignUsersToAppointment(), and confirmRejectBooking().

                                                  : array
     {
         if ($this->http->wrapper()->post()->has('bookuser')) {
             return $this->http->wrapper()->post()->retrieve(
                 'bookuser',
                 $this->refinery->kindlyTo()->dictOf(
                     $this->refinery->kindlyTo()->string()
                 )
             );
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initBookingUsersFromQuery()

ilConsultationHoursGUI::initBookingUsersFromQuery ( )

protected

Returns: string[]

Definition at line 197 of file class.ilConsultationHoursGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by confirmRejectBooking().

                                                   : array
     {
         if ($this->http->wrapper()->query()->has('bookuser')) {
             return [
                 $this->http->wrapper()->query()->retrieve(
                     'bookuser',
                     $this->refinery->kindlyTo()->string()
                 )
             ];
         }
         return [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormSequence()

ilConsultationHoursGUI::initFormSequence ( int $a_mode )

protected

Todo:: get rid of $this->form

Definition at line 462 of file class.ilConsultationHoursGUI.php.

References $form, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilCalendarRecurrence\FREQ_DAILY, ilCalendarRecurrence\FREQ_MONTHLY, ilCalendarRecurrence\FREQ_WEEKLY, ilYuiUtil\initDomEvent(), ILIAS\Repository\lng(), ilRecurrenceInputGUI\setEnabledSubForms(), ilFormPropertyGUI\setInfo(), ilTextAreaInputGUI\setRows(), ilDurationInputGUI\setShowMinutes(), ilDateTimeInputGUI\setShowTime(), and ilNumberInputGUI\setSize().

Referenced by createSequence(), edit(), saveSequence(), and updateMulti().

                                                     : ilPropertyFormGUI
     {
         ilYuiUtil::initDomEvent();
 
         $this->form = new ilPropertyFormGUI();
         $this->form->setFormAction($this->ctrl->getFormAction($this));
 
         switch ($a_mode) {
             case self::MODE_CREATE:
                 $this->form->setTitle($this->lng->txt('cal_ch_add_sequence'));
                 $this->form->addCommandButton('saveSequence', $this->lng->txt('save'));
                 $this->form->addCommandButton('appointments', $this->lng->txt('cancel'));
                 break;
 
             case self::MODE_MULTI:
                 $this->form->setTitle($this->lng->txt('cal_ch_multi_edit_sequence'));
                 $this->form->addCommandButton('updateMulti', $this->lng->txt('save'));
                 $this->form->addCommandButton('appointments', $this->lng->txt('cancel'));
                 break;
         }
 
         // Title
         $ti = new ilTextInputGUI($this->lng->txt('title'), 'ti');
         $ti->setSize(32);
         $ti->setMaxLength(128);
         $ti->setRequired(true);
         $this->form->addItem($ti);
 
         if ($a_mode != self::MODE_MULTI) {
             // Start
             $dur = new ilDateTimeInputGUI($this->lng->txt('cal_start'), 'st');
             $dur->setShowTime(true);
             $dur->setRequired(true);
             $this->form->addItem($dur);
 
             // Duration
             $du = new ilDurationInputGUI($this->lng->txt('cal_ch_duration'), 'du');
             $du->setShowMinutes(true);
             $du->setShowHours(true);
             $this->form->addItem($du);
 
             // Number of appointments
             $nu = new ilNumberInputGUI($this->lng->txt('cal_ch_num_appointments'), 'ap');
             $nu->setInfo($this->lng->txt('cal_ch_num_appointments_info'));
             $nu->setSize(2);
             $nu->setMaxLength(2);
             $nu->setRequired(true);
             $nu->setMinValue(1);
             $this->form->addItem($nu);
 
             // Recurrence
             $rec = new ilRecurrenceInputGUI($this->lng->txt('cal_recurrences'), 'frequence');
             $rec->setEnabledSubForms(
                 array(
                     ilCalendarRecurrence::FREQ_DAILY,
                     ilCalendarRecurrence::FREQ_WEEKLY,
                     ilCalendarRecurrence::FREQ_MONTHLY
                 )
             );
             $this->form->addItem($rec);
         }
 
         // Number of bookings
         $nu = new ilNumberInputGUI($this->lng->txt('cal_ch_num_bookings'), 'bo');
         $nu->setSize(2);
         $nu->setMaxLength(2);
         $nu->setMinValue(1);
         $nu->setRequired(true);
         $this->form->addItem($nu);
 
         // Deadline
         $dead = new ilDurationInputGUI($this->lng->txt('cal_ch_deadline'), 'dead');
         $dead->setInfo($this->lng->txt('cal_ch_deadline_info'));
         $dead->setShowMinutes(false);
         $dead->setShowHours(true);
         $dead->setShowDays(true);
         $this->form->addItem($dead);
 
         // Location
         $lo = new ilTextInputGUI($this->lng->txt('cal_where'), 'lo');
         $lo->setSize(32);
         $lo->setMaxLength(128);
         $this->form->addItem($lo);
 
         // Description
         $de = new ilTextAreaInputGUI($this->lng->txt('description'), 'de');
         $de->setRows(10);
         $de->setCols(60);
         $this->form->addItem($de);
 
         // Target Object
         $tgt = new ilTextInputGUI($this->lng->txt('cal_ch_target_object'), 'tgt');
         $tgt->setInfo($this->lng->txt('cal_ch_target_object_info'));
         $tgt->setSize(16);
         $tgt->setMaxLength(128);
         $this->form->addItem($tgt);
         return $this->form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSearchAssignmentToAppointments()

ilConsultationHoursGUI::initSearchAssignmentToAppointments ( $a_default = false )

protected

Definition at line 113 of file class.ilConsultationHoursGUI.php.

References $search_assignment_to_appointments, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                                                              : bool
     {
         $this->search_assignment_to_appointments = $a_default;
         if ($this->http->wrapper()->query()->has('assignM')) {
             $this->search_assignment_to_appointments = $this->http->wrapper()->query()->retrieve(
                 'assignM',
                 $this->refinery->kindlyTo()->bool()
             );
         }
         return $this->search_assignment_to_appointments;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSequenceCreation()

ilConsultationHoursGUI::initSequenceCreation ( )

protected

Definition at line 1139 of file class.ilConsultationHoursGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by renderViewControl().

                                              : ILIAS\UI\Component\Component
     {
         $add_sequence_button = $this->ui_factory->button()->standard(
             $this->lng->txt('cal_ch_add_sequence'),
             $this->ctrl->getLinkTarget($this, 'createSequence')
         );
         return $add_sequence_button;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsForm()

ilConsultationHoursGUI::initSettingsForm ( )

protected

build settings form

Definition at line 890 of file class.ilConsultationHoursGUI.php.

References $form, ilPropertyFormGUI\addCommandButton(), ilPropertyFormGUI\addItem(), ILIAS\Repository\ctrl(), ilConsultationHourAppointments\getManager(), ILIAS\Repository\lng(), ilFormGUI\setFormAction(), and ilPropertyFormGUI\setTitle().

Referenced by settings(), and updateSettings().

                                          : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this));
 
         $mng = new ilTextInputGUI($this->lng->txt('cal_ch_manager'), 'mng');
         $mng->setInfo($this->lng->txt('cal_ch_manager_info'));
         $form->addItem($mng);
 
         $mng->setValue(ilConsultationHourAppointments::getManager(true));
 
         $form->setTitle($this->lng->txt('settings'));
         $form->addCommandButton('updateSettings', $this->lng->txt('save'));
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initViewMode()

ilConsultationHoursGUI::initViewMode ( )

protected

Definition at line 1205 of file class.ilConsultationHoursGUI.php.

References $DIC, ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by appointments().

                                      : void
     {
         global $DIC;
 
         $user = $DIC->user();
         $vm_period = $this->http->wrapper()->query()->retrieve(
             'vm_period',
             $this->refinery->byTrying(
                 [
                     $this->refinery->kindlyTo()->string(),
                     $this->refinery->always('')
                 ]
             )
         );
         $vm_status = $this->http->wrapper()->query()->retrieve(
             'vm_status',
             $this->refinery->byTrying(
                 [
                     $this->refinery->kindlyTo()->string(),
                     $this->refinery->always('')
                 ]
             )
         );
 
         if ($vm_period !== '') {
             $user->writePref('cal_ch_vm_period', $vm_period);
         }
         if ($vm_status !== '') {
             $user->writePref('cal_ch_vm_status', $vm_status);
         }
         $this->vm_period = $user->getPref('cal_ch_vm_period') ? $user->getPref('cal_ch_vm_period') : self::VIEW_MODE_PERIOD_ALL;
         $this->vm_status = $user->getPref('cal_ch_vm_status') ? $user->getPref('cal_ch_vm_status') : self::VIEW_MODE_STATUS_ALL;
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderViewControl()

ilConsultationHoursGUI::renderViewControl ( )

protected

Definition at line 1148 of file class.ilConsultationHoursGUI.php.

References ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), ILIAS\Repository\ctrl(), initSequenceCreation(), and ILIAS\Repository\lng().

Referenced by appointments().

                                           : string
     {
         $toolbar = new ilToolbarGUI();
         $toolbar->addComponent($this->initSequenceCreation());
         $toolbar->addSeparator();
 
         $this->ctrl->setParameter($this, 'vm_period', self::VIEW_MODE_PERIOD_PAST);
         $actions[$this->lng->txt('cal_ch_vm_period_' . self::VIEW_MODE_PERIOD_PAST)] = $this->ctrl->getLinkTarget(
             $this,
             'appointments'
         );
         $this->ctrl->setParameter($this, 'vm_period', self::VIEW_MODE_PERIOD_UPCOMING);
         $actions[$this->lng->txt('cal_ch_vm_period_' . self::VIEW_MODE_PERIOD_UPCOMING)] = $this->ctrl->getLinkTarget(
             $this,
             'appointments'
         );
         $this->ctrl->setParameter($this, 'vm_period', self::VIEW_MODE_PERIOD_ALL);
         $actions[$this->lng->txt('cal_ch_vm_period_' . self::VIEW_MODE_PERIOD_ALL)] = $this->ctrl->getLinkTarget(
             $this,
             'appointments'
         );
         $this->ctrl->setParameter($this, 'vm_period', '');
 
         $view_control_period = $this->ui_factory->viewControl()->mode(
             $actions,
             $this->lng->txt('meta_aria_language_selection')
         )->withActive($this->lng->txt('cal_ch_vm_period_' . $this->vm_period));
 
         $toolbar->addComponent($view_control_period);
 
         $actions = [];
         $this->ctrl->setParameter($this, 'vm_status', self::VIEW_MODE_STATUS_OPEN);
         $actions[$this->lng->txt('cal_ch_vm_status_' . self::VIEW_MODE_STATUS_OPEN)] = $this->ctrl->getLinkTarget(
             $this,
             'appointments'
         );
         $this->ctrl->setParameter($this, 'vm_status', self::VIEW_MODE_STATUS_BOOKED);
         $actions[$this->lng->txt('cal_ch_vm_status_' . self::VIEW_MODE_STATUS_BOOKED)] = $this->ctrl->getLinkTarget(
             $this,
             'appointments'
         );
         $this->ctrl->setParameter($this, 'vm_status', self::VIEW_MODE_STATUS_ALL);
         $actions[$this->lng->txt('cal_ch_vm_status_' . self::VIEW_MODE_STATUS_ALL)] = $this->ctrl->getLinkTarget(
             $this,
             'appointments'
         );
         $this->ctrl->setParameter($this, 'vm_status', '');
 
         $view_control_status = $this->ui_factory->viewControl()->mode(
             $actions,
             $this->lng->txt('meta_aria_language_selection')
         )->withActive($this->lng->txt('cal_ch_vm_status_' . $this->vm_status));
 
         $toolbar->addComponent($view_control_status);
         return $toolbar->getHTML();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rewriteBookingIdsForAppointments()

ilConsultationHoursGUI::rewriteBookingIdsForAppointments	(	ilBookingEntry	$booking,
		array	$appointments,
		ilPropertyFormGUI	$form
	)

protected

Definition at line 776 of file class.ilConsultationHoursGUI.php.

References ilConsultationHourUtils\findCalendarAppointmentsForBooking(), ilBookingEntry\getId(), ilPropertyFormGUI\getInput(), and ilBookingEntry\getInstanceByCalendarEntryId().

Referenced by updateMulti().

      : void {
         foreach ($appointments as $appointment_id) {
             $booking_appointment = new \ilCalendarEntry($appointment_id);
             $booking_start = $booking_appointment->getStart();
             $booking_end = $booking_appointment->getEnd();
 
             $deprecatedBooking = \ilBookingEntry::getInstanceByCalendarEntryId($appointment_id);
             if (!$deprecatedBooking instanceof \ilBookingEntry) {
                 // @todo error handling
                 continue;
             }
 
             $relevant_appointments = \ilConsultationHourUtils::findCalendarAppointmentsForBooking(
                 $deprecatedBooking,
                 $booking_start,
                 $booking_end
             );
             foreach ($relevant_appointments as $relevant_appointment_id) {
                 $entry = new \ilCalendarEntry($relevant_appointment_id);
                 $entry->setContextId($booking->getId());
                 $entry->setTitle($form->getInput('ti'));
                 $entry->setLocation($form->getInput('lo'));
                 $entry->setDescription($form->getInput('de'));
                 $entry->update();
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveSequence()

ilConsultationHoursGUI::saveSequence ( )

protected

Save new sequence.

Definition at line 564 of file class.ilConsultationHoursGUI.php.

References $ref_id, ilObject\_lookupObjId(), ilObject\_lookupType(), createAppointments(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getUserId(), initFormSequence(), ILIAS\Repository\lng(), ilBookingEntry\save(), ilBookingEntry\setDeadlineHours(), ilBookingEntry\setNumberOfBookings(), ilBookingEntry\setObjId(), and ilBookingEntry\setTargetObjIds().

                                      : void
     {
         $this->initFormSequence(self::MODE_CREATE);
 
         if ($this->form->checkInput()) {
             $this->form->setValuesByPost();
 
             $booking = new ilBookingEntry();
             $booking->setObjId($this->getUserId());
             $booking->setNumberOfBookings((int) $this->form->getInput('bo'));
 
             $deadline = $this->form->getInput('dead');
             $deadline = $deadline['dd'] * 24 + $deadline['hh'];
             $booking->setDeadlineHours($deadline);
 
             $tgt = array_map('intval', explode(',', $this->form->getInput('tgt')));
             $obj_ids = array();
             foreach ($tgt as $ref_id) {
                 if ($ref_id === 0) {
                     continue;
                 }
                 $obj_id = ilObject::_lookupObjId($ref_id);
                 $type = ilObject::_lookupType($obj_id);
                 $valid_types = array('crs', 'grp');
                 if (!$obj_id or !in_array($type, $valid_types)) {
                     $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cal_ch_unknown_repository_object'));
                     $this->tpl->setContent($this->form->getHTML());
                     return;
                 }
 
                 $obj_ids[] = $obj_id;
             }
             $booking->setTargetObjIds($obj_ids);
             $booking->save();
             $this->createAppointments($booking);
             $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
             $this->ctrl->redirect($this, 'appointments');
         } else {
             $this->form->setValuesByPost();
             $this->tpl->setContent($this->form->getHTML());
         }
     }

Here is the call graph for this function:

◆ searchUsersForAppointments()

ilConsultationHoursGUI::searchUsersForAppointments ( )

protected

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

References ILIAS\Repository\ctrl(), initAppointmentIdsFromTableAction(), ILIAS\Repository\lng(), and ilSession\set().

Referenced by handleBookingTableActions().

                                                    : void
     {
         $apps = $this->initAppointmentIdsFromTableAction();
         if ($apps === []) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'appointments');
         }
         ilSession::set('ch_apps', $apps);
         $this->ctrl->setParameterByClass(ilConsultationHoursGUI::class, 'assignM', 1);
         $this->ctrl->redirectByClass(ilRepositorySearchGUI::class, '');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendInfoAboutUnassignedUsers()

ilConsultationHoursGUI::sendInfoAboutUnassignedUsers ( array $unassigned )

protected

Send info message about unassigned users.

Parameters

int[] $unassigned

Definition at line 286 of file class.ilConsultationHoursGUI.php.

References ilObjUser\_lookupFullname(), and ILIAS\Repository\lng().

Referenced by assignUsersToAppointment(), and assignUsersToAppointments().

                                                                       : bool
     {
         if (!$unassigned) {
             return true;
         }
         $users = array();
         foreach ($unassigned as $user_id) {
             $users[] = ilObjUser::_lookupFullname($user_id);
         }
         $this->tpl->setOnScreenMessage('info', $this->lng->txt('cal_ch_user_assignment_failed_info') .
         '<br />' . implode('<br />', $users), true);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendMailToSelectedUsers()

ilConsultationHoursGUI::sendMailToSelectedUsers ( )

protected

Definition at line 964 of file class.ilConsultationHoursGUI.php.

References ilObjUser\_lookupLogin(), appointments(), ILIAS\Repository\ctrl(), ilBookingEntry\getCurrentBookings(), ilMailFormCall\getRedirectTarget(), initAppointmentIdsFromTableAction(), and ILIAS\Repository\lng().

Referenced by handleBookingTableActions().

                                                 : void
     {
         $appointment_ids = $this->initAppointmentIdsFromTableAction();
         if ($appointment_ids === []) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->appointments();
             return;
         }
 
         $bookusers = [];
         foreach ($appointment_ids as $appointment_id) {
             $entry = new ilCalendarEntry($appointment_id);
             $booking = new ilBookingEntry($entry->getContextId());
             foreach ($booking->getCurrentBookings($entry->getEntryId()) as $bookuser) {
                 $login = ilObjUser::_lookupLogin($bookuser);
                 if (!in_array($login, $bookusers)) {
                     $bookusers[] = $login;
                 }
             }
         }
         $this->ctrl->redirectToURL(
             ilMailFormCall::getRedirectTarget(
                 $this,
                 'appointments',
                 [],
                 [
                     'type' => 'new',
                     'rcp_to' => implode(',', $bookusers)
                 ]
             )
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTabs()

ilConsultationHoursGUI::setTabs ( )

protected

Definition at line 678 of file class.ilConsultationHoursGUI.php.

References ILIAS\Repository\ctrl(), ilConsultationHourAppointments\getManagedUsers(), getUserId(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by executeCommand().

                                 : void
     {
         $this->ctrl->setParameter($this, 'user_id', '');
         $this->tabs->addTab(
             'consultation_hours_' . $this->user_id,
             $this->lng->txt('cal_ch_ch'),
             $this->ctrl->getLinkTarget($this, 'appointments')
         );
 
         foreach (ilConsultationHourAppointments::getManagedUsers() as $user_id => $login) {
             $this->ctrl->setParameter($this, 'user_id', $user_id);
             $this->tabs->addTab(
                 'consultation_hours_' . $user_id,
                 $this->lng->txt('cal_ch_ch') . ': ' . $login,
                 $this->ctrl->getLinkTarget($this, 'appointments')
             );
         }
         $this->ctrl->setParameter($this, 'user_id', '');
         $this->tabs->addTab('ch_settings', $this->lng->txt('settings'), $this->ctrl->getLinkTarget($this, 'settings'));
         $this->tabs->activateTab('consultation_hours_' . $this->getUserId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

ilConsultationHoursGUI::settings ( )

display settings gui

Definition at line 878 of file class.ilConsultationHoursGUI.php.

References ilPropertyFormGUI\getHTML(), ILIAS\Repository\help(), initSettingsForm(), and ILIAS\Repository\tabs().

                               : void
     {
         $this->help->setScreenId("consultation_hours_settings");
         $this->tabs->activateTab('ch_settings');
 
         $form = $this->initSettingsForm();
         $this->tpl->setContent($form->getHTML());
     }

Here is the call graph for this function:

◆ showProfile()

ilConsultationHoursGUI::showProfile ( )

show public profile of given user

Definition at line 841 of file class.ilConsultationHoursGUI.php.

References ILIAS\Repository\ctrl(), getProfileBackUrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

                                  : void
     {
         $this->tabs->clearTargets();
 
         $user_id = 0;
         if ($this->http->wrapper()->query()->has('user')) {
             $user_id = $this->http->wrapper()->query()->retrieve(
                 'user',
                 $this->refinery->kindlyTo()->int()
             );
         }
         $profile = new ilPublicUserProfileGUI($user_id);
         $profile->setBackUrl($this->getProfileBackUrl());
         $this->tpl->setContent($this->ctrl->getHTML($profile));
     }

Here is the call graph for this function:

◆ updateMulti()

ilConsultationHoursGUI::updateMulti ( )

protected

Update multiple sequence items.

Definition at line 811 of file class.ilConsultationHoursGUI.php.

References createNewBookingEntry(), ILIAS\Repository\ctrl(), edit(), ILIAS\Repository\form(), initAppointmentIdsFromPostString(), initFormSequence(), ILIAS\Repository\lng(), ilBookingEntry\removeObsoleteEntries(), and rewriteBookingIdsForAppointments().

                                     : void
     {
         $this->initFormSequence(self::MODE_MULTI);
         if (!$this->form->checkInput()) {
             $this->form->setValuesByPost();
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
             $this->edit();
             return;
         }
 
         $this->form->setValuesByPost();
         $apps = $this->initAppointmentIdsFromPostString();
 
         // create new booking
         $booking = $this->createNewBookingEntry($this->form);
         if (!$booking instanceof \ilBookingEntry) {
             $this->edit();
             return;
         }
         $this->rewriteBookingIdsForAppointments($booking, $apps, $this->form);
         ilBookingEntry::removeObsoleteEntries();
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
         $this->ctrl->redirect($this, 'appointments');
         $this->tpl->setContent($this->form->getHTML());
     }

Here is the call graph for this function:

◆ updateSettings()

ilConsultationHoursGUI::updateSettings ( )

save settings

Definition at line 909 of file class.ilConsultationHoursGUI.php.

References ilPropertyFormGUI\checkInput(), ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), initSettingsForm(), ILIAS\Repository\lng(), ilConsultationHourAppointments\setManager(), and ILIAS\Repository\tabs().

                                     : void
     {
         $form = $this->initSettingsForm();
         if ($form->checkInput()) {
             $mng = $form->getInput('mng');
             if (ilConsultationHourAppointments::setManager($mng)) {
                 $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
                 $this->ctrl->redirect($this, 'settings');
             } else {
                 $this->tabs->activateTab('ch_settings');
 
                 $this->tpl->setOnScreenMessage('failure', $this->lng->txt('cal_ch_unknown_user'));
                 $field = $form->getItemByPostVar('mng');
                 $field->setValue($mng);
                 $this->tpl->setContent($form->getHTML());
                 return;
             }
         }
     }