|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* @description: see OrderStep.md |
|
5
|
|
|
* |
|
6
|
|
|
* |
|
7
|
|
|
* @authors: Nicolaas [at] Sunny Side Up .co.nz |
|
8
|
|
|
* @package: ecommerce |
|
9
|
|
|
* @sub-package: model |
|
10
|
|
|
* @inspiration: Silverstripe Ltd, Jeremy |
|
11
|
|
|
**/ |
|
12
|
|
|
class OrderStep extends DataObject implements EditableEcommerceObject |
|
|
|
|
|
|
13
|
|
|
{ |
|
14
|
|
|
|
|
15
|
|
|
/** |
|
16
|
|
|
* standard SS variable. |
|
17
|
|
|
* |
|
18
|
|
|
* @return array |
|
19
|
|
|
*/ |
|
20
|
|
|
private static $db = array( |
|
|
|
|
|
|
21
|
|
|
'Name' => 'Varchar(50)', |
|
22
|
|
|
'Code' => 'Varchar(50)', |
|
23
|
|
|
'Description' => 'Text', |
|
24
|
|
|
'EmailSubject' => 'Varchar(200)', |
|
25
|
|
|
'CustomerMessage' => 'HTMLText', |
|
26
|
|
|
//customer privileges |
|
27
|
|
|
'CustomerCanEdit' => 'Boolean', |
|
28
|
|
|
'CustomerCanCancel' => 'Boolean', |
|
29
|
|
|
'CustomerCanPay' => 'Boolean', |
|
30
|
|
|
//What to show the customer... |
|
31
|
|
|
'ShowAsUncompletedOrder' => 'Boolean', |
|
32
|
|
|
'ShowAsInProcessOrder' => 'Boolean', |
|
33
|
|
|
'ShowAsCompletedOrder' => 'Boolean', |
|
34
|
|
|
'HideStepFromCustomer' => 'Boolean', |
|
35
|
|
|
//sorting index |
|
36
|
|
|
'Sort' => 'Int', |
|
37
|
|
|
'DeferTimeInSeconds' => 'Int', |
|
38
|
|
|
'DeferFromSubmitTime' => 'Boolean' |
|
39
|
|
|
); |
|
40
|
|
|
|
|
41
|
|
|
|
|
42
|
|
|
|
|
43
|
|
|
/** |
|
44
|
|
|
* standard SS variable. |
|
45
|
|
|
* |
|
46
|
|
|
* @return array |
|
47
|
|
|
*/ |
|
48
|
|
|
private static $indexes = array( |
|
|
|
|
|
|
49
|
|
|
'Code' => true, |
|
50
|
|
|
'Sort' => true, |
|
51
|
|
|
); |
|
52
|
|
|
|
|
53
|
|
|
/** |
|
54
|
|
|
* standard SS variable. |
|
55
|
|
|
* |
|
56
|
|
|
* @return array |
|
57
|
|
|
*/ |
|
58
|
|
|
private static $has_many = array( |
|
|
|
|
|
|
59
|
|
|
'Orders' => 'Order', |
|
60
|
|
|
'OrderEmailRecords' => 'OrderEmailRecord', |
|
61
|
|
|
); |
|
62
|
|
|
|
|
63
|
|
|
/** |
|
64
|
|
|
* standard SS variable. |
|
65
|
|
|
* |
|
66
|
|
|
* @return array |
|
67
|
|
|
*/ |
|
68
|
|
|
private static $field_labels = array( |
|
|
|
|
|
|
69
|
|
|
'Sort' => 'Sorting Index', |
|
70
|
|
|
'CustomerCanEdit' => 'Customer can edit order', |
|
71
|
|
|
'CustomerCanPay' => 'Customer can pay order', |
|
72
|
|
|
'CustomerCanCancel' => 'Customer can cancel order', |
|
73
|
|
|
); |
|
74
|
|
|
|
|
75
|
|
|
/** |
|
76
|
|
|
* standard SS variable. |
|
77
|
|
|
* |
|
78
|
|
|
* @return array |
|
79
|
|
|
*/ |
|
80
|
|
|
private static $summary_fields = array( |
|
|
|
|
|
|
81
|
|
|
'NameAndDescription' => 'Step', |
|
82
|
|
|
'ShowAsSummary' => 'Phase', |
|
83
|
|
|
); |
|
84
|
|
|
|
|
85
|
|
|
/** |
|
86
|
|
|
* standard SS variable. |
|
87
|
|
|
* |
|
88
|
|
|
* @return array |
|
89
|
|
|
*/ |
|
90
|
|
|
private static $casting = array( |
|
|
|
|
|
|
91
|
|
|
'Title' => 'Varchar', |
|
92
|
|
|
'CustomerCanEditNice' => 'Varchar', |
|
93
|
|
|
'CustomerCanPayNice' => 'Varchar', |
|
94
|
|
|
'CustomerCanCancelNice' => 'Varchar', |
|
95
|
|
|
'ShowAsUncompletedOrderNice' => 'Varchar', |
|
96
|
|
|
'ShowAsInProcessOrderNice' => 'Varchar', |
|
97
|
|
|
'ShowAsCompletedOrderNice' => 'Varchar', |
|
98
|
|
|
'HideStepFromCustomerNice' => 'Varchar', |
|
99
|
|
|
'HasCustomerMessageNice' => 'Varchar', |
|
100
|
|
|
'ShowAsSummary' => 'HTMLText', |
|
101
|
|
|
'NameAndDescription' => 'HTMLText' |
|
102
|
|
|
); |
|
103
|
|
|
|
|
104
|
|
|
/** |
|
105
|
|
|
* standard SS variable. |
|
106
|
|
|
* |
|
107
|
|
|
* @return array |
|
108
|
|
|
*/ |
|
109
|
|
|
private static $searchable_fields = array( |
|
|
|
|
|
|
110
|
|
|
'Name' => array( |
|
111
|
|
|
'title' => 'Name', |
|
112
|
|
|
'filter' => 'PartialMatchFilter', |
|
113
|
|
|
), |
|
114
|
|
|
'Code' => array( |
|
115
|
|
|
'title' => 'Code', |
|
116
|
|
|
'filter' => 'PartialMatchFilter', |
|
117
|
|
|
), |
|
118
|
|
|
); |
|
119
|
|
|
|
|
120
|
|
|
|
|
121
|
|
|
/** |
|
122
|
|
|
* casted variable. |
|
123
|
|
|
* |
|
124
|
|
|
* @return string |
|
125
|
|
|
*/ |
|
126
|
|
|
public function Title() |
|
127
|
|
|
{ |
|
128
|
|
|
return $this->getTitle(); |
|
129
|
|
|
} |
|
130
|
|
|
public function getTitle() |
|
|
|
|
|
|
131
|
|
|
{ |
|
132
|
|
|
return $this->Name; |
|
|
|
|
|
|
133
|
|
|
} |
|
134
|
|
|
|
|
135
|
|
|
/** |
|
136
|
|
|
* casted variable. |
|
137
|
|
|
* |
|
138
|
|
|
* @return string |
|
139
|
|
|
*/ |
|
140
|
|
|
public function CustomerCanEditNice() |
|
141
|
|
|
{ |
|
142
|
|
|
return $this->getCustomerCanEditNice(); |
|
143
|
|
|
} |
|
144
|
|
|
public function getCustomerCanEditNice() |
|
145
|
|
|
{ |
|
146
|
|
|
if ($this->CustomerCanEdit) { |
|
|
|
|
|
|
147
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
148
|
|
|
} |
|
149
|
|
|
|
|
150
|
|
|
return _t('OrderStep.NO', 'No'); |
|
151
|
|
|
} |
|
152
|
|
|
|
|
153
|
|
|
/** |
|
154
|
|
|
* casted variable. |
|
155
|
|
|
* |
|
156
|
|
|
* @return string |
|
157
|
|
|
*/ |
|
158
|
|
|
public function CustomerCanPayNice() |
|
159
|
|
|
{ |
|
160
|
|
|
return $this->getCustomerCanPayNice(); |
|
161
|
|
|
} |
|
162
|
|
|
public function getCustomerCanPayNice() |
|
163
|
|
|
{ |
|
164
|
|
|
if ($this->CustomerCanPay) { |
|
|
|
|
|
|
165
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
166
|
|
|
} |
|
167
|
|
|
|
|
168
|
|
|
return _t('OrderStep.NO', 'No'); |
|
169
|
|
|
} |
|
170
|
|
|
|
|
171
|
|
|
/** |
|
172
|
|
|
* casted variable. |
|
173
|
|
|
* |
|
174
|
|
|
* @return string |
|
175
|
|
|
*/ |
|
176
|
|
|
public function CustomerCanCancelNice() |
|
177
|
|
|
{ |
|
178
|
|
|
return $this->getCustomerCanCancelNice(); |
|
179
|
|
|
} |
|
180
|
|
|
public function getCustomerCanCancelNice() |
|
181
|
|
|
{ |
|
182
|
|
|
if ($this->CustomerCanCancel) { |
|
|
|
|
|
|
183
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
184
|
|
|
} |
|
185
|
|
|
|
|
186
|
|
|
return _t('OrderStep.NO', 'No'); |
|
187
|
|
|
} |
|
188
|
|
|
|
|
189
|
|
|
public function ShowAsUncompletedOrderNice() |
|
190
|
|
|
{ |
|
191
|
|
|
return $this->getShowAsUncompletedOrderNice(); |
|
192
|
|
|
} |
|
193
|
|
|
public function getShowAsUncompletedOrderNice() |
|
194
|
|
|
{ |
|
195
|
|
|
if ($this->ShowAsUncompletedOrder) { |
|
|
|
|
|
|
196
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
197
|
|
|
} |
|
198
|
|
|
|
|
199
|
|
|
return _t('OrderStep.NO', 'No'); |
|
200
|
|
|
} |
|
201
|
|
|
|
|
202
|
|
|
/** |
|
203
|
|
|
* casted variable. |
|
204
|
|
|
* |
|
205
|
|
|
* @return string |
|
206
|
|
|
*/ |
|
207
|
|
|
public function ShowAsInProcessOrderNice() |
|
208
|
|
|
{ |
|
209
|
|
|
return $this->getShowAsInProcessOrderNice(); |
|
210
|
|
|
} |
|
211
|
|
|
public function getShowAsInProcessOrderNice() |
|
212
|
|
|
{ |
|
213
|
|
|
if ($this->ShowAsInProcessOrder) { |
|
|
|
|
|
|
214
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
215
|
|
|
} |
|
216
|
|
|
|
|
217
|
|
|
return _t('OrderStep.NO', 'No'); |
|
218
|
|
|
} |
|
219
|
|
|
|
|
220
|
|
|
/** |
|
221
|
|
|
* casted variable. |
|
222
|
|
|
* |
|
223
|
|
|
* @return string |
|
224
|
|
|
*/ |
|
225
|
|
|
public function ShowAsCompletedOrderNice() |
|
226
|
|
|
{ |
|
227
|
|
|
return $this->getShowAsCompletedOrderNice(); |
|
228
|
|
|
} |
|
229
|
|
|
public function getShowAsCompletedOrderNice() |
|
230
|
|
|
{ |
|
231
|
|
|
if ($this->ShowAsCompletedOrder) { |
|
|
|
|
|
|
232
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
233
|
|
|
} |
|
234
|
|
|
|
|
235
|
|
|
return _t('OrderStep.NO', 'No'); |
|
236
|
|
|
} |
|
237
|
|
|
|
|
238
|
|
|
/** |
|
239
|
|
|
* do not show in steps at all. |
|
240
|
|
|
* @return boolean |
|
241
|
|
|
*/ |
|
242
|
|
|
public function HideFromEveryone() |
|
243
|
|
|
{ |
|
244
|
|
|
return false; |
|
245
|
|
|
} |
|
246
|
|
|
|
|
247
|
|
|
/** |
|
248
|
|
|
* casted variable. |
|
249
|
|
|
* |
|
250
|
|
|
* @return string |
|
251
|
|
|
*/ |
|
252
|
|
|
public function HideStepFromCustomerNice() |
|
253
|
|
|
{ |
|
254
|
|
|
return $this->getHideStepFromCustomerNice(); |
|
255
|
|
|
} |
|
256
|
|
|
|
|
257
|
|
|
public function getHideStepFromCustomerNice() |
|
258
|
|
|
{ |
|
259
|
|
|
if ($this->HideStepFromCustomer) { |
|
|
|
|
|
|
260
|
|
|
return _t('OrderStep.YES', 'Yes'); |
|
261
|
|
|
} |
|
262
|
|
|
|
|
263
|
|
|
return _t('OrderStep.NO', 'No'); |
|
264
|
|
|
} |
|
265
|
|
|
|
|
266
|
|
|
/** |
|
267
|
|
|
* standard SS variable. |
|
268
|
|
|
* |
|
269
|
|
|
* @return string |
|
270
|
|
|
*/ |
|
271
|
|
|
private static $singular_name = 'Order Step'; |
|
|
|
|
|
|
272
|
|
|
public function i18n_singular_name() |
|
273
|
|
|
{ |
|
274
|
|
|
return _t('OrderStep.ORDERSTEP', 'Order Step'); |
|
275
|
|
|
} |
|
276
|
|
|
|
|
277
|
|
|
/** |
|
278
|
|
|
* standard SS variable. |
|
279
|
|
|
* |
|
280
|
|
|
* @return string |
|
281
|
|
|
*/ |
|
282
|
|
|
private static $plural_name = 'Order Steps'; |
|
|
|
|
|
|
283
|
|
|
public function i18n_plural_name() |
|
284
|
|
|
{ |
|
285
|
|
|
return _t('OrderStep.ORDERSTEPS', 'Order Steps'); |
|
286
|
|
|
} |
|
287
|
|
|
|
|
288
|
|
|
/** |
|
289
|
|
|
* Standard SS variable. |
|
290
|
|
|
* |
|
291
|
|
|
* @var string |
|
292
|
|
|
*/ |
|
293
|
|
|
private static $description = 'A step that any order goes through.'; |
|
|
|
|
|
|
294
|
|
|
|
|
295
|
|
|
/** |
|
296
|
|
|
* SUPER IMPORTANT TO KEEP ORDER! |
|
297
|
|
|
* standard SS variable. |
|
298
|
|
|
* |
|
299
|
|
|
* @return string |
|
300
|
|
|
*/ |
|
301
|
|
|
private static $default_sort = '"Sort" ASC'; |
|
|
|
|
|
|
302
|
|
|
|
|
303
|
|
|
/** |
|
304
|
|
|
* returns all the order steps |
|
305
|
|
|
* that the admin should / can edit.... |
|
306
|
|
|
* |
|
307
|
|
|
* @return DataList |
|
308
|
|
|
*/ |
|
309
|
|
|
public static function admin_manageable_steps() |
|
310
|
|
|
{ |
|
311
|
|
|
$lastStep = OrderStep::get()->Last(); |
|
312
|
|
|
return OrderStep::get()->filter(array('CustomerCanEdit' => 0))->exclude(array('ID' => $lastStep->ID)); |
|
313
|
|
|
} |
|
314
|
|
|
|
|
315
|
|
|
/** |
|
316
|
|
|
* return StatusIDs (orderstep IDs) from orders that are bad.... |
|
317
|
|
|
* (basically StatusID values that do not exist) |
|
318
|
|
|
* |
|
319
|
|
|
* @return array |
|
320
|
|
|
*/ |
|
321
|
|
|
public static function bad_order_step_ids() |
|
322
|
|
|
{ |
|
323
|
|
|
$badorderStatus = Order::get() |
|
324
|
|
|
->leftJoin('OrderStep', '"OrderStep"."ID" = "Order"."StatusID"') |
|
325
|
|
|
->where('"OrderStep"."ID" IS NULL AND "StatusID" > 0') |
|
326
|
|
|
->column('StatusID'); |
|
327
|
|
|
if (is_array($badorderStatus)) { |
|
328
|
|
|
return array_unique(array_values($badorderStatus)); |
|
329
|
|
|
} else { |
|
330
|
|
|
return array(-1); |
|
331
|
|
|
} |
|
332
|
|
|
} |
|
333
|
|
|
|
|
334
|
|
|
/** |
|
335
|
|
|
* turns code into ID. |
|
336
|
|
|
* |
|
337
|
|
|
* @param string $code |
|
338
|
|
|
* @param int |
|
339
|
|
|
*/ |
|
340
|
|
|
public static function get_status_id_from_code($code) |
|
341
|
|
|
{ |
|
342
|
|
|
$otherStatus = OrderStep::get() |
|
343
|
|
|
->filter(array('Code' => $code)) |
|
344
|
|
|
->First(); |
|
345
|
|
|
if ($otherStatus) { |
|
346
|
|
|
return $otherStatus->ID; |
|
347
|
|
|
} |
|
348
|
|
|
|
|
349
|
|
|
return 0; |
|
350
|
|
|
} |
|
351
|
|
|
|
|
352
|
|
|
/** |
|
353
|
|
|
*@return array |
|
354
|
|
|
**/ |
|
355
|
|
|
public static function get_codes_for_order_steps_to_include() |
|
356
|
|
|
{ |
|
357
|
|
|
$newArray = array(); |
|
358
|
|
|
$array = EcommerceConfig::get('OrderStep', 'order_steps_to_include'); |
|
359
|
|
|
if (is_array($array) && count($array)) { |
|
360
|
|
|
foreach ($array as $className) { |
|
361
|
|
|
$code = singleton($className)->getMyCode(); |
|
362
|
|
|
$newArray[$className] = strtoupper($code); |
|
363
|
|
|
} |
|
364
|
|
|
} |
|
365
|
|
|
|
|
366
|
|
|
return $newArray; |
|
367
|
|
|
} |
|
368
|
|
|
|
|
369
|
|
|
/** |
|
370
|
|
|
* returns a list of ordersteps that have not been created yet. |
|
371
|
|
|
* |
|
372
|
|
|
* @return array |
|
|
|
|
|
|
373
|
|
|
**/ |
|
374
|
|
|
public static function get_not_created_codes_for_order_steps_to_include() |
|
375
|
|
|
{ |
|
376
|
|
|
$array = EcommerceConfig::get('OrderStep', 'order_steps_to_include'); |
|
377
|
|
|
if (is_array($array) && count($array)) { |
|
378
|
|
|
foreach ($array as $className) { |
|
379
|
|
|
$obj = $className::get()->First(); |
|
380
|
|
|
if ($obj) { |
|
381
|
|
|
unset($array[$className]); |
|
382
|
|
|
} |
|
383
|
|
|
} |
|
384
|
|
|
} |
|
385
|
|
|
|
|
386
|
|
|
return $array; |
|
387
|
|
|
} |
|
388
|
|
|
|
|
389
|
|
|
/** |
|
390
|
|
|
*@return string |
|
391
|
|
|
**/ |
|
392
|
|
|
public function getMyCode() |
|
393
|
|
|
{ |
|
394
|
|
|
$array = Config::inst()->get($this->ClassName, 'defaults', Config::UNINHERITED); |
|
395
|
|
|
if (!isset($array['Code'])) { |
|
396
|
|
|
user_error($this->class.' does not have a default code specified'); |
|
397
|
|
|
} |
|
398
|
|
|
|
|
399
|
|
|
return $array['Code']; |
|
400
|
|
|
} |
|
401
|
|
|
|
|
402
|
|
|
/** |
|
403
|
|
|
* IMPORTANT:: MUST HAVE Code must be defined!!! |
|
404
|
|
|
* standard SS variable. |
|
405
|
|
|
* |
|
406
|
|
|
* @return array |
|
407
|
|
|
*/ |
|
408
|
|
|
private static $defaults = array( |
|
|
|
|
|
|
409
|
|
|
'CustomerCanEdit' => 0, |
|
410
|
|
|
'CustomerCanCancel' => 0, |
|
411
|
|
|
'CustomerCanPay' => 1, |
|
412
|
|
|
'ShowAsUncompletedOrder' => 0, |
|
413
|
|
|
'ShowAsInProcessOrder' => 0, |
|
414
|
|
|
'ShowAsCompletedOrder' => 0, |
|
415
|
|
|
'Code' => 'ORDERSTEP', |
|
416
|
|
|
); |
|
417
|
|
|
|
|
418
|
|
|
/** |
|
419
|
|
|
* standard SS method. |
|
420
|
|
|
*/ |
|
421
|
|
|
public function populateDefaults() |
|
422
|
|
|
{ |
|
423
|
|
|
parent::populateDefaults(); |
|
424
|
|
|
$this->Description = $this->myDescription(); |
|
|
|
|
|
|
425
|
|
|
} |
|
426
|
|
|
|
|
427
|
|
|
/** |
|
428
|
|
|
*@return FieldList |
|
429
|
|
|
**/ |
|
430
|
|
|
public function getCMSFields() |
|
431
|
|
|
{ |
|
432
|
|
|
$fields = parent::getCMSFields(); |
|
433
|
|
|
//replacing |
|
434
|
|
|
if ($this->canBeDefered()) { |
|
435
|
|
|
if ($this->DeferTimeInSeconds) { |
|
|
|
|
|
|
436
|
|
|
$fields->addFieldToTab( |
|
437
|
|
|
'Root.Queue', |
|
438
|
|
|
HeaderField::create( |
|
439
|
|
|
'WhenWillThisRun', |
|
440
|
|
|
$this->humanReadeableDeferTimeInSeconds() |
|
441
|
|
|
) |
|
442
|
|
|
); |
|
443
|
|
|
} |
|
444
|
|
|
$fields->addFieldToTab( |
|
445
|
|
|
'Root.Queue', |
|
446
|
|
|
$deferTimeInSecondsField = TextField::create( |
|
447
|
|
|
'DeferTimeInSeconds', |
|
448
|
|
|
_t('OrderStep.DeferTimeInSeconds', 'Seconds in queue') |
|
449
|
|
|
) |
|
450
|
|
|
->setRightTitle( |
|
451
|
|
|
_t( |
|
452
|
|
|
'OrderStep.TIME_EXPLANATION', |
|
453
|
|
|
'86,400 seconds is one day ... |
|
454
|
|
|
<br />To make it easier, you can also enter things like <em>1 week</em>, <em>3 hours</em>, or <em>7 minutes</em>. |
|
455
|
|
|
<br />Non-second entries will automatically be converted to seconds.' |
|
456
|
|
|
) |
|
457
|
|
|
) |
|
458
|
|
|
); |
|
459
|
|
|
if ($this->DeferTimeInSeconds) { |
|
|
|
|
|
|
460
|
|
|
$fields->addFieldToTab( |
|
461
|
|
|
'Root.Queue', |
|
462
|
|
|
$deferTimeInSecondsField = CheckboxField::create( |
|
463
|
|
|
'DeferFromSubmitTime', |
|
464
|
|
|
_t('OrderStep.DeferFromSubmitTime', 'Calculated from submit time?') |
|
465
|
|
|
) |
|
466
|
|
|
->setDescription( |
|
467
|
|
|
_t( |
|
468
|
|
|
'OrderStep.DeferFromSubmitTime_HELP', |
|
469
|
|
|
'The time in the queue can be calculated from the moment the current ordersteps starts or from the moment the order was submitted (in this case, check the box above) ' |
|
470
|
|
|
) |
|
471
|
|
|
) |
|
472
|
|
|
); |
|
473
|
|
|
} |
|
474
|
|
|
} |
|
475
|
|
|
if ($this->hasCustomerMessage()) { |
|
476
|
|
|
$rightTitle = _t( |
|
477
|
|
|
'OrderStep.EXPLAIN_ORDER_NUMBER_IN_SUBJECT', |
|
478
|
|
|
'You can use [OrderNumber] as a tag that will be replaced with the actual Order Number.' |
|
479
|
|
|
); |
|
480
|
|
|
$fields->addFieldToTab( |
|
481
|
|
|
'Root.CustomerMessage', |
|
482
|
|
|
TextField::create('EmailSubject', _t('OrderStep.EMAILSUBJECT', 'Email Subject')) |
|
483
|
|
|
->setRightTitle($rightTitle) |
|
484
|
|
|
); |
|
485
|
|
|
$fields->addFieldToTab('Root.CustomerMessage', $htmlEditorField = new HTMLEditorField('CustomerMessage', _t('OrderStep.CUSTOMERMESSAGE', 'Customer Message (if any)'))); |
|
486
|
|
|
if ($testEmailLink = $this->testEmailLink()) { |
|
487
|
|
|
$fields->addFieldToTab('Root.CustomerMessage', new LiteralField('testEmailLink', '<p><a href="'.$testEmailLink.'" data-popup="true">'._t('OrderStep.VIEW_EMAIL_EXAMPLE', 'View email example in browser').'</a></p>')); |
|
488
|
|
|
} |
|
489
|
|
|
} else { |
|
490
|
|
|
$fields->removeFieldFromTab('Root', 'OrderEmailRecords'); |
|
491
|
|
|
$fields->removeFieldFromTab('Root.Main', 'EmailSubject'); |
|
492
|
|
|
$fields->removeFieldFromTab('Root.Main', 'CustomerMessage'); |
|
493
|
|
|
} |
|
494
|
|
|
//adding |
|
495
|
|
|
if (!$this->exists() || !$this->isDefaultStatusOption()) { |
|
496
|
|
|
$fields->removeFieldFromTab('Root.Main', 'Code'); |
|
497
|
|
|
$fields->addFieldToTab('Root.Main', new DropdownField('ClassName', _t('OrderStep.TYPE', 'Type'), self::get_not_created_codes_for_order_steps_to_include()), 'Name'); |
|
498
|
|
|
} |
|
499
|
|
|
if ($this->isDefaultStatusOption()) { |
|
500
|
|
|
$fields->replaceField('Code', $fields->dataFieldByName('Code')->performReadonlyTransformation()); |
|
501
|
|
|
} |
|
502
|
|
|
//headers |
|
503
|
|
|
$fields->addFieldToTab('Root.Main', new HeaderField('WARNING1', _t('OrderStep.CAREFUL', 'CAREFUL! please edit details below with care'), 2), 'Description'); |
|
504
|
|
|
$fields->addFieldToTab('Root.Main', new HeaderField('WARNING2', _t('OrderStep.CUSTOMERCANCHANGE', 'What can be changed during this step?'), 3), 'CustomerCanEdit'); |
|
505
|
|
|
$fields->addFieldToTab('Root.Main', new HeaderField('WARNING5', _t('OrderStep.ORDERGROUPS', 'Order groups for customer?'), 3), 'ShowAsUncompletedOrder'); |
|
506
|
|
|
$fields->addFieldToTab('Root.Main', new HeaderField('HideStepFromCustomerHeader', _t('OrderStep.HIDE_STEP_FROM_CUSTOMER_HEADER', 'Customer Interaction'), 3), 'HideStepFromCustomer'); |
|
507
|
|
|
//final cleanup |
|
508
|
|
|
$fields->removeFieldFromTab('Root.Main', 'Sort'); |
|
509
|
|
|
$fields->addFieldToTab('Root.Main', new TextareaField('Description', _t('OrderStep.DESCRIPTION', 'Explanation for internal use only')), 'WARNING1'); |
|
510
|
|
|
|
|
511
|
|
|
return $fields; |
|
512
|
|
|
} |
|
513
|
|
|
|
|
514
|
|
|
/** |
|
515
|
|
|
* link to edit the record. |
|
516
|
|
|
* |
|
517
|
|
|
* @param string | Null $action - e.g. edit |
|
518
|
|
|
* |
|
519
|
|
|
* @return string |
|
520
|
|
|
*/ |
|
521
|
|
|
public function CMSEditLink($action = null) |
|
522
|
|
|
{ |
|
523
|
|
|
return Controller::join_links( |
|
524
|
|
|
Director::baseURL(), |
|
525
|
|
|
'/admin/shop/'.$this->ClassName.'/EditForm/field/'.$this->ClassName.'/item/'.$this->ID.'/', |
|
526
|
|
|
$action |
|
527
|
|
|
); |
|
528
|
|
|
} |
|
529
|
|
|
|
|
530
|
|
|
/** |
|
531
|
|
|
* tells the order to display itself with an alternative display page. |
|
532
|
|
|
* in that way, orders can be displayed differently for certain steps |
|
533
|
|
|
* for example, in a print step, the order can be displayed in a |
|
534
|
|
|
* PRINT ONLY format. |
|
535
|
|
|
* |
|
536
|
|
|
* When the method return null, the order is displayed using the standard display page |
|
537
|
|
|
* |
|
538
|
|
|
* @see Order::DisplayPage |
|
539
|
|
|
* |
|
540
|
|
|
* @return null|object (Page) |
|
541
|
|
|
**/ |
|
542
|
|
|
public function AlternativeDisplayPage() |
|
543
|
|
|
{ |
|
544
|
|
|
return; |
|
545
|
|
|
} |
|
546
|
|
|
|
|
547
|
|
|
/** |
|
548
|
|
|
* Allows the opportunity for the Order Step to add any fields to Order::getCMSFields |
|
549
|
|
|
* Usually this is added before ActionNextStepManually. |
|
550
|
|
|
* |
|
551
|
|
|
* @param FieldList $fields |
|
552
|
|
|
* @param Order $order |
|
553
|
|
|
* |
|
554
|
|
|
* @return FieldList |
|
555
|
|
|
**/ |
|
556
|
|
|
public function addOrderStepFields(FieldList $fields, Order $order) |
|
557
|
|
|
{ |
|
558
|
|
|
return $fields; |
|
559
|
|
|
} |
|
560
|
|
|
|
|
561
|
|
|
/** |
|
562
|
|
|
*@return ValidationResult |
|
563
|
|
|
**/ |
|
564
|
|
|
public function validate() |
|
565
|
|
|
{ |
|
566
|
|
|
$result = parent::validate(); |
|
567
|
|
|
$anotherOrderStepWithSameNameOrCode = OrderStep::get() |
|
568
|
|
|
->filter( |
|
569
|
|
|
array( |
|
570
|
|
|
'Name' => $this->Name, |
|
|
|
|
|
|
571
|
|
|
'Code' => strtoupper($this->Code), |
|
|
|
|
|
|
572
|
|
|
) |
|
573
|
|
|
) |
|
574
|
|
|
->exclude(array('ID' => intval($this->ID))) |
|
575
|
|
|
->First(); |
|
576
|
|
|
if ($anotherOrderStepWithSameNameOrCode) { |
|
577
|
|
|
$result->error(_t('OrderStep.ORDERSTEPALREADYEXISTS', 'An order status with this name already exists. Please change the name and try again.')); |
|
578
|
|
|
} |
|
579
|
|
|
|
|
580
|
|
|
return $result; |
|
581
|
|
|
} |
|
582
|
|
|
|
|
583
|
|
|
/************************************************** |
|
584
|
|
|
* moving between statusses... |
|
585
|
|
|
**************************************************/ |
|
586
|
|
|
/** |
|
587
|
|
|
*initStep: |
|
588
|
|
|
* makes sure the step is ready to run.... (e.g. check if the order is ready to be emailed as receipt). |
|
589
|
|
|
* should be able to run this function many times to check if the step is ready. |
|
590
|
|
|
* |
|
591
|
|
|
* @see Order::doNextStatus |
|
592
|
|
|
* |
|
593
|
|
|
* @param Order object |
|
594
|
|
|
* |
|
595
|
|
|
* @return bool - true if the current step is ready to be run... |
|
596
|
|
|
**/ |
|
597
|
|
|
public function initStep(Order $order) |
|
598
|
|
|
{ |
|
599
|
|
|
user_error('Please implement the initStep method in a subclass ('.get_class().') of OrderStep', E_USER_WARNING); |
|
600
|
|
|
|
|
601
|
|
|
return true; |
|
602
|
|
|
} |
|
603
|
|
|
|
|
604
|
|
|
/** |
|
605
|
|
|
*doStep: |
|
606
|
|
|
* should only be able to run this function once |
|
607
|
|
|
* (init stops you from running it twice - in theory....) |
|
608
|
|
|
* runs the actual step. |
|
609
|
|
|
* |
|
610
|
|
|
* @see Order::doNextStatus |
|
611
|
|
|
* |
|
612
|
|
|
* @param Order object |
|
613
|
|
|
* |
|
614
|
|
|
* @return bool - true if run correctly. |
|
615
|
|
|
**/ |
|
616
|
|
|
public function doStep(Order $order) |
|
617
|
|
|
{ |
|
618
|
|
|
user_error('Please implement the initStep method in a subclass ('.get_class().') of OrderStep', E_USER_WARNING); |
|
619
|
|
|
|
|
620
|
|
|
return true; |
|
621
|
|
|
} |
|
622
|
|
|
|
|
623
|
|
|
/** |
|
624
|
|
|
* nextStep: |
|
625
|
|
|
* returns the next step (after it checks if everything is in place for the next step to run...). |
|
626
|
|
|
* |
|
627
|
|
|
* @see Order::doNextStatus |
|
628
|
|
|
* |
|
629
|
|
|
* @param Order $order |
|
630
|
|
|
* |
|
631
|
|
|
* @return OrderStep | Null (next step OrderStep object) |
|
|
|
|
|
|
632
|
|
|
**/ |
|
633
|
|
|
public function nextStep(Order $order) |
|
634
|
|
|
{ |
|
635
|
|
|
$nextOrderStepObject = OrderStep::get() |
|
636
|
|
|
->filter(array('Sort:GreaterThan' => $this->Sort)) |
|
|
|
|
|
|
637
|
|
|
->First(); |
|
638
|
|
|
if ($nextOrderStepObject) { |
|
639
|
|
|
return $nextOrderStepObject; |
|
640
|
|
|
} |
|
641
|
|
|
|
|
642
|
|
|
return; |
|
643
|
|
|
} |
|
644
|
|
|
|
|
645
|
|
|
/************************************************** |
|
646
|
|
|
* Boolean checks |
|
647
|
|
|
**************************************************/ |
|
648
|
|
|
|
|
649
|
|
|
/** |
|
650
|
|
|
* Checks if a step has passed (been completed) in comparison to the current step. |
|
651
|
|
|
* |
|
652
|
|
|
* @param string $code: the name of the step to check |
|
|
|
|
|
|
653
|
|
|
* @param bool $orIsEqualTo if set to true, this method will return TRUE if the step being checked is the current one |
|
654
|
|
|
* |
|
655
|
|
|
* @return bool |
|
656
|
|
|
**/ |
|
657
|
|
|
public function hasPassed($code, $orIsEqualTo = false) |
|
658
|
|
|
{ |
|
659
|
|
|
$otherStatus = OrderStep::get() |
|
660
|
|
|
->filter(array('Code' => $code)) |
|
661
|
|
|
->First(); |
|
662
|
|
|
if ($otherStatus) { |
|
663
|
|
|
if ($otherStatus->Sort < $this->Sort) { |
|
|
|
|
|
|
664
|
|
|
return true; |
|
665
|
|
|
} |
|
666
|
|
|
if ($orIsEqualTo && $otherStatus->Code == $this->Code) { |
|
|
|
|
|
|
667
|
|
|
return true; |
|
668
|
|
|
} |
|
669
|
|
|
} else { |
|
670
|
|
|
user_error("could not find $code in OrderStep", E_USER_NOTICE); |
|
671
|
|
|
} |
|
672
|
|
|
|
|
673
|
|
|
return false; |
|
674
|
|
|
} |
|
675
|
|
|
|
|
676
|
|
|
/** |
|
677
|
|
|
* @param string $code |
|
678
|
|
|
* |
|
679
|
|
|
* @return bool |
|
680
|
|
|
**/ |
|
681
|
|
|
public function hasPassedOrIsEqualTo($code) |
|
682
|
|
|
{ |
|
683
|
|
|
return $this->hasPassed($code, true); |
|
684
|
|
|
} |
|
685
|
|
|
|
|
686
|
|
|
/** |
|
687
|
|
|
* @param string $code |
|
688
|
|
|
* |
|
689
|
|
|
* @return bool |
|
690
|
|
|
**/ |
|
691
|
|
|
public function hasNotPassed($code) |
|
692
|
|
|
{ |
|
693
|
|
|
return (bool) !$this->hasPassed($code, true); |
|
694
|
|
|
} |
|
695
|
|
|
|
|
696
|
|
|
/** |
|
697
|
|
|
* Opposite of hasPassed. |
|
698
|
|
|
* |
|
699
|
|
|
* @param string $code |
|
700
|
|
|
* |
|
701
|
|
|
* @return bool |
|
702
|
|
|
**/ |
|
703
|
|
|
public function isBefore($code) |
|
704
|
|
|
{ |
|
705
|
|
|
return (bool) $this->hasPassed($code, false) ? false : true; |
|
706
|
|
|
} |
|
707
|
|
|
|
|
708
|
|
|
/** |
|
709
|
|
|
*@return bool |
|
710
|
|
|
**/ |
|
711
|
|
|
protected function isDefaultStatusOption() |
|
712
|
|
|
{ |
|
713
|
|
|
return in_array($this->Code, self::get_codes_for_order_steps_to_include()); |
|
|
|
|
|
|
714
|
|
|
} |
|
715
|
|
|
|
|
716
|
|
|
/************************************************** |
|
717
|
|
|
* Email |
|
718
|
|
|
**************************************************/ |
|
719
|
|
|
|
|
720
|
|
|
/** |
|
721
|
|
|
* @var string |
|
722
|
|
|
*/ |
|
723
|
|
|
protected $emailClassName = ''; |
|
724
|
|
|
|
|
725
|
|
|
/** |
|
726
|
|
|
* returns the email class used for emailing the |
|
727
|
|
|
* customer during a specific step (IF ANY!). |
|
728
|
|
|
* |
|
729
|
|
|
* @return string |
|
730
|
|
|
*/ |
|
731
|
|
|
public function getEmailClassName() |
|
732
|
|
|
{ |
|
733
|
|
|
return $this->emailClassName; |
|
734
|
|
|
} |
|
735
|
|
|
|
|
736
|
|
|
/** |
|
737
|
|
|
* return true if done already or mailed successfully now. |
|
738
|
|
|
* |
|
739
|
|
|
* @param order $order |
|
740
|
|
|
* @param string $subject |
|
741
|
|
|
* @param string $message |
|
742
|
|
|
* @param bool $resend |
|
743
|
|
|
* @param bool | string $adminOnlyOrToEmail you can set to false = send to customer, true: send to admin, or email = send to email |
|
744
|
|
|
* @param string $emailClassName |
|
745
|
|
|
* |
|
746
|
|
|
* @return boolean; |
|
|
|
|
|
|
747
|
|
|
*/ |
|
748
|
|
|
protected function sendEmailForStep( |
|
749
|
|
|
$order, |
|
750
|
|
|
$subject, |
|
751
|
|
|
$message = '', |
|
752
|
|
|
$resend = false, |
|
753
|
|
|
$adminOnlyOrToEmail = false, |
|
754
|
|
|
$emailClassName = '' |
|
755
|
|
|
) { |
|
756
|
|
|
if (!$this->hasBeenSent($order) || $resend) { |
|
757
|
|
|
if (!$subject) { |
|
758
|
|
|
$subject = $this->EmailSubject; |
|
|
|
|
|
|
759
|
|
|
} |
|
760
|
|
|
if (!$emailClassName) { |
|
761
|
|
|
$emailClassName = $this->getEmailClassName(); |
|
762
|
|
|
} |
|
763
|
|
|
$adminOnlyOrToEmailIsEmail = $adminOnlyOrToEmail && filter_var($adminOnlyOrToEmail, FILTER_VALIDATE_EMAIL); |
|
764
|
|
|
if ($this->hasCustomerMessage() || $adminOnlyOrToEmailIsEmail) { |
|
765
|
|
|
return $order->sendEmail( |
|
766
|
|
|
$subject, |
|
767
|
|
|
$message, |
|
768
|
|
|
$resend, |
|
769
|
|
|
$adminOnlyOrToEmail, |
|
770
|
|
|
$emailClassName |
|
771
|
|
|
); |
|
772
|
|
|
} else { |
|
773
|
|
|
if (!$emailClassName) { |
|
774
|
|
|
$emailClassName = 'Order_ErrorEmail'; |
|
775
|
|
|
} |
|
776
|
|
|
//looks like we are sending an error, but we are just using this for notification |
|
777
|
|
|
$message = _t('OrderStep.THISMESSAGENOTSENTTOCUSTOMER', 'NOTE: This message was not sent to the customer.').'<br /><br /><br /><br />'.$message; |
|
778
|
|
|
$outcome = $order->sendAdminNotification( |
|
779
|
|
|
$subject, |
|
780
|
|
|
$message, |
|
781
|
|
|
$resend, |
|
782
|
|
|
$emailClassName |
|
783
|
|
|
); |
|
784
|
|
|
} |
|
785
|
|
|
if ($outcome || Director::isDev()) { |
|
|
|
|
|
|
786
|
|
|
return true; |
|
787
|
|
|
} |
|
788
|
|
|
|
|
789
|
|
|
return false; |
|
790
|
|
|
} |
|
791
|
|
|
|
|
792
|
|
|
return true; |
|
793
|
|
|
} |
|
794
|
|
|
|
|
795
|
|
|
/** |
|
796
|
|
|
* sets the email class used for emailing the |
|
797
|
|
|
* customer during a specific step (IF ANY!). |
|
798
|
|
|
* |
|
799
|
|
|
* @param string |
|
800
|
|
|
*/ |
|
801
|
|
|
public function setEmailClassName($s) |
|
802
|
|
|
{ |
|
803
|
|
|
$this->emailClassName = $s; |
|
804
|
|
|
} |
|
805
|
|
|
|
|
806
|
|
|
/** |
|
807
|
|
|
* returns a link that can be used to test |
|
808
|
|
|
* the email being sent during this step |
|
809
|
|
|
* this method returns NULL if no email |
|
810
|
|
|
* is being sent OR if there is no suitable Order |
|
811
|
|
|
* to test with... |
|
812
|
|
|
* |
|
813
|
|
|
* @return string |
|
|
|
|
|
|
814
|
|
|
*/ |
|
815
|
|
|
protected function testEmailLink() |
|
816
|
|
|
{ |
|
817
|
|
|
if ($this->getEmailClassName()) { |
|
818
|
|
|
$orders = Order::get() |
|
819
|
|
|
->where('"OrderStep"."Sort" >= '.$this->Sort) |
|
|
|
|
|
|
820
|
|
|
->sort('IF("OrderStep"."Sort" > '.$this->Sort.', 0, 1) ASC, "OrderStep"."Sort" ASC, RAND() ASC') |
|
|
|
|
|
|
821
|
|
|
->innerJoin('OrderStep', '"OrderStep"."ID" = "Order"."StatusID"'); |
|
822
|
|
|
if ($orders->count()) { |
|
823
|
|
|
if ($order = $orders->First()) { |
|
824
|
|
|
return OrderConfirmationPage::get_email_link($order->ID, $this->getEmailClassName(), $actuallySendEmail = false, $alternativeOrderStepID = $this->ID); |
|
825
|
|
|
} |
|
826
|
|
|
} |
|
827
|
|
|
} |
|
828
|
|
|
} |
|
829
|
|
|
|
|
830
|
|
|
/** |
|
831
|
|
|
* Has an email been sent to the customer for this |
|
832
|
|
|
* order step. |
|
833
|
|
|
*"-10 days". |
|
834
|
|
|
* |
|
835
|
|
|
* @param Order $order |
|
836
|
|
|
* @param bool $checkDateOfOrder |
|
837
|
|
|
* |
|
838
|
|
|
* @return bool |
|
839
|
|
|
**/ |
|
840
|
|
|
public function hasBeenSent(Order $order, $checkDateOfOrder = true) |
|
841
|
|
|
{ |
|
842
|
|
|
//if it has been more than a XXX days since the order was last edited (submitted) then we do not send emails as |
|
843
|
|
|
//this would be embarrasing. |
|
844
|
|
|
if ($checkDateOfOrder) { |
|
845
|
|
|
if ($log = $order->SubmissionLog()) { |
|
846
|
|
|
$lastEditedValue = $log->LastEdited; |
|
847
|
|
|
} else { |
|
848
|
|
|
$lastEditedValue = $order->LastEdited; |
|
849
|
|
|
} |
|
850
|
|
|
if ((strtotime($lastEditedValue) < strtotime('-'.EcommerceConfig::get('OrderStep', 'number_of_days_to_send_update_email').' days'))) { |
|
851
|
|
|
return true; |
|
852
|
|
|
} |
|
853
|
|
|
} |
|
854
|
|
|
$count = OrderEmailRecord::get() |
|
855
|
|
|
->Filter(array( |
|
856
|
|
|
'OrderID' => $order->ID, |
|
857
|
|
|
'OrderStepID' => $this->ID, |
|
858
|
|
|
'Result' => 1, |
|
859
|
|
|
)) |
|
860
|
|
|
->count(); |
|
861
|
|
|
|
|
862
|
|
|
return $count ? true : false; |
|
863
|
|
|
} |
|
864
|
|
|
|
|
865
|
|
|
/** |
|
866
|
|
|
* For some ordersteps this returns true... |
|
867
|
|
|
* |
|
868
|
|
|
* @return bool |
|
869
|
|
|
**/ |
|
870
|
|
|
protected function hasCustomerMessage() |
|
871
|
|
|
{ |
|
872
|
|
|
return false; |
|
873
|
|
|
} |
|
874
|
|
|
|
|
875
|
|
|
|
|
876
|
|
|
/** |
|
877
|
|
|
* Formatted answer for "hasCustomerMessage". |
|
878
|
|
|
* |
|
879
|
|
|
* @return string |
|
880
|
|
|
*/ |
|
881
|
|
|
public function HasCustomerMessageNice() |
|
882
|
|
|
{ |
|
883
|
|
|
return $this->getHasCustomerMessageNice(); |
|
884
|
|
|
} |
|
885
|
|
|
public function getHasCustomerMessageNice() |
|
886
|
|
|
{ |
|
887
|
|
|
return $this->hasCustomerMessage() ? _t('OrderStep.YES', 'Yes') : _t('OrderStep.NO', 'No'); |
|
888
|
|
|
} |
|
889
|
|
|
|
|
890
|
|
|
/** |
|
891
|
|
|
* Formatted answer for "hasCustomerMessage". |
|
892
|
|
|
* |
|
893
|
|
|
* @return string |
|
|
|
|
|
|
894
|
|
|
*/ |
|
895
|
|
|
public function ShowAsSummary() |
|
896
|
|
|
{ |
|
897
|
|
|
return $this->getShowAsSummary(); |
|
898
|
|
|
} |
|
899
|
|
|
|
|
900
|
|
|
/** |
|
901
|
|
|
* |
|
902
|
|
|
* |
|
903
|
|
|
* @return string |
|
|
|
|
|
|
904
|
|
|
*/ |
|
905
|
|
|
public function getShowAsSummary() |
|
906
|
|
|
{ |
|
907
|
|
|
$v = '<strong>'; |
|
908
|
|
|
if ($this->ShowAsUncompletedOrder) { |
|
|
|
|
|
|
909
|
|
|
$v .= _t('OrderStep.UNCOMPLETED', 'Uncompleted'); |
|
910
|
|
|
} elseif ($this->ShowAsInProcessOrder) { |
|
|
|
|
|
|
911
|
|
|
$v .= _t('OrderStep.INPROCESS', 'In process'); |
|
912
|
|
|
} elseif ($this->ShowAsCompletedOrder) { |
|
|
|
|
|
|
913
|
|
|
$v .= _t('OrderStep.COMPLETED', 'Completed'); |
|
914
|
|
|
} |
|
915
|
|
|
$v .= '</strong>'; |
|
916
|
|
|
$canArray = array(); |
|
917
|
|
|
if ($this->CustomerCanEdit) { |
|
|
|
|
|
|
918
|
|
|
$canArray[] = _t('OrderStep.EDITABLE', 'edit'); |
|
919
|
|
|
} |
|
920
|
|
|
if ($this->CustomerCanPay) { |
|
|
|
|
|
|
921
|
|
|
$canArray[] = _t('OrderStep.PAY', 'pay'); |
|
922
|
|
|
} |
|
923
|
|
|
if ($this->CustomerCanCancel) { |
|
|
|
|
|
|
924
|
|
|
$canArray[] = _t('OrderStep.CANCEL', 'cancel'); |
|
925
|
|
|
} |
|
926
|
|
|
if (count($canArray)) { |
|
927
|
|
|
$v .= '<br />'._t('OrderStep.CUSTOMER_CAN', 'Customer Can').': '.implode(', ', $canArray).''; |
|
928
|
|
|
} |
|
929
|
|
|
if ($this->hasCustomerMessage()) { |
|
930
|
|
|
$v .= '<br />'._t('OrderStep.CUSTOMER_MESSAGES', 'Includes message to customer'); |
|
931
|
|
|
} |
|
932
|
|
|
if ($this->DeferTimeInSeconds) { |
|
|
|
|
|
|
933
|
|
|
$v .= '<br />'.$this->humanReadeableDeferTimeInSeconds(); |
|
934
|
|
|
} |
|
935
|
|
|
|
|
936
|
|
|
return DBField::create_field('HTMLText', $v); |
|
937
|
|
|
} |
|
938
|
|
|
|
|
939
|
|
|
/** |
|
940
|
|
|
* @return string |
|
|
|
|
|
|
941
|
|
|
*/ |
|
942
|
|
|
protected function humanReadeableDeferTimeInSeconds() |
|
943
|
|
|
{ |
|
944
|
|
|
if ($this->canBeDefered()) { |
|
945
|
|
|
$field = DBField::create_field('SS_DateTime', strtotime('+ '.$this->DeferTimeInSeconds.' seconds')); |
|
|
|
|
|
|
946
|
|
|
$descr0 = _t('OrderStep.THE', 'The').' '.'<span style="color: #338DC1">'.$this->getTitle().'</span>'; |
|
947
|
|
|
$descr1 = _t('OrderStep.DELAY_VALUE', 'Order Step, for any order, will run'); |
|
948
|
|
|
$descr2 = $field->ago(); |
|
949
|
|
|
$descr3 = $this->DeferFromSubmitTime ? |
|
|
|
|
|
|
950
|
|
|
_t('OrderStep.FROM_ORDER_SUBMIT_TIME', 'from the order being submitted') : |
|
951
|
|
|
_t('OrderStep.FROM_START_OF_ORDSTEP', 'from the order arriving on this step'); |
|
952
|
|
|
return $descr0. ' ' . $descr1.' <span style="color: #338DC1">'.$descr2.'</span> '.$descr3.'.'; |
|
953
|
|
|
} |
|
954
|
|
|
// $dtF = new \DateTime('@0'); |
|
|
|
|
|
|
955
|
|
|
// $dtT = new \DateTime("@".$this->DeferTimeInSeconds); |
|
|
|
|
|
|
956
|
|
|
// |
|
957
|
|
|
// return $dtF->diff($dtT)->format('%a days, %h hours, %i minutes and %s seconds'); |
|
|
|
|
|
|
958
|
|
|
} |
|
959
|
|
|
|
|
960
|
|
|
/** |
|
961
|
|
|
* Formatted answer for "hasCustomerMessage". |
|
962
|
|
|
* |
|
963
|
|
|
* @return string |
|
|
|
|
|
|
964
|
|
|
*/ |
|
965
|
|
|
public function NameAndDescription() |
|
966
|
|
|
{ |
|
967
|
|
|
return $this->getNameAndDescription(); |
|
968
|
|
|
} |
|
969
|
|
|
|
|
970
|
|
|
public function getNameAndDescription() |
|
971
|
|
|
{ |
|
972
|
|
|
$v = '<strong>'.$this->Name.'</strong><br /><em>'.$this->Description.'</em>'; |
|
|
|
|
|
|
973
|
|
|
|
|
974
|
|
|
return DBField::create_field('HTMLText', $v); |
|
975
|
|
|
} |
|
976
|
|
|
|
|
977
|
|
|
/** |
|
978
|
|
|
* This allows you to set the time to something other than the standard DeferTimeInSeconds |
|
979
|
|
|
* value based on the order provided. |
|
980
|
|
|
* |
|
981
|
|
|
* @param Order |
|
982
|
|
|
* |
|
983
|
|
|
* @return int |
|
984
|
|
|
*/ |
|
985
|
|
|
public function CalculatedDeferTimeInSeconds($order) |
|
|
|
|
|
|
986
|
|
|
{ |
|
987
|
|
|
return $this->DeferTimeInSeconds; |
|
|
|
|
|
|
988
|
|
|
} |
|
989
|
|
|
|
|
990
|
|
|
/** |
|
991
|
|
|
* can this order step be delayed? |
|
992
|
|
|
* in general, if there is a customer message |
|
993
|
|
|
* we should be able to delay it |
|
994
|
|
|
* |
|
995
|
|
|
* This method can be overridden in any orderstep |
|
996
|
|
|
* @return bool |
|
997
|
|
|
**/ |
|
998
|
|
|
protected function canBeDefered() |
|
999
|
|
|
{ |
|
1000
|
|
|
return $this->hasCustomerMessage(); |
|
1001
|
|
|
} |
|
1002
|
|
|
|
|
1003
|
|
|
|
|
1004
|
|
|
/************************************************** |
|
1005
|
|
|
* Order Status Logs |
|
1006
|
|
|
**************************************************/ |
|
1007
|
|
|
|
|
1008
|
|
|
/** |
|
1009
|
|
|
* The OrderStatusLog that is relevant to the particular step. |
|
1010
|
|
|
* |
|
1011
|
|
|
* @var string |
|
1012
|
|
|
*/ |
|
1013
|
|
|
protected $relevantLogEntryClassName = ''; |
|
1014
|
|
|
|
|
1015
|
|
|
/** |
|
1016
|
|
|
* @return string |
|
1017
|
|
|
*/ |
|
1018
|
|
|
public function getRelevantLogEntryClassName() |
|
1019
|
|
|
{ |
|
1020
|
|
|
return $this->relevantLogEntryClassName; |
|
1021
|
|
|
} |
|
1022
|
|
|
|
|
1023
|
|
|
/** |
|
1024
|
|
|
* @param string |
|
1025
|
|
|
*/ |
|
1026
|
|
|
public function setRelevantLogEntryClassName($s) |
|
1027
|
|
|
{ |
|
1028
|
|
|
$this->relevantLogEntryClassName = $s; |
|
1029
|
|
|
} |
|
1030
|
|
|
|
|
1031
|
|
|
/** |
|
1032
|
|
|
* returns the OrderStatusLog that is relevant to this step. |
|
1033
|
|
|
* |
|
1034
|
|
|
* @param Order $order |
|
1035
|
|
|
* |
|
1036
|
|
|
* @return OrderStatusLog | null |
|
1037
|
|
|
*/ |
|
1038
|
|
|
public function RelevantLogEntry(Order $order) |
|
1039
|
|
|
{ |
|
1040
|
|
|
if ($className = $this->getRelevantLogEntryClassName()) { |
|
|
|
|
|
|
1041
|
|
|
return $this->RelevantLogEntries($order)->Last(); |
|
1042
|
|
|
} |
|
1043
|
|
|
} |
|
1044
|
|
|
|
|
1045
|
|
|
/** |
|
1046
|
|
|
* returns the OrderStatusLogs that are relevant to this step. |
|
1047
|
|
|
* |
|
1048
|
|
|
* @param Order $order |
|
1049
|
|
|
* |
|
1050
|
|
|
* @return DataObjectSet | null |
|
1051
|
|
|
*/ |
|
1052
|
|
|
public function RelevantLogEntries(Order $order) |
|
1053
|
|
|
{ |
|
1054
|
|
|
if ($className = $this->getRelevantLogEntryClassName()) { |
|
1055
|
|
|
return $className::get()->filter(array('OrderID' => $order->ID)); |
|
1056
|
|
|
} |
|
1057
|
|
|
} |
|
1058
|
|
|
|
|
1059
|
|
|
/************************************************** |
|
1060
|
|
|
* Silverstripe Standard Data Object Methods |
|
1061
|
|
|
**************************************************/ |
|
1062
|
|
|
|
|
1063
|
|
|
/** |
|
1064
|
|
|
* Standard SS method |
|
1065
|
|
|
* These are only created programmatically. |
|
1066
|
|
|
* |
|
1067
|
|
|
* @param Member $member |
|
|
|
|
|
|
1068
|
|
|
* |
|
1069
|
|
|
* @return bool |
|
1070
|
|
|
*/ |
|
1071
|
|
|
public function canCreate($member = null) |
|
1072
|
|
|
{ |
|
1073
|
|
|
return false; |
|
1074
|
|
|
} |
|
1075
|
|
|
|
|
1076
|
|
|
/** |
|
1077
|
|
|
* Standard SS method. |
|
1078
|
|
|
* |
|
1079
|
|
|
* @param Member $member |
|
|
|
|
|
|
1080
|
|
|
* |
|
1081
|
|
|
* @return bool |
|
|
|
|
|
|
1082
|
|
|
*/ |
|
1083
|
|
|
public function canView($member = null) |
|
1084
|
|
|
{ |
|
1085
|
|
|
if (! $member) { |
|
1086
|
|
|
$member = Member::currentUser(); |
|
1087
|
|
|
} |
|
1088
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
|
|
|
|
|
1089
|
|
|
if ($extended !== null) { |
|
1090
|
|
|
return $extended; |
|
1091
|
|
|
} |
|
1092
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
|
1093
|
|
|
return true; |
|
1094
|
|
|
} |
|
1095
|
|
|
|
|
1096
|
|
|
return parent::canEdit($member); |
|
|
|
|
|
|
1097
|
|
|
} |
|
1098
|
|
|
|
|
1099
|
|
|
/** |
|
1100
|
|
|
* the default for this is TRUE, but for completed order steps |
|
1101
|
|
|
* |
|
1102
|
|
|
* we do not allow this. |
|
1103
|
|
|
* |
|
1104
|
|
|
* @param Order $order |
|
1105
|
|
|
* @param Member $member optional |
|
|
|
|
|
|
1106
|
|
|
* @return bool |
|
1107
|
|
|
*/ |
|
1108
|
|
|
public function canOverrideCanViewForOrder($order, $member = null) |
|
|
|
|
|
|
1109
|
|
|
{ |
|
1110
|
|
|
//return true if the order can have customer input |
|
1111
|
|
|
// orders recently saved can also be views |
|
1112
|
|
|
return |
|
1113
|
|
|
$this->CustomerCanEdit || |
|
|
|
|
|
|
1114
|
|
|
$this->CustomerCanCancel || |
|
|
|
|
|
|
1115
|
|
|
$this->CustomerCanPay; |
|
|
|
|
|
|
1116
|
|
|
} |
|
1117
|
|
|
|
|
1118
|
|
|
/** |
|
1119
|
|
|
* standard SS method. |
|
1120
|
|
|
* |
|
1121
|
|
|
* @param Member | NULL |
|
1122
|
|
|
* |
|
1123
|
|
|
* @return bool |
|
|
|
|
|
|
1124
|
|
|
*/ |
|
1125
|
|
|
public function canEdit($member = null) |
|
1126
|
|
|
{ |
|
1127
|
|
|
if (! $member) { |
|
1128
|
|
|
$member = Member::currentUser(); |
|
1129
|
|
|
} |
|
1130
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
1131
|
|
|
if ($extended !== null) { |
|
1132
|
|
|
return $extended; |
|
1133
|
|
|
} |
|
1134
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
|
1135
|
|
|
return true; |
|
1136
|
|
|
} |
|
1137
|
|
|
|
|
1138
|
|
|
return parent::canEdit($member); |
|
1139
|
|
|
} |
|
1140
|
|
|
|
|
1141
|
|
|
/** |
|
1142
|
|
|
* Standard SS method. |
|
1143
|
|
|
* |
|
1144
|
|
|
* @param Member $member |
|
|
|
|
|
|
1145
|
|
|
* |
|
1146
|
|
|
* @return bool |
|
|
|
|
|
|
1147
|
|
|
*/ |
|
1148
|
|
|
public function canDelete($member = null) |
|
1149
|
|
|
{ |
|
1150
|
|
|
//cant delete last status if there are orders with this status |
|
1151
|
|
|
$nextOrderStepObject = $this->NextOrderStep(); |
|
1152
|
|
|
if ($nextOrderStepObject) { |
|
|
|
|
|
|
1153
|
|
|
//do nothing |
|
1154
|
|
|
} else { |
|
1155
|
|
|
$orderCount = Order::get() |
|
1156
|
|
|
->filter(array('StatusID' => intval($this->ID) - 0)) |
|
1157
|
|
|
->count(); |
|
1158
|
|
|
if ($orderCount) { |
|
1159
|
|
|
return false; |
|
1160
|
|
|
} |
|
1161
|
|
|
} |
|
1162
|
|
|
if ($this->isDefaultStatusOption()) { |
|
1163
|
|
|
return false; |
|
1164
|
|
|
} |
|
1165
|
|
|
if (! $member) { |
|
1166
|
|
|
$member = Member::currentUser(); |
|
1167
|
|
|
} |
|
1168
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
|
|
|
|
|
1169
|
|
|
if ($extended !== null) { |
|
1170
|
|
|
return $extended; |
|
1171
|
|
|
} |
|
1172
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
|
1173
|
|
|
return true; |
|
1174
|
|
|
} |
|
1175
|
|
|
|
|
1176
|
|
|
return parent::canEdit($member); |
|
|
|
|
|
|
1177
|
|
|
} |
|
1178
|
|
|
|
|
1179
|
|
|
/** |
|
1180
|
|
|
* standard SS method. |
|
1181
|
|
|
*/ |
|
1182
|
|
|
public function onBeforeWrite() |
|
1183
|
|
|
{ |
|
1184
|
|
|
parent::onBeforeWrite(); |
|
1185
|
|
|
//make sure only one of three conditions applies ... |
|
1186
|
|
|
if ($this->ShowAsUncompletedOrder) { |
|
|
|
|
|
|
1187
|
|
|
$this->ShowAsInProcessOrder = false; |
|
|
|
|
|
|
1188
|
|
|
$this->ShowAsCompletedOrder = false; |
|
|
|
|
|
|
1189
|
|
|
} elseif ($this->ShowAsInProcessOrder) { |
|
|
|
|
|
|
1190
|
|
|
$this->ShowAsUncompletedOrder = false; |
|
|
|
|
|
|
1191
|
|
|
$this->ShowAsCompletedOrder = false; |
|
|
|
|
|
|
1192
|
|
|
} elseif ($this->ShowAsCompletedOrder) { |
|
|
|
|
|
|
1193
|
|
|
$this->ShowAsUncompletedOrder = false; |
|
|
|
|
|
|
1194
|
|
|
$this->ShowAsInProcessOrder = false; |
|
|
|
|
|
|
1195
|
|
|
} |
|
1196
|
|
|
if (! $this->canBeDefered()) { |
|
1197
|
|
|
$this->DeferTimeInSeconds = 0; |
|
|
|
|
|
|
1198
|
|
|
$this->DeferFromSubmitTime = 0; |
|
|
|
|
|
|
1199
|
|
|
} else { |
|
1200
|
|
|
if (is_numeric($this->DeferTimeInSeconds)) { |
|
|
|
|
|
|
1201
|
|
|
$this->DeferTimeInSeconds = intval($this->DeferTimeInSeconds); |
|
|
|
|
|
|
1202
|
|
|
} else { |
|
1203
|
|
|
$this->DeferTimeInSeconds = strtotime('+'.$this->DeferTimeInSeconds); |
|
|
|
|
|
|
1204
|
|
|
if ($this->DeferTimeInSeconds > 0) { |
|
|
|
|
|
|
1205
|
|
|
$this->DeferTimeInSeconds = $this->DeferTimeInSeconds - time(); |
|
|
|
|
|
|
1206
|
|
|
} |
|
1207
|
|
|
} |
|
1208
|
|
|
} |
|
1209
|
|
|
$this->Code = strtoupper($this->Code); |
|
|
|
|
|
|
1210
|
|
|
} |
|
1211
|
|
|
|
|
1212
|
|
|
/** |
|
1213
|
|
|
* move linked orders to the next status |
|
1214
|
|
|
* standard SS method. |
|
1215
|
|
|
*/ |
|
1216
|
|
|
public function onBeforeDelete() |
|
1217
|
|
|
{ |
|
1218
|
|
|
parent::onBeforeDelete(); |
|
1219
|
|
|
$previousOrderStepObject = null; |
|
1220
|
|
|
$nextOrderStepObject = $this->NextOrderStep(); |
|
1221
|
|
|
//backup |
|
1222
|
|
|
if ($nextOrderStepObject) { |
|
|
|
|
|
|
1223
|
|
|
//do nothing |
|
1224
|
|
|
} else { |
|
1225
|
|
|
$previousOrderStepObject = $this->PreviousOrderStep(); |
|
1226
|
|
|
} |
|
1227
|
|
|
if ($previousOrderStepObject) { |
|
1228
|
|
|
$ordersWithThisStatus = Order::get()->filter(array('StatusID' => $this->ID)); |
|
1229
|
|
|
if ($ordersWithThisStatus && $ordersWithThisStatus->count()) { |
|
1230
|
|
|
foreach ($ordersWithThisStatus as $orderWithThisStatus) { |
|
1231
|
|
|
$orderWithThisStatus->StatusID = $previousOrderStepObject->ID; |
|
1232
|
|
|
$orderWithThisStatus->write(); |
|
1233
|
|
|
} |
|
1234
|
|
|
} |
|
1235
|
|
|
} |
|
1236
|
|
|
} |
|
1237
|
|
|
|
|
1238
|
|
|
/** |
|
1239
|
|
|
* standard SS method. |
|
1240
|
|
|
*/ |
|
1241
|
|
|
public function onAfterDelete() |
|
1242
|
|
|
{ |
|
1243
|
|
|
parent::onAfterDelete(); |
|
1244
|
|
|
$this->requireDefaultRecords(); |
|
1245
|
|
|
} |
|
1246
|
|
|
|
|
1247
|
|
|
protected function NextOrderStep() |
|
1248
|
|
|
{ |
|
1249
|
|
|
return OrderStep::get() |
|
1250
|
|
|
->filter(array('Sort:GreaterThan' => $this->Sort)) |
|
|
|
|
|
|
1251
|
|
|
->First(); |
|
1252
|
|
|
} |
|
1253
|
|
|
|
|
1254
|
|
|
protected function PreviousOrderStep() |
|
1255
|
|
|
{ |
|
1256
|
|
|
return OrderStep::get() |
|
1257
|
|
|
->filter(array('Sort:LessThan' => $this->Sort)) |
|
|
|
|
|
|
1258
|
|
|
->First(); |
|
1259
|
|
|
} |
|
1260
|
|
|
|
|
1261
|
|
|
/** |
|
1262
|
|
|
* standard SS method |
|
1263
|
|
|
* USED TO BE: Unpaid,Query,Paid,Processing,Sent,Complete,AdminCancelled,MemberCancelled,Cart. |
|
1264
|
|
|
*/ |
|
1265
|
|
|
public function requireDefaultRecords() |
|
1266
|
|
|
{ |
|
1267
|
|
|
parent::requireDefaultRecords(); |
|
1268
|
|
|
$orderStepsToInclude = EcommerceConfig::get('OrderStep', 'order_steps_to_include'); |
|
1269
|
|
|
$codesToInclude = self::get_codes_for_order_steps_to_include(); |
|
1270
|
|
|
$indexNumber = 0; |
|
1271
|
|
|
if ($orderStepsToInclude && count($orderStepsToInclude)) { |
|
1272
|
|
|
if ($codesToInclude && count($codesToInclude)) { |
|
|
|
|
|
|
1273
|
|
|
foreach ($codesToInclude as $className => $code) { |
|
1274
|
|
|
$code = strtoupper($code); |
|
1275
|
|
|
$filter = array('ClassName' => $className); |
|
1276
|
|
|
$indexNumber += 10; |
|
1277
|
|
|
$itemCount = OrderStep::get()->filter($filter)->Count(); |
|
1278
|
|
|
if ($itemCount) { |
|
1279
|
|
|
$obj = OrderStep::get()->filter($filter)->First(); |
|
1280
|
|
|
if ($obj->Code != $code) { |
|
1281
|
|
|
$obj->Code = $code; |
|
1282
|
|
|
$obj->write(); |
|
1283
|
|
|
} |
|
1284
|
|
|
$parentObj = singleton('OrderStep'); |
|
1285
|
|
|
if ($obj->Description == $parentObj->myDescription()) { |
|
1286
|
|
|
$obj->Description = $obj->myDescription(); |
|
1287
|
|
|
$obj->write(); |
|
1288
|
|
|
} |
|
1289
|
|
|
} else { |
|
1290
|
|
|
$obj = $className::create(); |
|
1291
|
|
|
$obj->Code = $code; |
|
1292
|
|
|
$obj->Description = $obj->myDescription(); |
|
1293
|
|
|
$obj->write(); |
|
1294
|
|
|
DB::alteration_message("Created \"$code\" as $className.", 'created'); |
|
1295
|
|
|
} |
|
1296
|
|
|
$obj = OrderStep::get() |
|
1297
|
|
|
->filter(array('Code' => strtoupper($code))) |
|
1298
|
|
|
->First(); |
|
1299
|
|
|
if ($obj) { |
|
1300
|
|
|
if ($obj->Sort != $indexNumber) { |
|
1301
|
|
|
$obj->Sort = $indexNumber; |
|
1302
|
|
|
$obj->write(); |
|
1303
|
|
|
} |
|
1304
|
|
|
} else { |
|
1305
|
|
|
user_error("There was an error in creating the $code OrderStep"); |
|
1306
|
|
|
} |
|
1307
|
|
|
} |
|
1308
|
|
|
} |
|
1309
|
|
|
} |
|
1310
|
|
|
$steps = OrderStep::get(); |
|
1311
|
|
|
foreach ($steps as $step) { |
|
1312
|
|
|
if (!$step->Description) { |
|
1313
|
|
|
$step->Description = $step->myDescription(); |
|
1314
|
|
|
$step->write(); |
|
1315
|
|
|
} |
|
1316
|
|
|
} |
|
1317
|
|
|
} |
|
1318
|
|
|
|
|
1319
|
|
|
/** |
|
1320
|
|
|
* returns the standard EcommerceDBConfig for use within OrderSteps. |
|
1321
|
|
|
* |
|
1322
|
|
|
* @return EcommerceDBConfig |
|
1323
|
|
|
*/ |
|
1324
|
|
|
protected function EcomConfig() |
|
1325
|
|
|
{ |
|
1326
|
|
|
return EcommerceDBConfig::current_ecommerce_db_config(); |
|
1327
|
|
|
} |
|
1328
|
|
|
|
|
1329
|
|
|
/** |
|
1330
|
|
|
* Explains the current order step. |
|
1331
|
|
|
* |
|
1332
|
|
|
* @return string |
|
1333
|
|
|
*/ |
|
1334
|
|
|
protected function myDescription() |
|
1335
|
|
|
{ |
|
1336
|
|
|
return _t('OrderStep.DESCRIPTION', 'No description has been provided for this step.'); |
|
1337
|
|
|
} |
|
1338
|
|
|
} |
|
1339
|
|
|
|
You can fix this by adding a namespace to your class:
When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries.