Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adhocore/php-cron-expr
Ultra lightweight, Dependency free and Super Fast Cron Expression parser for PHP
https://github.com/adhocore/php-cron-expr
adhocore cron cron-expr cron-expression cron-parser cron-relay crontab crontab-parser php-cron php-crontab scheduler
Last synced: about 2 months ago
JSON representation
Ultra lightweight, Dependency free and Super Fast Cron Expression parser for PHP
- Host: GitHub
- URL: https://github.com/adhocore/php-cron-expr
- Owner: adhocore
- License: mit
- Created: 2017-06-13T15:30:07.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-05-24T16:29:02.000Z (4 months ago)
- Last Synced: 2024-06-19T20:51:12.199Z (3 months ago)
- Topics: adhocore, cron, cron-expr, cron-expression, cron-parser, cron-relay, crontab, crontab-parser, php-cron, php-crontab, scheduler
- Language: PHP
- Homepage: https://github.com/adhocore/php-cron-expr
- Size: 103 KB
- Stars: 50
- Watchers: 3
- Forks: 5
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## adhocore/cron-expr
[](https://github.com/adhocore/php-cron-expr/releases)
[](https://travis-ci.org/adhocore/php-cron-expr?branch=master)
[](https://scrutinizer-ci.com/g/adhocore/php-cron-expr/?branch=master)
[](https://codecov.io/gh/adhocore/php-cron-expr)
[](https://styleci.io/repos/94228363)
[](LICENSE)
[](https://twitter.com/intent/tweet?text=Lightweight+and+fast+cron+expression+parser+for+PHP&url=https://github.com/adhocore/php-cron-expr&hashtags=php,cron,cronparser,parser,cronexpr)
[](https://github.com/sponsors/adhocore)
- Lightweight Cron expression parser library for PHP.
- Zero dependency.
- Very **fast** because it bails early in case a segment doesnt match.
- Real [benchmark](https://github.com/adhocore/php-cron-bench) shows it is about 7.54x to 12.92x faster than `dragonmantank/cron-expression`
## Installation
```bash
composer require adhocore/cron-expr
# PHP5.6 or lower
composer require adhocore/cron-expr:0.1.0
```
## Usage
**Basic**
```php
use Ahc\Cron\Expression;
use Ahc\Cron\Normalizer;
Expression::isDue('@always');
Expression::isDue(Normalizer::HOURLY, '2015-01-01 00:00:00');
Expression::isDue('*/20 * * * *', new DateTime);
Expression::isDue('5-34/4 * * * *', time());
// Dont like static calls? Below is possible too!
$expr = new Expression;
$expr->isCronDue('*/1 * * * *', time());
```
**Bulk checks**
When checking for several jobs at once, if more than one of the jobs share equivalent expression
then the evaluation is done only once per go thus greatly improving performnce.
```php
use Ahc\Cron\Expression;
$jobs = [
'job1' => '*/2 */2 * * *',
'job1' => '* 20,21,22 * * *',
'job3' => '7-9 * */9 * *',
'job4' => '*/5 * * * *',
'job5' => '@5minutes', // equivalent to job4 (so it is due if job4 is due)
'job6' => '7-9 * */9 * *', // exact same as job3 (so it is due if job3 is due)
];
// The second param $time can be used same as above: null/time()/date string/DateTime
$dues = Expression::getDues($jobs, '2015-08-10 21:50:00');
// ['job1', 'job4', 'job5']
// Dont like static calls? Below is possible too!
$expr = new Expression;
$dues = $expr->filter($jobs, time());
```
### Cron Expression
Cron expression normally consists of 5 segments viz:
```
```
and sometimes there can be 6th segment for `` at the end.
### Real Abbreviations
You can use real abbreviations for month and week days. eg: `JAN`, `dec`, `fri`, `SUN`
### Tags
Following tags are available and they are converted to real cron expressions before parsing:
- *@yearly* or *@annually* - every year
- *@monthly* - every month
- *@daily* - every day
- *@weekly* - every week
- *@hourly* - every hour
- *@5minutes* - every 5 minutes
- *@10minutes* - every 10 minutes
- *@15minutes* - every 15 minutes
- *@30minutes* - every 30 minutes
- *@always* - every minute
> You can refer them with constants from `Ahc\Cron\Normalizer` like `Ahc\Cron\Normalizer::WEEKLY`
### Modifiers
Following modifiers supported
- *Day of Month / 3rd segment:*
- `L` stands for last day of month (eg: `L` could mean 29th for February in leap year)
- `W` stands for closest week day (eg: `10W` is closest week days (MON-FRI) to 10th date)
- *Day of Week / 5th segment:*
- `L` stands for last weekday of month (eg: `2L` is last monday)
- `#` stands for nth day of week in the month (eg: `1#2` is second sunday)
## LICENSE
> © [MIT](./LICENSE) | 2017-2019, Jitendra Adhikari
## Credits
This project is release managed by [please](https://github.com/adhocore/please).