Project

General

Profile

Actions

Bug #85205

closed

[BUGFIX] Documentation: use FQCN in Table Garbage Collection Tasks

Added by Forger Service over 6 years ago. Updated about 6 years ago.

Status:
Closed
Priority:
Must have
Category:
Documentation
Target version:
-
Start date:
2018-06-10
Due date:
% Done:

100%

Estimated time:
TYPO3 Version:
9
PHP Version:
7.2
Tags:
Complexity:
Is Regression:
Sprint Focus:

Description

The fully qualified class name of class `TableGarbageCollectionTask` must be used to configure database tables, which should be cleaned up (inactive or deleted records removed from the system).

Wrong: `tx_scheduler_TableGarbageCollection`
Correct: `\TYPO3\CMS\Scheduler\Task\TableGarbageCollectionTask::class`
This issue was automatically created from https://github.com/TYPO3/TYPO3.CMS/pull/112

Actions #1

Updated by Gerrit Code Review over 6 years 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/57166

Actions #2

Updated by Gerrit Code Review over 6 years ago

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

Actions #3

Updated by Michael Schams over 6 years ago

  • Tracker changed from Task to Bug
  • Subject changed from [BUGFIX] Use FQCN to configure Table Garbage Collection Tasks to [BUGFIX] Documentation: use FQCN in Table Garbage Collection Tasks
  • Category set to Documentation
  • Assignee set to Anja Leichsenring
  • Priority changed from Should have to Must have
  • TYPO3 Version changed from 8 to 9
  • PHP Version set to 7.2

When configuring an up-to-date TYPO3 v9.3-dev instance to disable/delete expired BE users via scheduler task, the documentation [1] suggests the following code:

<?php
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks']['tx_scheduler_TableGarbageCollection']['options']['tables'] = [
  'be_users' => [
    'dateField' => 'tstamp',
    'expirePeriod' => '180'
  ]
];

However, the fully qualified class name of class "TableGarbageCollectionTask" must be used to configure database tables.
Therefore, "tx_scheduler_TableGarbageCollection" should be replaced by "\TYPO3\CMS\Scheduler\Task\TableGarbageCollectionTask::class":

<?php
$GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['scheduler']['tasks'][\TYPO3\CMS\Scheduler\Task\TableGarbageCollectionTask::class]['options']['tables'] = [
  'be_users' => [
    'dateField' => 'tstamp',
    'expirePeriod' => '180'
  ]
];

Note: this is a simple documentation update only.

[1] https://docs.typo3.org/typo3cms/extensions/scheduler/Installation/BaseTasks/Index.html

Actions #4

Updated by Anonymous over 6 years ago

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

Updated by Benni Mack about 6 years ago

  • Status changed from Resolved to Closed
Actions

Also available in: Atom PDF