/
nonmerchant_demo.php
328 lines (284 loc) · 11.7 KB
/
nonmerchant_demo.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
<?php
/**
* Nonmerchant Demo Gateway
*
* @package blesta
* @subpackage blesta.components.gateways.nonmerchant_demo
* @copyright Copyright (c) 2010, Phillips Data, Inc.
* @license http://www.blesta.com/license/ The Blesta License Agreement
* @link http://www.blesta.com/ Blesta
*/
class NonmerchantDemo extends NonmerchantGateway {
/**
* @var string The version of this gateway
*/
private static $version = "1.0.0";
/**
* @var string The authors of this gateway
*/
private static $authors = array(array('name' => "Phillips Data, Inc.", 'url' => "http://www.blesta.com"));
/**
* @var array An array of meta data for this gateway
*/
private $meta;
/**
* Construct a new merchant gateway
*/
public function __construct() {
// Load components required by this gateway
Loader::loadComponents($this, array("Input"));
// Load the language required by this gateway
Language::loadLang("nonmerchant_demo", null, dirname(__FILE__) . DS . "language" . DS);
}
/**
* Returns the name of this gateway
*
* @return string The common name of this gateway
*/
public function getName() {
return Language::_("NonmerchantDemo.name", true);
}
/**
* Returns the version of this gateway
*
* @return string The current version of this gateway
*/
public function getVersion() {
return self::$version;
}
/**
* Returns the name and URL for the authors of this gateway
*
* @return array The name and URL of the authors of this gateway
*/
public function getAuthors() {
return self::$authors;
}
/**
* Return all currencies supported by this gateway
*
* @return array A numerically indexed array containing all currency codes (ISO 4217 format) this gateway supports
*/
public function getCurrencies() {
return array("EUR", "GBP", "USD");
}
/**
* Sets the currency code to be used for all subsequent payments
*
* @param string $currency The ISO 4217 currency code to be used for subsequent payments
*/
public function setCurrency($currency) {
$this->currency = $currency;
}
/**
* Create and return the view content required to modify the settings of this gateway
*
* @param array $meta An array of meta (settings) data belonging to this gateway
* @return string HTML content containing the fields to update the meta data for this gateway
*/
public function getSettings(array $meta=null) {
$this->view = $this->makeView("settings", "default", str_replace(ROOTWEBDIR, "", dirname(__FILE__) . DS));
// Load the helpers required for this view
Loader::loadHelpers($this, array("Form", "Html"));
$this->view->set("meta", $meta);
return $this->view->fetch();
}
/**
* Validates the given meta (settings) data to be updated for this gateway
*
* @param array $meta An array of meta (settings) data to be updated for this gateway
* @return array The meta data to be updated in the database for this gateway, or reset into the form on failure
*/
public function editSettings(array $meta) {
// Verify meta data is valid
$rules = array(
'key'=>array(
'valid'=>array(
'rule'=>array("betweenLength", 16, 16),
'message'=>Language::_("NonmerchantDemo.!error.key.valid", true)
)
)
#
# TODO: Do error checking on any other fields that require it
#
);
$this->Input->setRules($rules);
// Validate the given meta data to ensure it meets the requirements
$this->Input->validates($meta);
// Return the meta data, no changes required regardless of success or failure for this gateway
return $meta;
}
/**
* Returns an array of all fields to encrypt when storing in the database
*
* @return array An array of the field names to encrypt when storing in the database
*/
public function encryptableFields() {
#
# TODO: return an array of all meta field names to store encrypted
#
return array("key");
}
/**
* Sets the meta data for this particular gateway
*
* @param array $meta An array of meta data to set for this gateway
*/
public function setMeta(array $meta=null) {
$this->meta = $meta;
}
/**
* Returns all HTML markup required to render an authorization and capture payment form
*
* @param array $contact_info An array of contact info including:
* - id The contact ID
* - client_id The ID of the client this contact belongs to
* - user_id The user ID this contact belongs to (if any)
* - contact_type The type of contact
* - contact_type_id The ID of the contact type
* - first_name The first name on the contact
* - last_name The last name on the contact
* - title The title of the contact
* - company The company name of the contact
* - address1 The address 1 line of the contact
* - address2 The address 2 line of the contact
* - city The city of the contact
* - state An array of state info including:
* - code The 2 or 3-character state code
* - name The local name of the country
* - country An array of country info including:
* - alpha2 The 2-character country code
* - alpha3 The 3-cahracter country code
* - name The english name of the country
* - alt_name The local name of the country
* - zip The zip/postal code of the contact
* @param float $amount The amount to charge this contact
* @param array $invoice_amounts An array of invoices, each containing:
* - id The ID of the invoice being processed
* - amount The amount being processed for this invoice (which is included in $amount)
* @param array $options An array of options including:
* - description The Description of the charge
* - return_url The URL to redirect users to after a successful payment
* - recur An array of recurring info including:
* - amount The amount to recur
* - term The term to recur
* - period The recurring period (day, week, month, year, onetime) used in conjunction with term in order to determine the next recurring payment
* @return string HTML markup required to render an authorization and capture payment form
*/
public function buildProcess(array $contact_info, $amount, array $invoice_amounts=null, array $options=null) {
$this->view = $this->makeView("process", "default", str_replace(ROOTWEBDIR, "", dirname(__FILE__) . DS));
// Load the helpers required for this view
Loader::loadHelpers($this, array("Form", "Html"));
$fields = array();
$post_to = "";
#
# TODO: Define all form fields and the $post_to fields
#
$this->view->set("post_to", $post_to);
$this->view->set("fields", $fields);
return $this->view->fetch();
}
/**
* Validates the incoming POST/GET response from the gateway to ensure it is
* legitimate and can be trusted.
*
* @param array $get The GET data for this request
* @param array $post The POST data for this request
* @return array An array of transaction data, sets any errors using Input if the data fails to validate
* - client_id The ID of the client that attempted the payment
* - amount The amount of the payment
* - currency The currency of the payment
* - invoices An array of invoices and the amount the payment should be applied to (if any) including:
* - id The ID of the invoice to apply to
* - amount The amount to apply to the invoice
* - status The status of the transaction (approved, declined, void, pending, reconciled, refunded, returned)
* - reference_id The reference ID for gateway-only use with this transaction (optional)
* - transaction_id The ID returned by the gateway to identify this transaction
*/
public function validate(array $get, array $post) {
#
# TODO: Verify the get/post data, then return the transaction
#
#
// Log the successful response
$this->log($this->ifSet($_SERVER['REQUEST_URI']), serialize($post), "output", true);
return array();
}
/**
* Returns data regarding a success transaction. This method is invoked when
* a client returns from the non-merchant gateway's web site back to Blesta.
*
* @param array $get The GET data for this request
* @param array $post The POST data for this request
* @return array An array of transaction data, may set errors using Input if the data appears invalid
* - client_id The ID of the client that attempted the payment
* - amount The amount of the payment
* - currency The currency of the payment
* - invoices An array of invoices and the amount the payment should be applied to (if any) including:
* - id The ID of the invoice to apply to
* - amount The amount to apply to the invoice
* - status The status of the transaction (approved, declined, void, pending, reconciled, refunded, returned)
* - transaction_id The ID returned by the gateway to identify this transaction
*/
public function success(array $get, array $post) {
#
# TODO: Return transaction data, if possible
#
$this->Input->setErrors($this->getCommonError("unsupported"));
}
/**
* Captures a previously authorized payment
*
* @param string $reference_id The reference ID for the previously authorized transaction
* @param string $transaction_id The transaction ID for the previously authorized transaction
* @return array An array of transaction data including:
* - status The status of the transaction (approved, declined, void, pending, reconciled, refunded, returned)
* - reference_id The reference ID for gateway-only use with this transaction (optional)
* - transaction_id The ID returned by the remote gateway to identify this transaction
* - message The message to be displayed in the interface in addition to the standard message for this transaction status (optional)
*/
public function capture($reference_id, $transaction_id, $amount, array $invoice_amounts=null) {
#
# TODO: Return transaction data, if possible
#
$this->Input->setErrors($this->getCommonError("unsupported"));
}
/**
* Void a payment or authorization
*
* @param string $reference_id The reference ID for the previously submitted transaction
* @param string $transaction_id The transaction ID for the previously submitted transaction
* @param string $notes Notes about the void that may be sent to the client by the gateway
* @return array An array of transaction data including:
* - status The status of the transaction (approved, declined, void, pending, reconciled, refunded, returned)
* - reference_id The reference ID for gateway-only use with this transaction (optional)
* - transaction_id The ID returned by the remote gateway to identify this transaction
* - message The message to be displayed in the interface in addition to the standard message for this transaction status (optional)
*/
public function void($reference_id, $transaction_id, $notes=null) {
#
# TODO: Return transaction data, if possible
#
$this->Input->setErrors($this->getCommonError("unsupported"));
}
/**
* Refund a payment
*
* @param string $reference_id The reference ID for the previously submitted transaction
* @param string $transaction_id The transaction ID for the previously submitted transaction
* @param float $amount The amount to refund this card
* @param string $notes Notes about the refund that may be sent to the client by the gateway
* @return array An array of transaction data including:
* - status The status of the transaction (approved, declined, void, pending, reconciled, refunded, returned)
* - reference_id The reference ID for gateway-only use with this transaction (optional)
* - transaction_id The ID returned by the remote gateway to identify this transaction
* - message The message to be displayed in the interface in addition to the standard message for this transaction status (optional)
*/
public function refund($reference_id, $transaction_id, $amount, $notes=null) {
#
# TODO: Return transaction data, if possible
#
$this->Input->setErrors($this->getCommonError("unsupported"));
}
}
?>