README

English | Русский

DATE CSE HELPERS

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

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

Introduction

CSE HELPERS 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 was created for the rapid development of web applications.

CSE Helpers project:

• Array CSE helpers
• Cookie CSE helpers
• Date CSE helpers
• Email CSE helpers
• IP CSE helpers
• Json CSE helpers
• Math Converter CSE helpers
• Phone CSE helpers
• Request CSE helpers
• Session CSE helpers
• Word CSE helpers

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.

Composer

Execute the following command to get the latest version of the package:

composer require cse/helpers-date

Or file composer.json should include the following contents:

{
    "require": {
        "cse/helpers-date": "*"
    }
}

Git

Clone this repository locally:

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

Download

Download the latest release here.

Usage

The class consists of static methods that are conveniently used in any project. See example examples-date.php.

GET time by date

Example:

Date::getTime('01.01.2018');
// 1514754000

Use current date:

Date::getTime();
Date::getTime('now');
// timestemp

Use relative time:

Date::getTime('+1 week 2 days 4 hours 2 seconds');
// timestemp

Convert date to format

Example:

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

Use timestamp:

Date::toFormat(1514754000);
// 01.01.2018

Change default format:

Date::toFormat(1514754000, 'Y/m/d');
// 2018/01/01

Use current date:

Date::toFormat();
Date::toFormat('now');
// d.m.Y

Use relative time:

Date::toFormat('+1 week 2 days 4 hours 2 seconds');

Convert date to SQL

Example:

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

Use timestamp:

Date::toSQL(1514754000);
// 2018-01-01

Use current date:

Date::toSQL();
Date::toSQL('now');
// Y-m-d

Use relative time:

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

Diff date

Example:

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

Date format hour:

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

Use timestamp:

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

Other format:

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

Current date:

Date::diff('31.01.2018');
Date::diff('31.01.2018', 'now');
// %d

Use relative time:

Date::diff'31.01.2018', '+1 week');
// %d

Current date

Example:

Date::current();
// d.m.Y

Set format:

Date::current(Date::FORMAT_SQL);
// Y-m-d

Extreme month date

Get last day month:

Date::extremeMonthDate('11.01.2018');
// 2018-01-31

Get first day month:

Date::extremeMonthDate('28.02.2018', 'Y-m-01');
// 2018-02-01

Use timestemp:

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

Use current date:

Date::extremeMonthDate();
Date::extremeMonthDate('now');
// Y-m-last_mounth_day

Use relative date:

Date::extremeMonthDate('+1 week');
// Y-m-last_mounth_day + 1 week

Get quarter

Example:

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

Use timestemp:

Date::getQuarter(1514754000);
// 1

Use current date:

Date::getQuarter();
Date::getQuarter('now');
// quarter

Use relative time:

Date::getQuarter('+1 week 2 days 4 hours 2 seconds');
// quarter

Get quarter by number month

Example:

Date::getQuarterByNumberMonth(12);
// 4

Change day

Add day:

Date::changeDay('01.01.2018', 1);
// 02.01.2018

Sub day:

Date::changeDay('2018-01-01', -1);
// 31.12.2017

Change format:

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

Use timestamp:

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

Check today

Example:

Date::isToday('01.01.2018 00:00:00');
// false

Use timestamp:

Date::isToday(1519804800);
// false

Use relative time:

Date::isToday('now');
// true

Check date

Example:

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

SET TIMEZONE

Example:

Date::setTimezone();
// UTC

Set timezone:

Date::setTimezone('GMT');
// GMT

GET TIMEZONE

Example:

Date::getTimezone();
// UTC

IS TIMEZONE

Example:

Date::isTimezone();
// true

Set timezone:

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:

phpunit PATH/TO/PROJECT/tests/

If you want code coverage reports, use the following:

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

Used PHPUnit default config:

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

Donating

You can support this project here. 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 for more information.

GitHub @cs-eliseev