[TASK] Deprecate unused CSS Styled Content Controller methods 58/36558/2
authorBenjamin Mack <benni@typo3.org>
Sun, 1 Feb 2015 09:19:50 +0000 (10:19 +0100)
committerWouter Wolters <typo3@wouterwolters.nl>
Sun, 1 Feb 2015 13:45:38 +0000 (14:45 +0100)
Certain methods within CSS Styled Content Controller for
rendering TypoScript-based calculations can be deprecated
as there are proper TypoScript-based solutions already.

Resolves: #64711
Releases: master
Change-Id: I2a0868d03f64422fcccae492d002ec7b2c74efa0
Reviewed-on: http://review.typo3.org/36558
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Jan Helke <typo3@helke.de>
Tested-by: Jan Helke <typo3@helke.de>
Reviewed-by: Andreas Fernandez <andreas.fernandez@aspedia.de>
Tested-by: Andreas Fernandez <andreas.fernandez@aspedia.de>
Reviewed-by: Göran Bodenschatz <coding@46halbe.de>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
typo3/sysext/core/Documentation/Changelog/master/Deprecation-64711-UnusedCssStyledContentMethods.rst [new file with mode: 0644]
typo3/sysext/css_styled_content/Classes/Controller/CssStyledContentController.php

diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-64711-UnusedCssStyledContentMethods.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-64711-UnusedCssStyledContentMethods.rst
new file mode 100644 (file)
index 0000000..a9c618a
--- /dev/null
@@ -0,0 +1,26 @@
+==========================================================================
+Deprecation: #64711 - Various methods within CSS Styled Content Controller
+==========================================================================
+
+Description
+===========
+
+The following methods within the main CSS Styled Content Controller responsible for rendering
+custom HTML due to lack of TypoScript logic in the past have been marked for removal for TYPO3 CMS 8.
+They are not part of the default CSS Styled Content TypoScript code since TYPO3 CMS 6.
+
+.. code-block:: php
+
+       CssStyledContentController->render_bullets()
+       CssStyledContentController->render_uploads()
+       CssStyledContentController->beautifyFileLink()
+
+Impact
+======
+
+Using the methods in custom TypoScript code or CSS Styled Content methods will throw a deprecation message.
+
+Migration
+=========
+
+Use default TypoScript from CSS Styled Content derived from the current version.
index 88d76a0..8075374 100644 (file)
@@ -61,8 +61,10 @@ class CssStyledContentController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlug
         * @param string $content Content input. Not used, ignore.
         * @param array $conf TypoScript configuration
         * @return string HTML output.
+        * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, is done by default in pure TypoScript
         */
        public function render_bullets($content, $conf) {
+               GeneralUtility::logDeprecatedFunction();
                // Look for hook before running default code for function
                if ($hookObj = $this->hookRequest('render_bullets')) {
                        return $hookObj->render_bullets($content, $conf);
@@ -220,8 +222,10 @@ class CssStyledContentController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlug
         * @param string $content Content input. Not used, ignore.
         * @param array $conf TypoScript configuration
         * @return string HTML output.
+        * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, is done by default in pure TypoScript
         */
        public function render_uploads($content, $conf) {
+               GeneralUtility::logDeprecatedFunction();
                // Look for hook before running default code for function
                if ($hookObj = $this->hookRequest('render_uploads')) {
                        return $hookObj->render_uploads($content, $conf);
@@ -1158,8 +1162,10 @@ class CssStyledContentController extends \TYPO3\CMS\Frontend\Plugin\AbstractPlug
         * @param bool $useSpaces
         * @param bool $cutFileExtension
         * @return array modified array with new link text
+        * @deprecated since TYPO3 CMS 7, will be removed in TYPO3 CMS 8, is done by default in pure TypoScript
         */
        protected function beautifyFileLink(array $links, $fileName, $useSpaces = FALSE, $cutFileExtension = FALSE) {
+               GeneralUtility::logDeprecatedFunction();
                $linkText = $fileName;
                if ($useSpaces) {
                        $linkText = str_replace('_', ' ', $linkText);