Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cs-eliseev/helpers-date

The helpers allows you to easy use DATE. Change format, add/sub day, diff date, get quarter - all this is available in this library.
https://github.com/cs-eliseev/helpers-date

collection collections converter cse date framework helper helpers library php tool tools utilities utility utils

Last synced: 11 days ago
JSON representation

The helpers allows you to easy use DATE. Change format, add/sub day, diff date, get quarter - all this is available in this library.

Awesome Lists containing this project

README

        

English | [Русский](https://github.com/cs-eliseev/helpers-date/blob/master/README.ru_RU.md)

DATE CSE HELPERS
=======

[![Travis (.org)](https://img.shields.io/travis/cs-eliseev/helpers-date.svg?style=flat-square)](https://travis-ci.org/cs-eliseev/helpers-date)
[![Codecov](https://img.shields.io/codecov/c/github/cs-eliseev/helpers-date.svg?style=flat-square)](https://codecov.io/gh/cs-eliseev/helpers-date)
[![Scrutinizer code quality](https://img.shields.io/scrutinizer/g/cs-eliseev/helpers-date.svg?style=flat-square)](https://scrutinizer-ci.com/g/cs-eliseev/helpers-date/?branch=master)

[![Packagist](https://img.shields.io/packagist/v/cse/helpers-date.svg?style=flat-square)](https://packagist.org/packages/cse/helpers-date)
[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg?style=flat-square)](https://packagist.org/packages/cse/helpers-date)
[![Packagist](https://img.shields.io/packagist/l/cse/helpers-date.svg?style=flat-square)](https://github.com/cs-eliseev/helpers-date/blob/master/LICENSE.md)
[![GitHub repo size](https://img.shields.io/github/repo-size/cs-eliseev/helpers-date.svg?style=flat-square)](https://github.com/cs-eliseev/helpers-date/archive/master.zip)

The helpers allows you to easy use DATE. Change format, add/sub day, diff date, get quarter - all this is available in this library.

Project repository: https://github.com/cs-eliseev/helpers-date

**DATE**
```php
if (Date::isToday($date)) {
$date = Date::changeDay($date, -7);
}
$mount = Date::diff($date, 'now', '%m');
Date::getQuarterByNumberMonth($mount);
```

***

## Introduction

[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) is a collection of several libraries with simple functions written in PHP for people.

Despite using PHP as the main programming language for the Internet, its functions are not enough.
DATE CSE HELPERS used method: change format, add/sub day, diff date, get quarter and other.

[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.

**CSE Helpers project:**
* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)
* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)
* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)
* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)
* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)
* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)
* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)
* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)
* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)
* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)
* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)

Below you will find some information on how to init library and perform common commands.

## Install

You can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-date).

### Composer

Execute the following command to get the latest version of the package:
```bash
composer require cse/helpers-date
```

Or file composer.json should include the following contents:
```json
{
"require": {
"cse/helpers-date": "*"
}
}
```

### Git

Clone this repository locally:
```bash
git clone https://github.com/cs-eliseev/helpers-date.git
```

### Download

[Download the latest release here](https://github.com/cs-eliseev/helpers-date/archive/master.zip).

## Usage

The class consists of static methods that are conveniently used in any project.
See example [examples-date.php](https://github.com/cs-eliseev/helpers-date/blob/master/examples/examples-date.php).

**GET time by date**

Example:
```php
Date::getTime('01.01.2018');
// 1514754000
```

Use current date:
```php
Date::getTime();
Date::getTime('now');
// timestemp
```

Use relative time:
```php
Date::getTime('+1 week 2 days 4 hours 2 seconds');
// timestemp
```

**Convert date to format**

Example:
```php
Date::toFormat('2018-01-01');
// 01.01.2018
```

Use timestamp:
```php
Date::toFormat(1514754000);
// 01.01.2018
```

Change default format:
```php
Date::toFormat(1514754000, 'Y/m/d');
// 2018/01/01
```

Use current date:
```php
Date::toFormat();
Date::toFormat('now');
// d.m.Y
```

Use relative time:
```php
Date::toFormat('+1 week 2 days 4 hours 2 seconds');
```

**Convert date to SQL**

Example:
```php
Date::toSQL('01.01.2018');
// 2018-01-01
```

Use timestamp:
```php
Date::toSQL(1514754000);
// 2018-01-01
```

Use current date:
```php
Date::toSQL();
Date::toSQL('now');
// Y-m-d
```

Use relative time:
```php
Date::toSQL('+1 week 2 days 4 hours 2 seconds');
// Y-m-d
```

**Diff date**

Example:
```php
Date::diff('2018-07-01', '2018-07-01');
// 0
```

Date format hour:
```php
Date::diff('2018-07-01 02:00:00', '01.01.2018 00:00:00', '%h');
// 2
```

Use timestamp:
```php
Date::diff(strtotime('2018-09-02'), strtotime('2018-07-02'), '%m'));
// 2
```

Other format:
```php
Date::diff('31.01.2018', 1514754000, '%d/%m'));
// 30/0
```

Current date:
```php
Date::diff('31.01.2018');
Date::diff('31.01.2018', 'now');
// %d
```

Use relative time:
```php
Date::diff'31.01.2018', '+1 week');
// %d
```

**Current date**

Example:
```php
Date::current();
// d.m.Y
```

Set format:
```php
Date::current(Date::FORMAT_SQL);
// Y-m-d
```

**Extreme month date**

Get last day month:
```php
Date::extremeMonthDate('11.01.2018');
// 2018-01-31
```

Get first day month:
```php
Date::extremeMonthDate('28.02.2018', 'Y-m-01');
// 2018-02-01
```

Use timestemp:
```php
Date::extremeMonthDate(strtotime('28.02.2018'), 'Y-m-01');
// 2018-02-01
```

Use current date:
```php
Date::extremeMonthDate();
Date::extremeMonthDate('now');
// Y-m-last_mounth_day
```

Use relative date:
```php
Date::extremeMonthDate('+1 week');
// Y-m-last_mounth_day + 1 week
```

**Get quarter**

Example:
```php
Date::getQuarter('31.12.2018 23:59:59');
// 4
```

Use timestemp:
```php
Date::getQuarter(1514754000);
// 1
```

Use current date:
```php
Date::getQuarter();
Date::getQuarter('now');
// quarter
```

Use relative time:
```php
Date::getQuarter('+1 week 2 days 4 hours 2 seconds');
// quarter
```

**Get quarter by number month**

Example:
```php
Date::getQuarterByNumberMonth(12);
// 4
```

**Change day**

Add day:
```php
Date::changeDay('01.01.2018', 1);
// 02.01.2018
```

Sub day:
```php
Date::changeDay('2018-01-01', -1);
// 31.12.2017
```

Change format:
```php
Date::changeDay('01.01.2018', -1, Date::FORMAT_SQL);
// 2017-12-31
```

Use timestamp:
```php
Date::changeDay(timestamp('01.01.2018'), -1, Date::FORMAT_SQL);
// 2017-12-31
```

**Check today**

Example:
```php
Date::isToday('01.01.2018 00:00:00');
// false
```

Use timestamp:
```php
Date::isToday(1519804800);
// false
```

Use relative time:
```php
Date::isToday('now');
// true
```

**Check date**

Example:
```php
Date::checkDateByTimestamp((new \DateTime('now'))->format('U'));
// true
```

**SET TIMEZONE**

Example:
```php
Date::setTimezone();
// UTC
```

Set timezone:
```php
Date::setTimezone('GMT');
// GMT
```

**GET TIMEZONE**

Example:
```php
Date::getTimezone();
// UTC
```

**IS TIMEZONE**

Example:
```php
Date::isTimezone();
// true
```

Set timezone:
```php
Date::isTimezone('GMT');
// false
```

## Testing & Code Coverage

PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.

General PHPUnit documentation can be found at https://phpunit.de/documentation.html.

To run the PHPUnit unit tests, execute:
```bash
phpunit PATH/TO/PROJECT/tests/
```

If you want code coverage reports, use the following:
```bash
phpunit --coverage-html ./report PATH/TO/PROJECT/tests/
```

Used PHPUnit default config:
```bash
phpunit --configuration PATH/TO/PROJECT/phpunit.xml
```

## Donating

You can support this project [here](https://www.paypal.me/cseliseev/10usd).
You can also help out by contributing to the project, or reporting bugs.
Even voicing your suggestions for features is great. Anything to help is much appreciated.

## License

The DATE CSE HELPERS is open-source PHP library licensed under the MIT license. Please see [License File](https://github.com/cs-eliseev/helpers-date/blob/master/LICENSE.md) for more information.

***

> GitHub [@cs-eliseev](https://github.com/cs-eliseev)