|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* @Description: DataObject recording all order emails sent. |
|
5
|
|
|
* |
|
6
|
|
|
* |
|
7
|
|
|
* @authors: Silverstripe, Jeremy, Nicolaas |
|
8
|
|
|
* |
|
9
|
|
|
* |
|
10
|
|
|
* @authors: Nicolaas [at] Sunny Side Up .co.nz |
|
11
|
|
|
* @package: ecommerce |
|
12
|
|
|
* @sub-package: model |
|
13
|
|
|
* @inspiration: Silverstripe Ltd, Jeremy |
|
14
|
|
|
**/ |
|
15
|
|
|
class OrderEmailRecord extends DataObject implements EditableEcommerceObject |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* standard SS variable. |
|
19
|
|
|
* |
|
20
|
|
|
* @var array |
|
21
|
|
|
*/ |
|
22
|
|
|
private static $db = array( |
|
|
|
|
|
|
23
|
|
|
'From' => 'Varchar(255)', |
|
24
|
|
|
'To' => 'Varchar(255)', |
|
25
|
|
|
'Subject' => 'Varchar(255)', |
|
26
|
|
|
'Content' => 'HTMLText', |
|
27
|
|
|
'Result' => 'Boolean', |
|
28
|
|
|
); |
|
29
|
|
|
|
|
30
|
|
|
/** |
|
31
|
|
|
* standard SS variable. |
|
32
|
|
|
* |
|
33
|
|
|
* @var array |
|
34
|
|
|
*/ |
|
35
|
|
|
private static $has_one = array( |
|
|
|
|
|
|
36
|
|
|
'Order' => 'Order', |
|
37
|
|
|
'OrderStep' => 'OrderStep', |
|
38
|
|
|
); |
|
39
|
|
|
|
|
40
|
|
|
/** |
|
41
|
|
|
* standard SS variable. |
|
42
|
|
|
* |
|
43
|
|
|
* @var array |
|
44
|
|
|
*/ |
|
45
|
|
|
private static $casting = array( |
|
|
|
|
|
|
46
|
|
|
'Title' => 'Varchar', |
|
47
|
|
|
'OrderStepNice' => 'Varchar', |
|
48
|
|
|
'ResultNice' => 'Varchar', |
|
49
|
|
|
); |
|
50
|
|
|
|
|
51
|
|
|
/** |
|
52
|
|
|
* standard SS variable. |
|
53
|
|
|
* |
|
54
|
|
|
* @var array |
|
55
|
|
|
*/ |
|
56
|
|
|
private static $summary_fields = array( |
|
|
|
|
|
|
57
|
|
|
'Created' => 'Send', |
|
58
|
|
|
'OrderStepNice' => 'Order Step', |
|
59
|
|
|
'From' => 'From', |
|
60
|
|
|
'To' => 'To', |
|
61
|
|
|
'Subject' => 'Subject', |
|
62
|
|
|
'ResultNice' => 'Sent Succesfully', |
|
63
|
|
|
); |
|
64
|
|
|
|
|
65
|
|
|
/** |
|
66
|
|
|
* standard SS variable. |
|
67
|
|
|
* |
|
68
|
|
|
* @var array |
|
69
|
|
|
*/ |
|
70
|
|
|
private static $field_labels = array( |
|
|
|
|
|
|
71
|
|
|
'Created' => 'Send', |
|
72
|
|
|
'OrderStepNice' => 'Order Step', |
|
73
|
|
|
'From' => 'From', |
|
74
|
|
|
'To' => 'To', |
|
75
|
|
|
'Subject' => 'Subject', |
|
76
|
|
|
'ResultNice' => 'Sent Succesfully', |
|
77
|
|
|
); |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* standard SS variable. |
|
81
|
|
|
* |
|
82
|
|
|
* @var array |
|
83
|
|
|
*/ |
|
84
|
|
|
private static $searchable_fields = array( |
|
|
|
|
|
|
85
|
|
|
'OrderID' => array( |
|
86
|
|
|
'field' => 'NumericField', |
|
87
|
|
|
'title' => 'Order Number', |
|
88
|
|
|
), |
|
89
|
|
|
'From' => 'PartialMatchFilter', |
|
90
|
|
|
'To' => 'PartialMatchFilter', |
|
91
|
|
|
'Subject' => 'PartialMatchFilter', |
|
92
|
|
|
//make sure to keep the item below, otherwise they do not show in form |
|
93
|
|
|
'OrderStepID' => array( |
|
94
|
|
|
'filter' => 'OrderEmailRecordFilters_MultiOptionsetStatusIDFilter', |
|
95
|
|
|
), |
|
96
|
|
|
'Result' => true, |
|
97
|
|
|
); |
|
98
|
|
|
|
|
99
|
|
|
/** |
|
100
|
|
|
* casted Variable. |
|
101
|
|
|
* |
|
102
|
|
|
* @var string |
|
103
|
|
|
*/ |
|
104
|
|
|
public function ResultNice() |
|
105
|
|
|
{ |
|
106
|
|
|
return $this->getResultNice(); |
|
107
|
|
|
} |
|
108
|
|
|
public function getResultNice() |
|
109
|
|
|
{ |
|
110
|
|
|
if ($this->Result) { |
|
|
|
|
|
|
111
|
|
|
return _t('OrderEmailRecord.YES', 'Yes'); |
|
112
|
|
|
} |
|
113
|
|
|
|
|
114
|
|
|
return _t('OrderEmailRecord.NO', 'No'); |
|
115
|
|
|
} |
|
116
|
|
|
|
|
117
|
|
|
/** |
|
118
|
|
|
* standard SS variable. |
|
119
|
|
|
* |
|
120
|
|
|
* @var string |
|
121
|
|
|
*/ |
|
122
|
|
|
private static $singular_name = 'Customer Email'; |
|
|
|
|
|
|
123
|
|
|
public function i18n_singular_name() |
|
124
|
|
|
{ |
|
125
|
|
|
return _t('OrderEmailRecord.CUSTOMEREMAIL', 'Customer Email'); |
|
126
|
|
|
} |
|
127
|
|
|
|
|
128
|
|
|
/** |
|
129
|
|
|
* standard SS variable. |
|
130
|
|
|
* |
|
131
|
|
|
* @var string |
|
132
|
|
|
*/ |
|
133
|
|
|
private static $plural_name = 'Customer Emails'; |
|
|
|
|
|
|
134
|
|
|
public function i18n_plural_name() |
|
135
|
|
|
{ |
|
136
|
|
|
return _t('OrderEmailRecord.CUSTOMEREMAILS', 'Customer Emails'); |
|
137
|
|
|
} |
|
138
|
|
|
|
|
139
|
|
|
/** |
|
140
|
|
|
* Standard SS variable. |
|
141
|
|
|
* |
|
142
|
|
|
* @var string |
|
143
|
|
|
*/ |
|
144
|
|
|
private static $description = 'A record of any email that has been sent in relation to an order.'; |
|
145
|
|
|
|
|
146
|
|
|
/** |
|
147
|
|
|
* standard SS method. |
|
148
|
|
|
* |
|
149
|
|
|
* @param Member $member |
|
|
|
|
|
|
150
|
|
|
* |
|
151
|
|
|
* @return bool |
|
152
|
|
|
*/ |
|
153
|
|
|
public function canCreate($member = null) |
|
154
|
|
|
{ |
|
155
|
|
|
return false; |
|
156
|
|
|
} |
|
157
|
|
|
|
|
158
|
|
|
/** |
|
159
|
|
|
* standard SS method. |
|
160
|
|
|
* |
|
161
|
|
|
* @param Member $member |
|
|
|
|
|
|
162
|
|
|
* |
|
163
|
|
|
* @return bool |
|
164
|
|
|
*/ |
|
165
|
|
|
public function canView($member = null) |
|
166
|
|
|
{ |
|
167
|
|
|
if (! $member) { |
|
168
|
|
|
$member = Member::currentUser(); |
|
169
|
|
|
} |
|
170
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
|
|
|
|
|
171
|
|
|
if ($extended !== null) { |
|
172
|
|
|
return $extended; |
|
173
|
|
|
} |
|
174
|
|
|
$order = $this->Order(); |
|
|
|
|
|
|
175
|
|
|
if ($order && $order->exists()) { |
|
176
|
|
|
return $order->canView(); |
|
177
|
|
|
} |
|
178
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
|
179
|
|
|
return true; |
|
180
|
|
|
} |
|
181
|
|
|
|
|
182
|
|
|
return parent::canEdit($member); |
|
|
|
|
|
|
183
|
|
|
} |
|
184
|
|
|
|
|
185
|
|
|
/** |
|
186
|
|
|
* standard SS method. |
|
187
|
|
|
* |
|
188
|
|
|
* @param Member $member |
|
|
|
|
|
|
189
|
|
|
* |
|
190
|
|
|
* @return bool |
|
191
|
|
|
*/ |
|
192
|
|
|
public function canEdit($member = null) |
|
193
|
|
|
{ |
|
194
|
|
|
return false; |
|
195
|
|
|
} |
|
196
|
|
|
|
|
197
|
|
|
/** |
|
198
|
|
|
* standard SS method. |
|
199
|
|
|
* |
|
200
|
|
|
* @param Member $member |
|
|
|
|
|
|
201
|
|
|
* |
|
202
|
|
|
* @return bool |
|
203
|
|
|
*/ |
|
204
|
|
|
public function canDelete($member = null) |
|
205
|
|
|
{ |
|
206
|
|
|
return false; |
|
207
|
|
|
} |
|
208
|
|
|
|
|
209
|
|
|
//defaults |
|
210
|
|
|
|
|
211
|
|
|
/** |
|
212
|
|
|
* standard SS variable. |
|
213
|
|
|
* |
|
214
|
|
|
* @return string |
|
215
|
|
|
*/ |
|
216
|
|
|
private static $default_sort = [ |
|
|
|
|
|
|
217
|
|
|
'ID' => 'ASC' |
|
218
|
|
|
]; |
|
219
|
|
|
|
|
220
|
|
|
private static $indexes = [ |
|
|
|
|
|
|
221
|
|
|
'From' => true, |
|
222
|
|
|
'To' => true, |
|
223
|
|
|
'Result' => true |
|
224
|
|
|
]; |
|
225
|
|
|
|
|
226
|
|
|
/** |
|
227
|
|
|
* standard SS method. |
|
228
|
|
|
* |
|
229
|
|
|
* @return FieldList |
|
230
|
|
|
*/ |
|
231
|
|
|
public function getCMSFields() |
|
232
|
|
|
{ |
|
233
|
|
|
$fields = parent::getCMSFields(); |
|
234
|
|
|
$fields->addFieldsToTab( |
|
235
|
|
|
'Root.Details', |
|
236
|
|
|
array( |
|
237
|
|
|
$fields->dataFieldByName("To"), |
|
238
|
|
|
$fields->dataFieldByName("Subject"), |
|
239
|
|
|
$fields->dataFieldByName("From"), |
|
240
|
|
|
$fields->dataFieldByName("Result"), |
|
241
|
|
|
$fields->dataFieldByName("OrderID"), |
|
242
|
|
|
$fields->dataFieldByName("OrderStepID") |
|
243
|
|
|
) |
|
244
|
|
|
); |
|
245
|
|
|
$emailLink = OrderEmailRecord_Review::review_link($this); |
|
246
|
|
|
$fields->replaceField('Content', new LiteralField('Content', "<iframe src=\"$emailLink\" width=\"100%\" height=\"700\" style=\"border: 5px solid #2e7ead; border-radius: 2px;\"></iframe>")); |
|
247
|
|
|
$fields->replaceField('OrderID', $fields->dataFieldByName('OrderID')->performReadonlyTransformation()); |
|
248
|
|
|
$fields->replaceField('OrderStepID', new ReadonlyField('OrderStepNice', 'Order Step', $this->OrderStepNice())); |
|
249
|
|
|
|
|
250
|
|
|
return $fields; |
|
251
|
|
|
} |
|
252
|
|
|
|
|
253
|
|
|
/** |
|
254
|
|
|
* link to edit the record. |
|
255
|
|
|
* |
|
256
|
|
|
* @param string | Null $action - e.g. edit |
|
257
|
|
|
* |
|
258
|
|
|
* @return string |
|
|
|
|
|
|
259
|
|
|
*/ |
|
260
|
|
|
public function CMSEditLink($action = null) |
|
261
|
|
|
{ |
|
262
|
|
|
return CMSEditLinkAPI::find_edit_link_for_object($this, $action); |
|
263
|
|
|
} |
|
264
|
|
|
|
|
265
|
|
|
/** |
|
266
|
|
|
* Determine which properties on the DataObject are |
|
267
|
|
|
* searchable, and map them to their default {@link FormField} |
|
268
|
|
|
* representations. Used for scaffolding a searchform for {@link ModelAdmin}. |
|
269
|
|
|
* |
|
270
|
|
|
* Some additional logic is included for switching field labels, based on |
|
271
|
|
|
* how generic or specific the field type is. |
|
272
|
|
|
* |
|
273
|
|
|
* Used by {@link SearchContext}. |
|
274
|
|
|
* |
|
275
|
|
|
* @param array $_params |
|
|
|
|
|
|
276
|
|
|
* 'fieldClasses': Associative array of field names as keys and FormField classes as values |
|
277
|
|
|
* 'restrictFields': Numeric array of a field name whitelist |
|
278
|
|
|
* |
|
279
|
|
|
* @return FieldList |
|
280
|
|
|
*/ |
|
281
|
|
|
public function scaffoldSearchFields($_params = null) |
|
282
|
|
|
{ |
|
283
|
|
|
$fieldList = parent::scaffoldSearchFields($_params); |
|
284
|
|
|
$fieldList->replaceField('OrderID', new NumericField('OrderID', 'Order Number')); |
|
285
|
|
|
$statusOptions = OrderStep::get(); |
|
286
|
|
|
if ($statusOptions && $statusOptions->count()) { |
|
287
|
|
|
$createdOrderStatusID = 0; |
|
|
|
|
|
|
288
|
|
|
$preSelected = array(); |
|
289
|
|
|
$createdOrderStatus = $statusOptions->First(); |
|
290
|
|
|
if ($createdOrderStatus) { |
|
291
|
|
|
$createdOrderStatusID = $createdOrderStatus->ID; |
|
|
|
|
|
|
292
|
|
|
} |
|
293
|
|
|
$arrayOfStatusOptions = clone $statusOptions->map('ID', 'Title'); |
|
294
|
|
|
$arrayOfStatusOptionsFinal = array(); |
|
295
|
|
|
if (count($arrayOfStatusOptions)) { |
|
296
|
|
|
foreach ($arrayOfStatusOptions as $key => $value) { |
|
297
|
|
|
if (isset($_GET['q']['OrderStepID'][$key])) { |
|
298
|
|
|
$preSelected[$key] = $key; |
|
299
|
|
|
} |
|
300
|
|
|
$count = OrderEmailRecord::get() |
|
301
|
|
|
->Filter(array('OrderStepID' => intval($key))) |
|
302
|
|
|
->count(); |
|
303
|
|
|
if ($count < 1) { |
|
304
|
|
|
//do nothing |
|
305
|
|
|
} else { |
|
306
|
|
|
$arrayOfStatusOptionsFinal[$key] = $value." ($count)"; |
|
307
|
|
|
} |
|
308
|
|
|
} |
|
309
|
|
|
} |
|
310
|
|
|
$statusField = new CheckboxSetField( |
|
311
|
|
|
'OrderStepID', |
|
312
|
|
|
Injector::inst()->get('OrderStep')->i18n_singular_name(), |
|
313
|
|
|
$arrayOfStatusOptionsFinal, |
|
314
|
|
|
$preSelected |
|
|
|
|
|
|
315
|
|
|
); |
|
316
|
|
|
$fieldList->push($statusField); |
|
317
|
|
|
} |
|
318
|
|
|
|
|
319
|
|
|
return $fieldList; |
|
320
|
|
|
} |
|
321
|
|
|
|
|
322
|
|
|
/** |
|
323
|
|
|
* casted variable. |
|
324
|
|
|
* |
|
325
|
|
|
*@ return String |
|
326
|
|
|
**/ |
|
327
|
|
|
public function Title() |
|
328
|
|
|
{ |
|
329
|
|
|
return $this->getTitle(); |
|
330
|
|
|
} |
|
331
|
|
|
public function getTitle() |
|
332
|
|
|
{ |
|
333
|
|
|
$str = 'TO: '.$this->To; |
|
|
|
|
|
|
334
|
|
|
if ($order = $this->Order()) { |
|
|
|
|
|
|
335
|
|
|
$str .= ' - '.$this->Order()->getTitle(); |
|
|
|
|
|
|
336
|
|
|
$str .= ' - '.$this->OrderStepNice(); |
|
337
|
|
|
} |
|
338
|
|
|
|
|
339
|
|
|
return $str; |
|
340
|
|
|
} |
|
341
|
|
|
|
|
342
|
|
|
/** |
|
343
|
|
|
* casted variable. |
|
344
|
|
|
* |
|
345
|
|
|
*@ return String |
|
346
|
|
|
**/ |
|
347
|
|
|
public function OrderStepNice() |
|
|
|
|
|
|
348
|
|
|
{ |
|
349
|
|
|
return $this->getOrderStepNice(); |
|
350
|
|
|
} |
|
351
|
|
|
public function getOrderStepNice() |
|
|
|
|
|
|
352
|
|
|
{ |
|
353
|
|
|
if ($this->OrderStepID) { |
|
|
|
|
|
|
354
|
|
|
$orderStep = OrderStep::get()->byID($this->OrderStepID); |
|
|
|
|
|
|
355
|
|
|
if ($orderStep) { |
|
356
|
|
|
return $orderStep->Name; |
|
357
|
|
|
} |
|
358
|
|
|
} |
|
359
|
|
|
} |
|
360
|
|
|
|
|
361
|
|
|
/** |
|
362
|
|
|
* Debug helper method. |
|
363
|
|
|
* Can be called from /shoppingcart/debug/. |
|
364
|
|
|
* |
|
365
|
|
|
* @return string |
|
366
|
|
|
*/ |
|
367
|
|
|
public function debug() |
|
368
|
|
|
{ |
|
369
|
|
|
return EcommerceTaskDebugCart::debug_object($this); |
|
370
|
|
|
} |
|
371
|
|
|
} |
|
372
|
|
|
|