sunkan / dictus
Date utility classes
Installs: 7 380
Dependents: 1
Suggesters: 1
Security: 0
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Requires (Dev)
- phpstan/phpstan: ^1.0
- phpunit/phpunit: ^9.5
- stefna/codestyle: ^1.5
README
This is a small library to help with date formatting and keeping a consistent clock in a project
Usage
Using formatters
use Sunkan\Dictus\DateTimeFormat; use Sunkan\Dictus\DateTimeFormatter; use Sunkan\Dictus\LocalizedFormat; use Sunkan\Dictus\LocalizedStrftimeFormatter; use Sunkan\Dictus\LocalizedDateTimeFormatter; LocalizedDateTimeFormatter::addLocaleFormat('sv_SE', new \Sunkan\Dictus\Locales\SvSe()); $jsonDateFormatter = new DateTimeFormatter(DateTimeFormat::JSON); $localizedStrftimeFormatter = new LocalizedStrftimeFormatter('sv_SE', LocalizedFormat::DATETIME); $localizedDateTimeFormatter = new LocalizedDateTimeFormatter('sv_SE', 'l d F [kl.] H:i'); $date = new DateTimeImmutable(); echo $jsonDateFormatter->format($date); echo $localizedStrftimeFormatterFormatter->format($date); // 21.08.2023 16:26 echo $localizedDateTimeFormatter->format($date); // måndag 21 augusti kl. 16:26
Using localized formatters
We recommend using LocalizedDateTimeFormatter
that just support translating of
the regular date format syntax.
It will translate the following keys:
D
short version of day namel
long version of day nameM
short version of month nameF
long version of month name
It also supports 6 custom keys that helps with common localized formats
Example for icelandic
'LT' => 'H:i', // 17:32 'LTS' => 'H:i:s', // 17:32:12 'L' => 'd.m.Y', // 06.12.2023 'LL' => 'j. F Y', // 6. desember 2023 'LLL' => 'j. F [kl.] H:i', // 6. desember kl. 17:32 'LLLL' => 'l j. F Y [kl.] H:i', // miðvikudagur 6. desember 2023 kl. 17:32
Custom localization
All you need to do to create your own localization is to create a class that's implements LocaleFormat
final class CustomLocal implements \Sunkan\Dictus\LocaleFormat { public function formatChar(string $char, \DateTimeImmutable $dateTime): ?string { return match ($char) { 'D' => 'short custom weekday name', 'l' => 'long custom weekday name', 'M' => null, // use english month names 'F' => null, // use english month names default => null, }; } public function resolveFormat(string $format): ?string { return match($format) { 'LT' => 'H:i', // can be any valid date format string 'LTS' => 'H:i:s', // can be any valid date format string 'L' => 'd.m.Y', // can be any valid date format string 'LL' => 'j. F Y', // can be any valid date format string 'LLL' => 'j. F [kl.] H:i', // can be any valid date format string 'LLLL' => 'l j. F Y [kl.] H:i', // can be any valid date format string default => null, }; } }
Clock
The library provides 3 clock implementations
SystemClock, FrozenClock and ProjectClock
SystemClock
is just a wrapper around new DateTimeImmutable('now')
FrozenClock
is a wrapper around a fixed DateTimeImmutable
object
ProjectClock
is wrapper around a ClockInterface
implementation