Complex classes like Grid 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 Grid, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 16 | class Grid |
||
|
|
|||
| 17 | { |
||
| 18 | /** |
||
| 19 | * @var string |
||
| 20 | */ |
||
| 21 | private $code; |
||
| 22 | |||
| 23 | /** |
||
| 24 | * @var string |
||
| 25 | */ |
||
| 26 | private $driver; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * @var array |
||
| 30 | */ |
||
| 31 | private $driverConfiguration; |
||
| 32 | |||
| 33 | /** |
||
| 34 | * @var array |
||
| 35 | */ |
||
| 36 | private $sorting = []; |
||
| 37 | |||
| 38 | /** |
||
| 39 | * @var array |
||
| 40 | */ |
||
| 41 | private $limits = []; |
||
| 42 | |||
| 43 | /** |
||
| 44 | * @var array |
||
| 45 | */ |
||
| 46 | private $fields = []; |
||
| 47 | |||
| 48 | /** |
||
| 49 | * @var array |
||
| 50 | */ |
||
| 51 | private $filters = []; |
||
| 52 | |||
| 53 | /** |
||
| 54 | * @var array |
||
| 55 | */ |
||
| 56 | private $actionGroups = []; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @param string $code |
||
| 60 | * @param string $driver |
||
| 61 | * @param array $driverConfiguration |
||
| 62 | */ |
||
| 63 | private function __construct($code, $driver, array $driverConfiguration) |
||
| 69 | |||
| 70 | /** |
||
| 71 | * @param string $code |
||
| 72 | * @param string $driver |
||
| 73 | * @param array $driverConfiguration |
||
| 74 | * |
||
| 75 | * @return self |
||
| 76 | */ |
||
| 77 | public static function fromCodeAndDriverConfiguration($code, $driver, array $driverConfiguration) |
||
| 81 | |||
| 82 | /** |
||
| 83 | * @return string |
||
| 84 | */ |
||
| 85 | public function getCode() |
||
| 89 | |||
| 90 | /** |
||
| 91 | * @return string |
||
| 92 | */ |
||
| 93 | public function getDriver() |
||
| 97 | |||
| 98 | /** |
||
| 99 | * @return array |
||
| 100 | */ |
||
| 101 | public function getDriverConfiguration() |
||
| 105 | |||
| 106 | /** |
||
| 107 | * @param array $driverConfiguration |
||
| 108 | */ |
||
| 109 | public function setDriverConfiguration(array $driverConfiguration) |
||
| 113 | |||
| 114 | /** |
||
| 115 | * @return array |
||
| 116 | */ |
||
| 117 | public function getSorting() |
||
| 121 | |||
| 122 | /** |
||
| 123 | * @param array $sorting |
||
| 124 | */ |
||
| 125 | public function setSorting(array $sorting) |
||
| 129 | |||
| 130 | /** |
||
| 131 | * @return array |
||
| 132 | */ |
||
| 133 | public function getLimits() |
||
| 137 | |||
| 138 | /** |
||
| 139 | * @param array $limits |
||
| 140 | */ |
||
| 141 | public function setLimits(array $limits) |
||
| 145 | |||
| 146 | /** |
||
| 147 | * @return array |
||
| 148 | */ |
||
| 149 | public function getFields() |
||
| 153 | |||
| 154 | /** |
||
| 155 | * @return array |
||
| 156 | */ |
||
| 157 | public function getEnabledFields() |
||
| 161 | |||
| 162 | /** |
||
| 163 | * @param Field $field |
||
| 164 | */ |
||
| 165 | public function addField(Field $field) |
||
| 175 | |||
| 176 | /** |
||
| 177 | * @param string $name |
||
| 178 | */ |
||
| 179 | public function removeField($name) |
||
| 185 | |||
| 186 | /** |
||
| 187 | * @param string $name |
||
| 188 | * |
||
| 189 | * @return Field |
||
| 190 | */ |
||
| 191 | public function getField($name) |
||
| 199 | |||
| 200 | /** |
||
| 201 | * @param Field $field |
||
| 202 | */ |
||
| 203 | public function setField(Field $field) |
||
| 209 | |||
| 210 | /** |
||
| 211 | * @param string $name |
||
| 212 | * |
||
| 213 | * @return bool |
||
| 214 | */ |
||
| 215 | public function hasField($name) |
||
| 219 | |||
| 220 | /** |
||
| 221 | * @return array |
||
| 222 | */ |
||
| 223 | public function getActionGroups() |
||
| 227 | |||
| 228 | /** |
||
| 229 | * @return array |
||
| 230 | */ |
||
| 231 | public function getEnabledActionGroups() |
||
| 235 | |||
| 236 | /** |
||
| 237 | * @param ActionGroup $actionGroup |
||
| 238 | */ |
||
| 239 | public function addActionGroup(ActionGroup $actionGroup) |
||
| 249 | |||
| 250 | /** |
||
| 251 | * @param string $name |
||
| 252 | */ |
||
| 253 | public function removeActionGroup($name) |
||
| 259 | |||
| 260 | /** |
||
| 261 | * @param string $name |
||
| 262 | * |
||
| 263 | * @return ActionGroup |
||
| 264 | */ |
||
| 265 | public function getActionGroup($name) |
||
| 273 | |||
| 274 | /** |
||
| 275 | * @param ActionGroup $actionGroup |
||
| 276 | */ |
||
| 277 | public function setActionGroup(ActionGroup $actionGroup) |
||
| 283 | |||
| 284 | /** |
||
| 285 | * @param string $groupName |
||
| 286 | * |
||
| 287 | * @return Action[] |
||
| 288 | */ |
||
| 289 | public function getActions($groupName) |
||
| 293 | |||
| 294 | /** |
||
| 295 | * @return array |
||
| 296 | */ |
||
| 297 | public function getEnabledActions($groupName) |
||
| 301 | |||
| 302 | /** |
||
| 303 | * @param string $name |
||
| 304 | * |
||
| 305 | * @return bool |
||
| 306 | */ |
||
| 307 | public function hasActionGroup($name) |
||
| 311 | |||
| 312 | /** |
||
| 313 | * @return array |
||
| 314 | */ |
||
| 315 | public function getFilters() |
||
| 319 | |||
| 320 | /** |
||
| 321 | * @return array |
||
| 322 | */ |
||
| 323 | public function getEnabledFilters() |
||
| 327 | |||
| 328 | /** |
||
| 329 | * @param Filter $filter |
||
| 330 | */ |
||
| 331 | public function addFilter(Filter $filter) |
||
| 339 | |||
| 340 | /** |
||
| 341 | * @param string $name |
||
| 342 | */ |
||
| 343 | public function removeFilter($name) |
||
| 349 | |||
| 350 | /** |
||
| 351 | * @param string $name |
||
| 352 | * |
||
| 353 | * @return Filter |
||
| 354 | */ |
||
| 355 | public function getFilter($name) |
||
| 363 | |||
| 364 | /** |
||
| 365 | * @param Filter $filter |
||
| 366 | */ |
||
| 367 | public function setFilter(Filter $filter) |
||
| 373 | |||
| 374 | /** |
||
| 375 | * @param string $name |
||
| 376 | * |
||
| 377 | * @return bool |
||
| 378 | */ |
||
| 379 | public function hasFilter($name) |
||
| 383 | |||
| 384 | /** |
||
| 385 | * @param array $items |
||
| 386 | * |
||
| 387 | * @return array |
||
| 388 | */ |
||
| 389 | private function getEnabledItems(array $items) |
||
| 400 | } |
||
| 401 |