-
Notifications
You must be signed in to change notification settings - Fork 5
/
Copy pathblockviewed.php
347 lines (319 loc) · 11.6 KB
/
blockviewed.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
<?php
/**
* Copyright (C) 2017-2024 thirty bees
* Copyright (C) 2007-2016 PrestaShop SA
*
* thirty bees is an extension to the PrestaShop software by PrestaShop SA.
*
* NOTICE OF LICENSE
*
* This source file is subject to the Academic Free License (AFL 3.0)
* that is bundled with this package in the file LICENSE.md.
* It is also available through the world-wide-web at this URL:
* https://opensource.org/licenses/afl-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 license@thirtybees.com so we can send you a copy immediately.
*
* @author thirty bees <modules@thirtybees.com>
* @author PrestaShop SA <contact@prestashop.com>
* @copyright 2017-2024 thirty bees
* @copyright 2007-2016 PrestaShop SA
* @license Academic Free License (AFL 3.0)
* PrestaShop is an internationally registered trademark of PrestaShop SA.
*/
if (!defined('_TB_VERSION_')) {
exit;
}
/**
* Class BlockViewed
*
* @since 1.0.0
*/
class BlockViewed extends Module
{
/**
* BlockViewed constructor.
*
* @throws PrestaShopException
* @since 1.0.0
*/
public function __construct()
{
$this->name = 'blockviewed';
$this->tab = 'front_office_features';
$this->version = '2.1.0';
$this->author = 'thirty bees';
$this->need_instance = 0;
$this->bootstrap = true;
parent::__construct();
$this->displayName = $this->l('Block Viewed Products');
$this->description = $this->l('Adds a block displaying recently viewed products.');
$this->tb_versions_compliancy = '> 1.0.0';
$this->tb_min_version = '1.0.0';
}
/**
* @return bool
*
* @throws HTMLPurifier_Exception
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
* @since 1.0.0
*/
public function install()
{
if (!parent::install()
|| !$this->registerHook('header')
|| !$this->registerHook('leftColumn')
) {
return false;
}
Configuration::updateValue('PRODUCTS_VIEWED_NBR', 2);
return true;
}
/**
* Called in administration -> module -> configure
*
* @return string
* @throws HTMLPurifier_Exception
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
* @throws SmartyException
*/
public function getContent()
{
$output = '';
if (Tools::isSubmit('submitBlockViewed')) {
if (!($productNbr = Tools::getValue('PRODUCTS_VIEWED_NBR')) || empty($productNbr))
$output .= $this->displayError($this->l('You must fill in the \'Products displayed\' field.'));
elseif ((int)($productNbr) == 0)
$output .= $this->displayError($this->l('Invalid number.'));
else
{
Configuration::updateValue('PRODUCTS_VIEWED_NBR', (int)$productNbr);
$output .= $this->displayConfirmation($this->l('Settings updated'));
}
}
return $output.$this->renderForm();
}
/**
* @param array $params
*
* @return string|null
*
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
* @throws SmartyException
* @since 1.0.0
*/
public function hookRightColumn($params)
{
$context = Context::getContext();
$cookie = $context->cookie;
$languageId = (int)$context->language->id;
$productsViewed = $this->getViewedProducts($cookie);
if ($productsViewed) {
$productIds = implode(',', $productsViewed);
$productsData = Db::getInstance(_PS_USE_SQL_SLAVE_)->executeS('
SELECT MAX(image_shop.id_image) id_image, p.id_product, il.legend, product_shop.active, pl.name, pl.description_short, pl.link_rewrite, cl.link_rewrite AS category_rewrite
FROM '._DB_PREFIX_.'product p
'.Shop::addSqlAssociation('product', 'p').'
LEFT JOIN '._DB_PREFIX_.'product_lang pl ON (pl.id_product = p.id_product'.Shop::addSqlRestrictionOnLang('pl').')
LEFT JOIN '._DB_PREFIX_.'image i ON (i.id_product = p.id_product)'.
Shop::addSqlAssociation('image', 'i', false, 'image_shop.cover=1').'
LEFT JOIN '._DB_PREFIX_.'image_lang il ON (il.id_image = image_shop.id_image AND il.id_lang = '.$languageId.')
LEFT JOIN '._DB_PREFIX_.'category_lang cl ON (cl.id_category = product_shop.id_category_default'.Shop::addSqlRestrictionOnLang('cl').')
WHERE p.id_product IN ('.$productIds.')
AND pl.id_lang = '.$languageId.'
AND cl.id_lang = '.$languageId.'
AND product_shop.active
GROUP BY product_shop.id_product'
);
$productsImagesArray = [];
foreach ($productsData as $row) {
$productsImagesArray[(int)$row['id_product']] = $row;
}
$productsViewedObj = [];
foreach ($productsViewed as $productViewed)
{
if (isset($productsImagesArray[$productViewed])) {
$row = $productsImagesArray[$productViewed];
$obj = new stdClass();
$obj->id = (int)$row['id_product'];
$obj->active = true;
$obj->id_image = (int)$row['id_image'];
$obj->cover = (int)$row['id_image'];
$obj->legend = $row['legend'];
$obj->name = $row['name'];
$obj->description_short = $row['description_short'];
$obj->link_rewrite = $row['link_rewrite'];
$obj->category_rewrite = $row['category_rewrite'];
$obj->product_link = $this->context->link->getProductLink($obj->id, $obj->link_rewrite, $obj->category_rewrite);
$productsViewedObj[] = $obj;
}
}
if ($productsViewedObj) {
$this->smarty->assign([
'productsViewedObj' => $productsViewedObj,
'mediumSize' => Image::getSize('medium'),
]);
return $this->display(__FILE__, 'blockviewed.tpl');
}
}
return null;
}
/**
* @param array $params
*
* @return string
*
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
* @throws SmartyException
* @since 1.0.0
*/
public function hookLeftColumn($params)
{
return $this->hookRightColumn($params);
}
/**
* @param array $params
*
* @return string
*
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
* @throws SmartyException
* @since 1.0.0
*/
public function hookFooter($params)
{
return $this->hookRightColumn($params);
}
/**
* @param $params
*
* @throws PrestaShopException
* @since 1.0.0
*/
public function hookHeader($params)
{
$context = Context::getContext();
if ($context->controller->php_self === 'product') {
$productId = (int)Tools::getValue('id_product');
$product = new Product((int)$productId);
if (Validate::isLoadedObject($product) && $product->checkAccess((int)$this->context->customer->id)) {
// add product to list of viewed products
$cookie = $context->cookie;
$productsViewed = $this->getViewedProducts($cookie);
array_unshift($productsViewed, $productId);
$this->saveViewedProducts($cookie, $productsViewed);
}
}
$this->context->controller->addCSS($this->_path.'css/blockviewed.css');
}
/**
* @return string
*
* @throws PrestaShopDatabaseException
* @throws PrestaShopException
* @throws SmartyException
* @since 1.0.0
*/
public function renderForm()
{
$fields_form = [
'form' => [
'legend' => [
'title' => $this->l('Settings'),
'icon' => 'icon-cogs',
],
'input' => [
[
'type' => 'text',
'label' => $this->l('Products to display'),
'name' => 'PRODUCTS_VIEWED_NBR',
'desc' => $this->l('Define the number of products displayed in this block'),
'class' => 'fixed-width-xs',
],
],
'submit' => [
'title' => $this->l('Save'),
],
],
];
$helper = new HelperForm();
$helper->show_toolbar = false;
$helper->table = $this->table;
$lang = new Language((int) Configuration::get('PS_LANG_DEFAULT'));
$helper->default_form_language = $lang->id;
$helper->allow_employee_form_lang = Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') ? Configuration::get('PS_BO_ALLOW_EMPLOYEE_FORM_LANG') : 0;
$helper->identifier = $this->identifier;
$helper->submit_action = 'submitBlockViewed';
$helper->currentIndex = $this->context->link->getAdminLink('AdminModules', false).'&configure='.$this->name.'&tab_module='.$this->tab.'&module_name='.$this->name;
$helper->token = Tools::getAdminTokenLite('AdminModules');
$helper->tpl_vars = [
'fields_value' => $this->getConfigFieldsValues(),
'languages' => $this->context->controller->getLanguages(),
'id_language' => $this->context->language->id,
];
return $helper->generateForm([$fields_form]);
}
/**
* @return array
*
* @throws PrestaShopException
* @since 1.0.0
*/
public function getConfigFieldsValues()
{
return [
'PRODUCTS_VIEWED_NBR' => (int) Tools::getValue('PRODUCTS_VIEWED_NBR', Configuration::get('PRODUCTS_VIEWED_NBR')),
];
}
/**
* @param Cookie $cookie
* @return int[]
* @throws PrestaShopException
*/
protected function getViewedProducts(Cookie $cookie)
{
if (isset($cookie->viewed)) {
$limit = max(0, (int)Configuration::get('PRODUCTS_VIEWED_NBR'));
$viewed = explode(',', $cookie->viewed);
if ($viewed) {
$viewed = array_unique(array_map('intval', $viewed), SORT_NUMERIC);
if (count($viewed) > $limit) {
return $this->saveViewedProducts($cookie, $viewed);
}
return $viewed;
}
}
return [];
}
/**
* @param Cookie $cookie
* @param int[] $viewed
* @throws PrestaShopException
* @return int[]
*/
protected function saveViewedProducts(Cookie $cookie, array $viewed)
{
$viewed = array_unique(array_map('intval', $viewed), SORT_NUMERIC);
$limit = max(0, (int)Configuration::get('PRODUCTS_VIEWED_NBR'));
if (count($viewed) > $limit) {
$viewed = array_slice($viewed, 0, $limit);
}
if ($viewed) {
$value = implode(',', $viewed);
if (! isset($cookie->viewed) || $cookie->viewed != $value) {
$cookie->viewed = $value;
}
} else {
if (isset($cookie->viewed)) {
unset($cookie->viewed);
}
}
return $viewed;
}
}