MAGETWO-32628: Define Public API - MPI (CS)

Dell- · Dell- · commit 3d8dfb8a8cb4 · 2015-04-09T21:24:55.000+03:00
diff --git a/app/code/Magento/Checkout/Block/Cart/Shipping.php b/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 = []
     ) {
diff --git a/app/code/Magento/Dhl/Model/Carrier.php b/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))) {
diff --git a/app/code/Magento/Fedex/Model/Carrier.php b/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;
diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Flatrate.php b/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;
diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Freeshipping.php b/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;
diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Pickup.php b/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;
diff --git a/app/code/Magento/OfflineShipping/Model/Carrier/Tablerate.php b/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;
diff --git a/app/code/Magento/Payment/Model/Cart.php b/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,
diff --git a/app/code/Magento/Payment/Model/Cart/SalesModel/Factory.php b/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
      */
diff --git a/app/code/Magento/Payment/Model/Cart/SalesModel/SalesModelInterface.php b/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();
 }
diff --git a/app/code/Magento/Payment/Model/Method/AbstractMethod.php b/app/code/Magento/Payment/Model/Method/AbstractMethod.php
@@ -506,7 +506,7 @@ public function getInfoBlockType()
     /**
      * Retrieve payment information model object
      *
-     * @return \Magento\Payment\Model\Info
+     * @return \Magento\Payment\Model\InfoInterface
      * @throws \Magento\Framework\Exception\LocalizedException
      * @api
      */
@@ -799,9 +799,7 @@ public function prepareSave()
     /**
      * Check whether payment method can be used
      *
-     * TODO: payment method instance is not supposed to know about quote
-     *
-     * @param \Magento\Quote\Model\Quote|null $quote
+     * @param \Magento\Quote\Api\Data\CartInterface|null $quote
      * @return bool
      */
     public function isAvailable($quote = null)
diff --git a/app/code/Magento/Payment/Model/Method/Cc.php b/app/code/Magento/Payment/Model/Method/Cc.php
@@ -362,7 +362,7 @@ public function validateCcNumOther($ccNumber)
     /**
      * Check whether there are CC types set in configuration
      *
-     * @param \Magento\Quote\Model\Quote|null $quote
+     * @param \Magento\Quote\Api\Data\CartInterface|null $quote
      * @return bool
      */
     public function isAvailable($quote = null)
diff --git a/app/code/Magento/Payment/Model/MethodList.php b/app/code/Magento/Payment/Model/MethodList.php
@@ -33,11 +33,11 @@ public function __construct(
     }
 
     /**
-     * @param \Magento\Quote\Model\Quote $quote
+     * @param \Magento\Quote\Api\Data\CartInterface $quote
      * @return \Magento\Payment\Model\MethodInterface[]
      * @api
      */
-    public function getAvailableMethods(\Magento\Quote\Model\Quote $quote = null)
+    public function getAvailableMethods(\Magento\Quote\Api\Data\CartInterface $quote = null)
     {
         $store = $quote ? $quote->getStoreId() : null;
         $methods = [];
@@ -55,10 +55,10 @@ public function getAvailableMethods(\Magento\Quote\Model\Quote $quote = null)
      * Check payment method model
      *
      * @param \Magento\Payment\Model\MethodInterface $method
-     * @param \Magento\Quote\Model\Quote $quote
+     * @param \Magento\Quote\Api\Data\CartInterface $quote
      * @return bool
      */
-    protected function _canUseMethod($method, \Magento\Quote\Model\Quote $quote)
+    protected function _canUseMethod($method, \Magento\Quote\Api\Data\CartInterface $quote)
     {
         return $this->methodSpecificationFactory->create(
             [
diff --git a/app/code/Magento/Quote/Model/Quote/Address.php b/app/code/Magento/Quote/Model/Quote/Address.php
@@ -248,7 +248,7 @@ class Address extends \Magento\Customer\Model\Address\AbstractAddress implements
      * @param \Magento\Quote\Model\Quote\Address\Total\CollectorFactory $totalCollectorFactory
      * @param Address\TotalFactory $addressTotalFactory
      * @param \Magento\Framework\Object\Copy $objectCopyService
-     * @param Address\CarrierFactoryInterface $carrierFactory
+     * @param \Magento\Shipping\Model\CarrierFactoryInterface $carrierFactory
      * @param Address\Validator $validator
      * @param \Magento\Customer\Model\Address\Mapper $addressMapper
      * @param \Magento\Framework\Model\Resource\AbstractResource $resource
@@ -280,7 +280,7 @@ public function __construct(
         \Magento\Quote\Model\Quote\Address\Total\CollectorFactory $totalCollectorFactory,
         \Magento\Quote\Model\Quote\Address\TotalFactory $addressTotalFactory,
         \Magento\Framework\Object\Copy $objectCopyService,
-        \Magento\Quote\Model\Quote\Address\CarrierFactoryInterface $carrierFactory,
+        \Magento\Shipping\Model\CarrierFactoryInterface $carrierFactory,
         Address\Validator $validator,
         \Magento\Customer\Model\Address\Mapper $addressMapper,
         \Magento\Framework\Model\Resource\AbstractResource $resource = null,
diff --git a/app/code/Magento/Quote/Model/Resource/Quote/Address/Rate/Collection.php b/app/code/Magento/Quote/Model/Resource/Quote/Address/Rate/Collection.php
@@ -24,7 +24,7 @@ class Collection extends \Magento\Framework\Model\Resource\Db\Collection\Abstrac
      * @param \Psr\Log\LoggerInterface $logger
      * @param \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy
      * @param \Magento\Framework\Event\ManagerInterface $eventManager
-     * @param \Magento\Quote\Model\Quote\Address\CarrierFactoryInterface $carrierFactory
+     * @param \Magento\Shipping\Model\CarrierFactoryInterface $carrierFactory
      * @param \Zend_Db_Adapter_Abstract $connection
      * @param \Magento\Framework\Model\Resource\Db\AbstractDb $resource
      */
@@ -33,7 +33,7 @@ public function __construct(
         \Psr\Log\LoggerInterface $logger,
         \Magento\Framework\Data\Collection\Db\FetchStrategyInterface $fetchStrategy,
         \Magento\Framework\Event\ManagerInterface $eventManager,
-        \Magento\Quote\Model\Quote\Address\CarrierFactoryInterface $carrierFactory,
+        \Magento\Shipping\Model\CarrierFactoryInterface $carrierFactory,
         $connection = null,
         \Magento\Framework\Model\Resource\Db\AbstractDb $resource = null
     ) {
diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrier.php
@@ -8,10 +8,12 @@
 
 namespace Magento\Shipping\Model\Carrier;
 
-use Magento\Quote\Model\Quote\Address\AbstractCarrierInterface;
 use Magento\Quote\Model\Quote\Address\RateResult\Error;
 use Magento\Shipping\Model\Shipment\Request;
 
+/**
+ * Class AbstractCarrier
+ */
 abstract class AbstractCarrier extends \Magento\Framework\Object implements AbstractCarrierInterface
 {
     /**
@@ -137,6 +139,7 @@ public function getConfigData($field)
      * @param string $field
      * @return bool
      * @SuppressWarnings(PHPMD.BooleanGetMethodName)
+     * @api
      */
     public function getConfigFlag($field)
     {
@@ -154,11 +157,11 @@ public function getConfigFlag($field)
     /**
      * Collect and get rates
      *
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return \Magento\Shipping\Model\Rate\Result|bool|null
      * @abstract
      */
-    abstract public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request);
+    abstract public function collectRates(\Magento\Framework\Object $request);
 
     /**
      * Do request to shipment
@@ -276,11 +279,11 @@ public function getDeliveryConfirmationTypes(\Magento\Framework\Object $params =
     }
 
     /**
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
+     * @param \Magento\Framework\Object $request
      * @return $this|bool|false|\Magento\Framework\Model\AbstractModel
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
      */
-    public function checkAvailableShipCountries(\Magento\Quote\Model\Quote\Address\RateRequest $request)
+    public function checkAvailableShipCountries(\Magento\Framework\Object $request)
     {
         $speCountriesAllow = $this->getConfigData('sallowspecific');
         /*
@@ -323,11 +326,11 @@ public function checkAvailableShipCountries(\Magento\Quote\Model\Quote\Address\R
     /**
      * Processing additional validation to check is carrier applicable.
      *
-     * @param \Magento\Quote\Model\Quote\Address\RateRequest $request
-     * @return $this|bool|Error
+     * @param \Magento\Framework\Object $request
+     * @return $this|bool|\Magento\Framework\Object
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    public function proccessAdditionalValidation(\Magento\Quote\Model\Quote\Address\RateRequest $request)
+    public function proccessAdditionalValidation(\Magento\Framework\Object $request)
     {
         return $this;
     }
@@ -593,6 +596,7 @@ protected function _debug($debugData)
      *
      * @return bool
      * @SuppressWarnings(PHPMD.BooleanGetMethodName)
+     * @api
      */
     public function getDebugFlag()
     {
diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierInterface.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierInterface.php
diff --git a/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php b/app/code/Magento/Shipping/Model/Carrier/AbstractCarrierOnline.php
diff --git a/app/code/Magento/Shipping/Model/Carrier/CarrierInterface.php b/app/code/Magento/Shipping/Model/Carrier/CarrierInterface.php
diff --git a/app/code/Magento/Shipping/Model/CarrierFactory.php b/app/code/Magento/Shipping/Model/CarrierFactory.php
diff --git a/app/code/Magento/Shipping/Model/CarrierFactoryInterface.php b/app/code/Magento/Shipping/Model/CarrierFactoryInterface.php
diff --git a/app/code/Magento/Shipping/etc/di.xml b/app/code/Magento/Shipping/etc/di.xml
diff --git a/app/code/Magento/Ups/Model/Carrier.php b/app/code/Magento/Ups/Model/Carrier.php
diff --git a/app/code/Magento/Usps/Model/Carrier.php b/app/code/Magento/Usps/Model/Carrier.php

Original file line number	Diff line number	Diff line change
`@@ -236,10 +236,10 @@ protected function _createTrackSoapClient()`
`236`	`236`	`/**`
`237`	`237`	`* Collect and get rates`
`238`	`238`	`*`
`239`		`- * @param RateRequest $request`
	`239`	`+ * @param \Magento\Framework\Object $request`
`240`	`240`	`* @return Result\|bool\|null`
`241`	`241`	`*/`
`242`		`- public function collectRates(RateRequest $request)`
	`242`	`+ public function collectRates(\Magento\Framework\Object $request)`
`243`	`243`	`{`
`244`	`244`	`if (!$this->getConfigFlag($this->_activeFlag)) {`
`245`	`245`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -55,12 +55,12 @@ public function __construct(`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`/**`
`58`		`- * @param \Magento\Quote\Model\Quote\Address\RateRequest $request`
	`58`	`+ * @param \Magento\Framework\Object $request`
`59`	`59`	`* @return Result\|bool`
`60`	`60`	`* @SuppressWarnings(PHPMD.CyclomaticComplexity)`
`61`	`61`	`* @SuppressWarnings(PHPMD.NPathComplexity)`
`62`	`62`	`*/`
`63`		`- public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)`
	`63`	`+ public function collectRates(\Magento\Framework\Object $request)`
`64`	`64`	`{`
`65`	`65`	`if (!$this->getConfigFlag('active')) {`
`66`	`66`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -58,10 +58,10 @@ public function __construct(`
`58`	`58`	`/**`
`59`	`59`	`* FreeShipping Rates Collector`
`60`	`60`	`*`
`61`		`- * @param \Magento\Quote\Model\Quote\Address\RateRequest $request`
	`61`	`+ * @param \Magento\Framework\Object $request`
`62`	`62`	`* @return \Magento\Shipping\Model\Rate\Result\|bool`
`63`	`63`	`*/`
`64`		`- public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)`
	`64`	`+ public function collectRates(\Magento\Framework\Object $request)`
`65`	`65`	`{`
`66`	`66`	`if (!$this->getConfigFlag('active')) {`
`67`	`67`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -50,11 +50,11 @@ public function __construct(`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`/**`
`53`		`- * @param \Magento\Quote\Model\Quote\Address\RateRequest $request`
	`53`	`+ * @param \Magento\Framework\Object $request`
`54`	`54`	`* @return \Magento\Shipping\Model\Rate\Result`
`55`	`55`	`* @SuppressWarnings(PHPMD.UnusedLocalVariable)`
`56`	`56`	`*/`
`57`		`- public function collectRates(\Magento\Quote\Model\Quote\Address\RateRequest $request)`
	`57`	`+ public function collectRates(\Magento\Framework\Object $request)`
`58`	`58`	`{`
`59`	`59`	`if (!$this->getConfigFlag('active')) {`
`60`	`60`	`return false;`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public function __construct(\Magento\Framework\ObjectManagerInterface $objectMan`
`26`	`26`	`/**`
`27`	`27`	`* Wrap sales model with Magento\Payment\Model\Cart\SalesModel\SalesModelInterface`
`28`	`28`	`*`
`29`		`- * @param \Magento\Sales\Model\Order\|\Magento\Quote\Model\Quote $salesModel`
	`29`	`+ * @param \Magento\Quote\Api\Data\CartInterface $salesModel`
`30`	`30`	`* @return \Magento\Payment\Model\Cart\SalesModel\SalesModelInterface`
`31`	`31`	`* @throws \InvalidArgumentException`
`32`	`32`	`*/`