Wallogit.com
2017 © Pedro Peláez
A parser for date & time written in natural language
A parser for date and time written in natural language for PHP., (*1)
, (*2)
The preferred way to install package is via composer:, (*3)
composer require wapmorgan/time-parser
Parse some input from user and receive a DateTime object., (*4)
Create a Parser object, (*5)
$parser = new wapmorgan\TimeParser\TimeParser('all');
First argument is a language. Applicable values:, (*6)
'all' (by default) - scan for all available languages. Use it when you can not predict user's preferred language.'russian' - scan only as string written in one language.array('english', 'russian') - scan as english and then the rest as russian.Enable and disable parsing of alphabetic values., (*7)
// To enable alphabetic parsing. $parser->allowAlphabeticUnits(); // To disable alphabetic parsing. $parser->disallowAlphabeticUnits();
Parse string and return a DateTimeImmutable object. If second argument is true, method will return false when no date&time strings found. If third parameter is provided, then it is filled with the string obtained after all the transformations., (*8)
$datetime = $parser->parse(fgets(STDIN));
// next call returns false
$datetime = $parser->parse('abc', true);
// $result will contains "we will come "
$datetime = $parser->parse('We will come in a week', true, $result);
For advanced parsing of alphabetic values is used built-in function. You can specify your own handler for this feature. Сurrently is used for russian and english languages only., (*9)
use wapmorgan\TimeParser\TimeParser;
// $string will contains alphabetic value for advanced parsing.
// Ex.: for string "in twenty five minutes", it will contains "twenty five".
// $lang will contains name of the parsed language.
TimeParser::setWordsToNumberCallback(function($string, $lang) {
// do some magic
});
php
// $date must be an array with a structure like the existing rules.
$parser->addLanguage($data);
For this moment four languages supported: Russian, English, French and German. Two languages support is in progress: Chinese, Spanish.
Their rules are in rules catalog so you can improve TimeParser by adding new language or by improving existing one., (*10)
Languages with examples of strings containing date&time:, (*11)
| Language | Example |
|---|---|
| chinese | 15:12:13 下星期一 下年 二月 経由15小时 経由10分钟 経由11秒钟 経由5年 経由2星期 経由1天 経由10月 |
| english | 15 december 1977 at 15:12:13 next monday next year in february in 15 hours in 10 minutes in 11 seconds in 5 years in 2 weeks in 1 day in 10 months |
| french | 15:12:13 prochaine lundi prochaine année février bout de 15 heures bout de 10 minutes bout de 11 secondes bout de 5 années bout de 2 semaines bout de 1 jour bout de 10 mois |
| german | 15:12:13 nächsten montag nächsten jahr im februar nach 15 uhr nach 10 minuten nach 11 secunden nach 5 jahre nach 2 wochen nach 1 tag nach 10 monate |
| russian | 15 декабря 1977 года в 15:12:13 в следующий понедельник в следующем году в феврале через 15 часов через 10 минут через 11 секунд через 5 лет через 2 недели через 1 день через 10 месяцев |
| spanish | 15:12:13 el próximo lunes en próximo año en febrero en 15 horas en 10 minutos en 11 segundos en 5 años en 2 semanas en 1 día en 10 meses |
For developing reasons you may would like to see process of parsing. To do this call related methods:, (*12)
TimeParser::enableDebug(); // and TimeParser::disableDebug();
To understand, how it works, look at substrings separately:, (*13)
A parser for date & time written in natural language
MIT
parser date time humanized human-written
A parser for date & time written in natural language
MIT
parser date time humanized human-written