forked from appixia/cartapi-plugin-prestashop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Items.php
488 lines (415 loc) · 18.9 KB
/
Items.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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
<?php
/*
*
* NOTICE OF LICENSE
*
* This source file is subject to the Open Software License (OSL 3.0).
* It is available through the world-wide-web at this URL:
* http://opensource.org/licenses/osl-3.0.php
* If you did not receive a copy of the license and are unable to
* obtain it through the world-wide-web, please send an email
* to info@appixia.com so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade this module to newer
* versions in the future. If you wish to customize the module for your
* needs please look at the /overrides module directory or refer to
* http://kb.appixia.com for more information.
*
*/
class CartAPI_Handlers_Items
{
public function Handle_GetSingleItem($metadata, $request, $encoder)
{
// required arguments
if (!isset($request['Id'])) CartAPI_Helpers::dieOnError($encoder, 'IncompleteRequest', 'Id argument missing');
// load the product
global $cookie;
$id_lang = $cookie->id_lang;
$product = $this->getProductFromProductId($request['Id'], $id_lang);
if (!Validate::isLoadedObject($product)) CartAPI_Helpers::dieOnError($encoder, 'ItemNotFound', Tools::displayError('Product not found'));
// create the response
$response = CartAPI_Helpers::createSuccessResponse($encoder, CartAPI_Handlers_Helpers::getLocale());
// add the item to the response
$item = &$encoder->addContainer($response, 'Item');
// fill in the item fields
$encoder->addNumber($item, 'Id', $product->id);
$this->addTitleFromProduct($encoder, $item, $product);
$price = $this->getPriceFromProduct($product);
$encoder->addNumber($item, 'Price', $price);
$referencePrice = $this->getReferencePriceFromProduct($product);
if ($referencePrice > $price) $encoder->addNumber($item, 'ReferencePrice', $referencePrice);
$this->addThumbnailUrlFromProduct($encoder, $item, $product);
$this->addSubtitleFromProduct($encoder, $item, $product);
$this->addImageUrlFromProduct($encoder, $item, $product, $id_lang);
$this->addFeaturesFromProduct($encoder, $item, $product, $id_lang);
$this->addAvailabilityFromProduct($encoder, $item, $product);
$this->addVariationsAndCombinationsFromProduct($encoder, $item, $product, $id_lang);
$this->addCustomizationsFromProduct($encoder, $item, $product, $id_lang);
$this->addResourcesFromProduct($encoder, $item, $product, $id_lang);
$this->addExtraFieldsFromProduct($metadata, $request, $encoder, $item, $product, $id_lang);
// show the response
$encoder->render($response);
}
public function Handle_GetItemList($metadata, $request, $encoder)
{
// required arguments
if (!isset($request['Paging'])) CartAPI_Helpers::dieOnError($encoder, 'IncompleteRequest', 'Paging argument missing');
$sql_limit = CartAPI_Helpers::getSqlLimitFromPagingRequest($encoder, $request['Paging']);
global $cookie;
$id_lang = $cookie->id_lang;
// allow to override filters before the command is executed
if (isset($request['Filter'])) $this->overrideItemListFilters($request['Filter']);
// go over the filters
$sql_filters = array();
$filters = CartAPI_Helpers::getDictionaryKeyAsArray($request, 'Filter');
foreach ($filters as $filter)
{
$db_field_name_map = array('Title' => 'pl.`name`', 'CategoryId' => 'cp.`id_category`');
$sql_filters[] = CartAPI_Helpers::getSqlFilterFromFilter($encoder, $filter, $db_field_name_map);
}
$sql_orderby = 'p.`id_product` desc'; // default sort (newest items first)
$this->overrideItemListSqlOrderBy($request, $sql_orderby);
// complete the sql statement
if (class_exists('Shop'))
{
$id_shop = Shop::getContextShopID(true);
if ($id_shop !== null) $sql_filters[] = 'pl.`id_shop` = '.(int)$id_shop;
}
$sql_filters[] = 'p.`active` = 1';
$sql_filters[] = 'pl.`id_lang` = '.(int)$id_lang;
$sql_where = CartAPI_Helpers::getSqlWhereFromSqlFilters($sql_filters);
$sql = '
SELECT SQL_CALC_FOUND_ROWS p.`id_product`, pl.`name`, p.`active`
FROM `'._DB_PREFIX_.'product` p
LEFT JOIN `'._DB_PREFIX_.'category_product` cp ON cp.`id_product` = p.`id_product`
LEFT JOIN `'._DB_PREFIX_.'product_lang` pl ON p.`id_product` = pl.`id_product`
'.$sql_where.'
GROUP BY `id_product`
ORDER BY '.$sql_orderby.'
'.$sql_limit;
// load the products and the total element count
$result = Db::getInstance()->ExecuteS($sql);
$total_elements_row = Db::getInstance()->getRow('SELECT FOUND_ROWS()');
$total_elements = intval(array_pop($total_elements_row));
// change results before they are returned
$this->overrideItemListResult($request, $result, $total_elements);
// create the response
$response = CartAPI_Helpers::createSuccessResponseWithPaging($encoder, $request['Paging'], $total_elements, CartAPI_Handlers_Helpers::getLocale());
// add the items to the response if needed
if (count($result) > 0) $items = &$encoder->addArray($response, 'Item');
// encode each item
foreach ($result as $row)
{
// to allow support for overrideItemListResult() to return objects instead of arrays, let's check if it's an object and fix as needed
if (is_object($row) && ($row instanceof ProductCore))
{
$arr = array();
$arr['id_product'] = $row->id;
$arr['name'] = $row->name;
$row = $arr; // make the switch from object to array
}
// encode the item
$item = &$encoder->addContainerToArray($items);
$encoder->addNumber($item, 'Id', $row['id_product']);
$encoder->addString($item, 'Title', $row['name']);
$price = $this->getPriceFromProductId($row['id_product']);
$encoder->addNumber($item, 'Price', $price);
$referencePrice = $this->getReferencePriceFromProductId($row['id_product']);
if ($referencePrice > $price) $encoder->addNumber($item, 'ReferencePrice', $referencePrice);
$this->addThumbnailUrlFromProductId($encoder, $item, $row['id_product']);
$this->addExtraFieldsFromProductId($metadata, $request, $encoder, $item, $row['id_product']);
}
// show the response
$encoder->render($response);
}
public function overrideItemListFilters(&$filter)
{
return; // do nothing by default
}
public function overrideItemListSqlOrderBy($request, &$sql_orderby)
{
return; // do nothing by default
}
public function overrideItemListResult($request, &$result, &$total_elements)
{
return; // do nothing by default
}
public function addFeaturesFromProduct($encoder, &$item, $product, $id_lang)
{
$features = $product->getFrontFeatures($id_lang);
if (!is_array($features) || (count($features) == 0)) return;
$_features = &$encoder->addArray($item, 'Feature');
foreach ($features as $feature)
{
$_feature = &$encoder->addContainerToArray($_features);
$encoder->addString($_feature, 'Name', $feature["name"]);
$encoder->addString($_feature, 'Value', $feature["value"]);
}
}
// returns an array of arrays (resources)
public function getResourceDictionariesFromProduct($product, $id_lang)
{
return array(); // do nothing by default
}
public function addExtraFieldsFromProductId($metadata, $request, $encoder, &$item, $product_id)
{
// do nothing by default
}
public function addExtraFieldsFromProduct($metadata, $request, $encoder, &$item, $product, $id_lang)
{
// do nothing by default
}
public function addResourcesFromProduct($encoder, &$item, $product, $id_lang)
{
$resources = $this->getResourceDictionariesFromProduct($product, $id_lang);
if ((!is_array($resources)) || (count($resources) == 0)) return;
$_resources = &$encoder->addArray($item, 'Resource');
foreach ($resources as $resource)
{
$_resource = &$encoder->addContainerToArray($_resources);
foreach ($resource as $key => $value) $encoder->addString($_resource, $key, $value);
}
}
public function getProductFromProductId($product_id, $id_lang)
{
return new Product($product_id, false, $id_lang);
}
public function getImageUrl($name, $ids, $type)
{
global $link;
$url = $link->getImageLink($name, $ids, $type); // older prestashop versions return a relative url here, so we must make sure it's absolute
if (CartAPI_Handlers_Helpers::isAbsoluteUrl($url)) return $url;
else return CartAPI_Handlers_Helpers::getShopDomain().$url;
}
public function getThumbnailImageType()
{
return 'home';
}
public function getThumbnailUrlFromImageId($image_id, $product_id = -1, $link_rewrite = NULL)
{
if ($link_rewrite === NULL) $link_rewrite = 'image';
if ($product_id != -1) $image_id = (int)$product_id . '-' . (int)$image_id;
return $this->getImageUrl($link_rewrite, $image_id, $this->getThumbnailImageType());
}
public function getImagesImageType()
{
return 'thickbox';
}
public function getImageUrlFromImageId($image_id, $product_id = -1, $link_rewrite = NULL)
{
if ($link_rewrite === NULL) $link_rewrite = 'image';
if ($product_id != -1) $image_id = (int)$product_id . '-' . (int)$image_id;
return $this->getImageUrl($link_rewrite, $image_id, $this->getImagesImageType());
}
public function getPriceFromProduct($product)
{
return $product->getPrice(true, NULL, 2);
}
public function getPriceFromProductId($product_id)
{
return Product::getPriceStatic($product_id, true, NULL, 2);
}
public function getReferencePriceFromProduct($product)
{
return Tools::ps_round($product->getPriceWithoutReduct(false, NULL), 2);
}
public function getReferencePriceFromProductId($product_id)
{
return Product::getPriceStatic($product_id, true, NULL, 2, NULL, false, false);
}
public function addThumbnailUrlFromProduct($encoder, &$item, $product)
{
// taken from Product::getCoverWs - we're not using getCoverWs directly since it's not avail in old prestashop versions
$cover = $product->getCover($product->id);
$cover_image_id = $cover['id_image'];
$encoder->addString($item, 'ThumbnailUrl', $this->getThumbnailUrlFromImageId($cover_image_id, $product->id));
}
public function addThumbnailUrlFromProductId($encoder, &$item, $product_id)
{
$cover_arr = Product::getCover($product_id);
if (is_array($cover_arr)) $encoder->addString($item, 'ThumbnailUrl', $this->getThumbnailUrlFromImageId(array_pop($cover_arr), $product_id));
}
public function getIsAvailableFromProduct($product)
{
return $product->checkQty(1);
}
public function addAvailabilityFromProduct($encoder, &$item, $product)
{
$encoder->addBoolean($item, 'Available', (bool)$this->getIsAvailableFromProduct($product));
}
public function addImageUrlFromProduct($encoder, &$item, $product, $id_lang)
{
$images = $product->getImages($id_lang);
if (!is_array($images) || (count($images) == 0)) return;
$_imageUrls = &$encoder->addArray($item, 'ImageUrl');
foreach ($images as $image)
{
$image_id = -1;
if (isset($image['id_image'])) $image_id = $image['id_image'];
if ($image_id != -1) $encoder->addStringToArray($_imageUrls, $this->getImageUrlFromImageId($image_id, $product->id));
}
}
public function addTitleFromProduct($encoder, &$item, $product)
{
$encoder->addString($item, 'Title', $product->name);
}
public function addSubtitleFromProduct($encoder, &$item, $product)
{
if ($product->description_short)
{
$subtitle = $product->description_short;
$subtitle = CartAPI_Handlers_Helpers::removeHtmlTags($subtitle);
$encoder->addString($item, 'Subtitle', $subtitle);
}
}
public function overrideVariationDefaultValue($variationId, &$defaultValueId)
{
return; // do nothing by default
}
public function addVariationsAndCombinationsFromProduct($encoder, &$item, $product, $id_lang)
{
$attributesGroups = $product->getAttributesGroups($id_lang);
if (!is_array($attributesGroups) || (count($attributesGroups) == 0)) return;
$combinationImages = $product->getCombinationImages($id_lang);
// prepare the groups.. taken from ProductController line 280
$colors = array();
$groups = array();
$combinations = array();
foreach ($attributesGroups as $row)
{
/* Color management */
if (((isset($row['attribute_color']) AND $row['attribute_color']) OR (file_exists(_PS_COL_IMG_DIR_.$row['id_attribute'].'.jpg'))) AND $row['id_attribute_group'] == $product->id_color_default)
{
$colors[$row['id_attribute']]['value'] = $row['attribute_color'];
$colors[$row['id_attribute']]['name'] = $row['attribute_name'];
if (!isset($colors[$row['id_attribute']]['attributes_quantity']))
$colors[$row['id_attribute']]['attributes_quantity'] = 0;
$colors[$row['id_attribute']]['attributes_quantity'] += (int)($row['quantity']);
}
if (!isset($groups[$row['id_attribute_group']]))
{
$groups[$row['id_attribute_group']] = array(
'name' => $row['public_group_name'],
'is_color_group' => $row['is_color_group'],
'default' => -1,
);
}
$groups[$row['id_attribute_group']]['attributes'][$row['id_attribute']] = $row['attribute_name'];
if ($row['default_on'] && $groups[$row['id_attribute_group']]['default'] == -1)
$groups[$row['id_attribute_group']]['default'] = (int)($row['id_attribute']);
if (!isset($groups[$row['id_attribute_group']]['attributes_quantity'][$row['id_attribute']]))
$groups[$row['id_attribute_group']]['attributes_quantity'][$row['id_attribute']] = 0;
$groups[$row['id_attribute_group']]['attributes_quantity'][$row['id_attribute']] += (int)($row['quantity']);
$combinations[$row['id_product_attribute']]['attributes_values'][$row['id_attribute_group']] = $row['attribute_name'];
$combinations[$row['id_product_attribute']]['attributes'][$row['id_attribute_group']] = (int)($row['id_attribute']);
$combinations[$row['id_product_attribute']]['price'] = (float)($row['price']);
$combinations[$row['id_product_attribute']]['ecotax'] = (float)($row['ecotax']);
$combinations[$row['id_product_attribute']]['weight'] = (float)($row['weight']);
$combinations[$row['id_product_attribute']]['quantity'] = (int)($row['quantity']);
$combinations[$row['id_product_attribute']]['reference'] = $row['reference'];
if (isset($row['ean13'])) $combinations[$row['id_product_attribute']]['ean13'] = $row['ean13'];
if (isset($row['unit_price_impact'])) $combinations[$row['id_product_attribute']]['unit_impact'] = $row['unit_price_impact'];
if (isset($row['minimal_quantity'])) $combinations[$row['id_product_attribute']]['minimal_quantity'] = $row['minimal_quantity'];
$combinations[$row['id_product_attribute']]['id_image'] = isset($combinationImages[$row['id_product_attribute']][0]['id_image']) ? $combinationImages[$row['id_product_attribute']][0]['id_image'] : -1;
}
// check if the product is available when out of stock, and only if not, we need to check quantity of each combination
$shouldCheckCombinationAvailability = !$product->isAvailableWhenOutOfStock($product->out_of_stock);
// get the default product price
$defaultProductPrice = $this->getPriceFromProduct($product);
// add the variations
$_variations = &$encoder->addArray($item, 'Variation');
foreach ($groups as $group_id => $group)
{
$_variation = &$encoder->addContainerToArray($_variations);
$encoder->addString($_variation, 'Id', $group_id);
$encoder->addString($_variation, 'Name', $group["name"]);
$_variationValues = &$encoder->addArray($_variation, 'Value');
foreach ($group['attributes'] as $attribute_id => $attribute_value)
{
$_variationValue = &$encoder->addContainerToArray($_variationValues);
$encoder->addString($_variationValue, 'Id', $attribute_id);
$encoder->addString($_variationValue, 'Name', $attribute_value);
// color
if (isset($colors[$attribute_id]))
{
$encoder->addString($_variationValue, 'RenderType', 'HtmlColor');
$encoder->addString($_variationValue, 'RenderValue', $colors[$attribute_id]['value']);
}
}
// default value
if (isset($group['default']))
{
$defaultValueId = $group['default'];
$this->overrideVariationDefaultValue($group_id, $defaultValueId);
$encoder->addString($_variation, 'DefaultValueId', $defaultValueId);
}
}
// add the combinations
if (count($combinations) == 0) return;
$_combinations = &$encoder->addArray($item, 'Combination');
foreach ($combinations as $id_product_attribute => $combination)
{
$_combination = &$encoder->addContainerToArray($_combinations);
// add the variations that are part of this combination
$_variations = &$encoder->addArray($_combination, 'Variation');
foreach ($combination['attributes'] as $id_attribute_group => $attribute_id)
{
$_variation = &$encoder->addContainerToArray($_variations);
$encoder->addString($_variation, 'Id', $id_attribute_group);
$encoder->addString($_variation, 'ValueId', $attribute_id);
}
// add the overrides for this combination
$_override = &$encoder->addContainer($_combination, 'Override');
// thumbnail url override
if ($combination['id_image'] != -1)
{
$encoder->addString($_override, 'ThumbnailUrl', $this->getThumbnailUrlFromImageId($combination['id_image'], $product->id));
}
// image urls override
if (isset($combinationImages[$id_product_attribute]) && is_array($combinationImages[$id_product_attribute]) && (count($combinationImages[$id_product_attribute]) > 0))
{
$_imageUrls = &$encoder->addArray($_override, 'ImageUrl');
foreach ($combinationImages[$id_product_attribute] as $combinationImage)
{
$image_id = -1;
if (isset($combinationImage['id_image'])) $image_id = $combinationImage['id_image'];
if ($image_id != -1) $encoder->addStringToArray($_imageUrls, $this->getImageUrlFromImageId($image_id, $product->id));
}
}
// availability override
if ($shouldCheckCombinationAvailability)
{
if ($combination['quantity'] > 0) $encoder->addBoolean($_override, 'Available', true);
else $encoder->addBoolean($_override, 'Available', false);
}
// price override
$combinationPrice = $product->getPrice(true, $id_product_attribute, 2);
if ($combinationPrice != $defaultProductPrice)
{
$encoder->addNumber($_override, 'Price', $combinationPrice);
}
// add more overrides..
}
}
public function addCustomizationsFromProduct($encoder, &$item, $product, $id_lang)
{
if (!$product->customizable) return;
// add the variations
$_customizations = &$encoder->addArray($item, 'Customization');
// go over the fields
$customizationFields = $product->getCustomizationFields($id_lang);
foreach ($customizationFields as $field)
{
// handle prestashop text fields
if ($field['type'] == 1)
{
$_customization = &$encoder->addContainerToArray($_customizations);
$encoder->addString($_customization, 'Id', $field['id_customization_field']);
if (!empty($field['name'])) $encoder->addString($_customization, 'Name', $field['name']);
}
}
}
}
?>