Files
cms-core/Documentation/Changelog/11.5/Deprecation-95320-VariousMethodArgumentsInAuthenticationObjects.rst

68 lines
2.2 KiB
ReStructuredText

.. include:: /Includes.rst.txt
.. _deprecation-95320:
========================================================================
Deprecation: #95320 - Various method arguments in Authentication objects
========================================================================
See :issue:`95320`
Description
===========
The following methods of the classes
:php:`TYPO3\CMS\Core\Authentication\AbstractUserAuthentication` and
:php:`TYPO3\CMS\Core\Authentication\BackendUserAuthentication` have their
first argument been marked as deprecated:
* :php:`AbstractUserAuthentication->writeUC()`
* :php:`AbstractUserAuthentication->unpack_uc()`
* :php:`BackendUserAuthentication->backendCheckLogin()`
The following method has its third argument marked as deprecated:
* :php:`BackendUserAuthentication->isInWebMount()`
Impact
======
Calling these methods with an explicit argument of the deprecated
arguments given will trigger a PHP :php:`E_USER_DEPRECATED` error.
Affected installations
======================
TYPO3 installations with custom extensions calling these methods
with the deprecated arguments which is highly unlikely.
Migration
=========
Call :php:`AbstractUserAuthentication->writeUC()` without a
method argument. If you need to explicitly set a custom UC value
which is not :php:`AbstractUserAuthentication->uc`, you can set this via
:php:`AbstractUserAuthentication->uc = $myValue;` in the
line before.
Call :php:`AbstractUserAuthentication->unpack_uc()` without an
method argument. If you need to explicitly set a custom UC value
which is not :php:`AbstractUserAuthentication->uc`, you can set this via
:php:`AbstractUserAuthentication->uc = $myValue;` in the
line before.
Call :php:`BackendUserAuthentication->backendCheckLogin()` without
an argument but wrap this call in a :php:`try {} catch (\Throwable $e)` if
you need the old behavior and want to avoid a deprecation
message.
Call :php:`BackendUserAuthentication->isInWebMount()` without the
third argument and check for the return value of being :php:`null`
which is the equivalent of the expected :php:`RuntimeException` being
thrown when the third argument was set to :php:`true`.
.. index:: Backend, Frontend, PHP-API, FullyScanned, ext:core