Response.php — WooCommerce Square 5.4.2

woocommerce-square / includes / Gateway / API / Response.php

woocommerce-square / includes / Gateway / API Last commit date

Requests 4 months ago Responses 10 months ago Response.php 2 years ago Response_Message_Helper.php 2 years ago

Response.php

178 lines

1	<?php
2	/**
3	* WooCommerce Square
4	*
5	* This source file is subject to the GNU General Public License v3.0
6	* that is bundled with this package in the file license.txt.
7	* It is also available through the world-wide-web at this URL:
8	* http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later
9	* If you did not receive a copy of the license and are unable to
10	* obtain it through the world-wide-web, please send an email
11	* to license@woocommerce.com so we can send you a copy immediately.
12	*
13	* DISCLAIMER
14	*
15	* Do not edit or add to this file if you wish to upgrade WooCommerce Square to newer
16	* versions in the future. If you wish to customize WooCommerce Square for your
17	* needs please refer to https://docs.woocommerce.com/document/woocommerce-square/
18	*
19	* @author WooCommerce
20	* @copyright Copyright: (c) 2019, Automattic, Inc.
21	* @license http://www.gnu.org/licenses/gpl-3.0.html GNU General Public License v3.0 or later
22	*/
23
24	namespace WooCommerce\Square\Gateway\API;
25
26	defined( 'ABSPATH' ) \|\| exit;
27
28	use WooCommerce\Square\Framework\PaymentGateway\Api\Payment_Gateway_API_Response;
29	use WooCommerce\Square\Gateway;
30
31	class Response extends \WooCommerce\Square\API\Response implements Payment_Gateway_API_Response {
32
33	/**
34	* The transaction has been approved.
35	*/
36	const STATUS_COMPLETED = 'COMPLETED';
37
38	/**
39	* The transaction has been approved.
40	*/
41	const STATUS_APPROVED = 'APPROVED';
42
43	/**
44	* The transaction has been authorized but not yet captured.
45	*/
46	const STATUS_AUTHORIZED = 'AUTHORIZED';
47
48	/**
49	* Determines if the transaction was approved.
50	*
51	* @since 2.0.0
52	*
53	* @return bool
54	*/
55	public function transaction_approved() {
56
57	return ! $this->has_errors();
58	}
59
60
61	/**
62	* Determines if the transaction was held.
63	*
64	* @since 2.0.0
65	*
66	* @return bool
67	*/
68	public function transaction_held() {
69
70	return false; // TODO: make sure there are no held responses
71	}
72
73
74	/ Getter methods **********************************************************************************************/
75
76
77	/**
78	* Gets the transaction ID.
79	*
80	* @since 2.0.0
81	*
82	* @return string
83	*/
84	public function get_transaction_id() {
85
86	return '';
87	}
88
89
90	/**
91	* Gets the response status message.
92	*
93	* @since 2.0.0
94	*
95	* @return string
96	*/
97	public function get_status_message() {
98
99	$message = '';
100
101	foreach ( $this->get_errors() as $error ) {
102
103	$message = $error->getDetail();
104	break;
105	}
106
107	return $message;
108	}
109
110
111	/**
112	* Gets the response status code.
113	*
114	* @since 2.0.0
115	*
116	* @return string
117	*/
118	public function get_status_code() {
119
120	$code = '';
121
122	foreach ( $this->get_errors() as $error ) {
123
124	$code = $error->getCode();
125	break;
126	}
127
128	return $code;
129	}
130
131	/**
132	* Gets array of response status codes.
133	*
134	* @since 3.5.0
135	*
136	* @return array
137	*/
138	public function get_status_codes() {
139
140	$codes = array();
141
142	foreach ( $this->get_errors() as $error ) {
143
144	$codes[] = $error->getCode();
145	}
146
147	return $codes;
148	}
149
150
151	/**
152	* Gets the message to display to the user.
153	*
154	* @since 2.0.0
155	*
156	* @return string
157	*/
158	public function get_user_message() {
159
160	return '';
161	}
162
163
164	/**
165	* Gets the payment type.
166	*
167	* @since 2.0.0
168	*
169	* @return string
170	*/
171	public function get_payment_type() {
172
173	return Gateway::PAYMENT_TYPE_CREDIT_CARD;
174	}
175
176
177	}
178