DVDoug\BoxPacker\OrientatedItem

Complexity

Total Complexity

12

Size/Duplication

Total Lines	108
Duplicated Lines	0 %

Test Coverage

Coverage

71.88%

Importance

Changes	7
Bugs	3	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	getDepth()	0	3	1
A	getWidth()	0	3	1
A	__construct()	0	10	1
A	isSameDimensions()	0	10	2
A	getLength()	0	3	1
A	getSurfaceFootprint()	0	3	1
A	isStable()	0	5	2
A	getItem()	0	3	1
A	jsonSerialize()	0	7	1
A	__toString()	0	3	1

<?php
/**
 * Box packing (3D bin packing, knapsack problem).
 *
 * @author Doug Wright
 */
declare(strict_types=1);

namespace DVDoug\BoxPacker;

use JsonSerializable;
use Stringable;

use function atan;
use function min;
use function sort;

/**
 * An item to be packed.
 */
class OrientatedItem implements JsonSerializable, Stringable
{
    protected readonly int $surfaceFootprint;

    /**
     * @var array<string, bool>
     */
    protected static array $stabilityCache = [];

    /**
     * @var int[]
     */
    protected array $dimensionsAsArray;

    public function __construct(
        protected Item $item,
        protected int $width,
        protected int $length,
        protected int $depth
    ) {
        $this->surfaceFootprint = $width * $length;

The property surfaceFootprint is declared read-only in DVDoug\BoxPacker\OrientatedItem.

        $this->dimensionsAsArray = [$width, $length, $depth];
        sort($this->dimensionsAsArray);
    }

    /**
     * Item.
     */
    public function getItem(): Item
    {
        return $this->item;
    }

    /**
     * Item width in mm in it's packed orientation.
     */
    public function getWidth(): int
    {
        return $this->width;
    }

    /**
     * Item length in mm in it's packed orientation.
     */
    public function getLength(): int
    {
        return $this->length;
    }

    /**
     * Item depth in mm in it's packed orientation.
     */
    public function getDepth(): int
    {
        return $this->depth;
    }

    /**
     * Calculate the surface footprint of the current orientation.
     */
    public function getSurfaceFootprint(): int
    {
        return $this->surfaceFootprint;
    }

    /**
     * Is this item stable (low centre of gravity), calculated as if the tipping point is >15 degrees.
     *
     * N.B. Assumes equal weight distribution.
     */
    public function isStable(): bool
    {
        $cacheKey = $this->width . '|' . $this->length . '|' . $this->depth;

        return static::$stabilityCache[$cacheKey] ?? (static::$stabilityCache[$cacheKey] = atan(min($this->length, $this->width) / ($this->depth ?: 1)) > 0.261);
    }

    /**
     * Is the supplied item the same size as this one?
     *
     * @internal
     */
    public function isSameDimensions(Item $item): bool
    {
        if ($item === $this->item) {
            return true;
        }

        $itemDimensions = [$item->getWidth(), $item->getLength(), $item->getDepth()];
        sort($itemDimensions);

        return $this->dimensionsAsArray === $itemDimensions;
    }

    public function jsonSerialize(): array
    {
        return [
            'item' => $this->item,
            'width' => $this->width,
            'length' => $this->length,
            'depth' => $this->depth,
        ];
    }

    public function __toString(): string
    {
        return $this->width . '|' . $this->length . '|' . $this->depth;
    }
}