dvdoug /
BoxPacker
| Conditions | 13 |
| Paths | 10 |
| Total Lines | 82 |
| Code Lines | 52 |
| Lines | 0 |
| Ratio | 0 % |
| Tests | 53 |
| CRAP Score | 13 |
| Changes | 5 | ||
| Bugs | 0 | Features | 0 |
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.
There are several approaches to avoid long parameter lists:
| 1 | <?php |
||
| 73 | 92 | public function packLayer(ItemList &$items, PackedItemList $packedItemList, int $startX, int $startY, int $startZ, int $widthForLayer, int $lengthForLayer, int $depthForLayer, int $guidelineLayerDepth, bool $considerStability): PackedLayer |
|
| 74 | { |
||
| 75 | 92 | $layer = new PackedLayer(); |
|
| 76 | 92 | $x = $startX; |
|
| 77 | 92 | $y = $startY; |
|
| 78 | 92 | $z = $startZ; |
|
| 79 | 92 | $rowLength = 0; |
|
| 80 | 92 | $prevItem = null; |
|
| 81 | 92 | $skippedItems = []; |
|
| 82 | 92 | $remainingWeightAllowed = $this->box->getMaxWeight() - $this->box->getEmptyWeight() - $packedItemList->getWeight(); |
|
| 83 | |||
| 84 | 92 | while ($items->count() > 0) { |
|
| 85 | 92 | $itemToPack = $items->extract(); |
|
| 86 | |||
| 87 | // skip items that will never fit e.g. too heavy |
||
| 88 | 92 | if ($itemToPack->getWeight() > $remainingWeightAllowed) { |
|
| 89 | 18 | continue; |
|
| 90 | } |
||
| 91 | |||
| 92 | 90 | $orientatedItem = $this->orientatedItemFactory->getBestOrientation($itemToPack, $prevItem, $items, $widthForLayer - $x, $lengthForLayer - $y, $depthForLayer, $rowLength, $x, $y, $z, $packedItemList, $considerStability); |
|
| 93 | |||
| 94 | 90 | if ($orientatedItem instanceof OrientatedItem) { |
|
| 95 | 89 | $packedItem = PackedItem::fromOrientatedItem($orientatedItem, $x, $y, $z); |
|
| 96 | 89 | $layer->insert($packedItem); |
|
| 97 | 89 | $packedItemList->insert($packedItem); |
|
| 98 | |||
| 99 | 89 | $rowLength = max($rowLength, $packedItem->getLength()); |
|
| 100 | 89 | $prevItem = $orientatedItem; |
|
| 101 | |||
| 102 | // Figure out if we can stack items on top of this rather than side by side |
||
| 103 | // e.g. when we've packed a tall item, and have just put a shorter one next to it. |
||
| 104 | 89 | $stackableDepth = ($guidelineLayerDepth ?: $layer->getDepth()) - $packedItem->getDepth(); |
|
| 105 | 89 | if ($stackableDepth > 0) { |
|
| 106 | 30 | $stackedLayer = $this->packLayer($items, $packedItemList, $x, $y, $z + $packedItem->getDepth(), $x + $packedItem->getWidth(), $y + $packedItem->getLength(), $stackableDepth, $stackableDepth, $considerStability); |
|
| 107 | 30 | $layer->merge($stackedLayer); |
|
| 108 | } |
||
| 109 | |||
| 110 | 89 | $x += $packedItem->getWidth(); |
|
| 111 | 89 | $remainingWeightAllowed = $this->box->getMaxWeight() - $this->box->getEmptyWeight() - $packedItemList->getWeight(); // remember may have packed additional items |
|
| 112 | |||
| 113 | 89 | if ($items->count() === 0 && $skippedItems) { |
|
| 114 | 16 | $items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true); |
|
| 115 | 16 | $skippedItems = []; |
|
| 116 | } |
||
| 117 | 89 | continue; |
|
| 118 | } |
||
| 119 | |||
| 120 | 81 | if (!$this->beStrictAboutItemOrdering && $items->count() > 0) { // skip for now, move on to the next item |
|
| 121 | 70 | $this->logger->debug("doesn't fit, skipping for now"); |
|
| 122 | 70 | $skippedItems[] = $itemToPack; |
|
| 123 | // abandon here if next item is the same, no point trying to keep going. Last time is not skipped, need that to trigger appropriate reset logic |
||
| 124 | 70 | while ($items->count() > 1 && self::isSameDimensions($itemToPack, $items->top())) { |
|
| 125 | 32 | $skippedItems[] = $items->extract(); |
|
| 126 | } |
||
| 127 | 70 | continue; |
|
| 128 | } |
||
| 129 | |||
| 130 | 81 | if ($x > $startX) { |
|
| 131 | // Having now placed items, there is space *within the same row* along the length. Pack into that. |
||
| 132 | 80 | $this->logger->debug('No more fit in width wise, packing along remaining length'); |
|
| 133 | 80 | $layer->merge($this->packLayer($items, $packedItemList, $x, $y + $rowLength, $z, $widthForLayer, $lengthForLayer - $rowLength, $depthForLayer, $layer->getDepth(), $considerStability)); |
|
| 134 | |||
| 135 | 80 | $this->logger->debug('No more fit in width wise, resetting for new row'); |
|
| 136 | 80 | $y += $rowLength; |
|
| 137 | 80 | $x = $startX; |
|
| 138 | 80 | $rowLength = 0; |
|
| 139 | 80 | $skippedItems[] = $itemToPack; |
|
| 140 | 80 | $items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true); |
|
| 141 | 80 | $skippedItems = []; |
|
| 142 | 80 | $prevItem = null; |
|
| 143 | 80 | continue; |
|
| 144 | } |
||
| 145 | |||
| 146 | 71 | $this->logger->debug('no items fit, so starting next vertical layer'); |
|
| 147 | 71 | $skippedItems[] = $itemToPack; |
|
| 148 | |||
| 149 | 71 | $items = ItemList::fromArray(array_merge($skippedItems, iterator_to_array($items)), true); |
|
| 150 | |||
| 151 | 71 | return $layer; |
|
| 152 | } |
||
| 153 | |||
| 154 | 91 | return $layer; |
|
| 155 | } |
||
| 173 |
Loading history...