Skip to content

Commit a3760f8

Browse files
committed
docs: about cron
1 parent 2a9505a commit a3760f8

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,22 @@ $jobs = [
5656
];
5757

5858
// The second param $time can be used same as above: null/time()/date string/DateTime
59-
$dueJobs = Expression::getDues($jobs, '2015-08-10 21:50:00');
59+
$dues = Expression::getDues($jobs, '2015-08-10 21:50:00');
6060
// ['job1', 'job4', 'job5']
6161

6262
// Dont like static calls? Below is possible too!
6363
$expr = new Expression;
64-
$dueJobs = $expr->filter($jobs, time());
64+
$dues = $expr->filter($jobs, time());
6565
```
6666

67+
### Cron Expression
68+
69+
Cron expression normally consists of 5 segments viz:
70+
```
71+
<minute> <hour> <day> <month> <weekday>
72+
```
73+
and sometimes there can be 6th segment for `<year>` at the end.
74+
6775
### Real Abbreviations
6876

6977
You can use real abbreviations for month and week days. eg: `JAN`, `dec`, `fri`, `SUN`
@@ -88,11 +96,11 @@ Following tags are available and they are converted to real cron expressions bef
8896
Following modifiers supported
8997

9098
- *Day of Month / 3rd segment:*
91-
- `L` stands for last day of month (eg: `L` could mean 29th for February in leap year)
92-
- `W` stands for closest week day (eg: `10W` is closest week days (MON-FRI) to 10th date)
99+
- `L` stands for last day of month (eg: `L` could mean 29th for February in leap year)
100+
- `W` stands for closest week day (eg: `10W` is closest week days (MON-FRI) to 10th date)
93101
- *Day of Week / 5th segment:*
94-
- `L` stands for last weekday of month (eg: `2L` is last monday)
95-
- `#` stands for nth day of week in the month (eg: `1#2` is second sunday)
102+
- `L` stands for last weekday of month (eg: `2L` is last monday)
103+
- `#` stands for nth day of week in the month (eg: `1#2` is second sunday)
96104

97105
## LICENSE
98106

0 commit comments

Comments
 (0)