Inspection of "Refactoring - Salewrapper Partner" - tricae-br/iris - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

by Rafael

created 2015-12-22 21:44 UTC

Status

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -88,7 +88,7 @@  discard block
 block discarded – undo
     }
 
     /**
-     * @param ReflectionMethod $method
+     * @param \ReflectionMethod $method
      * @param array            $data
      * @return array
      * @throws \Iris\Exceptions\ParameterNotFound
@@ -106,8 +106,8 @@  discard block
 block discarded – undo
     }
 
     /**
-     * @param $parameterName
-     * @param ReflectionMethod $method
+     * @param string $parameterName
+     * @param \ReflectionMethod $method
      * @param $data
      * @return void
      * @throws \Iris\Exceptions\ParameterNotFound

Please login to merge, or discard this patch.

src/Iris/SaleWrapper/Partner.php 1 patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -9,7 +9,7 @@  discard block
 block discarded – undo
 {
     /**
      * Gets Venture service.
-     * @return Iris\Interfaces\IrisVenture
+     * @return \Iris\Interfaces\Service
      */
     public function getVentureService()
     {
@@ -18,7 +18,7 @@  discard block
 block discarded – undo
 
     /**
      * Gets Stock service.
-     * @return Iris\Interfaces\Stock
+     * @return \Iris\Interfaces\Service
      */
     public function getStockService()
     {
@@ -27,7 +27,7 @@  discard block
 block discarded – undo
 
     /**
      * Gets Stock service.
-     * @return Iris\Interfaces\Catalog
+     * @return \Iris\Interfaces\Service
      */
     public function getCatalogService()
     {

Please login to merge, or discard this patch.

src/Iris/SaleWrapper/Venture.php 1 patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

@@ -5,7 +5,7 @@  discard block
 block discarded – undo
 class Venture extends Base implements VentureInterface
 {
     /**
-     * @return Iris\Interfaces\IrisPartner
+     * @return \Iris\Interfaces\Service
      */
     public function getPartnerService()
     {
@@ -13,7 +13,7 @@  discard block
 block discarded – undo
     }
 
     /**
-     * @return Iris\Interfaces\IrisVenture
+     * @return \Iris\Interfaces\Service
      */
     public function getVentureService()
     {
@@ -21,7 +21,7 @@  discard block
 block discarded – undo
     }
 
     /**
-     * @return Iris\Interfaces\Customer
+     * @return \Iris\Interfaces\Service
      */
     public function getCustomerService()
     {

Please login to merge, or discard this patch.

src/Iris/SaleWrapper/PartnerInterface.php 1 patch

Doc Comments +19 added lines, -24 removed lines patch added patch discarded remove patch

@@ -8,8 +8,7 @@  discard block
 block discarded – undo
      * As a Partner I expect to receive a reserve confirmation and quantity of stock for SalesOrderItem to remove its
      * reserve.
      *
-     * @param Iris\Transfer\Sales\Order\Item $orderNumber
-     * @param Iris\Transfer\Catalog\Simple $product
+     * @param \Iris\Transfer\Catalog\Simple $product
      * @return void
      * @throws Iris\Exceptions\VentureNotFound
      * @throws Iris\Exceptions\OrderItemNotFound
@@ -24,15 +23,15 @@  discard block
 block discarded – undo
 
     /**
      * Check if current item is from some iris venture.
-     * @param Iris\Transfer\Sales\Order\Item $item
+     * @param \Iris\Transfer\Sales\Order\Item $item
      * @return bool
      * @throws Iris\Exceptions\VentureNotFound
      */
     public function isVentureItem(\Iris\Transfer\Sales\Order\Item $item);
 
     /**
-     * @param Iris\Transfer\Sales\Order $order
-     * @param Iris\Transfer\Venture     $venture
+     * @param \Iris\Transfer\Sales\Order $order
+     * @param \Iris\Transfer\Venture     $venture
      * @return bool
      * @throws Iris\Exceptions\OrderNotFound
      * @throws Iris\Exceptions\RetryMessage
@@ -43,8 +42,8 @@  discard block
 block discarded – undo
     );
 
     /**
-     * @param Iris\Transfer\Sales\Order $order
-     * @param Iris\Transfer\Venture     $venture
+     * @param \Iris\Transfer\Sales\Order $order
+     * @param \Iris\Transfer\Venture     $venture
      * @return bool
      * @throws Iris\Exceptions\OrderNotFound
      * @throws Iris\Exceptions\RetryMessage
@@ -55,8 +54,8 @@  discard block
 block discarded – undo
     );
 
     /**
-     * @param Iris\Transfer\Sales\Order $order
-     * @param Iris\Transfer\Venture     $venture
+     * @param \Iris\Transfer\Sales\Order $order
+     * @param \Iris\Transfer\Venture     $venture
      * @return bool
      * @throws Iris\Exceptions\OrderNotFound
      * @throws Iris\Exceptions\RetryMessage
@@ -75,7 +74,7 @@  discard block
 block discarded – undo
 
     /**
      * As a Partner I expect to receive a shipped notification from Venture.
-     * @param array $order
+     * @param array $orderData
      * @return array Returns an array as:
      *
      * [
@@ -97,8 +96,7 @@  discard block
 block discarded – undo
 
     /**
      * As a Partner I expect to receive a delivered notification from Venture.
-     * @param \Iris\Transfer\Sales\Order $order
-     * @param \Iris\Transfer\Venture $venture
+     * @param \Iris\Transfer\Sales\Order $orderData
      * @return array Returns an array as:
      *
      * [
@@ -120,8 +118,7 @@  discard block
 block discarded – undo
 
     /**
      * As a Partner I expect to receive a delivery failed notification from Venture.
-     * @param Iris\Transfer\Sales\Order $order
-     * @param Iris\Transfer\Venture $venture
+     * @param Iris\Transfer\Sales\Order $orderData
      * @return array Returns an array as:
      *
      * [
@@ -143,22 +140,21 @@  discard block
 block discarded – undo
 
     /**
      * As a Partner I expect to receive the NFe Key and the Tracking URL from Venture.
-     * @param Iris\Transfer\Sales\Order $order
+     * @param \Iris\Transfer\Sales\Order $order
      * @param string $originCode
      * @return void
      */
     public function setNfeKeyAndTrackingUrl(\Iris\Transfer\Sales\Order $order, $originCode);
 
     /**
-     * @param Iris\Transfer\Sales\Order $order
+     * @param \Iris\Transfer\Sales\Order $order
      * @return bool
      */
     public function isInvalidOrder(\Iris\Transfer\Sales\Order $order);
 
     /**
      * As a Partner I want to receive a Venture Order Number to bind it with my Order Number.
-     * @param string $orderNumber Order number.
-     * @param string $ventureCode Venture code
+     * @param string $venture Venture code
      * @param string $ventureOrderNumber Venture Order Number
      * @return void
      */
@@ -167,7 +163,7 @@  discard block
 block discarded – undo
     /**
      * Create products from venture
      *
-     * @param array $productsData
+     * @param array $products
      * @param string $ventureCode
      * @return void
      */
@@ -176,8 +172,8 @@  discard block
 block discarded – undo
     /**
      * Update products from 
      *
-     * @param Iris\Transfer\Catalog\ConfigCollection $products
-     * @param Iris\Transfer\Venture $venture
+     * @param \Iris\Transfer\Catalog\ConfigCollection $products
+     * @param \Iris\Transfer\Venture $venture
      * @return void
      */
     public function updateProductsFromVenture(
@@ -188,8 +184,7 @@  discard block
 block discarded – undo
     /**
      * Handle images related to the products
      *
-     * @param Iris\Transfer\Catalog\Config $config
-     * @param Iris\Transfer\Catalog\ImageCollection $images
+     * @param \Iris\Transfer\Catalog\Config $config
      * @return void
      */
     public function handleImages(\Iris\Transfer\Catalog\Config $config);
@@ -206,7 +201,7 @@  discard block
 block discarded – undo
     /**
      * Update the stock from a product 
      *
-     * @param array $productsData
+     * @param array $productData
      * @param string $ventureCode
      * @return bool
      */

Please login to merge, or discard this patch.

		@@ -88,7 +88,7 @@ discard block
		block discarded – undo
88	88	}
89	89
90	90	/**
91		- * @param ReflectionMethod $method
	91	+ * @param \ReflectionMethod $method
92	92	* @param array $data
93	93	* @return array
94	94	* @throws \Iris\Exceptions\ParameterNotFound
		@@ -106,8 +106,8 @@ discard block
		block discarded – undo
106	106	}
107	107
108	108	/**
109		- * @param $parameterName
110		- * @param ReflectionMethod $method
	109	+ * @param string $parameterName
	110	+ * @param \ReflectionMethod $method
111	111	* @param $data
112	112	* @return void
113	113	* @throws \Iris\Exceptions\ParameterNotFound

		@@ -9,7 +9,7 @@ discard block
		block discarded – undo
9	9	{
10	10	/**
11	11	* Gets Venture service.
12		- * @return Iris\Interfaces\IrisVenture
	12	+ * @return \Iris\Interfaces\Service
13	13	*/
14	14	public function getVentureService()
15	15	{
		@@ -18,7 +18,7 @@ discard block
		block discarded – undo
18	18
19	19	/**
20	20	* Gets Stock service.
21		- * @return Iris\Interfaces\Stock
	21	+ * @return \Iris\Interfaces\Service
22	22	*/
23	23	public function getStockService()
24	24	{
		@@ -27,7 +27,7 @@ discard block
		block discarded – undo
27	27
28	28	/**
29	29	* Gets Stock service.
30		- * @return Iris\Interfaces\Catalog
	30	+ * @return \Iris\Interfaces\Service
31	31	*/
32	32	public function getCatalogService()
33	33	{

		@@ -5,7 +5,7 @@ discard block
		block discarded – undo
5	5	class Venture extends Base implements VentureInterface
6	6	{
7	7	/**
8		- * @return Iris\Interfaces\IrisPartner
	8	+ * @return \Iris\Interfaces\Service
9	9	*/
10	10	public function getPartnerService()
11	11	{
		@@ -13,7 +13,7 @@ discard block
		block discarded – undo
13	13	}
14	14
15	15	/**
16		- * @return Iris\Interfaces\IrisVenture
	16	+ * @return \Iris\Interfaces\Service
17	17	*/
18	18	public function getVentureService()
19	19	{
		@@ -21,7 +21,7 @@ discard block
		block discarded – undo
21	21	}
22	22
23	23	/**
24		- * @return Iris\Interfaces\Customer
	24	+ * @return \Iris\Interfaces\Service
25	25	*/
26	26	public function getCustomerService()
27	27	{

		@@ -8,8 +8,7 @@ discard block
		block discarded – undo
8	8	* As a Partner I expect to receive a reserve confirmation and quantity of stock for SalesOrderItem to remove its
9	9	* reserve.
10	10	*
11		- * @param Iris\Transfer\Sales\Order\Item $orderNumber
12		- * @param Iris\Transfer\Catalog\Simple $product
	11	+ * @param \Iris\Transfer\Catalog\Simple $product
13	12	* @return void
14	13	* @throws Iris\Exceptions\VentureNotFound
15	14	* @throws Iris\Exceptions\OrderItemNotFound
		@@ -24,15 +23,15 @@ discard block
		block discarded – undo
24	23
25	24	/**
26	25	* Check if current item is from some iris venture.
27		- * @param Iris\Transfer\Sales\Order\Item $item
	26	+ * @param \Iris\Transfer\Sales\Order\Item $item
28	27	* @return bool
29	28	* @throws Iris\Exceptions\VentureNotFound
30	29	*/
31	30	public function isVentureItem(\Iris\Transfer\Sales\Order\Item $item);
32	31
33	32	/**
34		- * @param Iris\Transfer\Sales\Order $order
35		- * @param Iris\Transfer\Venture $venture
	33	+ * @param \Iris\Transfer\Sales\Order $order
	34	+ * @param \Iris\Transfer\Venture $venture
36	35	* @return bool
37	36	* @throws Iris\Exceptions\OrderNotFound
38	37	* @throws Iris\Exceptions\RetryMessage
		@@ -43,8 +42,8 @@ discard block
		block discarded – undo
43	42	);
44	43
45	44	/**
46		- * @param Iris\Transfer\Sales\Order $order
47		- * @param Iris\Transfer\Venture $venture
	45	+ * @param \Iris\Transfer\Sales\Order $order
	46	+ * @param \Iris\Transfer\Venture $venture
48	47	* @return bool
49	48	* @throws Iris\Exceptions\OrderNotFound
50	49	* @throws Iris\Exceptions\RetryMessage
		@@ -55,8 +54,8 @@ discard block
		block discarded – undo
55	54	);
56	55
57	56	/**
58		- * @param Iris\Transfer\Sales\Order $order
59		- * @param Iris\Transfer\Venture $venture
	57	+ * @param \Iris\Transfer\Sales\Order $order
	58	+ * @param \Iris\Transfer\Venture $venture
60	59	* @return bool
61	60	* @throws Iris\Exceptions\OrderNotFound
62	61	* @throws Iris\Exceptions\RetryMessage
		@@ -75,7 +74,7 @@ discard block
		block discarded – undo
75	74
76	75	/**
77	76	* As a Partner I expect to receive a shipped notification from Venture.
78		- * @param array $order
	77	+ * @param array $orderData
79	78	* @return array Returns an array as:
80	79	*
81	80	* [
		@@ -97,8 +96,7 @@ discard block
		block discarded – undo
97	96
98	97	/**
99	98	* As a Partner I expect to receive a delivered notification from Venture.
100		- * @param \Iris\Transfer\Sales\Order $order
101		- * @param \Iris\Transfer\Venture $venture
	99	+ * @param \Iris\Transfer\Sales\Order $orderData
102	100	* @return array Returns an array as:
103	101	*
104	102	* [
		@@ -120,8 +118,7 @@ discard block
		block discarded – undo
120	118
121	119	/**
122	120	* As a Partner I expect to receive a delivery failed notification from Venture.
123		- * @param Iris\Transfer\Sales\Order $order
124		- * @param Iris\Transfer\Venture $venture
	121	+ * @param Iris\Transfer\Sales\Order $orderData
125	122	* @return array Returns an array as:
126	123	*
127	124	* [
		@@ -143,22 +140,21 @@ discard block
		block discarded – undo
143	140
144	141	/**
145	142	* As a Partner I expect to receive the NFe Key and the Tracking URL from Venture.
146		- * @param Iris\Transfer\Sales\Order $order
	143	+ * @param \Iris\Transfer\Sales\Order $order
147	144	* @param string $originCode
148	145	* @return void
149	146	*/
150	147	public function setNfeKeyAndTrackingUrl(\Iris\Transfer\Sales\Order $order, $originCode);
151	148
152	149	/**
153		- * @param Iris\Transfer\Sales\Order $order
	150	+ * @param \Iris\Transfer\Sales\Order $order
154	151	* @return bool
155	152	*/
156	153	public function isInvalidOrder(\Iris\Transfer\Sales\Order $order);
157	154
158	155	/**
159	156	* As a Partner I want to receive a Venture Order Number to bind it with my Order Number.
160		- * @param string $orderNumber Order number.
161		- * @param string $ventureCode Venture code
	157	+ * @param string $venture Venture code
162	158	* @param string $ventureOrderNumber Venture Order Number
163	159	* @return void
164	160	*/
		@@ -167,7 +163,7 @@ discard block
		block discarded – undo
167	163	/**
168	164	* Create products from venture
169	165	*
170		- * @param array $productsData
	166	+ * @param array $products
171	167	* @param string $ventureCode
172	168	* @return void
173	169	*/
		@@ -176,8 +172,8 @@ discard block
		block discarded – undo
176	172	/**
177	173	* Update products from
178	174	*
179		- * @param Iris\Transfer\Catalog\ConfigCollection $products
180		- * @param Iris\Transfer\Venture $venture
	175	+ * @param \Iris\Transfer\Catalog\ConfigCollection $products
	176	+ * @param \Iris\Transfer\Venture $venture
181	177	* @return void
182	178	*/
183	179	public function updateProductsFromVenture(
		@@ -188,8 +184,7 @@ discard block
		block discarded – undo
188	184	/**
189	185	* Handle images related to the products
190	186	*
191		- * @param Iris\Transfer\Catalog\Config $config
192		- * @param Iris\Transfer\Catalog\ImageCollection $images
	187	+ * @param \Iris\Transfer\Catalog\Config $config
193	188	* @return void
194	189	*/
195	190	public function handleImages(\Iris\Transfer\Catalog\Config $config);
		@@ -206,7 +201,7 @@ discard block
		block discarded – undo
206	201	/**
207	202	* Update the stock from a product
208	203	*
209		- * @param array $productsData
	204	+ * @param array $productData
210	205	* @param string $ventureCode
211	206	* @return bool
212	207	*/

tricae-br / iris

Pull Request — master (#6)

Status

Category

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

Doc Comments +3 added lines, -3 removed lines patch added patch discarded remove patch

Doc Comments +19 added lines, -24 removed lines patch added patch discarded remove patch