Complex classes like DBConnRef 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 DBConnRef, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 10 | class DBConnRef implements IDatabase { |
||
| 11 | /** @var ILoadBalancer */ |
||
| 12 | private $lb; |
||
| 13 | |||
| 14 | /** @var IDatabase|null Live connection handle */ |
||
| 15 | private $conn; |
||
| 16 | |||
| 17 | /** @var array|null N-tuple of (server index, group, DatabaseDomain|string) */ |
||
| 18 | private $params; |
||
| 19 | |||
| 20 | const FLD_INDEX = 0; |
||
| 21 | const FLD_GROUP = 1; |
||
| 22 | const FLD_DOMAIN = 2; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @param ILoadBalancer $lb |
||
| 26 | * @param IDatabase|array $conn Connection or (server index, group, DatabaseDomain|string) |
||
| 27 | */ |
||
| 28 | public function __construct( ILoadBalancer $lb, $conn ) { |
||
| 38 | |||
| 39 | function __call( $name, array $arguments ) { |
||
| 47 | |||
| 48 | public function getServerInfo() { |
||
| 51 | |||
| 52 | public function bufferResults( $buffer = null ) { |
||
| 55 | |||
| 56 | public function trxLevel() { |
||
| 59 | |||
| 60 | public function trxTimestamp() { |
||
| 63 | |||
| 64 | public function explicitTrxActive() { |
||
| 67 | |||
| 68 | public function tablePrefix( $prefix = null ) { |
||
| 71 | |||
| 72 | public function dbSchema( $schema = null ) { |
||
| 75 | |||
| 76 | public function getLBInfo( $name = null ) { |
||
| 79 | |||
| 80 | public function setLBInfo( $name, $value = null ) { |
||
| 83 | |||
| 84 | public function setLazyMasterHandle( IDatabase $conn ) { |
||
| 87 | |||
| 88 | public function implicitGroupby() { |
||
| 91 | |||
| 92 | public function implicitOrderby() { |
||
| 95 | |||
| 96 | public function lastQuery() { |
||
| 99 | |||
| 100 | public function doneWrites() { |
||
| 103 | |||
| 104 | public function lastDoneWrites() { |
||
| 107 | |||
| 108 | public function writesPending() { |
||
| 111 | |||
| 112 | public function writesOrCallbacksPending() { |
||
| 115 | |||
| 116 | public function pendingWriteQueryDuration( $type = self::ESTIMATE_TOTAL ) { |
||
| 119 | |||
| 120 | public function pendingWriteCallers() { |
||
| 123 | |||
| 124 | public function isOpen() { |
||
| 127 | |||
| 128 | public function setFlag( $flag, $remember = self::REMEMBER_NOTHING ) { |
||
| 131 | |||
| 132 | public function clearFlag( $flag, $remember = self::REMEMBER_NOTHING ) { |
||
| 135 | |||
| 136 | public function restoreFlags( $state = self::RESTORE_PRIOR ) { |
||
| 139 | |||
| 140 | public function getFlag( $flag ) { |
||
| 143 | |||
| 144 | public function getProperty( $name ) { |
||
| 147 | |||
| 148 | public function getDomainID() { |
||
| 157 | |||
| 158 | public function getWikiID() { |
||
| 161 | |||
| 162 | public function getType() { |
||
| 165 | |||
| 166 | public function open( $server, $user, $password, $dbName ) { |
||
| 169 | |||
| 170 | public function fetchObject( $res ) { |
||
| 173 | |||
| 174 | public function fetchRow( $res ) { |
||
| 177 | |||
| 178 | public function numRows( $res ) { |
||
| 181 | |||
| 182 | public function numFields( $res ) { |
||
| 185 | |||
| 186 | public function fieldName( $res, $n ) { |
||
| 189 | |||
| 190 | public function insertId() { |
||
| 193 | |||
| 194 | public function dataSeek( $res, $row ) { |
||
| 197 | |||
| 198 | public function lastErrno() { |
||
| 201 | |||
| 202 | public function lastError() { |
||
| 205 | |||
| 206 | public function fieldInfo( $table, $field ) { |
||
| 209 | |||
| 210 | public function affectedRows() { |
||
| 213 | |||
| 214 | public function getSoftwareLink() { |
||
| 217 | |||
| 218 | public function getServerVersion() { |
||
| 221 | |||
| 222 | public function close() { |
||
| 225 | |||
| 226 | public function reportConnectionError( $error = 'Unknown error' ) { |
||
| 229 | |||
| 230 | public function query( $sql, $fname = __METHOD__, $tempIgnore = false ) { |
||
| 233 | |||
| 234 | public function reportQueryError( $error, $errno, $sql, $fname, $tempIgnore = false ) { |
||
| 237 | |||
| 238 | public function freeResult( $res ) { |
||
| 241 | |||
| 242 | public function selectField( |
||
| 247 | |||
| 248 | public function selectFieldValues( |
||
| 253 | |||
| 254 | public function select( |
||
| 260 | |||
| 261 | public function selectSQLText( |
||
| 267 | |||
| 268 | public function selectRow( |
||
| 274 | |||
| 275 | public function estimateRowCount( |
||
| 280 | |||
| 281 | public function selectRowCount( |
||
| 286 | |||
| 287 | public function fieldExists( $table, $field, $fname = __METHOD__ ) { |
||
| 290 | |||
| 291 | public function indexExists( $table, $index, $fname = __METHOD__ ) { |
||
| 294 | |||
| 295 | public function tableExists( $table, $fname = __METHOD__ ) { |
||
| 298 | |||
| 299 | public function indexUnique( $table, $index ) { |
||
| 302 | |||
| 303 | public function insert( $table, $a, $fname = __METHOD__, $options = [] ) { |
||
| 306 | |||
| 307 | public function update( $table, $values, $conds, $fname = __METHOD__, $options = [] ) { |
||
| 310 | |||
| 311 | public function makeList( $a, $mode = self::LIST_COMMA ) { |
||
| 314 | |||
| 315 | public function makeWhereFrom2d( $data, $baseKey, $subKey ) { |
||
| 318 | |||
| 319 | public function aggregateValue( $valuedata, $valuename = 'value' ) { |
||
| 322 | |||
| 323 | public function bitNot( $field ) { |
||
| 326 | |||
| 327 | public function bitAnd( $fieldLeft, $fieldRight ) { |
||
| 330 | |||
| 331 | public function bitOr( $fieldLeft, $fieldRight ) { |
||
| 334 | |||
| 335 | public function buildConcat( $stringList ) { |
||
| 338 | |||
| 339 | public function buildGroupConcatField( |
||
| 344 | |||
| 345 | public function buildStringCast( $field ) { |
||
| 348 | |||
| 349 | public function selectDB( $db ) { |
||
| 352 | |||
| 353 | public function getDBname() { |
||
| 356 | |||
| 357 | public function getServer() { |
||
| 360 | |||
| 361 | public function addQuotes( $s ) { |
||
| 364 | |||
| 365 | public function buildLike() { |
||
| 368 | |||
| 369 | public function anyChar() { |
||
| 372 | |||
| 373 | public function anyString() { |
||
| 376 | |||
| 377 | public function nextSequenceValue( $seqName ) { |
||
| 380 | |||
| 381 | public function replace( $table, $uniqueIndexes, $rows, $fname = __METHOD__ ) { |
||
| 384 | |||
| 385 | public function upsert( |
||
| 390 | |||
| 391 | public function deleteJoin( |
||
| 396 | |||
| 397 | public function delete( $table, $conds, $fname = __METHOD__ ) { |
||
| 400 | |||
| 401 | public function insertSelect( |
||
| 407 | |||
| 408 | public function unionSupportsOrderAndLimit() { |
||
| 411 | |||
| 412 | public function unionQueries( $sqls, $all ) { |
||
| 415 | |||
| 416 | public function conditional( $cond, $trueVal, $falseVal ) { |
||
| 419 | |||
| 420 | public function strreplace( $orig, $old, $new ) { |
||
| 423 | |||
| 424 | public function getServerUptime() { |
||
| 427 | |||
| 428 | public function wasDeadlock() { |
||
| 431 | |||
| 432 | public function wasLockTimeout() { |
||
| 435 | |||
| 436 | public function wasErrorReissuable() { |
||
| 439 | |||
| 440 | public function wasReadOnlyError() { |
||
| 443 | |||
| 444 | public function masterPosWait( DBMasterPos $pos, $timeout ) { |
||
| 447 | |||
| 448 | public function getReplicaPos() { |
||
| 449 | return $this->__call( __FUNCTION__, func_get_args() ); |
||
| 450 | } |
||
| 451 | |||
| 452 | public function getMasterPos() { |
||
| 455 | |||
| 456 | public function serverIsReadOnly() { |
||
| 459 | |||
| 460 | public function onTransactionResolution( callable $callback, $fname = __METHOD__ ) { |
||
| 463 | |||
| 464 | public function onTransactionIdle( callable $callback, $fname = __METHOD__ ) { |
||
| 467 | |||
| 468 | public function onTransactionPreCommitOrIdle( callable $callback, $fname = __METHOD__ ) { |
||
| 471 | |||
| 472 | public function setTransactionListener( $name, callable $callback = null ) { |
||
| 475 | |||
| 476 | public function startAtomic( $fname = __METHOD__ ) { |
||
| 479 | |||
| 480 | public function endAtomic( $fname = __METHOD__ ) { |
||
| 483 | |||
| 484 | public function doAtomicSection( $fname, callable $callback ) { |
||
| 487 | |||
| 488 | public function begin( $fname = __METHOD__, $mode = IDatabase::TRANSACTION_EXPLICIT ) { |
||
| 491 | |||
| 492 | public function commit( $fname = __METHOD__, $flush = '' ) { |
||
| 495 | |||
| 496 | public function rollback( $fname = __METHOD__, $flush = '' ) { |
||
| 499 | |||
| 500 | public function flushSnapshot( $fname = __METHOD__ ) { |
||
| 503 | |||
| 504 | public function listTables( $prefix = null, $fname = __METHOD__ ) { |
||
| 507 | |||
| 508 | public function timestamp( $ts = 0 ) { |
||
| 511 | |||
| 512 | public function timestampOrNull( $ts = null ) { |
||
| 515 | |||
| 516 | public function ping( &$rtt = null ) { |
||
| 521 | |||
| 522 | public function getLag() { |
||
| 525 | |||
| 526 | public function getSessionLagStatus() { |
||
| 529 | |||
| 530 | public function maxListLen() { |
||
| 533 | |||
| 534 | public function encodeBlob( $b ) { |
||
| 537 | |||
| 538 | public function decodeBlob( $b ) { |
||
| 541 | |||
| 542 | public function setSessionOptions( array $options ) { |
||
| 545 | |||
| 546 | public function setSchemaVars( $vars ) { |
||
| 549 | |||
| 550 | public function lockIsFree( $lockName, $method ) { |
||
| 553 | |||
| 554 | public function lock( $lockName, $method, $timeout = 5 ) { |
||
| 557 | |||
| 558 | public function unlock( $lockName, $method ) { |
||
| 561 | |||
| 562 | public function getScopedLockAndFlush( $lockKey, $fname, $timeout ) { |
||
| 565 | |||
| 566 | public function namedLocksEnqueue() { |
||
| 569 | |||
| 570 | public function getInfinity() { |
||
| 573 | |||
| 574 | public function encodeExpiry( $expiry ) { |
||
| 577 | |||
| 578 | public function decodeExpiry( $expiry, $format = TS_MW ) { |
||
| 581 | |||
| 582 | public function setBigSelects( $value = true ) { |
||
| 585 | |||
| 586 | public function isReadOnly() { |
||
| 589 | |||
| 590 | public function setTableAliases( array $aliases ) { |
||
| 593 | |||
| 594 | /** |
||
| 595 | * Clean up the connection when out of scope |
||
| 596 | */ |
||
| 597 | function __destruct() { |
||
| 602 | } |
||
| 603 |