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
|
<?php
/**
* Provides the payment class, an interface to the payment table in the database
*
* @author Camil Staps
*
* BusinessAdmin: administrative software for small companies
* Copyright (C) 2015 Camil Staps (ViviSoft)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* An interface to the payment table in the database
*/
class Payment extends Model {
/** {@inheritDoc} */
public static
$table = 'payment',
$fillable_columns = ['offerId', 'date', 'braintree_id', 'braintree_status'],
$timestamps = ['date'];
/**
* Get the offer that this payment is linked to
*
* @return offer The offer
*/
public function getOffer() {
return new Offer($this->pdo, $this->offerId);
}
/**
* Make a mailer to send about this payment
*
* @return Mailer The mailer
*/
public function mailer() {
$mailer = new Mailer($this->pdo);
$mailer->setOffer($this->getOffer());
$lang = $this->getOffer()->getContact()->language;
$mailer->Subject = Correspondence::__('mail-offer-paid-subject', $lang);
$mailer->Body = Correspondence::__r('mail-offer-paid', $lang, $this);
return $mailer;
}
/**
* Send the payment notification to the offer's contact
*
* @return bool The result of Mailer::send
*/
public function send() {
return $this->mailer()->send();
}
/**
* Refresh the Braintree status
*
* @return string|null The new status, or null if this Payment does not have a Braintree id
*/
public function refreshBraintreeStatus() {
if (is_null($this->braintree_id)) {
return null;
}
$trans = Braintree_Transaction::find($this->braintree_id);
$this->braintree_status = $trans->status;
return $this->braintree_status;
}
/**
* Get Braintree status history
*/
public function getBraintreeStatusHistory() {
if (is_null($this->braintree_id)) {
return [];
}
$trans = Braintree_Transaction::find($this->braintree_id);
return $trans->statusHistory;
}
/**
* Is the Braintree transaction finished?
*
* @return bool|null True iff the Braintree transaction is finished, or null if this Payment does not have a Braintree id
*/
public function isBraintreeFinished() {
if (is_null($this->braintree_id)) {
return null;
}
return in_array($this->braintree_status, [
Braintree_Transaction::AUTHORIZATION_EXPIRED,
Braintree_Transaction::GATEWAY_REJECTED,
Braintree_Transaction::FAILED,
Braintree_Transaction::PROCESSOR_DECLINED,
Braintree_Transaction::SETTLED,
Braintree_Transaction::VOIDED,
Braintree_Transaction::SETTLEMENT_DECLINED,
]);
}
/**
* Is the Braintree transaction successful?
*
* A transaction can be successful if it is not yet finished.
*
* @return bool|null True iff the Braintree transaction is successful, or null if this Payment does not have a Braintree id
*/
public function isBraintreeSuccessful() {
if (is_null($this->braintree_id)) {
return null;
}
return in_array($this->braintree_status, [
Braintree_Transaction::AUTHORIZING,
Braintree_Transaction::AUTHORIZED,
Braintree_Transaction::SETTLED,
Braintree_Transaction::SETTLING,
Braintree_Transaction::SUBMITTED_FOR_SETTLEMENT,
Braintree_Transaction::SETTLEMENT_PENDING,
Braintree_Transaction::SETTLEMENT_CONFIRMED,
]);
}
}
|
