-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathStripeComponent.php
2722 lines (2166 loc) · 60.7 KB
/
StripeComponent.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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
spl_autoload_register(function ($class) {
foreach (App::path('Vendor') as $base) {
$path = $base . 'lib' . str_replace('Stripe\\', DS, $class) . '.php';
// for nested classes
$path = str_replace('\\', DS, $path);
if (file_exists($path)) {
include $path;
return;
}
}
});
/**
* Stripe Component
*
* PHP 5
*
* Licensed under The MIT License
*
* @version 2.0
* @author http://hashmode.com
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
* @link https://github.com/hashmode/CakePHP-Stripe-Component-Full
*
* Compatible with Stripe API version 3.4.0
*
* ***** IMPORTANT ******
* Stripe PHP library is not included, it should be downloaded from Stripe's website
* @link https://stripe.com/docs/libraries
*
* Stripe php documentation
* @link https://stripe.com/docs/api/php
*/
App::uses('Component', 'Controller');
/**
* Stripe Components allows to use Stripe Payments
*
*/
class StripeComponent extends Component {
/**
* Stripe mode, can be 'Live' or 'Test'
*
* @var string
*/
public $mode = 'Test';
/**
* Stripe API Secret key
*
* @var string
*/
public $key = null;
/**
* Stripe currency, default is 'usd'
*
* @var string
*/
public $currency = 'usd';
/**
*
* If provided, statuses will be saved in that file, default is false
* if enabled, log should be added in bootstrap, e.g. if log file should be in tmp/logs/stripe.log
*
CakeLog::config('stripe', array(
'engine' => 'FileLog',
'file' => 'stripe',
));
*
* @var string
*/
public $logFile = false;
/**
* Can be 'both', 'success' or 'error', to what results to save, default is 'error'
*
* @var string
*/
public $logType = 'error';
/**
* For saving the reflection class, to use in the loop
*
* @protected array
*/
protected $reflectionClass = array();
/**
* Initialize component
*
* @param Controller $controller Instantiating controller
* @return void
*/
public function initialize(Controller $controller) {
$this->Controller = $controller;
if (!class_exists('Stripe\Stripe')) {
throw new CakeException('Stripe PHP Library not found. Be sure it is unpacked in app/Vendor/stripe directory.
It can be downloaded from https://stripe.com/docs/libraries');
}
// if mode is not set in bootstrap, defaults to 'Test'
$mode = Configure::read('Stripe.mode');
if ($mode) {
$this->mode = $mode;
}
// set the Stripe API key
$this->key = Configure::read('Stripe.' . $this->mode . 'Secret');
if (!$this->key) {
throw new CakeException('Stripe API Secret key is not set');
}
// if currency is not set, defaults to 'usd'
$currency = Configure::read('Stripe.currency');
if ($currency) {
$this->currency = strtolower($currency);
}
// set logging
if (isset($this->settings['logFile'])) {
$this->logFile = $this->settings['logFile'];
// validate logFile
$logFiles = CakeLog::configured();
if (array_search($this->logFile, $logFiles) === false) {
throw new CakeException(__('Logging file is not added. Add this in your bootstrap').': '
.'CakeLog::config("'.$this->logFile.'", array("engine" => "FileLog", "file" => "'.$this->logFile.'" ));' );
}
if (isset($this->settings['logType'])) {
$this->logType = $this->settings['logType'];
// validate logType
if (!in_array($this->logType, array('both', 'success', 'error'))) {
throw new CakeException(__('Log Type can be only set as "success", "error" or "both" '));
}
}
}
}
public function getCents($price) {
return $price*100;
}
public function getUsd($price, $currency = false) {
return number_format($price/100, 2).($currency ? ' '.strtoupper($this->currency) : '');
}
public function setApiKey() {
Stripe\Stripe::setApiKey($this->key);
}
/**
* charge method
* Charges the given credit card(card id, array or token) or customer
*
* @param array $data
* @param string $customerId[optional]
* @return array
*
* @link https://stripe.com/docs/api#create_charge
*/
public function charge($data = null, $customerId = null) {
if (!$customerId && empty($data['card']) && empty($data['source'])) {
throw new CakeException(__('Customer Id or Card is required'));
}
if ($customerId) {
$data['customer'] = $customerId;
}
// set default currency
if (!isset($data['currency'])) {
$data['currency'] = $this->currency;
}
return $this->request(__FUNCTION__, $data);
}
/**
* retrieveCharge method
* Retrieves the details of a charge that has previously been created
*
* @param string $chargeId
* @return array
*
* @link https://stripe.com/docs/api#retrieve_charge
*/
public function retrieveCharge($chargeId = null) {
if (!$chargeId) {
throw new CakeException(__('Charge Id is required'));
}
$data = array(
'charge_id' => $chargeId
);
return $this->request(__FUNCTION__, $data);
}
/**
* updateCharge method
* Updates the specified charge
*
* @param string $chargeId
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api#update_charge
*/
public function updateCharge($chargeId = null, $data = array()) {
if (!$chargeId) {
throw new CakeException(__('Charge Id is not provided'));
}
if (empty($data)) {
throw new CakeException(__('No data is provided to updates the card'));
}
$data = array(
'charge_id' => $chargeId,
'fields' => $data,
);
return $this->request(__FUNCTION__, $data);
}
/**
* refundCharge method
* Refunds a charge that has previously been created but not yet refunded
*
* @param string $chargeId
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api#refund_charge
*/
public function refundCharge($chargeId = null, $data = array()) {
if (!$chargeId) {
throw new CakeException(__('Charge Id is not provided'));
}
$data['charge_id'] = $chargeId;
return $this->request(__FUNCTION__, $data);
}
/**
* captureCharge method
* Capture the payment of an existing, uncaptured, charge.
*
* @param string $chargeId
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api#charge_capture
*/
public function captureCharge($chargeId = null, $data = array()) {
if (!$chargeId) {
throw new CakeException(__('Charge Id is not provided'));
}
$data['charge_id'] = $chargeId;
return $this->request(__FUNCTION__, $data);
}
/**
* listCharges method
* Returns a list of charges you've previously created
*
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api#list_charges
*/
public function listCharges($data = array()) {
$data = array(
'options' => $data
);
return $this->request(__FUNCTION__, $data);
}
/**
* createCustomer method
* Creates a new customer
*
* @param array $data - according to customer object
* @return array
*
* @link https://stripe.com/docs/api/php#create_customers
*/
public function createCustomer($data) {
if (empty($data) || !is_array($data)) {
throw new CakeException(__('Data is empty or is not an array'));
}
return $this->request(__FUNCTION__, $data);
}
/**
* retrieveCustomer method
* Retrives the customer information
*
* @param string $customerId
* @return array
*
* @link https://stripe.com/docs/api/php#retrieve_customer
*/
public function retrieveCustomer($customerId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
$data = array(
'customer_id' => $customerId
);
return $this->request(__FUNCTION__, $data);
}
/**
* updateCustomer method
* Updates the customer info
*
* @param string $customerId
* @param array $fields - fields to be updated
* @return array
*
* @link https://stripe.com/docs/api/php#update_customer
*/
public function updateCustomer($customerId = null, $fields = array()) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (empty($fields)) {
throw new CakeException(__('Update fields are empty'));
}
$data = array(
'customer_id' => $customerId,
'fields' => $fields
);
return $this->request(__FUNCTION__, $data);
}
/**
* deleteCustomer method
* Deletes the customer
*
* @param string $customerId
* @return array
*
* @link https://stripe.com/docs/api/php#delete_customer
*/
public function deleteCustomer($customerId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
$data = array(
'customer_id' => $customerId
);
return $this->request(__FUNCTION__, $data);
}
/**
* listCustomers method
* Returns array with customers
*
* As this is an expensive call(Reflection class is used to convert objects to arrays) use limit wisely
*
* @param array $data
* @param array $cards - default is false, if true each customers cards will be returned as array
* @param array $subscriptions - default is false, if true each customers subscriptions will be returned as array
* @return array
*
* @link https://stripe.com/docs/api/php#list_customers
*/
public function listCustomers($data = array()) {
$data = array(
'options' => $data
);
return $this->request(__FUNCTION__, $data);
}
/**
* createCard method
* Creates a new card for the given customer
*
* @param string $customerId
* @param mixed $data - card data, token or array
* @return array
*
* @link https://stripe.com/docs/api/php#create_card
*/
public function createCard($customerId = null, $card = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$card) {
throw new CakeException(__('Card data is not provided'));
}
$metadata = array();
if (!empty($card['metadata'])) {
$metadata = $card['metadata'];
unset($card['metadata']);
}
$card['object'] = 'card';
$data = array(
'customer_id' => $customerId,
'source' => $card
);
if (!empty($metadata)) {
$data['metadata'] = $metadata;
}
return $this->request(__FUNCTION__, $data);
}
/**
* retrieveCard method
* Retrives an existing card for the given customer
*
* @param string $customerId
* @param string $cardId
* @return array
*
* @link https://stripe.com/docs/api/php#retrieve_card
*/
public function retrieveCard($customerId = null, $cardId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$cardId) {
throw new CakeException(__('Card Id is not provided'));
}
$data = array(
'customer_id' => $customerId,
'card_id' => $cardId
);
return $this->request(__FUNCTION__, $data);
}
/**
* updateCard method
* Updates an existing card for the given customer
*
* @param string $customerId
* @param string $cardId
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api/php#update_card
*/
public function updateCard($customerId = null, $cardId = null, $data = array()) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$cardId) {
throw new CakeException(__('Card Id is not provided'));
}
if (empty($data)) {
throw new CakeException(__('No data is provided to updates the card'));
}
$data = array(
'customer_id' => $customerId,
'card_id' => $cardId,
'fields' => $data,
);
return $this->request(__FUNCTION__, $data);
}
/**
* deleteCard method
* Deletes an existing card for the given customer
*
* @param string $customerId
* @param string $cardId
* @return array
*
* @link https://stripe.com/docs/api/php#delete_card
*/
public function deleteCard($customerId = null, $cardId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$cardId) {
throw new CakeException(__('Card Id is not provided'));
}
$data = array(
'customer_id' => $customerId,
'card_id' => $cardId
);
return $this->request(__FUNCTION__, $data);
}
/**
* listCards method
* Returs cards for the given customer
*
* @param string $customerId
* @param string $cardId
* @return array
*
* @link https://stripe.com/docs/api/php#list_cards
*/
public function listCards($customerId = null, $data = array()) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
$data = array(
'customer_id' => $customerId,
'options' => $data
);
return $this->request(__FUNCTION__, $data);
}
/**
* createSubscription method
* Creates a new subscription for the given customer
*
* @param int $customerId
* @param array $data - subscription data, token or array
* @return array
*
* @link https://stripe.com/docs/api/php#create_subscription
*/
public function createSubscription($customerId = null, $subscription = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$subscription) {
throw new CakeException(__('Subscription data is not provided'));
}
$data = array(
'customer_id' => $customerId,
'subscription' => $subscription
);
return $this->request(__FUNCTION__, $data);
}
/**
* retrieveSubscription method
* Retrives an existing subscription for the given customer
*
* @param string $customerId
* @param string $subscriptionId
* @return array
*
* @link https://stripe.com/docs/api/php#retrieve_subscription
*/
public function retrieveSubscription($customerId = null, $subscriptionId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$subscriptionId) {
throw new CakeException(__('Subscription Id is not provided'));
}
$data = array(
'customer_id' => $customerId,
'subscription_id' => $subscriptionId
);
return $this->request(__FUNCTION__, $data);
}
/**
* updateSubscription method
* Updates an existing subscription for the given customer
*
* @param string $customerId
* @param string $subscriptionId
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api/php#update_subscription
*/
public function updateSubscription($customerId = null, $subscriptionId = null, $data = array()) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$subscriptionId) {
throw new CakeException(__('Subscription Id is not provided'));
}
if (empty($data)) {
throw new CakeException(__('No data is provided to update the subscription'));
}
$data = array(
'customer_id' => $customerId,
'subscription_id' => $subscriptionId,
'fields' => $data,
);
return $this->request(__FUNCTION__, $data);
}
/**
* cancelSubscription method
* Cancels an existing subscription for the given customer
*
* @param string $customerId
* @param string $subscriptionId
* @return array
*
* @link https://stripe.com/docs/api/php#cancel_subscription
*/
public function cancelSubscription($customerId = null, $subscriptionId = null, $atPeriodEnd = false) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$subscriptionId) {
throw new CakeException(__('Subscription Id is not provided'));
}
$data = array(
'at_period_end' => $atPeriodEnd,
'customer_id' => $customerId,
'subscription_id' => $subscriptionId
);
return $this->request(__FUNCTION__, $data);
}
/**
* listSubscriptions method
* Returs subscriptions for the given customer
*
* @param string $customerId
* @param string $subscriptionId
* @return array
*
* @link https://stripe.com/docs/api/php#list_subscriptions
*/
public function listSubscriptions($customerId = null, $data = array()) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
$data = array(
'customer_id' => $customerId,
'options' => $data
);
return $this->request(__FUNCTION__, $data);
}
/**
* createPlan method
* Creates a new subscription plan
*
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api/php#create_plan
*/
public function createPlan($data = array()) {
if (empty($data) || !is_array($data)) {
throw new CakeException(__('Data is empty or is not an array'));
}
// set default currency
if (!isset($data['currency'])) {
$data['currency'] = $this->currency;
}
return $this->request(__FUNCTION__, $data);
}
/**
* retrievePlan method
* Retrieves the existing subscription plan
*
* @param string $planId
* @return array
*
* @link https://stripe.com/docs/api/php#retrieve_plan
*/
public function retrievePlan($planId = null) {
if (!$planId) {
throw new CakeException(__('Plan Id is required'));
}
$data = array(
'plan_id' => $planId
);
return $this->request(__FUNCTION__, $data);
}
/**
* updatePlan method
* Updates the existing subscription plan
*
* @param string $planId
* @return array
*
* @link https://stripe.com/docs/api/php#update_plan
*/
public function updatePlan($planId = null, $data = array()) {
if (!$planId) {
throw new CakeException(__('Plan Id is required'));
}
if (empty($data)) {
throw new CakeException(__('No data is provided to updates the plan'));
}
$data = array(
'plan_id' => $planId,
'fields' => $data
);
return $this->request(__FUNCTION__, $data);
}
/**
* deletePlan method
* Deletes the existing subscription plan
*
* @param string $planId
* @return array
*
* @link https://stripe.com/docs/api/php#delete_plan
*/
public function deletePlan($planId = null) {
if (!$planId) {
throw new CakeException(__('Plan Id is required'));
}
$data = array(
'plan_id' => $planId,
);
return $this->request(__FUNCTION__, $data);
}
/**
* listPlans method
* Returns all the plans
*
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api/php#list_plans
*/
public function listPlans($data = array()) {
$data = array(
'options' => $data,
);
return $this->request(__FUNCTION__, $data);
}
/**
* createCoupon method
* Creates a new coupon
*
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api/php#create_coupon
*/
public function createCoupon($data = array()) {
if (empty($data) || !is_array($data)) {
throw new CakeException(__('Data is empty or is not an array'));
}
// set default currency
if (!isset($data['currency'])) {
$data['currency'] = $this->currency;
}
return $this->request(__FUNCTION__, $data);
}
/**
* retrieveCoupon method
* Retrieves the existing coupon
*
* @param string $couponId
* @return array
*
* @link https://stripe.com/docs/api/php#retrieve_coupon
*/
public function retrieveCoupon($couponId = null) {
if (!$couponId) {
throw new CakeException(__('Coupon Id is required'));
}
$data = array(
'coupon_id' => $couponId
);
return $this->request(__FUNCTION__, $data);
}
/**
* deleteCoupon method
* Deletes the existing coupon
*
* @param string $couponId
* @return array
*
* @link https://stripe.com/docs/api/php#delete_coupon
*/
public function deleteCoupon($couponId = null) {
if (!$couponId) {
throw new CakeException(__('Coupon Id is required'));
}
$data = array(
'coupon_id' => $couponId,
);
return $this->request(__FUNCTION__, $data);
}
/**
* listCoupons method
* Returns all the plans
*
* @param array $data
* @return array
*
* @link https://stripe.com/docs/api/php#list_coupons
*/
public function listCoupons($data = array()) {
$data = array(
'options' => $data,
);
return $this->request(__FUNCTION__, $data);
}
/**
* deleteCustomerDiscount method
* Removes the currently applied discount on a customer
*
* @param string $customerId
* @return array
*
* @link https://stripe.com/docs/api/php#delete_discount
*/
public function deleteCustomerDiscount($customerId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
$data = array(
'customer_id' => $customerId
);
return $this->request(__FUNCTION__, $data);
}
/**
* deleteSubscriptionDiscount method
* Removes the currently applied discount on a subscription.
*
* @param string $customerId
* @param string $subscriptionId
* @return array
*
* @link https://stripe.com/docs/api#delete_subscription_discount
*/
public function deleteSubscriptionDiscount($customerId = null, $subscriptionId = null) {
if (!$customerId) {
throw new CakeException(__('Customer Id is not provided'));
}
if (!$subscriptionId) {
throw new CakeException(__('Subscription Id is not provided'));
}
$data = array(
'customer_id' => $customerId,
'subscription_id' => $subscriptionId
);
return $this->request(__FUNCTION__, $data);
}
/**
* retrieveInvoice method
* Retrives an existing invoice