1 | <?php |
||
26 | class Gateway extends AbstractGateway |
||
27 | { |
||
28 | /** |
||
29 | * Get gateway display name. |
||
30 | * |
||
31 | * This can be used by carts to get the display name for each gateway. |
||
32 | * |
||
33 | * @return string |
||
34 | */ |
||
35 | 2 | public function getName() |
|
39 | |||
40 | /** |
||
41 | * Get the gateway parameters. |
||
42 | * |
||
43 | * @return array |
||
44 | */ |
||
45 | 56 | public function getDefaultParameters() |
|
53 | |||
54 | /** |
||
55 | * Get a merchant id. |
||
56 | * |
||
57 | * @return string |
||
58 | */ |
||
59 | 2 | public function getMerchantId() |
|
63 | |||
64 | /** |
||
65 | * Set a merchant id. |
||
66 | * |
||
67 | * @param string $value |
||
68 | * |
||
69 | * @return $this |
||
70 | */ |
||
71 | 18 | public function setMerchantId($value) |
|
75 | |||
76 | /** |
||
77 | * Get a merchant's product id. |
||
78 | * |
||
79 | * @return string |
||
80 | */ |
||
81 | 2 | public function getProductId() |
|
85 | |||
86 | /** |
||
87 | * Set a merchant's product id. |
||
88 | * |
||
89 | * @param string $value |
||
90 | * |
||
91 | * @return $this |
||
92 | */ |
||
93 | 18 | public function setProductId($value) |
|
97 | |||
98 | /** |
||
99 | * Get a secret word. |
||
100 | * |
||
101 | * @return string |
||
102 | */ |
||
103 | 2 | public function getSecretWord() |
|
107 | |||
108 | /** |
||
109 | * Set a secret word. |
||
110 | * |
||
111 | * @param string $value |
||
112 | * |
||
113 | * @return $this |
||
114 | */ |
||
115 | 18 | public function setSecretWord($value) |
|
119 | |||
120 | /** |
||
121 | * Authorize request. |
||
122 | * |
||
123 | * An Authorize request is similar to a purchase request but the |
||
124 | * charge issues an authorization (or pre-authorization), and no money |
||
125 | * is transferred. The transaction will need to be captured later |
||
126 | * in order to effect payment. |
||
127 | * |
||
128 | * @param array $options |
||
129 | * |
||
130 | * @return AuthorizeRequest|RequestInterface |
||
131 | */ |
||
132 | 6 | public function authorize(array $options = array()) |
|
136 | |||
137 | /** |
||
138 | * Handle return from off-site gateways after authorization. |
||
139 | * |
||
140 | * @param array $options |
||
141 | * |
||
142 | * @return CompleteAuthorizeRequest|RequestInterface |
||
143 | */ |
||
144 | 4 | public function completeAuthorize(array $options = array()) |
|
148 | |||
149 | /** |
||
150 | * Capture Request. |
||
151 | * |
||
152 | * Use this request to capture and process a previously created authorization. |
||
153 | * |
||
154 | * @param array $options |
||
155 | * |
||
156 | * @return CaptureRequest|RequestInterface |
||
157 | */ |
||
158 | 4 | public function capture(array $options = array()) |
|
162 | |||
163 | /** |
||
164 | * Purchase request. |
||
165 | * |
||
166 | * Authorize and immediately capture an amount on the customers card. |
||
167 | * |
||
168 | * @param array $options |
||
169 | * |
||
170 | * @return PurchaseRequest |
||
171 | */ |
||
172 | 4 | public function purchase(array $options = array()) |
|
176 | |||
177 | /** |
||
178 | * Complete purchase request. |
||
179 | * |
||
180 | * Handle return from off-site gateways after purchase. |
||
181 | * |
||
182 | * @param array $options |
||
183 | * |
||
184 | * @return RequestInterface|void |
||
185 | */ |
||
186 | 4 | public function completePurchase(array $options = array()) |
|
190 | |||
191 | /** |
||
192 | * Refund request. |
||
193 | * |
||
194 | * Refund an already processed transaction. |
||
195 | * |
||
196 | * @param array $options |
||
197 | * |
||
198 | * @return \Omnipay\Common\Message\AbstractRequest|RequestInterface |
||
199 | */ |
||
200 | 4 | public function refund(array $options = array()) |
|
204 | |||
205 | /** |
||
206 | * Void request. |
||
207 | * |
||
208 | * Generally can only be called up to 24 hours after submitting a transaction. |
||
209 | * |
||
210 | * @param array $options |
||
211 | * |
||
212 | * @return \Omnipay\Common\Message\AbstractRequest|RequestInterface |
||
213 | */ |
||
214 | 4 | public function void(array $options = array()) |
|
218 | |||
219 | /** |
||
220 | * Status request. |
||
221 | * |
||
222 | * @param array $options |
||
223 | * |
||
224 | * @return \Omnipay\Common\Message\AbstractRequest|RequestInterface |
||
225 | */ |
||
226 | 2 | public function status(array $options = array()) |
|
230 | } |
||
231 |