[TASK] Update comments in ExtensionManagementUtility 37/52437/3
authorJigal van Hemert <jigal.van.hemert@typo3.org>
Thu, 13 Apr 2017 11:11:43 +0000 (13:11 +0200)
committerBenni Mack <benni@typo3.org>
Thu, 27 Apr 2017 11:29:30 +0000 (13:29 +0200)
Comments now mention that functions in ExtensionManagementUtility
must not be used in ext_tables.php

Resolves: #80837
Releases: master, 8.7
Change-Id: Ib36bdb1b6b6cc055759498199931f09b03065ebe
Reviewed-on: https://review.typo3.org/52437
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Reviewed-by: Benni Mack <benni@typo3.org>
Tested-by: Benni Mack <benni@typo3.org>
typo3/sysext/core/Classes/Utility/ExtensionManagementUtility.php

index 7035648..c1f9373 100644 (file)
@@ -229,7 +229,7 @@ class ExtensionManagementUtility
      * Adds an array with $GLOBALS['TCA'] column-configuration to the $GLOBALS['TCA']-entry for that table.
      * This function adds the configuration needed for rendering of the field in TCEFORMS - but it does NOT add the field names to the types lists!
      * So to have the fields displayed you must also call fx. addToAllTCAtypes or manually add the fields to the types list.
-     * FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php . Use in ext_tables.php FILES may break the frontend.
      *
      * @param string $table The table name of a table already present in $GLOBALS['TCA'] with a columns section
      * @param array $columnArray The array with the additional columns (typical some fields an extension wants to add)
@@ -248,7 +248,7 @@ class ExtensionManagementUtility
      * Adds a string $string (comma separated list of field names) to all ["types"][xxx]["showitem"] entries for table $table (unless limited by $typeList)
      * This is needed to have new fields shown automatically in the TCEFORMS of a record from $table.
      * Typically this function is called after having added new columns (database fields) with the addTCAcolumns function
-     * FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
      *
      * @param string $table Table name
      * @param string $newFieldsString Field list to add.
@@ -336,6 +336,7 @@ class ExtensionManagementUtility
      * Adds new fields to all palettes that is defined after an existing field.
      * If the field does not have a following palette yet, it's created automatically
      * and gets called "generatedFor-$field".
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
      *
      * See unit tests for more examples and edge cases.
      *
@@ -420,6 +421,7 @@ class ExtensionManagementUtility
     /**
      * Adds new fields to a palette.
      * If the palette does not exist yet, it's created automatically.
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
      *
      * @param string $table Name of the table
      * @param string $palette Name of the palette to be extended
@@ -445,6 +447,7 @@ class ExtensionManagementUtility
      * Warning: Do not use this method for radio or check types, especially not
      * with $relativeToField and $relativePosition parameters. This would shift
      * existing database data 'off by one'.
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
      *
      * As an example, this can be used to add an item to tt_content CType select
      * drop-down after the existing 'mailform' field with these parameters:
@@ -1152,7 +1155,7 @@ class ExtensionManagementUtility
      * 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
-     * FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
+     * 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 string $type Type (eg. "list_type") - basically a field from "tt_content" table
@@ -1189,6 +1192,7 @@ class ExtensionManagementUtility
     /**
      * Adds an entry to the "ds" array of the tt_content field "pi_flexform".
      * This is used by plugins to add a flexform XML reference / content for use when they are selected as plugin or content element.
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
      *
      * @param string $piKeyToMatch Plugin key as used in the list_type field. Use the asterisk * to match all list_type values.
      * @param string $value Either a reference to a flex-form XML file (eg. "FILE:EXT:newloginbox/flexform_ds.xml") or the XML directly.
@@ -1205,7 +1209,7 @@ class ExtensionManagementUtility
     /**
      * Adds the $table tablename to the list of tables allowed to be includes by content element type "Insert records"
      * By using $content_table and $content_field you can also use the function for other tables.
-     * FOR USE IN ext_tables.php FILES or files in Configuration/TCA/Overrides/*.php Use the latter to benefit from TCA caching!
+     * FOR USE IN files in Configuration/TCA/Overrides/*.php Use in ext_tables.php FILES may break the frontend.
      *
      * @param string $table Table name to allow for "insert record
      * @param string $content_table Table name TO WHICH the $table name is applied. See $content_field as well.
@@ -1291,7 +1295,7 @@ tt_content.' . $key . $suffix . ' {
 
     /**
      * Call this method to add an entry in the static template list found in sys_templates
-     * FOR USE IN ext_tables.php FILES or in Configuration/TCA/Overrides/sys_template.php Use the latter to benefit from TCA caching!
+     * FOR USE IN Configuration/TCA/Overrides/sys_template.php Use in ext_tables.php may break the frontend.
      *
      * @param string $extKey Is of course the extension key
      * @param string $path Is the path where the template files (fixed names) include_static.txt (integer list of uids from the table "static_templates"), constants.txt, setup.txt, and include_static_file.txt is found (relative to extPath, eg. 'static/'). The file include_static_file.txt, allows you to include other static templates defined in files, from your static template, and thus corresponds to the field 'include_static_file' in the sys_template table. The syntax for this is a comma separated list of static templates to include, like:  EXT:fluid_styled_content/Configuration/TypoScript/,EXT:da_newsletter_subscription/static/,EXT:cc_random_image/pi2/static/
@@ -1309,7 +1313,7 @@ tt_content.' . $key . $suffix . ' {
 
     /**
      * Call this method to add an entry in the pageTSconfig list found in pages
-     * FOR USE in Configuration/TCA/Overrides/pages.php Use the latter to benefit from TCA caching!
+     * FOR USE in Configuration/TCA/Overrides/pages.php
      *
      * @param string $extKey The extension key
      * @param string $filePath The path where the TSconfig file is located