2. The Order and OrderItem¶

2.1. Order basics¶

Each order has 2 main identifiers, an ID and a human-friendly number. You can access those by calling ->getId() and ->getNumber() respectively. The number is mutable, so you can change it by calling ->setNumber('E001') on the order instance.

<?php

$order->getId();
$order->getNumber();

$order->setNumber('E001');

2.2. Confirmation status¶

To check whether the order is confirmed or not, you can use the isConfirmed() method, which returns a true/false value. To change that status, you can use the confirmation setter, setConfirmed(false). All orders are confirmed by default, unless you enabled the e-mail confirmation feature. Order also can contain a confirmation token, accessible by the appropriate getter and setter.

<?php

if ($order->isConfirmed()) {
    echo 'This one is confirmed, great!';
}

2.3. Order totals¶

An order has 3 basic totals, which are all persisted together with the order.

The first total is the items total, it is calculated as the sum of all item totals.

The second total is the adjustments total, you can read more about this in next chapter.

<?php

echo $order->getItemsTotal(); // 1900.
echo $order->getAdjustmentsTotal(); // -250.

$order->calculateTotal();
echo $order->getTotal(); // 1650.

The main order total is a sum of the previously mentioned values. You can access the order total value using the ->getTotal() method. Recalculation of totals can happen by calling ->calculateTotal() method, using the simplest possible math. It will also update the item totals.

2.4. Items management¶

The collection of items (Implementing the Doctrine\Common\Collections\Collection interface) can be obtained using the ->getItems(). To add or remove items, you can simply use the addItem and removeItem methods.

<?php

// $item1 and $item2 are instances of OrderItemInterface.
$order
    ->addItem($item)
    ->removeItem($item2)
;

2.5. OrderItem basics¶

An order item model has only the id as identifier, also it has the order to which it belongs, accessible via ->getOrder() method.

The sellable object can be retrieved and set, using the following setter and getter - ->getProduct() & ->setVariant(ProductVariantInterface $variant).

<?php

$item->setVariant($book);

Just like for the order, the total is available via the same method, but the unit price is accessible using the ->getUnitPrice() Each item also can calculate its total, using the quantity (->getQuantity()) and the unit price.

<?php

$item = $itemRepository->createNew();
$item
    ->setVariant($book)
    ->setUnitPrice(2000)
    ->setQuantity(4)
    ->calculateTotal()
;

echo $item->getTotal(); // 8000.

An OrderItem can also hold adjustments.