1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Dynamic\FoxyStripe\Page; |
4
|
|
|
|
5
|
|
|
use Bummzack\SortableFile\Forms\SortableUploadField; |
|
|
|
|
6
|
|
|
use Dynamic\FoxyStripe\Model\FoxyCart; |
7
|
|
|
use Dynamic\FoxyStripe\Model\FoxyStripeSetting; |
8
|
|
|
use Dynamic\FoxyStripe\Model\OptionItem; |
9
|
|
|
use Dynamic\FoxyStripe\Model\OrderDetail; |
10
|
|
|
use Dynamic\FoxyStripe\Model\ProductCategory; |
11
|
|
|
use Dynamic\FoxyStripe\Model\ProductImage; |
12
|
|
|
use SilverStripe\AssetAdmin\Forms\UploadField; |
13
|
|
|
use SilverStripe\Assets\Image; |
14
|
|
|
use SilverStripe\Forms\CheckboxField; |
15
|
|
|
use SilverStripe\Forms\CurrencyField; |
16
|
|
|
use SilverStripe\Forms\DropdownField; |
17
|
|
|
use SilverStripe\Forms\GridField\GridField; |
18
|
|
|
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter; |
19
|
|
|
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor; |
20
|
|
|
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor; |
21
|
|
|
use SilverStripe\Forms\GridField\GridFieldDeleteAction; |
22
|
|
|
use SilverStripe\Forms\HeaderField; |
23
|
|
|
use SilverStripe\Forms\LiteralField; |
24
|
|
|
use SilverStripe\Forms\NumericField; |
25
|
|
|
use SilverStripe\Forms\RequiredFields; |
26
|
|
|
use SilverStripe\Forms\TextField; |
27
|
|
|
use SilverStripe\Security\Member; |
28
|
|
|
use SilverStripe\Security\Permission; |
29
|
|
|
use SilverStripe\Security\PermissionProvider; |
30
|
|
|
use Symbiote\GridFieldExtensions\GridFieldOrderableRows; |
31
|
|
|
|
32
|
|
|
/** |
33
|
|
|
* Class ProductPage |
34
|
|
|
* @package Dynamic\FoxyStripe\Page |
35
|
|
|
* |
36
|
|
|
* @property \SilverStripe\ORM\FieldType\DBCurrency Price |
37
|
|
|
* @property \SilverStripe\ORM\FieldType\DBDecimal Weight |
38
|
|
|
* @property \SilverStripe\ORM\FieldType\DBVarchar Code |
39
|
|
|
* @property \SilverStripe\ORM\FieldType\DBVarchar ReceiptTitle |
40
|
|
|
* @property \SilverStripe\ORM\FieldType\DBBoolean Featured |
41
|
|
|
* @property \SilverStripe\ORM\FieldType\DBBoolean Available |
42
|
|
|
* |
43
|
|
|
* @property int PreviewImageID |
44
|
|
|
* @method Image PreviewImage |
45
|
|
|
* @property int CategoryID |
46
|
|
|
* @method ProductCategory Category |
47
|
|
|
* |
48
|
|
|
* |
49
|
|
|
* @method \SilverStripe\ORM\HasManyList ProductImages |
50
|
|
|
* @method \SilverStripe\ORM\HasManyList ProductOptions |
51
|
|
|
* @method \SilverStripe\ORM\HasManyList OrderDetails |
52
|
|
|
* |
53
|
|
|
* @method \SilverStripe\ORM\ManyManyList ProductHolders |
54
|
|
|
*/ |
55
|
|
|
class ProductPage extends \Page implements PermissionProvider |
56
|
|
|
{ |
57
|
|
|
/** |
58
|
|
|
* @var string |
59
|
|
|
*/ |
60
|
|
|
private static $default_parent = ProductHolder::class; |
|
|
|
|
61
|
|
|
|
62
|
|
|
/** |
63
|
|
|
* @var bool |
64
|
|
|
*/ |
65
|
|
|
private static $can_be_root = false; |
|
|
|
|
66
|
|
|
|
67
|
|
|
/** |
68
|
|
|
* @var array |
69
|
|
|
*/ |
70
|
|
|
private static $db = [ |
|
|
|
|
71
|
|
|
'Price' => 'Currency', |
72
|
|
|
'Weight' => 'Decimal', |
73
|
|
|
'Code' => 'Varchar(100)', |
74
|
|
|
'ReceiptTitle' => 'HTMLVarchar(255)', |
75
|
|
|
'Available' => 'Boolean', |
76
|
|
|
]; |
77
|
|
|
|
78
|
|
|
/** |
79
|
|
|
* @var array |
80
|
|
|
*/ |
81
|
|
|
private static $has_one = [ |
|
|
|
|
82
|
|
|
'Category' => ProductCategory::class, |
83
|
|
|
]; |
84
|
|
|
|
85
|
|
|
/** |
86
|
|
|
* @var array |
87
|
|
|
*/ |
88
|
|
|
private static $has_many = [ |
|
|
|
|
89
|
|
|
'ProductOptions' => OptionItem::class, |
90
|
|
|
'OrderDetails' => OrderDetail::class, |
91
|
|
|
]; |
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* @var array |
95
|
|
|
*/ |
96
|
|
|
private static $many_many = [ |
|
|
|
|
97
|
|
|
'Images' => Image::class, |
98
|
|
|
]; |
99
|
|
|
|
100
|
|
|
/** |
101
|
|
|
* @var array |
102
|
|
|
*/ |
103
|
|
|
private static $many_many_extraFields = [ |
|
|
|
|
104
|
|
|
'Images' => [ |
105
|
|
|
'SortOrder' => 'Int', |
106
|
|
|
], |
107
|
|
|
]; |
108
|
|
|
|
109
|
|
|
/** |
110
|
|
|
* @var array |
111
|
|
|
*/ |
112
|
|
|
private static $owns = [ |
|
|
|
|
113
|
|
|
'Images', |
114
|
|
|
]; |
115
|
|
|
|
116
|
|
|
/** |
117
|
|
|
* @var array |
118
|
|
|
*/ |
119
|
|
|
private static $belongs_many_many = [ |
|
|
|
|
120
|
|
|
'ProductHolders' => ProductHolder::class, |
121
|
|
|
]; |
122
|
|
|
|
123
|
|
|
/** |
124
|
|
|
* @var string |
125
|
|
|
*/ |
126
|
|
|
private static $singular_name = 'Product'; |
|
|
|
|
127
|
|
|
|
128
|
|
|
/** |
129
|
|
|
* @var string |
130
|
|
|
*/ |
131
|
|
|
private static $plural_name = 'Products'; |
|
|
|
|
132
|
|
|
|
133
|
|
|
/** |
134
|
|
|
* @var string |
135
|
|
|
*/ |
136
|
|
|
private static $description = 'A product that can be added to the shopping cart'; |
|
|
|
|
137
|
|
|
|
138
|
|
|
/** |
139
|
|
|
* @var array |
140
|
|
|
*/ |
141
|
|
|
private static $indexes = [ |
|
|
|
|
142
|
|
|
'Code' => true, // make unique |
143
|
|
|
]; |
144
|
|
|
|
145
|
|
|
/** |
146
|
|
|
* @var array |
147
|
|
|
*/ |
148
|
|
|
private static $defaults = [ |
|
|
|
|
149
|
|
|
'ShowInMenus' => false, |
150
|
|
|
'Available' => true, |
151
|
|
|
'Weight' => '1.0', |
152
|
|
|
]; |
153
|
|
|
|
154
|
|
|
/** |
155
|
|
|
* @var array |
156
|
|
|
*/ |
157
|
|
|
private static $summary_fields = [ |
|
|
|
|
158
|
|
|
'Image.CMSThumbnail', |
159
|
|
|
'Title', |
160
|
|
|
'Code', |
161
|
|
|
'Price.Nice', |
162
|
|
|
'Category.Title', |
163
|
|
|
]; |
164
|
|
|
|
165
|
|
|
/** |
166
|
|
|
* @var array |
167
|
|
|
*/ |
168
|
|
|
private static $searchable_fields = [ |
|
|
|
|
169
|
|
|
'Title', |
170
|
|
|
'Code', |
171
|
|
|
'Available', |
172
|
|
|
'Category.ID', |
173
|
|
|
]; |
174
|
|
|
|
175
|
|
|
/** |
176
|
|
|
* @var string |
177
|
|
|
*/ |
178
|
|
|
private static $table_name = 'ProductPage'; |
|
|
|
|
179
|
|
|
|
180
|
|
|
/** |
181
|
|
|
* @param bool $includerelations |
182
|
|
|
* |
183
|
|
|
* @return array |
184
|
|
|
*/ |
185
|
|
|
public function fieldLabels($includerelations = true) |
186
|
|
|
{ |
187
|
|
|
$labels = parent::fieldLabels(); |
188
|
|
|
|
189
|
|
|
$labels['Title'] = _t('ProductPage.TitleLabel', 'Name'); |
190
|
|
|
$labels['Code'] = _t('ProductPage.CodeLabel', 'Code'); |
191
|
|
|
$labels['Price.Nice'] = _t('ProductPage.PriceLabel', 'Price'); |
192
|
|
|
$labels['Available.Nice'] = _t('ProductPage.AvailableLabel', 'Available'); |
193
|
|
|
$labels['Category.ID'] = _t('ProductPage.IDLabel', 'Category'); |
194
|
|
|
$labels['Category.Title'] = _t('ProductPage.CategoryTitleLabel', 'Category'); |
195
|
|
|
$labels['Image.CMSThumbnail'] = _t('ProductPage.ImageLabel', 'Image'); |
196
|
|
|
|
197
|
|
|
return $labels; |
198
|
|
|
} |
199
|
|
|
|
200
|
|
|
/** |
201
|
|
|
* @return \SilverStripe\Forms\FieldList |
202
|
|
|
*/ |
203
|
|
|
public function getCMSFields() |
204
|
|
|
{ |
205
|
|
|
$fields = parent::getCMSFields(); |
206
|
|
|
|
207
|
|
|
// Cateogry Dropdown field w/ add new |
208
|
|
|
$source = function () { |
209
|
|
|
return ProductCategory::get()->map()->toArray(); |
210
|
|
|
}; |
211
|
|
|
$catField = DropdownField::create('CategoryID', _t('ProductPage.Category', 'FoxyCart Category'), $source()) |
212
|
|
|
->setEmptyString('') |
213
|
|
|
->setDescription(_t( |
214
|
|
|
'ProductPage.CategoryDescription', |
215
|
|
|
'Required, must also exist in |
216
|
|
|
<a href="https://admin.foxycart.com/admin.php?ThisAction=ManageProductCategories" target="_blank"> |
217
|
|
|
FoxyCart Categories |
218
|
|
|
</a>. |
219
|
|
|
Used to set category specific options like shipping and taxes. Managed in |
220
|
|
|
<a href="admin/settings"> |
221
|
|
|
Settings > FoxyStripe > Categories |
222
|
|
|
</a>' |
223
|
|
|
)); |
224
|
|
|
if (class_exists('QuickAddNewExtension')) { |
225
|
|
|
$catField->useAddNew('ProductCategory', $source); |
226
|
|
|
} |
227
|
|
|
|
228
|
|
|
$fields->addFieldsToTab( |
229
|
|
|
'Root.Main', |
230
|
|
|
[ |
231
|
|
|
TextField::create('Code') |
232
|
|
|
->setTitle(_t('ProductPage.Code', 'Product Code')) |
233
|
|
|
->setDescription(_t( |
234
|
|
|
'ProductPage.CodeDescription', |
235
|
|
|
'Required, must be unique. Product identifier used by FoxyCart in transactions' |
236
|
|
|
)), |
237
|
|
|
CurrencyField::create('Price') |
238
|
|
|
->setTitle(_t('ProductPage.Price', 'Price')) |
239
|
|
|
->setDescription(_t( |
240
|
|
|
'ProductPage.PriceDescription', |
241
|
|
|
'Base price for this product. Can be modified using Product Options' |
242
|
|
|
)), |
243
|
|
|
$catField, |
244
|
|
|
], |
245
|
|
|
'Content' |
246
|
|
|
); |
247
|
|
|
|
248
|
|
|
// Product Options field |
249
|
|
|
$config = GridFieldConfig_RelationEditor::create(); |
250
|
|
|
$config->addComponent(new GridFieldOrderableRows('SortOrder')); |
251
|
|
|
$products = $this->ProductOptions()->sort('SortOrder'); |
252
|
|
|
$config->removeComponentsByType(GridFieldAddExistingAutocompleter::class); |
253
|
|
|
$prodOptField = GridField::create( |
254
|
|
|
'ProductOptions', |
255
|
|
|
_t('ProductPage.ProductOptions', 'Options'), |
256
|
|
|
$products, |
257
|
|
|
$config |
258
|
|
|
); |
259
|
|
|
|
260
|
|
|
// Details tab |
261
|
|
|
$fields->addFieldsToTab('Root.Details', [ |
262
|
|
|
CheckboxField::create('Available') |
263
|
|
|
->setTitle(_t('ProductPage.Available', 'Available for purchase')) |
264
|
|
|
->setDescription(_t( |
265
|
|
|
'ProductPage.AvailableDescription', |
266
|
|
|
'If unchecked, will remove "Add to Cart" form and instead display "Currently unavailable"' |
267
|
|
|
)), |
268
|
|
|
NumericField::create('Weight') |
269
|
|
|
->setTitle(_t('ProductPage.Weight', 'Weight')) |
270
|
|
|
->setDescription(_t( |
271
|
|
|
'ProductPage.WeightDescription', |
272
|
|
|
'Base weight for this product in lbs. Can be modified using Product Options' |
273
|
|
|
)) |
274
|
|
|
->setScale(2), |
275
|
|
|
TextField::create('ReceiptTitle') |
276
|
|
|
->setTitle(_t('ProductPage.ReceiptTitle', 'Product Title for Receipt')) |
277
|
|
|
->setDescription(_t( |
278
|
|
|
'ProductPage.ReceiptTitleDescription', |
279
|
|
|
'Optional' |
280
|
|
|
)), |
281
|
|
|
]); |
282
|
|
|
|
283
|
|
|
// Options Tab |
284
|
|
|
$fields->addFieldsToTab('Root.Options', [ |
285
|
|
|
$prodOptField |
286
|
|
|
->setDescription(_t( |
287
|
|
|
'Page.OptionsDescrip', |
288
|
|
|
'<p>Product Options allow products to be customized by attributes such as size or color. |
289
|
|
|
Options can also modify the product\'s price, weight or code.<br></p>' |
290
|
|
|
)), |
291
|
|
|
]); |
292
|
|
|
|
293
|
|
|
// Images tab |
294
|
|
|
$images = SortableUploadField::create('Images') |
295
|
|
|
->setSortColumn('SortOrder') |
296
|
|
|
->setIsMultiUpload(true) |
297
|
|
|
->setAllowedFileCategories('image') |
298
|
|
|
->setFolderName('Uploads/Products/Images') |
299
|
|
|
; |
300
|
|
|
|
301
|
|
|
$fields->addFieldsToTab('Root.Images', [ |
302
|
|
|
$images, |
303
|
|
|
]); |
304
|
|
|
|
305
|
|
|
if (FoxyCart::store_name_warning() !== null) { |
306
|
|
|
$fields->addFieldToTab('Root.Main', LiteralField::create('StoreSubDomainHeaderWarning', _t( |
307
|
|
|
'ProductPage.StoreSubDomainHeaderWarning', |
308
|
|
|
'<p class="message error">Store sub-domain must be entered in the |
309
|
|
|
<a href="/admin/settings/">site settings</a></p>' |
310
|
|
|
)), 'Title'); |
311
|
|
|
} |
312
|
|
|
|
313
|
|
|
return $fields; |
314
|
|
|
} |
315
|
|
|
|
316
|
|
|
/** |
317
|
|
|
* @return mixed |
318
|
|
|
*/ |
319
|
|
|
public function getImage() |
320
|
|
|
{ |
321
|
|
|
if ($this->Images()->count() > 0) { |
|
|
|
|
322
|
|
|
return $this->Images()->first(); |
323
|
|
|
} |
324
|
|
|
} |
325
|
|
|
|
326
|
|
|
public function Image() |
327
|
|
|
{ |
328
|
|
|
return $this->getImage(); |
329
|
|
|
} |
330
|
|
|
|
331
|
|
|
/** |
332
|
|
|
* @throws \Exception |
333
|
|
|
*/ |
334
|
13 |
|
public function onBeforeWrite() |
335
|
|
|
{ |
336
|
13 |
|
parent::onBeforeWrite(); |
337
|
13 |
|
if (!$this->CategoryID) { |
338
|
|
|
$default = ProductCategory::get()->filter(['Code' => 'DEFAULT'])->first(); |
339
|
|
|
$this->CategoryID = $default->ID; |
340
|
|
|
} |
341
|
|
|
|
342
|
|
|
//update many_many lists when multi-group is on |
343
|
13 |
|
if (FoxyStripeSetting::current_foxystripe_setting()->MultiGroup) { |
344
|
|
|
$holders = $this->ProductHolders(); |
345
|
|
|
$product = self::get()->byID($this->ID); |
346
|
|
|
if (isset($product->ParentID)) { |
347
|
|
|
$origParent = $product->ParentID; |
348
|
|
|
} else { |
349
|
|
|
$origParent = null; |
350
|
|
|
} |
351
|
|
|
$currentParent = $this->ParentID; |
352
|
|
|
if ($origParent != $currentParent) { |
353
|
|
|
if ($holders->find('ID', $origParent)) { |
354
|
|
|
$holders->removeByID($origParent); |
355
|
|
|
} |
356
|
|
|
} |
357
|
|
|
$holders->add($currentParent); |
358
|
|
|
} |
359
|
|
|
|
360
|
13 |
|
$this->Title = trim($this->Title); |
361
|
13 |
|
$this->Code = trim($this->Code); |
|
|
|
|
362
|
13 |
|
$this->ReceiptTitle = trim($this->ReceiptTitle); |
|
|
|
|
363
|
|
|
} |
364
|
|
|
|
365
|
13 |
|
public function onAfterWrite() |
366
|
|
|
{ |
367
|
13 |
|
parent::onAfterWrite(); |
368
|
|
|
} |
369
|
|
|
|
370
|
2 |
|
public function onBeforeDelete() |
371
|
|
|
{ |
372
|
2 |
|
if ($this->Status != 'Published') { |
|
|
|
|
373
|
2 |
|
if ($this->ProductOptions()) { |
374
|
2 |
|
$options = $this->getComponents('ProductOptions'); |
375
|
2 |
|
foreach ($options as $option) { |
376
|
|
|
$option->delete(); |
377
|
|
|
} |
378
|
|
|
} |
379
|
|
|
} |
380
|
2 |
|
parent::onBeforeDelete(); |
381
|
|
|
} |
382
|
|
|
|
383
|
5 |
|
public function validate() |
384
|
|
|
{ |
385
|
5 |
|
$result = parent::validate(); |
386
|
|
|
|
387
|
|
|
/*if($this->ID>0){ |
|
|
|
|
388
|
|
|
if($this->Price <= 0) { |
389
|
|
|
$result->error('Must set a positive price value'); |
390
|
|
|
} |
391
|
|
|
if($this->Weight <= 0){ |
392
|
|
|
$result->error('Must set a positive weight value'); |
393
|
|
|
} |
394
|
|
|
if($this->Code == ''){ |
395
|
|
|
$result->error('Must set a product code'); |
396
|
|
|
} |
397
|
|
|
}*/ |
398
|
|
|
|
399
|
5 |
|
return $result; |
400
|
|
|
} |
401
|
|
|
|
402
|
|
|
public function getCMSValidator() |
403
|
|
|
{ |
404
|
|
|
return new RequiredFields(['CategoryID', 'Price', 'Weight', 'Code']); |
405
|
|
|
} |
406
|
|
|
|
407
|
|
|
/** |
408
|
|
|
* @param null $productCode |
|
|
|
|
409
|
|
|
* @param null $optionName |
|
|
|
|
410
|
|
|
* @param null $optionValue |
|
|
|
|
411
|
|
|
* @param string $method |
412
|
|
|
* @param bool $output |
413
|
|
|
* @param bool $urlEncode |
414
|
|
|
* |
415
|
|
|
* @return null|string |
416
|
|
|
*/ |
417
|
|
|
public static function getGeneratedValue( |
418
|
|
|
$productCode = null, |
419
|
|
|
$optionName = null, |
420
|
|
|
$optionValue = null, |
421
|
|
|
$method = 'name', |
422
|
|
|
$output = false, |
423
|
|
|
$urlEncode = false |
424
|
|
|
) { |
425
|
|
|
$optionName = ($optionName !== null) ? preg_replace('/\s/', '_', $optionName) : $optionName; |
|
|
|
|
426
|
|
|
|
427
|
|
|
return (FoxyStripeSetting::current_foxystripe_setting()->CartValidation) |
428
|
|
|
? \FoxyCart_Helper::fc_hash_value($productCode, $optionName, $optionValue, $method, $output, $urlEncode) : |
429
|
|
|
$optionValue; |
430
|
|
|
} |
431
|
|
|
|
432
|
|
|
/** |
433
|
|
|
* @param Member $member |
434
|
|
|
* |
435
|
|
|
* @return bool |
436
|
|
|
*/ |
437
|
|
|
public function canEdit($member = null) |
438
|
|
|
{ |
439
|
|
|
return Permission::check('Product_CANCRUD', 'any', $member); |
440
|
|
|
} |
441
|
|
|
|
442
|
|
|
public function canDelete($member = null) |
443
|
|
|
{ |
444
|
|
|
return Permission::check('Product_CANCRUD', 'any', $member); |
445
|
|
|
} |
446
|
|
|
|
447
|
|
|
public function canCreate($member = null, $context = []) |
448
|
|
|
{ |
449
|
|
|
return Permission::check('Product_CANCRUD', 'any', $member); |
450
|
|
|
} |
451
|
|
|
|
452
|
|
|
public function canPublish($member = null) |
453
|
|
|
{ |
454
|
|
|
return Permission::check('Product_CANCRUD', 'any', $member); |
455
|
|
|
} |
456
|
|
|
|
457
|
|
|
public function providePermissions() |
458
|
|
|
{ |
459
|
|
|
return [ |
460
|
|
|
'Product_CANCRUD' => 'Allow user to manage Products and related objects', |
461
|
|
|
]; |
462
|
|
|
} |
463
|
|
|
} |
464
|
|
|
|
The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g.
excluded_paths: ["lib/*"]
, you can move it to the dependency path list as follows:For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths