Repository navigation
Expand file tree
/
Copy pathps_linklist.php
More file actions
336 lines (288 loc) · 10.3 KB
/
Copy pathps_linklist.php
File metadata and controls
336 lines (288 loc) · 10.3 KB
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
<?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 version 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 license@prestashop.com so we can send you a copy immediately.
*
* @author PrestaShop SA and Contributors <contact@prestashop.com>
* @copyright Since 2007 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License version 3.0
*/
if (!defined('_PS_VERSION_')) {
exit;
}
if (file_exists(__DIR__ . '/vendor/autoload.php')) {
require_once __DIR__ . '/vendor/autoload.php';
}
use PrestaShop\Module\LinkList\DataMigration;
use PrestaShop\Module\LinkList\Filter\BestSalesRouteFilter;
use PrestaShop\Module\LinkList\Filter\LinkFilter;
use PrestaShop\Module\LinkList\LegacyLinkBlockRepository;
use PrestaShop\Module\LinkList\Model\LinkBlockLang;
use PrestaShop\Module\LinkList\Presenter\LinkBlockPresenter;
use PrestaShop\Module\LinkList\Repository\LinkBlockRepository;
use PrestaShop\PrestaShop\Adapter\SymfonyContainer;
use PrestaShop\PrestaShop\Core\Module\WidgetInterface;
/**
* Class Ps_Linklist.
*/
class Ps_Linklist extends Module implements WidgetInterface
{
/**
* @var string Name of the module running on PS 1.6.x. Used for data migration.
*/
const PS_16_EQUIVALENT_MODULE = 'blockcms';
const MODULE_NAME = 'ps_linklist';
protected $_html;
protected $_display;
/**
* @var LinkBlockPresenter
*/
private $linkBlockPresenter;
/**
* @var LegacyLinkBlockRepository
*/
private $legacyBlockRepository;
/**
* @var LinkBlockRepository|LegacyLinkBlockRepository|null
*/
private $repository;
public $templateFile;
/**
* @var string
*/
public $templateFileColumn;
public function __construct()
{
$this->name = 'ps_linklist';
$this->author = 'PrestaShop';
$this->version = '7.0.1';
$this->need_instance = 0;
$this->tab = 'front_office_features';
$tabNames = [];
foreach (Language::getLanguages(true) as $lang) {
$tabNames[$lang['locale']] = $this->trans('Link List', [], 'Modules.Linklist.Admin', $lang['locale']);
}
$this->tabs = [
[
'route_name' => 'admin_link_block_list',
'class_name' => 'AdminLinkWidget',
'visible' => true,
'name' => $tabNames,
'parent_class_name' => 'AdminParentThemes',
'wording' => 'Link List',
'wording_domain' => 'Modules.Linklist.Admin',
],
];
$this->bootstrap = true;
parent::__construct();
$this->displayName = $this->trans('Link List', [], 'Modules.Linklist.Admin');
$this->description = $this->trans('Give more visibility to your content/static pages (CMS, external pages, or else), where you want and when you want, to make your visitors feel like shopping on your store.', [], 'Modules.Linklist.Admin');
$this->ps_versions_compliancy = ['min' => '9.0.0', 'max' => _PS_VERSION_];
$this->templateFile = 'module:ps_linklist/views/templates/hook/linkblock.tpl';
$this->templateFileColumn = 'module:ps_linklist/views/templates/hook/linkblock-column.tpl';
$this->linkBlockPresenter = new LinkBlockPresenter(
new Link(),
$this->context->language,
new LinkFilter([
new BestSalesRouteFilter(),
])
);
$this->legacyBlockRepository = new LegacyLinkBlockRepository(Db::getInstance(), $this->context->shop, $this->context->getTranslator());
}
public function install()
{
if (Shop::isFeatureActive()) {
Shop::setContext(Shop::CONTEXT_ALL);
}
if (!parent::install()) {
return false;
}
$tablesInstalledWithSuccess = $this->createTables();
if (!$tablesInstalledWithSuccess) {
$this->uninstall();
return false;
}
$old16ModuleUninstalledWithSuccess = $this->uninstallPrestaShop16Module();
if ($old16ModuleUninstalledWithSuccess) {
(new DataMigration(Db::getInstance()))->migrateData();
$dataLoadedWithSuccess = true;
} else {
$dataLoadedWithSuccess = $this->installFixtures();
}
$dataLoadedWithSuccess = $dataLoadedWithSuccess
&& $this->registerHook('displayFooter')
&& $this->registerHook('actionUpdateLangAfter')
&& $this->registerHook('actionGeneralPageSave');
if ($dataLoadedWithSuccess) {
return true;
}
$this->uninstall();
return false;
}
/**
* @return bool
*
* @throws \Doctrine\DBAL\Exception
*/
private function createTables()
{
$result = $this->getRepository()->createTables();
if (false === $result || (is_array($result) && !empty($result))) {
if (is_array($result)) {
$this->addModuleErrors($result);
}
return false;
}
return true;
}
/**
* @return bool
*
* @throws \Doctrine\DBAL\Exception
*/
private function installFixtures()
{
$result = $this->getRepository()->installFixtures();
if (false === $result || (is_array($result) && !empty($result))) {
if (is_array($result)) {
$this->addModuleErrors($result);
}
return false;
}
return true;
}
public function uninstall()
{
$uninstalled = true;
$result = $this->getRepository()->dropTables();
if (false === $result || (is_array($result) && !empty($result))) {
if (is_array($result)) {
$this->addModuleErrors($result);
}
$uninstalled = false;
}
return $uninstalled && parent::uninstall();
}
/**
* Migrate data from 1.6 equivalent module (if applicable), then uninstall
*/
private function uninstallPrestaShop16Module()
{
if (!Module::isInstalled(self::PS_16_EQUIVALENT_MODULE)) {
return false;
}
$oldModule = Module::getInstanceByName(self::PS_16_EQUIVALENT_MODULE);
if ($oldModule) {
// This closure calls the parent class to prevent data to be erased
// It allows the new module to be configured without migration
$parentUninstallClosure = function () {
return parent::uninstall();
};
$parentUninstallClosure = $parentUninstallClosure->bindTo($oldModule, get_class($oldModule));
$parentUninstallClosure();
}
return true;
}
public function hookActionUpdateLangAfter($params)
{
if (!empty($params['lang']) && $params['lang'] instanceof Language) {
Language::updateMultilangFromClass(_DB_PREFIX_ . 'link_block_lang', LinkBlockLang::class, $params['lang']);
}
}
public function hookActionGeneralPageSave()
{
$this->_clearCache('');
}
public function _clearCache($template, $cache_id = null, $compile_id = null)
{
return array_sum([
parent::_clearCache($this->templateFile),
parent::_clearCache($this->templateFileColumn),
]);
}
public function getContent()
{
// We need to explicitely get Symfony container, because $this->get will use the admin legacy container
$sfContainer = SymfonyContainer::getInstance();
$router = $sfContainer->get('router');
Tools::redirectAdmin(
$router->generate('admin_link_block_list')
);
}
public function renderWidget($hookName, array $configuration)
{
$key = 'ps_linklist|' . $hookName;
if (
in_array($hookName, [
'displayLeftColumn',
'displayLeftColumnProduct',
'displayRightColumn',
'displayRightColumnProduct',
])
) {
$template = $this->templateFileColumn;
} else {
$template = $this->templateFile;
}
if (!$this->isCached($template, $this->getCacheId($key))) {
$this->smarty->assign($this->getWidgetVariables($hookName, $configuration));
}
return $this->fetch($template, $this->getCacheId($key));
}
public function getWidgetVariables($hookName, array $configuration)
{
$id_hook = Hook::getIdByName($hookName);
$linkBlocks = $this->legacyBlockRepository->getByIdHook($id_hook);
$blocks = [];
foreach ($linkBlocks as $block) {
$blocks[] = $this->linkBlockPresenter->present($block);
}
return [
'linkBlocks' => $blocks,
'hookName' => $hookName,
];
}
/**
* @param array $errors
*/
private function addModuleErrors(array $errors)
{
foreach ($errors as $error) {
$this->_errors[] = $this->trans($error['key'], $error['parameters'], $error['domain']);
}
}
/**
* @return LinkBlockRepository|LegacyLinkBlockRepository
*/
private function getRepository()
{
if (null === $this->repository) {
try {
$this->repository = $this->get('prestashop.module.link_block.repository');
} catch (Throwable $e) {
try {
$container = SymfonyContainer::getInstance();
if (null !== $container) {
$this->repository = $container->get('prestashop.module.link_block.repository');
}
} catch (Throwable $e) {
}
}
}
// Container is not available so we use legacy repository as fallback
if (!$this->repository) {
$this->repository = $this->legacyBlockRepository;
}
return $this->repository;
}
}