[BUGFIX] Update ExtensionUtility::registerPlugin() icon parameter docs 84/54184/2
authorMathias Brodala <mbrodala@pagemachine.de>
Fri, 8 Sep 2017 08:40:08 +0000 (10:40 +0200)
committerSusanne Moog <susanne.moog@typo3.org>
Wed, 20 Sep 2017 15:00:35 +0000 (17:00 +0200)
The icon parameter is passed through to TCA "select" items, thus aside
from an icon file path an icon identifier can be used here.

Resolves: #82351
Releases: master, 8.7
Change-Id: Ia84aa9c739c10372f1ad76c5b4dde9f0b1a62c99
Reviewed-on: https://review.typo3.org/54184
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Susanne Moog <susanne.moog@typo3.org>
Tested-by: Susanne Moog <susanne.moog@typo3.org>
typo3/sysext/extbase/Classes/Utility/ExtensionUtility.php

index 9158ced..266ce6e 100644 (file)
@@ -109,10 +109,10 @@ tt_content.' . $pluginSignature . ' {
      * @param string $extensionName The extension name (in UpperCamelCase) or the extension key (in lower_underscore)
      * @param string $pluginName must be a unique id for your plugin in UpperCamelCase (the string length of the extension key added to the length of the plugin name should be less than 32!)
      * @param string $pluginTitle is a speaking title of the plugin that will be displayed in the drop down menu in the backend
-     * @param string $pluginIconPathAndFilename is a path to an icon file (relative to TYPO3_mainDir), that will be displayed in the drop down menu in the backend (optional)
+     * @param string $pluginIcon is an icon identifier or file path prepended with "EXT:", that will be displayed in the drop down menu in the backend (optional)
      * @throws \InvalidArgumentException
      */
-    public static function registerPlugin($extensionName, $pluginName, $pluginTitle, $pluginIconPathAndFilename = null)
+    public static function registerPlugin($extensionName, $pluginName, $pluginTitle, $pluginIcon = null)
     {
         self::checkPluginNameFormat($pluginName);
         self::checkExtensionNameFormat($extensionName);
@@ -134,7 +134,7 @@ tt_content.' . $pluginSignature . ' {
             : 'list_type';
 
         \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addPlugin(
-            [$pluginTitle, $pluginSignature, $pluginIconPathAndFilename],
+            [$pluginTitle, $pluginSignature, $pluginIcon],
             $pluginType,
             $extensionKey
         );