-
Notifications
You must be signed in to change notification settings - Fork 24
/
Plan.php
447 lines (374 loc) · 11.2 KB
/
Plan.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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
<?php
/**
* @package StartupAPI
* @subpackage Subscriptions
*/
require_once (__DIR__ . '/PaymentSchedule.php');
/**
* Every account is associated with existing Plan using Plan Slug and PaymentSchedule using PaymentSchedule Slug.
*/
class Plan {
/**
* @var string Plan slug
*/
private $slug;
/**
* @var string Plan name
*/
private $name;
/**
* @var boolean Indicates to users that plan is available for selection
*/
private $available;
/**
* @var string Plan description
*/
private $description;
/**
* @var int Base price to display for the plan (actual charges are managed by PaymentSchedule class)
*/
private $base_price;
/**
* @var string Base plan price period to display for the plan (actual charge intervals managed by PaymentSchedule class)
*/
private $base_period;
/**
* @var string Plan details page URL
*/
private $details_url;
/**
* Capabilities supported by accounts that subscribe to this plan.
*
* You can test for those capabilities in your code.
*
* StartupAPI also supports following capabilities out of the box:
* - individual: true / false (indicates that account only allows for one member)
*
* @var mixed[] Array of capabilities
*/
private $capabilities;
/**
* @var string Slug of the plan to downgrade to when subscription ends or cancelled
*/
private $downgrade_to_slug;
/**
* @var int Amount of days to wait after due payment is not recieved before downgrading the account
*/
private $grace_period;
/**
* @var PaymentSchedule[] Array of payment schedules available for a plan
*/
private $payment_schedules;
/**
* @var callable Plan activation hook, called when plan is activated for account
*/
private $account_activate_hook;
/**
* @var callable Plan deactivation hook, called when plan is deactivated for account
*/
private $account_deactivate_hook;
/**
* @var Plan[] Array of currently registered plans in the system
*/
private static $plans = array();
/**
* Creates new plan
*
* @param string $slug Plan slug
* @param mixed[] $a Array of plan options
*
* @throws Exception
*/
public function __construct($slug, $settings) {
if (!$slug) {
throw new Exception("Plan slug is required");
}
if (!is_array($settings)) {
throw new Exception("Configuration array required");
}
if (!array_key_exists('name', $settings) && $settings['name']) {
throw new Exception("Mandatory parameter 'name' was not found in init array for plan $slug");
}
// mandatory parameters checked above
$this->slug = $slug;
$this->name = $settings['name'];
// these are initialized to non-null value if not set
$this->available = isset($settings['available']) ? $settings['available'] : TRUE;
$this->payment_schedules = isset($settings['payment_schedules']) ? $settings['payment_schedules'] : array();
$this->downgrade_to_slug = isset($settings['downgrade_to']) ? $settings['downgrade_to'] : UserConfig::$default_plan_slug;
// the rest are initialized to null if not set
$this->description = isset($settings['description']) ? $settings['description'] : NULL;
$this->base_price = isset($settings['base_price']) ? $settings['base_price'] : NULL;
$this->base_period = isset($settings['base_period']) ? $settings['base_period'] : NULL;
$this->details_url = isset($settings['details_url']) ? $settings['details_url'] : NULL;
$this->capabilities = isset($settings['capabilities']) ? $settings['capabilities'] : NULL;
$this->grace_period = isset($settings['grace_period']) ? $settings['grace_period'] : NULL;
$this->account_activate_hook = isset($settings['account_activate_hook']) ? $settings['account_activate_hook'] : NULL;
$this->account_deactivate_hook = isset($settings['account_deactivate_hook']) ? $settings['account_deactivate_hook'] : NULL;
// If downgrade_to has the same slug as we have, reset it to null
if ($this->slug == $this->downgrade_to_slug) {
$this->downgrade_to_slug = NULL;
}
// Instantiate PaymentSchedules, replacing stored parameters arrays with actual objects
if (is_array($this->payment_schedules)) {
$schedules = array();
foreach ($this->payment_schedules as $slug => $schedule_settings) {
$schedules[] = new PaymentSchedule($slug, $schedule_settings);
}
$this->payment_schedules = $schedules;
if (!$this->getDefaultPaymentSchedule() && count($this->payment_schedules)) {
$this->payment_schedules[0]->setAsDefault();
}
}
# Check user hooks
if (!is_null($this->account_activate_hook) && !is_callable($this->account_activate_hook)) {
throw new Exception("Activate hook defined, but is not callable");
}
if (!is_null($this->account_deactivate_hook) && !is_callable($this->account_deactivate_hook)) {
throw new Exception("Deactivate hook defined, but is not callable");
}
// register new plan globally
self::$plans[] = $this;
}
/**
* @return string Plan slug
*/
public function getSlug() {
return $this->slug;
}
/**
* @return string Plan name
*/
public function getName() {
return $this->name;
}
/**
* @return boolean True if plan is available and False if it's registered, but currently disabled
*/
public function isAvailable() {
return $this->available ? TRUE : FALSE;
}
/**
* @return PaymentSchedule[] Array of payment schedules for this plan
*/
public function getPaymentSchedules() {
return $this->payment_schedules;
}
/**
* @return Plan Plan to downgrade to
*/
public function getDowngradeToPlan() {
return self::getPlanBySlug($this->downgrade_to_slug);
}
/**
* @return string Plan descriptions
*/
public function getDescription() {
return $this->description;
}
/**
* @return int Price to be displayed in UI (actually charged price is defined in payment schedules)
*/
public function getBasePrice() {
return $this->base_price;
}
/**
* Returns charge period string (associated with base price) to be displayed in UI
* (actual periods used are defined in payment schedules)
*
* @return string Charge period to be displayed in UI
*/
public function getBasePeriod() {
return $this->base_period;
}
/**
* @return string URL of plan details page
*/
public function getDetailsURL() {
return $this->details_url;
}
/**
* @return mixed[] Array of capabilities enabled as part of this plan
*/
public function getCapabilities() {
return $this->capabilities;
}
/**
* @return int Amount of days to wait after due payment is not recieved before downgrading the account
*/
public function getGracePeriod() {
return $this->grace_period;
}
/**
* Returns and array of payment schedule slugs available for this plan
*
* @return string[]
*/
public function getPaymentScheduleSlugs() {
$slugs = array();
foreach ($this->payment_schedules as $schedule) {
$slugs[] = $schedule->getSlug();
}
return $slugs;
}
/**
* Compares two plans (by matching slugs)
*
* @param Plan $other_plan Plan to compare to
*
* @return boolean True if same plan
*/
public function isTheSameAs(Plan $other_plan) {
return $this->slug == $other_plan->getSlug();
}
/**
* Checks if plan has particular feature enabled
*
* @param Feature $feature Feature to check
*
* @return boolean Enabled / Disabled
*/
public function hasFeatureEnabled(Feature $feature) {
if (array_key_exists('enable_features', $this->capabilities) && is_array($this->capabilities['enable_features'])) {
return in_array($feature->getID(), $this->capabilities['enable_features']);
}
return false;
}
/**
* Returns schedule slugs
*
* @param string $slug Schedule slug
*
* @return PaymentSchedule|null|false Returns false if null slug is passed,
* null if there is no schedule with such slug and PaymentSchedule if found
*/
public function getPaymentScheduleBySlug($slug) {
if ($slug === NULL) {
return FALSE;
}
if (is_array($this->payment_schedules)) {
foreach ($this->payment_schedules as $x => $schedule) {
if ($schedule->getSlug() == $slug) {
return $schedule;
}
}
}
return NULL;
}
/**
* Returns default payment schedule
*
* @return PaymentSchedule Default payment schedule
*/
public function getDefaultPaymentSchedule() {
if (is_array($this->payment_schedules))
foreach ($this->payment_schedules as $x => $schedule) {
if ($schedule->isDefault()) {
return $schedule;
}
}
return NULL;
}
/**
* Calls account activation hooks registered for the plan
*
* @param int $account_id Account ID
* @param string $old_plan_slug Old plan slug
* @param string $old_schedule_slug Old payment schedule slug
* @param string $old_engine_slug Old payment engine slug
*/
public function activateHook($account_id, $old_plan_slug, $old_schedule_slug, $old_engine_slug) {
if (!is_callable($this->account_activate_hook)) {
return;
}
call_user_func_array($this->account_activate_hook, array(
$account_id,
$old_plan_slug,
$old_schedule_slug,
$old_engine_slug
));
}
/**
* Calls account activation hooks registered for the plan
*
* @param int $account_id Account ID
* @param string $new_plan_slug New plan slug
* @param string $new_schedule_slug New payment schedule slug
* @param string $new_engine_slug New payment engine slug
*/
public function deactivateHook($account_id, $new_plan_slug, $new_schedule_slug, $new_engine_slug) {
if (!is_callable($this->account_deactivate_hook)) {
return;
}
call_user_func_array($this->account_deactivate_hook, array(
$account_id,
$new_plan_slug,
$new_schedule_slug,
$new_engine_slug,
));
}
/**
* Initializes all plans based on parameters array
*
* @param mixed[] $plan_parameters Array of parameters for all plans
*
* @throws Exception
*/
public static function init($plan_parameters) {
// if (count(self::$Plans))
// throw new Exception("Already initialized");
self::$plans = array(); // Isn't it an init?
if (!is_array($plan_parameters)) {
throw new Exception("Plan parameters is not an array");
}
foreach ($plan_parameters as $slug => $param) {
new self($slug, $param);
}
}
/**
* Returns plan based on a slug string
*
* @param string $slug Plan slug
*
* @return Plan|false|null Returns false if null slug is passed,
* null if there is no such plan with a slug and Plan object if found
*/
public static function getPlanBySlug($slug) {
if ($slug === NULL || !count(self::$plans)) {
return FALSE;
}
foreach (self::$plans as $p) {
if ($p->slug == $slug) {
return $p;
}
}
return NULL;
}
/**
* Returns an array of slugs for all plans in the system
*
* @return string[]|FALSE Array of slug strings for plans in the system or FALSE if no plans are registered
*/
public static function getPlanSlugs() {
if (!count(self::$plans)) {
return FALSE;
}
$slugs = array();
foreach (self::$plans as $p) {
$slugs[] = $p->slug;
}
return $slugs;
}
/**
* Checks if user actually has plan assigned and if not,
* redirects user to a page where they can get one
*
* @param Plan $plan Plan object or null / false to indicate that there is no plan
*/
public static function enforcePlan($plan) {
if (!UserConfig::$IGNORE_CURRENT_ACCOUNT_PLAN_VERIFICATION && !$plan) {
header('Location: ' . UserConfig::$USERSROOTURL . '/plans.php');
exit;
}
}
}