stevegrunwell / time-constants
A series of constants designed to make it easier to express time in PHP applications
Installs: 326 919
Dependents: 2
Suggesters: 0
Security: 0
Stars: 27
Watchers: 4
Forks: 8
Open Issues: 0
Requires
- php: ^7.0 | ^8.0
Requires (Dev)
README
The Time Constants package defines a number of useful PHP constants within your application, making it easier to express measures of time.
For example, assume we have a cache()
function that accepts three arguments:
- The cache key.
- The value to cache.
- The amount of time (in seconds) to cache the value.
Currently, caching a value for 24 hours might look something like this:
cache($cacheKey, $value, 24 * 60 * 60);
Instead of spending the time figuring out what 24 * 60 * 60
means (or the fact that 86400
is meant to be one day in seconds), Time Constants allows you to represent the time using an easy-to-understand PHP constant:
cache($cacheKey, $value, \TimeConstants\DAY_IN_SECONDS);
If the requirements changed and we needed to cache the value for multiple days, we can rewrite it as:
cache($cacheKey, $value, 5 * \TimeConstants\DAY_IN_SECONDS);
These constants may seem familiar to WordPress developers, as they're absolutely inspired by WordPress' use of time constants. This package goes a bit further, however, adding *_IN_MINUTES
constants, for easier use with libraries like Laravel's Cache
facade.
Installation
Time Constants is intended to be installed via Composer:
$ composer require stevegrunwell/time-constants
The package has been configured to automatically expose the constants.php
file via the Composer-generated autoloader, so you'll be ready to use the constants as soon as the package has been installed!
Defined constants
This is a list of all constants defined by this package, along with their values. Each constant is wrapped in a if (! defined(...))
conditional, ensuring these constants can easily be redefined if necessary and won't conflict with existing constants.
As of version 2.0.0 of this library, all of these constants are defined in the TimeConstants
namespace. If you are upgrading from version 1.x, please see the 2.0.0 release notes for notes about migration.
Please note that these constants are defined for convenience, and not necessarily for accuracy; all months are treated as 30 days, and years as 365 days. If you need support for leap years or more advanced measures of time, you might consider PHP's
DateTime
class or Nesbot's Carbon package.
Time based in seconds
ONE_SECOND
(1 second)MINUTE_IN_SECONDS
(60 seconds)HOUR_IN_SECONDS
(3600 seconds)DAY_IN_SECONDS
(86,400 seconds)WEEK_IN_SECONDS
(604,800 seconds)MONTH_IN_SECONDS
(2,592,000 seconds)YEAR_IN_SECONDS
(31,536,000 seconds)
Time based in minutes
ONE_MINUTE
(1 minute)HOUR_IN_MINUTES
(60 minutes)DAY_IN_MINUTES
(1,440 minutes)WEEK_IN_MINUTES
(10,080 minutes)MONTH_IN_MINUTES
(43,200 minutes)YEAR_IN_MINUTES
(525,600 minutes)
Multipliers
These can be helpful when dealing with fractions of a second. For example, all of the following are equivalent:
6000 === (6 * ONE_SECOND) * 1000 === 6 * MILLISECONDS_PER_SECOND
MILLISECONDS_PER_SECOND
(1,000ms/s)MICROSECONDS_PER_SECOND
(1,000,000µs/s)NANOSECONDS_PER_SECOND
(1,000,000,000ns/s)PICOSECONDS_PER_SECOND
(1,000,000,000,000ps/s)