Moment.php
Parse, validate, manipulate, and display dates in PHP w/ i18n support. Inspired by moment.js
Install / Use
/learn @fightbulc/Moment.phpREADME
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!
<pre> _ _ _ __ ___ ___ _ __ ___ ___ _ __ | |_ _ __ | |__ _ __ | '_ ` _ \ / _ \| '_ ` _ \ / _ \ '_ \| __| | '_ \| '_ \| '_ \ | | | | | | (_) | | | | | | __/ | | | |_ _| |_) | | | | |_) | |_| |_| |_|\___/|_| |_| |_|\___|_| |_|\__(_) .__/|_| |_| .__/ |_| |_| </pre>
Intro
What is moment.php?
Date library for parsing, manipulating and formatting dates w/ i18n.
Any dependencies?
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
Get a moment
$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
Accepted date formats
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';
Switch locale
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 Catalan
cs_CZ Czech
da_DK Danish
de_DE German (Germany)
en_CA English (Canada)
en_GB English (British)
en_US English (American)
eo_EO Esperanto
es_ES Spanish (Europe)
fa_IR Farsi
fi_FI Finnish
fr_CA French (Canada)
fr_FR French (Europe)
hu_HU Hungarian
id_ID Indonesian
it_IT Italian
ja_JP Japanese
kz_KZ Kazakh
lv_LV Latvian (Latviešu)
nl_NL Dutch
oc_LNC Lengadocian
pl_PL Polish
pt_BR Portuguese (Brazil)
pt_PT Portuguese (Portugal)
ru_RU Russian (Basic version)
sv_SE Swedish
th_TH Thai
tr_TR Turkish
uk_UA Ukrainian
vi_VN Vietnamese
zh_CN Chinese
zh_TW Chinese (traditional)
Switch timezones
$m = new \Moment\Moment('2012-04-25T03:00:00', 'CET');
echo $m->setTimezone('UTC')->format(); // 2012-04-25T01:00:00+0000
Change default timezone
\Moment\Moment::setDefaultTimezone('CET');
$m = new \Moment\Moment('2016-09-13T14:32:06');
echo $m->format(); // 2016-09-13T14:32:06+0100
Custom format
I. PHP only (Standard)
$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.
II. Non-php formats
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.
III. Easy text escaping
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
IV. Fixed ordinal representations
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
Create custom moments and manipulate it
I. Past/Future moments
$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
II. Clone a given moment
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.
III. Methods for manipulating the date/time
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)
IV. Setter/Getter
Setter | Getter --- | --- setSecond($s) | getSecond() setMinute($m) | getMinute() setHour($h) | getHour() setDay($d) | getDay() setMonth($m) | getMonth() setYear($y) | getYear() -- | getQuarter()
Difference between dates
$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
