|
1 |
| -# Purchase Unit |
| 1 | +# PurchaseUnit |
2 | 2 |
|
3 |
| -coming soon. |
| 3 | +See https://developer.paypal.com/docs/api/orders/v2/#definition-purchase_unit. |
4 | 4 |
|
| 5 | +## Methods |
| 6 | + |
| 7 | +### PurchaseUnit::__construct() |
| 8 | + |
| 9 | +Creates a new PurchaseUnit instance. |
| 10 | + |
| 11 | +#### Signature |
| 12 | + |
| 13 | +```php |
| 14 | +public function __construct(AmountBreakdown $amount); |
| 15 | +``` |
| 16 | +#### Example |
| 17 | + |
| 18 | +```php |
| 19 | +$amount = AmountBreakdown::of('100.00', 'CAD'); |
| 20 | +$purchase_unit = new PurchaseUnit($amount); |
| 21 | +``` |
| 22 | + |
| 23 | +### PurchaseUnit::addItems() |
| 24 | + |
| 25 | +Pushes a new item or array of items into the items array of PurchaseUnit. |
| 26 | + |
| 27 | +#### Signature |
| 28 | + |
| 29 | +```php |
| 30 | +public function addItems(array $items): self; |
| 31 | +``` |
| 32 | + |
| 33 | +#### Example |
| 34 | + |
| 35 | +```php |
| 36 | +$amount = AmountBreakdown::of('100', 'CAD'); |
| 37 | +$purchase_unit = new PurchaseUnit($amount); |
| 38 | + |
| 39 | +$items = array_map(function ($index) { |
| 40 | + return Item::create("Item $index", '100.00', 'CAD', $index); |
| 41 | +}, [1, 2, 3]); |
| 42 | + |
| 43 | + |
| 44 | +$purchase_unit->addItems($items); |
| 45 | + |
| 46 | +``` |
| 47 | + |
| 48 | +### PurchaseUnit::addItem() |
| 49 | + |
| 50 | +Pushes a new item into the items array of PurchaseUnit. |
| 51 | + |
| 52 | +#### Signature |
| 53 | + |
| 54 | +```php |
| 55 | +public function addItem(Item $item): self; |
| 56 | +``` |
| 57 | + |
| 58 | +#### Example |
| 59 | + |
| 60 | +```php |
| 61 | +$amount = AmountBreakdown::of('100', 'CAD'); |
| 62 | +$purchase_unit = new PurchaseUnit($amount); |
| 63 | + |
| 64 | +$purchase_unit->addItem(Item::create('Item 1', '100.00', 'CAD', 2)); |
| 65 | +``` |
| 66 | + |
| 67 | +### PurchaseUnit::getItems() |
| 68 | + |
| 69 | +Returns the items array of PurchaseUnit. |
| 70 | + |
| 71 | +#### Signature |
| 72 | + |
| 73 | +```php |
| 74 | +public function getItems(): array; |
| 75 | +``` |
| 76 | + |
| 77 | +#### Example |
| 78 | + |
| 79 | +```php |
| 80 | +$amount = AmountBreakdown::of('100', 'CAD'); |
| 81 | +$purchase_unit = new PurchaseUnit($amount); |
| 82 | + |
| 83 | +$purchase_unit->addItem(Item::create('Item 1', '100.00', 'CAD', 2)); |
| 84 | +$purchase_unit->addItem(Item::create('Item 2', '100.00', 'CAD', 2)); |
| 85 | + |
| 86 | +$purchase_unit->getItems(); |
| 87 | +``` |
| 88 | +### PurchaseUnit::getAmount() |
| 89 | + |
| 90 | +Returns the amount breakdown of PurchaseUnit. |
| 91 | + |
| 92 | +#### Signature |
| 93 | + |
| 94 | +```php |
| 95 | +public function getAmount(): AmountBreakdown; |
| 96 | +``` |
| 97 | + |
| 98 | +#### Example |
| 99 | + |
| 100 | +```php |
| 101 | +$amount = AmountBreakdown::of('100', 'CAD'); |
| 102 | +$purchase_unit = new PurchaseUnit($amount); |
| 103 | + |
| 104 | +$amount = $purchaseUnit->getAmount(); |
| 105 | +``` |
0 commit comments