123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603 |
- <?php
- /**
- * Date helper.
- *
- * @package Kohana
- * @category Helpers
- * @author Kohana Team
- * @copyright (c) Kohana Team
- * @license https://koseven.ga/LICENSE.md
- */
- class Kohana_Date {
- // Second amounts for various time increments
- const YEAR = 31556926;
- const MONTH = 2629744;
- const WEEK = 604800;
- const DAY = 86400;
- const HOUR = 3600;
- const MINUTE = 60;
- // Available formats for Date::months()
- const MONTHS_LONG = '%B';
- const MONTHS_SHORT = '%b';
- /**
- * Default timestamp format for formatted_time
- * @var string
- */
- public static $timestamp_format = 'Y-m-d H:i:s';
- /**
- * Timezone for formatted_time
- * @link http://uk2.php.net/manual/en/timezones.php
- * @var string
- */
- public static $timezone;
- /**
- * Returns the offset (in seconds) between two time zones. Use this to
- * display dates to users in different time zones.
- *
- * $seconds = Date::offset('America/Chicago', 'GMT');
- *
- * [!!] A list of time zones that PHP supports can be found at
- * <http://php.net/timezones>.
- *
- * @param string $remote timezone that to find the offset of
- * @param string $local timezone used as the baseline
- * @param mixed $now UNIX timestamp or date string
- * @return integer
- */
- public static function offset($remote, $local = NULL, $now = NULL)
- {
- if ($local === NULL)
- {
- // Use the default timezone
- $local = date_default_timezone_get();
- }
- if (is_int($now))
- {
- // Convert the timestamp into a string
- $now = date(DateTime::RFC2822, $now);
- }
- // Create timezone objects
- $zone_remote = new DateTimeZone($remote);
- $zone_local = new DateTimeZone($local);
- // Create date objects from timezones
- $time_remote = new DateTime($now, $zone_remote);
- $time_local = new DateTime($now, $zone_local);
- // Find the offset
- $offset = $zone_remote->getOffset($time_remote) - $zone_local->getOffset($time_local);
- return $offset;
- }
- /**
- * Number of seconds in a minute, incrementing by a step. Typically used as
- * a shortcut for generating a list that can used in a form.
- *
- * $seconds = Date::seconds(); // 01, 02, 03, ..., 58, 59, 60
- *
- * @param integer $step amount to increment each step by, 1 to 30
- * @param integer $start start value
- * @param integer $end end value
- * @return array A mirrored (foo => foo) array from 1-60.
- */
- public static function seconds($step = 1, $start = 0, $end = 60)
- {
- // Always integer
- $step = (int) $step;
- $seconds = [];
- for ($i = $start; $i < $end; $i += $step)
- {
- $seconds[$i] = sprintf('%02d', $i);
- }
- return $seconds;
- }
- /**
- * Number of minutes in an hour, incrementing by a step. Typically used as
- * a shortcut for generating a list that can be used in a form.
- *
- * $minutes = Date::minutes(); // 05, 10, 15, ..., 50, 55, 60
- *
- * @uses Date::seconds
- * @param integer $step amount to increment each step by, 1 to 30
- * @return array A mirrored (foo => foo) array from 1-60.
- */
- public static function minutes($step = 5)
- {
- // Because there are the same number of minutes as seconds in this set,
- // we choose to re-use seconds(), rather than creating an entirely new
- // function. Shhhh, it's cheating! ;) There are several more of these
- // in the following methods.
- return Date::seconds($step);
- }
- /**
- * Number of hours in a day. Typically used as a shortcut for generating a
- * list that can be used in a form.
- *
- * $hours = Date::hours(); // 01, 02, 03, ..., 10, 11, 12
- *
- * @param integer $step amount to increment each step by
- * @param boolean $long use 24-hour time
- * @param integer $start the hour to start at
- * @return array A mirrored (foo => foo) array from start-12 or start-23.
- */
- public static function hours($step = 1, $long = FALSE, $start = NULL)
- {
- // Default values
- $step = (int) $step;
- $long = (bool) $long;
- $hours = [];
- // Set the default start if none was specified.
- if ($start === NULL)
- {
- $start = ($long === FALSE) ? 1 : 0;
- }
- $hours = [];
- // 24-hour time has 24 hours, instead of 12
- $size = ($long === TRUE) ? 23 : 12;
- for ($i = $start; $i <= $size; $i += $step)
- {
- $hours[$i] = (string) $i;
- }
- return $hours;
- }
- /**
- * Returns AM or PM, based on a given hour (in 24 hour format).
- *
- * $type = Date::ampm(12); // PM
- * $type = Date::ampm(1); // AM
- *
- * @param integer $hour number of the hour
- * @return string
- */
- public static function ampm($hour)
- {
- // Always integer
- $hour = (int) $hour;
- return ($hour > 11) ? 'PM' : 'AM';
- }
- /**
- * Adjusts a non-24-hour number into a 24-hour number.
- *
- * $hour = Date::adjust(3, 'pm'); // 15
- *
- * @param integer $hour hour to adjust
- * @param string $ampm AM or PM
- * @return string
- */
- public static function adjust($hour, $ampm)
- {
- $hour = (int) $hour;
- $ampm = strtolower($ampm);
- switch ($ampm)
- {
- case 'am':
- if ($hour == 12)
- {
- $hour = 0;
- }
- break;
- case 'pm':
- if ($hour < 12)
- {
- $hour += 12;
- }
- break;
- }
- return sprintf('%02d', $hour);
- }
- /**
- * Number of days in a given month and year. Typically used as a shortcut
- * for generating a list that can be used in a form.
- *
- * Date::days(4, 2010); // 1, 2, 3, ..., 28, 29, 30
- *
- * @param integer $month number of month
- * @param integer $year number of year to check month, defaults to the current year
- * @return array A mirrored (foo => foo) array of the days.
- */
- public static function days($month, $year = FALSE)
- {
- static $months;
- if ($year === FALSE)
- {
- // Use the current year by default
- $year = date('Y');
- }
- // Always integers
- $month = (int) $month;
- $year = (int) $year;
- // We use caching for months, because time functions are used
- if (empty($months[$year][$month]))
- {
- $months[$year][$month] = [];
- // Use date to find the number of days in the given month
- $total = date('t', mktime(1, 0, 0, $month, 1, $year)) + 1;
- for ($i = 1; $i < $total; $i++)
- {
- $months[$year][$month][$i] = (string) $i;
- }
- }
- return $months[$year][$month];
- }
- /**
- * Number of months in a year. Typically used as a shortcut for generating
- * a list that can be used in a form.
- *
- * By default a mirrored array of $month_number => $month_number is returned
- *
- * Date::months();
- * // aray(1 => 1, 2 => 2, 3 => 3, ..., 12 => 12)
- *
- * But you can customise this by passing in either Date::MONTHS_LONG
- *
- * Date::months(Date::MONTHS_LONG);
- * // array(1 => 'January', 2 => 'February', ..., 12 => 'December')
- *
- * Or Date::MONTHS_SHORT
- *
- * Date::months(Date::MONTHS_SHORT);
- * // array(1 => 'Jan', 2 => 'Feb', ..., 12 => 'Dec')
- *
- * @uses Date::hours
- * @param string $format The format to use for months
- * @return array An array of months based on the specified format
- */
- public static function months($format = NULL)
- {
- $months = [];
- if ($format === Date::MONTHS_LONG OR $format === Date::MONTHS_SHORT)
- {
- for ($i = 1; $i <= 12; ++$i)
- {
- $months[$i] = strftime($format, mktime(0, 0, 0, $i, 1));
- }
- }
- else
- {
- $months = Date::hours();
- }
- return $months;
- }
- /**
- * Returns an array of years between a starting and ending year. By default,
- * the the current year - 5 and current year + 5 will be used. Typically used
- * as a shortcut for generating a list that can be used in a form.
- *
- * $years = Date::years(2000, 2010); // 2000, 2001, ..., 2009, 2010
- *
- * @param integer $start starting year (default is current year - 5)
- * @param integer $end ending year (default is current year + 5)
- * @return array
- */
- public static function years($start = FALSE, $end = FALSE)
- {
- // Default values
- $start = ($start === FALSE) ? (date('Y') - 5) : (int) $start;
- $end = ($end === FALSE) ? (date('Y') + 5) : (int) $end;
- $years = [];
- for ($i = $start; $i <= $end; $i++)
- {
- $years[$i] = (string) $i;
- }
- return $years;
- }
- /**
- * Returns time difference between two timestamps, in human readable format.
- * If the second timestamp is not given, the current time will be used.
- * Also consider using [Date::fuzzy_span] when displaying a span.
- *
- * $span = Date::span(60, 182, 'minutes,seconds'); // array('minutes' => 2, 'seconds' => 2)
- * $span = Date::span(60, 182, 'minutes'); // 2
- *
- * @param integer $remote timestamp to find the span of
- * @param integer $local timestamp to use as the baseline
- * @param string $output formatting string
- * @return string when only a single output is requested
- * @return array associative list of all outputs requested
- */
- public static function span($remote, $local = NULL, $output = 'years,months,weeks,days,hours,minutes,seconds')
- {
- // Normalize output
- $output = trim(strtolower( (string) $output));
- if ( ! $output)
- {
- // Invalid output
- return FALSE;
- }
- // Array with the output formats
- $output = preg_split('/[^a-z]+/', $output);
- // Convert the list of outputs to an associative array
- $output = array_combine($output, array_fill(0, count($output), 0));
- // Make the output values into keys
- extract(array_flip($output), EXTR_SKIP);
- if ($local === NULL)
- {
- // Calculate the span from the current time
- $local = time();
- }
- // Calculate timespan (seconds)
- $timespan = abs($remote - $local);
- if (isset($output['years']))
- {
- $timespan -= Date::YEAR * ($output['years'] = (int) floor($timespan / Date::YEAR));
- }
- if (isset($output['months']))
- {
- $timespan -= Date::MONTH * ($output['months'] = (int) floor($timespan / Date::MONTH));
- }
- if (isset($output['weeks']))
- {
- $timespan -= Date::WEEK * ($output['weeks'] = (int) floor($timespan / Date::WEEK));
- }
- if (isset($output['days']))
- {
- $timespan -= Date::DAY * ($output['days'] = (int) floor($timespan / Date::DAY));
- }
- if (isset($output['hours']))
- {
- $timespan -= Date::HOUR * ($output['hours'] = (int) floor($timespan / Date::HOUR));
- }
- if (isset($output['minutes']))
- {
- $timespan -= Date::MINUTE * ($output['minutes'] = (int) floor($timespan / Date::MINUTE));
- }
- // Seconds ago, 1
- if (isset($output['seconds']))
- {
- $output['seconds'] = $timespan;
- }
- if (count($output) === 1)
- {
- // Only a single output was requested, return it
- return array_pop($output);
- }
- // Return array
- return $output;
- }
- /**
- * Returns the difference between a time and now in a "fuzzy" way.
- * Displaying a fuzzy time instead of a date is usually faster to read and understand.
- *
- * $span = Date::fuzzy_span(time() - 10); // "moments ago"
- * $span = Date::fuzzy_span(time() + 20); // "in moments"
- *
- * A second parameter is available to manually set the "local" timestamp,
- * however this parameter shouldn't be needed in normal usage and is only
- * included for unit tests
- *
- * @param integer $timestamp "remote" timestamp
- * @param integer $local_timestamp "local" timestamp, defaults to time()
- * @return string
- */
- public static function fuzzy_span($timestamp, $local_timestamp = NULL)
- {
- $local_timestamp = ($local_timestamp === NULL) ? time() : (int) $local_timestamp;
- // Determine the difference in seconds
- $offset = abs($local_timestamp - $timestamp);
- if ($offset <= Date::MINUTE)
- {
- $span = 'moments';
- }
- elseif ($offset < (Date::MINUTE * 20))
- {
- $span = 'a few minutes';
- }
- elseif ($offset < Date::HOUR)
- {
- $span = 'less than an hour';
- }
- elseif ($offset < (Date::HOUR * 4))
- {
- $span = 'a couple of hours';
- }
- elseif ($offset < Date::DAY)
- {
- $span = 'less than a day';
- }
- elseif ($offset < (Date::DAY * 2))
- {
- $span = 'about a day';
- }
- elseif ($offset < (Date::DAY * 4))
- {
- $span = 'a couple of days';
- }
- elseif ($offset < Date::WEEK)
- {
- $span = 'less than a week';
- }
- elseif ($offset < (Date::WEEK * 2))
- {
- $span = 'about a week';
- }
- elseif ($offset < Date::MONTH)
- {
- $span = 'less than a month';
- }
- elseif ($offset < (Date::MONTH * 2))
- {
- $span = 'about a month';
- }
- elseif ($offset < (Date::MONTH * 4))
- {
- $span = 'a couple of months';
- }
- elseif ($offset < Date::YEAR)
- {
- $span = 'less than a year';
- }
- elseif ($offset < (Date::YEAR * 2))
- {
- $span = 'about a year';
- }
- elseif ($offset < (Date::YEAR * 4))
- {
- $span = 'a couple of years';
- }
- elseif ($offset < (Date::YEAR * 8))
- {
- $span = 'a few years';
- }
- elseif ($offset < (Date::YEAR * 12))
- {
- $span = 'about a decade';
- }
- elseif ($offset < (Date::YEAR * 24))
- {
- $span = 'a couple of decades';
- }
- elseif ($offset < (Date::YEAR * 64))
- {
- $span = 'several decades';
- }
- else
- {
- $span = 'a long time';
- }
- if ($timestamp <= $local_timestamp)
- {
- // This is in the past
- return $span.' ago';
- }
- else
- {
- // This in the future
- return 'in '.$span;
- }
- }
- /**
- * Converts a UNIX timestamp to DOS format. There are very few cases where
- * this is needed, but some binary formats use it (eg: zip files.)
- * Converting the other direction is done using {@link Date::dos2unix}.
- *
- * $dos = Date::unix2dos($unix);
- *
- * @param integer $timestamp UNIX timestamp
- * @return integer
- */
- public static function unix2dos($timestamp = FALSE)
- {
- $timestamp = ($timestamp === FALSE) ? getdate() : getdate($timestamp);
- if ($timestamp['year'] < 1980)
- {
- return (1 << 21 | 1 << 16);
- }
- $timestamp['year'] -= 1980;
- // What voodoo is this? I have no idea... Geert can explain it though,
- // and that's good enough for me.
- return ($timestamp['year'] << 25 | $timestamp['mon'] << 21 |
- $timestamp['mday'] << 16 | $timestamp['hours'] << 11 |
- $timestamp['minutes'] << 5 | $timestamp['seconds'] >> 1);
- }
- /**
- * Converts a DOS timestamp to UNIX format.There are very few cases where
- * this is needed, but some binary formats use it (eg: zip files.)
- * Converting the other direction is done using {@link Date::unix2dos}.
- *
- * $unix = Date::dos2unix($dos);
- *
- * @param integer $timestamp DOS timestamp
- * @return integer
- */
- public static function dos2unix($timestamp = FALSE)
- {
- $sec = 2 * ($timestamp & 0x1f);
- $min = ($timestamp >> 5) & 0x3f;
- $hrs = ($timestamp >> 11) & 0x1f;
- $day = ($timestamp >> 16) & 0x1f;
- $mon = ($timestamp >> 21) & 0x0f;
- $year = ($timestamp >> 25) & 0x7f;
- return mktime($hrs, $min, $sec, $mon, $day, $year + 1980);
- }
- /**
- * Returns a date/time string with the specified timestamp format
- *
- * $time = Date::formatted_time('5 minutes ago');
- *
- * @link http://www.php.net/manual/datetime.construct
- * @param string $datetime_str datetime string
- * @param string $timestamp_format timestamp format
- * @param string $timezone timezone identifier
- * @return string
- */
- public static function formatted_time($datetime_str = 'now', $timestamp_format = NULL, $timezone = NULL)
- {
- $timestamp_format = ($timestamp_format == NULL) ? Date::$timestamp_format : $timestamp_format;
- $timezone = ($timezone === NULL) ? Date::$timezone : $timezone;
- $tz = new DateTimeZone($timezone ? $timezone : date_default_timezone_get());
- $time = new DateTime($datetime_str, $tz);
- // Convert the time back to the expected timezone if required (in case the datetime_str provided a timezone,
- // offset or unix timestamp. This also ensures that the timezone reported by the object is correct on HHVM
- // (see https://github.com/facebook/hhvm/issues/2302).
- $time->setTimeZone($tz);
- return $time->format($timestamp_format);
- }
- }
|