https://github.com/withinboredom/time

A really simple library for converting time
https://github.com/withinboredom/time

php-library php8 time

Last synced: 3 months ago
JSON representation

A really simple library for converting time

• Host: GitHub
• URL: https://github.com/withinboredom/time
• Owner: withinboredom
• Created: 2022-03-20T14:26:32.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-07-10T16:57:55.000Z (6 months ago)
• Last Synced: 2024-09-29T20:23:29.651Z (3 months ago)
• Topics: php-library, php8, time
• Language: PHP
• Homepage:
• Size: 130 KB
• Stars: 12
• Watchers: 4
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# A really simple library for converting time

This is a simple library for interacting with time durations.

You can write your code to expect time and know that is what you have:

```php

function sleep(\Withinboredom\Time\Time $time): void {

    \sleep($time->as(\Withinboredom\Time\TimeUnit::Seconds));

}

sleep(\Withinboredom\Time\Minutes(5));

```

## Equality

All values of the same time are always strongly equaled to each other:

```php

\Withinboredom\Time\Minutes(60) === \Withinboredom\Time\Hours(1)

```

## Utilities

There are also a few utility methods:

> ->add(Time)->subtract(Time): AnyTime

Add and subtract durations.

> ->toDateInterval(): DateInterval

Creates a date interval for use in other things.

## Units

- Nanoseconds

- Microseconds

- Milliseconds

- Minutes

- Hours

- Days

- Weeks

## FAQ

> Why not months/years?

There's no set days in a month/year, so it’s better to use `DateInterval` for those types of measures.

> Why does this exist?

I don’t like [magic numbers](https://en.wikipedia.org/wiki/Magic_number_(programming)#:~:text=Magic%20numbers%20are%20common%20in%20programs%20across%20many,have%20such%20constants%20that%20identify%20the%20contained%20data.).

> How performant is this?

The main overhead is in autoloading and function-call overhead. Thus, if realtime performance is a concern, you might

want to stick to magic numbers.

## Developing

If you wish to create a PR or update the code here:

1. Clone the repo

2. `composer install` to install test dependencies

3. `yarn` to install git hooks for formatting

4. Open in favorite IDE.

## Code Standards

[Per](https://www.php-fig.org/per/coding-style/) coding styles are followed.