Your IP : 216.73.217.95
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Sales\Model\Order\Invoice;
use Magento\Framework\Api\AttributeValueFactory;
use Magento\Sales\Api\Data\InvoiceItemInterface;
use Magento\Sales\Model\AbstractModel;
/**
* @api
* @method float getBaseWeeeTaxRowDisposition()
* @method \Magento\Sales\Model\Order\Invoice\Item setBaseWeeeTaxRowDisposition(float $value)
* @method float getWeeeTaxAppliedRowAmount()
* @method \Magento\Sales\Model\Order\Invoice\Item setWeeeTaxAppliedRowAmount(float $value)
* @method float getBaseWeeeTaxAppliedAmount()
* @method \Magento\Sales\Model\Order\Invoice\Item setBaseWeeeTaxAppliedAmount(float $value)
* @method float getWeeeTaxRowDisposition()
* @method \Magento\Sales\Model\Order\Invoice\Item setWeeeTaxRowDisposition(float $value)
* @method float getBaseWeeeTaxDisposition()
* @method \Magento\Sales\Model\Order\Invoice\Item setBaseWeeeTaxDisposition(float $value)
* @method float getWeeeTaxAppliedAmount()
* @method \Magento\Sales\Model\Order\Invoice\Item setWeeeTaxAppliedAmount(float $value)
* @method float getWeeeTaxDisposition()
* @method \Magento\Sales\Model\Order\Invoice\Item setWeeeTaxDisposition(float $value)
* @method float getBaseWeeeTaxAppliedRowAmnt()
* @method \Magento\Sales\Model\Order\Invoice\Item setBaseWeeeTaxAppliedRowAmnt(float $value)
* @method string getWeeeTaxApplied()
* @method \Magento\Sales\Model\Order\Invoice\Item setWeeeTaxApplied(string $value)
* @SuppressWarnings(PHPMD.ExcessivePublicCount)
* @SuppressWarnings(PHPMD.CouplingBetweenObjects)
* @since 100.0.2
*/
class Item extends AbstractModel implements InvoiceItemInterface
{
/**
* @var string
*/
protected $_eventPrefix = 'sales_invoice_item';
/**
* @var string
*/
protected $_eventObject = 'invoice_item';
/**
* @var \Magento\Sales\Model\Order\Item|null
*/
protected $_orderItem = null;
/**
* @var \Magento\Sales\Model\Order\ItemFactory
*/
protected $_orderItemFactory;
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory
* @param AttributeValueFactory $customAttributeFactory
* @param \Magento\Sales\Model\Order\ItemFactory $orderItemFactory
* @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
* @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
* @param array $data
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory,
AttributeValueFactory $customAttributeFactory,
\Magento\Sales\Model\Order\ItemFactory $orderItemFactory,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = []
) {
parent::__construct(
$context,
$registry,
$extensionFactory,
$customAttributeFactory,
$resource,
$resourceCollection,
$data
);
$this->_orderItemFactory = $orderItemFactory;
}
/**
* Initialize resource model
*
* @return void
*/
protected function _construct()
{
$this->_init(\Magento\Sales\Model\ResourceModel\Order\Invoice\Item::class);
}
/**
* Declare invoice instance
*
* @param \Magento\Sales\Api\Data\InvoiceInterface $invoice
* @return $this
*/
public function setInvoice(\Magento\Sales\Api\Data\InvoiceInterface $invoice)
{
return $this->setData(self::INVOICE, $invoice);
}
/**
* Retrieve invoice instance
*
* @codeCoverageIgnore
*
* @return \Magento\Sales\Model\Order\Invoice
*/
public function getInvoice()
{
return $this->getData(self::INVOICE);
}
/**
* Declare order item instance
*
* @param \Magento\Sales\Model\Order\Item $item
* @return $this
*/
public function setOrderItem(\Magento\Sales\Model\Order\Item $item)
{
$this->_orderItem = $item;
$this->setOrderItemId($item->getId());
return $this;
}
/**
* Retrieve order item instance
*
* @return \Magento\Sales\Model\Order\Item
*/
public function getOrderItem()
{
if ($this->_orderItem === null) {
if ($this->getInvoice()) {
$this->_orderItem = $this->getInvoice()->getOrder()->getItemById($this->getOrderItemId());
} else {
$this->_orderItem = $this->_orderItemFactory->create()->load($this->getOrderItemId());
}
}
return $this->_orderItem;
}
/**
* Declare qty
*
* @codeCoverageIgnore
*
* @param float $qty
* @return $this
*/
public function setQty($qty)
{
return $this->setData(self::QTY, $qty);
}
/**
* Applying qty to order item
*
* @return $this
*/
public function register()
{
$orderItem = $this->getOrderItem();
$orderItem->setQtyInvoiced($orderItem->getQtyInvoiced() + $this->getQty());
$orderItem->setTaxInvoiced($orderItem->getTaxInvoiced() + $this->getTaxAmount());
$orderItem->setBaseTaxInvoiced($orderItem->getBaseTaxInvoiced() + $this->getBaseTaxAmount());
$orderItem->setDiscountTaxCompensationInvoiced(
$orderItem->getDiscountTaxCompensationInvoiced() + $this->getDiscountTaxCompensationAmount()
);
$orderItem->setBaseDiscountTaxCompensationInvoiced(
$orderItem->getBaseDiscountTaxCompensationInvoiced() + $this->getBaseDiscountTaxCompensationAmount()
);
$orderItem->setDiscountInvoiced($orderItem->getDiscountInvoiced() + $this->getDiscountAmount());
$orderItem->setBaseDiscountInvoiced($orderItem->getBaseDiscountInvoiced() + $this->getBaseDiscountAmount());
$orderItem->setRowInvoiced($orderItem->getRowInvoiced() + $this->getRowTotal());
$orderItem->setBaseRowInvoiced($orderItem->getBaseRowInvoiced() + $this->getBaseRowTotal());
return $this;
}
/**
* Cancelling invoice item
*
* @return $this
*/
public function cancel()
{
$orderItem = $this->getOrderItem();
$orderItem->setQtyInvoiced($orderItem->getQtyInvoiced() - $this->getQty());
$orderItem->setTaxInvoiced($orderItem->getTaxInvoiced() - $this->getTaxAmount());
$orderItem->setBaseTaxInvoiced($orderItem->getBaseTaxInvoiced() - $this->getBaseTaxAmount());
$orderItem->setDiscountTaxCompensationInvoiced(
$orderItem->getDiscountTaxCompensationInvoiced() - $this->getDiscountTaxCompensationAmount()
);
$orderItem->setBaseDiscountTaxCompensationInvoiced(
$orderItem->getBaseDiscountTaxCompensationInvoiced() - $this->getBaseDiscountTaxCompensationAmount()
);
$orderItem->setDiscountInvoiced($orderItem->getDiscountInvoiced() - $this->getDiscountAmount());
$orderItem->setBaseDiscountInvoiced($orderItem->getBaseDiscountInvoiced() - $this->getBaseDiscountAmount());
$orderItem->setRowInvoiced($orderItem->getRowInvoiced() - $this->getRowTotal());
$orderItem->setBaseRowInvoiced($orderItem->getBaseRowInvoiced() - $this->getBaseRowTotal());
return $this;
}
/**
* Invoice item row total calculation
*
* @return $this
*/
public function calcRowTotal()
{
$invoice = $this->getInvoice();
$orderItem = $this->getOrderItem();
$orderItemQty = $orderItem->getQtyOrdered();
$rowTotal = $orderItem->getRowTotal() - $orderItem->getRowInvoiced();
$baseRowTotal = $orderItem->getBaseRowTotal() - $orderItem->getBaseRowInvoiced();
$rowTotalInclTax = $orderItem->getRowTotalInclTax();
$baseRowTotalInclTax = $orderItem->getBaseRowTotalInclTax();
if (!$this->isLast()) {
$availableQty = $orderItemQty - $orderItem->getQtyInvoiced();
$rowTotal = $invoice->roundPrice($rowTotal / $availableQty * $this->getQty());
$baseRowTotal = $invoice->roundPrice($baseRowTotal / $availableQty * $this->getQty(), 'base');
}
$this->setRowTotal($rowTotal);
$this->setBaseRowTotal($baseRowTotal);
if ($rowTotalInclTax && $baseRowTotalInclTax) {
$this->setRowTotalInclTax(
$invoice->roundPrice($rowTotalInclTax / $orderItemQty * $this->getQty(), 'including')
);
$this->setBaseRowTotalInclTax(
$invoice->roundPrice($baseRowTotalInclTax / $orderItemQty * $this->getQty(), 'including_base')
);
}
return $this;
}
/**
* Checking if the item is last
*
* @return bool
*/
public function isLast()
{
if ((string)(double)$this->getQty() == (string)(double)$this->getOrderItem()->getQtyToInvoice()) {
return true;
}
return false;
}
//@codeCoverageIgnoreStart
/**
* Returns additional_data
*
* @return string|null
*/
public function getAdditionalData()
{
return $this->getData(InvoiceItemInterface::ADDITIONAL_DATA);
}
/**
* Returns base_cost
*
* @return float|null
*/
public function getBaseCost()
{
return $this->getData(InvoiceItemInterface::BASE_COST);
}
/**
* Returns base_discount_amount
*
* @return float|null
*/
public function getBaseDiscountAmount()
{
return $this->getData(InvoiceItemInterface::BASE_DISCOUNT_AMOUNT);
}
/**
* Returns base_discount_tax_compensation_amount
*
* @return float|null
*/
public function getBaseDiscountTaxCompensationAmount()
{
return $this->getData(InvoiceItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT);
}
/**
* Returns base_price
*
* @return float|null
*/
public function getBasePrice()
{
return $this->getData(InvoiceItemInterface::BASE_PRICE);
}
/**
* Returns base_price_incl_tax
*
* @return float|null
*/
public function getBasePriceInclTax()
{
return $this->getData(InvoiceItemInterface::BASE_PRICE_INCL_TAX);
}
/**
* Returns base_row_total
*
* @return float|null
*/
public function getBaseRowTotal()
{
return $this->getData(InvoiceItemInterface::BASE_ROW_TOTAL);
}
/**
* Returns base_row_total_incl_tax
*
* @return float|null
*/
public function getBaseRowTotalInclTax()
{
return $this->getData(InvoiceItemInterface::BASE_ROW_TOTAL_INCL_TAX);
}
/**
* Returns base_tax_amount
*
* @return float|null
*/
public function getBaseTaxAmount()
{
return $this->getData(InvoiceItemInterface::BASE_TAX_AMOUNT);
}
/**
* Returns description
*
* @return string|null
*/
public function getDescription()
{
return $this->getData(InvoiceItemInterface::DESCRIPTION);
}
/**
* Returns discount_amount
*
* @return float|null
*/
public function getDiscountAmount()
{
return $this->getData(InvoiceItemInterface::DISCOUNT_AMOUNT);
}
/**
* Returns discount_tax_compensation_amount
*
* @return float|null
*/
public function getDiscountTaxCompensationAmount()
{
return $this->getData(InvoiceItemInterface::DISCOUNT_TAX_COMPENSATION_AMOUNT);
}
/**
* Returns name
*
* @return string|null
*/
public function getName()
{
return $this->getData(InvoiceItemInterface::NAME);
}
/**
* Returns order_item_id
*
* @return int
*/
public function getOrderItemId()
{
return $this->getData(InvoiceItemInterface::ORDER_ITEM_ID);
}
/**
* Returns parent_id
*
* @return int|null
*/
public function getParentId()
{
return $this->getData(InvoiceItemInterface::PARENT_ID);
}
/**
* Returns price
*
* @return float|null
*/
public function getPrice()
{
return $this->getData(InvoiceItemInterface::PRICE);
}
/**
* Returns price_incl_tax
*
* @return float|null
*/
public function getPriceInclTax()
{
return $this->getData(InvoiceItemInterface::PRICE_INCL_TAX);
}
/**
* Returns product_id
*
* @return int|null
*/
public function getProductId()
{
return $this->getData(InvoiceItemInterface::PRODUCT_ID);
}
/**
* Returns qty
*
* @return float
*/
public function getQty()
{
return $this->getData(InvoiceItemInterface::QTY);
}
/**
* Returns row_total
*
* @return float|null
*/
public function getRowTotal()
{
return $this->getData(InvoiceItemInterface::ROW_TOTAL);
}
/**
* Returns row_total_incl_tax
*
* @return float|null
*/
public function getRowTotalInclTax()
{
return $this->getData(InvoiceItemInterface::ROW_TOTAL_INCL_TAX);
}
/**
* Returns sku
*
* @return string
*/
public function getSku()
{
return $this->getData(InvoiceItemInterface::SKU);
}
/**
* Returns tax_amount
*
* @return float|null
*/
public function getTaxAmount()
{
return $this->getData(InvoiceItemInterface::TAX_AMOUNT);
}
/**
* {@inheritdoc}
*/
public function setParentId($id)
{
return $this->setData(InvoiceItemInterface::PARENT_ID, $id);
}
/**
* {@inheritdoc}
*/
public function setBasePrice($price)
{
return $this->setData(InvoiceItemInterface::BASE_PRICE, $price);
}
/**
* {@inheritdoc}
*/
public function setTaxAmount($amount)
{
return $this->setData(InvoiceItemInterface::TAX_AMOUNT, $amount);
}
/**
* {@inheritdoc}
*/
public function setBaseRowTotal($amount)
{
return $this->setData(InvoiceItemInterface::BASE_ROW_TOTAL, $amount);
}
/**
* {@inheritdoc}
*/
public function setDiscountAmount($amount)
{
return $this->setData(InvoiceItemInterface::DISCOUNT_AMOUNT, $amount);
}
/**
* {@inheritdoc}
*/
public function setRowTotal($amount)
{
return $this->setData(InvoiceItemInterface::ROW_TOTAL, $amount);
}
/**
* {@inheritdoc}
*/
public function setBaseDiscountAmount($amount)
{
return $this->setData(InvoiceItemInterface::BASE_DISCOUNT_AMOUNT, $amount);
}
/**
* {@inheritdoc}
*/
public function setPriceInclTax($amount)
{
return $this->setData(InvoiceItemInterface::PRICE_INCL_TAX, $amount);
}
/**
* {@inheritdoc}
*/
public function setBaseTaxAmount($amount)
{
return $this->setData(InvoiceItemInterface::BASE_TAX_AMOUNT, $amount);
}
/**
* {@inheritdoc}
*/
public function setBasePriceInclTax($amount)
{
return $this->setData(InvoiceItemInterface::BASE_PRICE_INCL_TAX, $amount);
}
/**
* {@inheritdoc}
*/
public function setBaseCost($baseCost)
{
return $this->setData(InvoiceItemInterface::BASE_COST, $baseCost);
}
/**
* {@inheritdoc}
*/
public function setPrice($price)
{
return $this->setData(InvoiceItemInterface::PRICE, $price);
}
/**
* {@inheritdoc}
*/
public function setBaseRowTotalInclTax($amount)
{
return $this->setData(InvoiceItemInterface::BASE_ROW_TOTAL_INCL_TAX, $amount);
}
/**
* {@inheritdoc}
*/
public function setRowTotalInclTax($amount)
{
return $this->setData(InvoiceItemInterface::ROW_TOTAL_INCL_TAX, $amount);
}
/**
* {@inheritdoc}
*/
public function setProductId($id)
{
return $this->setData(InvoiceItemInterface::PRODUCT_ID, $id);
}
/**
* {@inheritdoc}
*/
public function setOrderItemId($id)
{
return $this->setData(InvoiceItemInterface::ORDER_ITEM_ID, $id);
}
/**
* {@inheritdoc}
*/
public function setAdditionalData($additionalData)
{
return $this->setData(InvoiceItemInterface::ADDITIONAL_DATA, $additionalData);
}
/**
* {@inheritdoc}
*/
public function setDescription($description)
{
return $this->setData(InvoiceItemInterface::DESCRIPTION, $description);
}
/**
* {@inheritdoc}
*/
public function setSku($sku)
{
return $this->setData(InvoiceItemInterface::SKU, $sku);
}
/**
* {@inheritdoc}
*/
public function setName($name)
{
return $this->setData(InvoiceItemInterface::NAME, $name);
}
/**
* {@inheritdoc}
*/
public function setDiscountTaxCompensationAmount($amount)
{
return $this->setData(InvoiceItemInterface::DISCOUNT_TAX_COMPENSATION_AMOUNT, $amount);
}
/**
* {@inheritdoc}
*/
public function setBaseDiscountTaxCompensationAmount($amount)
{
return $this->setData(InvoiceItemInterface::BASE_DISCOUNT_TAX_COMPENSATION_AMOUNT, $amount);
}
/**
* {@inheritdoc}
*
* @return \Magento\Sales\Api\Data\InvoiceItemExtensionInterface|null
*/
public function getExtensionAttributes()
{
return $this->_getExtensionAttributes();
}
/**
* {@inheritdoc}
*
* @param \Magento\Sales\Api\Data\InvoiceItemExtensionInterface $extensionAttributes
* @return $this
*/
public function setExtensionAttributes(\Magento\Sales\Api\Data\InvoiceItemExtensionInterface $extensionAttributes)
{
return $this->_setExtensionAttributes($extensionAttributes);
}
//@codeCoverageIgnoreEnd
}