invoice_model.php — LatePoint – Calendar Booking Plugin for Appointments and Events 5.6.3

latepoint / lib / models / invoice_model.php

latepoint / lib / models Last commit date

invoice_model.php

249 lines

1	<?php
2
3	class OsInvoiceModel extends OsModel {
4	public $id,
5	$order_id,
6	$invoice_number,
7	$data,
8	$charge_amount,
9	$payment_portion,
10	$status,
11	$access_key,
12	$due_at,
13	$updated_at,
14	$created_at;
15
16	function __construct( $id = false ) {
17	parent::__construct();
18	$this->table_name = LATEPOINT_TABLE_ORDER_INVOICES;
19
20	if ( $id ) {
21	$this->load_by_id( $id );
22	}
23	}
24
25	public function get_receipt_url(): string {
26	$transaction = new OsTransactionModel();
27	$transaction = $transaction->where(
28	[
29	'invoice_id' => $this->id,
30	'status' => LATEPOINT_TRANSACTION_STATUS_SUCCEEDED,
31	]
32	)->set_limit( 1 )->get_results_as_models();
33	if ( $transaction && ! $transaction->is_new_record() ) {
34	return $transaction->get_receipt_url();
35	} else {
36	return $this->get_access_url();
37	}
38	}
39
40	public function properties_to_query(): array {
41	return [
42	'status' => __( 'Status', 'latepoint' ),
43	'payment_portion' => __( 'Payment Portion', 'latepoint' ),
44	];
45	}
46
47	public function get_customer(): OsCustomerModel {
48	return $this->get_order()->get_customer();
49	}
50
51
52	public function generate_data_vars(): array {
53
54	$vars['id'] = $this->id;
55	$vars['order_id'] = $this->order_id;
56	$vars['invoice_number'] = $this->get_invoice_number();
57	$vars['payment_portion'] = $this->payment_portion;
58	$vars['status'] = $this->status;
59	$vars['data'] = $this->data;
60	$vars['charge_amount'] = $this->charge_amount;
61	$vars['access_key'] = $this->access_key;
62	$vars['due_at'] = $this->due_at;
63
64	$vars['customer'] = $this->get_customer()->get_data_vars();
65	$vars['order'] = $this->get_order()->get_first_level_data_vars();
66	$vars['transactions'] = [];
67
68	$transactions = $this->get_successful_payments();
69	if ( $transactions ) {
70	foreach ( $transactions as $transaction ) {
71	$vars['transactions'][] = $transaction->get_data_vars();
72	}
73	}
74
75	return $vars;
76	}
77
78	public function get_order(): OsOrderModel {
79	if ( $this->order_id ) {
80	if ( ! isset( $this->order ) \|\| ( isset( $this->order ) && ( $this->order->id != $this->order_id ) ) ) {
81	$this->order = new OsOrderModel( $this->order_id );
82	}
83	} else {
84	$this->order = new OsOrderModel();
85	}
86
87	return $this->order;
88	}
89
90	public function get_successful_payments(): array {
91	$transactions = new OsTransactionModel();
92	$transactions = $transactions->where(
93	[
94	'status' => LATEPOINT_TRANSACTION_STATUS_SUCCEEDED,
95	'invoice_id' => $this->id,
96	]
97	)->get_results_as_models();
98
99	return $transactions;
100	}
101
102	public function get_amount_paid(): float {
103	$total = 0;
104	foreach ( $this->get_successful_payments() as $transaction ) {
105	$total += (float) $transaction->amount;
106	}
107
108	return $total;
109	}
110
111	public function get_amount_due(): float {
112	return (float) $this->charge_amount - $this->get_amount_paid();
113	}
114
115
116	protected function params_to_sanitize() {
117	return [
118	'charge_amount' => 'money',
119	];
120	}
121
122	/**
123	* @param string $new_status
124	*
125	* @return bool
126	*/
127	public function change_status( string $new_status ): bool {
128	$old_status = $this->status;
129	$old_invoice = clone $this;
130	if ( $old_status == $new_status ) {
131	return true;
132	}
133	if ( $this->update_attributes( [ 'status' => $new_status ] ) ) {
134	/**
135	* Invoice status has been changed
136	*
137	* @param {OsInvoiceModel} $invoice invoice model
138	* @param {string} $old_status previous status of the invoice
139	* @param {string} $new_status new status of the invoice
140	*
141	* @since 5.1.0
142	* @hook latepoint_invoice_status_changed
143	*
144	*/
145	do_action( 'latepoint_invoice_status_changed', $this, $old_status, $new_status );
146	/**
147	* Invoice was updated
148	*
149	* @param {OsInvoiceModel} $invoice instance of invoice model after it was updated
150	* @param {OsInvoiceModel} $old_invoice instance of invoice model before it was updated
151	*
152	* @since 5.1.0
153	* @hook latepoint_invoice_updated
154	*
155	*/
156	do_action( 'latepoint_invoice_updated', $this, $old_invoice );
157
158	return true;
159	} else {
160	return false;
161	}
162	}
163
164	public function get_invoice_number(): string {
165	if ( ! empty( $this->invoice_number ) ) {
166	return $this->invoice_number;
167	}
168	if ( empty( $this->id ) ) {
169	return '';
170	}
171	$this->invoice_number = OsSettingsHelper::get_settings_value( 'invoices_number_prefix', 'INV-' ) . sprintf( '1%06d', $this->id );
172	$this->update_attributes( [ 'invoice_number' => $this->invoice_number ] );
173	return $this->invoice_number;
174	}
175
176
177	protected function before_save() {
178	if ( empty( $this->status ) ) {
179	$this->status = LATEPOINT_INVOICE_STATUS_OPEN;
180	}
181	if ( empty( $this->due_at ) ) {
182	$this->due_at = OsTimeHelper::now_datetime_in_format( LATEPOINT_DATETIME_DB_FORMAT );
183	}
184	if ( empty( $this->access_key ) ) {
185	$this->access_key = OsUtilHelper::generate_uuid();
186	}
187	}
188
189	public function get_readable_due_at(): string {
190	try {
191	return OsTimeHelper::get_readable_date( new OsWpDateTime( $this->due_at, new DateTimeZone( 'UTC' ) ) );
192	} catch ( Exception $e ) {
193	return 'n/a';
194	}
195	}
196
197	public function get_access_url(): string {
198	return OsRouterHelper::build_admin_post_link( [ 'invoices', 'view_by_key' ], [ 'key' => $this->access_key ] );
199	}
200
201	public function get_pay_url(): string {
202	return OsRouterHelper::build_admin_post_link( [ 'invoices', 'summary_before_payment' ], [ 'key' => $this->access_key ] );
203	}
204
205
206	protected function params_to_save( $role = 'admin' ): array {
207	$params_to_save = [
208	'id',
209	'order_id',
210	'invoice_number',
211	'payment_portion',
212	'status',
213	'data',
214	'charge_amount',
215	'access_key',
216	'due_at',
217	];
218
219	return $params_to_save;
220	}
221
222
223	protected function allowed_params( $role = 'admin' ): array {
224	$allowed_params = [
225	'id',
226	'order_id',
227	'invoice_number',
228	'payment_portion',
229	'status',
230	'data',
231	'charge_amount',
232	'access_key',
233	'due_at',
234	];
235
236	return $allowed_params;
237	}
238
239
240	protected function properties_to_validate(): array {
241	$validations = [
242	'order_id' => [ 'presence' ],
243	'status' => [ 'presence' ],
244	];
245
246	return $validations;
247	}
248	}
249