class-wc-rest-payments-transactions-controller.php
6.66 KB
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
<?php
/**
* Class WC_REST_Payments_Transactions_Controller
*
* @package WooCommerce\Payments\Admin
*/
defined( 'ABSPATH' ) || exit;
/**
* REST controller for transactions.
*/
class WC_REST_Payments_Transactions_Controller extends WC_Payments_REST_Controller {
/**
* Endpoint path.
*
* @var string
*/
protected $rest_base = 'payments/transactions';
/**
* Configure REST API routes.
*/
public function register_routes() {
register_rest_route(
$this->namespace,
'/' . $this->rest_base,
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_transactions' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/download',
[
'methods' => WP_REST_Server::CREATABLE,
'callback' => [ $this, 'get_transactions_export' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/summary',
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_transactions_summary' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/search',
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_transactions_search_autocomplete' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
register_rest_route(
$this->namespace,
'/' . $this->rest_base . '/(?P<transaction_id>\w+)',
[
'methods' => WP_REST_Server::READABLE,
'callback' => [ $this, 'get_transaction' ],
'permission_callback' => [ $this, 'check_permission' ],
]
);
}
/**
* Retrieve transactions to respond with via API.
*
* @param WP_REST_Request $request Full data about the request.
*/
public function get_transactions( $request ) {
$page = (int) $request->get_param( 'page' );
$page_size = (int) $request->get_param( 'pagesize' );
$sort = $request->get_param( 'sort' );
$direction = $request->get_param( 'direction' );
$deposit_id = $request->get_param( 'deposit_id' );
$filters = $this->get_transactions_filters( $request );
return $this->forward_request( 'list_transactions', [ $page, $page_size, $sort, $direction, $filters, $deposit_id ] );
}
/**
* Initiate transactions export via API.
*
* @param WP_REST_Request $request Full data about the request.
*/
public function get_transactions_export( $request ) {
$user_email = $request->get_param( 'user_email' );
$deposit_id = $request->get_param( 'deposit_id' );
$filters = $this->get_transactions_filters( $request );
return $this->forward_request( 'get_transactions_export', [ $filters, $user_email, $deposit_id ] );
}
/**
* Retrieve transaction to respond with via API.
*
* @param WP_REST_Request $request Full data about the request.
*/
public function get_transaction( $request ) {
$transaction_id = $request->get_param( 'transaction_id' );
return $this->forward_request( 'get_transactions', [ 'transaction_id' ] );
}
/**
* Retrieve transactions summary to respond with via API.
*
* @param WP_REST_Request $request Full data about the request.
*/
public function get_transactions_summary( $request ) {
$deposit_id = $request->get_param( 'deposit_id' );
$filters = $this->get_transactions_filters( $request );
return $this->forward_request( 'get_transactions_summary', [ $filters, $deposit_id ] );
}
/**
* Retrieve transactions search options to respond with via API.
*
* @param WP_REST_Request $request Full data about the request.
*/
public function get_transactions_search_autocomplete( $request ) {
$search_term = $request->get_param( 'search_term' );
return $this->forward_request( 'get_transactions_search_autocomplete', [ $search_term ] );
}
/**
* Extract transactions filters from request
*
* @param WP_REST_Request $request Full data about the request.
*/
private function get_transactions_filters( $request ) {
$date_between_filter = $request->get_param( 'date_between' );
$user_timezone = $request->get_param( 'user_timezone' );
if ( ! is_null( $date_between_filter ) ) {
$date_between_filter = array_map(
function ( $transaction_date ) use ( $user_timezone ) {
return $this->format_transaction_date_with_timestamp( $transaction_date, $user_timezone );
},
$date_between_filter
);
}
return array_filter(
[
'match' => $request->get_param( 'match' ),
'date_before' => $this->format_transaction_date_with_timestamp( $request->get_param( 'date_before' ), $user_timezone ),
'date_after' => $this->format_transaction_date_with_timestamp( $request->get_param( 'date_after' ), $user_timezone ),
'date_between' => $date_between_filter,
'type_is' => $request->get_param( 'type_is' ),
'type_is_not' => $request->get_param( 'type_is_not' ),
'store_currency_is' => $request->get_param( 'store_currency_is' ),
'customer_currency_is' => $request->get_param( 'customer_currency_is' ),
'customer_currency_is_not' => $request->get_param( 'customer_currency_is_not' ),
'loan_id_is' => $request->get_param( 'loan_id_is' ),
'search' => $request->get_param( 'search' ),
],
static function ( $filter ) {
return null !== $filter;
}
);
}
/**
* Formats the incoming transaction date as per the blog's timezone.
*
* @param string|null $transaction_date Transaction date to format.
* @param string|null $user_timezone User's timezone passed from client.
*
* @return string|null The formatted transaction date as per timezone.
*/
private function format_transaction_date_with_timestamp( $transaction_date, $user_timezone ) {
if ( is_null( $transaction_date ) || is_null( $user_timezone ) ) {
return $transaction_date;
}
// Get blog timezone.
$blog_time = new DateTime( $transaction_date );
$blog_time->setTimezone( new DateTimeZone( wp_timezone_string() ) );
// Get local timezone.
$local_time = new DateTime( $transaction_date );
$local_time->setTimezone( new DateTimeZone( $user_timezone ) );
// Compute time difference in minutes.
$time_difference = ( strtotime( $local_time->format( 'Y-m-d H:i:s' ) ) - strtotime( $blog_time->format( 'Y-m-d H:i:s' ) ) ) / 60;
// Shift date by time difference.
$formatted_date = new DateTime( $transaction_date );
date_modify( $formatted_date, $time_difference . 'minutes' );
return $formatted_date->format( 'Y-m-d H:i:s' );
}
}