Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/SeoBundle/Helper/OrderConverter.php

<?php

namespace Kunstmaan\SeoBundle\Helper;

/**
 * Class OrderConverter
 *
 * @package Kunstmaan\SeoBundle\Helper
 */
class OrderConverter
{

    /**
     * Converts an Order object to an Array.
     *
     * @param Order $order
     *
     * @return array

Consider making the return type a bit more specific; maybe use array<string,string|array>.

     */
    public function convert(Order $order)
    {
        $orderItems = array();

        foreach ($order->orderItems as $orderItem) {
            /** @var $orderItem OrderItem */
            $orderItems[] = array(
                'sku' => $orderItem->getSKU(),
                'quantity' => $this->formatNumber($orderItem->getQuantity()),
                'unit_price' => $this->formatNumber($orderItem->getUnitPrice()),
                'taxes' => $this->formatNumber($orderItem->getTaxes()),
                'category_or_variation' => $orderItem->getCategoryOrVariation(),
                'name' => $orderItem->getName(),
            );
        }

        return array(
            'transaction_id' => $order->getTransactionID(),
            'store_name' => $order->getStoreName(),
            'total' => $this->formatNumber($order->getTotal()),
            'taxes_total' => $this->formatNumber($order->getTaxesTotal()),
            'shipping_total' => $this->formatNumber($order->getShippingTotal()),
            'city' => $order->getCity(),
            'state_or_province' => $order->getStateOrProvince(),
            'country' => $order->getCountry(),
            'order_items' => $orderItems
        );
    }

    /**
     * Formats a number to a format google an easily comprehend.
     *
     * @param $number number
     *
     * @return string
     */
    protected function formatNumber($number)
    {
        return number_format($number, 2, '.', '');
    }
}