DriverMiddlewareService.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Database;
 
use ‪TYPO3\CMS\Core\Service\DependencyOrderingService;
 
class DriverMiddlewareService
{
    public function __construct(private readonly DependencyOrderingService $dependencyOrderingService) {}
 
    public function order(array $middlewares): array
    {
        return $this->dependencyOrderingService->orderByDependencies($middlewares);
    }
 
    public function normalizeMiddlewareConfiguration(string ‪$identifier, array|string $middleware): array
    {
        // @deprecated class-string middleware configuration since v13. Remove this in v14 or throw an exception.
        if (is_string($middleware)) {
            trigger_error(
                sprintf(
                    'DriverMiddleware registration with class-string is deprecated since v13 for "%s". Please configure as array.',
                    ‪$identifier
                ),
                E_USER_DEPRECATED
            );
            if ($middleware === '') {
                $middleware = [
                    'disabled' => true,
                ];
            } else {
                $middleware = [
                    'target' => $middleware,
                    'after' => [
                        'typo3/core/custom-platform-driver-middleware',
                    ],
                ];
            }
        }
 
        return $middleware;
    }
 
    public function ensureCompleteMiddlewareConfiguration(array $middleware): array
    {
        $target = (string)($middleware['target'] ?? '');
        if ($target === '' || !class_exists($target)) {
            throw new \RuntimeException(
                'Doctrine DBAL driver middleware registration requires a valid class-name as "target".',
                1701546655
            );
        }
        $targetImplements = $target !== '' && class_exists($target) ? (class_implements($target) ?: []) : [];
        return [
            'target' => $target,
            'disabled' => (bool)($middleware['disabled'] ?? false),
            'after' => (array)($middleware['after'] ?? []),
            'before' => (array)($middleware['before'] ?? []),
            'type' => '',
        ];
    }
}