Decouple time widgets by Jan-Schuppik · Pull Request #350 · Icinga/ipl-web

Jan-Schuppik · 2026-01-08T11:46:30Z

This PR removes the direct dependency of the time widgets on Icinga Web 2 (\Icinga\Date\DateFormatter::formatDateTime()) and introduces a native relative-time formatting behavior in IPL Web.

Resolve:

Decouple TimeAgo, TimeUntil and TimeSince from Icinga Web #341

Depends on:

Provide Icinga to ipl/web behaviors icingaweb2#5238
(brings the ability to create js-behaviors outside of icingaweb2 )

Create a general Time Widget which is also the base for TimeAgo, TimeSince & TimeUntil

For this change to work the following PR is required: Icinga/icingaweb2#5238

src/Widget/Time.php

sukhwinder33445 · 2026-01-22T17:23:04Z

src/Widget/Time.php

+
+    protected $tag = 'time';
+
+    public function __construct(int|float|DateTimeInterface $time)


Please add PHPDoc.

This is not the right place for timezone handling. It is also unnecessary for daylight saving time, because IANA time zones take care of the shift.

nilmerg

Didn't look at JS yet.

Also, add tests for Time and its child classes. Test formatting and rendering.

src/Widget/Time.php

nilmerg · 2026-02-13T09:10:00Z

src/Widget/TimeAgo.php

+                $values = ['at %s', 'An event happened at the given time'];
+        }
+
+        return sprintf(t(...$values), $time);


https://github.com/Icinga/developer-guidelines-drafts/issues/10#issuecomment-3895818014

nilmerg · 2026-02-13T09:10:05Z

src/Widget/TimeSince.php

+                $values = ['since %s', 'A status is lasting since the given time, date or date and time'];
+        }
+
+        return sprintf(t(...$values), $time);


https://github.com/Icinga/developer-guidelines-drafts/issues/10#issuecomment-3895818014

nilmerg · 2026-02-13T09:10:10Z

src/Widget/TimeUntil.php

+                $values = ['at %s', 'An event will happen at the given time'];
+        }
+
+        return sprintf(t(...$values), $time);


https://github.com/Icinga/developer-guidelines-drafts/issues/10#issuecomment-3895818014

src/Widget/Time.php

clean up unnecessary methods only allow \DateTime to construct widgets simplify formating of time strings

And fix linting error in Time.php

nilmerg

There are still no tests!

nilmerg · 2026-02-27T08:55:03Z

src/Widget/Time.php

+    /** @var string Tag of element. */
+    protected $tag = 'time';
+
+    public function __construct(DateTime $time)


There's still no phpdoc for the constructor… is there a reason why you neglect to add this?

nilmerg · 2026-02-27T08:58:58Z

src/Widget/Time.php

+    /** @var string Tag of element. */
+    protected $tag = 'time';
+
+    public function __construct(DateTime $time)


I'm afraid, but I just noticed that requiring DateTime is a breaking change. At least as long as this is the constructor for the child classes as well.

To solve this, please override the constructor in the child classes and widen the allowed types so that it's possible to pass what was previously allowed, but cast it to DateTime before calling the parent constructor.

nilmerg · 2026-02-27T09:05:27Z

src/Widget/Time.php

+     *
+     * Returns an array with the interval, the formatted string and the type of difference
+     * Type can be one of the constants RELATIVE, TIME, DATE, DATETIME
+     * Passing null as a parameter will use the current time


no, it fails

nilmerg · 2026-02-27T09:10:56Z

src/Widget/TimeAgo.php

+        [$time, $type] = $this->diff($this->dateTime);
+        $format = $map[$type] ?? $onMessage;
+
+        return sprintf(t(N_($format[0]), N_($format[1])), $time);


Seems like you didn't understand how t() and N_() work yet. Look at their implementation, look where they're used (especially N_) and read up what gettext is and how it works.

Then open a PR at https://github.com/Icinga/developer-guidelines-drafts/pulls to explain what you've learned so that others don't make the same mistakes.

Yes, I mean this serious!

This was a great idea, now i understand how they work!

We want to use DateTime objects for the Time class to work with but the subclasses need to be able to handle also timestamps

This reverts commit 7f1ab16.

Passing a timezone to `new DateTime()` when the input is a Unix timestamp prefixed with `@` is silently ignored by PHP — the timezone is always set to UTC in that case. Fix by calling `setTimezone()` explicitly after construction.

Instead of stripping the sign with Math.abs() before rendering and handling negation inconsistently across different calls, pass the raw signed value through and derive the display sign in render()

The until -> ago transition relies on a cached TimeAgo format. If none is cached yet, the transition silently fails. Fix by pre-assigning the ago label to TimeUntil widgets when they are animated (< 1h), ensuring the format is available when the transition occurs.

No code path in Time::diff() ever returns the DATETIME type, making the constant and its references in the subclass format maps dead code.

Jan-Schuppik added 2 commits January 8, 2026 12:39

Introduce independ time-widgets

9da1580

Create a general Time Widget which is also the base for TimeAgo, TimeSince & TimeUntil

Add data-relative-time-attribute

5a2b6dd

cla-bot bot added the cla/signed label Jan 8, 2026

Jan-Schuppik added 2 commits January 8, 2026 12:51

Fix linting errors

97e7867

Add relative-time behavior (WIP)

ab8aa8e

BastianLedererIcinga mentioned this pull request Jan 19, 2026

Allow switching between relative and absolute timestamps Icinga/icingadb-web#1322

Open

Jan-Schuppik added 5 commits January 20, 2026 13:36

Fix missing timezone handling in relative-time behavior

c620465

cleanup time widgets

31cdf5e

Create a relative-time behavior as expected

29bdf2a

For this change to work the following PR is required: Icinga/icingaweb2#5238

Fix timezone handling - use available feature

4207ad3

Cleanup: relative-time-behavior

a1019c7

Jan-Schuppik mentioned this pull request Jan 21, 2026

Move relative time js behavior to ipl-web Icinga/icingaweb2#5461

Open

Jan-Schuppik added 3 commits January 21, 2026 20:09

Split relative-time in core and behavior

0072131

Remove notjQuery and simplify RelativeTime parameter

2f3d7b5

Add timezone to Time-widget

8ac3881

Jan-Schuppik requested a review from sukhwinder33445 January 22, 2026 14:34

Jan-Schuppik added 3 commits January 22, 2026 15:37

Add tryout: timezone refreshing mechanism

db2b8f5

Adjust: get timezone from icinga config in js

6d17781

Cleanup: code style & variable names

c8fd09a

sukhwinder33445 reviewed Jan 23, 2026

View reviewed changes

Jan-Schuppik added 10 commits January 27, 2026 13:54

Apply suggestions: adjust phpdocs of Time.php

9ef3790

Add: auto-refresh for timezones in js

b5cba9b

Adjust: rendering of the timestrings

216f9d2

Introduce: caching of timeformat

ff5030d

Adjust calculating the relative time

cd29ec9

Add caching of timezone offset

4ec6e58

Add cache for offset and element time differences

7d6db77

Remove element time difference cache (it slows down)

434f792

Fix: refresh cache on update & remove minus sign prefix

647c17e

Remove timezone handling

89c3d0e

This is not the right place for timezone handling. It is also unnecessary for daylight saving time, because IANA time zones take care of the shift.

nilmerg requested changes Feb 13, 2026

View reviewed changes

Jan-Schuppik added 2 commits February 16, 2026 16:44

Apply suggestions: simplify the time widgets

ceb8798

clean up unnecessary methods only allow \DateTime to construct widgets simplify formating of time strings

Adjust: use cache instead of ago-label

8d465de

And fix linting error in Time.php

nilmerg requested changes Feb 27, 2026

View reviewed changes

Jan-Schuppik added 13 commits February 27, 2026 11:27

Fix comments of time widget

71212bc

Add constructor to subclasses to avoid breaking change

e5b266d

We want to use DateTime objects for the Time class to work with but the subclasses need to be able to handle also timestamps

Fix usage of t() and N_()

e2f8794

Introduce: unit-tests for time widgets

a065145

Fix: year-boundary tests and add missing edge-case coverage

18ef512

Refactor: remove t() and N_() namespace workaround from tests

7f1ab16

Revert "Refactor: remove t() and N_() namespace workaround from tests"

51b7a30

This reverts commit 7f1ab16.

Fix: linting error

9b93fd5

fix(RelativeTime): preserve sign through render pipeline

000ed5e

Instead of stripping the sign with Math.abs() before rendering and handling negation inconsistently across different calls, pass the raw signed value through and derive the display sign in render()

test: add tests to verify the ago label is set properly

639d72e

fix: remove unused DATETIME constant

2e23df8

No code path in Time::diff() ever returns the DATETIME type, making the constant and its references in the subclass format maps dead code.


		protected $tag = 'time';

		public function __construct(int\|float\|DateTimeInterface $time)

Conversation

Jan-Schuppik commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

nilmerg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Jan-Schuppik commented Jan 8, 2026 •

edited

Loading