sabbelasichon / typo3-rector

Rector for TYPO3
MIT License
215 stars 60 forks source link

Deprecation: #95222 - Extbase ViewInterface #3715

Open simonschaufi opened 7 months ago

simonschaufi commented 7 months ago

Deprecation: #95222 - Extbase ViewInterface

https://docs.typo3.org/c/typo3/cms-core/main/en-us/Changelog/11.5/Deprecation-95222-ExtbaseViewInterface.html .. include:: /Includes.rst.txt

.. _deprecation-95222:

=========================================== Deprecation: #95222 - Extbase ViewInterface

See :issue:95222

Description

To further streamline Fluid view related class inheritance and dependencies, the interface :php:TYPO3\CMS\Extbase\Mvc\View\ViewInterface has been marked as deprecated and will be removed in TYPO3 v12.

Impact

This deprecation has little impact on TYPO3 v11: The interface is kept and still carried around in the Core, no PHP :php:E_USER_DEPRECATED error is triggered.

The interface itself deviates from the casual view related classes only by requiring an implementation of method :php:initializeView() which was never actively used, calling that method will vanish in TYPO3 v12. The second deviation is method :php:setControllerContext(), and class :php:ControllerContext has been marked as deprecated, too.

Affected Installations

The extension scanner will find usages of Extbase :php:ViewInterface as a strong match.

Migration

Some instances may rely on extensions that type hint :php:ViewInterface, especially in the Extbase action controller method :php:initializeView(). The default implementation of that method in :php:TYPO3\CMS\Extbase\Mvc\Controller\ActionController is empty. To simplify compatibility for extensions supporting both TYPO3 v11 and TYPO3 v12, that empty method will be removed in TYPO3 v12, but will still be called if it exists in classes extending :php:ActionController. Extension authors should thus avoid calling :php:parent::initializeView($view) in their implementation of :php:initializeView() to prepare towards TYPO3 v12. Additionally, extension authors should adapt the method signature to avoid a PHP contravariance violation:

.. code-block:: php

// Old:
protected function initializeView(ViewInterface $view)
// New:
protected function initializeView($view)

Apart from that, usages of TYPO3\CMS\Extbase\Mvc\View\ViewInterface should be changed to the more specific :php:TYPO3\CMS\Fluid\View\StandaloneView - usually in non-Extbase related classes, or to the less specific :php:TYPO3Fluid\Fluid\View\ViewInterface.

If using a custom view implementing :php:ViewInterface, keep in mind that auto configuration based on the interface will be dropped in TYPO3 v12, you may have to configure the service in :file:Services.yaml manually.

.. index:: Fluid, PHP-API, FullyScanned, ext:fluid

sabbelasichon commented 4 months ago

We should also add a docblock with TYPO3Fluid\Fluid\View\ViewInterface $view

simonschaufi commented 2 months ago

this is for example used in news and solr

sabbelasichon commented 1 month ago

@simonschaufi What is missing here. I see two things:

  1. Remove parent call
  2. Use StandaloneView instead of TYPO3\CMS\Extbase\Mvc\View\ViewInterface
sabbelasichon commented 1 month ago

@simonschaufi IMHO it is not possible to distinguish when to use TYPO3\CMS\Fluid\View\StandaloneView and when to use TYPO3Fluid\Fluid\View\ViewInterface. We should always use TYPO3\CMS\Fluid\View\StandaloneView