3678: Require timelog comment via settings

CHANGELOG.md

@@ -4,6 +4,8 @@
 
 ## [3.3.0] - 2025-01-17
 
+* [PR-39](https://github.com/ITK-Leantime/leantime-timetable/pull/39)
+  * Require timelog comments via settings
 * [PR-37](https://github.com/ITK-Leantime/leantime-timetable/pull/37)
   * Reimplement ability to move timelog to another date
 

Controllers/Settings.php

@@ -44,7 +44,9 @@ public function get(): Response
     {
         try {
             $ticketCacheExpiration = (int) ($this->settingsRepo->getSetting('itk-leantime-timetable.ticketCacheExpiration') ?: self::DEFAULT_TICKET_EXPIRATION);
+            $requireTimeRegistrationComment = (int) ($this->settingsRepo->getSetting('itk-leantime-timetable.requireTimeRegistrationComment') ?: 0);
             $this->template->assign('ticketCacheExpiration', $ticketCacheExpiration);
+            $this->template->assign('requireTimeRegistrationComment', $requireTimeRegistrationComment);
         } catch (\Exception $e) {
             $this->template->setNotification('An error occurred while saving the settings. ' . $e, 'error');
         }
@@ -63,6 +65,7 @@ public function post(array $params): RedirectResponse
     {
         try {
             $this->settingsRepo->saveSetting('itk-leantime-timetable.ticketCacheExpiration', (int)($params['ticketCacheExpiration'] ?? self::DEFAULT_TICKET_EXPIRATION));
+            $this->settingsRepo->saveSetting('itk-leantime-timetable.requireTimeRegistrationComment', (int)($params['requireTimeRegistrationComment'] ?? 0));
             $this->template->setNotification('The settings were successfully saved.', 'success');
         } catch (\Exception $e) {
             $this->template->setNotification('An error occurred while saving the settings. ' . $e, 'error');

Controllers/TimeTable.php

@@ -195,6 +195,7 @@ public function get(): Response
         $this->template->assign('fromDate', $fromDate);
         $this->template->assign('toDate', $toDate);
         $this->template->assign('allStateLabels', json_encode($allStateLabels));
+        $this->template->assign('requireTimeRegistrationComment', $this->settings->getSetting('itk-leantime-timetable.requireTimeRegistrationComment') ?? 0);
         return $this->template->display('TimeTable.timetable');
     }
 }

Templates/settings.blade.php

@@ -26,6 +26,15 @@
                             name="ticketCacheExpiration" />
                     </div>
                 </div>
+                <div class="row">
+                    <div class="col-md-2">
+                        <label>Require timelog comment</label>
+                    </div>
+                    <div class="col-md-8">
+                        <input type="checkbox" value="1" name="requireTimeRegistrationComment"
+                            {{ (int) $requireTimeRegistrationComment === 1 ? 'checked' : '' }} />
+                    </div>
+                </div>
                 <input type="submit" value="Save" id="saveBtn" />
             </form>
 

Templates/timetable.blade.php

@@ -8,6 +8,7 @@
             <h1>{{ __('timeTable.headline') }}</h1>
         </div>
     </div>
+
     <!-- page header -->
     <div class="maincontent">
         <div class="maincontentinner">
@@ -88,7 +89,8 @@ class="timetable-to-today btn btn-default">{{ __('timeTable.button_show_this_wee
                                             $hours = $timesheetDate[0]['hours'] ?? null;
                                             $hoursLeft = $timesheetDate[0]['hourRemaining'] ?? null;
                                             $description = $timesheetDate[0]['description'] ?? null;
-                                            $isMissingDescription = isset($hours) && trim($description) === '';
+                                            $requireTimeRegistrationComment = $requireTimeRegistrationComment ?? 0;
+                                            $isMissingDescription = isset($hours) & (trim($description) === '') && $requireTimeRegistrationComment !== 0;
 
                                             // accumulate hours
                                             if ($hours) {
@@ -206,7 +208,8 @@ class="timetable-edit-entry {{ $weekendClass }} {{ $todayClass }} {{ $newWeekCla
             {{-- Description input --}}
             <div class="description-wrapper">
                 <textarea type="text" id="modal-description" name="timesheet-description"
-                    placeholder="{{ __('timeTable.description') }}" required></textarea>
+                    placeholder="{{ __('timeTable.description') }}"
+                    {{ (int) $requireTimeRegistrationComment === 1 ? 'required' : '' }}></textarea>
             </div>
             <div class="timesheet-date-move-notifier hidden"><small><i class="fa fa-exclamation-circle"></i>
                     {{ __('timeTable.about_to_move') }}</small></div>

assets/timeTable.js

@@ -9,6 +9,8 @@ jQuery(document).ready(function ($) {
   const pluginSettings = {
     userId: timetableSettings.settings.userId,
     allStateLabels: $("#all-state-labels").val(),
+    requireTimeRegistrationComment:
+      timetableSettings.settings.requireTimeRegistrationComment,
   };
 
   class TimeTable {

bin/create-release

@@ -62,7 +62,7 @@ find "${target_dir}" -type f -exec sed -i "s/%%VERSION%%/${tag}/g" {} \;
 
 # Strip any leading `dev-` from tag name in package name.
 name="${plugin_name}-${tag#dev-}.tar.gz"
-tar --create --file "$name" -C "$release_dir" "$plugin_name"
+tar --gzip --create --file "$name" -C "$release_dir" "$plugin_name"
 sha256sum "$name" >| checksum.txt
 
 # Clean up

register.php

@@ -59,12 +59,14 @@ function () {
                 echo '<link rel="stylesheet" href="' . htmlspecialchars($timeTableStyle) . '"></link>';
                 $userId = htmlspecialchars(session('userdata.id'), ENT_QUOTES, 'UTF-8');
                 $ticketCacheExpiration = app()->make(Setting::class)->getSetting('itk-leantime-timetable.ticketCacheExpiration') ?: '1200';
+                $requireTimeRegistrationComment = app()->make(Setting::class)->getSetting('itk-leantime-timetable.requireTimeRegistrationComment') ?: '0';
 
                 echo '<script>';
                 echo 'const timetableSettings = ' . json_encode([
                         'settings' => [
                             'userId' => $userId,
                             'ticketCacheExpiration' => $ticketCacheExpiration,
+                            'requireTimeRegistrationComment' => $requireTimeRegistrationComment,
                         ],
                     ], JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT);
                 echo '</script>';