Autoloading inheritance issue with abstract classes [Symfony 6.1 & PHP8.1] #48295

MenschLennart · 2022-11-23T11:07:37Z

MenschLennart
Nov 23, 2022

Hello everyone,
Symfony's dependency injection can't properly resolve class inheritance and thus resolves an error that occurs from time to time. I suspect it is related to the cache.

Symfony 6.1 & PHP8.1

Local with Built-In PHP 8.1 (PHP-FPM)
Local with NGINX and PHP 8.1 (PHP-FPM)
Server environment with NGINX and PHP-FPM 8.1 (PHP-FPM)

The error occurs in all test environments.

If it contributes to the error, please know that we have anonymised the namespace. We use a custom namespace that is set via composer.json.

The following exception is thrown. This also crashes the PHP service and restarts it automatically.

Error: During inheritance of App\Dialog\Dialog, while autoloading App\Dialog\Application\ContractCheckDialog: Uncaught ReflectionException: Class "App\Dialog\Dialog" does not exist in /Users/lenni/Development/tap-crm/vendor/symfony/error-handler/DebugClassLoader.php:318
Stack trace:
#0 /Users/lenni/Development/tap-crm/vendor/symfony/error-handler/DebugClassLoader.php(318): ReflectionClass->__construct('App\\Ta...')
#1 /Users/lenni/Development/tap-crm/vendor/symfony/error-handler/DebugClassLoader.php(405): Symfony\Component\ErrorHandler\DebugClassLoader->checkClass('App\\Ta...')
#2 /Users/lenni/Development/tap-crm/vendor/symfony/error-handler/DebugClassLoader.php(328): Symfony\Component\ErrorHandler\DebugClassLoader->checkAnnotations(Object(ReflectionClass), 'App\\Ta...')
#3 /Users/lenni/Development/tap-crm/vendor/symfony/error-handler/DebugClassLoader.php(301): Symfony\Component\ErrorHandler\DebugClassLoader->checkClass('App\\Ta...', '/Users/lenni/De...')
#4 /Users/lenni/Development/tap-crm/src/Dialog/Dialog.php(15): Symfony\Component\ErrorHandler\DebugClassLoader->loadClass('App\\Ta...')
#5 /Users/lenni/Development/tap-crm/var/cache/dev/ContainerEHvXLdt/getContractCheckDialogService.php(21): include_once('/Users/lenni/De...')
#6 /Users/lenni/Development/tap-crm/var/cache/dev/ContainerEHvXLdt/App_KernelDevDebugContainer.php(471): ContainerEHvXLdt\getContractCheckDialogService::do(Object(ContainerEHvXLdt\ App_KernelDevDebugContainer), true)
#7 /Users/lenni/Development/tap-crm/vendor/symfony/dependency-injection/Container.php(215): ContainerEHvXLdt\ App_KernelDevDebugContainer->load('getContractChec...')
#8 /Users/lenni/Development/tap-crm/vendor/symfony/dependency-injection/Container.php(197): Symfony\Component\DependencyInjection\Container->make('App\...', 1)
#9 /Users/lenni/Development/tap-crm/src/Service/DialogService.php(41): Symfony\Component\DependencyInjection\Container->get('App\...')
#10 /Users/lenni/Development/tap-crm/src/Controller/ViewpointController.php(225): App\Service\DialogService->createDialog('App\...', Object(App\Entity\Application), Array, false)
#11 /Users/lenni/Development/tap-crm/src/Controller/ApplicationController.php(129): App\Controller\ViewpointController->addDialog('App...', Object(App\Entity\Application))
#12 /Users/lenni/Development/tap-crm/vendor/symfony/http-kernel/HttpKernel.php(163): App\Controller\ApplicationController->read(Object(Symfony\Component\HttpFoundation\Request), 'f7150800-f620-1...')
#13 /Users/lenni/Development/tap-crm/vendor/symfony/http-kernel/HttpKernel.php(75): Symfony\Component\HttpKernel\HttpKernel->handleRaw(Object(Symfony\Component\HttpFoundation\Request), 1)
#14 /Users/lenni/Development/tap-crm/vendor/symfony/http-kernel/Kernel.php(202): Symfony\Component\HttpKernel\HttpKernel->handle(Object(Symfony\Component\HttpFoundation\Request), 1, true)
#15 /Users/lenni/Development/tap-crm/vendor/symfony/runtime/Runner/Symfony/HttpKernelRunner.php(35): Symfony\Component\HttpKernel\Kernel->handle(Object(Symfony\Component\HttpFoundation\Request))
#16 /Users/lenni/Development/tap-crm/vendor/autoload_runtime.php(29): Symfony\Component\Runtime\Runner\Symfony\HttpKernelRunner->run()
#17 /Users/lenni/Development/tap-crm/public/index.php(5): require_once('/Users/lenni/De...')
#18 {main}

What we want to do

With the DialogService, the respective class with the DI is to be created via function and the class name as parameter.
Briefly. We are aware that inserting the container is not best practice - but we decided to do it here because we want to build classes dynamically. We are sure there are better ways and means to do this. But we still want to discuss this issue here with you.

service.yaml
We added a new entry for all Dialogs under a new namespace like described here because since we inject the container we need to set them to be public.
In addition, we use the Calls function to set the container in the DialogService.

App\:
    resource: '../src/'
    exclude:
      - '../src/DependencyInjection/'
      - '../src/Entity/'
      - '../src/Kernel.php'

  App\Dialog\:
    resource: '../src/Dialog/'
    public: true
  App\Service\DialogService:
    calls: [ [ setContainer, [ '@service_container' ] ] ]

Dialog (abstract class)
Abstract class with standard functions like getters and setters from which all *Dialog classes inherit.

<?php
namespace App\Dialog\Application;
...
abstract class Dialog implements DialogInterface
{
    private string $name;
    private string $modal;
    private string $view;

    private ?FormInterface $form;
    private ?DataTableInterface $data = null;
    private array $options = [];
    private bool $available = false;

    public function __construct(
        protected FormFactoryInterface $formFactory,
        protected Environment $twig,
        protected EntityManagerInterface $em
    ) {}
...

ContractCheckDialog.php (inheritance class)
The Class we want to autoload via $this->container->get($class) inside of the DialogService.
This Class is using the PHP 8 #[Required] annotation component implemented with Symfony 6

<?php
namespace App\Dialog\Application;
...
class ContractCheckDialog extends Dialog
{
    private ServerDocumentService $documentService;

    #[Required]
    public function setDocumentService(ServerDocumentService $documentService): void
    {
        $this->documentService = $documentService;
    }
...

DialogService
This service is getting the container via ContainerAwareTrait and use it to dynamically create the class
with $this->container->get($class);

<?php

namespace App\Service;

use Psr\Log\LoggerInterface;
use App\Dialog\DialogInterface;
use App\Entity\DataTableEntity;
use Symfony\Component\DependencyInjection\ContainerAwareTrait;
use Symfony\Component\Finder\SplFileInfo;

class DialogService
{
    use ContainerAwareTrait;

    private FileLoaderService $fileLoaderService;
    private LoggerInterface $logger;


    public const TAP_DIALOG_DIR = '/src/Form/%ENTITY%/Dialog';

    /**
     * @param FileLoaderService $fileLoaderService
     * @param LoggerInterface   $logger
     */
    public function __construct(FileLoaderService $fileLoaderService, LoggerInterface $logger)
    {
        $this->fileLoaderService = $fileLoaderService;
        $this->logger = $logger;
    }

    public function createDialog(
        string           $class,
        ?DataTableEntity $data = null,
        array            $options = [],
        bool             $available = false,
    ): ?DialogInterface
    {
        /** @var DialogInterface $dialog */
        $dialog = $this->container->get($class);
        $dialog?->setData($data);
        $dialog?->setOptions($options);
        $dialog?->setAvailable($available);
        $dialog?->configure();

        return $dialog;
    }
...

Have we configured the service.yaml incorrectly? Or are we doing something wrong elsewhere? We would be very happy to hear your ideas about this, because so far we have not been able to delete it and find the causes of the problem.

MatTheCat · 2022-11-26T08:50:52Z

MatTheCat
Nov 26, 2022

Are you sure you don't just reference an inexisting App\Dialog\Dialog class?

Else we would need a reproducer in order to investigate.

0 replies

Autoloading inheritance issue with abstract classes [Symfony 6.1 & PHP8.1] #48295

MenschLennart Nov 23, 2022

What we want to do

Replies: 1 suggested answer

MatTheCat Nov 26, 2022

Insert Link

MenschLennart
Nov 23, 2022

MatTheCat
Nov 26, 2022