doctrine /
dbal
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
Complex classes like AbstractMySQLDriver often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use AbstractMySQLDriver, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 39 | abstract class AbstractMySQLDriver implements Driver, ExceptionConverterDriver, VersionAwarePlatformDriver |
||
| 40 | { |
||
| 41 | /** |
||
| 42 | * {@inheritdoc} |
||
| 43 | * |
||
| 44 | * @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-client.html |
||
| 45 | * @link http://dev.mysql.com/doc/refman/5.7/en/error-messages-server.html |
||
| 46 | */ |
||
| 47 | 4 | public function convertException($message, DriverException $exception) |
|
| 48 | { |
||
| 49 | 4 | switch ($exception->getErrorCode()) { |
|
| 50 | 4 | case '1213': |
|
| 51 | 4 | return new Exception\DeadlockException($message, $exception); |
|
| 52 | 4 | case '1205': |
|
| 53 | 4 | return new Exception\LockWaitTimeoutException($message, $exception); |
|
| 54 | 4 | case '1050': |
|
| 55 | 4 | return new Exception\TableExistsException($message, $exception); |
|
| 56 | |||
| 57 | 4 | case '1051': |
|
| 58 | 4 | case '1146': |
|
| 59 | 4 | return new Exception\TableNotFoundException($message, $exception); |
|
| 60 | |||
| 61 | 4 | case '1216': |
|
| 62 | 4 | case '1217': |
|
| 63 | 4 | case '1451': |
|
| 64 | 4 | case '1452': |
|
| 65 | 4 | case '1701': |
|
| 66 | 4 | return new Exception\ForeignKeyConstraintViolationException($message, $exception); |
|
| 67 | |||
| 68 | 4 | case '1062': |
|
| 69 | 4 | case '1557': |
|
| 70 | 4 | case '1569': |
|
| 71 | 4 | case '1586': |
|
| 72 | 4 | return new Exception\UniqueConstraintViolationException($message, $exception); |
|
| 73 | |||
| 74 | 4 | case '1054': |
|
| 75 | 4 | case '1166': |
|
| 76 | 4 | case '1611': |
|
| 77 | 4 | return new Exception\InvalidFieldNameException($message, $exception); |
|
| 78 | |||
| 79 | 4 | case '1052': |
|
| 80 | 4 | case '1060': |
|
| 81 | 4 | case '1110': |
|
| 82 | 4 | return new Exception\NonUniqueFieldNameException($message, $exception); |
|
| 83 | |||
| 84 | 4 | case '1064': |
|
| 85 | 4 | case '1149': |
|
| 86 | 4 | case '1287': |
|
| 87 | 4 | case '1341': |
|
| 88 | 4 | case '1342': |
|
| 89 | 4 | case '1343': |
|
| 90 | 4 | case '1344': |
|
| 91 | 4 | case '1382': |
|
| 92 | 4 | case '1479': |
|
| 93 | 4 | case '1541': |
|
| 94 | 4 | case '1554': |
|
| 95 | 4 | case '1626': |
|
| 96 | 4 | return new Exception\SyntaxErrorException($message, $exception); |
|
| 97 | |||
| 98 | 4 | case '1044': |
|
| 99 | 4 | case '1045': |
|
| 100 | 4 | case '1046': |
|
| 101 | 4 | case '1049': |
|
| 102 | 4 | case '1095': |
|
| 103 | 4 | case '1142': |
|
| 104 | 4 | case '1143': |
|
| 105 | 4 | case '1227': |
|
| 106 | 4 | case '1370': |
|
| 107 | 4 | case '1429': |
|
| 108 | 4 | case '2002': |
|
| 109 | 4 | case '2005': |
|
| 110 | 4 | return new Exception\ConnectionException($message, $exception); |
|
| 111 | |||
| 112 | 4 | case '1048': |
|
| 113 | 4 | case '1121': |
|
| 114 | 4 | case '1138': |
|
| 115 | 4 | case '1171': |
|
| 116 | 4 | case '1252': |
|
| 117 | 4 | case '1263': |
|
| 118 | 4 | case '1364': |
|
| 119 | 4 | case '1566': |
|
| 120 | 4 | return new Exception\NotNullConstraintViolationException($message, $exception); |
|
| 121 | } |
||
| 122 | |||
| 123 | 4 | return new Exception\DriverException($message, $exception); |
|
| 124 | } |
||
| 125 | |||
| 126 | /** |
||
| 127 | * {@inheritdoc} |
||
| 128 | * |
||
| 129 | * @return AbstractPlatform|MariaDb1027Platform|MySQL57Platform|MySqlPlatform |
||
| 130 | * @throws DBALException |
||
| 131 | */ |
||
| 132 | 6 | public function createDatabasePlatformForVersion($version): AbstractPlatform |
|
| 133 | { |
||
| 134 | 6 | if (false !== stripos($version, 'mariadb')) { |
|
| 135 | 3 | $versionNumber = $this->getMariaDbMysqlVersionNumber($version); |
|
| 136 | 3 | if (version_compare($versionNumber, '10.2.7', '>=')) { |
|
| 137 | 3 | return new MariaDb1027Platform(); |
|
| 138 | } |
||
| 139 | } else { |
||
| 140 | 6 | $versionNumber = $this->getOracleMysqlVersionNumber($version); |
|
| 141 | 3 | if (version_compare($versionNumber, '5.7.9', '>=')) { |
|
| 142 | 3 | return new MySQL57Platform(); |
|
| 143 | } |
||
| 144 | } |
||
| 145 | |||
| 146 | 3 | return $this->getDatabasePlatform(); |
|
| 147 | } |
||
| 148 | |||
| 149 | /** |
||
| 150 | * Get a normalized 'version number' from the server string |
||
| 151 | * returned by Oracle MySQL servers. |
||
| 152 | * |
||
| 153 | * @param string $versionString Version string returned by the driver, i.e. '5.7.10' |
||
| 154 | * @throws DBALException |
||
| 155 | */ |
||
| 156 | 6 | private function getOracleMysqlVersionNumber(string $versionString): string |
|
| 157 | { |
||
| 158 | 6 | if (!preg_match('/^(?P<major>\d+)(?:\.(?P<minor>\d+)(?:\.(?P<patch>\d+))?)?/', $versionString, $versionParts)) { |
|
| 159 | 3 | throw DBALException::invalidPlatformVersionSpecified( |
|
| 160 | 3 | $versionString, |
|
| 161 | 3 | '<major_version>.<minor_version>.<patch_version>' |
|
| 162 | ); |
||
| 163 | } |
||
| 164 | 3 | $majorVersion = $versionParts['major']; |
|
| 165 | 3 | $minorVersion = $versionParts['minor'] ?? 0; |
|
| 166 | 3 | $patchVersion = $versionParts['patch'] ?? null; |
|
| 167 | |||
| 168 | 3 | if ('5' === $majorVersion && '7' === $minorVersion && null === $patchVersion) { |
|
| 169 | 3 | $patchVersion = '9'; |
|
| 170 | } |
||
| 171 | |||
| 172 | 3 | return $majorVersion . '.' . $minorVersion . '.' . $patchVersion; |
|
| 173 | } |
||
| 174 | |||
| 175 | /** |
||
| 176 | * Detect MariaDB server version, including hack for some mariadb distributions |
||
| 177 | * that starts with the prefix '5.5.5-' |
||
| 178 | * |
||
| 179 | * @param string $versionString Version string as returned by mariadb server, i.e. '5.5.5-Mariadb-10.0.8-xenial' |
||
| 180 | * @throws DBALException |
||
| 181 | */ |
||
| 182 | 3 | private function getMariaDbMysqlVersionNumber(string $versionString): string |
|
| 183 | { |
||
| 184 | 3 | $version = str_replace('5.5.5-', '', $versionString); |
|
| 185 | |||
| 186 | 3 | if (!preg_match('/^(mariadb-)?(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)/', strtolower($version), $versionParts)) { |
|
| 187 | throw DBALException::invalidPlatformVersionSpecified( |
||
| 188 | $version, |
||
| 189 | '(mariadb-)?<major_version>.<minor_version>.<patch_version>' |
||
| 190 | ); |
||
| 191 | } |
||
| 192 | |||
| 193 | 3 | return $versionParts['major'] . '.' . $versionParts['minor'] . '.' . $versionParts['patch']; |
|
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * {@inheritdoc} |
||
| 198 | */ |
||
| 199 | 4 | View Code Duplication | public function getDatabase(\Doctrine\DBAL\Connection $conn) |
| 209 | |||
| 210 | /** |
||
| 211 | * {@inheritdoc} |
||
| 212 | */ |
||
| 213 | 6 | public function getDatabasePlatform() |
|
| 217 | |||
| 218 | /** |
||
| 219 | * {@inheritdoc} |
||
| 220 | */ |
||
| 221 | 3 | public function getSchemaManager(\Doctrine\DBAL\Connection $conn) |
|
| 225 | } |
||
| 226 |
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.