-
Notifications
You must be signed in to change notification settings - Fork 25
/
ps_categorytree.php
373 lines (333 loc) · 15.8 KB
/
ps_categorytree.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
<?php
/**
* Copyright since 2007 PrestaShop SA and Contributors
* PrestaShop is an International Registered Trademark & Property of PrestaShop SA
*
* NOTICE OF LICENSE
*
* This source file is subject to the Academic Free License 3.0 (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
* 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 [email protected] so we can send you a copy immediately.
*
* DISCLAIMER
*
* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
* versions in the future. If you wish to customize PrestaShop for your
* needs please refer to https://devdocs.prestashop.com/ for more information.
*
* @author PrestaShop SA and Contributors <[email protected]>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
*/
if (!defined('_PS_VERSION_')) {
exit;
}
use PrestaShop\PrestaShop\Core\Module\WidgetInterface;
class Ps_CategoryTree extends Module implements WidgetInterface
{
/**
* @var int A way to display the category tree: Home category
*/
const CATEGORY_ROOT_HOME = 0;
/**
* @var int A way to display the category tree: Current category
*/
const CATEGORY_ROOT_CURRENT = 1;
/**
* @var int A way to display the category tree: Parent category
*/
const CATEGORY_ROOT_PARENT = 2;
/**
* @var int A way to display the category tree: Current category and its parent (if exists)
*/
const CATEGORY_ROOT_CURRENT_PARENT = 3;
public function __construct()
{
$this->name = 'ps_categorytree';
$this->tab = 'front_office_features';
$this->version = '3.0.1';
$this->author = 'PrestaShop';
$this->bootstrap = true;
parent::__construct();
$this->displayName = $this->trans('Category tree links', [], 'Modules.Categorytree.Admin');
$this->description = $this->trans('Help navigation on your store, show your visitors current category and subcategories.', [], 'Modules.Categorytree.Admin');
$this->ps_versions_compliancy = ['min' => '1.7.7.0', 'max' => _PS_VERSION_];
}
public function install()
{
return parent::install() && $this->registerHook('displayLeftColumn');
}
public function uninstall()
{
if (!parent::uninstall() ||
!Configuration::deleteByName('BLOCK_CATEG_MAX_DEPTH') ||
!Configuration::deleteByName('BLOCK_CATEG_ROOT_CATEGORY')) {
return false;
}
return true;
}
public function getContent()
{
$output = '';
if (Tools::isSubmit('submitBlockCategories')) {
$maxDepth = (int) (Tools::getValue('BLOCK_CATEG_MAX_DEPTH'));
if ($maxDepth < 0) {
$output .= $this->displayError($this->trans('Maximum depth: Invalid number.', [], 'Admin.Notifications.Error'));
} else {
Configuration::updateValue('BLOCK_CATEG_MAX_DEPTH', (int) $maxDepth);
Configuration::updateValue('BLOCK_CATEG_SORT_WAY', Tools::getValue('BLOCK_CATEG_SORT_WAY'));
Configuration::updateValue('BLOCK_CATEG_SORT', Tools::getValue('BLOCK_CATEG_SORT'));
Configuration::updateValue('BLOCK_CATEG_ROOT_CATEGORY', Tools::getValue('BLOCK_CATEG_ROOT_CATEGORY'));
Tools::redirectAdmin(AdminController::$currentIndex . '&configure=' . $this->name . '&token=' . Tools::getAdminTokenLite('AdminModules') . '&conf=6');
}
}
return $output . $this->renderForm();
}
/**
* Format category into an array compatible with existing templates.
*/
private function formatCategory($rawCategory, $idsOfCategoriesInPath): array
{
$children = [];
if (!empty($rawCategory['children'])) {
foreach ($rawCategory['children'] as $k => $v) {
$children[$k] = $this->formatCategory($v, $idsOfCategoriesInPath);
}
}
return [
'id' => $rawCategory['id_category'],
'link' => $this->context->link->getCategoryLink($rawCategory['id_category'], $rawCategory['link_rewrite']),
'name' => $rawCategory['name'],
'desc' => $rawCategory['description'],
'children' => $children,
'in_path' => in_array($rawCategory['id_category'], $idsOfCategoriesInPath),
];
}
private function getCategories($category): array
{
// Determine max depth to get categories
$maxdepth = (int) Configuration::get('BLOCK_CATEG_MAX_DEPTH');
if ($maxdepth > 0) {
$maxdepth += $category->level_depth;
}
// Define filters to get categories
$groups = Customer::getGroupsStatic((int) $this->context->customer->id);
$sqlFilter = $maxdepth ? 'AND c.`level_depth` <= ' . (int) $maxdepth : '';
$orderBy = ' ORDER BY c.`level_depth` ASC, ' . (Configuration::get('BLOCK_CATEG_SORT') ? 'cl.`name`' : 'category_shop.`position`') . ' ' . (Configuration::get('BLOCK_CATEG_SORT_WAY') ? 'DESC' : 'ASC');
// Retrieve them using the built in method
$categories = Category::getNestedCategories($category->id, $this->context->language->id, true, $groups, true, $sqlFilter, $orderBy);
if (empty($categories)) {
return [];
}
// Get path to current category so we can use it for marking
$idsOfCategoriesInPath = $this->getIdsOfCategoriesInPathToCurrentCategory();
// And do our formatting
foreach ($categories as $k => $v) {
$categories[$k] = $this->formatCategory($v, $idsOfCategoriesInPath);
}
return array_shift($categories);
}
public function renderForm()
{
$fields_form = [
'form' => [
'legend' => [
'title' => $this->trans('Settings', [], 'Admin.Global'),
'icon' => 'icon-cogs',
],
'input' => [
[
'type' => 'radio',
'label' => $this->trans('Category root', [], 'Modules.Categorytree.Admin'),
'name' => 'BLOCK_CATEG_ROOT_CATEGORY',
'hint' => $this->trans('Select which category is displayed in the block. The current category is the one the visitor is currently browsing.', [], 'Modules.Categorytree.Admin'),
'values' => [
[
'id' => 'home',
'value' => static::CATEGORY_ROOT_HOME,
'label' => $this->trans('Home category', [], 'Modules.Categorytree.Admin'),
],
[
'id' => 'current',
'value' => static::CATEGORY_ROOT_CURRENT,
'label' => $this->trans('Current category', [], 'Modules.Categorytree.Admin'),
],
[
'id' => 'parent',
'value' => static::CATEGORY_ROOT_PARENT,
'label' => $this->trans('Parent category', [], 'Modules.Categorytree.Admin'),
],
[
'id' => 'current_parent',
'value' => static::CATEGORY_ROOT_CURRENT_PARENT,
'label' => $this->trans('Current category, unless it has no subcategories, in which case the parent category of the current category is used', [], 'Modules.Categorytree.Admin'),
],
],
],
[
'type' => 'text',
'label' => $this->trans('Maximum depth', [], 'Modules.Categorytree.Admin'),
'name' => 'BLOCK_CATEG_MAX_DEPTH',
'desc' => $this->trans('Set the maximum depth of category sublevels displayed in this block (0 = infinite).', [], 'Modules.Categorytree.Admin'),
],
[
'type' => 'radio',
'label' => $this->trans('Sort', [], 'Admin.Actions'),
'name' => 'BLOCK_CATEG_SORT',
'values' => [
[
'id' => 'name',
'value' => 1,
'label' => $this->trans('By name', [], 'Admin.Global'),
],
[
'id' => 'position',
'value' => 0,
'label' => $this->trans('By position', [], 'Admin.Global'),
],
],
],
[
'type' => 'radio',
'label' => $this->trans('Sort order', [], 'Admin.Actions'),
'name' => 'BLOCK_CATEG_SORT_WAY',
'values' => [
[
'id' => 'name',
'value' => 1,
'label' => $this->trans('Descending', [], 'Admin.Global'),
],
[
'id' => 'position',
'value' => 0,
'label' => $this->trans('Ascending', [], 'Admin.Global'),
],
],
],
],
'submit' => [
'title' => $this->trans('Save', [], 'Admin.Actions'),
],
],
];
$helper = new HelperForm();
$helper->show_toolbar = false;
$helper->table = $this->table;
$helper->submit_action = 'submitBlockCategories';
$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(),
];
return $helper->generateForm([$fields_form]);
}
public function getConfigFieldsValues()
{
return [
'BLOCK_CATEG_MAX_DEPTH' => Tools::getValue('BLOCK_CATEG_MAX_DEPTH', Configuration::get('BLOCK_CATEG_MAX_DEPTH')),
'BLOCK_CATEG_SORT_WAY' => Tools::getValue('BLOCK_CATEG_SORT_WAY', Configuration::get('BLOCK_CATEG_SORT_WAY')),
'BLOCK_CATEG_SORT' => Tools::getValue('BLOCK_CATEG_SORT', Configuration::get('BLOCK_CATEG_SORT')),
'BLOCK_CATEG_ROOT_CATEGORY' => Tools::getValue('BLOCK_CATEG_ROOT_CATEGORY', Configuration::get('BLOCK_CATEG_ROOT_CATEGORY')),
];
}
public function renderWidget($hookName = null, array $configuration = [])
{
$this->smarty->assign($this->getWidgetVariables($hookName, $configuration));
return $this->fetch('module:ps_categorytree/views/templates/hook/ps_categorytree.tpl');
}
public function getWidgetVariables($hookName = null, array $configuration = [])
{
switch (Configuration::get('BLOCK_CATEG_ROOT_CATEGORY')) {
// Always the home category
case static::CATEGORY_ROOT_HOME:
$rootCategory = $this->getHomeCategory();
break;
// Always the current category
case static::CATEGORY_ROOT_CURRENT:
$rootCategory = $this->getCurrentCategory();
break;
// Always the parent category
case static::CATEGORY_ROOT_PARENT:
$rootCategory = $this->tryToGetParentCategoryIfAvailable($this->getCurrentCategory());
break;
// Current category, unless it has no subcategories, in which case the parent category of the current category is used
case static::CATEGORY_ROOT_CURRENT_PARENT:
$rootCategory = $this->getCurrentCategory();
if (!$rootCategory->getSubCategories($rootCategory->id, true)) {
$rootCategory = $this->tryToGetParentCategoryIfAvailable($rootCategory);
}
break;
default:
$rootCategory = $this->getHomeCategory();
}
return [
'categories' => $this->getCategories($rootCategory),
'currentCategory' => $rootCategory->id,
];
}
/*
* Tries to retrieve current category from the context. In case of category controller, it's the category.
* In case of product controller, it's either the default category of the product, or the category the customer
* came from. This is resolved by the ProductController.
*/
private function getCurrentCategory(): Category
{
/*
* We check several things:
* If the controller has the method
* If we are on the correct controller
* If we have some sensible data and the category is properly loaded
*/
if (
!method_exists($this->context->controller, 'getCategory') ||
(!$this->context->controller instanceof CategoryController && !$this->context->controller instanceof ProductController) ||
empty($this->context->controller->getCategory()) ||
!Validate::isLoadedObject($this->context->controller->getCategory())
) {
return $this->getHomeCategory();
}
return $this->context->controller->getCategory();
}
/*
* Tries to get a parent of the current category.
* If we are already on the top of the tree, it will return the input.
*
* Three cases can happen:
* - This category has a normal active parent
* - This category has a disabled parent
* - This category is already the home category
*/
private function tryToGetParentCategoryIfAvailable($category): Category
{
// If we are already on the top of the tree, nothing to do here
if ($category->is_root_category || !$category->id_parent || $category->id == Configuration::get('PS_HOME_CATEGORY')) {
return $category;
}
// We try to load the parent
$parentCategory = new Category($category->id_parent, $this->context->language->id);
// If the parent is malfunctioned somehow, we can't do anything and we return the home category
if (!Validate::isLoadedObject($parentCategory)) {
return $this->getHomeCategory();
}
// Now we have a valid parent category, let's check it. It must be active, accessible and belong to the shop.
// Same conditions as in CategoryController. If it fails, we select the next parent.
if (!$parentCategory->active || !$category->checkAccess((int) $this->context->customer->id) || !$category->existsInShop($this->context->shop->id)) {
return $this->tryToGetParentCategoryIfAvailable($parentCategory);
}
return $parentCategory;
}
private function getIdsOfCategoriesInPathToCurrentCategory(): array
{
// Call built in method to retrieve all parents, including the current category
$categories = $this->getCurrentCategory()->getParentsCategories();
return array_column($categories, 'id_category');
}
private function getHomeCategory(): Category
{
return new Category((int) Configuration::get('PS_HOME_CATEGORY'), $this->context->language->id);
}
}