moment.php
8.1
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!
_ _ _ __ ___ ___ _ __ ___ ___ _ __ | |_ _ __ | |__ _ __ | '_ ` _ / _ | '_ ` _ / _ '_ | __| | '_ | '_ | '_ | | | | | | (_) | | | | | | __/ | | | |_ _| |_) | | | | |_) | |_| |_| |_|___/|_| |_| |_|___|_| |_|__(_) .__/|_| |_| .__/ |_| |_|
Change log
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.
Easy install via composer. Still no idea what composer is? Inform yourself here.
composer require fightbulc/moment
$m = new MomentMoment(); // default is "now" UTCecho $m->format(); // e.g. 2012-10-03T10:00:00+0000$m = new MomentMoment('now', 'Europe/Berlin');echo $m->format(); // e.g. 2012-10-03T12:00:00+0200$m = new MomentMoment('2017-06-06T10:00:00', 'Europe/Berlin');echo $m->format(); // e.g. 2012-10-03T12:00:00+0200$m = new MomentMoment(1499366585);echo $m->format(); // e.g. 2017-07-06T18:43:05+0000Moment parses the following date formats as input:
const ATOM = 'Y-m-dTH:i:sP'; // 2005-08-15T15:52:01+00:00const COOKIE = 'l, d-M-y H:i:s T'; // Monday, 15-Aug-2005 15:52:01 UTCconst ISO8601 = 'Y-m-dTH:i:sO'; // 2005-08-15T15:52:01+0000const RFC822 = 'D, d M y H:i:s O'; // Mon, 15 Aug 05 15:52:01 +0000const RFC850 = 'l, d-M-y H:i:s T'; // Monday, 15-Aug-05 15:52:01 UTCconst RFC1036 = 'D, d M y H:i:s O'; // Mon, 15 Aug 05 15:52:01 +0000const RFC1123 = 'D, d M Y H:i:s O'; // Mon, 15 Aug 2005 15:52:01 +0000const RFC2822 = 'D, d M Y H:i:s O'; // Mon, 15 Aug 2005 15:52:01 +0000const RSS = 'D, d M Y H:i:s O'; // Mon, 15 Aug 2005 15:52:01 +0000const W3C = 'Y-m-dTH:i:sP'; // 2005-08-15T15:52:01+00:00// Moment also tries to parse dates without timezone or without secondsconst NO_TZ_MYSQL = 'Y-m-d H:i:s'; // 2005-08-15 15:52:01const NO_TZ_NO_SECS = 'Y-m-d H:i'; // 2005-08-15 15:52const 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 MomentMoment();echo $m->format('[Weekday:] l'); // e.g. Weekday: Wednesday// set german localeMomentMoment::setLocale('de_DE');$m = new MomentMoment();echo $m->format('[Wochentag:] l'); // e.g. Wochentag: MittwochSupported languages so far:
ar_TN Arabic (Tunisia)ca_ES Catalancs_CZ Czechda_DK Danishde_DE German (Germany)en_CA English (Canada)en_GB English (British)en_US English (American)eo_EO Esperantoes_ES Spanish (Europe)fa_IR Farsifi_FI Finnishfr_CA French (Canada)fr_FR French (Europe)hu_HU Hungarianid_ID Indonesianit_IT Italianja_JP Japanesekz_KZ Kazakhlv_LV Latvian (Latviešu)nl_NL Dutchoc_LNC Lengadocianpl_PL Polishpt_BR Portuguese (Brazil)pt_PT Portuguese (Portugal)ru_RU Russian (Basic version)sv_SE Swedishth_TH Thaitr_TR Turkishuk_UA Ukrainianvi_VN Vietnamesezh_CN Chinesezh_TW Chinese (traditional)
$m = new MomentMoment('2012-04-25T03:00:00', 'CET');echo $m->setTimezone('UTC')->format(); // 2012-04-25T01:00:00+0000MomentMoment::setDefaultTimezone('CET');$m = new MomentMoment('2016-09-13T14:32:06');echo $m->format(); // 2016-09-13T14:32:06+0100$m = new MomentMoment('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 MomentMoment('2012-04-25T03:00:00', 'CET');// format with moment.js definitionsecho $m->format('LLLL', new MomentCustomFormatsMomentJs()); // Wednesday, April 25th 2012 3:00 AMCustom 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 MomentMoment('2012-04-25T03:00:00', 'CET');echo $m->format('[We are in the month of:] F'); // We are in the month of: AprilPHP'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 functiondate('WS', mktime(12, 22, 0, 5, 27, 2014)); // 22th// moment.php$m = new MomentMoment('2014-05-27T12:22:00', 'CET');$m->format('WS'); // 22nd$m = new MomentMoment('2012-05-15T12:30:00', 'CET');echo $m->addHours(2)->format(); // 2012-05-15T14:30:00+0200$m = new MomentMoment('2012-05-15T12:30:00', 'CET');echo $m->subtractDays(7)->subtractMinutes(15)->format(); // 2012-05-08T12:15:00+0200$m = new MomentMoment('@1401443979', 'CET'); // unix timeecho $m->subtractDays(7)->subtractMinutes(15)->format(); // 2014-05-23T09:44:39+0000Sometimes its useful to take a given moment and work with it without changing the origin. For that use cloning().
$m = new MomentMoment('2012-05-15T12:30:00', 'CET');$c = $m->cloning()->addDays(1);echo $m->getDay(); // 15echo $c->getDay(); // 16Alternately, you can enable immutable mode on the origin.
$m = new MomentMoment('2012-05-15T12:30:00', 'CET', true);$c = $m->addDays(1);echo $m->getDay(); // 15echo $c->getDay(); // 16// You can also change the immutable mode after creation:$m->setImmutableMode(false)->subtractDays(1);echo $m->getDay(); // 14Immutable 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 MomentMoment('2013-02-01T07:00:00');$momentFromVo = $m->fromNow();// or from a specific moment$m = new MomentMoment('2013-02-01T07:00:00');$momentFromVo = $m->from('2011-09-25T10:00:00');// result comes as a value object classecho $momentFromVo->getDirection() // "future"echo $momentFromVo->getSeconds() // -42411600echo $momentFromVo->getMinutes() // -706860echo $momentFromVo->getHours() // -11781echo $momentFromVo->getDays() // -490.88echo $momentFromVo->getWeeks() // -70.13echo $momentFromVo->getMonths() // -17.53echo $momentFromVo->getYears() // -1.42echo $momentFromVo->getRelative() // in a yearSometimes 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 MomentMoment('2013-10-23T10:00:00');$momentPeriodVo = $m->getPeriod('week');// results comes as well as a value object classecho $momentPeriodVo->getStartDate()
->format('Y-m-d'); // 2013-10-21echo $momentPeriodVo->getEndDate()
->format('Y-m-d'); // 2013-10-27echo $momentPeriodVo->getRefDate()
->format('Y-m-d'); // 2013-10-23echo $momentPeriodVo->getInterval(); // 43 = week of yearSame 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 MomentMoment('2014-03-30T16:58:00', 'CET'))->subtractDays(6)->calendar(); // last week(new MomentMoment('2014-03-30T16:58:00', 'CET'))->subtractDays(1)->calendar(); // yesterday(new MomentMoment('2014-03-30T16:58:00', 'CET'))->calendar(); // today(new MomentMoment('2014-03-30T16:58:00', 'CET'))->addDays(1)->calendar(); // tomorrow(new MomentMoment('2014-03-30T16:58:00', 'CET'))->addDays(3)->calendar(); // next week(new MomentMoment('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 MomentMoment('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 secondsNote: 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 forTuesdays 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, // tuesday4, // thursday];$m = new MomentMoment();$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.
Try to port useful methods from moment.js
Add unit tests
added:
support for PHP 8.2 #218
support for PHP 8.3 #227
fixed:
French locale
Canadian tests
added:
Esperanto locale
Kazakh locale
fixed:
DateTime::createFromFormat signature match
added:
Farsi locale
added:
code checks vis GH action workflows
Canadian locale for English/French
fixed:
merge with a couple of PRs (thanks!)
added:
Finish locale
fixed:
Swedish locale
updated Italian locale
added:
custom formats for en_US
flag for loading similar locale
fixed typehint issue
fixed:
missing relativeTime format
allow 9-digit unixtime
fixed RFC2822 as valid format
fixed relative time
added Norwegian locale
fixes and locale additions (see commits for the 22.11.2018)
fixed:
Occitan locale
fixed:
Russian locale issue
added:
Portuguese (pt_PT)
fixed:
Hungarian locale weekdays order
added:
allow initialising Moment with unix timestamp without leading @
fixed:
Fix format of 'LLL' in Custom Formats
fixed:
removed php5.4+ only syntax
fixed:
Danish day- and monthnames correct case
French locale
PHPDocs
added:
consts for NO_TZ_MYSQL, NO_TZ_NO_SECS and NO_TIME when parsing dates
added:
Dutch customFormat
fixed:
Russian locale
added:
Turkish locale
fixed:
Lengadocian locale
fixed:
PHP7.1 setTime requires $microseconds
added:
Ukrainian locale
added:
Hungarian locale
fixed:
Lengadocian locale
added:
Vietnamese locale
Lengadocian locale
added:
Change default timezone
fixed:
FormatsInterface docs
added:
Arabic locale
Custom format on locale level
fixed:
Russian locale
added:
Russian locale tests
fixed:
Polish locale
Calculation of seconds
fixed:
Russian: more relative time fixes
fixed:
Russian locale relative time: day handling
fixed:
missing immutable handling
fixed:
Improved Polish locale (added Nominativ)
fixed:
Chinese locale
added accepted formats to README
fixed:
Thai locale
added:
Catalan locale
fixed:
Polish locale test
added:
Russian locale
fixed:
Polish locale test
added:
Immutable mode
fixed:
Polish locale
added:
Polish locale
added:
Indonesian locale
added:
Japanese locale
fixed:
typo in Dutch locale
added:
Dutch locale
added:
Swedish locale
added:
Danish locale
fixed:
fixed starting/ending weekday for Romanian locale
fixed:
adding delimiter character to Italian locale
fixed:
passing back new instance for startOf/endOf for week, month, quarter
added:
locale Czech
added:
calendar locale receives as Closure the following params function(Moment $m) {}
relativeTime locale receives as Closure the following params function($count, $direction, Moment $m) {}
added:
fixed passing closures to locale (calendar, relativeTime)
set correct german locale information
added:
fixed Thai locale strings
added:
locale traditional Chinese
added:
locale Chinese
ordinal formatter receives now the token e.g. the token within dS is d
fixed: english ordinal issue for numbers between 11 - 13
added: locale Italian
fixed: english ordinal issue
added: locale Portuguese
fixed:
Locale displayed wrong month name (#34)
Changed the order of weekdays within locale files
added:
getWeekdayNameLong()
getWeekdayNameShort()
getMonthNameLong()
getMonthNameShort()
added:
Locale: Thai
added:
getMonths()
getYears()
getRelative()
Locale
MomentFromVo:
fixed:
getSeconds() shows now direction as well
MomentFromVo:
fixed:
timezone issue which occured only for unixtime dates
other:
direction returns now: "future" (-) / "past" (+)
time values are now type casted as floats
MomentFromVo:
fixed:
unrecognised timezone when constructing a Moment
added:
getMomentsByWeekdays()
getWeekday()
getWeekOfYear()
other:
escaped text
added:
e.g. [Hello World] will be automatically transformed into Hello World
e.g. WS for 21th week of the year shows now correct 21th etc.
get the period for a given quarter in a given year
week = week of the year
month = month of the year
quarter = quarter of the year
create a new mutable moment based of the given instance
startOf and endOf as implemented by moment.js
get the quarter period of a given date
setDay()
getDay()
setMonth()
getMonth()
setYear()
getYear()
getQuarter()
setSecond()
getSecond()
setMinute()
getMinute()
setHour()
getHour()
added cloning()
added getInterval() to MomentPeriodVo to indicate the interval of the given period
added a static class MomentHelper
fixed PHP's internal ordinal calculation (also in combination with moment.js formatting)
you can now escape text by wrapping it in []
removed:
add()
subtract()
added:
calendar format as implemented by moment.js
fixed:
incompatibility w/ PHP 5.3
added:
test for dates w/ format YYYY-mm-dd and YYYY-mm-ddTHH:ii:ss
throws MomentException on invalid dates
Exception throw as MomentException
Date validation on instantiation:
addSeconds()
addMinutes()
addHours()
addDays()
addWeeks()
addMonths()
addYears()
subtractSeconds()
subtractMinutes()
subtractHours()
subtractDays()
subtractWeeks()
subtractMonths()
subtractYears()
deprecated:
add()
subtract()
The maintainers of this project suggest following the contribution guide.
Moment.php is freely distributable under the terms of the MIT license.
Copyright (c) 2017 Tino Ehrich
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
