FM / order

/home/sharedstore/public_html/prestashop.sharedstore.ma/classes/order/

/home/sharedstore/public_html/prestashop.sharedstore.ma/classes/order

Name	Size	Mode	Actions
index.php	1375	0644	edit dl rm
Order.php	103473	0644	edit dl rm
OrderCarrier.php	7119	0644	edit dl rm
OrderCartRule.php	2771	0644	edit dl rm
OrderDetail.php	37794	0644	edit dl rm
OrderHistory.php	29548	0644	edit dl rm
OrderInvoice.php	35387	0644	edit dl rm
OrderMessage.php	2605	0644	edit dl rm
OrderPayment.php	4824	0644	edit dl rm
OrderReturn.php	11849	0644	edit dl rm
OrderReturnState.php	2359	0644	edit dl rm
OrderSlip.php	23320	0644	edit dl rm
OrderState.php	6746	0644	edit dl rm

Edit: /home/sharedstore/public_html/prestashop.sharedstore.ma/classes/order/OrderInvoice.php (35387B)

<?php
/**
 * Copyright since 2007 PrestaShop SA and Contributors
 * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is bundled with this package in the file LICENSE.md.
 * It is also available through the world-wide-web at this URL:
 * https://opensource.org/licenses/OSL-3.0
 * If you did not receive a copy of the license and are unable to
 * obtain it through the world-wide-web, please send an email
 * to license@prestashop.com so we can send you a copy immediately.
 *
 * DISCLAIMER
 *
 * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
 * versions in the future. If you wish to customize PrestaShop for your
 * needs please refer to https://devdocs.prestashop.com/ for more information.
 *
 * @author    PrestaShop SA and Contributors <contact@prestashop.com>
 * @copyright Since 2007 PrestaShop SA and Contributors
 * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
 */
class OrderInvoiceCore extends ObjectModel
{
    public const TAX_EXCL = 0;
    public const TAX_INCL = 1;
    public const DETAIL = 2;

/** @var int */
    public $id_order;

/** @var int */
    public $number;

/** @var int */
    public $delivery_number;

/** @var string */
    public $delivery_date = '0000-00-00 00:00:00';

/** @var float */
    public $total_discount_tax_excl;

/** @var float */
    public $total_discount_tax_incl;

/** @var float */
    public $total_paid_tax_excl;

/** @var float */
    public $total_paid_tax_incl;

/** @var float */
    public $total_products;

/** @var float */
    public $total_products_wt;

/** @var float */
    public $total_shipping_tax_excl;

/** @var float */
    public $total_shipping_tax_incl;

/** @var int */
    public $shipping_tax_computation_method;

/** @var float */
    public $total_wrapping_tax_excl;

/** @var float */
    public $total_wrapping_tax_incl;

/** @var string shop address */
    public $shop_address;

/** @var string note */
    public $note;

/** @var string */
    public $date_add;

/** @var array Total paid cache */
    protected static $_total_paid_cache = [];

/** @var Order|null */
    private $order;

/**
     * @see ObjectModel::$definition
     */
    public static $definition = [
        'table' => 'order_invoice',
        'primary' => 'id_order_invoice',
        'fields' => [
            'id_order' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
            'number' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId', 'required' => true],
            'delivery_number' => ['type' => self::TYPE_INT, 'validate' => 'isUnsignedId'],
            'delivery_date' => ['type' => self::TYPE_DATE, 'validate' => 'isDateFormat'],
            'total_discount_tax_excl' => ['type' => self::TYPE_FLOAT],
            'total_discount_tax_incl' => ['type' => self::TYPE_FLOAT],
            'total_paid_tax_excl' => ['type' => self::TYPE_FLOAT],
            'total_paid_tax_incl' => ['type' => self::TYPE_FLOAT],
            'total_products' => ['type' => self::TYPE_FLOAT],
            'total_products_wt' => ['type' => self::TYPE_FLOAT],
            'total_shipping_tax_excl' => ['type' => self::TYPE_FLOAT],
            'total_shipping_tax_incl' => ['type' => self::TYPE_FLOAT],
            'shipping_tax_computation_method' => ['type' => self::TYPE_INT],
            'total_wrapping_tax_excl' => ['type' => self::TYPE_FLOAT],
            'total_wrapping_tax_incl' => ['type' => self::TYPE_FLOAT],
            'shop_address' => ['type' => self::TYPE_HTML, 'validate' => 'isCleanHtml', 'size' => 4194303],
            'note' => ['type' => self::TYPE_HTML, 'size' => 4194303],
            'date_add' => ['type' => self::TYPE_DATE, 'validate' => 'isDate'],
        ],
    ];

public function add($autodate = true, $null_values = false)
    {
        $order = new Order($this->id_order);

$this->shop_address = OrderInvoice::getCurrentFormattedShopAddress($order->id_shop);

return parent::add();
    }

public function getProductsDetail()
    {
        return Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
        SELECT *, od.ecotax as od_ecotax, od.ecotax_tax_rate as od_ecotax_tax_rate
        FROM `' . _DB_PREFIX_ . 'order_detail` od
        LEFT JOIN `' . _DB_PREFIX_ . 'product` p
        ON p.id_product = od.product_id
        LEFT JOIN `' . _DB_PREFIX_ . 'product_shop` ps ON (ps.id_product = p.id_product AND ps.id_shop = od.id_shop)
        WHERE od.`id_order` = ' . (int) $this->id_order . '
        ' . ($this->id && $this->number ? ' AND od.`id_order_invoice` = ' . (int) $this->id : '') . ' ORDER BY od.`product_name`');
    }

/**
     * Returns OrderInvoice for a specific invoice number and order ID.
     * It's highly recommended to also provide an order ID, because you
     * may end up with a different invoice than you wanted.
     *
     * DO NOT CONFUSE the number with id_order_invoice, that's a different,
     * unique identifier of the invoice.
     *
     * @param string|int $invoiceNumber
     * @param int $orderId
     *
     * @return OrderInvoice|false
     */
    public static function getInvoiceByNumber($invoiceNumber, $orderId = null)
    {
        if (is_numeric($invoiceNumber)) {
            $invoiceNumber = (int) $invoiceNumber;
        } elseif (is_string($invoiceNumber)) {
            $matches = [];
            if (preg_match('/^(?:' . Configuration::get('PS_INVOICE_PREFIX', Context::getContext()->language->id) . ')\s*([0-9]+)$/i', $invoiceNumber, $matches)) {
                $invoiceNumber = $matches[1];
            }
        }
        if (!$invoiceNumber) {
            return false;
        }

$id_order_invoice = Db::getInstance(_PS_USE_SQL_SLAVE_)->getValue(
            'SELECT `id_order_invoice`
            FROM `' . _DB_PREFIX_ . 'order_invoice`
            WHERE `number` = ' . (int) $invoiceNumber . (!empty($orderId) ? ' AND `id_order` = ' . (int) $orderId : '')
        );

return $id_order_invoice ? new OrderInvoice((int) $id_order_invoice) : false;
    }

/**
     * Get order products.
     *
     * @return array Products with price, quantity (with taxe and without)
     */
    public function getProducts($products = false, $selected_products = false, $selected_qty = false)
    {
        if (!$products) {
            $products = $this->getProductsDetail();
        }

$order = new Order($this->id_order);

$result_array = [];
        foreach ($products as $row) {
            // Change qty if selected
            if ($selected_qty) {
                $row['product_quantity'] = 0;
                foreach ($selected_products as $key => $id_product) {
                    if ($row['id_order_detail'] == $id_product) {
                        $row['product_quantity'] = (int) $selected_qty[$key];
                    }
                }
                if (!$row['product_quantity']) {
                    continue;
                }
            }

$this->setProductImageInformations($row);
            $this->setProductCurrentStock($row);

$customized_datas = Product::getAllCustomizedDatas($order->id_cart, null, true, null, (int) $row['id_customization']);
            $this->setProductCustomizedDatas($row, $customized_datas);

// Add information for virtual product
            if ($row['download_hash'] && !empty($row['download_hash'])) {
                $row['filename'] = ProductDownload::getFilenameFromIdProduct((int) $row['product_id']);
                // Get the display filename
                $row['display_filename'] = ProductDownload::getFilenameFromFilename($row['filename']);
            }

$row['id_address_delivery'] = $order->id_address_delivery;

/* Ecotax */
            $round_mode = $order->round_mode;

// Use values from order_detail not from product because they are more accurate at the time the Order was made
            // and they contain the true value for combinations
            $ecotax = isset($row['od_ecotax']) ? $row['od_ecotax'] : $row['ecotax'];
            $ecotaxRate = isset($row['od_ecotax_tax_rate']) ? $row['od_ecotax_tax_rate'] : $row['ecotax_tax_rate'];

$row['ecotax_tax_excl'] = $ecotax; // alias for coherence
            $row['ecotax_tax_incl'] = $ecotax * (100 + $ecotaxRate) / 100;
            $row['ecotax_tax'] = $row['ecotax_tax_incl'] - $row['ecotax_tax_excl'];

if ($round_mode == Order::ROUND_ITEM) {
                $row['ecotax_tax_incl'] = Tools::ps_round($row['ecotax_tax_incl'], Context::getContext()->getComputingPrecision(), $round_mode);
            }

$row['total_ecotax_tax_excl'] = $row['ecotax_tax_excl'] * $row['product_quantity'];
            $row['total_ecotax_tax_incl'] = $row['ecotax_tax_incl'] * $row['product_quantity'];

$row['total_ecotax_tax'] = $row['total_ecotax_tax_incl'] - $row['total_ecotax_tax_excl'];

foreach ([
                'ecotax_tax_excl',
                'ecotax_tax_incl',
                'ecotax_tax',
                'total_ecotax_tax_excl',
                'total_ecotax_tax_incl',
                'total_ecotax_tax',
            ] as $ecotax_field) {
                $row[$ecotax_field] = Tools::ps_round($row[$ecotax_field], Context::getContext()->getComputingPrecision(), $round_mode);
            }

// Aliases
            $row['unit_price_tax_excl_including_ecotax'] = $row['unit_price_tax_excl'];
            $row['unit_price_tax_incl_including_ecotax'] = $row['unit_price_tax_incl'];
            $row['total_price_tax_excl_including_ecotax'] = $row['total_price_tax_excl'];
            $row['total_price_tax_incl_including_ecotax'] = $row['total_price_tax_incl'];

if ($customized_datas) {
                Product::addProductCustomizationPrice($row, $customized_datas);
            }
            /* Stock product */
            $result_array[(int) $row['id_order_detail']] = $row;
        }

return $result_array;
    }

protected function setProductCustomizedDatas(&$product, $customized_datas)
    {
        $product['customizedDatas'] = null;
        if (isset($customized_datas[$product['product_id']][$product['product_attribute_id']])) {
            $product['customizedDatas'] = $customized_datas[$product['product_id']][$product['product_attribute_id']];
        } else {
            $product['customizationQuantityTotal'] = 0;
        }
    }

/**
     * This method allow to add stock information on a product detail.
     *
     * @param array $product
     */
    protected function setProductCurrentStock(&$product)
    {
        if (Configuration::get('PS_ADVANCED_STOCK_MANAGEMENT')
            && (int) $product['advanced_stock_management'] == 1
            && (int) $product['id_warehouse'] > 0) {
            $product['current_stock'] = StockManagerFactory::getManager()->getProductPhysicalQuantities($product['product_id'], $product['product_attribute_id'], null, true);
        } else {
            $product['current_stock'] = '--';
        }
    }

/**
     * This method allow to add image information on a product detail.
     *
     * @param array $product
     */
    protected function setProductImageInformations(&$product)
    {
        if (isset($product['product_attribute_id']) && $product['product_attribute_id']) {
            $id_image = Db::getInstance()->getValue('
                SELECT image_shop.id_image
                FROM ' . _DB_PREFIX_ . 'product_attribute_image pai' .
                Shop::addSqlAssociation('image', 'pai', true) . '
                WHERE id_product_attribute = ' . (int) $product['product_attribute_id']);
        }

if (!isset($id_image) || !$id_image) {
            $id_image = Db::getInstance()->getValue('
                SELECT image_shop.id_image
                FROM ' . _DB_PREFIX_ . 'image i' .
                Shop::addSqlAssociation('image', 'i', true, 'image_shop.cover=1') . '
                WHERE i.id_product = ' . (int) $product['product_id']);
        }

$product['image'] = null;
        $product['image_size'] = null;

if ($id_image) {
            $product['image'] = new Image((int) $id_image);
        }
    }

/**
     * This method returns true if at least one order details uses the
     * One After Another tax computation method.
     *
     * @since 1.5
     *
     * @return bool
     */
    public function useOneAfterAnotherTaxComputationMethod()
    {
        // if one of the order details use the tax computation method the display will be different
        return Db::getInstance()->getValue('
    		SELECT od.`tax_computation_method`
    		FROM `' . _DB_PREFIX_ . 'order_detail_tax` odt
    		LEFT JOIN `' . _DB_PREFIX_ . 'order_detail` od ON (od.`id_order_detail` = odt.`id_order_detail`)
    		WHERE od.`id_order` = ' . (int) $this->id_order . '
    		AND od.`id_order_invoice` = ' . (int) $this->id . '
    		AND od.`tax_computation_method` = ' . (int) TaxCalculator::ONE_AFTER_ANOTHER_METHOD)
            || Configuration::get(
                'PS_INVOICE_TAXES_BREAKDOWN'
        );
    }

public function displayTaxBasesInProductTaxesBreakdown()
    {
        return !$this->useOneAfterAnotherTaxComputationMethod();
    }

public function getOrder()
    {
        if (!$this->order) {
            $this->order = new Order($this->id_order);
        }

return $this->order;
    }

public function getProductTaxesBreakdown($order = null)
    {
        if (!$order) {
            $order = $this->getOrder();
        }

$sum_composite_taxes = !$this->useOneAfterAnotherTaxComputationMethod();

// $breakdown will be an array with tax rates as keys and at least the columns:
        // 	- 'total_price_tax_excl'
        // 	- 'total_amount'
        $breakdown = [];

$details = $order->getProductTaxesDetails();

if ($sum_composite_taxes) {
            $grouped_details = [];
            foreach ($details as $row) {
                if ($this->id !== (int) $row['id_order_invoice']) {
                    continue;
                }
                if (!isset($grouped_details[$row['id_order_detail']])) {
                    $grouped_details[$row['id_order_detail']] = [
                        'tax_rate' => 0,
                        'total_tax_base' => 0,
                        'total_amount' => 0,
                        'id_tax' => $row['id_tax'],
                    ];
                }

$grouped_details[$row['id_order_detail']]['tax_rate'] += $row['tax_rate'];
                $grouped_details[$row['id_order_detail']]['total_tax_base'] += $row['total_tax_base'];
                $grouped_details[$row['id_order_detail']]['total_amount'] += $row['total_amount'];
            }

$details = $grouped_details;
        }

foreach ($details as $row) {
            $rate = sprintf('%.3f', $row['tax_rate']);
            if (!isset($breakdown[$rate])) {
                $breakdown[$rate] = [
                    'total_price_tax_excl' => 0,
                    'total_amount' => 0,
                    'id_tax' => $row['id_tax'],
                    'rate' => $rate,
                ];
            }

$breakdown[$rate]['total_price_tax_excl'] += $row['total_tax_base'];
            $breakdown[$rate]['total_amount'] += $row['total_amount'];
        }

foreach ($breakdown as $rate => $data) {
            $breakdown[$rate]['total_price_tax_excl'] = Tools::ps_round($data['total_price_tax_excl'], Context::getContext()->getComputingPrecision(), $order->round_mode);
            $breakdown[$rate]['total_amount'] = Tools::ps_round($data['total_amount'], Context::getContext()->getComputingPrecision(), $order->round_mode);
        }

ksort($breakdown);

return $breakdown;
    }

/**
     * Returns the shipping taxes breakdown.
     *
     * @since 1.5
     *
     * @param Order $order
     *
     * @return array
     */
    public function getShippingTaxesBreakdown($order)
    {
        // No shipping breakdown if no shipping!
        if ($this->total_shipping_tax_excl == 0) {
            return [];
        }

// No shipping breakdown if it's free!
        foreach ($order->getCartRules() as $cart_rule) {
            if ($cart_rule['free_shipping']) {
                return [];
            }
        }

$shipping_tax_amount = $this->total_shipping_tax_incl - $this->total_shipping_tax_excl;

if (Configuration::get('PS_INVOICE_TAXES_BREAKDOWN') || Configuration::get('PS_ATCP_SHIPWRAP')) {
            $shipping_breakdown = Db::getInstance()->executeS(
                'SELECT t.id_tax, t.rate, oit.amount as total_amount
                 FROM `' . _DB_PREFIX_ . 'tax` t
                 INNER JOIN `' . _DB_PREFIX_ . 'order_invoice_tax` oit ON oit.id_tax = t.id_tax
                 WHERE oit.type = "shipping" AND oit.id_order_invoice = ' . (int) $this->id
            );

$sum_of_split_taxes = 0;
            $sum_of_tax_bases = 0;
            /** @var array{id_tax: int, rate: float, total_amount: float} $row */
            foreach ($shipping_breakdown as &$row) {
                if (Configuration::get('PS_ATCP_SHIPWRAP')) {
                    $row['total_tax_excl'] = Tools::ps_round($row['total_amount'] / $row['rate'] * 100, Context::getContext()->getComputingPrecision(), $this->getOrder()->round_mode);
                    $sum_of_tax_bases += $row['total_tax_excl'];
                } else {
                    $row['total_tax_excl'] = $this->total_shipping_tax_excl;
                }

$row['total_amount'] = Tools::ps_round($row['total_amount'], Context::getContext()->getComputingPrecision(), $this->getOrder()->round_mode);
                $sum_of_split_taxes += $row['total_amount'];
            }
            unset($row);

$delta_amount = $shipping_tax_amount - $sum_of_split_taxes;

if ($delta_amount != 0) {
                Tools::spreadAmount($delta_amount, Context::getContext()->getComputingPrecision(), $shipping_breakdown, 'total_amount');
            }

$delta_base = $this->total_shipping_tax_excl - $sum_of_tax_bases;

if ($delta_base != 0) {
                Tools::spreadAmount($delta_base, Context::getContext()->getComputingPrecision(), $shipping_breakdown, 'total_tax_excl');
            }
        } else {
            $shipping_breakdown = [
                [
                    'total_tax_excl' => $this->total_shipping_tax_excl,
                    'rate' => $order->carrier_tax_rate,
                    'total_amount' => $shipping_tax_amount,
                    'id_tax' => null,
                ],
            ];
        }

return $shipping_breakdown;
    }

/**
     * Returns the wrapping taxes breakdown.
     *
     * @return array
     */
    public function getWrappingTaxesBreakdown()
    {
        if ($this->total_wrapping_tax_excl == 0) {
            return [];
        }

$wrapping_tax_amount = $this->total_wrapping_tax_incl - $this->total_wrapping_tax_excl;

$wrapping_breakdown = Db::getInstance()->executeS(
            'SELECT t.id_tax, t.rate, oit.amount as total_amount
            FROM `' . _DB_PREFIX_ . 'tax` t
            INNER JOIN `' . _DB_PREFIX_ . 'order_invoice_tax` oit ON oit.id_tax = t.id_tax
            WHERE oit.type = "wrapping" AND oit.id_order_invoice = ' . (int) $this->id
        );

$sum_of_split_taxes = 0;
        $sum_of_tax_bases = 0;
        $total_tax_rate = 0;
        /** @var array{id_tax: int, rate: float, total_amount: float} $row */
        foreach ($wrapping_breakdown as &$row) {
            if (Configuration::get('PS_ATCP_SHIPWRAP')) {
                $row['total_tax_excl'] = Tools::ps_round($row['total_amount'] / $row['rate'] * 100, Context::getContext()->getComputingPrecision(), $this->getOrder()->round_mode);
                $sum_of_tax_bases += $row['total_tax_excl'];
            } else {
                $row['total_tax_excl'] = $this->total_wrapping_tax_excl;
            }

$row['total_amount'] = Tools::ps_round($row['total_amount'], Context::getContext()->getComputingPrecision(), $this->getOrder()->round_mode);
            $sum_of_split_taxes += $row['total_amount'];
            $total_tax_rate += (float) $row['rate'];
        }
        unset($row);

$delta_amount = $wrapping_tax_amount - $sum_of_split_taxes;

if ($delta_amount != 0) {
            Tools::spreadAmount($delta_amount, Context::getContext()->getComputingPrecision(), $wrapping_breakdown, 'total_amount');
        }

$delta_base = $this->total_wrapping_tax_excl - $sum_of_tax_bases;

if ($delta_base != 0) {
            Tools::spreadAmount($delta_base, Context::getContext()->getComputingPrecision(), $wrapping_breakdown, 'total_tax_excl');
        }

if (!Configuration::get('PS_INVOICE_TAXES_BREAKDOWN') && !Configuration::get('PS_ATCP_SHIPWRAP')) {
            $wrapping_breakdown = [
                [
                    'total_tax_excl' => $this->total_wrapping_tax_excl,
                    'rate' => $total_tax_rate,
                    'total_amount' => $wrapping_tax_amount,
                ],
            ];
        }

return $wrapping_breakdown;
    }

/**
     * Returns the ecotax taxes breakdown.
     *
     * @since 1.5
     *
     * @return array
     */
    public function getEcoTaxTaxesBreakdown()
    {
        $result = Db::getInstance()->executeS('
        SELECT `ecotax_tax_rate` as `rate`, SUM(`ecotax` * `product_quantity`) as `ecotax_tax_excl`, SUM(`ecotax` * `product_quantity`) as `ecotax_tax_incl`
        FROM `' . _DB_PREFIX_ . 'order_detail`
        WHERE `id_order` = ' . (int) $this->id_order . '
        AND `id_order_invoice` = ' . (int) $this->id . '
        GROUP BY `ecotax_tax_rate`');

$priceDisplayPrecision = Context::getContext()->getComputingPrecision();
        $taxes = [];
        /** @var array{rate: float, ecotax_tax_excl: float, ecotax_tax_incl: float} $row */
        foreach ($result as $row) {
            if ($row['ecotax_tax_excl'] > 0) {
                $row['ecotax_tax_incl'] = Tools::ps_round($row['ecotax_tax_excl'] + ($row['ecotax_tax_excl'] * $row['rate'] / 100), $priceDisplayPrecision);
                $row['ecotax_tax_excl'] = Tools::ps_round($row['ecotax_tax_excl'], $priceDisplayPrecision);
                $taxes[] = $row;
            }
        }

return $taxes;
    }

/**
     * Returns all the order invoice that match the date interval.
     *
     * @since 1.5
     *
     * @param string $date_from
     * @param string $date_to
     *
     * @return array collection of OrderInvoice
     */
    public static function getByDateInterval($date_from, $date_to)
    {
        $order_invoice_list = Db::getInstance()->executeS('
            SELECT oi.*
            FROM `' . _DB_PREFIX_ . 'order_invoice` oi
            LEFT JOIN `' . _DB_PREFIX_ . 'orders` o ON (o.`id_order` = oi.`id_order`)
            WHERE DATE_ADD(oi.date_add, INTERVAL -1 DAY) <= \'' . pSQL($date_to) . '\'
            AND oi.date_add >= \'' . pSQL($date_from) . '\'
            ' . Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o') . '
            AND oi.number > 0
            ORDER BY oi.date_add ASC
        ');

return ObjectModel::hydrateCollection('OrderInvoice', $order_invoice_list);
    }

/**
     * @since 1.5.0.3
     *
     * @param int $id_order_state
     *
     * @return array collection of OrderInvoice
     */
    public static function getByStatus($id_order_state)
    {
        $order_invoice_list = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
            SELECT oi.*
            FROM `' . _DB_PREFIX_ . 'order_invoice` oi
            LEFT JOIN `' . _DB_PREFIX_ . 'orders` o ON (o.`id_order` = oi.`id_order`)
            WHERE ' . (int) $id_order_state . ' = o.current_state
            ' . Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o') . '
            AND oi.number > 0
            ORDER BY oi.`date_add` ASC
        ');

return ObjectModel::hydrateCollection('OrderInvoice', $order_invoice_list);
    }

/**
     * @since 1.5.0.3
     *
     * @param string $date_from
     * @param string $date_to
     *
     * @return array collection of invoice
     */
    public static function getByDeliveryDateInterval($date_from, $date_to)
    {
        $order_invoice_list = Db::getInstance()->executeS('
            SELECT oi.*
            FROM `' . _DB_PREFIX_ . 'order_invoice` oi
            LEFT JOIN `' . _DB_PREFIX_ . 'orders` o ON (o.`id_order` = oi.`id_order`)
            WHERE DATE_ADD(oi.delivery_date, INTERVAL -1 DAY) <= \'' . pSQL($date_to) . '\'
            AND oi.delivery_date >= \'' . pSQL($date_from) . '\'
            ' . Shop::addSqlRestriction(Shop::SHARE_ORDER, 'o') . '
            ORDER BY oi.delivery_date ASC
        ');

return ObjectModel::hydrateCollection('OrderInvoice', $order_invoice_list);
    }

/**
     * @since 1.5
     *
     * @param int $id_order_invoice
     */
    public static function getCarrier($id_order_invoice)
    {
        $carrier = false;
        if ($id_carrier = OrderInvoice::getCarrierId($id_order_invoice)) {
            $carrier = new Carrier((int) $id_carrier);
        }

return $carrier;
    }

/**
     * @since 1.5
     *
     * @param int $id_order_invoice
     */
    public static function getCarrierId($id_order_invoice)
    {
        $sql = 'SELECT `id_carrier`
                FROM `' . _DB_PREFIX_ . 'order_carrier`
                WHERE `id_order_invoice` = ' . (int) $id_order_invoice;

return Db::getInstance()->getValue($sql);
    }

/**
     * @param int $id
     *
     * @return OrderInvoice
     *
     * @throws PrestaShopException
     */
    public static function retrieveOneById($id)
    {
        $order_invoice = new OrderInvoice($id);
        if (!Validate::isLoadedObject($order_invoice)) {
            throw new PrestaShopException('Can\'t load Order Invoice object for id: ' . $id);
        }

return $order_invoice;
    }

/**
     * Amounts of payments.
     *
     * @since 1.5.0.2
     *
     * @return float Total paid
     */
    public function getTotalPaid()
    {
        $cache_id = 'order_invoice_paid_' . (int) $this->id;
        if (!Cache::isStored($cache_id)) {
            $amount = 0;
            $payments = OrderPayment::getByInvoiceId($this->id);
            foreach ($payments as $payment) {
                /* @var OrderPayment $payment */
                $amount += $payment->amount;
            }
            Cache::store($cache_id, $amount);

return $amount;
        }

return Cache::retrieve($cache_id);
    }

/**
     * Rest Paid.
     *
     * @since 1.5.0.2
     *
     * @return float Rest Paid
     */
    public function getRestPaid()
    {
        if (!$this->number) {
            return 0;
        }

return round($this->total_paid_tax_incl + $this->getSiblingTotal() - $this->getTotalPaid(), 2);
    }

/**
     * Return collection of order invoice object linked to the payments of the current order invoice object.
     *
     * @since 1.5.0.14
     *
     * @return PrestaShopCollection|array Collection of OrderInvoice or empty array
     */
    public function getSibling()
    {
        $query = new DbQuery();
        $query->select('oip2.id_order_invoice');
        $query->from('order_invoice_payment', 'oip1');
        $query->innerJoin(
            'order_invoice_payment',
            'oip2',
            'oip2.id_order_payment = oip1.id_order_payment
                AND oip2.id_order_invoice <> oip1.id_order_invoice
                AND oip2.id_order = oip1.id_order'
        );
        $query->where('oip1.id_order_invoice = ' . (int) $this->id);

$invoices = Db::getInstance()->executeS($query);
        if (!$invoices) {
            return [];
        }

$invoice_list = [];
        foreach ($invoices as $invoice) {
            $invoice_list[] = $invoice['id_order_invoice'];
        }

$payments = new PrestaShopCollection('OrderInvoice');
        $payments->where('id_order_invoice', 'IN', $invoice_list);

return $payments;
    }

/**
     * Return total to paid of sibling invoices.
     *
     * @param int $mod TAX_EXCL, TAX_INCL, DETAIL
     *
     * @return float|array
     *
     * @since 1.5.0.14
     */
    public function getSiblingTotal($mod = OrderInvoice::TAX_INCL)
    {
        $query = new DbQuery();
        $query->select('SUM(oi.total_paid_tax_incl) as total_paid_tax_incl, SUM(oi.total_paid_tax_excl) as total_paid_tax_excl');
        $query->from('order_invoice_payment', 'oip1');
        $query->innerJoin(
            'order_invoice_payment',
            'oip2',
            'oip2.id_order_payment = oip1.id_order_payment
                AND oip2.id_order_invoice <> oip1.id_order_invoice
                AND oip2.id_order = oip1.id_order'
        );
        $query->leftJoin(
            'order_invoice',
            'oi',
            'oi.id_order_invoice = oip2.id_order_invoice'
        );
        $query->where('oip1.id_order_invoice = ' . (int) $this->id);

$row = Db::getInstance()->getRow($query);

switch ($mod) {
            case OrderInvoice::TAX_EXCL:
                return $row['total_paid_tax_excl'];
            case OrderInvoice::TAX_INCL:
                return $row['total_paid_tax_incl'];
            default:
                return $row;
        }
    }

/**
     * Get global rest to paid
     *    This method will return something different of the method getRestPaid if
     *    there is an other invoice linked to the payments of the current invoice.
     *
     * @since 1.5.0.13
     */
    public function getGlobalRestPaid()
    {
        static $cache;

if (!isset($cache[$this->id])) {
            $res = Db::getInstance()->getRow('
            SELECT SUM(sub.paid) paid, SUM(sub.to_paid) to_paid
            FROM (
                SELECT
                    op.amount as paid, SUM(oi.total_paid_tax_incl) to_paid
                FROM `' . _DB_PREFIX_ . 'order_invoice_payment` oip1
                INNER JOIN `' . _DB_PREFIX_ . 'order_invoice_payment` oip2
                    ON oip2.id_order_payment = oip1.id_order_payment
                INNER JOIN `' . _DB_PREFIX_ . 'order_invoice` oi
                    ON oi.id_order_invoice = oip2.id_order_invoice
                INNER JOIN `' . _DB_PREFIX_ . 'order_payment` op
                    ON op.id_order_payment = oip2.id_order_payment
                WHERE oip1.id_order_invoice = ' . (int) $this->id . '
                GROUP BY op.id_order_payment
            ) sub');
            $cache[$this->id] = round($res['to_paid'] - $res['paid'], 2);
        }

return $cache[$this->id];
    }

/**
     * @since 1.5.0.2
     *
     * @return bool Is paid ?
     */
    public function isPaid()
    {
        return $this->getTotalPaid() == $this->total_paid_tax_incl;
    }

/**
     * @since 1.5.0.2
     *
     * @return PrestaShopCollection Collection of Order payment
     */
    public function getOrderPaymentCollection()
    {
        return OrderPayment::getByInvoiceId($this->id);
    }

/**
     * Get the formatted number of invoice.
     *
     * @since 1.5.0.2
     *
     * @param int $id_lang for invoice_prefix
     *
     * @return string
     */
    public function getInvoiceNumberFormatted($id_lang, $id_shop = null)
    {
        $invoice_formatted_number = Hook::exec('actionInvoiceNumberFormatted', [
            get_class($this) => $this,
            'id_lang' => (int) $id_lang,
            'id_shop' => (int) $id_shop,
            'number' => (int) $this->number,
        ]);

if (!empty($invoice_formatted_number)) {
            return $invoice_formatted_number;
        }

$format = '%1$s%2$06d';

if (Configuration::get('PS_INVOICE_USE_YEAR')) {
            $format = Configuration::get('PS_INVOICE_YEAR_POS') ? '%1$s%3$s/%2$06d' : '%1$s%2$06d/%3$s';
        }

return sprintf($format, Configuration::get('PS_INVOICE_PREFIX', (int) $id_lang, null, (int) $id_shop), $this->number, date('Y', strtotime($this->date_add)));
    }

public function saveCarrierTaxCalculator(array $taxes_amount)
    {
        $is_correct = true;
        foreach ($taxes_amount as $id_tax => $amount) {
            $sql = 'INSERT INTO `' . _DB_PREFIX_ . 'order_invoice_tax` (`id_order_invoice`, `type`, `id_tax`, `amount`)
                    VALUES (' . (int) $this->id . ', \'shipping\', ' . (int) $id_tax . ', ' . (float) $amount . ')';

$is_correct &= Db::getInstance()->execute($sql);
        }

return $is_correct;
    }

public function saveWrappingTaxCalculator(array $taxes_amount)
    {
        $is_correct = true;
        foreach ($taxes_amount as $id_tax => $amount) {
            $sql = 'INSERT INTO `' . _DB_PREFIX_ . 'order_invoice_tax` (`id_order_invoice`, `type`, `id_tax`, `amount`)
                    VALUES (' . (int) $this->id . ', \'wrapping\', ' . (int) $id_tax . ', ' . (float) $amount . ')';

$is_correct &= Db::getInstance()->execute($sql);
        }

return $is_correct;
    }

public static function getCurrentFormattedShopAddress($id_shop = null)
    {
        $address = new Address();
        $address->company = Configuration::get('PS_SHOP_NAME', null, null, $id_shop);
        $address->address1 = Configuration::get('PS_SHOP_ADDR1', null, null, $id_shop);
        $address->address2 = Configuration::get('PS_SHOP_ADDR2', null, null, $id_shop);
        $address->postcode = Configuration::get('PS_SHOP_CODE', null, null, $id_shop);
        $address->city = Configuration::get('PS_SHOP_CITY', null, null, $id_shop);
        $address->phone = Configuration::get('PS_SHOP_PHONE', null, null, $id_shop);
        $address->id_country = (int) Configuration::get('PS_SHOP_COUNTRY_ID', null, null, $id_shop);

return AddressFormat::generateAddress($address, [], '<br />', ' ');
    }

/**
     * This method is used to fix shop addresses that cannot be fixed during upgrade process
     * (because uses the whole environnement of PS classes that is not available during upgrade).
     * This method should execute once on an upgraded PrestaShop to fix all OrderInvoices in one shot.
     * This method is triggered once during a (non bulk) creation of a PDF from an OrderInvoice that is not fixed yet.
     *
     * @since 1.6.1.1
     */
    public static function fixAllShopAddresses()
    {
        $shop_ids = Shop::getShops(false, null, true);
        $db = Db::getInstance();
        foreach ($shop_ids as $id_shop) {
            $address = OrderInvoice::getCurrentFormattedShopAddress($id_shop);
            $escaped_address = $db->escape($address, true, true);

$db->execute('UPDATE `' . _DB_PREFIX_ . 'order_invoice` INNER JOIN `' . _DB_PREFIX_ . 'orders` USING (`id_order`)
                SET `shop_address` = \'' . $escaped_address . '\' WHERE `shop_address` IS NULL AND `id_shop` = ' . $id_shop);
        }
    }
}

cmd: