wormling /
phparia
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 Channels 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 Channels, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 37 | class Channels extends MediaBase |
||
| 38 | { |
||
| 39 | /** |
||
| 40 | * List all active channels in Asterisk. |
||
| 41 | * |
||
| 42 | * @return Channel[] |
||
| 43 | */ |
||
| 44 | public function getChannels() |
||
| 56 | |||
| 57 | /** |
||
| 58 | * Create a new channel (originate). The new channel is created immediately and a snapshot of it |
||
| 59 | * returned. If a Stasis application is provided it will be automatically subscribed to the originated |
||
| 60 | * channel for further events and updates. |
||
| 61 | * |
||
| 62 | * @param string $endpoint (required) Endpoint to call. |
||
| 63 | * @param string $extension The extension to dial after the endpoint answers |
||
| 64 | * @param string $context The context to dial after the endpoint answers. If omitted, uses 'default' |
||
| 65 | * @param int $priority The priority to dial after the endpoint answers. If omitted, uses 1 |
||
| 66 | * @param string $label Asterisk 13+ The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'. |
||
| 67 | * @param string $app The application that is subscribed to the originated channel. When the channel is answered, it will be passed to this Stasis application. Mutually exclusive with 'context', 'extension', 'priority', and 'label'. |
||
| 68 | * @param string $appArgs The application arguments to pass to the Stasis application. |
||
| 69 | * @param string $callerId CallerID to use when dialing the endpoint or extension. |
||
| 70 | * @param int $timeout (default 30) Timeout (in seconds) before giving up dialing, or -1 for no timeout. |
||
| 71 | * @param string $channelId The unique id to assign the channel on creation. |
||
| 72 | * @param string $otherChannelId The unique id to assign the second channel when using local channels. |
||
| 73 | * @param array $variables The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } } |
||
| 74 | * @return Channel |
||
| 75 | * @throws InvalidParameterException |
||
| 76 | * @throws ServerException |
||
| 77 | */ |
||
| 78 | 36 | public function createChannel( |
|
| 116 | |||
| 117 | /** |
||
| 118 | * Channel details. |
||
| 119 | * |
||
| 120 | * @param string $channelId |
||
| 121 | * @return Channel |
||
| 122 | * @throws NotFoundException |
||
| 123 | */ |
||
| 124 | public function getChannel($channelId) |
||
| 135 | |||
| 136 | /** |
||
| 137 | * Create a new channel (originate). The new channel is created immediately and a snapshot of it |
||
| 138 | * returned. If a Stasis application is provided it will be automatically subscribed to the originated |
||
| 139 | * channel for further events and updates. |
||
| 140 | * |
||
| 141 | * @param string $endpoint (required) Endpoint to call. |
||
| 142 | * @param string $extension The extension to dial after the endpoint answers |
||
| 143 | * @param string $context The context to dial after the endpoint answers. If omitted, uses 'default' |
||
| 144 | * @param int $priority The priority to dial after the endpoint answers. If omitted, uses 1 |
||
| 145 | * @param string $label Asterisk 13+ The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'. |
||
| 146 | * @param string $app The application that is subscribed to the originated channel, and passed to the Stasis application. |
||
| 147 | * @param string $appArgs The application arguments to pass to the Stasis application. |
||
| 148 | * @param string $callerId CallerID to use when dialing the endpoint or extension. |
||
| 149 | * @param int $timeout (default 30) Timeout (in seconds) before giving up dialing, or -1 for no timeout. |
||
| 150 | * @param string $channelId The unique id to assign the channel on creation. |
||
| 151 | * @param string $otherChannelId The unique id to assign the second channel when using local channels. |
||
| 152 | * @param array $variables The "variables" key in the body object holds variable key/value pairs to set on the channel on creation. Other keys in the body object are interpreted as query parameters. Ex. { "endpoint": "SIP/Alice", "variables": { "CALLERID(name)": "Alice" } } |
||
| 153 | * @return Channel |
||
| 154 | * @throws InvalidParameterException |
||
| 155 | */ |
||
| 156 | public function createChannelWithId( |
||
| 191 | |||
| 192 | /** |
||
| 193 | * Delete (i.e. hangup) a channel. |
||
| 194 | * |
||
| 195 | * @param string $channelId Channel's id |
||
| 196 | * @throws NotFoundException |
||
| 197 | */ |
||
| 198 | 1 | View Code Duplication | public function deleteChannel($channelId) |
|
|
|||
| 199 | { |
||
| 200 | 1 | $uri = "/channels/$channelId"; |
|
| 201 | try { |
||
| 202 | 1 | $this->client->getEndpoint()->delete($uri); |
|
| 203 | 1 | } catch (Pest_NotFound $e) { |
|
| 204 | 1 | throw new NotFoundException($e); |
|
| 205 | } |
||
| 206 | 1 | } |
|
| 207 | |||
| 208 | /** |
||
| 209 | * Hangup a channel if it still exists. |
||
| 210 | * |
||
| 211 | * @param string $channelId Channel's id |
||
| 212 | */ |
||
| 213 | 1 | public function hangup($channelId) |
|
| 214 | { |
||
| 215 | try { |
||
| 216 | 1 | $this->deleteChannel($channelId); |
|
| 217 | 1 | } catch (\Exception $ignore) { |
|
| 218 | // Don't throw exception if the channel doesn't exist |
||
| 219 | } |
||
| 220 | 1 | } |
|
| 221 | |||
| 222 | /** |
||
| 223 | * Exit application; continue execution in the dialplan. |
||
| 224 | * |
||
| 225 | * @param string $channelId Channel's id |
||
| 226 | * @param string $context The context to continue to. |
||
| 227 | * @param string $extension The extension to continue to. |
||
| 228 | * @param int $priority The priority to continue to. |
||
| 229 | * @throws NotFoundException |
||
| 230 | * @throws ConflictException |
||
| 231 | */ |
||
| 232 | public function continueDialplan($channelId, $context, $extension, $priority) |
||
| 247 | |||
| 248 | /** |
||
| 249 | * Answer a channel. |
||
| 250 | * |
||
| 251 | * @param string $channelId Channel's id |
||
| 252 | * @throws NotFoundException |
||
| 253 | * @throws ConflictException |
||
| 254 | */ |
||
| 255 | 35 | View Code Duplication | public function answer($channelId) |
| 266 | |||
| 267 | /** |
||
| 268 | * Indicate ringing to a channel. |
||
| 269 | * |
||
| 270 | * @param string $channelId |
||
| 271 | * @throws NotFoundException |
||
| 272 | * @throws ConflictException |
||
| 273 | */ |
||
| 274 | View Code Duplication | public function startRinging($channelId) |
|
| 285 | |||
| 286 | /** |
||
| 287 | * Stop ringing indication on a channel if locally generated. |
||
| 288 | * |
||
| 289 | * @param string $channelId |
||
| 290 | * @throws NotFoundException |
||
| 291 | * @throws ConflictException |
||
| 292 | */ |
||
| 293 | View Code Duplication | public function stopRinging($channelId) |
|
| 304 | |||
| 305 | /** |
||
| 306 | * Send provided DTMF to a given channel. |
||
| 307 | * |
||
| 308 | * @param string $channelId |
||
| 309 | * @param string $dtmf DTMF To send. |
||
| 310 | * @param int $before Amount of time to wait before DTMF digits (specified in milliseconds) start. |
||
| 311 | * @param int $between Amount of time in between DTMF digits (specified in milliseconds). Default: 100 |
||
| 312 | * @param int $duration Length of each DTMF digit (specified in milliseconds). Default: 100 |
||
| 313 | * @param int $after Amount of time to wait after DTMF digits (specified in milliseconds) end. |
||
| 314 | * @throws InvalidParameterException |
||
| 315 | * @throws NotFoundException |
||
| 316 | * @throws ConflictException |
||
| 317 | */ |
||
| 318 | public function sendDtmf($channelId, $dtmf, $before = null, $between = null, $duration = null, $after = null) |
||
| 337 | |||
| 338 | /** |
||
| 339 | * Mute a channel. |
||
| 340 | * |
||
| 341 | * @param string $channelId Channel's id |
||
| 342 | * @param string $direction (default both) Direction in which to mute audio. Allowed values: both, in, out |
||
| 343 | * @throws NotFoundException |
||
| 344 | * @throws ConflictException |
||
| 345 | */ |
||
| 346 | public function mute($channelId, $direction) |
||
| 359 | |||
| 360 | /** |
||
| 361 | * Unmute a channel. |
||
| 362 | * |
||
| 363 | * @param string $channelId Channel's id |
||
| 364 | * @param string $direction (default both) Direction in which to unmute audio |
||
| 365 | * @throws NotFoundException |
||
| 366 | * @throws ConflictException |
||
| 367 | */ |
||
| 368 | View Code Duplication | public function unmute($channelId, $direction) |
|
| 379 | |||
| 380 | /** |
||
| 381 | * Hold a channel. |
||
| 382 | * |
||
| 383 | * @param string $channelId Channel's id |
||
| 384 | * @throws NotFoundException |
||
| 385 | * @throws ConflictException |
||
| 386 | */ |
||
| 387 | View Code Duplication | public function hold($channelId) |
|
| 398 | |||
| 399 | /** |
||
| 400 | * Remove a channel from hold. |
||
| 401 | * |
||
| 402 | * @param string $channelId Channel's id |
||
| 403 | * @throws NotFoundException |
||
| 404 | * @throws ConflictException |
||
| 405 | */ |
||
| 406 | View Code Duplication | public function unhold($channelId) |
|
| 417 | |||
| 418 | /** |
||
| 419 | * Play silence to a channel. Using media operations such as /play on a channel playing silence in this manner will suspend silence without resuming automatically. |
||
| 420 | * |
||
| 421 | * @param string $channelId Channel's id |
||
| 422 | * @throws NotFoundException |
||
| 423 | * @throws ConflictException |
||
| 424 | */ |
||
| 425 | View Code Duplication | public function startSilence($channelId) |
|
| 436 | |||
| 437 | /** |
||
| 438 | * Stop playing silence to a channel. |
||
| 439 | * |
||
| 440 | * @param string $channelId Channel's id |
||
| 441 | * @throws NotFoundException |
||
| 442 | * @throws ConflictException |
||
| 443 | */ |
||
| 444 | View Code Duplication | public function stopSilence($channelId) |
|
| 455 | |||
| 456 | /** |
||
| 457 | * Get the value of a channel variable or function. |
||
| 458 | * |
||
| 459 | * @param string $channelId |
||
| 460 | * @param string $variable |
||
| 461 | * @param null|string $default The value to return if the variable does not exist |
||
| 462 | * @return string|Variable |
||
| 463 | * @throws ConflictException |
||
| 464 | * @throws InvalidParameterException |
||
| 465 | * @throws NotFoundException |
||
| 466 | */ |
||
| 467 | public function getVariable($channelId, $variable, $default = null) |
||
| 487 | |||
| 488 | /** |
||
| 489 | * Set the value of a channel variable or function. |
||
| 490 | * |
||
| 491 | * @param string $channelId |
||
| 492 | * @param string $variable |
||
| 493 | * @param string $value |
||
| 494 | * @return Variable |
||
| 495 | * @throws InvalidParameterException |
||
| 496 | * @throws NotFoundException |
||
| 497 | * @throws ConflictException |
||
| 498 | */ |
||
| 499 | public function setVariable($channelId, $variable, $value) |
||
| 517 | |||
| 518 | /** |
||
| 519 | * Start snooping. Snoop (spy/whisper) on a specific channel. |
||
| 520 | * |
||
| 521 | * @param string $channelId Channel's id |
||
| 522 | * @param string $spy (default none) Direction of audio to spy on |
||
| 523 | * @param string $whisper (default none) Direction of audio to whisper into |
||
| 524 | * @param string $app (required) Application the snooping channel is placed into |
||
| 525 | * @param string $appArgs The application arguments to pass to the Stasis application |
||
| 526 | * @param string $snoopId Unique ID to assign to snooping channel |
||
| 527 | * @return Channel |
||
| 528 | * @throws InvalidParameterException |
||
| 529 | * @throws NotFoundException |
||
| 530 | */ |
||
| 531 | View Code Duplication | public function startSnoop($channelId, $spy, $whisper, $app, $appArgs, $snoopId) |
|
| 550 | |||
| 551 | /** |
||
| 552 | * Start snooping. Snoop (spy/whisper) on a specific channel. |
||
| 553 | * |
||
| 554 | * @param string $channelId Channel's id |
||
| 555 | * @param string $spy (default none) Direction of audio to spy on |
||
| 556 | * @param string $whisper (default none) Direction of audio to whisper into |
||
| 557 | * @param string $app (required) Application the snooping channel is placed into |
||
| 558 | * @param string $appArgs The application arguments to pass to the Stasis application |
||
| 559 | * @param string $snoopId Unique ID to assign to snooping channel |
||
| 560 | * @return Channel |
||
| 561 | * @throws InvalidParameterException |
||
| 562 | * @throws NotFoundException |
||
| 563 | */ |
||
| 564 | View Code Duplication | public function startSnoopWithId($channelId, $spy, $whisper, $app, $appArgs, $snoopId) |
|
| 582 | |||
| 583 | /** |
||
| 584 | * @return string |
||
| 585 | */ |
||
| 586 | 6 | public function getType() |
|
| 590 | } |
||
| 591 |
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.