forked from PrestaShopCorp/ps_mbo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ps_mbo.php
421 lines (378 loc) · 12.3 KB
/
ps_mbo.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
<?php
/**
* 2007-2020 PrestaShop and Contributors
*
* 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.txt.
* 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.
*
* @author PrestaShop SA <[email protected]>
* @copyright 2007-2020 PrestaShop SA and Contributors
* @license https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
* International Registered Trademark & Property of PrestaShop SA
*/
if (!defined('_PS_VERSION_')) {
exit;
}
$autoloadPath = __DIR__ . '/vendor/autoload.php';
if (file_exists($autoloadPath)) {
require_once $autoloadPath;
}
use PrestaShop\Module\Mbo\Tab\TabCollectionProvider;
use PrestaShop\PrestaShop\Adapter\SymfonyContainer;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
class ps_mbo extends Module
{
const TABS_WITH_RECOMMENDED_MODULES_BUTTON = [
'AdminProducts',
'AdminCategories',
'AdminTracking',
'AdminAttributesGroups',
'AdminFeatures',
'AdminManufacturers',
'AdminSuppliers',
'AdminTags',
'AdminOrders',
'AdminInvoices',
'AdminReturn',
'AdminDeliverySlip',
'AdminSlip',
'AdminStatuses',
'AdminOrderMessage',
'AdminCustomers',
'AdminAddresses',
'AdminGroups',
'AdminCarts',
'AdminCustomerThreads',
'AdminContacts',
'AdminCartRules',
'AdminSpecificPriceRule',
'AdminShipping',
'AdminLocalization',
'AdminZones',
'AdminCountries',
'AdminCurrencies',
'AdminTaxes',
'AdminTaxRulesGroup',
'AdminTranslations',
'AdminPreferences',
'AdminOrderPreferences',
'AdminPPreferences',
'AdminCustomerPreferences',
'AdminThemes',
'AdminMeta',
'AdminCmsContent',
'AdminImages',
'AdminSearchConf',
'AdminGeolocation',
'AdminInformation',
'AdminPerformance',
'AdminEmails',
'AdminImport',
'AdminBackup',
'AdminRequestSql',
'AdminLogs',
'AdminAdminPreferences',
'AdminStats',
'AdminSearchEngines',
'AdminReferrers',
];
const TABS_WITH_RECOMMENDED_MODULES_AFTER_CONTENT = [
'AdminMarketing',
'AdminPayment',
'AdminCarriers',
];
const ADMIN_CONTROLLERS = [
'AdminPsMboModule' => [
'name' => 'Module catalog',
'visible' => true,
'class_name' => 'AdminPsMboModule',
'parent_class_name' => 'AdminParentModulesCatalog',
'core_reference' => 'AdminModulesCatalog',
],
'AdminPsMboAddons' => [
'name' => 'Module selection',
'visible' => true,
'class_name' => 'AdminPsMboAddons',
'parent_class_name' => 'AdminParentModulesCatalog',
'core_reference' => 'AdminAddonsCatalog',
],
'AdminPsMboRecommended' => [
'name' => 'Module recommended',
'visible' => true,
'class_name' => 'AdminPsMboRecommended',
],
'AdminPsMboTheme' => [
'name' => 'Theme catalog',
'visible' => true,
'class_name' => 'AdminPsMboTheme',
'parent_class_name' => 'AdminParentThemes',
'core_reference' => 'AdminThemesCatalog',
],
];
const HOOKS = [
'actionAdminControllerSetMedia',
'displayDashboardTop',
];
/**
* @var ContainerInterface
*/
protected $container;
/**
* Constructor.
*/
public function __construct()
{
$this->name = 'ps_mbo';
$this->version = '2.0.2';
$this->author = 'PrestaShop';
$this->tab = 'administration';
$this->module_key = '6cad5414354fbef755c7df4ef1ab74eb';
$this->need_instance = 0;
$this->ps_versions_compliancy = [
'min' => '1.7.5.0',
'max' => _PS_VERSION_,
];
parent::__construct();
$this->displayName = $this->l('PrestaShop Marketplace in your Back Office');
$this->description = $this->l('Browse the Addons marketplace directly from your back office to better meet your needs.');
}
/**
* Install Module.
*
* @return bool
*/
public function install()
{
return parent::install()
&& $this->registerHook(static::HOOKS);
}
/**
* Enable Module.
*
* @return bool
*/
public function enable($force_all = false)
{
return parent::enable($force_all)
&& $this->installTabs();
}
/**
* Install all Tabs.
*
* @return bool
*/
public function installTabs()
{
foreach (static::ADMIN_CONTROLLERS as $adminTab) {
if (false === $this->installTab($adminTab)) {
return false;
}
}
return true;
}
/**
* Install Tab.
* Used in upgrade script.
*
* @param array $tabData
*
* @return bool
*/
public function installTab(array $tabData)
{
$position = 0;
$tabNameByLangId = array_fill_keys(
Language::getIDs(false),
$tabData['name']
);
if (isset($tabData['core_reference'])) {
$tabCoreId = Tab::getIdFromClassName($tabData['core_reference']);
if ($tabCoreId !== false) {
$tabCore = new Tab($tabCoreId);
$tabNameByLangId = $tabCore->name;
$position = $tabCore->position;
$tabCore->active = false;
$tabCore->save();
}
}
$tab = new Tab();
$tab->module = $this->name;
$tab->class_name = $tabData['class_name'];
$tab->position = (int) $position;
$tab->id_parent = empty($tabData['parent_class_name']) ? -1 : Tab::getIdFromClassName($tabData['parent_class_name']);
$tab->name = $tabNameByLangId;
if (false === (bool) $tab->add()) {
return false;
}
if (Validate::isLoadedObject($tab)) {
// Updating the id_parent will override the position, that's why we save 2 times
$tab->position = (int) $position;
$tab->save();
}
return true;
}
/**
* Disable Module.
*
* @return bool
*/
public function disable($force_all = false)
{
return parent::disable($force_all)
&& $this->uninstallTabs();
}
/**
* Uninstall all Tabs.
*
* @return bool
*/
public function uninstallTabs()
{
foreach (static::ADMIN_CONTROLLERS as $adminTab) {
if (false === $this->uninstallTab($adminTab)) {
return false;
}
}
return true;
}
/**
* Uninstall Tab.
* Can be used in upgrade script.
*
* @param array $tabData
*
* @return bool
*/
public function uninstallTab(array $tabData)
{
$tabId = Tab::getIdFromClassName($tabData['class_name']);
$tab = new Tab($tabId);
if (false === Validate::isLoadedObject($tab)) {
return false;
}
if (false === (bool) $tab->delete()) {
return false;
}
if (isset($tabData['core_reference'])) {
$tabCoreId = Tab::getIdFromClassName($tabData['core_reference']);
$tabCore = new Tab($tabCoreId);
if (Validate::isLoadedObject($tabCore)) {
$tabCore->active = true;
}
if (false === (bool) $tabCore->save()) {
return false;
}
}
return true;
}
/**
* Hook actionAdminControllerSetMedia.
*/
public function hookActionAdminControllerSetMedia()
{
// has to be loaded in header to prevent flash of content
$this->context->controller->addJs($this->getPathUri() . 'views/js/recommended-modules.js?v=' . $this->version);
if ($this->shouldAttachRecommendedModulesButton()
|| $this->shouldAttachRecommendedModulesAfterContent()
) {
$this->context->controller->addCSS($this->getPathUri() . 'views/css/recommended-modules.css');
$this->context->controller->addJs(
rtrim(__PS_BASE_URI__, '/')
. str_ireplace(
_PS_CORE_DIR_,
'',
_PS_BO_ALL_THEMES_DIR_
)
. 'default/js/bundle/module/module_card.js?v='
. _PS_VERSION_
);
}
}
/**
* Hook displayDashboardTop.
* Includes content just below the toolbar.
*
* @return string
*/
public function hookDisplayDashboardTop()
{
/** @var UrlGeneratorInterface $router */
$router = $this->get('router');
try {
$recommendedModulesUrl = $router->generate(
'admin_mbo_recommended_modules',
[
'tabClassName' => Tools::getValue('controller'),
]
);
} catch (Exception $exception) {
// Avoid fatal errors on ServiceNotFoundException
return '';
}
$this->smarty->assign([
'shouldAttachRecommendedModulesAfterContent' => $this->shouldAttachRecommendedModulesAfterContent(),
'shouldAttachRecommendedModulesButton' => $this->shouldAttachRecommendedModulesButton(),
'shouldUseLegacyTheme' => $this->isAdminLegacyContext(),
'recommendedModulesTitleTranslated' => $this->trans('Recommended Modules and Services'),
'recommendedModulesCloseTranslated' => $this->trans('Close', [], 'Admin.Actions'),
'recommendedModulesUrl' => $recommendedModulesUrl,
]);
return $this->fetch('module:ps_mbo/views/templates/hook/recommended-modules.tpl');
}
/**
* Indicates if the recommended modules should be attached after content in this page
*
* @return bool
*/
private function shouldAttachRecommendedModulesAfterContent()
{
// AdminLogin should not call TabCollectionProvider
if (Validate::isLoadedObject($this->context->employee)) {
/** @var TabCollectionProvider $tabCollectionProvider */
$tabCollectionProvider = $this->get('mbo.tab.collection.provider');
if ($tabCollectionProvider->isTabCollectionCached()) {
return $tabCollectionProvider->getTabCollection()->getTab(Tools::getValue('controller'))->shouldDisplayAfterContent()
|| 'AdminCarriers' === Tools::getValue('controller');
}
}
return in_array(Tools::getValue('controller'), static::TABS_WITH_RECOMMENDED_MODULES_AFTER_CONTENT, true);
}
/**
* Indicates if the recommended modules button should be attached in this page
*
* @return bool
*/
private function shouldAttachRecommendedModulesButton()
{
// AdminLogin should not call TabCollectionProvider
if (Validate::isLoadedObject($this->context->employee)) {
/** @var TabCollectionProvider $tabCollectionProvider */
$tabCollectionProvider = $this->get('mbo.tab.collection.provider');
if ($tabCollectionProvider->isTabCollectionCached()) {
return $tabCollectionProvider->getTabCollection()->getTab(Tools::getValue('controller'))->shouldDisplayButton()
&& 'AdminCarriers' !== Tools::getValue('controller');
}
}
return in_array(Tools::getValue('controller'), static::TABS_WITH_RECOMMENDED_MODULES_BUTTON, true);
}
/**
* Override of native function to always retrieve Symfony container instead of legacy admin container on legacy context.
*
* {@inheritdoc}
*/
public function get($serviceName)
{
if (null === $this->container) {
$this->container = SymfonyContainer::getInstance();
}
return $this->container->get($serviceName);
}
}