1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Iris\Interfaces; |
4
|
|
|
|
5
|
|
|
interface Order extends Service |
6
|
|
|
{ |
7
|
|
|
/** |
8
|
|
|
* Cancel an order received from venture |
9
|
|
|
* |
10
|
|
|
* @param \Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection |
11
|
|
|
* @param string $ventureCode |
12
|
|
|
* @return bool |
13
|
|
|
* @throws \Iris\Exceptions\EventNotFound |
14
|
|
|
*/ |
15
|
|
|
public function cancelOrderFromVenture( |
16
|
|
|
\Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection, |
17
|
|
|
$ventureCode |
18
|
|
|
); |
19
|
|
|
|
20
|
|
|
/** |
21
|
|
|
* Drop |
22
|
|
|
* |
23
|
|
|
* @param integer $orderNr Partner order number |
24
|
|
|
* @return bool |
25
|
|
|
* @throws \Iris\Exceptions\UnableToDropReserve |
26
|
|
|
*/ |
27
|
|
|
public function dropReserve($orderNr); |
28
|
|
|
|
29
|
|
|
/** |
30
|
|
|
* Cancel order received from partner |
31
|
|
|
* |
32
|
|
|
* @param \Iris\Transfer\Sales\Order $order |
33
|
|
|
* @return bool |
34
|
|
|
* @throws \Iris\Exceptions\EventNotFound |
35
|
|
|
*/ |
36
|
|
|
public function cancel(\Iris\Transfer\Sales\Order $order); |
37
|
|
|
|
38
|
|
|
/** |
39
|
|
|
* Save an new order from partner |
40
|
|
|
* |
41
|
|
|
* @param \Iris\Transfer\Sales\Order $order |
42
|
|
|
* @return \Iris\Transfer\Sales\Order |
43
|
|
|
* @throws \Iris\Exceptions\UnableToCreateOrder |
44
|
|
|
*/ |
45
|
|
|
public function save(\Iris\Transfer\Sales\Order $order); |
46
|
|
|
|
47
|
|
|
/** |
48
|
|
|
* Confirm payment from partner |
49
|
|
|
* |
50
|
|
|
* @param \Iris\Transfer\Sales\Order $order |
51
|
|
|
* @return bool |
52
|
|
|
* @throws \Iris\Exceptions\UnableToConfirmOrder |
53
|
|
|
*/ |
54
|
|
|
public function confirmPayment(\Iris\Transfer\Sales\Order $order); |
55
|
|
|
|
56
|
|
|
/** |
57
|
|
|
* Gets venture order based on partner order number and partner code |
58
|
|
|
* |
59
|
|
|
* @param string $orderNr Partner order number |
60
|
|
|
* @param string $partnerCode |
61
|
|
|
* @return \Iris\Transfer\Sales\Order |
62
|
|
|
* @throws \Iris\Exceptions\OrderNotFound |
63
|
|
|
*/ |
64
|
|
|
public function getOrderByOrderNumberAndPartnerCode($orderNr, $partnerCode); |
65
|
|
|
|
66
|
|
|
/** |
67
|
|
|
* @param \Iris\Transfer\Sales\Order $order |
|
|
|
|
68
|
|
|
* @param string $ventureCode |
69
|
|
|
* @return array Returns an array as: |
70
|
|
|
* |
71
|
|
|
* [ |
72
|
|
|
* 'order_data' = [ |
73
|
|
|
* 'order_number' => '00000057', |
74
|
|
|
* 'items' => [ |
75
|
|
|
* [53 => [ |
76
|
|
|
* 'status' => true |
77
|
|
|
* ]], |
78
|
|
|
* [54 => [ |
79
|
|
|
* 'status' => false, |
80
|
|
|
* 'message' => 'Some error' |
81
|
|
|
* ] |
82
|
|
|
* ] |
83
|
|
|
* ] |
84
|
|
|
* ] |
85
|
|
|
*/ |
86
|
|
|
public function shippedFromVenture( |
87
|
|
|
\Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection, |
88
|
|
|
$ventureCode |
89
|
|
|
); |
90
|
|
|
|
91
|
|
|
/** |
92
|
|
|
* @param \Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection |
93
|
|
|
* @param string $ventureCode |
94
|
|
|
* @return array Returns an array as: |
95
|
|
|
* |
96
|
|
|
* [ |
97
|
|
|
* 'order_data' = [ |
98
|
|
|
* 'order_number' => '00000057', |
99
|
|
|
* 'items' => [ |
100
|
|
|
* [53 => [ |
101
|
|
|
* 'status' => true |
102
|
|
|
* ]], |
103
|
|
|
* [54 => [ |
104
|
|
|
* 'status' => false, |
105
|
|
|
* 'message' => 'Some error' |
106
|
|
|
* ] |
107
|
|
|
* ] |
108
|
|
|
* ] |
109
|
|
|
* ] |
110
|
|
|
*/ |
111
|
|
|
public function deliveredFromVenture( |
112
|
|
|
\Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection, |
113
|
|
|
$ventureCode |
114
|
|
|
); |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* @param \Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection |
118
|
|
|
* @param string $ventureCode |
119
|
|
|
* @return array Returns an array as: |
120
|
|
|
* |
121
|
|
|
* [ |
122
|
|
|
* 'order_data' = [ |
123
|
|
|
* 'order_number' => '00000057', |
124
|
|
|
* 'items' => [ |
125
|
|
|
* [53 => [ |
126
|
|
|
* 'status' => true |
127
|
|
|
* ]], |
128
|
|
|
* [54 => [ |
129
|
|
|
* 'status' => false, |
130
|
|
|
* 'message' => 'Some error' |
131
|
|
|
* ] |
132
|
|
|
* ] |
133
|
|
|
* ] |
134
|
|
|
* ] |
135
|
|
|
*/ |
136
|
|
|
public function deliveryFailedFromVenture( |
137
|
|
|
\Iris\Transfer\PostPayment\PostPaymentCollection $postPaymentCollection, |
138
|
|
|
$ventureCode |
139
|
|
|
); |
140
|
|
|
|
141
|
|
|
/** |
142
|
|
|
* Bind order information from venture on partner |
143
|
|
|
* |
144
|
|
|
* @param integer $orderNr |
145
|
|
|
* @param string $ventureCode |
146
|
|
|
* @param integer $ventureOrderNr |
147
|
|
|
* @return void |
148
|
|
|
*/ |
149
|
|
|
public function bindPartnerOrderWithVentureOrder( |
150
|
|
|
$orderNr, |
151
|
|
|
$ventureCode, |
152
|
|
|
$ventureOrderNr |
153
|
|
|
); |
154
|
|
|
} |
155
|
|
|
|
This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function.
Consider the following example. The parameter
$italy
is not defined by the methodfinale(...)
.The most likely cause is that the parameter was removed, but the annotation was not.