4.2.0 - getGroupedRanges()

Author: brandonkelly

CHANGELOG.md

@@ -1,5 +1,8 @@
 # Release Notes for Store Hours
 
+## 4.2.0 - 2024-07-28
+- Added `craft\storehours\data\FieldData::getGroupedRanges()`.
+
 ## 4.1.0 - 2024-07-28
 - Added the “Start Day” field setting. ([#43](https://github.com/craftcms/store-hours/issues/43))
 - Added `craft\storehours\data\FieldData::getIsOpen()`. ([#37](https://github.com/craftcms/store-hours/issues/37))

README.md

@@ -115,6 +115,36 @@ To only show certain days of the week (e.g only Monday through Friday), use the
 {% endfor %}
 ```
 
+### Showing Grouped Ranges
+
+You can show consolidated list of hours, such as:
+
+> **11am** – **6pm** Mon – Fri
+> **11am** – **5pm** Sat – Sun
+
+To do that, use the `getGroupedRanges()` field method, which is similar to `getRange()`, except the resulting days are grouped by their time slots.
+
+```twig
+<ul>
+  {% for group in entry.<FieldHandle>.getGroupedRanges(1) %}
+    {% set first = group|first %}
+    {% set last = group|last %}
+    {% if first.open and first.close %}
+      <li>
+        <strong>
+          {{ first.open|date('g:sa')|replace(':00', '') }}&hairsp;–&hairsp;{{ first.close|date('g:sa')|replace(':00', '') }}
+        </strong>
+        {% if first != last %}
+          {{ first.getName('medium') }}&hairsp;–&hairsp;{{ last.getName('medium') }}
+        {% else %}
+          {{ first.getName('medium') }}
+        {% endif %}
+      {% endif %}
+    </li>  
+  {% endfor %}
+</ul>
+```
+
 ### Changing the Week Start Day
 
 You can use the `getRange()` field method to return the full list of days with a different week start day. For example, if you want Monday to be the first day of the week, do this:

src/data/FieldData.php

@@ -198,7 +198,31 @@ public function getRange(int $start, int $end = null): array
             array_slice($data, 0, $end + 1)
         );
     }
-    
+
+    /**
+     * Returns a range of the days, grouped by consecutive days that have the same time slot values.
+     *
+     * @param int $start The first day to return
+     * @param int|null $end The last day to return. If null, it will be whatever day comes before `$start`.
+     * @return DayData[][]
+     */
+    public function getGroupedRanges(int $start, int $end = null): array
+    {
+        $range = $this->getRange($start, $end);
+        $groups = [];
+        $lastSlotKey = null;
+        foreach ($range as $day) {
+            /** @phpstan-ignore-next-line */
+            $slotKey = implode('-', array_map(fn(?DateTime $slot) => $slot ? $this->minuteOfDay($slot) : 'null', (array)$day));
+            if ($slotKey !== $lastSlotKey) {
+                $groups[] = [];
+                $lastSlotKey = $slotKey;
+            }
+            $groups[count($groups) - 1][] = $day;
+        }
+        return $groups;
+    }
+
     /**
      * Returns whether any day has any time slots filled in.
      *