[BUGFIX] Clarify description in ExtensionManagementUtility::addPlugin 21/62921/2
authorBenni Mack <benni@typo3.org>
Wed, 15 Jan 2020 21:28:17 +0000 (22:28 +0100)
committerTobi Kretschmann <tobi@tobishome.de>
Thu, 16 Jan 2020 07:53:23 +0000 (08:53 +0100)
The description that the extension key should be used - instead of the
plugin identifier is wrong, and is now adapted.

Resolves: #90113
Releases: master, 9.5
Change-Id: I4928dba4255d46bf72e0a0b45e5ff3360ae718ac
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/62921
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Jörg Bösche <typo3@joergboesche.de>
Tested-by: Steffen Frese <steffenf14@gmail.com>
Tested-by: Felix P. <f.pachowsky@neusta.de>
Tested-by: Tobi Kretschmann <tobi@tobishome.de>
Reviewed-by: Steffen Frese <steffenf14@gmail.com>
Reviewed-by: Jörg Bösche <typo3@joergboesche.de>
Reviewed-by: Felix P. <f.pachowsky@neusta.de>
Reviewed-by: Tobi Kretschmann <tobi@tobishome.de>

index 37a6828..e1d48bb 100644 (file)
@@ -1123,10 +1123,11 @@ class ExtensionManagementUtility
      * Adds an entry to the list of plugins in content elements of type "Insert plugin"
      * Takes the $itemArray (label, value[,icon]) and adds to the items-array of $GLOBALS['TCA'][tt_content] elements with CType "listtype" (or another field if $type points to another fieldname)
      * If the value (array pos. 1) is already found in that items-array, the entry is substituted, otherwise the input array is added to the bottom.
-     * Use this function to add a frontend plugin to this list of plugin-types - or more generally use this function to add an entry to any selectorbox/radio-button set in the TCEFORMS
+     * Use this function to add a frontend plugin to this list of plugin-types - or more generally use this function to add an entry to any selectorbox/radio-button set in the FormEngine
+     *
      * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
-     * @param array $itemArray Numerical array: [0] => Plugin label, [1] => Underscored extension key, [2] => Path to plugin icon relative to TYPO3_mainDir
+     * @param array $itemArray Numerical array: [0] => Plugin label, [1] => Plugin identifier / plugin key, ideally prefixed with a extension-specific name (e.g. "events2_list"), [2] => Path to plugin icon relative to TYPO3_mainDir
      * @param string $type Type (eg. "list_type") - basically a field from "tt_content" table
      * @param string $extensionKey The extension key
      * @throws \RuntimeException