ublaboo /
datagrid
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 ArrayDataSource 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 ArrayDataSource, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 24 | class ArrayDataSource implements IDataSource |
||
| 25 | { |
||
| 26 | |||
| 27 | /** |
||
| 28 | * @var array |
||
| 29 | */ |
||
| 30 | protected $data = []; |
||
| 31 | |||
| 32 | |||
| 33 | /** |
||
| 34 | * @param array $data_source |
||
| 35 | */ |
||
| 36 | public function __construct(array $data_source) |
||
| 37 | { |
||
| 38 | $this->data = $data_source; |
||
| 39 | } |
||
| 40 | |||
| 41 | |||
| 42 | /******************************************************************************** |
||
| 43 | * IDataSource implementation * |
||
| 44 | ********************************************************************************/ |
||
| 45 | |||
| 46 | |||
| 47 | /** |
||
| 48 | * Get count of data |
||
| 49 | * @return int |
||
| 50 | */ |
||
| 51 | public function getCount() |
||
| 52 | { |
||
| 53 | return sizeof($this->data); |
||
| 54 | } |
||
| 55 | |||
| 56 | |||
| 57 | /** |
||
| 58 | * Get the data |
||
| 59 | * @return array |
||
| 60 | * @return array |
||
| 61 | */ |
||
| 62 | public function getData() |
||
| 63 | { |
||
| 64 | return $this->data; |
||
| 65 | } |
||
| 66 | |||
| 67 | |||
| 68 | /** |
||
| 69 | * Filter data |
||
| 70 | * @param Filter[] $filters |
||
| 71 | * @return static |
||
| 72 | */ |
||
| 73 | public function filter(array $filters) |
||
| 74 | { |
||
| 75 | foreach ($filters as $filter) { |
||
| 76 | if ($filter->isValueSet()) { |
||
| 77 | if ($filter->hasConditionCallback()) { |
||
| 78 | $this->data = (array) call_user_func_array( |
||
| 79 | $filter->getConditionCallback(), |
||
| 80 | [$this->data, $filter->getValue()] |
||
| 81 | ); |
||
| 82 | } else { |
||
| 83 | $this->data = array_filter($this->data, function($row) use ($filter) { |
||
| 84 | return $this->applyFilter($row, $filter); |
||
| 85 | }); |
||
| 86 | } |
||
| 87 | } |
||
| 88 | } |
||
| 89 | |||
| 90 | return $this; |
||
| 91 | } |
||
| 92 | |||
| 93 | |||
| 94 | /** |
||
| 95 | * Filter data - get one row |
||
| 96 | * @param array $condition |
||
| 97 | * @return ArrayDataSource |
||
| 98 | */ |
||
| 99 | public function filterOne(array $condition) |
||
| 100 | { |
||
| 101 | foreach ($this->data as $item) { |
||
| 102 | foreach ($condition as $key => $value) { |
||
| 103 | if ($item[$key] == $value) { |
||
| 104 | $this->data = [$item]; |
||
| 105 | |||
| 106 | return $this; |
||
| 107 | } |
||
| 108 | } |
||
| 109 | } |
||
| 110 | |||
| 111 | $this->data = []; |
||
| 112 | |||
| 113 | return $this; |
||
| 114 | } |
||
| 115 | |||
| 116 | |||
| 117 | /** |
||
| 118 | * Apply limit and offset on data |
||
| 119 | * @param int $offset |
||
| 120 | * @param int $limit |
||
| 121 | * @return static |
||
| 122 | */ |
||
| 123 | public function limit($offset, $limit) |
||
| 129 | |||
| 130 | |||
| 131 | /** |
||
| 132 | * Apply fitler and tell whether row passes conditions or not |
||
| 133 | * @param mixed $row |
||
| 134 | * @param Filter $filter |
||
| 135 | * @return mixed |
||
| 136 | */ |
||
| 137 | protected function applyFilter($row, Filter $filter) |
||
| 138 | { |
||
| 139 | if (is_array($row) || $row instanceof \Traversable) { |
||
| 140 | if ($filter instanceof FilterDate) { |
||
| 141 | return $this->applyFilterDate($row, $filter); |
||
| 142 | } else if ($filter instanceof FilterMultiSelect) { |
||
| 143 | return $this->applyFilterMultiSelect($row, $filter); |
||
| 144 | View Code Duplication | } else if ($filter instanceof FilterDateRange) { |
|
|
|
|||
| 145 | return $this->applyFilterDateRange($row, $filter); |
||
| 146 | } else if ($filter instanceof FilterRange) { |
||
| 147 | return $this->applyFilterRange($row, $filter); |
||
| 148 | } |
||
| 149 | |||
| 150 | $condition = $filter->getCondition(); |
||
| 151 | |||
| 152 | foreach ($condition as $column => $value) { |
||
| 153 | $words = explode(' ', $value); |
||
| 154 | $row_value = strtolower(Strings::toAscii($row[$column])); |
||
| 155 | |||
| 156 | foreach ($words as $word) { |
||
| 157 | if (FALSE !== strpos($row_value, strtolower(Strings::toAscii($value)))) { |
||
| 158 | return $row; |
||
| 159 | } |
||
| 160 | } |
||
| 161 | } |
||
| 162 | } |
||
| 163 | |||
| 164 | return FALSE; |
||
| 165 | } |
||
| 166 | |||
| 167 | |||
| 168 | /** |
||
| 169 | * Filter by multi select value |
||
| 170 | * @param mixed $row |
||
| 171 | * @param FilterMultiSelect $filter |
||
| 172 | * @return void |
||
| 173 | */ |
||
| 174 | public function applyFilterMultiSelect($row, FilterMultiSelect $filter) |
||
| 181 | |||
| 182 | |||
| 183 | /** |
||
| 184 | * @param mixed $row |
||
| 185 | * @param FilterRange $filter |
||
| 186 | * @return void |
||
| 187 | */ |
||
| 188 | public function applyFilterRange($row, FilterRange $filter) |
||
| 207 | |||
| 208 | |||
| 209 | /** |
||
| 210 | * @param mixed $row |
||
| 211 | * @param FilterDateRange $filter |
||
| 212 | * @return void |
||
| 213 | */ |
||
| 214 | public function applyFilterDateRange($row, FilterDateRange $filter) |
||
| 274 | |||
| 275 | |||
| 276 | /** |
||
| 277 | * Apply fitler date and tell whether row value matches or not |
||
| 278 | * @param mixed $row |
||
| 279 | * @param FilterDate $filter |
||
| 280 | * @return mixed |
||
| 281 | */ |
||
| 282 | protected function applyFilterDate($row, FilterDate $filter) |
||
| 314 | |||
| 315 | |||
| 316 | /** |
||
| 317 | * Sort data |
||
| 318 | * @param Sorting $sorting |
||
| 319 | * @return static |
||
| 320 | */ |
||
| 321 | public function sort(Sorting $sorting) |
||
| 364 | |||
| 365 | } |
||
| 366 |
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.