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 Swift_Transport_StreamBuffer 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 Swift_Transport_StreamBuffer, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class Swift_Transport_StreamBuffer extends Swift_ByteStream_AbstractFilterableInputStream implements Swift_Transport_IoBuffer |
||
|
|
|||
| 17 | { |
||
| 18 | /** |
||
| 19 | * A primary socket |
||
| 20 | * |
||
| 21 | * @var resource |
||
| 22 | */ |
||
| 23 | private $_stream; |
||
| 24 | |||
| 25 | /** |
||
| 26 | * The input stream |
||
| 27 | */ |
||
| 28 | private $_in; |
||
| 29 | |||
| 30 | /** |
||
| 31 | * The output stream |
||
| 32 | */ |
||
| 33 | private $_out; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Buffer initialization parameters |
||
| 37 | */ |
||
| 38 | private $_params = array(); |
||
| 39 | |||
| 40 | /** |
||
| 41 | * The ReplacementFilterFactory |
||
| 42 | * |
||
| 43 | * @var Swift_ReplacementFilterFactory |
||
| 44 | */ |
||
| 45 | private $_replacementFactory; |
||
| 46 | |||
| 47 | /** |
||
| 48 | * Translations performed on data being streamed into the buffer |
||
| 49 | * |
||
| 50 | * @var array |
||
| 51 | */ |
||
| 52 | private $_translations = array(); |
||
| 53 | |||
| 54 | /** |
||
| 55 | * Create a new StreamBuffer using $replacementFactory for transformations. |
||
| 56 | * |
||
| 57 | * @param Swift_ReplacementFilterFactory $replacementFactory |
||
| 58 | */ |
||
| 59 | 8 | public function __construct(Swift_ReplacementFilterFactory $replacementFactory) |
|
| 63 | |||
| 64 | /** |
||
| 65 | * Perform any initialization needed, using the given $params. |
||
| 66 | * |
||
| 67 | * Parameters will vary depending upon the type of IoBuffer used. |
||
| 68 | * |
||
| 69 | * @param array $params |
||
| 70 | */ |
||
| 71 | 5 | public function initialize(array $params) |
|
| 84 | |||
| 85 | /** |
||
| 86 | * Set an individual param on the buffer (e.g. switching to SSL). |
||
| 87 | * |
||
| 88 | * @param string $param |
||
| 89 | * @param integer $value |
||
| 90 | */ |
||
| 91 | public function setParam($param, $value) |
||
| 110 | |||
| 111 | public function startTLS() |
||
| 115 | |||
| 116 | /** |
||
| 117 | * Perform any shutdown logic needed. |
||
| 118 | */ |
||
| 119 | 4 | public function terminate() |
|
| 138 | |||
| 139 | /** |
||
| 140 | * Set an array of string replacements which should be made on data written |
||
| 141 | * to the buffer. |
||
| 142 | * |
||
| 143 | * This could replace LF with CRLF for example. |
||
| 144 | * |
||
| 145 | * @param string[] $replacements |
||
| 146 | */ |
||
| 147 | 6 | public function setWriteTranslations(array $replacements) |
|
| 148 | { |
||
| 149 | 6 | foreach ($this->_translations as $search => $replace) { |
|
| 150 | 5 | if (!isset($replacements[$search])) { |
|
| 151 | 4 | $this->removeFilter($search); |
|
| 152 | 4 | unset($this->_translations[$search]); |
|
| 153 | 4 | } |
|
| 154 | 6 | } |
|
| 155 | |||
| 156 | 6 | foreach ($replacements as $search => $replace) { |
|
| 157 | 6 | if (!isset($this->_translations[$search])) { |
|
| 158 | 6 | $this->addFilter( |
|
| 159 | 6 | $this->_replacementFactory->createFilter($search, $replace), |
|
| 160 | $search |
||
| 161 | 6 | ); |
|
| 162 | 6 | $this->_translations[$search] = true; |
|
| 163 | 6 | } |
|
| 164 | 6 | } |
|
| 165 | 6 | } |
|
| 166 | |||
| 167 | /** |
||
| 168 | * Get a line of output (including any CRLF). |
||
| 169 | * |
||
| 170 | * The $sequence number comes from any writes and may or may not be used |
||
| 171 | * depending upon the implementation. |
||
| 172 | * |
||
| 173 | * @param int $sequence of last write to scan from |
||
| 174 | * |
||
| 175 | * @throws Swift_IoException |
||
| 176 | * |
||
| 177 | * @return string |
||
| 178 | */ |
||
| 179 | 5 | View Code Duplication | public function readLine($sequence) |
| 193 | |||
| 194 | /** |
||
| 195 | * Reads $length bytes from the stream into a string and moves the pointer |
||
| 196 | * through the stream by $length. |
||
| 197 | * |
||
| 198 | * If less bytes exist than are requested the remaining bytes are given instead. |
||
| 199 | * If no bytes are remaining at all, boolean false is returned. |
||
| 200 | * |
||
| 201 | * @param int $length |
||
| 202 | * |
||
| 203 | * @throws Swift_IoException |
||
| 204 | * |
||
| 205 | * @return string|null |
||
| 206 | */ |
||
| 207 | View Code Duplication | public function read($length) |
|
| 208 | { |
||
| 209 | if (isset($this->_out) && !feof($this->_out)) { |
||
| 210 | $ret = fread($this->_out, $length); |
||
| 211 | if (!$ret) { |
||
| 212 | $metas = stream_get_meta_data($this->_out); |
||
| 213 | if ($metas['timed_out']) { |
||
| 214 | throw new Swift_IoException( |
||
| 215 | 'Connection to ' . $this->_getReadConnectionDescription() . ' Timed Out' |
||
| 216 | ); |
||
| 217 | } |
||
| 218 | } |
||
| 219 | |||
| 220 | return $ret; |
||
| 221 | } |
||
| 222 | } |
||
| 223 | |||
| 224 | /** Not implemented */ |
||
| 225 | public function setReadPointer($byteOffset) |
||
| 228 | |||
| 229 | /** Flush the stream contents */ |
||
| 230 | 4 | protected function _flush() |
|
| 236 | |||
| 237 | /** |
||
| 238 | * Write this bytes to the stream |
||
| 239 | * |
||
| 240 | * @param string $bytes |
||
| 241 | * |
||
| 242 | * @return int |
||
| 243 | * |
||
| 244 | * @throws Swift_IoException |
||
| 245 | */ |
||
| 246 | 4 | protected function _commit($bytes) |
|
| 268 | |||
| 269 | /** |
||
| 270 | * Establishes a connection to a remote server. |
||
| 271 | * |
||
| 272 | * @throws Swift_TransportException |
||
| 273 | */ |
||
| 274 | 5 | private function _establishSocketConnection() |
|
| 320 | |||
| 321 | /** |
||
| 322 | * Opens a process for input/output. |
||
| 323 | */ |
||
| 324 | private function _establishProcessConnection() |
||
| 345 | |||
| 346 | 1 | private function _getReadConnectionDescription() |
|
| 365 | } |
||
| 366 |
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.