kakserpom /
phpdaemon
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 Connection 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 Connection, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 17 | abstract class Connection extends IOStream |
||
| 18 | { |
||
| 19 | /** |
||
| 20 | * @var string Path |
||
| 21 | */ |
||
| 22 | protected $path; |
||
| 23 | |||
| 24 | /** |
||
| 25 | * @var string Hostname |
||
| 26 | */ |
||
| 27 | protected $host; |
||
| 28 | |||
| 29 | /** |
||
| 30 | * @var string Real host |
||
| 31 | */ |
||
| 32 | protected $hostReal; |
||
| 33 | |||
| 34 | /** |
||
| 35 | * @var integer Port number |
||
| 36 | */ |
||
| 37 | protected $port; |
||
| 38 | |||
| 39 | /** |
||
| 40 | * @var string User name |
||
| 41 | */ |
||
| 42 | protected $user; |
||
| 43 | |||
| 44 | /** |
||
| 45 | * @var string Password |
||
| 46 | */ |
||
| 47 | protected $password; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * @var string Address |
||
| 51 | */ |
||
| 52 | protected $addr; |
||
| 53 | |||
| 54 | /** |
||
| 55 | * @var object Stack of callbacks called when connection is established |
||
| 56 | */ |
||
| 57 | protected $onConnected = null; |
||
| 58 | |||
| 59 | /** |
||
| 60 | * @var boolean Connected? |
||
| 61 | */ |
||
| 62 | protected $connected = false; |
||
| 63 | |||
| 64 | /** |
||
| 65 | * @var boolean Failed? |
||
| 66 | */ |
||
| 67 | protected $failed = false; |
||
| 68 | |||
| 69 | /** |
||
| 70 | * @var integer Timeout |
||
| 71 | */ |
||
| 72 | protected $timeout = 120; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * @var string Local address |
||
| 76 | */ |
||
| 77 | protected $locAddr; |
||
| 78 | |||
| 79 | /** |
||
| 80 | * @var integer Local port |
||
| 81 | */ |
||
| 82 | protected $locPort; |
||
| 83 | |||
| 84 | /** |
||
| 85 | * @var boolean Keepalive? |
||
| 86 | */ |
||
| 87 | protected $keepalive = false; |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @var string Type |
||
| 91 | */ |
||
| 92 | protected $type; |
||
| 93 | |||
| 94 | /** |
||
| 95 | * @var Generic Parent socket |
||
| 96 | */ |
||
| 97 | protected $parentSocket; |
||
| 98 | |||
| 99 | /** |
||
| 100 | * @var boolean Dgram connection? |
||
| 101 | */ |
||
| 102 | protected $dgram = false; |
||
| 103 | |||
| 104 | /** |
||
| 105 | * @var boolean Enable bevConnect? |
||
| 106 | */ |
||
| 107 | protected $bevConnectEnabled = true; |
||
| 108 | |||
| 109 | /** |
||
| 110 | * @var array URI information |
||
| 111 | */ |
||
| 112 | protected $uri; |
||
| 113 | |||
| 114 | /** |
||
| 115 | * @var string Scheme |
||
| 116 | */ |
||
| 117 | protected $scheme; |
||
| 118 | |||
| 119 | /** |
||
| 120 | * @var string Private key file |
||
| 121 | */ |
||
| 122 | protected $pkfile; |
||
| 123 | |||
| 124 | /** |
||
| 125 | * @var string Certificate file |
||
| 126 | */ |
||
| 127 | protected $certfile; |
||
| 128 | |||
| 129 | /** |
||
| 130 | * @var string Passphrase |
||
| 131 | */ |
||
| 132 | protected $passphrase; |
||
| 133 | |||
| 134 | /** |
||
| 135 | * @var boolean Verify peer? |
||
| 136 | */ |
||
| 137 | protected $verifypeer = false; |
||
| 138 | |||
| 139 | /** |
||
| 140 | * @var boolean Allow self-signed? |
||
| 141 | */ |
||
| 142 | protected $allowselfsigned = true; |
||
| 143 | |||
| 144 | /** |
||
| 145 | * @var CappedStorage Context cache |
||
| 146 | */ |
||
| 147 | protected static $contextCache; |
||
| 148 | |||
| 149 | /** |
||
| 150 | * @var number Context cache size |
||
| 151 | */ |
||
| 152 | protected static $contextCacheSize = 64; |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Connected? |
||
| 156 | * @return boolean |
||
| 157 | */ |
||
| 158 | public function isConnected() |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Sets DGRAM mode |
||
| 165 | * @param boolean $bool DGRAM Mode |
||
| 166 | * @return void |
||
| 167 | */ |
||
| 168 | public function setDgram($bool) |
||
| 172 | |||
| 173 | /** |
||
| 174 | * Sets peer name |
||
| 175 | * @param string $host Hostname |
||
| 176 | * @param integer $port Port |
||
| 177 | * @return void |
||
| 178 | */ |
||
| 179 | public function setPeername($host, $port) |
||
| 192 | |||
| 193 | /** |
||
| 194 | * Getter |
||
| 195 | * @param string $name Name |
||
| 196 | * @return mixed |
||
| 197 | */ |
||
| 198 | public function __get($name) |
||
| 209 | |||
| 210 | /** |
||
| 211 | * Get socket name |
||
| 212 | * @param string &$addr Addr |
||
| 213 | * @param srting &$port Port |
||
| 214 | * @return void |
||
| 215 | */ |
||
| 216 | public function getSocketName(&$addr, &$port) |
||
| 224 | |||
| 225 | /** |
||
| 226 | * Sets parent socket |
||
| 227 | * @param \PHPDaemon\BoundSocket\Generic $sock |
||
| 228 | * @return void |
||
| 229 | */ |
||
| 230 | public function setParentSocket(Generic $sock) |
||
| 234 | |||
| 235 | /** |
||
| 236 | * Called when new UDP packet received |
||
| 237 | * @param object $pct Packet |
||
| 238 | * @return void |
||
| 239 | */ |
||
| 240 | public function onUdpPacket($pct) |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Called when the connection is handshaked (at low-level), and peer is ready to recv. data |
||
| 246 | * @return void |
||
| 247 | */ |
||
| 248 | public function onReady() |
||
| 256 | |||
| 257 | /** |
||
| 258 | * Called if we inherit connection from request |
||
| 259 | * @param Request $req Parent Request |
||
| 260 | * @return void |
||
| 261 | */ |
||
| 262 | public function onInheritanceFromRequest($req) |
||
| 265 | |||
| 266 | /** |
||
| 267 | * Called when the connection failed to be established |
||
| 268 | * @return void |
||
| 269 | */ |
||
| 270 | public function onFailure() |
||
| 277 | |||
| 278 | /** |
||
| 279 | * Called when the connection failed |
||
| 280 | * @param EventBufferEvent $bev |
||
|
|
|||
| 281 | * @return void |
||
| 282 | */ |
||
| 283 | public function onFailureEv($bev = null) |
||
| 295 | |||
| 296 | /** |
||
| 297 | * Destructor |
||
| 298 | * @return void |
||
| 299 | */ |
||
| 300 | public function __destruct() |
||
| 306 | |||
| 307 | /** |
||
| 308 | * Send data to the connection. Note that it just writes to buffer that flushes at every baseloop |
||
| 309 | * @param string $data Data to send |
||
| 310 | * @return boolean Success |
||
| 311 | */ |
||
| 312 | public function write($data) |
||
| 319 | |||
| 320 | /** |
||
| 321 | * Executes the given callback when/if the connection is handshaked |
||
| 322 | * @param callable $cb Callback |
||
| 323 | * @return void |
||
| 324 | */ |
||
| 325 | public function onConnected($cb) |
||
| 336 | |||
| 337 | protected function importParams() |
||
| 371 | |||
| 372 | /** |
||
| 373 | * Initialize SSL context |
||
| 374 | * @return object|false Context |
||
| 375 | */ |
||
| 376 | protected function initSSLContext() |
||
| 405 | |||
| 406 | /** |
||
| 407 | * Get URL |
||
| 408 | * @return string |
||
| 409 | */ |
||
| 410 | public function getUrl() |
||
| 414 | |||
| 415 | /** |
||
| 416 | * Get host |
||
| 417 | * @return string |
||
| 418 | */ |
||
| 419 | public function getHost() |
||
| 423 | |||
| 424 | /** |
||
| 425 | * Get port |
||
| 426 | * @return integer |
||
| 427 | */ |
||
| 428 | public function getPort() |
||
| 432 | |||
| 433 | /** |
||
| 434 | * Connects to URL |
||
| 435 | * @param string $url URL |
||
| 436 | * @param callable $cb Callback |
||
| 437 | * @return boolean Success |
||
| 438 | */ |
||
| 439 | public function connect($url, $cb = null) |
||
| 498 | |||
| 499 | /** |
||
| 500 | * Establish UNIX socket connection |
||
| 501 | * @param string $path Path |
||
| 502 | * @return boolean Success |
||
| 503 | */ |
||
| 504 | public function connectUnix($path) |
||
| 523 | |||
| 524 | /** |
||
| 525 | * Establish raw socket connection |
||
| 526 | * @param string $host Hostname |
||
| 527 | * @return boolean Success |
||
| 528 | */ |
||
| 529 | public function connectRaw($host) |
||
| 568 | |||
| 569 | /** |
||
| 570 | * Establish UDP connection |
||
| 571 | * @param string $host Hostname |
||
| 572 | * @param integer $port Port |
||
| 573 | * @return boolean Success |
||
| 574 | */ |
||
| 575 | public function connectUdp($host, $port) |
||
| 625 | |||
| 626 | /** |
||
| 627 | * Establish TCP connection |
||
| 628 | * @param string $host Hostname |
||
| 629 | * @param integer $port Port |
||
| 630 | * @return boolean Success |
||
| 631 | */ |
||
| 632 | public function connectTcp($host, $port) |
||
| 701 | |||
| 702 | /** |
||
| 703 | * Set keepalive |
||
| 704 | * @param boolean $bool |
||
| 705 | * @return void |
||
| 706 | */ |
||
| 707 | public function setKeepalive($bool) |
||
| 712 | |||
| 713 | /** |
||
| 714 | * Close the connection |
||
| 715 | * @return void |
||
| 716 | */ |
||
| 717 | public function close() |
||
| 724 | |||
| 725 | /** |
||
| 726 | * Set timeouts |
||
| 727 | * @param integer $read Read timeout in seconds |
||
| 728 | * @param integer $write Write timeout in seconds |
||
| 729 | * @return void |
||
| 730 | */ |
||
| 731 | public function setTimeouts($read, $write) |
||
| 747 | |||
| 748 | /** |
||
| 749 | * Set socket option |
||
| 750 | * @param integer $level Level |
||
| 751 | * @param integer $optname Option |
||
| 752 | * @param mixed $val Value |
||
| 753 | * @return void |
||
| 754 | */ |
||
| 755 | public function setOption($level, $optname, $val) |
||
| 763 | |||
| 764 | /** |
||
| 765 | * Called when connection finishes |
||
| 766 | * @return void |
||
| 767 | */ |
||
| 768 | public function onFinish() |
||
| 778 | } |
||
| 779 |
Loading history...
This check looks for
@paramannotations where the type inferred by our type inference engine differs from the declared type.It makes a suggestion as to what type it considers more descriptive.
Most often this is a case of a parameter that can be null in addition to its declared types.