Task #86089

Document scheduler tasks based on symfony

Added by Anja Leichsenring about 2 years ago. Updated 6 months ago.

Status:
Closed
Priority:
Should have
Assignee:
-
Category:
Documentation
Target version:
-
Start date:
2018-09-02
Due date:
% Done:

100%

TYPO3 Version:
9
PHP Version:
Tags:
Complexity:
Sprint Focus:

Description

The ext:scheduler documentation has no mention of scheduler tasks based on symfony commands, but the core supports this since a while and even provides settings around that topic.


Related issues

Related to TYPO3 Core - Feature #85991: Allow symfony commands to be non-schedulable Closed 2018-08-27
Related to TYPO3 Core - Epic #85990: Extbase CommandControllers vs. Symfony/Console Integration Closed 2018-08-27

Associated revisions

Revision 27877c16 (diff)
Added by Susanne Moog 8 months ago

[DOCS] Remove own scheduler task docs in favor of symfony commands

As the preferred and future-proof way of creating commands is using
symfony commands (as a base for scheduler tasks), the documentation
has been adjusted to reflect that, by avoiding promoting the scheduler's
own tasks.

Resolves: #86089
Releases: master
Change-Id: I12e385aaf433ad8caf5d4d43ecf41cf2ff7ceee6
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/63600
Tested-by: TYPO3com <>
Tested-by: Björn Jacob <>
Tested-by: Daniel Siepmann <>
Reviewed-by: Björn Jacob <>
Reviewed-by: Daniel Siepmann <>

History

#1 Updated by Anja Leichsenring about 2 years ago

  • Related to Feature #85991: Allow symfony commands to be non-schedulable added

#2 Updated by Sybille Peters 8 months ago

Creating Symfony command controllers is documented in "TYPO3 Explained": https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/CommandControllers/Index.html

This also includes information about how to run the command from the command line and from the scheduler.

Perhaps it is helpful to link to this documentation in the scheduler docs (for now).

(As often), it is not so easy to decide, what should be in the system extension docs and what in the core manuals, but I would suggest to put the programming related things in "TYPO3 Explained", add links to the sysext docs and vice versa.

What is currently not clear to me: when to use scheduler tasks (TYPO3\CMS\Scheduler\Task\AbstractTask), when to use command controllers (\Symfony\Component\Console\Command\Command). Both can be executed from the command line, both can be executed in the scheduler. Why do we have 2? Will the functionality eventually get merged? (Personally, I have been using command controllers only recently).

I would love to help with the documentation but since I have too many open questions myself at the moment, probably not a good idea.

#3 Updated by Susanne Moog 8 months ago

  • Related to Epic #85990: Extbase CommandControllers vs. Symfony/Console Integration added

#4 Updated by Susanne Moog 8 months ago

@Sybille: See the epic #85990 - preferred would be symfony commands only, so when documenting, we should remove any info about the old way and only add a crosslink to the docs you pointed to.

#5 Updated by Gerrit Code Review 8 months ago

  • Status changed from New to Under Review

Patch set 1 for branch master of project Packages/TYPO3.CMS has been pushed to the review server.
It is available at https://review.typo3.org/c/Packages/TYPO3.CMS/+/63600

#6 Updated by Susanne Moog 8 months ago

  • Status changed from Under Review to Resolved
  • % Done changed from 0 to 100

#7 Updated by Benni Mack 6 months ago

  • Status changed from Resolved to Closed

Also available in: Atom PDF