[Scheduler] Add new component documentation #18290
Closed
Conversation
This file contains hidden or 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
|
|
||
| .. code-block:: terminal | ||
|
|
||
| $ php bin/console messenger:consume scheduler_trial |
There was a problem hiding this comment.
Where do scheduler_trial comes from?
Aerendir
suggested changes
Aug 2, 2023
alexandre-daubois
suggested changes
Aug 30, 2023
| RecurringMessage::every('first day of month', $msg); | ||
| RecurringMessage::every('next tuesday', $msg); | ||
|
|
||
| It is possible to specify an exact hour to trigger the schedule with `from` |
There was a problem hiding this comment.
Suggested change
| It is possible to specify an exact hour to trigger the schedule with `from` | |
| It is possible to specify an exact hour to trigger the schedule with ``from`` |
| $from = new \DateTimeImmutable('13:47', new \DateTimeZone('Europe/Paris')); | ||
| RecurringMessage::every('first day of month', $msg, from: $from); | ||
|
|
||
| If your schedule does not need to run indefinitely, you can use the `until` option |
There was a problem hiding this comment.
Suggested change
| If your schedule does not need to run indefinitely, you can use the `until` option | |
| If your schedule does not need to run indefinitely, you can use the ``until`` option |
|
|
||
| .. note:: | ||
|
|
||
| The minimal interval allowed with cron is 1 minute. |
There was a problem hiding this comment.
Suggested change
| The minimal interval allowed with cron is 1 minute. | |
| The minimal interval allowed by the ``cron()`` method is 1 minute. |
| } | ||
| } | ||
|
|
||
| Run the Messenger consumer |
There was a problem hiding this comment.
Suggested change
| Run the Messenger consumer | |
| Run The Messenger Consumer |
|
|
||
| $ php bin/console messenger:consume scheduler_trial | ||
|
|
||
| Trigger your schedule |
There was a problem hiding this comment.
Suggested change
| Trigger your schedule | |
| Trigger Your Schedule |
| The minimal interval allowed with cron is 1 minute. | ||
|
|
||
| Hashed expressions | ||
| ~~~~ |
There was a problem hiding this comment.
Suggested change
| ~~~~ | |
| ~~~~~~~~~~~~~~~~~~ |
Comment on lines
+134
to
+138
| * `#yearly`, `#annually` - Run once a year, midnight, Jan. 1 - `0 0 1 1 *` | ||
| * `#monthly` - Run once a month, midnight, first of month - `0 0 1 * *` | ||
| * `#weekly` - Run once a week, midnight on Sun - `0 0 * * 0` | ||
| * `#daily`, `#midnight` - Run once a day, midnight - `0 0 * * *` | ||
| * `#hourly` - Run once an hour, first minute - `0 * * * *` |
There was a problem hiding this comment.
Suggested change
| * `#yearly`, `#annually` - Run once a year, midnight, Jan. 1 - `0 0 1 1 *` | |
| * `#monthly` - Run once a month, midnight, first of month - `0 0 1 * *` | |
| * `#weekly` - Run once a week, midnight on Sun - `0 0 * * 0` | |
| * `#daily`, `#midnight` - Run once a day, midnight - `0 0 * * *` | |
| * `#hourly` - Run once an hour, first minute - `0 * * * *` | |
| * ``#yearly``, ``#annually`` - Run once a year, midnight, Jan. 1 - ``0 0 1 1 *`` | |
| * ``#monthly`` - Run once a month, midnight, first of month - ``0 0 1 * *`` | |
| * ``#weekly`` - Run once a week, midnight on Sun - ``0 0 * * 0`` | |
| * ``#daily``, ``#midnight`` - Run once a day, midnight - ``0 0 * * *`` | |
| * ``#hourly`` - Run once an hour, first minute - ``0 * * * *`` |
| * `#hourly` - Run once an hour, first minute - `0 * * * *` | ||
|
|
||
| Message generator | ||
| ~~~~ |
There was a problem hiding this comment.
Suggested change
| ~~~~ | |
| ~~~~~~~~~~~~~~~~~ |
|
|
||
| You can also use some another triggers: ``CallbackTrigger, CronExpressionTrigger, DateIntervalTrigger, DatePeriodTrigger, ExcludeTimeTrigger`` | ||
|
|
||
| Define your own trigger |
There was a problem hiding this comment.
Suggested change
| Define your own trigger | |
| Define Your Own Trigger |
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| By implementing the TriggerInterface, you can create your own trigger using | ||
| ``getNextRunDate`` method:: |
There was a problem hiding this comment.
Suggested change
| ``getNextRunDate`` method:: | |
| the :method:`FQCN\TriggerInterface::getNextRunDate` method:: |
|
@kbond maybe you can find some spare time and review this PR, so we can merge this as a first version. Thanks |
|
Please, let's not work on this PR anymore for now. It's not bad 🙏 but we're discussing internally about a radically different approach for the docs of this component. Same comment for the #17964 PR about Webhook/RemoteEvent docs. I'm sorry but I hope you understand this. Thanks! |
|
@javiereguiluz , please, can you give us more details? I'm so curious! 😋 |
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.
Fixes #18067, #18255, #18251
Based on #18136
Waiting for feedbacks and ready to fix some issues :)