[TASK] Deprecate plugin content element and plugin subtypes (list_type) #4821

linawolf · 2024-10-13T08:57:42Z

Depends on TYPO3-Documentation/TYPO3CMS-Reference-TCA#1183

Resolves: TYPO3-Documentation/Changelog-To-Doc#1071

Releases: main

Depends on TYPO3-Documentation/TYPO3CMS-Reference-TCA#1183 Resolves: TYPO3-Documentation/Changelog-To-Doc#1071 Releases: main, 13.4

Documentation/ApiOverview/ContentElements/ContentElementsWizard.rst

sfroemkenjw · 2024-10-17T06:37:26Z

Documentation/ApiOverview/ContentElements/ContentElementsWizard.rst

-subtype.
+..  deprecated:: 13.4
+    Using the default `list_type` for the parameter is deprecated. All content
+    elements and plugins should be added as sing `CType` for parameter `$type`.


sing? La la lala la laaaa string? single?

Documentation/ApiOverview/ContentElements/CustomBackendPreview.rst

sfroemkenjw · 2024-10-17T06:52:44Z

Documentation/ApiOverview/ContentElements/Index.rst

-Each plugin has its own plugin type, which is used in the database field
-tt_content.list_type. The list_type could be understood as subtype of CType.
+..  deprecated:: 13.4
+    Setting the second parameter to any value but `CType`


Only list_type is deprecated. You still can call that method without any deprecations for any TCA select type. Sure, it does not make sense, but it's possible. addPlugin looks a little bit like addTcaSelectItem, it just adds a new entry to a select type.

Documentation/ApiOverview/ContentElements/MigrationListType.rst

sfroemkenjw · 2024-10-17T07:23:46Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+
+..  _plugins-list-type-migration-extbase-configuration:
+
+1. Adjust the Extbase plugin configuration


What about using: https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Howto/WritingReST/CheatSheet.html#ref-styled-numbered-lists-big-nums

sfroemkenjw · 2024-10-17T07:28:02Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+If the fourth parameter, `$nonCacheableControllerActions` was missing you can
+set it to an empty array, the default value.
+
+It is theoretically possible that the extension author did not use this utility


This is correct for Extensions without Extbase usage, but for Extbase it is needed to register the action and controller here:
$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'][$extensionName]['plugins']. And that entry will only be done by configurePlugin. But yes, you also can register that part manually, too.

Yes and I have seen ppl do that. You cannot rely on they used the Utility functions. But "theoretically"

sfroemkenjw · 2024-10-17T07:29:55Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+    :caption: EXT:examples/Configuration/TCA/Overrides/tt_content.php (difference)
+
+The `CType` based plugin does not inherit the standard fields provided by the
+TCA of the content-element "List". These where in many cases removed by


Nearly everywhere above you write it without -

Suggested change

TCA of the content-element "List". These where in many cases removed by

TCA of the content element "List". These where in many cases removed by

sfroemkenjw · 2024-10-17T07:32:20Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+-------------------------------------------------------------
+
+..  literalinclude:: _Migration/_tca_registration.php.diff
+    :caption: EXT:examples/Configuration/TCA/Overrides/tt_content.php (difference)


You are writing Line 15 below. So activating line numbers would be perfect

Suggested change

:caption: EXT:examples/Configuration/TCA/Overrides/tt_content.php (difference)

:caption: EXT:examples/Configuration/TCA/Overrides/tt_content.php (difference)

:linenos:

sfroemkenjw · 2024-10-17T07:34:38Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+
+As these fields are not displayed automatically anymore you can remove this
+definition without replacement: Line 15 in the diff. If they have not been
+removed and still needed you need to add them manually to your plugins type.


Suggested change

removed and still needed you need to add them manually to your plugins type.

removed and are still needed, you will need to manually add them to your plugin type.

sfroemkenjw · 2024-10-17T07:38:56Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+Migration example: Core-based plugin
+====================================
+
+..  _plugins-list-type-migration-core-registration:
+
+1.  Adjust the plugin registration
+==================================


Sorry, not rendered until now. No link, no content, ... look ugly

I feel like something is missing...

sfroemkenjw · 2024-10-17T07:43:50Z

Documentation/ApiOverview/ContentElements/_Migration/_ext_localconf.php.diff

+ ExtensionUtility::configurePlugin(
+     'Examples',
+     'FalExamples',
+        'HtmlParser',
+        [
+            HtmlParserController::class => 'index',
+        ],
+       [],
+    ExtensionUtility::PLUGIN_TYPE_CONTENT_ELEMENT,


Something is completely broken here. 3rd Argument is an Array, but here it is "HtmlParser" and the indents of 6th (should be 5th) argument is missing 3 spaces. And in general the indents in PHP are 4 and not 7.

This is a diff, not a PHP file?

Documentation/CodeSnippets/FlexForms/Examples/PluginHaikuListRegistration.rst.txt

sfroemkenjw · 2024-10-17T07:51:17Z

Documentation/CodeSnippets/FlexForms/Examples/PluginHaikuListRegistration.rst.txt

+        'tt_content',
+        '--div--;Configuration,pi_flexform,',
+        $pluginSignature,
+        'after:subheader',


subheader is only available for CType header. As subheader is not available for all other CTypes this field will be added to the last tab and behind last field.

Documentation/ExtensionArchitecture/BestPractises/NamingConventions.rst

sfroemkenjw · 2024-10-17T07:54:11Z

Documentation/ExtensionArchitecture/BestPractises/NamingConventions.rst

+        'tt_content',
+        '--div--;Configuration,pi_flexform,',
+        $pluginSignature,
+        'after:subheader',


Works only for CType "header" as expected

Documentation/ExtensionArchitecture/BestPractises/NamingConventions.rst

sfroemkenjw · 2024-10-17T07:57:35Z

Documentation/ExtensionArchitecture/Extbase/Reference/FrontendPlugins.rst

+    #.  A unique identifier for your plugin in UpperCamelCase: :php:`'PostSingle'`
+    #.  An array of allowed combinations of controllers and actions stored in an array
+    #.  (Optional) an array of controller name and  action names which should not be cached
+    #.  Using any value but `ExtensionUtility::PLUGIN_TYPE_CONTENT_ELEMENT` is


Only list_type will create a deprecation log entry

And the default value which is empty but defaults to list_type as well. So for all practical reasons: just use ExtensionUtility::PLUGIN_TYPE_CONTENT_ELEMENT. I don't think details beyond this are needed

Documentation/ApiOverview/ContentElements/ContentElementsWizard.rst

Documentation/ApiOverview/ContentElements/Index.rst

linawolf · 2024-10-17T12:26:47Z

Documentation/ApiOverview/ContentElements/MigrationListType.rst

+If the fourth parameter, `$nonCacheableControllerActions` was missing you can
+set it to an empty array, the default value.
+
+It is theoretically possible that the extension author did not use this utility


Yes and I have seen ppl do that. You cannot rely on they used the Utility functions. But "theoretically"

linawolf · 2024-10-17T12:28:42Z

Documentation/ApiOverview/ContentElements/_Migration/_ext_localconf.php.diff

+ ExtensionUtility::configurePlugin(
+     'Examples',
+     'FalExamples',
+        'HtmlParser',
+        [
+            HtmlParserController::class => 'index',
+        ],
+       [],
+    ExtensionUtility::PLUGIN_TYPE_CONTENT_ELEMENT,


This is a diff, not a PHP file?

Documentation/CodeSnippets/FlexForms/Examples/PluginHaikuListRegistration.rst.txt

linawolf · 2024-10-17T12:33:24Z

Documentation/ExtensionArchitecture/Extbase/Reference/FrontendPlugins.rst

+    #.  A unique identifier for your plugin in UpperCamelCase: :php:`'PostSingle'`
+    #.  An array of allowed combinations of controllers and actions stored in an array
+    #.  (Optional) an array of controller name and  action names which should not be cached
+    #.  Using any value but `ExtensionUtility::PLUGIN_TYPE_CONTENT_ELEMENT` is


And the default value which is empty but defaults to list_type as well. So for all practical reasons: just use ExtensionUtility::PLUGIN_TYPE_CONTENT_ELEMENT. I don't think details beyond this are needed

Co-authored-by: Stefan Frömken <123929835+sfroemkenjw@users.noreply.github.com>

linawolf · 2024-10-17T12:40:11Z

Documentation/ExtensionArchitecture/BestPractises/NamingConventions.rst

+        'tt_content',
+        '--div--;Configuration,pi_flexform,',
+        $pluginSignature,
+        'after:subheader',


Suggested change

'after:subheader',

'after:header',

linawolf self-assigned this Oct 13, 2024

linawolf marked this pull request as draft October 13, 2024 08:57

linawolf force-pushed the task/codesnippets2 branch 2 times, most recently from 345a537 to 9ae84d1 Compare October 14, 2024 13:41

linawolf marked this pull request as ready for review October 14, 2024 13:42

linawolf marked this pull request as draft October 14, 2024 13:43

linawolf added the backport 13.4 Backport to TYPO3v13 label Oct 15, 2024

linawolf force-pushed the task/codesnippets2 branch 2 times, most recently from 7e2a4ca to 8e5da43 Compare October 16, 2024 19:18

linawolf marked this pull request as ready for review October 16, 2024 19:18

[TASK] Deprecate plugin content element and plugin subtypes (list_type)

95ab966

Depends on TYPO3-Documentation/TYPO3CMS-Reference-TCA#1183 Resolves: TYPO3-Documentation/Changelog-To-Doc#1071 Releases: main, 13.4

linawolf force-pushed the task/codesnippets2 branch from 8e5da43 to 95ab966 Compare October 16, 2024 19:19