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 BaseCircle 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 BaseCircle, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class BaseCircle { |
||
| 32 | |||
| 33 | const CIRCLES_SETTINGS_DEFAULT = [ |
||
| 34 | 'allow_links' => false, |
||
| 35 | 'allow_links_auto' => false, |
||
| 36 | 'allow_links_files' => false |
||
| 37 | ]; |
||
| 38 | |||
| 39 | const CIRCLES_PERSONAL = 1; |
||
| 40 | const CIRCLES_HIDDEN = 2; |
||
| 41 | const CIRCLES_PRIVATE = 4; |
||
| 42 | const CIRCLES_PUBLIC = 8; |
||
| 43 | |||
| 44 | const CIRCLES_ALL = 15; |
||
| 45 | |||
| 46 | /** @var int */ |
||
| 47 | private $id; |
||
| 48 | |||
| 49 | /** @var L10N */ |
||
| 50 | protected $l10n; |
||
| 51 | |||
| 52 | /** @var string */ |
||
| 53 | private $uniqueId; |
||
| 54 | |||
| 55 | /** @var string */ |
||
| 56 | private $name; |
||
| 57 | |||
| 58 | /** @var Member */ |
||
| 59 | private $owner; |
||
| 60 | |||
| 61 | /** @var Member */ |
||
| 62 | private $user; |
||
| 63 | |||
| 64 | /** @var string */ |
||
| 65 | private $description; |
||
| 66 | |||
| 67 | /** @var array */ |
||
| 68 | private $settings = []; |
||
| 69 | |||
| 70 | /** @var int */ |
||
| 71 | private $type; |
||
| 72 | |||
| 73 | /** @var string */ |
||
| 74 | private $creation; |
||
| 75 | |||
| 76 | /** @var Member[] */ |
||
| 77 | private $members; |
||
| 78 | |||
| 79 | /** @var FederatedLink[] */ |
||
| 80 | private $links; |
||
| 81 | |||
| 82 | public function __construct($l10n, $type = -1, $name = '') { |
||
| 92 | |||
| 93 | |||
| 94 | public function setId($id) { |
||
| 99 | |||
| 100 | public function getId() { |
||
| 103 | |||
| 104 | |||
| 105 | /** |
||
| 106 | * @param string $uniqueId |
||
| 107 | * |
||
| 108 | * @return $this |
||
| 109 | */ |
||
| 110 | public function setUniqueId($uniqueId) { |
||
| 115 | |||
| 116 | /** |
||
| 117 | * @return string |
||
| 118 | */ |
||
| 119 | public function getUniqueId() { |
||
| 122 | |||
| 123 | public function generateUniqueId() { |
||
| 127 | |||
| 128 | public function setName($name) { |
||
| 133 | |||
| 134 | public function getName() { |
||
| 137 | |||
| 138 | |||
| 139 | public function getOwner() { |
||
| 142 | |||
| 143 | public function setOwner($owner) { |
||
| 148 | |||
| 149 | |||
| 150 | /** |
||
| 151 | * @return Member |
||
| 152 | */ |
||
| 153 | public function getUser() { |
||
| 156 | |||
| 157 | public function setUser($user) { |
||
| 162 | |||
| 163 | |||
| 164 | public function setDescription($description) { |
||
| 169 | |||
| 170 | public function getDescription() { |
||
| 173 | |||
| 174 | |||
| 175 | public function setSettings($settings) { |
||
| 184 | |||
| 185 | public function getSettings($json = false) { |
||
| 201 | |||
| 202 | |||
| 203 | public function setSetting($k, $v) { |
||
| 206 | |||
| 207 | |||
| 208 | /** |
||
| 209 | * @param string $k |
||
| 210 | * |
||
| 211 | * @return string|null |
||
| 212 | */ |
||
| 213 | public function getSetting($k) { |
||
| 223 | |||
| 224 | |||
| 225 | public function setType($type) { |
||
| 230 | |||
| 231 | public function getType() { |
||
| 234 | |||
| 235 | |||
| 236 | public function setCreation($creation) { |
||
| 241 | |||
| 242 | public function getCreation() { |
||
| 245 | |||
| 246 | |||
| 247 | public function setMembers($members) { |
||
| 252 | |||
| 253 | public function getMembers() { |
||
| 256 | |||
| 257 | |||
| 258 | public function getRemote() { |
||
| 261 | |||
| 262 | public function addRemote($link) { |
||
| 265 | |||
| 266 | public function getRemoteFromToken($token) { |
||
| 275 | |||
| 276 | public function getRemoteFromAddressAndId($address, $id) { |
||
| 285 | |||
| 286 | |||
| 287 | public static function typeInt($type) { |
||
| 306 | } |
Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.
Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..