NoticeState.php
104 lines
| 1 | <?php |
| 2 | |
| 3 | declare(strict_types=1); |
| 4 | |
| 5 | namespace AC\Notice; |
| 6 | |
| 7 | use AC\Storage\UserMeta; |
| 8 | |
| 9 | class NoticeState |
| 10 | { |
| 11 | private const META_KEY = '_ac_notices'; |
| 12 | |
| 13 | private ?array $data = null; |
| 14 | |
| 15 | public function get(string $slug, string $key) |
| 16 | { |
| 17 | $data = $this->get_data(); |
| 18 | |
| 19 | return $data[$slug][$key] ?? null; |
| 20 | } |
| 21 | |
| 22 | public function set(string $slug, string $key, $value): void |
| 23 | { |
| 24 | $data = $this->get_data(); |
| 25 | $data[$slug][$key] = $value; |
| 26 | |
| 27 | $this->save_data($data); |
| 28 | } |
| 29 | |
| 30 | public function is_dismissed(string $slug): bool |
| 31 | { |
| 32 | return (bool)$this->get($slug, 'dismissed'); |
| 33 | } |
| 34 | |
| 35 | public function dismiss(string $slug): void |
| 36 | { |
| 37 | $this->set($slug, 'dismissed', true); |
| 38 | } |
| 39 | |
| 40 | public function track_first_seen(string $slug): void |
| 41 | { |
| 42 | if (! $this->get($slug, 'first-seen')) { |
| 43 | $this->set($slug, 'first-seen', time()); |
| 44 | } |
| 45 | } |
| 46 | |
| 47 | /** |
| 48 | * Check if enough time has passed since the notice was first seen. |
| 49 | * Each notice defines its own delay via get_delay_days(). This prevents |
| 50 | * notices from showing immediately on new installs. |
| 51 | */ |
| 52 | public function is_delay_met(string $slug, int $days): bool |
| 53 | { |
| 54 | $first_seen = $this->get($slug, 'first-seen'); |
| 55 | |
| 56 | return $first_seen && (time() - (int)$first_seen) >= $days * DAY_IN_SECONDS; |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Record that a notice was just dismissed. Used together with is_cooldown_active() |
| 61 | * to suppress all integration notices for a period after any dismissal, preventing |
| 62 | * the user from seeing back-to-back notices. |
| 63 | */ |
| 64 | public function track_dismissal(): void |
| 65 | { |
| 66 | $data = $this->get_data(); |
| 67 | $data['_last_dismissed'] = time(); |
| 68 | |
| 69 | $this->save_data($data); |
| 70 | } |
| 71 | |
| 72 | /** |
| 73 | * Check if a recent dismissal should suppress all notices. |
| 74 | * Returns true if any notice was dismissed less than $days ago. |
| 75 | */ |
| 76 | public function is_cooldown_active(int $days): bool |
| 77 | { |
| 78 | $last = $this->get_data()['_last_dismissed'] ?? null; |
| 79 | |
| 80 | return $last && (time() - (int)$last) < $days * DAY_IN_SECONDS; |
| 81 | } |
| 82 | |
| 83 | private function get_data(): array |
| 84 | { |
| 85 | if (null === $this->data) { |
| 86 | $this->data = $this->create_storage()->get() ?: []; |
| 87 | } |
| 88 | |
| 89 | return $this->data; |
| 90 | } |
| 91 | |
| 92 | private function save_data(array $data): void |
| 93 | { |
| 94 | $this->data = $data; |
| 95 | $this->create_storage()->save($data); |
| 96 | } |
| 97 | |
| 98 | private function create_storage(): UserMeta |
| 99 | { |
| 100 | return new UserMeta(self::META_KEY); |
| 101 | } |
| 102 | |
| 103 | } |
| 104 |