[TASK] Deprecate GIFbuilder-related methods in ContentObjectRenderer 23/52223/2
authorBenni Mack <benni@typo3.org>
Tue, 28 Mar 2017 19:36:38 +0000 (21:36 +0200)
committerFrank Naegler <frank.naegler@typo3.org>
Tue, 28 Mar 2017 20:06:19 +0000 (22:06 +0200)
The following methods within ContentObjectRenderer (cObj) have been marked
as deprecated as all logic related to that have been moved to GifBuilder.

* clearTSProperties()
* gifBuilderTextBox()
* linebreaks()

Resolves: #80532
Releases: master
Change-Id: I064b0b22c944894ec358d95d50a4be72969a7567
Reviewed-on: https://review.typo3.org/52223
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Frank Naegler <frank.naegler@typo3.org>
Tested-by: Frank Naegler <frank.naegler@typo3.org>
typo3/sysext/core/Documentation/Changelog/master/Deprecation-80532-GifBuilder-relatedMethodsInContentObjectRenderer.rst [new file with mode: 0644]
typo3/sysext/frontend/Classes/ContentObject/ContentObjectRenderer.php

diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80532-GifBuilder-relatedMethodsInContentObjectRenderer.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80532-GifBuilder-relatedMethodsInContentObjectRenderer.rst
new file mode 100644 (file)
index 0000000..42f31e9
--- /dev/null
@@ -0,0 +1,31 @@
+.. include:: ../../Includes.txt
+
+=========================================================================
+Deprecation: #80532 - GifBuilder-related methods in ContentObjectRenderer
+=========================================================================
+
+See :issue:`80532`
+
+Description
+===========
+
+The following methods related to php:`GifBuilder` within php:`ContentObjectRenderer` have been marked
+as deprecated.
+
+* clearTSProperties()
+* gifBuilderTextBox()
+* linebreaks()
+
+
+Impact
+======
+
+Calling any of the methods above will trigger a deprecation message.
+
+
+Affected Installations
+======================
+
+Any installation using these methods in custom extensions.
+
+.. index:: Frontend, PHP-API
\ No newline at end of file
index 18e7b49..f27b50a 100644 (file)
@@ -6861,9 +6861,11 @@ class ContentObjectRenderer
      * @param string $propList List of properties to clear both value/properties for. Eg. "myprop,another_property
      * @return array The TypoScript array
      * @see gifBuilderTextBox()
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, as the textbox is built within GifBuilder
      */
     public function clearTSProperties($TSArr, $propList)
     {
+        GeneralUtility::logDeprecatedFunction();
         $list = explode(',', $propList);
         foreach ($list as $prop) {
             $prop = trim($prop);
@@ -6904,9 +6906,11 @@ class ContentObjectRenderer
      * @param array $conf TypoScript properties for this function
      * @param string $text The text string to write onto the GIFBUILDER file
      * @return array The modified $gifbuilderConf array
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, as the textbox is built within GifBuilder
      */
     public function gifBuilderTextBox($gifbuilderConf, $conf, $text)
     {
+        GeneralUtility::logDeprecatedFunction();
         $chars = (int)$conf['chars'] ?: 20;
         $lineDist = (int)$conf['lineDist'] ?: 20;
         $Valign = strtolower(trim($conf['Valign']));
@@ -6955,9 +6959,11 @@ class ContentObjectRenderer
      * @return array array with lines.
      * @access private
      * @see gifBuilderTextBox()
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9, as the textbox is built within GifBuilder
      */
     public function linebreaks($string, $chars, $maxLines = 0)
     {
+        GeneralUtility::logDeprecatedFunction();
         $lines = explode(LF, $string);
         $lineArr = [];
         $c = 0;