Skip to content

Commit

Permalink
Update add-scheduled-task.md
Browse files Browse the repository at this point in the history
Removed non existing method supposedly prescribed by the ScheduledTaskHandler Interface. This is probably a remain of an older shopware version.
  • Loading branch information
AndreasMorasch authored Jan 22, 2025
1 parent e94af40 commit 46d3cc1
Showing 1 changed file with 1 addition and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,8 @@ class ExampleTaskHandler extends ScheduledTaskHandler
}
```

The respective task handler, `ExampleTaskHandler` as defined previously in your `services.xml`, has to extend from the class `Shopware\Core\Framework\MessageQueue\ScheduledTask\ScheduledTaskHandler`. This also comes with two methods, that you need to implement first:
The respective task handler, `ExampleTaskHandler` as defined previously in your `services.xml`, will be annotated with `AsMessageHandler` handeling the `ExampleTask` class. In addition the `ScheduledTaskHandler` has to extend from the class `Shopware\Core\Framework\MessageQueue\ScheduledTask\ScheduledTaskHandler`. This also comes with one method, that you need to implement first:

Check warning on line 104 in guides/plugins/plugins/plugin-fundamentals/add-scheduled-task.md

View workflow job for this annotation

GitHub Actions / Runner

[LanguageTool] reported by reviewdog 🐶 A comma may be missing after the conjunctive/linking adverb ‘addition’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[2]) Suggestions: `addition,` URL: https://languagetool.org/insights/post/linking-words/ Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=2 Category: PUNCTUATION Raw Output: guides/plugins/plugins/plugin-fundamentals/add-scheduled-task.md:104:176: A comma may be missing after the conjunctive/linking adverb ‘addition’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA[2]) Suggestions: `addition,` URL: https://languagetool.org/insights/post/linking-words/ Rule: https://community.languagetool.org/rule/show/SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA?lang=en-US&subId=2 Category: PUNCTUATION

* `getHandledMessages`: An iterable, or an array, of the scheduled tasks, that this handler will take care of. In this case this is only the `ExampleTask` class.
* `run`: This method is executed once your scheduled task is executed. Do everything, that your task is supposed to do here. In this example, it will just create a new file.

Now every five minutes, your task will be executed and it will print an output every time now.
Expand Down

0 comments on commit 46d3cc1

Please sign in to comment.