Response.php — WooCommerce Square 3.8.1

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

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

Requests 3 years ago Responses 3 years ago Response.php 3 years ago Response_Message_Helper.php 3 years ago

Response.php

164 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	/**
35	* Determines if the transaction was approved.
36	*
37	* @since 2.0.0
38	*
39	* @return bool
40	*/
41	public function transaction_approved() {
42
43	return ! $this->has_errors();
44	}
45
46
47	/**
48	* Determines if the transaction was held.
49	*
50	* @since 2.0.0
51	*
52	* @return bool
53	*/
54	public function transaction_held() {
55
56	return false; // TODO: make sure there are no held responses
57	}
58
59
60	/ Getter methods **********************************************************************************************/
61
62
63	/**
64	* Gets the transaction ID.
65	*
66	* @since 2.0.0
67	*
68	* @return string
69	*/
70	public function get_transaction_id() {
71
72	return '';
73	}
74
75
76	/**
77	* Gets the response status message.
78	*
79	* @since 2.0.0
80	*
81	* @return string
82	*/
83	public function get_status_message() {
84
85	$message = '';
86
87	foreach ( $this->get_errors() as $error ) {
88
89	$message = $error->getDetail();
90	break;
91	}
92
93	return $message;
94	}
95
96
97	/**
98	* Gets the response status code.
99	*
100	* @since 2.0.0
101	*
102	* @return string
103	*/
104	public function get_status_code() {
105
106	$code = '';
107
108	foreach ( $this->get_errors() as $error ) {
109
110	$code = $error->getCode();
111	break;
112	}
113
114	return $code;
115	}
116
117	/**
118	* Gets array of response status codes.
119	*
120	* @since 3.5.0
121	*
122	* @return array
123	*/
124	public function get_status_codes() {
125
126	$codes = array();
127
128	foreach ( $this->get_errors() as $error ) {
129
130	$codes[] = $error->getCode();
131	}
132
133	return $codes;
134	}
135
136
137	/**
138	* Gets the message to display to the user.
139	*
140	* @since 2.0.0
141	*
142	* @return string
143	*/
144	public function get_user_message() {
145
146	return '';
147	}
148
149
150	/**
151	* Gets the payment type.
152	*
153	* @since 2.0.0
154	*
155	* @return string
156	*/
157	public function get_payment_type() {
158
159	return Gateway::PAYMENT_TYPE_CREDIT_CARD;
160	}
161
162
163	}
164