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 | const AST_STATE_DOWN = 'Down'; // Channel is down and available |
||
| 40 | const AST_STATE_RESERVED = 'Rsrvd'; // Channel is down, but reserved |
||
| 41 | const AST_STATE_OFFHOOK = 'OffHook'; // Channel is off hook |
||
| 42 | const AST_STATE_DIALING = 'Dialing'; // Digits (or equivalent) have been dialed |
||
| 43 | const AST_STATE_RING = 'Ring'; // Line is ringing |
||
| 44 | const AST_STATE_RINGING = 'Ringing'; // Remote end is ringing |
||
| 45 | const AST_STATE_UP = 'Up'; // Line is up |
||
| 46 | const AST_STATE_BUSY = 'Busy'; // Line is busy |
||
| 47 | const AST_STATE_DIALING_OFFHOOK = 'Dialing Offhook'; // Digits (or equivalent) have been dialed while offhook |
||
| 48 | const AST_STATE_PRERING = 'Pre-ring'; // Channel has detected an incoming call and is waiting for ring |
||
| 49 | const AST_STATE_MUTE = 'Mute'; // Do not transmit voice data |
||
| 50 | const AST_STATE_UNKNOWN = 'Unknown'; |
||
| 51 | |||
| 52 | /** |
||
| 53 | * List all active channels in Asterisk. |
||
| 54 | * |
||
| 55 | * @return Channel[] |
||
| 56 | */ |
||
| 57 | 88 | View Code Duplication | public function getChannels() |
| 69 | |||
| 70 | /** |
||
| 71 | * Create a new channel (originate). The new channel is created immediately and a snapshot of it |
||
| 72 | * returned. If a Stasis application is provided it will be automatically subscribed to the originated |
||
| 73 | * channel for further events and updates. |
||
| 74 | * |
||
| 75 | * @param string $endpoint (required) Endpoint to call. |
||
| 76 | * @param string $extension The extension to dial after the endpoint answers |
||
| 77 | * @param string $context The context to dial after the endpoint answers. If omitted, uses 'default' |
||
| 78 | * @param int $priority The priority to dial after the endpoint answers. If omitted, uses 1 |
||
| 79 | * @param string $label Asterisk 13+ The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'. |
||
| 80 | * @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'. |
||
| 81 | * @param string $appArgs The application arguments to pass to the Stasis application. |
||
| 82 | * @param string $callerId CallerID to use when dialing the endpoint or extension. |
||
| 83 | * @param int $timeout (default 30) Timeout (in seconds) before giving up dialing, or -1 for no timeout. |
||
| 84 | * @param string $channelId The unique id to assign the channel on creation. |
||
| 85 | * @param string $otherChannelId The unique id to assign the second channel when using local channels. |
||
| 86 | * @param string $formats The format name capability list to use if originator is not specified. Ex. "ulaw,slin16". Format names can be found with "core show codecs". |
||
| 87 | * @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" } } |
||
| 88 | * @return Channel |
||
| 89 | * @throws InvalidParameterException |
||
| 90 | * @throws ServerException |
||
| 91 | */ |
||
| 92 | View Code Duplication | public function createChannel( |
|
| 132 | |||
| 133 | /** |
||
| 134 | * Channel details. |
||
| 135 | * |
||
| 136 | * @param string $channelId |
||
| 137 | * @return Channel |
||
| 138 | * @throws NotFoundException |
||
| 139 | */ |
||
| 140 | View Code Duplication | public function getChannel($channelId) |
|
| 151 | |||
| 152 | /** |
||
| 153 | * Create a new channel (originate). The new channel is created immediately and a snapshot of it |
||
| 154 | * returned. If a Stasis application is provided it will be automatically subscribed to the originated |
||
| 155 | * channel for further events and updates. |
||
| 156 | * |
||
| 157 | * @param string $endpoint (required) Endpoint to call. |
||
| 158 | * @param string $extension The extension to dial after the endpoint answers |
||
| 159 | * @param string $context The context to dial after the endpoint answers. If omitted, uses 'default' |
||
| 160 | * @param int $priority The priority to dial after the endpoint answers. If omitted, uses 1 |
||
| 161 | * @param string $label Asterisk 13+ The label to dial after the endpoint answers. Will supersede 'priority' if provided. Mutually exclusive with 'app'. |
||
| 162 | * @param string $app The application that is subscribed to the originated channel, and passed to the Stasis application. |
||
| 163 | * @param string $appArgs The application arguments to pass to the Stasis application. |
||
| 164 | * @param string $callerId CallerID to use when dialing the endpoint or extension. |
||
| 165 | * @param int $timeout (default 30) Timeout (in seconds) before giving up dialing, or -1 for no timeout. |
||
| 166 | * @param string $channelId The unique id to assign the channel on creation. |
||
| 167 | * @param string $otherChannelId The unique id to assign the second channel when using local channels. |
||
| 168 | * @param string $formats The format name capability list to use if originator is not specified. Ex. "ulaw,slin16". Format names can be found with "core show codecs". |
||
| 169 | * @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" } } |
||
| 170 | * @return Channel |
||
| 171 | * @throws InvalidParameterException |
||
| 172 | * @throws ServerException |
||
| 173 | */ |
||
| 174 | View Code Duplication | public function createChannelWithId( |
|
| 213 | |||
| 214 | /** |
||
| 215 | * Delete (i.e. hangup) a channel. |
||
| 216 | * |
||
| 217 | * @param string $channelId Channel's id |
||
| 218 | * @throws NotFoundException |
||
| 219 | */ |
||
| 220 | public function deleteChannel($channelId) |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Hangup a channel if it still exists. |
||
| 232 | * |
||
| 233 | * @param string $channelId Channel's id |
||
| 234 | */ |
||
| 235 | public function hangup($channelId) |
||
| 243 | |||
| 244 | /** |
||
| 245 | * Exit application; continue execution in the dialplan. |
||
| 246 | * |
||
| 247 | * @param string $channelId Channel's id |
||
| 248 | * @param string $context The context to continue to. |
||
| 249 | * @param string $extension The extension to continue to. |
||
| 250 | * @param int $priority The priority to continue to. |
||
| 251 | * @throws NotFoundException |
||
| 252 | * @throws ConflictException |
||
| 253 | */ |
||
| 254 | public function continueDialplan($channelId, $context, $extension, $priority) |
||
| 269 | |||
| 270 | /** |
||
| 271 | * Redirect the channel to a different location. |
||
| 272 | * |
||
| 273 | * @param string $channelId Channel's id |
||
| 274 | * @param string $endpoint (required) The endpoint to redirect the channel to |
||
| 275 | * @throws MissingParameterException |
||
| 276 | * @throws NotFoundException |
||
| 277 | * @throws ConflictException |
||
| 278 | * @throws UnprocessableEntityException |
||
| 279 | * @throws PreconditionFailedException |
||
| 280 | */ |
||
| 281 | public function redirect($channelId, $endpoint) |
||
| 294 | |||
| 295 | /** |
||
| 296 | * Answer a channel. |
||
| 297 | * |
||
| 298 | * @param string $channelId Channel's id |
||
| 299 | * @throws NotFoundException |
||
| 300 | * @throws ConflictException |
||
| 301 | */ |
||
| 302 | public function answer($channelId) |
||
| 311 | |||
| 312 | /** |
||
| 313 | * Indicate ringing to a channel. |
||
| 314 | * |
||
| 315 | * @param string $channelId |
||
| 316 | * @throws NotFoundException |
||
| 317 | * @throws ConflictException |
||
| 318 | */ |
||
| 319 | public function startRinging($channelId) |
||
| 328 | |||
| 329 | /** |
||
| 330 | * Stop ringing indication on a channel if locally generated. |
||
| 331 | * |
||
| 332 | * @param string $channelId |
||
| 333 | * @throws NotFoundException |
||
| 334 | * @throws ConflictException |
||
| 335 | */ |
||
| 336 | public function stopRinging($channelId) |
||
| 345 | |||
| 346 | /** |
||
| 347 | * Send provided DTMF to a given channel. |
||
| 348 | * |
||
| 349 | * @param string $channelId |
||
| 350 | * @param string $dtmf DTMF To send. |
||
| 351 | * @param int $before Amount of time to wait before DTMF digits (specified in milliseconds) start. |
||
| 352 | * @param int $between Amount of time in between DTMF digits (specified in milliseconds). Default: 100 |
||
| 353 | * @param int $duration Length of each DTMF digit (specified in milliseconds). Default: 100 |
||
| 354 | * @param int $after Amount of time to wait after DTMF digits (specified in milliseconds) end. |
||
| 355 | * @throws InvalidParameterException |
||
| 356 | * @throws NotFoundException |
||
| 357 | * @throws ConflictException |
||
| 358 | */ |
||
| 359 | public function sendDtmf($channelId, $dtmf, $before = null, $between = null, $duration = null, $after = null) |
||
| 376 | |||
| 377 | /** |
||
| 378 | * Mute a channel. |
||
| 379 | * |
||
| 380 | * @param string $channelId Channel's id |
||
| 381 | * @param string $direction (default both) Direction in which to mute audio. Allowed values: both, in, out |
||
| 382 | * @throws NotFoundException |
||
| 383 | * @throws ConflictException |
||
| 384 | */ |
||
| 385 | public function mute($channelId, $direction) |
||
| 398 | |||
| 399 | /** |
||
| 400 | * Unmute a channel. |
||
| 401 | * |
||
| 402 | * @param string $channelId Channel's id |
||
| 403 | * @param string $direction (default both) Direction in which to unmute audio |
||
| 404 | * @throws NotFoundException |
||
| 405 | * @throws ConflictException |
||
| 406 | */ |
||
| 407 | View Code Duplication | public function unmute($channelId, $direction) |
|
| 416 | |||
| 417 | /** |
||
| 418 | * Hold a channel. |
||
| 419 | * |
||
| 420 | * @param string $channelId Channel's id |
||
| 421 | * @throws NotFoundException |
||
| 422 | * @throws ConflictException |
||
| 423 | */ |
||
| 424 | public function hold($channelId) |
||
| 433 | |||
| 434 | /** |
||
| 435 | * Remove a channel from hold. |
||
| 436 | * |
||
| 437 | * @param string $channelId Channel's id |
||
| 438 | * @throws NotFoundException |
||
| 439 | * @throws ConflictException |
||
| 440 | */ |
||
| 441 | public function unhold($channelId) |
||
| 450 | |||
| 451 | /** |
||
| 452 | * 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. |
||
| 453 | * |
||
| 454 | * @param string $channelId Channel's id |
||
| 455 | * @throws NotFoundException |
||
| 456 | * @throws ConflictException |
||
| 457 | */ |
||
| 458 | public function startSilence($channelId) |
||
| 467 | |||
| 468 | /** |
||
| 469 | * Stop playing silence to a channel. |
||
| 470 | * |
||
| 471 | * @param string $channelId Channel's id |
||
| 472 | * @throws NotFoundException |
||
| 473 | * @throws ConflictException |
||
| 474 | */ |
||
| 475 | public function stopSilence($channelId) |
||
| 484 | |||
| 485 | /** |
||
| 486 | * Get the value of a channel variable or function. |
||
| 487 | * |
||
| 488 | * @param string $channelId |
||
| 489 | * @param string $variable |
||
| 490 | * @param null|string $default The value to return if the variable does not exist |
||
| 491 | * @return string|Variable |
||
| 492 | * @throws ConflictException |
||
| 493 | * @throws InvalidParameterException |
||
| 494 | * @throws NotFoundException |
||
| 495 | */ |
||
| 496 | public function getChannelVar($channelId, $variable, $default = null) |
||
| 519 | |||
| 520 | /** |
||
| 521 | * Get the value of a channel variable or function. |
||
| 522 | * |
||
| 523 | * @param string $channelId |
||
| 524 | * @param string $variable |
||
| 525 | * @param null|string $default The value to return if the variable does not exist |
||
| 526 | * @return string|Variable |
||
| 527 | * @throws ConflictException |
||
| 528 | * @throws InvalidParameterException |
||
| 529 | * @throws NotFoundException |
||
| 530 | * @deprecated |
||
| 531 | */ |
||
| 532 | public function getVariable($channelId, $variable, $default = null) |
||
| 536 | |||
| 537 | /** |
||
| 538 | * Set the value of a channel variable or function. |
||
| 539 | * |
||
| 540 | * @param string $channelId |
||
| 541 | * @param string $variable |
||
| 542 | * @param string $value |
||
| 543 | * @return Variable |
||
| 544 | * @throws InvalidParameterException |
||
| 545 | * @throws NotFoundException |
||
| 546 | * @throws ConflictException |
||
| 547 | */ |
||
| 548 | public function setChannelVar($channelId, $variable, $value) |
||
| 564 | |||
| 565 | /** |
||
| 566 | * Set the value of a channel variable or function. |
||
| 567 | * |
||
| 568 | * @param string $channelId |
||
| 569 | * @param string $variable |
||
| 570 | * @param string $value |
||
| 571 | * @return Variable |
||
| 572 | * @throws InvalidParameterException |
||
| 573 | * @throws NotFoundException |
||
| 574 | * @throws ConflictException |
||
| 575 | * @deprecated |
||
| 576 | */ |
||
| 577 | public function setVariable($channelId, $variable, $value) |
||
| 581 | |||
| 582 | /** |
||
| 583 | * Start snooping. Snoop (spy/whisper) on a specific channel. |
||
| 584 | * |
||
| 585 | * @param string $channelId Channel's id |
||
| 586 | * @param string $spy (default none) Direction of audio to spy on |
||
| 587 | * @param string $whisper (default none) Direction of audio to whisper into |
||
| 588 | * @param string $app (required) Application the snooping channel is placed into |
||
| 589 | * @param string $appArgs The application arguments to pass to the Stasis application |
||
| 590 | * @param string $snoopId Unique ID to assign to snooping channel |
||
| 591 | * @return Channel |
||
| 592 | * @throws InvalidParameterException |
||
| 593 | * @throws NotFoundException |
||
| 594 | */ |
||
| 595 | View Code Duplication | public function startSnoop($channelId, $spy, $whisper, $app, $appArgs, $snoopId) |
|
| 614 | |||
| 615 | /** |
||
| 616 | * Start snooping. Snoop (spy/whisper) on a specific channel. |
||
| 617 | * |
||
| 618 | * @param string $channelId Channel's id |
||
| 619 | * @param string $spy (default none) Direction of audio to spy on |
||
| 620 | * @param string $whisper (default none) Direction of audio to whisper into |
||
| 621 | * @param string $app (required) Application the snooping channel is placed into |
||
| 622 | * @param string $appArgs The application arguments to pass to the Stasis application |
||
| 623 | * @param string $snoopId Unique ID to assign to snooping channel |
||
| 624 | * @return Channel |
||
| 625 | * @throws InvalidParameterException |
||
| 626 | * @throws NotFoundException |
||
| 627 | */ |
||
| 628 | View Code Duplication | public function startSnoopWithId($channelId, $spy, $whisper, $app, $appArgs, $snoopId) |
|
| 646 | |||
| 647 | /** |
||
| 648 | * @return string |
||
| 649 | */ |
||
| 650 | public function getType() |
||
| 654 | } |
||
| 655 |
