PHPFUI/InstaDoc
 
Copied!
<?php

/**
 * Date helper class
 *
 * @author	Dan Cogliano <http://zcontent.net>
 * @copyright   Copyright (C) 2006 - 2018 by Dan Cogliano
 * @license     GNU GPLv3 <http://www.gnu.org/licenses/gpl.html>
 * @link http://phpfui.com/?n=ICalendarOrg
 */

namespace ICalendarOrg;

/**
 * Zap Calendar Date Helper Class
 *
 * Helper class for various date functions
 */
class ZDateHelper
	{
	/**
	 * Date math: add or substract from current date to get a new date
	 *
	 * @param int $date date to add or subtract from
	 * @param int $hour add or subtract hours from date
	 * @param int $min add or subtract minutes from date
	 * @param int $sec add or subtract seconds from date
	 * @param int $month add or subtract months from date
	 * @param int $day add or subtract days from date
	 * @param int $year add or subtract years from date
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 *
	 * @return int Unix timestamp
	 */
	public static function addDate(int $date, int $hour, int $min, int $sec, int $month, int $day, int $year, string $tzid = 'UTC')
		{
		\date_default_timezone_set($tzid);
		$sqldate = self::toSQLDateTime($date);
		$tdate = [];
		$tdate['year'] = (int)\substr($sqldate, 0, 4);
		$tdate['mon'] = (int)\substr($sqldate, 5, 2);
		$tdate['mday'] = (int)\substr($sqldate, 8, 2);
		$tdate['hours'] = (int)\substr($sqldate, 11, 2);
		$tdate['minutes'] = (int)\substr($sqldate, 14, 2);
		$tdate['seconds'] = (int)\substr($sqldate, 17, 2);
		$newdate = \mktime($tdate['hours'] + $hour, $tdate['minutes'] + $min, $tdate['seconds'] + $sec, $tdate['mon'] + $month, $tdate['mday'] + $day, $tdate['year'] + $year);
		\date_default_timezone_set('UTC');

		return $newdate;
		}

	/**
	 * Find the number of days in a month
	 *
	 * @param int $month Month is between 1 and 12 inclusive
	 * @param int $year is between 1 and 32767 inclusive
	 */
	public static function DayInMonth(int $month, int $year) : int
		{
		$daysInMonth = [31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];

		if (2 != $month)
			{
			return $daysInMonth[$month - 1];
			}

		return (\checkdate($month, 29, $year)) ? 29 : 28;
		}

	/**
	 * Return now as DateTime
	 *
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function DTNow(string $tzid) : \DateTime
		{
		try
			{
			$dtz = new \DateTimeZone($tzid);
			}
		catch (\Exception $e)
			{
			$dtz = null;
			}

		return new \DateTime('now', $dtz);
		}

	/**
	 * Format iCal date-time string to Unix timestamp
	 *
	 * @param string $datetime in iCal time format ( YYYYMMDD or YYYYMMDDTHHMMSS or YYYYMMDDTHHMMSSZ )
	 *
	 * @return int Unix timestamp
	 */
	public static function fromiCaltoUnixDateTime(string $datetime) : int
		{
		// first check format
		$formats = [];
		$formats[] = '/[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]/';
		$formats[] = '/[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]T[0-9][0-9][0-9][0-9][0-9][0-9]/';
		$formats[] = '/[0-9][0-9][0-9][0-9][0-9][0-9][0-9][0-9]T[0-9][0-9][0-9][0-9][0-9][0-9]Z/';
		$ok = false;

		foreach ($formats as $format)
			{
			if (\preg_match($format, $datetime))
				{
				$ok = true;

				break;
				}
			}

		if (! $ok)
			{
			return 0;
			}
		$year = (int)\substr($datetime, 0, 4);
		$month = (int)\substr($datetime, 4, 2);
		$day = (int)\substr($datetime, 6, 2);
		$hour = 0;
		$minute = 0;
		$second = 0;

		if (\strlen($datetime) > 8 && 'T' == $datetime[8])
			{
			$hour = (int)\substr($datetime, 9, 2);
			$minute = (int)\substr($datetime, 11, 2);
			$second = (int)\substr($datetime, 13, 2);
			}

		return \gmmktime($hour, $minute, $second, $month, $day, $year);
		}

	/**
	 * fromSqlDateTime()
	 *
	 * Take SQL timestamp and format to iCal date/time string
	 *
	 * @param string $datetime SQL timestamp, leave blank for current date/time
	 *
	 * @return string formatted iCal date/time string
	 */
	public static function fromSqlDateTime(?string $datetime = null) : string
		{
		\date_default_timezone_set('UTC');

		if (null == $datetime)
			{
			$datetime = \time();
			}
		else
			{
			$datetime = \strtotime($datetime);
			}

		return \date('Ymd\THis', $datetime);
		}

	/**
	 * Take Unix timestamp and format to iCal date string
	 *
	 * @param int $datetime Unix timestamp, leave blank for current date/time
	 *
	 * @return string formatted iCal date string
	 */
	public static function fromUnixDate(?int $datetime = null) : string
		{
		\date_default_timezone_set('UTC');

		if (null == $datetime)
			{
			$datetime = \time();
			}

		return \date('Ymd', $datetime);
		}

	/**
	 * Take Unix timestamp and format to iCal date/time string
	 *
	 * @param int $datetime Unix timestamp, leave blank for current date/time
	 *
	 * @return string formatted iCal date/time string
	 */
	public static function fromUnixDateTime(?int $datetime = null) : string
		{
		\date_default_timezone_set('UTC');

		if (null == $datetime)
			{
			$datetime = \time();
			}

		return \date('Ymd\THis', $datetime);
		}

	/**
	 * Format Unix timestamp to iCal date-time string
	 *
	 * @param int $datetime Unix timestamp
	 */
	public static function fromUnixDateTimetoiCal(int $datetime) : string
		{
		\date_default_timezone_set('GMT');

		return \gmdate("Ymd\THis", $datetime);
		}

	/**
	 * Convert from a relative date to an absolute date
	 *
	 * Examples of relative dates are '-2y' for 2 years ago, '18m'
	 * for 18 months after today. Relative date uses 'y', 'm' and 'd' for
	 * year, month and day. Relative date can be combined into comma
	 * separated list, i.e., '-1y,-1d' for 1 year and 1 day ago.
	 *
	 * @param string $date relative date string (i.e. '1y' for 1 year from today)
	 * @param string $rdate reference date, or blank for current date (in SQL date-time format)
	 *
	 * @return string in SQL date-time format
	 */
	public static function getAbsDate(string $date, string $rdate = '') : string
		{
		if (\str_replace(['y', 'm', 'd', 'h', 'n'], '', \strtolower($date)) != \strtolower($date))
			{
			\date_default_timezone_set('UTC');

			if ('' == $rdate)
				{
				$udate = \time();
				}
			else
				{
				$udate = self::toUnixDateTime($rdate);
				}
			$values = \explode(',', \strtolower($date));
			$y = 0;
			$m = 0;
			$d = 0;
			$h = 0;
			$n = 0;

			foreach ($values as $value)
				{
				$rtype = \substr($value, \strlen($value) - 1);
				$rvalue = (\substr($value, 0, \strlen($value) - 1));

				switch ($rtype)
					{
					case 'y':
						$y = (int)$rvalue;

						break;

					case 'm':
						$m = (int)$rvalue;

						break;

					case 'd':
						$d = (int)$rvalue;

						break;

					case 'h':
						$h = (int)$rvalue;

						break;

					case 'n':
						$n = (int)$rvalue;

						break;
					}

				// for '-' values, move to start of day , otherwise, move to end of day
				if ('-' == $rvalue[0])
					{
					$udate = \mktime(0, 0, 0, (int)\date('m', $udate), (int)\date('d', $udate), (int)\date('Y', $udate));
					}
				else
					{
					$udate = \mktime(0, -1, 0, (int)\date('m', $udate), (int)\date('d', $udate) + 1, (int)\date('Y', $udate));
					}
				$udate = self::addDate($udate, $h, $n, 0, $m, $d, $y);
				}
			$date = self::toSQLDateTime($udate);
			}

		return $date;
		}

	/**
	 * Date math: get date from week and day in specific month
	 *
	 * This routine finds actual dates for the second Tuesday of the month, last Friday of the month, etc.
	 * For second Tuesday, use $week = 1, $wday = 2
	 * for last Friday, use $week = -1, $wday = 5
	 *
	 * @param int $date Unix timestamp
	 * @param int $week week number, 0 is first week, -1 is last
	 * @param int $wday day of week, 0 is Sunday, 6 is Saturday
	 * @param string $tzid PHP supported timezone
	 *
	 * @return int Unix timestamp
	 */
	public static function getDateFromDay(int $date, int $week, int $wday, string $tzid = 'UTC') : int
		{
		// determine first day in month
		$tdate = \getdate($date);
		$monthbegin = \gmmktime(0, 0, 0, $tdate['mon'], 1, $tdate['year']);
		$monthend = self::addDate($monthbegin, 0, 0, 0, 1, -1, 0, $tzid); // add 1 month and subtract 1 day
		$day = self::addDate($date, 0, 0, 0, 0, 1 - $tdate['mday'], 0, $tzid);
		$month = [[]];

		while ($day <= $monthend)
			{
			$tdate = \getdate($day);
			$month[$tdate['wday']][] = $day;
			$day = self::addDate($day, 0, 0, 0, 0, 1, 0, $tzid); // add 1 day
			}
		$dayinmonth = 0;

		if ($week >= 0)
			{
			$dayinmonth = $month[$wday][$week];
			}
		else
			{
			$dayinmonth = $month[$wday][\count($month[$wday]) - 1];
			}

		return $dayinmonth;
		}

	/**
	 * Convert iCal duration string to # of seconds
	 *
	 * @param string $duration iCal duration string
	 */
	public static function iCalDurationtoSeconds(string $duration) : int
		{
		$secs = 0;

		if ('P' == $duration[0])
			{
			$duration = \str_replace(['H', 'M', 'S', 'T', 'D', 'W', 'P'], ['H,', 'M,', 'S,', '', 'D,', 'W,', ''], $duration);
			$dur2 = \explode(',', $duration);

			foreach ($dur2 as $dur)
				{
				$val = (int)$dur;

				if (\strlen($dur) > 0)
					{
					switch ($dur[\strlen($dur) - 1])
						{
						case 'H':
							$secs += 60 * 60 * $val;

							break;

						case 'M':
							$secs += 60 * $val;

							break;

						case 'S':
							$secs += $val;

							break;

						case 'D':
							$secs += 60 * 60 * 24 * $val;

							break;

						case 'W':
							$secs += 60 * 60 * 24 * 7 * $val;

							break;
						}
					}
				}
			}

		return $secs;
		}

	/**
	 * Check if day falls within date range
	 *
	 * @param int $daystart start of day in Unix timestamp format
	 * @param int $begin Unix timestamp of starting date range
	 * @param int $end Unix timestamp of end date range
	 */
	public static function inDay(int $daystart, int $begin, int $end) : bool
		{
		//$dayend = $daystart + 60*60*24 - 60;
		// add 1 day to determine end of day
		// don't use 24 hours, since twice a year DST Sundays are 23 hours and 25 hours in length
		// adding 1 day takes this into account
		$dayend = self::addDate($daystart, 0, 0, 0, 0, 1, 0);

		$end = \max($begin, $end); // $end can't be less than $begin
		$inday =
				($daystart <= $begin && $begin < $dayend)
				|| ($daystart < $end && $end < $dayend)
				|| ($begin <= $daystart && $end > $dayend);

		return $inday;
		}

	/**
	 * Is given date after today?
	 *
	 * @param int $date date in Unix timestamp format
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function isAfterToday(int $date, string $tzid = 'UTC') : bool
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return \mktime(0, 0, 0, (int)\date('m', $now), (int)\date('d', $now), (int)\date('Y', $now)) <
							 \mktime(0, 0, 0, (int)\date('m', $date), (int)\date('d', $date), (int)\date('Y', $date));
		}

	/**
	 * Is given date before today?
	 *
	 * @param int $date date in Unix timestamp format
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function isBeforeToday(int $date, string $tzid = 'UTC') : bool
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return \mktime(0, 0, 0, (int)\date('m', $now), (int)\date('d', $now), (int)\date('Y', $now)) >
							 \mktime(0, 0, 0, (int)\date('m', $date), (int)\date('d', $date), (int)\date('Y', $date));
		}

	/**
	 * Is given date in the future?
	 *
	 * This routine differs from isAfterToday() in that isFuture() will
	 * return true for date-time values later in the same day.
	 *
	 * @param int $date date in Unix timestamp format
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function isFuture(int $date, string $tzid = 'UTC') : bool
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return $date > $now;
		}

	/**
	 * Is given date in the past?
	 *
	 * This routine differs from isBeforeToday() in that isPast() will
	 * return true for date-time values earlier in the same day.
	 *
	 * @param int $date date in Unix timestamp format
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function isPast(int $date, string $tzid = 'UTC') : bool
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return $date < $now;
		}

	/**
	 * Is given date today?
	 *
	 * @param int $date date in Unix timestamp format
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function isToday(int $date, string $tzid = 'UTC') : bool
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return \gmdate('Y-m-d', $date) == \gmdate('Y-m-d', $now);
		}

	/**
	 * Is given date tomorrow?
	 *
	 * @param int $date date in Unix timestamp format
	 * @param string $tzid PHP recognized timezone (default is UTC)
	 */
	public static function isTomorrow(int $date, string $tzid = 'UTC') : bool
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return \gmdate('Y-m-d', $date) == \gmdate('Y-m-d', $now + 60 * 60 * 24);
		}

	/**
	 * Is given date fall on a weekend?
	 *
	 * @param int $date Unix timestamp
	 */
	public static function isWeekend(int $date) : bool
		{
		$dow = \gmdate('w', $date);

		return 0 == $dow || 6 == $dow;
		}

	/**
	 * Return current Unix timestamp in local timezone
	 *
	 * @param string $tzid PHP recognized timezone
	 */
	public static function now(string $tzid = 'UTC') : int
		{
		$dt = self::DTNow($tzid);
		$now = \time() + $dt->getTimezone()->getOffset($dt);

		return $now;
		}

	/**
	 * Format Unix timestamp to iCal date format
	 *
	 * @param int $datetime Unix timestamp
	 *
	 * @return string iCal date-time string
	 */
	public static function toiCalDate(?int $datetime = null) : string
		{
		\date_default_timezone_set('UTC');

		if (null == $datetime)
			{
			$datetime = \time();
			}

		return \gmdate('Ymd', $datetime);
		}

	/**
	 * Format Unix timestamp to iCal date-time format
	 *
	 * @param int $datetime Unix timestamp
	 *
	 * @return string iCal date-time string
	 */
	public static function toiCalDateTime(?int $datetime = null) : string
		{
		\date_default_timezone_set('UTC');

		if (null == $datetime)
			{
			$datetime = \time();
			}

		return \gmdate("Ymd\THis", $datetime);
		}

	/**
	 * Convert UTC date-time to local date-time
	 *
	 * @param string $sqldate SQL date-time string
	 * @param string $tzid PHP recognized timezone (default is 'UTC')
	 *
	 * @return string SQL date-time string
	 */
	public static function toLocalDateTime(string $sqldate, string $tzid = 'UTC') : string
		{
		try
			{
			$timezone = new \DateTimeZone($tzid);
			}
		catch (\Exception $e)
			{
			// bad time zone specified
			return $sqldate;
			}
		$udate = self::toUnixDateTime($sqldate);
		$daydatetime = new \DateTime('@' . $udate);
		$tzoffset = $timezone->getOffset($daydatetime);

		return self::toSQLDateTime($udate + $tzoffset);
		}

	/**
	 * Format Unix timestamp to SQL date
	 *
	 * @param int $t Unix timestamp
	 */
	public static function toSQLDate(int $t = 0) : string
		{
		\date_default_timezone_set('GMT');

		if (0 == $t)
			{
			return \gmdate('Y-m-d', self::now());
			}

		return \gmdate('Y-m-d', $t);
		}

	/**
	 * Format Unix timestamp to SQL date-time
	 *
	 * @param int $t Unix timestamp
	 */
	public static function toSQLDateTime(int $t = 0) : string
		{
		\date_default_timezone_set('GMT');

		if (0 == $t)
			{
			return \gmdate('Y-m-d H:i:s', self::now());
			}

		return \gmdate('Y-m-d H:i:s', $t);
		}

	/**
	 * Convert SQL date or date-time to Unix timestamp
	 *
	 * @param string $datetime SQL date or date-time
	 *
	 * @return int Unix date-time timestamp
	 */
	public static function toUnixDate(string $datetime) : int
		{
		$year = (int)\substr($datetime, 0, 4);
		$month = (int)\substr($datetime, 5, 2);
		$day = (int)\substr($datetime, 8, 2);

		return \mktime(0, 0, 0, $month, $day, $year);
		}

	/**
	 * Convert SQL date or date-time to Unix date timestamp
	 *
	 * @param string $datetime SQL date or date-time
	 *
	 * @return int Unix timestamp
	 */
	public static function toUnixDateTime(string $datetime) : int
		{
		// convert to absolute dates if neccessary
		$datetime = self::getAbsDate($datetime);
		$year = (int)\substr($datetime, 0, 4);
		$month = (int)\substr($datetime, 5, 2);
		$day = (int)\substr($datetime, 8, 2);
		$hour = 0;
		$minute = 0;
		$second = 0;

		if (\strlen($datetime) > 10)
			{
			$hour = (int)\substr($datetime, 11, 2);
			$minute = (int)\substr($datetime, 14, 2);
			$second = (int)\substr($datetime, 17, 2);
			}

		return \gmmktime($hour, $minute, $second, $month, $day, $year);
		}

	/**
	 * Convert local date-time to UTC date-time
	 *
	 * @param string $sqldate SQL date-time string
	 * @param string $tzid PHP recognized timezone (default is 'UTC')
	 *
	 * @return string SQL date-time string
	 */
	public static function toUTCDateTime(string $sqldate, string $tzid = 'UTC') : string
		{
		\date_default_timezone_set('UTC');

		try
			{
			$dtz = new \DateTimeZone($tzid);
			$date = new \DateTime($sqldate, $dtz);
			}
		catch (\Exception $e)
			{
			// bad time zone specified
			return $sqldate;
			}
		$offset = $dtz->getOffset($date);

		if ($offset >= 0)
			{
			$date->sub(new \DateInterval('PT' . $offset . 'S'));
			}
		else
			{
			$date->add(new \DateInterval('PT' . \abs($offset) . 'S'));
			}

		return $date->format('Y-m-d H:i:s');
		}
	}
© 2026 Bruce Wells
Search Namespaces \ Classes
Configuration