Intro
Date library for parsing, manipulating and formatting dates w/ i18n.
PHP 5.3 or later since moment.php is based on php's DateTime Class.
Install
Easy install via composer. Still no idea what composer is? Inform yourself here.
composer require fightbulc/moment
Quick examples
$m = new \Moment\Moment(); // default is "now" UTC
echo $m->format(); // e.g. 2012-10-03T10:00:00+0000
$m = new \Moment\Moment('now', 'Europe/Berlin');
echo $m->format(); // e.g. 2012-10-03T12:00:00+0200
$m = new \Moment\Moment('2017-06-06T10:00:00', 'Europe/Berlin');
echo $m->format(); // e.g. 2012-10-03T12:00:00+0200
$m = new \Moment\Moment(1499366585);
echo $m->format(); // e.g. 2017-07-06T18:43:05+0000
Moment parses the following date formats as input:
const ATOM = 'Y-m-d\TH:i:sP'; // 2005-08-15T15:52:01+00:00
const COOKIE = 'l, d-M-y H:i:s T'; // Monday, 15-Aug-2005 15:52:01 UTC
const ISO8601 = 'Y-m-d\TH:i:sO'; // 2005-08-15T15:52:01+0000
const RFC822 = 'D, d M y H:i:s O'; // Mon, 15 Aug 05 15:52:01 +0000
const RFC850 = 'l, d-M-y H:i:s T'; // Monday, 15-Aug-05 15:52:01 UTC
const RFC1036 = 'D, d M y H:i:s O'; // Mon, 15 Aug 05 15:52:01 +0000
const RFC1123 = 'D, d M Y H:i:s O'; // Mon, 15 Aug 2005 15:52:01 +0000
const RFC2822 = 'D, d M Y H:i:s O'; // Mon, 15 Aug 2005 15:52:01 +0000
const RSS = 'D, d M Y H:i:s O'; // Mon, 15 Aug 2005 15:52:01 +0000
const W3C = 'Y-m-d\TH:i:sP'; // 2005-08-15T15:52:01+00:00
// Moment also tries to parse dates without timezone or without seconds
const NO_TZ_MYSQL = 'Y-m-d H:i:s'; // 2005-08-15 15:52:01
const NO_TZ_NO_SECS = 'Y-m-d H:i'; // 2005-08-15 15:52
const NO_TIME = 'Y-m-d'; // 2005-08-15
// time fractions ".000" will be automatically removed
$timeWithFraction = '2016-05-04T10:00:00.000';
Have a look at the Locales
folder to see all supported languages. Default locale is en_GB
.
$m = new \Moment\Moment();
echo $m->format('[Weekday:] l'); // e.g. Weekday: Wednesday
// set german locale
\Moment\Moment::setLocale('de_DE');
$m = new \Moment\Moment();
echo $m->format('[Wochentag:] l'); // e.g. Wochentag: Mittwoch
Supported languages so far:
ar_TN
Arabic (Tunisia)ca_ES
Catalanzh_CN
Chinesezh_TW
Chinese (traditional)cs_CZ
Czechda_DK
Danishnl_NL
Dutchen_CA
English (Canada)en_GB
English (British)en_US
English (American)eo_EO
Esperantofa_IR
Farsifi_FI
Finnishfr_FR
French (Europe)fr_CA
French (Canada)de_DE
German (Germany)hu_HU
Hungarianid_ID
Indonesianit_IT
Italianja_JP
Japanesekz_KZ
Kazakhoc_LNC
Lengadocianlv_LV
Latvian (Latviešu)pl_PL
Polishpt_BR
Portuguese (Brazil)pt_PT
Portuguese (Portugal)ru_RU
Russian (Basic version)es_ES
Spanish (Europe)sv_SE
Swedishuk_UA
Ukrainianth_TH
Thaitr_TR
Turkishvi_VN
Vietnamese
$m = new \Moment\Moment('2012-04-25T03:00:00', 'CET');
echo $m->setTimezone('UTC')->format(); // 2012-04-25T01:00:00+0000
\Moment\Moment::setDefaultTimezone('CET');
$m = new \Moment\Moment('2016-09-13T14:32:06');
echo $m->format(); // 2016-09-13T14:32:06+0100
$m = new \Moment\Moment('2012-04-25T03:00:00', 'CET');
echo $m->format('l, dS F Y / H:i (e)'); // Wednesday, 25th April 2012 / 03:00 (Europe/Berlin)
Formats are based on PHP's Date function and DateTime class.
You can now inject different format handling by passing along a class which implements the FormatsInterface
. You can find an example within the test folder for implementing all formats from moment.js. Thanks to Ashish for taking the time to match moment.js
formats to those of PHP. Have a look at the test script to see the example in action.
Everybody can write format classes in the same manner. Its easy and scalable.
// get desired formats class
// create a moment
$m = new \Moment\Moment('2012-04-25T03:00:00', 'CET');
// format with moment.js definitions
echo $m->format('LLLL', new \Moment\CustomFormats\MomentJs()); // Wednesday, April 25th 2012 3:00 AM
Custom formats
can also come as part of every Locale
. If it does not exist for your locale yet go ahead and add it. See an example for the French locale.
Just wrap all your text within []
and all characters will be automatically escaped for you.
$m = new \Moment\Moment('2012-04-25T03:00:00', 'CET');
echo $m->format('[We are in the month of:] F'); // We are in the month of: April
PHP's interal ordinal calculation seems to be buggy. I added a quick fix to handle this issue.
The following example prints the week of the year of the given date. It should print 22nd
:
// internal function
date('WS', mktime(12, 22, 0, 5, 27, 2014)); // 22th
// moment.php
$m = new \Moment\Moment('2014-05-27T12:22:00', 'CET');
$m->format('WS'); // 22nd
$m = new \Moment\Moment('2012-05-15T12:30:00', 'CET');
echo $m->addHours(2)->format(); // 2012-05-15T14:30:00+0200
$m = new \Moment\Moment('2012-05-15T12:30:00', 'CET');
echo $m->subtractDays(7)->subtractMinutes(15)->format(); // 2012-05-08T12:15:00+0200
$m = new \Moment\Moment('@1401443979', 'CET'); // unix time
echo $m->subtractDays(7)->subtractMinutes(15)->format(); // 2014-05-23T09:44:39+0000
Sometimes its useful to take a given moment and work with it without changing the origin. For that use cloning()
.
$m = new \Moment\Moment('2012-05-15T12:30:00', 'CET');
$c = $m->cloning()->addDays(1);
echo $m->getDay(); // 15
echo $c->getDay(); // 16
Alternately, you can enable immutable mode on the origin.
$m = new \Moment\Moment('2012-05-15T12:30:00', 'CET', true);
$c = $m->addDays(1);
echo $m->getDay(); // 15
echo $c->getDay(); // 16
// You can also change the immutable mode after creation:
$m->setImmutableMode(false)->subtractDays(1);
echo $m->getDay(); // 14
Immutable mode makes all modification methods call cloning()
implicitly before applying their modifications.
Add | Subtract |
---|---|
addSeconds($s) | subtractSeconds($s) |
addMinutes($i) | subtractMinutes($i) |
addHours($h) | subtractHours($h) |
addDays($d) | subtractDays($d) |
addWeeks($w) | subtractWeeks($w) |
addMonths($m) | subtractMonths($m) |
addYears($y) | subtractYears($y) |
Setter | Getter |
---|---|
setSecond($s) | getSecond() |
setMinute($m) | getMinute() |
setHour($h) | getHour() |
setDay($d) | getDay() |
setMonth($m) | getMonth() |
setYear($y) | getYear() |
-- | getQuarter() |
$m = new \Moment\Moment('2013-02-01T07:00:00');
$momentFromVo = $m->fromNow();
// or from a specific moment
$m = new \Moment\Moment('2013-02-01T07:00:00');
$momentFromVo = $m->from('2011-09-25T10:00:00');
// result comes as a value object class
echo $momentFromVo->getDirection() // "future"
echo $momentFromVo->getSeconds() // -42411600
echo $momentFromVo->getMinutes() // -706860
echo $momentFromVo->getHours() // -11781
echo $momentFromVo->getDays() // -490.88
echo $momentFromVo->getWeeks() // -70.13
echo $momentFromVo->getMonths() // -17.53
echo $momentFromVo->getYears() // -1.42
echo $momentFromVo->getRelative() // in a year
Sometimes its helpful to get the period boundaries of a given date. For instance in case that today is Wednesday and I need the starting-/end dates from today's week. Allowed periods are week
, month
and quarter
.
$m = new \Moment\Moment('2013-10-23T10:00:00');
$momentPeriodVo = $m->getPeriod('week');
// results comes as well as a value object class
echo $momentPeriodVo
->getStartDate()
->format('Y-m-d'); // 2013-10-21
echo $momentPeriodVo
->getEndDate()
->format('Y-m-d'); // 2013-10-27
echo $momentPeriodVo
->getRefDate()
->format('Y-m-d'); // 2013-10-23
echo $momentPeriodVo->getInterval(); // 43 = week of year
Same procedure for monthly and quarterly periods:
$momentPeriodVo = $m->getPeriod('month');
$momentPeriodVo = $m->getPeriod('quarter');
Calendar time displays time relative to now
, but slightly differently than Moment::fromNow()
. Moment::calendar()
will format a date with different strings depending on how close to today the date is.
(new \Moment\Moment('2014-03-30T16:58:00', 'CET'))->subtractDays(6)->calendar(); // last week
(new \Moment\Moment('2014-03-30T16:58:00', 'CET'))->subtractDays(1)->calendar(); // yesterday
(new \Moment\Moment('2014-03-30T16:58:00', 'CET'))->calendar(); // today
(new \Moment\Moment('2014-03-30T16:58:00', 'CET'))->addDays(1)->calendar(); // tomorrow
(new \Moment\Moment('2014-03-30T16:58:00', 'CET'))->addDays(3)->calendar(); // next week
(new \Moment\Moment('2014-03-30T16:58:00', 'CET'))->addDays(10)->calendar(); // everything else
Time | Display |
---|---|
Last week | Last Monday at 15:54 |
The day before | Yesterday at 15:54 |
The same day | Today at 15:54 |
The next day | Tomorrow at 15:54 |
The next week | Wednesday at 15:54 |
Everything else | 04/09/2014 |
Note: Use $moment->calendar(false)
to leave out the time at 00:00
.
Same process as for moment.js: mutates the original moment by setting it to the start/end of a unit of time.
$m = new \Moment\Moment('20140515T10:15:23', 'CET');
$m->startOf('year'); // set to January 1st, 00:00 this year
$m->startOf('quarter'); // set to the beginning of the current quarter, 1st day of months, 00:00
$m->startOf('month'); // set to the first of this month, 00:00
$m->startOf('week'); // set to the first day of this week, 00:00
$m->startOf('day'); // set to 00:00 today
$m->startOf('hour'); // set to now, but with 0 mins, 0 secs
$m->startOf('minute'); // set to now, but with 0 seconds
$m->endOf('year'); // set to December 31st, 23:59 this year
$m->endOf('quarter'); // set to the end of the current quarter, last day of month, 23:59
$m->endOf('month'); // set to the last of this month, 23:59
$m->endOf('week'); // set to the last day of this week, 23:59
$m->endOf('day'); // set to 23:59 today
$m->endOf('hour'); // set to now, but with 59 mins, 59 secs
$m->endOf('minute'); // set to now, but with 59 seconds
Note: I ignored the period of second
since we are not dealing with milliseconds.
For one of my customers I needed to get moments by selected weekdays. The task was: give me the dates for Tuesdays
and Thursdays
for the next three weeks. So I added a small handler which does exactly this. As result you will receive an array filled with Moment Objects
.
// 1 - 7 = Mon - Sun
$weekdayNumbers = [
2, // tuesday
4, // thursday
];
$m = new \Moment\Moment();
$dates = $m->getMomentsByWeekdays($weekdayNumbers, 3);
// $dates = [Moment, Moment, Moment ...]
You can now run through the result and put it formatted into a drop-down field or for whatever you might need it.
Roadmap
Change Log
NO_TZ_MYSQL
, NO_TZ_NO_SECS
and NO_TIME
when parsing datesadded:
fixed:
$microseconds
calendar
locale receives as \Closure the following params function(Moment $m) {}
relativeTime
locale receives as \Closure the following params function($count, $direction, Moment $m) {}
token
e.g. the token within dS
is d
added:
getInterval()
to MomentPeriodVo
to indicate the interval of the given periodweek
= week of the yearmonth
= month of the yearquarter
= quarter of the yearMomentHelper
WS
for 21th week of the year shows now correct 21th
etc.[]
[Hello World]
will be automatically transformed into \H\e\l\l\o \W\o\r\l\d
removed:
fixed:
added:
MomentException
YYYY-mm-dd
and YYYY-mm-ddTHH:ii:ss
deprecated:
Support
I am a dad now for the last 1,5 years and that clearly shows in being on time with merging PRs or pushing this package further. Time is the biggest constraint here. I would be happy to pass the project on to somebody who has more time and the motivation to push the project forward. Just drop me a message. Cheers!
_ _
_ __ ___ ___ _ __ ___ ___ _ __ | |_ _ __ | |__ _ __
| '_ ` _ \ / _ \| '_ ` _ \ / _ \ '_ \| __| | '_ \| '_ \| '_ \
| | | | | | (_) | | | | | | __/ | | | |_ _| |_) | | | | |_) |
|_| |_| |_|\___/|_| |_| |_|\___|_| |_|\__(_) .__/|_| |_| .__/
|_| |_|
Author: fightbulc
Source Code: https://github.com/fightbulc/moment.php
License: View license
#php #i18n