Class ilEmployeeTalkAppointmentGUI. More...

Inheritance diagram for ilEmployeeTalkAppointmentGUI:

Collaboration diagram for ilEmployeeTalkAppointmentGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $template, ilLanguage $language, ilCtrl $controlFlow, HttpServices $http, Refinery $refinery, ilTabsGUI $tabs, NotificationHandlerInterface $notif_handler, ilObjEmployeeTalk $talk)
	ilEmployeeTalkAppointmentGUI constructor. More...

	executeCommand ()

Data Fields
const	EDIT_MODE_APPOINTMENT = 'appointment'

const	EDIT_MODE_SERIES = 'series'

const	EDIT_MODE = 'edit-mode'

Protected Member Functions
	getPendingTalkDates ()

Protected Attributes
NotificationHandlerInterface	$notif_handler

Private Member Functions
	executeSeriesCommand (string $cmd)

	executeAppointmentCommand (string $cmd)

	editSeries ()

	updateSeries ()

	initTalkEditForm (?EmployeeTalk $employeeTalk=null)

	initSeriesEditForm (?EmployeeTalk $employeeTalk=null)

	editAppointment ()

	sendNotification (ilObjEmployeeTalk ... $talks)

	editMode ()

	getEditModeParameter (string $mode)

	loadRecurrenceSettings (ilPropertyFormGUI $form)
	load recurrence settings More...

	getPendingTalksInSeries (ilObjEmployeeTalkSeries $series)

	deleteTalks (array $talks)

Private Attributes
ilGlobalTemplateInterface	$template

ilLanguage	$language

ilCtrl	$controlFlow

HttpServices	$http

Refinery	$refinery

ilTabsGUI	$tabs

ilObjEmployeeTalk	$talk

Detailed Description

Class ilEmployeeTalkAppointmentGUI.

ilEmployeeTalkAppointmentGUI: ilObjEmployeeTalkGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilEmployeeTalkAppointmentGUI::__construct	(	ilGlobalTemplateInterface	$template,
		ilLanguage	$language,
		ilCtrl	$controlFlow,
		HttpServices	$http,
		Refinery	$refinery,
		ilTabsGUI	$tabs,
		NotificationHandlerInterface	$notif_handler,
		ilObjEmployeeTalk	$talk
	)

ilEmployeeTalkAppointmentGUI constructor.

Parameters

ilGlobalTemplateInterface	$template
ilLanguage	$language
ilCtrl	$controlFlow
ilTabsGUI	$tabs
ilObjEmployeeTalk	$talk

Definition at line 59 of file class.ilEmployeeTalkAppointmentGUI.php.

References $controlFlow, $http, $language, $notif_handler, $refinery, $tabs, $talk, $template, ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

       {
         $this->template = $template;
         $this->language = $language;
         $this->controlFlow = $controlFlow;
         $this->http = $http;
         $this->refinery = $refinery;
         $this->tabs = $tabs;
         $this->notif_handler = $notif_handler;
         $this->talk = $talk;
 
         $this->language->loadLanguageModule('cal');
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteTalks()

ilEmployeeTalkAppointmentGUI::deleteTalks ( array $talks )

private

Parameters

ilObjEmployeeTalk[] $talks

Definition at line 560 of file class.ilEmployeeTalkAppointmentGUI.php.

References $data, ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by updateSeries().

                                               : void
     {
         foreach ($talks as $talk) {
             $talk->delete();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editAppointment()

ilEmployeeTalkAppointmentGUI::editAppointment ( )

private

Definition at line 276 of file class.ilEmployeeTalkAppointmentGUI.php.

References $data, EDIT_MODE_APPOINTMENT, getEditModeParameter(), IL_CAL_UNIX, initTalkEditForm(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), sendNotification(), and ilTimeZone\UTC.

Referenced by executeAppointmentCommand().

                                       : void
     {
         $form = $this->initTalkEditForm($this->talk->getData());
 
         $this->template->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editMode()

ilEmployeeTalkAppointmentGUI::editMode ( )

private

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

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

Referenced by executeCommand().

                                : string
     {
         $mode = '';
         if ($this->http->wrapper()->query()->has(self::EDIT_MODE)) {
             $mode = $this->http->wrapper()->query()->retrieve(
                 self::EDIT_MODE,
                 $this->refinery->kindlyTo()->string()
             );
         }
         if ($mode === self::EDIT_MODE_SERIES || $mode === self::EDIT_MODE_APPOINTMENT) {
             return $mode;
         }
         return 'invalid';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ editSeries()

ilEmployeeTalkAppointmentGUI::editSeries ( )

private

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

References $message, getPendingTalkDates(), initSeriesEditForm(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeSeriesCommand().

                                  : void
     {
         if (($dates_string = $this->getPendingTalkDates()) !== '') {
             $message = $this->language->txt('pending_talks_warning');
             $this->template->setOnScreenMessage('info', $message . $dates_string);
         }
         $form = $this->initSeriesEditForm($this->talk->getData());
 
         $this->template->setContent($form->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeAppointmentCommand()

ilEmployeeTalkAppointmentGUI::executeAppointmentCommand ( string $cmd )

private

Definition at line 131 of file class.ilEmployeeTalkAppointmentGUI.php.

References editAppointment(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by executeCommand().

                                                            : bool
     {
         $this->template->setTitle($this->language->txt('etal_date_appointment_edit'));
 
         switch ($cmd) {
             case ControlFlowCommand::UPDATE_INDEX:
                 $this->editAppointment();
                 return true;
             case ControlFlowCommand::UPDATE:
                 $this->updateAppointment();
                 return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilEmployeeTalkAppointmentGUI::executeCommand ( )

Implements ILIAS\EmployeeTalk\UI\ControlFlowCommandHandler.

Definition at line 81 of file class.ilEmployeeTalkAppointmentGUI.php.

References $ref_id, ILIAS\Forum\Notification\DEFAULT, editMode(), executeAppointmentCommand(), executeSeriesCommand(), ILIAS\FileDelivery\http(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

                                     : void
     {
         $cmd = $this->controlFlow->getCmd(ControlFlowCommand::DEFAULT);
         if ($this->http->wrapper()->query()->has('ref_id')) {
             $ref_id = $this->http->wrapper()->query()->retrieve(
                 'ref_id',
                 $this->refinery->kindlyTo()->int()
             );
         } else {
             throw new ilEmployeeTalkAppointmentException(
                 'No ref_id found'
             );
         }
 
         $backClass = strtolower(ilObjEmployeeTalkGUI::class);
         $this->controlFlow->setParameterByClass($backClass, 'ref_id', $ref_id);
         $this->tabs->setBackTarget(
             $this->language->txt('back'),
             $this->controlFlow->getLinkTargetByClass(strtolower(ilObjEmployeeTalkGUI::class), ControlFlowCommand::UPDATE)
         );
 
         switch ($this->editMode()) {
             case self::EDIT_MODE_SERIES:
                 $this->executeSeriesCommand($cmd);
                 break;
             case self::EDIT_MODE_APPOINTMENT:
                 $this->executeAppointmentCommand($cmd);
                 break;
             default:
                 $this->controlFlow->redirectByClass(strtolower(ilObjEmployeeTalkGUI::class), ControlFlowCommand::UPDATE);
                 break;
         }
     }

Here is the call graph for this function:

◆ executeSeriesCommand()

ilEmployeeTalkAppointmentGUI::executeSeriesCommand ( string $cmd )

private

Definition at line 115 of file class.ilEmployeeTalkAppointmentGUI.php.

References editSeries(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and updateSeries().

Referenced by executeCommand().

                                                       : bool
     {
         $this->template->setTitle($this->language->txt('etal_date_series_edit'));
 
         switch ($cmd) {
             case ControlFlowCommand::UPDATE_INDEX:
                 $this->editSeries();
                 return true;
             case ControlFlowCommand::UPDATE:
                 $this->updateSeries();
                 return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEditModeParameter()

ilEmployeeTalkAppointmentGUI::getEditModeParameter ( string $mode )

private

Definition at line 345 of file class.ilEmployeeTalkAppointmentGUI.php.

References EDIT_MODE.

Referenced by editAppointment(), initSeriesEditForm(), initTalkEditForm(), and updateSeries().

                                                        : string
     {
         return '&' . ilEmployeeTalkAppointmentGUI::EDIT_MODE . '=' . $mode;
     }

Here is the caller graph for this function:

◆ getPendingTalkDates()

ilEmployeeTalkAppointmentGUI::getPendingTalkDates ( )

protected

Definition at line 158 of file class.ilEmployeeTalkAppointmentGUI.php.

References Vendor\Package\$a, Vendor\Package\$b, ilDatePresentation\formatDate(), ilObjEmployeeTalk\getData(), getPendingTalksInSeries(), ilDatePresentation\setUseRelativeDates(), and ilDatePresentation\useRelativeDates().

Referenced by editSeries().

                                             : string
     {
         $parent = $this->talk->getParent();
         $talks = $this->getPendingTalksInSeries($parent);
 
         usort($talks, function (ilObjEmployeeTalk $a, ilObjEmployeeTalk $b) {
             $a = $a->getData()->getStartDate()->getUnixTime();
             $b = $b->getData()->getStartDate()->getUnixTime();
             if ($a === $b) {
                 return 0;
             }
             return $a < $b ? -1 : 1;
         });
 
         $dates = '';
         $rel = ilDatePresentation::useRelativeDates();
         ilDatePresentation::setUseRelativeDates(false);
         foreach ($talks as $talk) {
             $dates .= "</br>" . ilDatePresentation::formatDate($talk->getData()->getStartDate());
         }
         ilDatePresentation::setUseRelativeDates($rel);
         return $dates;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPendingTalksInSeries()

ilEmployeeTalkAppointmentGUI::getPendingTalksInSeries ( ilObjEmployeeTalkSeries $series )

private

Returns: ilObjEmployeeTalk[]

Definition at line 537 of file class.ilEmployeeTalkAppointmentGUI.php.

References $refId, $talk, ilObjEmployeeTalk\getData(), and ilContainer\getSubItems().

Referenced by getPendingTalkDates(), and updateSeries().

                                                                              : array
     {
         $talks = [];
         $subItems = $series->getSubItems()['_all'];
 
         foreach ($subItems as $subItem) {
             if ($subItem['type'] === 'etal') {
                 $refId = intval($subItem['ref_id']);
                 $talk = new ilObjEmployeeTalk($refId, true);
                 $talk_data = $talk->getData();
                 if ($talk_data->isStandalone() || $talk_data->isCompleted()) {
                     continue;
                 }
                 $talks[] = $talk;
             }
         }
 
         return $talks;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSeriesEditForm()

ilEmployeeTalkAppointmentGUI::initSeriesEditForm ( ?EmployeeTalk $employeeTalk = null )

private

Definition at line 235 of file class.ilEmployeeTalkAppointmentGUI.php.

References EDIT_MODE_SERIES, getEditModeParameter(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by editSeries(), and updateSeries().

                                                                            : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $editMode = $this->getEditModeParameter(ilEmployeeTalkAppointmentGUI::EDIT_MODE_SERIES);
         $form->setFormAction($this->controlFlow->getFormActionByClass(
             strtolower(self::class)
         ) . $editMode);
 
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->language->txt('appointments'));
         $form->addItem($header);
 
         $dur = new ilDateDurationInputGUI($this->language->txt('cal_fullday'), 'event');
         $dur->setRequired(true);
         $dur->setShowTime(true);
 
         if ($employeeTalk !== null) {
             $dur->enableToggleFullTime(
                 $this->language->txt('cal_fullday_title'),
                 $employeeTalk->isAllDay()
             );
 
             $dur->setStart($employeeTalk->getStartDate());
             $dur->setEnd($employeeTalk->getEndDate());
         }
 
         $form->addItem($dur);
 
         // Recurrence
         $cal = new ilRecurrenceInputGUI($this->language->txt('cal_recurrences'), "frequence");
         $event = new ilCalendarRecurrence();
 
         $cal->allowUnlimitedRecurrences(false);
         $cal->setRecurrence($event);
 
         $form->addItem($cal);
         $form->addCommandButton(ControlFlowCommand::UPDATE, $this->language->txt('save'), 'etal_series_save');
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initTalkEditForm()

ilEmployeeTalkAppointmentGUI::initTalkEditForm ( ?EmployeeTalk $employeeTalk = null )

private

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

References EDIT_MODE_APPOINTMENT, getEditModeParameter(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by editAppointment().

                                                                          : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $editMode = $this->getEditModeParameter(ilEmployeeTalkAppointmentGUI::EDIT_MODE_APPOINTMENT);
         $form->setFormAction($this->controlFlow->getFormActionByClass(
             strtolower(self::class)
         ) . $editMode);
 
         $header = new ilFormSectionHeaderGUI();
         $header->setTitle($this->language->txt('appointment'));
         $form->addItem($header);
 
         $dur = new ilDateDurationInputGUI($this->language->txt('cal_fullday'), 'event');
         $dur->setRequired(true);
         $dur->setShowTime(true);
 
         if ($employeeTalk !== null) {
             $dur->enableToggleFullTime(
                 $this->language->txt('cal_fullday_title'),
                 $employeeTalk->isAllDay()
             );
 
             $dur->setStart($employeeTalk->getStartDate());
             $dur->setEnd($employeeTalk->getEndDate());
         }
 
         $form->addItem($dur);
         $form->addCommandButton(ControlFlowCommand::UPDATE, $this->language->txt('save'), 'etal_date_save');
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRecurrenceSettings()

ilEmployeeTalkAppointmentGUI::loadRecurrenceSettings ( ilPropertyFormGUI $form )

private

load recurrence settings

protected

Returns

Definition at line 356 of file class.ilEmployeeTalkAppointmentGUI.php.

References $data, ilCalendarRecurrence\FREQ_DAILY, ilCalendarRecurrence\FREQ_MONTHLY, ilCalendarRecurrence\FREQ_WEEKLY, ilCalendarRecurrence\FREQ_YEARLY, ilCalendarRecurrence\getFrequenceType(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), ilObject\getOwner(), ilObject\getRefId(), IL_CAL_UNIX, IL_CAL_YEAR, sendNotification(), ilUtil\stripSlashes(), ilObjEmployeeTalk\TYPE, and ilTimeZone\UTC.

Referenced by updateSeries().

                                                                     : ilCalendarRecurrence
     {
         $rec = new ilCalendarRecurrence();
 
         switch ($form->getInput('frequence')) {
             case ilCalendarRecurrence::FREQ_DAILY:
                 $rec->setFrequenceType($form->getInput('frequence'));
                 $rec->setInterval((int) $form->getInput('count_DAILY'));
                 break;
 
             case ilCalendarRecurrence::FREQ_WEEKLY:
                 $rec->setFrequenceType($form->getInput('frequence'));
                 $rec->setInterval((int) $form->getInput('count_WEEKLY'));
                 if (is_array($form->getInput('byday_WEEKLY'))) {
                     $rec->setBYDAY(ilUtil::stripSlashes(implode(',', $form->getInput('byday_WEEKLY'))));
                 }
                 break;
 
             case ilCalendarRecurrence::FREQ_MONTHLY:
                 $rec->setFrequenceType($form->getInput('frequence'));
                 $rec->setInterval((int) $form->getInput('count_MONTHLY'));
                 switch ((int) $form->getInput('subtype_MONTHLY')) {
                     case 0:
                         // nothing to do;
                         break;
 
                     case 1:
                         switch ((int) $form->getInput('monthly_byday_day')) {
                             case 8:
                                 // Weekday
                                 $rec->setBYSETPOS($form->getInput('monthly_byday_num'));
                                 $rec->setBYDAY('MO,TU,WE,TH,FR');
                                 break;
 
                             case 9:
                                 // Day of month
                                 $rec->setBYMONTHDAY($form->getInput('monthly_byday_num'));
                                 break;
 
                             default:
                                 $rec->setBYDAY(($form->getInput('monthly_byday_num') . $form->getInput('monthly_byday_day')));
                                 break;
                         }
                         break;
 
                     case 2:
                         $rec->setBYMONTHDAY($form->getInput('monthly_bymonthday'));
                         break;
                 }
                 break;
 
             case ilCalendarRecurrence::FREQ_YEARLY:
                 $rec->setFrequenceType($form->getInput('frequence'));
                 $rec->setInterval((int) $form->getInput('count_YEARLY'));
                 switch ((int) $form->getInput('subtype_YEARLY')) {
                     case 0:
                         // nothing to do;
                         break;
 
                     case 1:
                         $rec->setBYMONTH($form->getInput('yearly_bymonth_byday'));
                         $rec->setBYDAY(($form->getInput('yearly_byday_num') . $form->getInput('yearly_byday')));
                         break;
 
                     case 2:
                         $rec->setBYMONTH($form->getInput('yearly_bymonth_by_monthday'));
                         $rec->setBYMONTHDAY($form->getInput('yearly_bymonthday'));
                         break;
                 }
                 break;
         }
 
         // UNTIL
         switch ((int) $form->getInput('until_type')) {
             case 1:
                 $rec->setFrequenceUntilDate(null);
                 // nothing to do
                 break;
 
             case 2:
                 $rec->setFrequenceUntilDate(null);
                 $rec->setFrequenceUntilCount((int) $form->getInput('count'));
                 break;
 
             case 3:
                 $frequence = $form->getItemByPostVar('frequence');
                 $end = $frequence->getRecurrence()->getFrequenceUntilDate();
                 $rec->setFrequenceUntilCount(0);
                 $rec->setFrequenceUntilDate($end);
                 break;
         }
 
         return $rec;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendNotification()

ilEmployeeTalkAppointmentGUI::sendNotification ( ilObjEmployeeTalk ... $talks )

private

Definition at line 325 of file class.ilEmployeeTalkAppointmentGUI.php.

Referenced by editAppointment(), and loadRecurrenceSettings().

                                                                   : void
     {
         $this->notif_handler->send(NotificationType::UPDATE, ...$talks);
     }

Here is the caller graph for this function:

◆ updateSeries()

ilEmployeeTalkAppointmentGUI::updateSeries ( )

private

Definition at line 182 of file class.ilEmployeeTalkAppointmentGUI.php.

References deleteTalks(), EDIT_MODE_SERIES, getEditModeParameter(), getPendingTalksInSeries(), initSeriesEditForm(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), and loadRecurrenceSettings().

Referenced by executeSeriesCommand().

                                    : void
     {
         $form = $this->initSeriesEditForm();
         if ($form->checkInput()) {
             $reoccurrence = $this->loadRecurrenceSettings($form);
             $parent = $this->talk->getParent();
             $old_talks = $this->getPendingTalksInSeries($parent);
             $this->createRecurringTalks($form, $reoccurrence, $parent);
             $this->deleteTalks($old_talks);
 
             $this->template->setOnScreenMessage('success', $this->language->txt('saved_successfully'), true);
         }
 
         $this->controlFlow->redirectToURL(
             $this->controlFlow->getLinkTargetByClass(
                 strtolower(ilEmployeeTalkMyStaffListGUI::class),
                 ControlFlowCommand::UPDATE_INDEX
             ) . $this->getEditModeParameter(ilEmployeeTalkAppointmentGUI::EDIT_MODE_SERIES)
         );
     }