forked from sarjon/gamifications
-
Notifications
You must be signed in to change notification settings - Fork 1
/
gamifications.php
304 lines (254 loc) · 8.41 KB
/
gamifications.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
<?php
/**
* This file is part of the Gamifications module.
*
* @author Sarunas Jonusas, <[email protected]>
* @copyright Copyright (c) permanent, Sarunas Jonusas
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
use PrestaShop\PrestaShop\Core\Foundation\Database\EntityManager;
/**
* Class Gamifications
*/
class Gamifications extends Module
{
/**
* Module admin controllers
*/
const ADMIN_GAMIFICATIONS_MODULE_CONTROLLER = 'AdminGamificationsModule';
const ADMIN_GAMIFICATIONS_PREFERENCE_CONTROLLER = 'AdminGamificationsPreference';
const ADMIN_GAMIFICATIONS_REWARD_CONTROLLER = 'AdminGamificationsReward';
const ADMIN_GAMIFICATIONS_ACTIVITY_CONTROLLER = 'AdminGamificationsActivity';
const ADMIN_GAMIFICATIONS_DAILY_REWARDS_CONTROLLER = 'AdminGamificationsDailyRewards';
const ADMIN_GAMIFICATIONS_POINT_EXCHANGE_CONTROLLER = 'AdminGamificationsPointExchange';
const ADMIN_GAMIFICATIONS_STATS_CONTROLLER = 'AdminGamificationsStats';
const ADMIN_GAMIFICATIONS_CUSTOMER_CONTROLLER = 'AdminGamificationsCustomer';
const ADMIN_GAMIFICATIONS_ACTIVITY_HISTORY_CONTROLLER = 'AdminGamificationsActivityHistory';
const ADMIN_GAMIFICATIONS_REFERRAL_CONTROLLER = 'AdminGamificationsReferral';
const ADMIN_GAMIFICATIONS_SHOPPING_POINT_CONTROLLER = 'AdminGamificationsShoppingPoint';
const ADMIN_GAMIFICATIONS_RANKING_CONTROLLER = 'AdminGamificationsRanking';
/**
* Module front controllers
*/
const FRONT_LOYALITY_CONTROLLER = 'loyality';
const FRONT_EXCHANGE_POINTS_CONTROLLER = 'exchangepoints';
/**
* @var EntityManager
*/
private $em;
/**
* Gamification constructor.
*
* @param EntityManager $em
*/
public function __construct(EntityManager $em)
{
$this->name = 'gamifications';
$this->author = 'Šarūnas Jonušas';
$this->tab = 'front_office_features';
$this->version = '1.0.0';
$this->need_instance = 0;
$this->controllers = [self::FRONT_LOYALITY_CONTROLLER, self::FRONT_EXCHANGE_POINTS_CONTROLLER];
parent::__construct();
$this->requireAutoloader();
$this->ps_versions_compliancy = ['min' => '1.7.0.0', 'max' => _PS_VERSION_];
$this->displayName = $this->l('Gamification: Customers loyalty program');
$this->description = $this->l('Increase customers loyality by adding various activities to your shop!').' '.
$this->l('Daily rewards, referral program, shopping points, gifts & more!');
$this->em = $em;
}
/**
* Process module installation
*
* @return bool
*/
public function install()
{
$installer = new GamificationsInstaller($this);
if (!parent::install() || !$installer->install()) {
return false;
}
return true;
}
/**
* Process module uninstall
*
* @return bool
*/
public function uninstall()
{
$installer = new GamificationsInstaller($this);
if (!$installer->uninstall() || !parent::uninstall()) {
return false;
}
return true;
}
/**
* Redirect to Preference controller
*/
public function getContent()
{
Tools::redirectAdmin($this->context->link->getAdminLink(self::ADMIN_GAMIFICATIONS_PREFERENCE_CONTROLLER));
}
/**
* Get entity manager
*
* @return EntityManager
*/
public function getEntityManager()
{
return $this->em;
}
/**
* Get context
*
* @return Context
*/
public function getContext()
{
return $this->context;
}
/**
* Display gamification page url in my-account page
*
* @return string
*/
public function hookDisplayCustomerAccount()
{
$frontOfficeTitle = Configuration::get(GamificationsConfig::FRONT_OFFICE_TITLE, $this->context->language->id);
$params = [
'front_office_title' => $frontOfficeTitle,
];
return $this->render('hook/displayCustomerAccount.tpl', $params);
}
/**
* Handle customer referral
*
* @param array $params
*/
public function hookActionObjectCustomerAddAfter(array $params)
{
if (!Tools::isSubmit('referral_code')) {
return;
}
$isReferralProgramEnabled = (bool) Configuration::get(GamificationsConfig::REFERRAL_PROGRAM_STATUS);
if (!$isReferralProgramEnabled) {
return;
}
/** @var Customer $invitedCustomer */
$invitedCustomer = $params['object'];
$referralCode = Tools::getValue('referral_code');
$referralProgramActivity = new GamificationsReferralProgramActivity($this->getEntityManager());
$referralProgramActivity->processReferralProgram($invitedCustomer, $referralCode);
}
/**
* Reward referral if order is valid
*
* @param array $params
*/
public function hookActionObjectOrderAddAfter(array $params)
{
/** @var Order $order */
$order = $params['object'];
$this->processReferralProgramActivity($order);
$this->processShoppingPoints($order, true);
}
/**
* Reward referral if order is valid
*
* @param array $params
*/
public function hookActionObjectOrderUpdateAfter(array $params)
{
/** @var Order $order */
$order = $params['object'];
$this->processReferralProgramActivity($order);
$this->processShoppingPoints($order);
}
/**
* Delete gamifications customer on customer delete
*
* @param array $params
*/
public function hookActionObjectCustomerDeleteAfter(array $params)
{
/** @var Customer $customer */
$customer = $params['object'];
GamificationsCustomer::remove($customer);
}
/**
* Display how many points will be earned
*
* @return string
*/
public function hookDisplayReassurance()
{
$isShoppingPointsEnabled = (bool) Configuration::get(GamificationsConfig::SHOPPING_POINTS_STATUS);
if (!$isShoppingPointsEnabled) {
return '';
}
$shoppingPointActivity = new GamificationsShoppingPointActivity($this->getEntityManager());
$possiblePoints = $shoppingPointActivity->calculatePossiblePoints();
return $this->render('hook/displayReassurance.tpl', ['possible_points' => $possiblePoints]);
}
/**
* Process referral program activity
*
* @param Order $order
*/
protected function processReferralProgramActivity(Order $order)
{
$isReferralProgramEnabled = (bool) Configuration::get(GamificationsConfig::REFERRAL_PROGRAM_STATUS);
if (!$isReferralProgramEnabled) {
return;
}
$referralProgramActivity = new GamificationsReferralProgramActivity($this->getEntityManager());
$referralProgramActivity->processReferralCustomerReward($order);
}
/**
* Process Shopping Points activity
*
* @param Order $order
* @param bool $createObject
*/
protected function processShoppingPoints(Order $order, $createObject = false)
{
static $hasProcessed;
$orderKey = sprintf('processShoppingPoints_order_%s', $order->id);
if (isset($hasProcessed[$orderKey])) {
return;
}
$isShoppingPointsEnabled = (bool) Configuration::get(GamificationsConfig::SHOPPING_POINTS_STATUS);
if (!$isShoppingPointsEnabled) {
return;
}
$shoppingPointActivity = new GamificationsShoppingPointActivity($this->getEntityManager());
$shoppingPointActivity->processOrder($order, $createObject);
$hasProcessed[$orderKey] = true;
}
/**
* Render template
*
* @param string $path
* @param array $params
*
* @return string
*/
protected function render($path, array $params = [])
{
if (!empty($params)) {
$this->context->smarty->assign($params);
}
$template = sprintf('module:%s/views/templates/'.$path, $this->name);
return $this->context->smarty->fetch($template);
}
/**
* Require autoloader
*/
private function requireAutoloader()
{
require_once $this->getLocalPath().'vendor/autoload.php';
}
}