Daily.php
2 years ago
Hourly.php
5 months ago
Interval.php
1 year ago
Intervals.php
2 years ago
Monthly.php
1 year ago
Weekly.php
2 years ago
Interval.php
32 lines
| 1 | <?php |
| 2 | |
| 3 | namespace IAWP\Statistics\Intervals; |
| 4 | |
| 5 | /** @internal */ |
| 6 | abstract class Interval |
| 7 | { |
| 8 | public abstract function id() : string; |
| 9 | public abstract function label() : string; |
| 10 | public abstract function date_interval() : \DateInterval; |
| 11 | public abstract function calculate_start_of_interval_for(\DateTime $original_date_time) : \DateTime; |
| 12 | /** |
| 13 | * Allow a subclass to define what the label should be for the data point. If the interval is year, |
| 14 | * you'd want to show something like "2025", but if it's a monthly interval you'd want "March 2025". |
| 15 | * |
| 16 | * @param \DateTime $date_time |
| 17 | * |
| 18 | * @return array |
| 19 | */ |
| 20 | public abstract function get_label_for(\DateTime $date_time) : array; |
| 21 | // Todo - Maybe have an option to pass in either the class or the id for Statistics.php equality checks |
| 22 | // that currently rely on the interval method |
| 23 | public function equals(\IAWP\Statistics\Intervals\Interval $interval) : bool |
| 24 | { |
| 25 | return $this->id() === $interval->id(); |
| 26 | } |
| 27 | protected function format(\DateTime $date_time, string $format) |
| 28 | { |
| 29 | return \wp_date($format, $date_time->getTimestamp(), $date_time->getTimezone()); |
| 30 | } |
| 31 | } |
| 32 |