1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
|
4
|
|
|
/*** |
5
|
|
|
* Class used to describe the steps in the checkout |
6
|
|
|
* |
7
|
|
|
*/ |
8
|
|
|
|
9
|
|
|
class CheckoutPage_StepDescription extends DataObject implements EditableEcommerceObject |
10
|
|
|
{ |
11
|
|
|
/** |
12
|
|
|
* standard SS variable. |
13
|
|
|
* |
14
|
|
|
* @Var Array |
15
|
|
|
*/ |
16
|
|
|
private static $db = array( |
|
|
|
|
17
|
|
|
'Heading' => 'Varchar', |
18
|
|
|
'Above' => 'Text', |
19
|
|
|
'Below' => 'Text', |
20
|
|
|
'Code' => 'Varchar(100)' |
21
|
|
|
); |
22
|
|
|
|
23
|
|
|
/** |
24
|
|
|
* standard SS variable. |
25
|
|
|
* |
26
|
|
|
* @Var Array |
27
|
|
|
*/ |
28
|
|
|
private static $searchable_fields = array( |
|
|
|
|
29
|
|
|
'Heading' => 'PartialMatchFilter', |
30
|
|
|
'Above' => 'PartialMatchFilter', |
31
|
|
|
'Below' => 'PartialMatchFilter', |
32
|
|
|
); |
33
|
|
|
|
34
|
|
|
/** |
35
|
|
|
* standard SS variable. |
36
|
|
|
* |
37
|
|
|
* @Var Array |
38
|
|
|
*/ |
39
|
|
|
private static $field_labels = array( |
|
|
|
|
40
|
|
|
'Above' => 'Above Checkout Step', |
41
|
|
|
'Below' => 'Below Checkout Step', |
42
|
|
|
); |
43
|
|
|
|
44
|
|
|
/** |
45
|
|
|
* standard SS variable. |
46
|
|
|
* |
47
|
|
|
* @Var Array |
48
|
|
|
*/ |
49
|
|
|
private static $summary_fields = array( |
|
|
|
|
50
|
|
|
'ID' => 'Step Number', |
51
|
|
|
'Heading' => 'Heading', |
52
|
|
|
); |
53
|
|
|
|
54
|
|
|
private static $indexes = [ |
|
|
|
|
55
|
|
|
'Code' => true |
56
|
|
|
]; |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* standard SS variable. |
60
|
|
|
* |
61
|
|
|
* @Var Array |
62
|
|
|
*/ |
63
|
|
|
private static $casting = array( |
|
|
|
|
64
|
|
|
'Title' => 'Varchar', |
65
|
|
|
); |
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* standard SS variable. |
69
|
|
|
* |
70
|
|
|
* @Var String |
71
|
|
|
*/ |
72
|
|
|
private static $singular_name = 'Checkout Step Description'; |
|
|
|
|
73
|
|
|
public function i18n_singular_name() |
74
|
|
|
{ |
75
|
|
|
return _t('CheckoutPage.CHECKOUTSTEPDESCRIPTION', 'Checkout Step Description'); |
76
|
|
|
} |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* standard SS variable. |
80
|
|
|
* |
81
|
|
|
* @Var String |
82
|
|
|
*/ |
83
|
|
|
private static $plural_name = 'Checkout Step Descriptions'; |
|
|
|
|
84
|
|
|
public function i18n_plural_name() |
85
|
|
|
{ |
86
|
|
|
return _t('CheckoutPage.CHECKOUTSTEPDESCRIPTIONS', 'Checkout Step Descriptions'); |
87
|
|
|
} |
88
|
|
|
|
89
|
|
|
/** |
90
|
|
|
* Standard SS variable. |
91
|
|
|
* |
92
|
|
|
* @var string |
93
|
|
|
*/ |
94
|
|
|
private static $description = 'A step within the checkout process (e.g. confirm details).'; |
|
|
|
|
95
|
|
|
|
96
|
|
|
/** |
97
|
|
|
* standard SS variable. |
98
|
|
|
* |
99
|
|
|
* @return bool |
100
|
|
|
*/ |
101
|
|
|
private static $can_create = false; |
|
|
|
|
102
|
|
|
|
103
|
|
|
/** |
104
|
|
|
* these are only created programmatically |
105
|
|
|
* standard SS method. |
106
|
|
|
* |
107
|
|
|
* @param Member $member |
|
|
|
|
108
|
|
|
* |
109
|
|
|
* @return bool |
110
|
|
|
*/ |
111
|
|
|
public function canCreate($member = null) |
112
|
|
|
{ |
113
|
|
|
return false; |
114
|
|
|
} |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* standard SS method. |
118
|
|
|
* |
119
|
|
|
* @param Member $member |
|
|
|
|
120
|
|
|
* |
121
|
|
|
* @return bool |
|
|
|
|
122
|
|
|
*/ |
123
|
|
|
public function canView($member = null) |
124
|
|
|
{ |
125
|
|
|
if (! $member) { |
126
|
|
|
$member = Member::currentUser(); |
127
|
|
|
} |
128
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
|
|
|
129
|
|
|
if ($extended !== null) { |
130
|
|
|
return $extended; |
131
|
|
|
} |
132
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
133
|
|
|
return true; |
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
return parent::canEdit($member); |
|
|
|
|
137
|
|
|
} |
138
|
|
|
|
139
|
|
|
/** |
140
|
|
|
* standard SS method. |
141
|
|
|
* |
142
|
|
|
* @param Member $member |
|
|
|
|
143
|
|
|
* |
144
|
|
|
* @return bool |
|
|
|
|
145
|
|
|
*/ |
146
|
|
|
public function canEdit($member = null) |
147
|
|
|
{ |
148
|
|
|
if (! $member) { |
149
|
|
|
$member = Member::currentUser(); |
150
|
|
|
} |
151
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
|
|
|
152
|
|
|
if ($extended !== null) { |
153
|
|
|
return $extended; |
154
|
|
|
} |
155
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
156
|
|
|
return true; |
157
|
|
|
} |
158
|
|
|
|
159
|
|
|
return parent::canEdit($member); |
|
|
|
|
160
|
|
|
} |
161
|
|
|
|
162
|
|
|
/** |
163
|
|
|
* standard SS method. |
164
|
|
|
* |
165
|
|
|
* @param Member $member |
|
|
|
|
166
|
|
|
* |
167
|
|
|
* @return bool |
|
|
|
|
168
|
|
|
*/ |
169
|
|
|
public function canDelete($member = null) |
170
|
|
|
{ |
171
|
|
|
$array = EcommerceConfig::get('CheckoutPage_Controller', 'checkout_steps'); |
172
|
|
|
if (in_array($this->getCode, $array)) { |
|
|
|
|
173
|
|
|
return false; |
174
|
|
|
} |
175
|
|
|
if (! $member) { |
176
|
|
|
$member = Member::currentUser(); |
177
|
|
|
} |
178
|
|
|
$extended = $this->extendedCan(__FUNCTION__, $member); |
|
|
|
|
179
|
|
|
if ($extended !== null) { |
180
|
|
|
return $extended; |
181
|
|
|
} |
182
|
|
|
if (Permission::checkMember($member, Config::inst()->get('EcommerceRole', 'admin_permission_code'))) { |
183
|
|
|
return true; |
184
|
|
|
} |
185
|
|
|
|
186
|
|
|
return parent::canEdit($member); |
|
|
|
|
187
|
|
|
} |
188
|
|
|
|
189
|
|
|
/** |
190
|
|
|
* standard SS method. |
191
|
|
|
* |
192
|
|
|
* @return FieldList |
193
|
|
|
*/ |
194
|
|
|
public function getCMSFields() |
195
|
|
|
{ |
196
|
|
|
$fields = parent::getCMSFields(); |
197
|
|
|
$fields->replaceField('Description', new TextareaField('Description', _t('Checkout.DESCRIPTION', 'Description'))); |
198
|
|
|
$fields->replaceField('Above', new TextareaField('Above', _t('Checkout.ABOVE', 'Top of section note'))); |
199
|
|
|
$fields->replaceField('Below', new TextareaField('Below', _t('Checkout.BELOW', 'Bottom of section note'))); |
200
|
|
|
|
201
|
|
|
return $fields; |
202
|
|
|
} |
203
|
|
|
|
204
|
|
|
/** |
205
|
|
|
* link to edit the record. |
206
|
|
|
* |
207
|
|
|
* @param string | Null $action - e.g. edit |
208
|
|
|
* |
209
|
|
|
* @return string |
|
|
|
|
210
|
|
|
*/ |
211
|
|
|
public function CMSEditLink($action = null) |
212
|
|
|
{ |
213
|
|
|
return CMSEditLinkAPI::find_edit_link_for_object($this, $action); |
214
|
|
|
} |
215
|
|
|
|
216
|
|
|
|
217
|
|
|
/** |
218
|
|
|
* casted variable. |
219
|
|
|
* |
220
|
|
|
* @return string |
221
|
|
|
*/ |
222
|
|
|
public function Title() |
223
|
|
|
{ |
224
|
|
|
return $this->getTitle(); |
225
|
|
|
} |
226
|
|
|
|
227
|
|
|
public function getTitle() |
|
|
|
|
228
|
|
|
{ |
229
|
|
|
return $this->Heading; |
|
|
|
|
230
|
|
|
} |
231
|
|
|
|
232
|
|
|
/** |
233
|
|
|
* standard SS method. |
234
|
|
|
*/ |
235
|
|
|
public function requireDefaultRecords() |
236
|
|
|
{ |
237
|
|
|
parent::requireDefaultRecords(); |
238
|
|
|
$steps = EcommerceConfig::get('CheckoutPage_Controller', 'checkout_steps'); |
239
|
|
|
if (is_array($steps) && count($steps)) { |
240
|
|
|
$idArray = []; |
241
|
|
|
foreach ($steps as $id => $code) { |
242
|
|
|
$filter = ['Code' => $code]; |
243
|
|
|
$obj = CheckoutPage_StepDescription::get()->filter($filter)->first(); |
244
|
|
|
if ($obj) { |
245
|
|
|
//do nothing |
246
|
|
|
} else { |
247
|
|
|
$obj = CheckoutPage_StepDescription::create($filter); |
248
|
|
|
$obj->Heading = $this->getDefaultTitle($code); |
|
|
|
|
249
|
|
|
$obj->write(); |
250
|
|
|
DB::alteration_message("Creating CheckoutPage_StepDescription $code", 'created'); |
251
|
|
|
} |
252
|
|
|
$idArray[$obj->ID] = $obj->ID; |
253
|
|
|
} |
254
|
|
|
$toDeleteObjects = CheckoutPage_StepDescription::get()->exclude(array('ID' => $idArray)); |
255
|
|
|
if ($toDeleteObjects->count()) { |
256
|
|
|
foreach ($toDeleteObjects as $toDeleteObject) { |
257
|
|
|
DB::alteration_message('Deleting CheckoutPage_StepDescription '.$toDeleteObject->Code, 'deleted'); |
258
|
|
|
$toDeleteObject->delete(); |
259
|
|
|
} |
260
|
|
|
} |
261
|
|
|
} |
262
|
|
|
} |
263
|
|
|
|
264
|
|
|
/** |
265
|
|
|
* turns code into title (default values). |
266
|
|
|
* |
267
|
|
|
* @param string $code - code |
268
|
|
|
* |
269
|
|
|
* @return string |
270
|
|
|
*/ |
271
|
|
|
private function getDefaultTitle($code) |
272
|
|
|
{ |
273
|
|
|
switch ($code) { |
274
|
|
|
case 'orderitems': |
275
|
|
|
return _t('CheckoutPage.ORDERITEMS', 'Order items'); |
276
|
|
|
break; |
|
|
|
|
277
|
|
|
case 'orderformaddress': |
278
|
|
|
return _t('CheckoutPage.ORDERFORMADDRESS', 'Your details'); |
279
|
|
|
break; |
|
|
|
|
280
|
|
|
case 'orderconfirmationandpayment': |
281
|
|
|
return _t('CheckoutPage.ORDERCONFIRMATIONANDPAYMENT', 'Confirm and pay'); |
282
|
|
|
break; |
|
|
|
|
283
|
|
|
} |
284
|
|
|
|
285
|
|
|
return $code; |
286
|
|
|
} |
287
|
|
|
} |
288
|
|
|
|
This check marks private properties in classes that are never used. Those properties can be removed.