Merge pull request #238 from magento-mpi/pull-request

[MPI] Define Public API + Bugs

app/code/Magento/Checkout/Block/Cart/Shipping.php

@@ -34,7 +34,7 @@ class Shipping extends \Magento\Checkout\Block\Cart\AbstractCart
     protected $_directoryBlock;
 
     /**
-     * @var \Magento\Quote\Model\Quote\Address\CarrierFactoryInterface
+     * @var \Magento\Shipping\Model\CarrierFactoryInterface
      */
     protected $_carrierFactory;
 
@@ -48,7 +48,7 @@ class Shipping extends \Magento\Checkout\Block\Cart\AbstractCart
      * @param \Magento\Customer\Model\Session $customerSession
      * @param \Magento\Checkout\Model\Session $checkoutSession
      * @param \Magento\Directory\Block\Data $directoryBlock
-     * @param \Magento\Quote\Model\Quote\Address\CarrierFactoryInterface $carrierFactory
+     * @param \Magento\Shipping\Model\CarrierFactoryInterface $carrierFactory
      * @param PriceCurrencyInterface $priceCurrency
      * @param array $data
      */
@@ -57,7 +57,7 @@ public function __construct(
         \Magento\Customer\Model\Session $customerSession,
         \Magento\Checkout\Model\Session $checkoutSession,
         \Magento\Directory\Block\Data $directoryBlock,
-        \Magento\Quote\Model\Quote\Address\CarrierFactoryInterface $carrierFactory,
+        \Magento\Shipping\Model\CarrierFactoryInterface $carrierFactory,
         PriceCurrencyInterface $priceCurrency,
         array $data = []
     ) {

app/code/Magento/Checkout/composer.json

@@ -10,6 +10,7 @@
         "magento/module-customer": "0.74.0-beta4",
         "magento/module-catalog": "0.74.0-beta4",
         "magento/module-payment": "0.74.0-beta4",
+        "magento/module-shipping": "0.74.0-beta4",
         "magento/module-tax": "0.74.0-beta4",
         "magento/module-directory": "0.74.0-beta4",
         "magento/module-eav": "0.74.0-beta4",

app/code/Magento/Dhl/Model/Carrier.php

@@ -295,10 +295,10 @@ protected function _getDefaultValue($origValue, $pathToValue)
     /**
      * Collect and get rates
      *
-     * @param RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return bool|Result|null
      */
-    public function collectRates(RateRequest $request)
+    public function collectRates(\Magento\Framework\Object $request)
     {
         if (!$this->getConfigFlag($this->_activeFlag)) {
             return false;
@@ -1255,10 +1255,10 @@ protected function _doShipmentRequest(\Magento\Framework\Object $request)
     /**
      * Processing additional validation to check is carrier applicable.
      *
-     * @param RateRequest $request
-     * @return $this|Error|boolean
+     * @param \Magento\Framework\Object $request
+     * @return $this|\Magento\Framework\Object|boolean
      */
-    public function proccessAdditionalValidation(RateRequest $request)
+    public function proccessAdditionalValidation(\Magento\Framework\Object $request)
     {
         //Skip by item validation if there is no items in request
         if (!count($this->getAllItems($request))) {

app/code/Magento/Fedex/Model/Carrier.php

@@ -236,10 +236,10 @@ protected function _createTrackSoapClient()
     /**
      * Collect and get rates
      *
-     * @param RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return Result|bool|null
      */
-    public function collectRates(RateRequest $request)
+    public function collectRates(\Magento\Framework\Object $request)
     {
         if (!$this->getConfigFlag($this->_activeFlag)) {
             return false;

app/code/Magento/OfflineShipping/Model/Carrier/Flatrate.php

@@ -55,12 +55,12 @@ public function __construct(
     }
 
     /**
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return Result|bool
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      */
-    public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)
+    public function collectRates(\Magento\Framework\Object $request)
     {
         if (!$this->getConfigFlag('active')) {
             return false;

app/code/Magento/OfflineShipping/Model/Carrier/Freeshipping.php

@@ -58,10 +58,10 @@ public function __construct(
     /**
      * FreeShipping Rates Collector
      *
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return \Magento\Shipping\Model\Rate\Result|bool
      */
-    public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)
+    public function collectRates(\Magento\Framework\Object $request)
     {
         if (!$this->getConfigFlag('active')) {
             return false;

app/code/Magento/OfflineShipping/Model/Carrier/Pickup.php

@@ -50,11 +50,11 @@ public function __construct(
     }
 
     /**
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return \Magento\Shipping\Model\Rate\Result
      * @SuppressWarnings(PHPMD.UnusedLocalVariable)
      */
-    public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)
+    public function collectRates(\Magento\Framework\Object $request)
     {
         if (!$this->getConfigFlag('active')) {
             return false;

app/code/Magento/OfflineShipping/Model/Carrier/Tablerate.php

@@ -72,13 +72,13 @@ public function __construct(
     }
 
     /**
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return \Magento\Shipping\Model\Rate\Result
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      * @SuppressWarnings(PHPMD.NPathComplexity)
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
-    public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)
+    public function collectRates(\Magento\Framework\Object $request)
     {
         if (!$this->getConfigFlag('active')) {
             return false;

app/code/Magento/Payment/Model/Cart.php

@@ -75,7 +75,7 @@ class Cart
     /**
      * @param \Magento\Payment\Model\Cart\SalesModel\Factory $salesModelFactory
      * @param \Magento\Framework\Event\ManagerInterface $eventManager
-     * @param \Magento\Sales\Model\Order|\Magento\Quote\Model\Quote $salesModel
+     * @param \Magento\Quote\Api\Data\CartInterface $salesModel
      */
     public function __construct(
         \Magento\Payment\Model\Cart\SalesModel\Factory $salesModelFactory,
@@ -91,6 +91,7 @@ public function __construct(
      * Return payment cart sales model
      *
      * @return \Magento\Payment\Model\Cart\SalesModel\SalesModelInterface
+     * @api
      */
     public function getSalesModel()
     {
@@ -102,6 +103,7 @@ public function getSalesModel()
      *
      * @param float $taxAmount
      * @return void
+     * @api
      */
     public function addTax($taxAmount)
     {
@@ -113,6 +115,7 @@ public function addTax($taxAmount)
      *
      * @param float $taxAmount
      * @return void
+     * @api
      */
     public function setTax($taxAmount)
     {
@@ -123,6 +126,7 @@ public function setTax($taxAmount)
      * Get tax amount
      *
      * @return float
+     * @api
      */
     public function getTax()
     {
@@ -134,6 +138,7 @@ public function getTax()
      *
      * @param float $discountAmount
      * @return void
+     * @api
      */
     public function addDiscount($discountAmount)
     {
@@ -145,6 +150,7 @@ public function addDiscount($discountAmount)
      *
      * @param float $discountAmount
      * @return void
+     * @api
      */
     public function setDiscount($discountAmount)
     {
@@ -155,6 +161,7 @@ public function setDiscount($discountAmount)
      * Get discount amount
      *
      * @return float
+     * @api
      */
     public function getDiscount()
     {
@@ -166,6 +173,7 @@ public function getDiscount()
      *
      * @param float $shippingAmount
      * @return void
+     * @api
      */
     public function addShipping($shippingAmount)
     {
@@ -177,6 +185,7 @@ public function addShipping($shippingAmount)
      *
      * @param float $shippingAmount
      * @return void
+     * @api
      */
     public function setShipping($shippingAmount)
     {
@@ -187,6 +196,7 @@ public function setShipping($shippingAmount)
      * Get shipping amount
      *
      * @return float
+     * @api
      */
     public function getShipping()
     {
@@ -198,6 +208,7 @@ public function getShipping()
      *
      * @param float $subtotalAmount
      * @return void
+     * @api
      */
     public function addSubtotal($subtotalAmount)
     {
@@ -208,6 +219,7 @@ public function addSubtotal($subtotalAmount)
      * Get subtotal amount
      *
      * @return float
+     * @api
      */
     public function getSubtotal()
     {
@@ -222,6 +234,7 @@ public function getSubtotal()
      * @param float $amount
      * @param string|null $identifier
      * @return void
+     * @api
      */
     public function addCustomItem($name, $qty, $amount, $identifier = null)
     {
@@ -232,6 +245,7 @@ public function addCustomItem($name, $qty, $amount, $identifier = null)
      * Get all cart items
      *
      * @return array
+     * @api
      */
     public function getAllItems()
     {
@@ -243,6 +257,7 @@ public function getAllItems()
      * Get shipping, tax, subtotal and discount amounts all together
      *
      * @return array
+     * @api
      */
     public function getAmounts()
     {
@@ -255,6 +270,7 @@ public function getAmounts()
      * Specify that shipping should be transferred as cart item
      *
      * @return void
+     * @api
      */
     public function setTransferShippingAsItem()
     {
@@ -265,6 +281,7 @@ public function setTransferShippingAsItem()
      * Specify that discount should be transferred as cart item
      *
      * @return void
+     * @api
      */
     public function setTransferDiscountAsItem()
     {

app/code/Magento/Payment/Model/Cart/SalesModel/Factory.php

@@ -26,7 +26,7 @@ public function __construct(\Magento\Framework\ObjectManagerInterface $objectMan
     /**
      * Wrap sales model with Magento\Payment\Model\Cart\SalesModel\SalesModelInterface
      *
-     * @param \Magento\Sales\Model\Order|\Magento\Quote\Model\Quote $salesModel
+     * @param \Magento\Quote\Api\Data\CartInterface $salesModel
      * @return \Magento\Payment\Model\Cart\SalesModel\SalesModelInterface
      * @throws \InvalidArgumentException
      */

app/code/Magento/Payment/Model/Cart/SalesModel/SalesModelInterface.php

@@ -14,26 +14,31 @@ interface SalesModelInterface
      * Get all items from shopping sales model
      *
      * @return array
+     * @api
      */
     public function getAllItems();
 
     /**
      * @return float|null
+     * @api
      */
     public function getBaseSubtotal();
 
     /**
      * @return float|null
+     * @api
      */
     public function getBaseTaxAmount();
 
     /**
      * @return float|null
+     * @api
      */
     public function getBaseShippingAmount();
 
     /**
      * @return float|null
+     * @api
      */
     public function getBaseDiscountAmount();
 
@@ -43,13 +48,15 @@ public function getBaseDiscountAmount();
      * @param string $key
      * @param mixed $args
      * @return mixed
+     * @api
      */
     public function getDataUsingMethod($key, $args = null);
 
     /**
      * Return object that contains tax related fields
      *
-     * @return \Magento\Sales\Model\Order|\Magento\Quote\Model\Quote\Address
+     * @return \Magento\Sales\Api\Data\OrderInterface|\Magento\Quote\Api\Data\AddressInterface
+     * @api
      */
     public function getTaxContainer();
 }

app/code/Magento/Payment/Model/Checks/PaymentMethodChecksInterface.php

@@ -14,6 +14,7 @@ interface PaymentMethodChecksInterface
      * Retrieve payment method code
      *
      * @return string
+     * @api
      */
     public function getCode();
 
@@ -22,13 +23,15 @@ public function getCode();
      * Can be used in admin
      *
      * @return bool
+     * @api
      */
     public function canUseInternal();
 
     /**
      * Can be used in regular checkout
      *
      * @return bool
+     * @api
      */
     public function canUseCheckout();
 
@@ -37,6 +40,7 @@ public function canUseCheckout();
      *
      * @param string $country
      * @return bool
+     * @api
      */
     public function canUseForCountry($country);
 
@@ -45,6 +49,7 @@ public function canUseForCountry($country);
      *
      * @param string $currencyCode
      * @return bool
+     * @api
      */
     public function canUseForCurrency($currencyCode);
 
@@ -55,6 +60,7 @@ public function canUseForCurrency($currencyCode);
      * @param int|string|null|\Magento\Store\Model\Store $storeId
      *
      * @return mixed
+     * @api
      */
     public function getConfigData($field, $storeId = null);
 }