vendor/doctrine/doctrine-bundle/ConnectionFactory.php line 45

Open in your IDE?
  1. <?php
  3. namespace Doctrine\Bundle\DoctrineBundle;
  5. use Doctrine\Common\EventManager;
  6. use Doctrine\DBAL\Configuration;
  7. use Doctrine\DBAL\Connection;
  8. use Doctrine\DBAL\Driver\AbstractMySQLDriver;
  9. use Doctrine\DBAL\DriverManager;
  10. use Doctrine\DBAL\Exception as DBALException;
  11. use Doctrine\DBAL\Exception\DriverException;
  12. use Doctrine\DBAL\Platforms\AbstractPlatform;
  13. use Doctrine\DBAL\Types\Type;
  15. use function array_merge;
  16. use function is_subclass_of;
  17. use function trigger_deprecation;
  19. use const PHP_EOL;
  21. /** @psalm-import-type Params from DriverManager */
  22. class ConnectionFactory
  23. {
  24.     /** @var mixed[][] */
  25.     private $typesConfig = [];
  27.     /** @var bool */
  28.     private $initialized = false;
  30.     /** @param mixed[][] $typesConfig */
  31.     public function __construct(array $typesConfig)
  32.     {
  33.         $this->typesConfig = $typesConfig;
  34.     }
  36.     /**
  37.      * Create a connection by name.
  38.      *
  39.      * @param mixed[]               $params
  40.      * @param array<string, string> $mappingTypes
  41.      * @psalm-param Params $params
  42.      *
  43.      * @return Connection
  44.      */
  45.     public function createConnection(array $params, ?Configuration $config = null, ?EventManager $eventManager = null, array $mappingTypes = [])
  46.     {
  47.         if (! $this->initialized) {
  48.             $this->initializeTypes();
  49.         }
  51.         $overriddenOptions = [];
  52.         if (isset($params['connection_override_options'])) {
  53.             trigger_deprecation('doctrine/doctrine-bundle', '2.4', 'The "connection_override_options" connection parameter is deprecated');
  54.             $overriddenOptions = $params['connection_override_options'];
  55.             unset($params['connection_override_options']);
  56.         }
  58.         if (! isset($params['pdo']) && (! isset($params['charset']) || $overriddenOptions || isset($params['dbname_suffix']))) {
  59.             $wrapperClass = null;
  61.             if (isset($params['wrapperClass'])) {
  62.                 if (! is_subclass_of($params['wrapperClass'], Connection::class)) {
  63.                     throw DBALException::invalidWrapperClass($params['wrapperClass']);
  64.                 }
  66.                 $wrapperClass           = $params['wrapperClass'];
  67.                 $params['wrapperClass'] = null;
  68.             }
  70.             $connection = DriverManager::getConnection($params, $config, $eventManager);
  71.             $params     = array_merge($connection->getParams(), $overriddenOptions);
  72.             $driver     = $connection->getDriver();
  74.             if (isset($params['dbname']) && isset($params['dbname_suffix'])) {
  75.                 $params['dbname'] .= $params['dbname_suffix'];
  76.             }
  78.             if (! isset($params['charset'])) {
  79.                 if ($driver instanceof AbstractMySQLDriver) {
  80.                     $params['charset'] = 'utf8mb4';
  82.                     if (! isset($params['defaultTableOptions']['collate'])) {
  83.                         $params['defaultTableOptions']['collate'] = 'utf8mb4_unicode_ci';
  84.                     }
  85.                 } else {
  86.                     $params['charset'] = 'utf8';
  87.                 }
  88.             }
  90.             if ($wrapperClass !== null) {
  91.                 $params['wrapperClass'] = $wrapperClass;
  92.             } else {
  93.                 $wrapperClass = Connection::class;
  94.             }
  96.             $connection = new $wrapperClass($params, $driver, $config, $eventManager);
  97.         } else {
  98.             $connection = DriverManager::getConnection($params, $config, $eventManager);
  99.         }
  101.         if (! empty($mappingTypes)) {
  102.             $platform = $this->getDatabasePlatform($connection);
  103.             foreach ($mappingTypes as $dbType => $doctrineType) {
  104.                 $platform->registerDoctrineTypeMapping($dbType, $doctrineType);
  105.             }
  106.         }
  108.         return $connection;
  109.     }
  111.     /**
  112.      * Try to get the database platform.
  113.      *
  114.      * This could fail if types should be registered to an predefined/unused connection
  115.      * and the platform version is unknown.
  116.      * For details have a look at DoctrineBundle issue #673.
  117.      *
  118.      * @throws DBALException
  119.      */
  120.     private function getDatabasePlatform(Connection $connection): AbstractPlatform
  121.     {
  122.         try {
  123.             return $connection->getDatabasePlatform();
  124.         } catch (DriverException $driverException) {
  125.             throw new DBALException(
  126.                 'An exception occurred while establishing a connection to figure out your platform version.' . PHP_EOL .
  127.                 "You can circumvent this by setting a 'server_version' configuration value" . PHP_EOL . PHP_EOL .
  128.                 'For further information have a look at:' . PHP_EOL .
  129.                 'https://github.com/doctrine/DoctrineBundle/issues/673',
  130.                 0,
  131.                 $driverException
  132.             );
  133.         }
  134.     }
  136.     /**
  137.      * initialize the types
  138.      */
  139.     private function initializeTypes(): void
  140.     {
  141.         foreach ($this->typesConfig as $typeName => $typeConfig) {
  142.             if (Type::hasType($typeName)) {
  143.                 Type::overrideType($typeName, $typeConfig['class']);
  144.             } else {
  145.                 Type::addType($typeName, $typeConfig['class']);
  146.             }
  147.         }
  149.         $this->initialized = true;
  150.     }
  151. }