eXpansionPluginPack /
eXpansion2
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 |
||
| 27 | class GridBuilder |
||
| 28 | { |
||
| 29 | /** @var ActionFactory */ |
||
| 30 | protected $actionFactory; |
||
| 31 | |||
| 32 | /** @var LineFactory */ |
||
| 33 | protected $titleLineFactory; |
||
| 34 | |||
| 35 | /** @var LineFactory */ |
||
| 36 | protected $lineFactory; |
||
| 37 | |||
| 38 | /** @var PagerFactory */ |
||
| 39 | protected $pagerFactory; |
||
| 40 | |||
| 41 | /** @var DataCollectionInterface */ |
||
| 42 | protected $dataCollection; |
||
| 43 | |||
| 44 | /** @var ManialinkInterface */ |
||
| 45 | protected $manialink; |
||
| 46 | |||
| 47 | /** @var ManialinkFactory */ |
||
| 48 | protected $manialinkFactory; |
||
| 49 | |||
| 50 | /** @var AbstractColumn[] */ |
||
| 51 | protected $columns; |
||
| 52 | |||
| 53 | /** @var float */ |
||
| 54 | protected $totalWidthCoefficency = 0; |
||
| 55 | |||
| 56 | /** @var int */ |
||
| 57 | protected $currentPage = 1; |
||
| 58 | |||
| 59 | /** @var string */ |
||
| 60 | protected $pageKey; |
||
| 61 | |||
| 62 | /** @var Action */ |
||
| 63 | protected $actionPreviousPage; |
||
| 64 | /** @var Action */ |
||
| 65 | protected $actionNextPage; |
||
| 66 | /** @var Action */ |
||
| 67 | protected $actionLastPage; |
||
| 68 | /** @var Action */ |
||
| 69 | protected $actionFirstPage; |
||
| 70 | |||
| 71 | /** @var Action[] */ |
||
| 72 | protected $temporaryActions = []; |
||
| 73 | |||
| 74 | /** |
||
| 75 | * GridBuilder constructor. |
||
| 76 | * |
||
| 77 | * @param ActionFactory $actionFactory |
||
| 78 | * @param LineFactory $lineFactory |
||
| 79 | * @param LineFactory $titleLineFactory |
||
| 80 | * @param PagerFactory $pagerFactory |
||
| 81 | */ |
||
| 82 | 5 | View Code Duplication | public function __construct( |
| 95 | |||
| 96 | /** |
||
| 97 | * Set the data collection. |
||
| 98 | * |
||
| 99 | * @param DataCollectionInterface $dataCollection |
||
| 100 | * |
||
| 101 | * @return $this |
||
| 102 | */ |
||
| 103 | 5 | public function setDataCollection(DataCollectionInterface $dataCollection) |
|
| 109 | |||
| 110 | /** |
||
| 111 | * Set the manialink the content is generated for. |
||
| 112 | * |
||
| 113 | * @param ManialinkInterface $manialink |
||
| 114 | * |
||
| 115 | * @return $this |
||
| 116 | */ |
||
| 117 | 5 | public function setManialink(ManialinkInterface $manialink) |
|
| 132 | |||
| 133 | /** |
||
| 134 | * Set the manialink factory responsible with the manialink. |
||
| 135 | * |
||
| 136 | * @param ManialinkFactory $manialinkFactory |
||
| 137 | * |
||
| 138 | * @return $this |
||
| 139 | */ |
||
| 140 | 5 | public function setManialinkFactory($manialinkFactory) |
|
| 146 | |||
| 147 | /** |
||
| 148 | * @param $key |
||
| 149 | * @param $name |
||
| 150 | * @param $widthCoefficiency |
||
| 151 | * @param bool $sortable |
||
| 152 | * @param bool $translatable |
||
| 153 | * |
||
| 154 | * @return $this |
||
| 155 | */ |
||
| 156 | 5 | public function addTextColumn($key, $name, $widthCoefficiency, $sortable = false, $translatable = false) |
|
| 162 | |||
| 163 | /** |
||
| 164 | * Add an action into a column. |
||
| 165 | * |
||
| 166 | * @param $key |
||
| 167 | * @param $name |
||
| 168 | * @param $widthCoefficiency |
||
| 169 | * @param $action |
||
| 170 | * @param $renderer |
||
| 171 | */ |
||
| 172 | 5 | public function addActionColumn($key, $name, $widthCoefficiency, $action, $renderer) |
|
| 176 | |||
| 177 | /** |
||
| 178 | * Remove all columns. |
||
| 179 | */ |
||
| 180 | 1 | public function resetColumns() |
|
| 185 | |||
| 186 | /** |
||
| 187 | * Build a grid. |
||
| 188 | * |
||
| 189 | * @param $width |
||
| 190 | * @param $height |
||
| 191 | * |
||
| 192 | * @return Frame |
||
| 193 | */ |
||
| 194 | 5 | public function build($width, $height) |
|
| 195 | { |
||
| 196 | 5 | foreach ($this->temporaryActions as $action) { |
|
| 197 | 1 | $this->actionFactory->destroyAction($action); |
|
| 198 | } |
||
| 199 | |||
| 200 | 5 | $lineHeight = 5 + 0.5; |
|
| 201 | |||
| 202 | 5 | $frame = new Frame(); |
|
| 203 | 5 | $frame->setPosition(0,0); |
|
| 204 | 5 | $frame->setSize($width, $height); |
|
| 205 | |||
| 206 | 5 | $posY = 0; |
|
| 207 | // Generating headers. |
||
| 208 | // TODO if sortable create actions... |
||
| 209 | 5 | $data = []; |
|
| 210 | 5 | foreach ($this->columns as $columnData) { |
|
| 211 | 5 | $data[] = [ |
|
| 212 | 5 | 'text' => $columnData->getName(), |
|
| 213 | 5 | 'width' => $columnData->getWidthCoeficiency(), |
|
| 214 | 'translatable' => true |
||
| 215 | ]; |
||
| 216 | } |
||
| 217 | |||
| 218 | 5 | $frame->addChild($this->titleLineFactory->create($frame->getWidth(), $data)); |
|
| 219 | 5 | $posY -= $lineHeight + 1; |
|
| 220 | |||
| 221 | /* |
||
| 222 | * Display the main content. |
||
| 223 | */ |
||
| 224 | 5 | $this->dataCollection->setPageSize(floor(($frame->getHeight() + $posY - $lineHeight - 2) / $lineHeight)); |
|
| 225 | |||
| 226 | 5 | $lines = $this->dataCollection->getData($this->currentPage); |
|
| 227 | 5 | foreach ($lines as $i => $lineData) { |
|
| 228 | 5 | $data = []; |
|
| 229 | 5 | foreach ($this->columns as $columnData) { |
|
| 230 | 5 | if ($columnData instanceof TextColumn) { |
|
| 231 | 5 | $data[] = [ |
|
| 232 | 5 | 'text' => $this->dataCollection->getLineData($lineData, $columnData->getKey()), |
|
| 233 | 5 | 'width' => $columnData->getWidthCoeficiency(), |
|
| 234 | 5 | 'translatable' => $columnData->getTranslatable() |
|
| 235 | ]; |
||
| 236 | 5 | } elseif($columnData instanceof ActionColumn) { |
|
| 237 | 5 | $action = $this->actionFactory |
|
| 238 | 5 | ->createManialinkAction($this->manialink, $columnData->getCallable(), $lineData); |
|
| 239 | 5 | $this->temporaryActions[] = $action; |
|
| 240 | 5 | $data[] = [ |
|
| 241 | 5 | 'renderer' => clone $columnData->getRenderer(), |
|
| 242 | 5 | 'width' => $columnData->getWidthCoeficiency(), |
|
| 243 | 5 | 'action' => $action, |
|
| 244 | ]; |
||
| 245 | } |
||
| 246 | } |
||
| 247 | 5 | $line = $this->lineFactory->create($frame->getWidth(), $data, $i); |
|
| 248 | 5 | $line->setPosition(0, $posY); |
|
| 249 | 5 | $frame->addChild($line); |
|
| 250 | 5 | $posY -= $lineHeight; |
|
| 251 | } |
||
| 252 | |||
| 253 | /* |
||
| 254 | * Handle the pager. |
||
| 255 | */ |
||
| 256 | 5 | $posY = ($frame->getHeight() -7) * -1; |
|
| 257 | 5 | $pager = $this->pagerFactory->create( |
|
| 258 | 5 | $frame->getWidth(), |
|
| 259 | 5 | $this->currentPage, |
|
| 260 | 5 | $this->dataCollection->getLastPageNumber(), |
|
| 261 | 5 | $this->actionFirstPage, |
|
| 262 | 5 | $this->actionPreviousPage, |
|
| 263 | 5 | $this->actionNextPage, |
|
| 264 | 5 | $this->actionLastPage |
|
| 265 | ); |
||
| 266 | 5 | $pager->setPosition(0, $posY); |
|
| 267 | 5 | $frame->addChild($pager); |
|
| 268 | |||
| 269 | 5 | return $frame; |
|
| 270 | } |
||
| 271 | |||
| 272 | /** |
||
| 273 | * Action callback to go to the first page. |
||
| 274 | */ |
||
| 275 | 1 | public function goToFirstPage() |
|
| 279 | |||
| 280 | /** |
||
| 281 | * Action callback to go to the previous page. |
||
| 282 | */ |
||
| 283 | 1 | public function goToPreviousPage() |
|
| 289 | |||
| 290 | /** |
||
| 291 | * Action callback to go to the next page. |
||
| 292 | */ |
||
| 293 | 3 | public function goToNextPage() |
|
| 299 | |||
| 300 | /** |
||
| 301 | * Action callback to go to the last page. |
||
| 302 | */ |
||
| 303 | 1 | public function goToLastPage() |
|
| 307 | |||
| 308 | /** |
||
| 309 | * Handle page change & refresh user window. |
||
| 310 | * |
||
| 311 | * @param $page |
||
| 312 | */ |
||
| 313 | 4 | protected function changePage($page) |
|
| 318 | } |
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.