ops-Gazelle/app/Util/Time.php

<?php

namespace Gazelle\Util;

class Time {
    /**
     * Returns the number of seconds between now() and the given timestamp. If the timestamp
     * is an integer, we assume that's the nubmer of seconds you wish to subtract, otherwise
     * it's a string of a timestamp that we convert to a UNIX timestamp and then do a subtraction.
     * If the passed in $timestamp does not convert properly or is null, return false (error).
     */
    public static function timeAgo(string|int|float $timestamp): false|int {
        if (is_numeric($timestamp)) {
            $timestamp = (int)$timestamp;
        } else {
            if ($timestamp == '') {
                return false;
            }
            $timestamp = strtotime($timestamp);
            if ($timestamp === false) {
                return false;
            }
        }
        return time() - $timestamp;
    }

    public static function diff(
        int|string|null $timestamp,
        int             $levels    = 2,
        bool            $span      = true,
        string|false    $starttime = false,
        bool            $hideAgo   = false,
    ): string {
        $starttime = ($starttime === false) ? time() : strtotime($starttime);

        if ($timestamp === 0 || $timestamp === '' || is_null($timestamp)) {
            return 'Never';
        }
        if (is_numeric($timestamp)) {
            $timestamp = (int)$timestamp;
        } else {
            $timestamp = strtotime($timestamp);
            if ($timestamp === false) {
                return 'Never';
            }
        }
        $time = $starttime - $timestamp;

        // If the time is negative, then it expires in the future.
        if ($time < 0) {
            $time = -$time;
            $hideAgo = true;
        }

        $years = floor($time / 31_556_926); // seconds in one year
        $remain = $time - $years * 31_556_926;

        $months = floor($remain / 2_629_744); // seconds in one month
        $remain = $remain - $months * 2_629_744;

        $weeks = floor($remain / 604800); // seconds in one week
        $remain = $remain - $weeks * 604800;

        $days = floor($remain / 86400); // seconds in one day
        $remain = $remain - $days * 86400;

        $hours = floor($remain / 3600); // seconds in one hour
        $remain = $remain - $hours * 3600;

        $minutes = floor($remain / 60);

        $timespec = '';

        if ($years > 0 && $levels > 0) {
            if ($years > 1) {
                $timespec .= "$years years";
            } else {
                $timespec .= "$years year";
            }
            $levels--;
        }

        if ($months > 0 && $levels > 0) {
            if ($timespec != '') {
                $timespec .= ', ';
            }
            if ($months > 1) {
                $timespec .= "$months months";
            } else {
                $timespec .= "$months month";
            }
            $levels--;
        }

        if ($weeks > 0 && $levels > 0) {
            if ($timespec != '') {
                $timespec .= ', ';
            }
            if ($weeks > 1) {
                $timespec .= "$weeks weeks";
            } else {
                $timespec .= "$weeks week";
            }
            $levels--;
        }

        if ($days > 0 && $levels > 0) {
            if ($timespec != '') {
                $timespec .= ', ';
            }
            if ($days > 1) {
                $timespec .= "$days days";
            } else {
                $timespec .= "$days day";
            }
            $levels--;
        }

        if ($hours > 0 && $levels > 0) {
            if ($timespec != '') {
                $timespec .= ', ';
            }
            if ($hours > 1) {
                $timespec .= "$hours hours";
            } else {
                $timespec .= "$hours hour";
            }
            $levels--;
        }

        if ($minutes > 0 && $levels > 0) {
            if ($timespec != '') {
                $timespec .= ' and ';
            }
            if ($minutes > 1) {
                $timespec .= "$minutes mins";
            } else {
                $timespec .= "$minutes min";
            }
        }

        if ($timespec == '') {
            $timespec = 'Just now';
        } elseif (!$hideAgo) {
            $timespec .= ' ago';
        }

        if ($span) {
            return '<span class="time tooltip" title="' . date('M d Y, H:i', $timestamp) . '">' . $timespec . '</span>';
        } else {
            return $timespec;
        }
    }

    /**
     * Converts a numeric amount of hours (though we round down via floor for all levels) into a more human readeable
     * string representing the number of years, months, weeks, days, and hours that make up that numeric amount. The
     * function then either surrounds the amount with a span or just returns the string. Giving a less than or equal
     * 0 hours to the function will return the string 'Never'.
     */
    public static function convertHours(int $hours, int $levels = 2, bool $span = true): string {
        if ($hours <= 0) {
            return 'Never';
        }

        $years = floor($hours / 8760); // hours in a year
        $remain = $hours - $years * 8760;

        $months = floor($remain / 730); // hours in a month
        $remain = $remain - $months * 730;

        $weeks = floor($remain / 168); // hours in a week
        $remain = $remain - $weeks * 168;

        $days = floor($remain / 24); // hours in a day
        $remain = $remain - $days * 24;

        $hours = floor($remain);

        $return = '';

        if ($years > 0 && $levels > 0) {
            $return .= $years . 'y';
            $levels--;
        }

        if ($months > 0 && $levels > 0) {
            $return .= $months . 'mo';
            $levels--;
        }

        if ($weeks > 0 && $levels > 0) {
            $return .= $weeks . 'w';
            $levels--;
        }

        if ($days > 0 && $levels > 0) {
            $return .= $days . 'd';
            $levels--;
        }

        if ($hours > 0 && $levels > 0) {
            $return .= $hours . 'h';
        }

        if ($span) {
            return '<span>' . $return . '</span>';
        } else {
            return $return;
        }
    }


    /**
     * Converts a numeric amount of seconds (though we round down via floor for all levels) into a more human readeable
     * string representing the number of weeks, days, hours, minutes, seconds.
     */
    public static function convertSeconds(int $seconds): string {
        if ($seconds <= 0) {
            return '0s';
        }

        $interval = [($seconds % 60) .  's'];
        $minutes = (int)floor($seconds / 60);

        if ($minutes >= 60) {
            $minute = $minutes % 60;
            $hours  = (int)floor($minutes / 60);
        } else {
            $minute = $minutes;
            $hours  = 0;
        }
        if ($minute) {
            $interval[] = "{$minute}m";
        }

        if ($hours >= 24) {
            $hour = $hours % 24;
            $days = (int)floor($hours / 24);
        } else {
            $hour = $hours;
            $days  = 0;
        }
        if ($hour) {
            $interval[] = "{$hour}h";
        }

        if ($days >= 7) {
            $day = $days % 7;
            $week = (int)floor($days / 7);
        } else {
            $day = $days;
            $week  = 0;
        }
        if ($day) {
            $interval[] = "{$day}d";
        }
        if ($week) {
            $interval[] = "{$week}w";
        }
        return implode('', array_slice(array_reverse($interval), 0, 2));
    }

    /**
     * Utility function to generate a timestamp to insert into the database, given some offset
     */
    public static function offset(int $offset): false|string {
        return date('Y-m-d H:i:s', time() + $offset);
    }

    public static function sqlTime($timestamp = false): string {
        if ($timestamp === false) {
            $timestamp = time();
        }
        return date('Y-m-d H:i:s', (int)$timestamp);
    }

    public static function validDate($date_string): bool {
        $date_time = explode(' ', $date_string);
        if (count($date_time) != 2) {
            return false;
        }
        [$date, $time] = $date_time;
        $split_time = array_map('intval', explode(':', $time));
        if (count($split_time) != 3) {
            return false;
        }
        [$hour, $minute, $second] = $split_time;
        if ($hour != 0 && !(is_number($hour) && $hour < 24 && $hour >= 0)) {
            return false;
        }
        if ($minute != 0 && !(is_number($minute) && $minute < 60 && $minute >= 0)) {
            return false;
        }
        if ($second != 0 && !(is_number($second) && $second < 60 && $second >= 0)) {
            return false;
        }
        $split_date = array_map('intval', explode('-', $date));
        if (count($split_date) != 3) {
            return false;
        }
        [$year, $month, $day] = $split_date;
        return checkdate($month, $day, $year);
    }

    public static function isValidDate($date): bool {
        return static::isValidDateTime($date, 'Y-m-d');
    }

    public static function isValidDateTime($date_time, $format = 'Y-m-d H:i'): bool {
        $formatted_date_time = \DateTime::createFromFormat($format, $date_time);
        return $formatted_date_time && $formatted_date_time->format($format) == $date_time;
    }
}