[TASK] Deprecate BackendUserAuthentication->simplelog() 35/56935/3
authorChristian Kuhn <lolli@schwarzbu.ch>
Sat, 12 May 2018 12:39:00 +0000 (14:39 +0200)
committerWouter Wolters <typo3@wouterwolters.nl>
Sat, 12 May 2018 12:57:27 +0000 (14:57 +0200)
The method is a shortcut to writelog() and used only once in
the core. To simplify the old fashioned non logging framework
based API a bit, the method is deprecated with the patch.

Resolves: #84981
Releases: master
Change-Id: Idc7a8d0d4e15e5fef8edc64248a7f307df897ec4
Reviewed-on: https://review.typo3.org/56935
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: Wouter Wolters <typo3@wouterwolters.nl>
Tested-by: TYPO3com <no-reply@typo3.com>
typo3/sysext/core/Classes/Authentication/BackendUserAuthentication.php
typo3/sysext/core/Documentation/Changelog/master/Deprecation-84981-BackendUserAuthentication-simplelogDeprecated.rst [new file with mode: 0644]
typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallMatcher.php

index 364baa8..5d8408c 100644 (file)
@@ -2194,7 +2194,7 @@ class BackendUserAuthentication extends AbstractUserAuthentication
                 ['workspace_id' => $this->user['workspace_id']],
                 ['uid' => (int)$this->user['uid']]
             );
-            $this->simplelog('User changed workspace to "' . $this->workspace . '"');
+            $this->writelog(4, 0, 0, 0, 'User changed workspace to "' . $this->workspace . '"', []);
         }
     }
 
@@ -2341,9 +2341,11 @@ class BackendUserAuthentication extends AbstractUserAuthentication
      * @param string $extKey Option extension key / module name
      * @param int $error Error level. 0 = message, 1 = error (user problem), 2 = System Error (which should not happen), 3 = security notice (admin)
      * @return int Log entry UID
+     * @deprecated since core v9, will be removed with core v10
      */
     public function simplelog($message, $extKey = '', $error = 0)
     {
+        trigger_error('This method will be removed in TYPO3 v10.', E_USER_DEPRECATED);
         return $this->writelog(4, 0, $error, 0, ($extKey ? '[' . $extKey . '] ' : '') . $message, []);
     }
 
diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-84981-BackendUserAuthentication-simplelogDeprecated.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-84981-BackendUserAuthentication-simplelogDeprecated.rst
new file mode 100644 (file)
index 0000000..dc90ef2
--- /dev/null
@@ -0,0 +1,33 @@
+.. include:: ../../Includes.txt
+
+=======================================================================
+Deprecation: #84981 - BackendUserAuthentication->simplelog() deprecated
+=======================================================================
+
+See :issue:`84981`
+
+Description
+===========
+
+Method :php:`TYPO3\CMS\Core\Authentication\BackendUserAuthentication->simplelog()` has been deprecated.
+
+
+Impact
+======
+
+The method has been a shortcut to :php:`writelog()` which can be used instead.
+
+
+Affected Installations
+======================
+
+Instances may use extensions that call this method. Calling the method will now throw a deprecation message.
+The extension scanner should find possible usages.
+
+
+Migration
+=========
+
+Use :php:`writelog()` instead or - even better - use the logging framework to log messages.
+
+.. index:: Backend, PHP-API, FullyScanned
\ No newline at end of file
index e45dd69..6e79738 100644 (file)
@@ -2179,4 +2179,11 @@ return [
             'Deprecation-84980-BackendUserAuthentication-addTScommentDeprecated.rst',
         ],
     ],
+    'TYPO3\CMS\Core\Authentication\BackendUserAuthentication->simplelog' => [
+        'numberOfMandatoryArguments' => 1,
+        'maximumNumberOfArguments' => 3,
+        'restFiles' => [
+            'Deprecation-84981-BackendUserAuthentication-simplelogDeprecated.rst',
+        ],
+    ],
 ];