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 Service 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 Service, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 11 | class Service extends Singleton |
||
| 12 | { |
||
| 13 | /** |
||
| 14 | * @var String Url de destino de la llamada |
||
| 15 | */ |
||
| 16 | private $url; |
||
| 17 | /** |
||
| 18 | * @var array Parámetros de la llamada |
||
| 19 | */ |
||
| 20 | private $params; |
||
| 21 | /** |
||
| 22 | * @var array Opciones llamada |
||
| 23 | */ |
||
| 24 | private $options; |
||
| 25 | /** |
||
| 26 | * @var array Cabeceras de la llamada |
||
| 27 | */ |
||
| 28 | private $headers; |
||
| 29 | /** |
||
| 30 | * @var string type |
||
| 31 | */ |
||
| 32 | private $type; |
||
| 33 | /** |
||
| 34 | * @var resource $con |
||
| 35 | */ |
||
| 36 | private $con; |
||
| 37 | /** |
||
| 38 | * @var string $result |
||
| 39 | */ |
||
| 40 | private $result; |
||
| 41 | /** |
||
| 42 | * @var mixed |
||
| 43 | */ |
||
| 44 | private $info; |
||
| 45 | |||
| 46 | /** |
||
| 47 | * @Injectable |
||
| 48 | * @var \PSFS\base\Logger Log de las llamadas |
||
| 49 | */ |
||
| 50 | protected $log; |
||
| 51 | /** |
||
| 52 | * @Injectable |
||
| 53 | * @var \PSFS\base\Cache $cache |
||
| 54 | */ |
||
| 55 | protected $cache; |
||
| 56 | /** |
||
| 57 | * @var bool |
||
| 58 | */ |
||
| 59 | protected $isJson = true; |
||
| 60 | |||
| 61 | 1 | private function closeConnection() { |
|
| 62 | 1 | if(null !== $this->con) { |
|
| 63 | curl_close($this->con); |
||
| 64 | } |
||
| 65 | 1 | } |
|
| 66 | |||
| 67 | public function __destruct() |
||
| 68 | { |
||
| 69 | $this->closeConnection(); |
||
| 70 | } |
||
| 71 | |||
| 72 | /** |
||
| 73 | * @return String |
||
| 74 | */ |
||
| 75 | public function getUrl() |
||
| 76 | { |
||
| 77 | return $this->url; |
||
| 78 | } |
||
| 79 | |||
| 80 | /** |
||
| 81 | * @param String $url |
||
| 82 | */ |
||
| 83 | public function setUrl($url) |
||
| 84 | { |
||
| 85 | $this->url = $url; |
||
| 86 | $this->initialize(); |
||
| 87 | } |
||
| 88 | |||
| 89 | /** |
||
| 90 | * @return string |
||
| 91 | */ |
||
| 92 | public function getResult() |
||
| 93 | { |
||
| 94 | return $this->result; |
||
| 95 | } |
||
| 96 | |||
| 97 | /** |
||
| 98 | * @param string $result |
||
| 99 | */ |
||
| 100 | public function setResult($result) |
||
| 101 | { |
||
| 102 | $this->result = $result; |
||
| 103 | } |
||
| 104 | |||
| 105 | /** |
||
| 106 | * @return array |
||
| 107 | */ |
||
| 108 | public function getParams() |
||
| 109 | { |
||
| 110 | return $this->params; |
||
| 111 | } |
||
| 112 | |||
| 113 | /** |
||
| 114 | * Add request param |
||
| 115 | * |
||
| 116 | * @param $key |
||
| 117 | * @param null $value |
||
| 118 | * |
||
| 119 | * @return \PSFS\base\Service |
||
| 120 | */ |
||
| 121 | public function addParam($key, $value = NULL) |
||
| 122 | { |
||
| 123 | $this->params[$key] = $value; |
||
| 124 | |||
| 125 | return $this; |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * @return array |
||
| 130 | */ |
||
| 131 | public function getOptions() |
||
| 132 | { |
||
| 133 | return $this->options; |
||
| 134 | } |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Add request param |
||
| 138 | * |
||
| 139 | * @param $key |
||
| 140 | * @param null $value |
||
| 141 | * |
||
| 142 | * @return \PSFS\base\Service |
||
| 143 | */ |
||
| 144 | public function addOption($key, $value = NULL) |
||
| 145 | { |
||
| 146 | $this->options[$key] = $value; |
||
| 147 | |||
| 148 | return $this; |
||
| 149 | } |
||
| 150 | |||
| 151 | /** |
||
| 152 | * @param array $params |
||
| 153 | */ |
||
| 154 | public function setParams($params) |
||
| 155 | { |
||
| 156 | $this->params = $params; |
||
| 157 | } |
||
| 158 | |||
| 159 | /** |
||
| 160 | * @return array |
||
| 161 | */ |
||
| 162 | public function getHeaders() |
||
| 163 | { |
||
| 164 | return $this->headers; |
||
| 165 | } |
||
| 166 | |||
| 167 | /** |
||
| 168 | * @param array $headers |
||
| 169 | */ |
||
| 170 | public function setHeaders($headers) |
||
| 171 | { |
||
| 172 | $this->headers = $headers; |
||
| 173 | } |
||
| 174 | |||
| 175 | /** |
||
| 176 | * @param $header |
||
| 177 | * @param null $content |
||
| 178 | * |
||
| 179 | * @return $this |
||
| 180 | */ |
||
| 181 | public function addHeader($header, $content = NULL) |
||
| 182 | { |
||
| 183 | $this->headers[$header] = $content; |
||
| 184 | |||
| 185 | return $this; |
||
| 186 | } |
||
| 187 | |||
| 188 | /** |
||
| 189 | * @return string |
||
| 190 | */ |
||
| 191 | public function getType() |
||
| 192 | { |
||
| 193 | return $this->type; |
||
| 194 | } |
||
| 195 | |||
| 196 | /** |
||
| 197 | * @param string $type |
||
| 198 | */ |
||
| 199 | public function setType($type) |
||
| 200 | { |
||
| 201 | $this->type = $type; |
||
| 202 | } |
||
| 203 | |||
| 204 | /** |
||
| 205 | * @return Logger |
||
| 206 | */ |
||
| 207 | public function getLog() |
||
| 208 | { |
||
| 209 | return $this->log; |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * @param Logger $log |
||
| 214 | */ |
||
| 215 | 1 | public function setLog($log) |
|
| 216 | { |
||
| 217 | 1 | $this->log = $log; |
|
| 218 | 1 | } |
|
| 219 | |||
| 220 | /** |
||
| 221 | * @param bool $isJson |
||
| 222 | */ |
||
| 223 | public function setIsJson($isJson = true) { |
||
| 224 | $this->isJson = $isJson; |
||
| 225 | } |
||
| 226 | |||
| 227 | /** |
||
| 228 | * @return bool |
||
| 229 | */ |
||
| 230 | public function getIsJson() { |
||
| 231 | return $this->isJson; |
||
| 232 | } |
||
| 233 | |||
| 234 | /** |
||
| 235 | * Método que limpia el contexto de la llamada |
||
| 236 | */ |
||
| 237 | 1 | private function clearContext() |
|
| 238 | { |
||
| 239 | 1 | $this->url = NULL; |
|
| 240 | 1 | $this->params = array(); |
|
| 241 | 1 | $this->headers = array(); |
|
| 242 | 1 | Logger::log("Context service for " . get_called_class() . " cleared!"); |
|
| 243 | 1 | $this->closeConnection(); |
|
| 244 | 1 | } |
|
| 245 | |||
| 246 | /** |
||
| 247 | * |
||
| 248 | */ |
||
| 249 | 1 | public function init() |
|
| 250 | { |
||
| 251 | 1 | parent::init(); |
|
| 252 | 1 | $this->clearContext(); |
|
| 253 | 1 | } |
|
| 254 | |||
| 255 | /** |
||
| 256 | * Initialize CURL |
||
| 257 | */ |
||
| 258 | private function initialize() |
||
| 259 | { |
||
| 260 | $this->closeConnection(); |
||
| 261 | $this->con = curl_init($this->url); |
||
| 262 | } |
||
| 263 | |||
| 264 | /** |
||
| 265 | * Generate auth header |
||
| 266 | * @param string $secret |
||
| 267 | * @param string $module |
||
| 268 | */ |
||
| 269 | protected function addRequestToken($secret, $module = 'PSFS') |
||
| 270 | { |
||
| 271 | $this->addHeader('X-PSFS-SEC-TOKEN', SecurityHelper::generateToken($secret, $module)); |
||
| 272 | } |
||
| 273 | |||
| 274 | /** |
||
| 275 | * @param $user |
||
| 276 | * @param $pass |
||
| 277 | */ |
||
| 278 | protected function addAuthHeader($user, $pass) { |
||
| 279 | $this->addOption(CURLOPT_HTTPAUTH, CURLAUTH_BASIC); |
||
| 280 | $this->addOption(CURLOPT_USERPWD, "$user:$pass"); |
||
| 281 | } |
||
| 282 | |||
| 283 | protected function applyOptions() { |
||
| 284 | if(count($this->options)) { |
||
| 285 | curl_setopt_array($this->con, $this->options); |
||
| 286 | } |
||
| 287 | } |
||
| 288 | |||
| 289 | protected function applyHeaders() { |
||
| 290 | $headers = []; |
||
| 291 | foreach($this->headers as $key => $value) { |
||
| 292 | $headers[] = $key . ': ' . $value; |
||
| 293 | } |
||
| 294 | if(count($headers)) { |
||
| 295 | curl_setopt($this->con, CURLOPT_HTTPHEADER, $headers); |
||
| 296 | } |
||
| 297 | } |
||
| 298 | |||
| 299 | protected function setDefaults() |
||
| 300 | { |
||
| 301 | switch (strtoupper($this->type)) { |
||
| 302 | case 'GET': |
||
| 303 | default: |
||
| 304 | $this->addOption(CURLOPT_CUSTOMREQUEST, "GET"); |
||
| 305 | if(!empty($this->params)) { |
||
| 306 | $sep = false === preg_match('/\?/', $this->getUrl() ? '?' : ''; |
||
|
|
|||
| 307 | $this->setUrl($this->getUrl() . $sep . http_build_query($this->params)); |
||
| 308 | } |
||
| 309 | break; |
||
| 310 | case 'POST': |
||
| 311 | $this->addOption(CURLOPT_CUSTOMREQUEST, "POST"); |
||
| 312 | if($this->getIsJson()) { |
||
| 313 | $this->addOption(CURLOPT_POSTFIELDS, json_encode($this->params)); |
||
| 314 | } else { |
||
| 315 | $this->addOption(CURLOPT_POSTFIELDS, http_build_query($this->params)); |
||
| 316 | } |
||
| 317 | break; |
||
| 318 | case 'DELETE': |
||
| 319 | $this->addOption(CURLOPT_CUSTOMREQUEST, "DELETE"); |
||
| 320 | break; |
||
| 321 | case 'PUT': |
||
| 322 | $this->addOption(CURLOPT_CUSTOMREQUEST, "PUT"); |
||
| 323 | |||
| 324 | if($this->getIsJson()) { |
||
| 325 | $this->addOption(CURLOPT_POSTFIELDS, json_encode($this->params)); |
||
| 326 | } else { |
||
| 327 | $this->addOption(CURLOPT_POSTFIELDS, http_build_query($this->params)); |
||
| 328 | } |
||
| 329 | break; |
||
| 330 | case 'PATCH': |
||
| 331 | $this->addOption(CURLOPT_CUSTOMREQUEST, "PATCH"); |
||
| 332 | if($this->getIsJson()) { |
||
| 333 | $this->addOption(CURLOPT_POSTFIELDS, json_encode($this->params)); |
||
| 334 | } else { |
||
| 335 | $this->addOption(CURLOPT_POSTFIELDS, http_build_query($this->params)); |
||
| 336 | } |
||
| 337 | break; |
||
| 338 | } |
||
| 339 | |||
| 340 | $this->addOption(CURLOPT_RETURNTRANSFER, true); |
||
| 341 | $this->addOption(CURLOPT_FOLLOWLOCATION, true); |
||
| 342 | $this->addOption(CURLOPT_SSL_VERIFYHOST, false); |
||
| 343 | $this->addOption(CURLOPT_SSL_VERIFYPEER, false); |
||
| 344 | } |
||
| 345 | |||
| 346 | public function callSrv() |
||
| 347 | { |
||
| 348 | $this->setDefaults(); |
||
| 349 | $this->applyOptions(); |
||
| 350 | $this->applyHeaders(); |
||
| 351 | if('debug' === Config::getParam('log.level')) { |
||
| 352 | curl_setopt($this->con, CURLOPT_VERBOSE, true); |
||
| 353 | $verbose = fopen('php://temp', 'w+'); |
||
| 354 | curl_setopt($this->con, CURLOPT_STDERR, $verbose); |
||
| 355 | } |
||
| 356 | $result = curl_exec($this->con); |
||
| 357 | $this->result = $this->isJson ? json_decode($result, true) : $result; |
||
| 358 | if('debug' === Config::getParam('log.level')) { |
||
| 359 | rewind($verbose); |
||
| 360 | $verboseLog = stream_get_contents($verbose); |
||
| 361 | Logger::log($verboseLog, LOG_DEBUG, [ |
||
| 362 | 'headers' => $this->getHeaders(), |
||
| 363 | 'options' => $this->getOptions(), |
||
| 364 | 'url' => $this->getUrl(), |
||
| 365 | ]); |
||
| 366 | } |
||
| 367 | Logger::log($this->url . ' response: ', LOG_DEBUG, $this->result); |
||
| 368 | $this->info = curl_getinfo($this->con); |
||
| 369 | } |
||
| 370 | |||
| 371 | /** |
||
| 372 | * @return mixed |
||
| 373 | */ |
||
| 374 | public function getCallInfo() { |
||
| 375 | return $this->info; |
||
| 376 | } |
||
| 379 |