PHP Class DVDoug\BoxPacker\Packer

Author: Doug Wright

Inheritance: implements Psr\Log\LoggerAwareInterface, use trait Psr\Log\LoggerAwareTrait

Protected Properties

Property	Type	Description
$boxes	DVDoug\BoxPacker\BoxList	List of box sizes available to pack items into
$items	ItemList	List of items to be packed

Method	Description
__construct ( )	Constructor
addBox ( DVDoug\BoxPacker\Box $box )	Add box size
addItem ( DVDoug\BoxPacker\Item $item, integer $qty = 1 )	Add item to be packed
doVolumePacking ( ) : DVDoug\BoxPacker\PackedBoxList	Pack items into boxes using the principle of largest volume item first
pack ( ) : DVDoug\BoxPacker\PackedBoxList	Pack items into boxes
setBoxes ( DVDoug\BoxPacker\BoxList $boxList )	Add a pre-prepared set of boxes all at once
setItems ( Traversable \| array $items )	Set a list of items all at once

Constructor

public __construct ( )

Add box size

public addBox ( DVDoug\BoxPacker\Box $box )
$box	DVDoug\BoxPacker\Box

Add item to be packed

public addItem ( DVDoug\BoxPacker\Item $item, integer $qty = 1 )
$item	DVDoug\BoxPacker\Item
$qty	integer

Pack items into boxes using the principle of largest volume item first

public doVolumePacking ( ) : DVDoug\BoxPacker\PackedBoxList
return	DVDoug\BoxPacker\PackedBoxList

Pack items into boxes

public pack ( ) : DVDoug\BoxPacker\PackedBoxList
return	DVDoug\BoxPacker\PackedBoxList

Add a pre-prepared set of boxes all at once

public setBoxes ( DVDoug\BoxPacker\BoxList $boxList )
$boxList	DVDoug\BoxPacker\BoxList

Set a list of items all at once

public setItems ( Traversable \| array $items )
$items	Traversable \| array

List of box sizes available to pack items into

protected BoxList,DVDoug\BoxPacker $boxes
return	DVDoug\BoxPacker\BoxList

List of items to be packed

protected ItemList,DVDoug\BoxPacker $items
return	ItemList