<?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)
 */

namespace PrestaShop\PrestaShop\Adapter\Order\Refund;

use OrderDetail;

/**
 * Container of all the necessary information for an order refund
 */
class OrderRefundSummary
{
    /**
     * @var OrderDetail[]
     */
    private $orderDetails;

    /**
     * @var array
     */
    private $productRefunds;

    /**
     * @var float
     */
    private $refundedAmount;

    /**
     * @var float
     */
    private $refundedShipping;

    /**
     * @var float
     */
    private $voucherAmount;

    /**
     * @var bool
     */
    private $voucherChosen;

    /**
     * @var bool
     */
    private $isTaxIncluded;

    /**
     * @var int
     */
    private $precision;

    /**
     * @param array $orderDetails
     * @param array $productRefunds
     * @param float $refundedAmount
     * @param float $refundedShipping
     * @param float $voucherAmount
     * @param bool $voucherChosen
     * @param bool $isTaxIncluded
     * @param int $precision
     */
    public function __construct(
        array $orderDetails,
        array $productRefunds,
        float $refundedAmount,
        float $refundedShipping,
        float $voucherAmount,
        bool $voucherChosen,
        bool $isTaxIncluded,
        int $precision
    ) {
        $this->orderDetails = $orderDetails;
        $this->productRefunds = $productRefunds;
        $this->refundedAmount = $refundedAmount;
        $this->refundedShipping = $refundedShipping;
        $this->voucherAmount = $voucherAmount;
        $this->voucherChosen = $voucherChosen;
        $this->isTaxIncluded = $isTaxIncluded;
        $this->precision = $precision;
    }

    /**
     * @return OrderDetail[]
     */
    public function getOrderDetails(): array
    {
        return $this->orderDetails;
    }

    /**
     * @return array
     */
    public function getProductRefunds(): array
    {
        return $this->productRefunds;
    }

    /**
     * @return float
     */
    public function getRefundedAmount(): float
    {
        return $this->refundedAmount;
    }

    /**
     * @return float
     */
    public function getRefundedShipping(): float
    {
        return $this->refundedShipping;
    }

    /**
     * @return float
     */
    public function getVoucherAmount(): float
    {
        return $this->voucherAmount;
    }

    /**
     * @return bool
     */
    public function isVoucherChosen(): bool
    {
        return $this->voucherChosen;
    }

    /**
     * @return bool
     */
    public function isTaxIncluded(): bool
    {
        return $this->isTaxIncluded;
    }

    /**
     * @return int
     */
    public function getPrecision(): int
    {
        return $this->precision;
    }

    /**
     * @param int $orderDetailId
     *
     * @return OrderDetail|null
     */
    public function getOrderDetailById(int $orderDetailId): ?OrderDetail
    {
        return isset($this->orderDetails[$orderDetailId]) ? $this->orderDetails[$orderDetailId] : null;
    }
}