vendor/doctrine/doctrine-bundle/src/ConnectionFactory.php line 77

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\Connection\StaticServerVersionProvider;
  9. use Doctrine\DBAL\ConnectionException;
  10. use Doctrine\DBAL\DriverManager;
  11. use Doctrine\DBAL\Exception as DBALException;
  12. use Doctrine\DBAL\Exception\DriverException;
  13. use Doctrine\DBAL\Exception\DriverRequired;
  14. use Doctrine\DBAL\Exception\InvalidWrapperClass;
  15. use Doctrine\DBAL\Exception\MalformedDsnException;
  16. use Doctrine\DBAL\Platforms\AbstractMySQLPlatform;
  17. use Doctrine\DBAL\Platforms\AbstractPlatform;
  18. use Doctrine\DBAL\Tools\DsnParser;
  19. use Doctrine\DBAL\Types\Type;
  20. use Doctrine\Deprecations\Deprecation;
  21. use InvalidArgumentException;
  23. use function array_merge;
  24. use function class_exists;
  25. use function is_subclass_of;
  26. use function method_exists;
  27. use function trigger_deprecation;
  29. use const PHP_EOL;
  31. /** @phpstan-import-type Params from DriverManager */
  32. class ConnectionFactory
  33. {
  34. /** @internal */
  35. public const DEFAULT_SCHEME_MAP = [
  36. 'db2' => 'ibm_db2',
  37. 'mssql' => 'pdo_sqlsrv',
  38. 'mysql' => 'pdo_mysql',
  39. 'mysql2' => 'pdo_mysql', // Amazon RDS, for some weird reason
  40. 'postgres' => 'pdo_pgsql',
  41. 'postgresql' => 'pdo_pgsql',
  42. 'pgsql' => 'pdo_pgsql',
  43. 'sqlite' => 'pdo_sqlite',
  44. 'sqlite3' => 'pdo_sqlite',
  45. ];
  47. /** @var mixed[][] */
  48. private array $typesConfig = [];
  50. private DsnParser $dsnParser;
  52. private bool $initialized = false;
  54. /** @param mixed[][] $typesConfig */
  55. public function __construct(array $typesConfig, ?DsnParser $dsnParser = null)
  56. {
  57. $this->typesConfig = $typesConfig;
  58. $this->dsnParser = $dsnParser ?? new DsnParser(self::DEFAULT_SCHEME_MAP);
  59. }
  61. /**
  62. * Create a connection by name.
  63. *
  64. * @param mixed[] $params
  65. * @param array<string, string> $mappingTypes
  66. * @phpstan-param Params $params
  67. *
  68. * @return Connection
  69. */
  70. public function createConnection(array $params, ?Configuration $config = null, ?EventManager $eventManager = null, array $mappingTypes = [])
  71. {
  72. if (! method_exists(Connection::class, 'getEventManager') && $eventManager !== null) {
  73. throw new InvalidArgumentException('Passing an EventManager instance is not supported with DBAL > 3');
  74. }
  76. if (! $this->initialized) {
  77. $this->initializeTypes();
  78. }
  80. $overriddenOptions = [];
  81. /** @psalm-suppress InvalidArrayOffset We should adjust when https://github.com/vimeo/psalm/issues/8984 is fixed */
  82. if (isset($params['connection_override_options'])) {
  83. trigger_deprecation('doctrine/doctrine-bundle', '2.4', 'The "connection_override_options" connection parameter is deprecated');
  84. $overriddenOptions = $params['connection_override_options'];
  85. unset($params['connection_override_options']);
  86. }
  88. $params = $this->parseDatabaseUrl($params);
  90. // URL support for PrimaryReplicaConnection
  91. if (isset($params['primary'])) {
  92. $params['primary'] = $this->parseDatabaseUrl($params['primary']);
  93. }
  95. if (isset($params['replica'])) {
  96. foreach ($params['replica'] as $key => $replicaParams) {
  97. $params['replica'][$key] = $this->parseDatabaseUrl($replicaParams);
  98. }
  99. }
  101. /** @psalm-suppress InvalidArrayOffset We should adjust when https://github.com/vimeo/psalm/issues/8984 is fixed */
  102. if (! isset($params['pdo']) && (! isset($params['charset']) || $overriddenOptions || isset($params['dbname_suffix']))) {
  103. $wrapperClass = null;
  105. if (isset($params['wrapperClass'])) {
  106. if (! is_subclass_of($params['wrapperClass'], Connection::class)) {
  107. if (class_exists(InvalidWrapperClass::class)) {
  108. throw InvalidWrapperClass::new($params['wrapperClass']);
  109. }
  111. /* @phpstan-ignore staticMethod.notFound */
  112. throw DBALException::invalidWrapperClass($params['wrapperClass']);
  113. }
  115. $wrapperClass = $params['wrapperClass'];
  116. $params['wrapperClass'] = null;
  117. }
  119. $connection = DriverManager::getConnection(...array_merge([$params, $config], $eventManager ? [$eventManager] : []));
  120. $params = $this->addDatabaseSuffix(array_merge($connection->getParams(), $overriddenOptions));
  121. $driver = $connection->getDriver();
  122. /** @phpstan-ignore arguments.count (DBAL < 4.x doesn't accept an argument) */
  123. $platform = $driver->getDatabasePlatform(
  124. ...(class_exists(StaticServerVersionProvider::class)
  125. ? [new StaticServerVersionProvider($params['serverVersion'] ?? $params['primary']['serverVersion'] ?? '')]
  126. : []
  127. ),
  128. );
  130. if (! isset($params['charset'])) {
  131. if ($platform instanceof AbstractMySQLPlatform) {
  132. $params['charset'] = 'utf8mb4';
  134. if (isset($params['defaultTableOptions']['collate'])) {
  135. Deprecation::trigger(
  136. 'doctrine/doctrine-bundle',
  137. 'https://github.com/doctrine/dbal/issues/5214',
  138. 'The "collate" default table option is deprecated in favor of "collation" and will be removed in doctrine/doctrine-bundle 3.0. ',
  139. );
  140. $params['defaultTableOptions']['collation'] = $params['defaultTableOptions']['collate'];
  141. unset($params['defaultTableOptions']['collate']);
  142. }
  144. if (! isset($params['defaultTableOptions']['collation'])) {
  145. $params['defaultTableOptions']['collation'] = 'utf8mb4_unicode_ci';
  146. }
  147. } else {
  148. $params['charset'] = 'utf8';
  149. }
  150. }
  152. if ($wrapperClass !== null) {
  153. $params['wrapperClass'] = $wrapperClass;
  154. } else {
  155. $wrapperClass = Connection::class;
  156. }
  158. $connection = new $wrapperClass($params, $driver, $config, $eventManager);
  159. } else {
  160. $connection = DriverManager::getConnection(...array_merge([$params, $config], $eventManager ? [$eventManager] : []));
  161. }
  163. if (! empty($mappingTypes)) {
  164. $platform = $this->getDatabasePlatform($connection);
  165. foreach ($mappingTypes as $dbType => $doctrineType) {
  166. $platform->registerDoctrineTypeMapping($dbType, $doctrineType);
  167. }
  168. }
  170. return $connection;
  171. }
  173. /**
  174. * Try to get the database platform.
  175. *
  176. * This could fail if types should be registered to an predefined/unused connection
  177. * and the platform version is unknown.
  178. *
  179. * @link https://github.com/doctrine/DoctrineBundle/issues/673
  180. *
  181. * @throws DBALException
  182. */
  183. private function getDatabasePlatform(Connection $connection): AbstractPlatform
  184. {
  185. try {
  186. return $connection->getDatabasePlatform();
  187. } catch (DriverException $driverException) {
  188. $class = class_exists(DBALException::class) ? DBALException::class : ConnectionException::class;
  190. /* @phpstan-ignore new.interface */
  191. throw new $class(
  192. 'An exception occurred while establishing a connection to figure out your platform version.' . PHP_EOL .
  193. "You can circumvent this by setting a 'server_version' configuration value" . PHP_EOL . PHP_EOL .
  194. 'For further information have a look at:' . PHP_EOL .
  195. 'https://github.com/doctrine/DoctrineBundle/issues/673',
  196. 0,
  197. $driverException,
  198. );
  199. }
  200. }
  202. /**
  203. * initialize the types
  204. */
  205. private function initializeTypes(): void
  206. {
  207. foreach ($this->typesConfig as $typeName => $typeConfig) {
  208. if (Type::hasType($typeName)) {
  209. Type::overrideType($typeName, $typeConfig['class']);
  210. } else {
  211. Type::addType($typeName, $typeConfig['class']);
  212. }
  213. }
  215. $this->initialized = true;
  216. }
  218. /**
  219. * @param array<string, mixed> $params
  220. *
  221. * @return array<string, mixed>
  222. */
  223. private function addDatabaseSuffix(array $params): array
  224. {
  225. if (isset($params['dbname']) && isset($params['dbname_suffix'])) {
  226. $params['dbname'] .= $params['dbname_suffix'];
  227. }
  229. foreach ($params['replica'] ?? [] as $key => $replicaParams) {
  230. if (! isset($replicaParams['dbname'], $replicaParams['dbname_suffix'])) {
  231. continue;
  232. }
  234. $params['replica'][$key]['dbname'] .= $replicaParams['dbname_suffix'];
  235. }
  237. if (isset($params['primary']['dbname'], $params['primary']['dbname_suffix'])) {
  238. $params['primary']['dbname'] .= $params['primary']['dbname_suffix'];
  239. }
  241. return $params;
  242. }
  244. /**
  245. * Extracts parts from a database URL, if present, and returns an
  246. * updated list of parameters.
  247. *
  248. * @param mixed[] $params The list of parameters.
  249. * @phpstan-param Params $params
  250. *
  251. * @return mixed[] A modified list of parameters with info from a database
  252. * URL extracted into individual parameter parts.
  253. * @phpstan-return Params
  254. *
  255. * @throws DBALException
  256. */
  257. private function parseDatabaseUrl(array $params): array
  258. {
  259. /** @psalm-suppress InvalidArrayOffset Need to be compatible with DBAL < 4, which still has `$params['url']` */
  260. if (! isset($params['url'])) {
  261. return $params;
  262. }
  264. try {
  265. $parsedParams = $this->dsnParser->parse($params['url']);
  266. } catch (MalformedDsnException $e) {
  267. throw new MalformedDsnException('Malformed parameter "url".', 0, $e);
  268. }
  270. if (isset($parsedParams['driver'])) {
  271. // The requested driver from the URL scheme takes precedence
  272. // over the default custom driver from the connection parameters (if any).
  273. unset($params['driverClass']);
  274. }
  276. $params = array_merge($params, $parsedParams);
  278. // If a schemeless connection URL is given, we require a default driver or default custom driver
  279. // as connection parameter.
  280. if (! isset($params['driverClass']) && ! isset($params['driver'])) {
  281. if (class_exists(DriverRequired::class)) {
  282. throw DriverRequired::new($params['url']);
  283. }
  285. throw DBALException::driverRequired($params['url']);
  286. }
  288. unset($params['url']);
  290. return $params;
  291. }
  292. }