[Scheduler] Periodical triggers timing #20447
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
codedmonkey
force-pushed
the
scheduler-frequency
branch
from
d305960 to
f58f1eb
Compare
wouterj
reviewed
Dec 7, 2024
| $until = '2023-06-12'; | ||
| RecurringMessage::every('first Monday of next month', new Message(), from: $from, until: $until); | ||
|
|
||
| If you don't pass a from parameter to your schedule, the first frequency period |
There was a problem hiding this comment.
I think we can merge this paragraph with the first one you added, as it's saying the same thing?
Comment on lines
+297
to
+313
| It's also possible to pass a from and until time for your schedule. For | ||
| example, if you want to execute a command every day at 13:00:: | ||
|
|
||
| $from = new \DateTimeImmutable('13:00', new \DateTimeZone('Europe/Paris')); | ||
| RecurringMessage::every('1 day', new Message(), from: $from); | ||
|
|
||
| Or if you want to execute a message every day until a specific date:: | ||
|
|
||
| $until = '2023-06-12'; | ||
| RecurringMessage::every('1 day', new Message(), until: $until); | ||
|
|
||
| And you can even combine the from and until parameters for more granular | ||
| control:: | ||
|
|
||
| $from = new \DateTimeImmutable('2023-01-01 13:47', new \DateTimeZone('Europe/Paris')); | ||
| $until = '2023-06-12'; | ||
| RecurringMessage::every('first Monday of next month', new Message(), from: $from, until: $until); |
There was a problem hiding this comment.
We tend to favor "documentation in code examples" over normal text. So I would suggest merging this into one code block and adding a couple inline comments, like:
// execute a message every day at 13:00
$from = new \DateTimeImmutable('13:00', new \DateTimeZone('Europe/Paris'));
RecurringMessage::every('1 day', new Message(), from: $from);
// execute a message every day until a specific date
$until = '2023-06-12';
RecurringMessage::every('1 day', new Message(), until: $until);
// ... etc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Improves the explanation of periodical triggers in the Scheduler component.
Related to #20349