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:
| 1 | <?php |
||
| 9 | class PubSub |
||
| 10 | { |
||
| 11 | use \PHPDaemon\Traits\ClassWatchdog; |
||
| 12 | use \PHPDaemon\Traits\StaticObjectWatchdog; |
||
| 13 | |||
| 14 | /** |
||
| 15 | * @var PubSubEvent[] Storage of events |
||
| 16 | */ |
||
| 17 | protected $events = []; |
||
| 18 | |||
| 19 | /** |
||
| 20 | * Is event exists? |
||
| 21 | * @param string $id Event ID |
||
| 22 | * @return boolean |
||
| 23 | */ |
||
| 24 | public function eventExists($id) |
||
| 28 | |||
| 29 | /** |
||
| 30 | * Subcribe to event |
||
| 31 | * @param string $id Event ID |
||
| 32 | * @param object $obj Subscriber |
||
| 33 | * @param callable $cb Callback |
||
| 34 | * @return boolean Success |
||
|
|
|||
| 35 | */ |
||
| 36 | public function sub($id, $obj, $cb) |
||
| 43 | |||
| 44 | /** |
||
| 45 | * Adds event |
||
| 46 | * @param string $id Event ID |
||
| 47 | * @param PubSubEvent $obj |
||
| 48 | * @return void |
||
| 49 | */ |
||
| 50 | public function addEvent($id, PubSubEvent $obj) |
||
| 54 | |||
| 55 | /** |
||
| 56 | * Removes event |
||
| 57 | * @param string $id Event ID |
||
| 58 | * @return void |
||
| 59 | */ |
||
| 60 | public function removeEvent($id) |
||
| 64 | |||
| 65 | /** |
||
| 66 | * Unsubscribe object from event |
||
| 67 | * @param string $id Event ID |
||
| 68 | * @param object $obj Subscriber |
||
| 69 | * @return boolean Success |
||
| 70 | */ |
||
| 71 | View Code Duplication | public function unsub($id, $obj) |
|
| 78 | |||
| 79 | /** |
||
| 80 | * Publish |
||
| 81 | * @param string $id Event ID |
||
| 82 | * @param mixed $data Data |
||
| 83 | * @return boolean Success |
||
| 84 | */ |
||
| 85 | View Code Duplication | public function pub($id, $data) |
|
| 92 | |||
| 93 | /** |
||
| 94 | * Unsubscribe object from all events |
||
| 95 | * @param object $obj Subscriber |
||
| 96 | * @return boolean Success |
||
| 97 | */ |
||
| 98 | public function unsubFromAll($obj) |
||
| 105 | } |
||
| 106 |
This check compares the return type specified in the
@returnannotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.