@@ -13,17 +13,17 @@ discard block |
||
13 | 13 | class GetPaid_Notification_Email_Sender { |
14 | 14 | |
15 | 15 | /** |
16 | - * Whether or not we should inline CSS into the email. |
|
17 | - */ |
|
18 | - public $inline_css = true; |
|
16 | + * Whether or not we should inline CSS into the email. |
|
17 | + */ |
|
18 | + public $inline_css = true; |
|
19 | 19 | |
20 | 20 | /** |
21 | - * The wp_mail() data. |
|
22 | - */ |
|
21 | + * The wp_mail() data. |
|
22 | + */ |
|
23 | 23 | public $wp_mail_data = null; |
24 | 24 | |
25 | 25 | /** |
26 | - * Sends a new email. |
|
26 | + * Sends a new email. |
|
27 | 27 | * |
28 | 28 | * @param string|array $to The recipients email or an array of recipient emails. |
29 | 29 | * @param string $subject The email's subject. |
@@ -31,49 +31,49 @@ discard block |
||
31 | 31 | * @param array $attachments The email attachments. |
32 | 32 | * |
33 | 33 | * @return bool |
34 | - */ |
|
35 | - public function send( $to, $subject, $email, $attachments = array() ) { |
|
34 | + */ |
|
35 | + public function send( $to, $subject, $email, $attachments = array() ) { |
|
36 | 36 | |
37 | - /* |
|
37 | + /* |
|
38 | 38 | * Allow to filter data on per-email basis. |
39 | 39 | */ |
40 | - $data = apply_filters( |
|
41 | - 'getpaid_email_data', |
|
42 | - array( |
|
43 | - 'to' => array_filter( array_unique( wpinv_parse_list( $to ) ) ), |
|
44 | - 'subject' => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ), |
|
45 | - 'email' => apply_filters( 'wpinv_mail_content', $email ), |
|
46 | - 'headers' => $this->get_headers(), |
|
47 | - 'attachments' => $attachments, |
|
48 | - ), |
|
49 | - $this |
|
50 | - ); |
|
40 | + $data = apply_filters( |
|
41 | + 'getpaid_email_data', |
|
42 | + array( |
|
43 | + 'to' => array_filter( array_unique( wpinv_parse_list( $to ) ) ), |
|
44 | + 'subject' => htmlspecialchars_decode( strip_tags( $subject ), ENT_QUOTES ), |
|
45 | + 'email' => apply_filters( 'wpinv_mail_content', $email ), |
|
46 | + 'headers' => $this->get_headers(), |
|
47 | + 'attachments' => $attachments, |
|
48 | + ), |
|
49 | + $this |
|
50 | + ); |
|
51 | 51 | |
52 | 52 | // Remove slashes. |
53 | 53 | $data = (array) wp_unslash( $data ); |
54 | 54 | |
55 | 55 | // Cache it. |
56 | - $this->wp_mail_data = $data; |
|
56 | + $this->wp_mail_data = $data; |
|
57 | 57 | |
58 | - // Attach our own hooks. |
|
59 | - $this->before_sending(); |
|
58 | + // Attach our own hooks. |
|
59 | + $this->before_sending(); |
|
60 | 60 | |
61 | 61 | $result = false; |
62 | 62 | |
63 | 63 | foreach ( $this->wp_mail_data['to'] as $to ) { |
64 | - $result = $this->_send( $to, $data ); |
|
64 | + $result = $this->_send( $to, $data ); |
|
65 | 65 | } |
66 | 66 | |
67 | - // Remove our hooks. |
|
68 | - $this->after_sending(); |
|
67 | + // Remove our hooks. |
|
68 | + $this->after_sending(); |
|
69 | 69 | |
70 | - $this->wp_mail_data = null; |
|
70 | + $this->wp_mail_data = null; |
|
71 | 71 | |
72 | - return $result; |
|
73 | - } |
|
72 | + return $result; |
|
73 | + } |
|
74 | 74 | |
75 | - /** |
|
76 | - * Does the actual sending. |
|
75 | + /** |
|
76 | + * Does the actual sending. |
|
77 | 77 | * |
78 | 78 | * @param string $to The recipient's email. |
79 | 79 | * @param array $data The email's data. |
@@ -81,81 +81,81 @@ discard block |
||
81 | 81 | * @param array $attachments The email attachments. |
82 | 82 | * |
83 | 83 | * @return bool |
84 | - */ |
|
85 | - protected function _send( $to, $data ) { |
|
86 | - |
|
87 | - // Prepare the sending function. |
|
88 | - $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' ); |
|
89 | - |
|
90 | - // Send the actual email. |
|
91 | - $result = call_user_func( |
|
92 | - $sending_function, |
|
93 | - $to, |
|
94 | - html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ), |
|
95 | - $data['email'], |
|
96 | - $data['headers'], |
|
97 | - $data['attachments'] |
|
98 | - ); |
|
99 | - |
|
100 | - if ( ! $result ) { |
|
101 | - $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] ); |
|
102 | - wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ ); |
|
103 | - } |
|
104 | - |
|
105 | - return $result; |
|
106 | - } |
|
84 | + */ |
|
85 | + protected function _send( $to, $data ) { |
|
86 | + |
|
87 | + // Prepare the sending function. |
|
88 | + $sending_function = apply_filters( 'getpaid_email_email_sending_function', 'wp_mail' ); |
|
89 | + |
|
90 | + // Send the actual email. |
|
91 | + $result = call_user_func( |
|
92 | + $sending_function, |
|
93 | + $to, |
|
94 | + html_entity_decode( $data['subject'], ENT_QUOTES, get_bloginfo( 'charset' ) ), |
|
95 | + $data['email'], |
|
96 | + $data['headers'], |
|
97 | + $data['attachments'] |
|
98 | + ); |
|
99 | + |
|
100 | + if ( ! $result ) { |
|
101 | + $log_message = wp_sprintf( __( "\nTime: %s\nTo: %s\nSubject: %s\n", 'invoicing' ), date_i18n( 'F j Y H:i:s', current_time( 'timestamp' ) ), $to, $data['subject'] ); |
|
102 | + wpinv_error_log( $log_message, __( 'Email from Invoicing plugin failed to send', 'invoicing' ), __FILE__, __LINE__ ); |
|
103 | + } |
|
104 | + |
|
105 | + return $result; |
|
106 | + } |
|
107 | 107 | |
108 | 108 | /** |
109 | - * Retrieves email headers. |
|
110 | - */ |
|
111 | - public function get_headers() { |
|
109 | + * Retrieves email headers. |
|
110 | + */ |
|
111 | + public function get_headers() { |
|
112 | 112 | |
113 | - $name = $this->get_from_name(); |
|
114 | - $reply_to = $this->get_reply_to(); |
|
115 | - $headers = array( "Reply-To:$name <$reply_to>" ); |
|
113 | + $name = $this->get_from_name(); |
|
114 | + $reply_to = $this->get_reply_to(); |
|
115 | + $headers = array( "Reply-To:$name <$reply_to>" ); |
|
116 | 116 | |
117 | - return apply_filters( 'getpaid_email_headers', $headers, $this ); |
|
117 | + return apply_filters( 'getpaid_email_headers', $headers, $this ); |
|
118 | 118 | |
119 | - } |
|
119 | + } |
|
120 | 120 | |
121 | 121 | /** |
122 | - * Fires before an email is sent |
|
123 | - * |
|
124 | - * @since 1.0.0 |
|
125 | - */ |
|
126 | - public function before_sending() { |
|
122 | + * Fires before an email is sent |
|
123 | + * |
|
124 | + * @since 1.0.0 |
|
125 | + */ |
|
126 | + public function before_sending() { |
|
127 | 127 | |
128 | 128 | do_action( 'getpaid_before_send_email', $this ); |
129 | - add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
130 | - add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
131 | - add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
132 | - add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 ); |
|
129 | + add_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
130 | + add_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
131 | + add_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
132 | + add_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 ); |
|
133 | 133 | |
134 | - } |
|
134 | + } |
|
135 | 135 | |
136 | 136 | /** |
137 | - * Returns the from name. |
|
138 | - */ |
|
139 | - public function get_from_name() { |
|
137 | + * Returns the from name. |
|
138 | + */ |
|
139 | + public function get_from_name() { |
|
140 | 140 | |
141 | 141 | $from_name = wpinv_get_option( 'email_from_name', get_bloginfo( 'name' ) ); |
142 | 142 | |
143 | - if ( empty( $from_name ) ) { |
|
144 | - $from_name = get_bloginfo( 'name' ); |
|
143 | + if ( empty( $from_name ) ) { |
|
144 | + $from_name = get_bloginfo( 'name' ); |
|
145 | 145 | } |
146 | 146 | |
147 | - return wp_specialchars_decode( $from_name, ENT_QUOTES ); |
|
147 | + return wp_specialchars_decode( $from_name, ENT_QUOTES ); |
|
148 | 148 | } |
149 | 149 | |
150 | 150 | /** |
151 | - * Returns the from email. |
|
152 | - */ |
|
153 | - public function get_from_address() { |
|
151 | + * Returns the from email. |
|
152 | + */ |
|
153 | + public function get_from_address() { |
|
154 | 154 | |
155 | 155 | $from_address = wpinv_get_option( 'email_from', $this->default_from_address() ); |
156 | 156 | |
157 | - if ( ! is_email( $from_address ) ) { |
|
158 | - $from_address = $this->default_from_address(); |
|
157 | + if ( ! is_email( $from_address ) ) { |
|
158 | + $from_address = $this->default_from_address(); |
|
159 | 159 | } |
160 | 160 | |
161 | 161 | return $from_address; |
@@ -163,75 +163,75 @@ discard block |
||
163 | 163 | } |
164 | 164 | |
165 | 165 | /** |
166 | - * The default emails from address. |
|
167 | - * |
|
168 | - * Defaults to wordpress@$sitename |
|
169 | - * Some hosts will block outgoing mail from this address if it doesn't exist, |
|
170 | - * but there's no easy alternative. Defaulting to admin_email might appear to be |
|
171 | - * another option, but some hosts may refuse to relay mail from an unknown domain. |
|
172 | - * |
|
173 | - */ |
|
174 | - public function default_from_address() { |
|
175 | - |
|
176 | - // Get the site domain and get rid of www. |
|
177 | - $sitename = strtolower( $_SERVER['SERVER_NAME'] ); |
|
178 | - if ( substr( $sitename, 0, 4 ) == 'www.' ) { |
|
179 | - $sitename = substr( $sitename, 4 ); |
|
180 | - } |
|
181 | - |
|
182 | - $from_email = 'wordpress@' . $sitename; |
|
183 | - |
|
184 | - return apply_filters( 'getpaid_default_from_address', $from_email ); |
|
166 | + * The default emails from address. |
|
167 | + * |
|
168 | + * Defaults to wordpress@$sitename |
|
169 | + * Some hosts will block outgoing mail from this address if it doesn't exist, |
|
170 | + * but there's no easy alternative. Defaulting to admin_email might appear to be |
|
171 | + * another option, but some hosts may refuse to relay mail from an unknown domain. |
|
172 | + * |
|
173 | + */ |
|
174 | + public function default_from_address() { |
|
175 | + |
|
176 | + // Get the site domain and get rid of www. |
|
177 | + $sitename = strtolower( $_SERVER['SERVER_NAME'] ); |
|
178 | + if ( substr( $sitename, 0, 4 ) == 'www.' ) { |
|
179 | + $sitename = substr( $sitename, 4 ); |
|
180 | + } |
|
181 | + |
|
182 | + $from_email = 'wordpress@' . $sitename; |
|
183 | + |
|
184 | + return apply_filters( 'getpaid_default_from_address', $from_email ); |
|
185 | 185 | |
186 | 186 | } |
187 | 187 | |
188 | 188 | /** |
189 | - * Get the email reply-to. |
|
190 | - * |
|
191 | - * |
|
192 | - * @return string The email reply-to address. |
|
193 | - */ |
|
194 | - public function get_reply_to() { |
|
189 | + * Get the email reply-to. |
|
190 | + * |
|
191 | + * |
|
192 | + * @return string The email reply-to address. |
|
193 | + */ |
|
194 | + public function get_reply_to() { |
|
195 | 195 | |
196 | - $reply_to = wpinv_get_admin_email(); |
|
196 | + $reply_to = wpinv_get_admin_email(); |
|
197 | 197 | |
198 | - if ( ! is_email( $reply_to ) ) { |
|
199 | - $reply_to = get_option( 'admin_email' ); |
|
200 | - } |
|
198 | + if ( ! is_email( $reply_to ) ) { |
|
199 | + $reply_to = get_option( 'admin_email' ); |
|
200 | + } |
|
201 | 201 | |
202 | - return $reply_to; |
|
202 | + return $reply_to; |
|
203 | 203 | } |
204 | 204 | |
205 | 205 | /** |
206 | - * Get the email content type. |
|
207 | - * |
|
208 | - */ |
|
209 | - public function get_content_type() { |
|
210 | - return apply_filters( 'getpaid_email_content_type', 'text/html', $this ); |
|
206 | + * Get the email content type. |
|
207 | + * |
|
208 | + */ |
|
209 | + public function get_content_type() { |
|
210 | + return apply_filters( 'getpaid_email_content_type', 'text/html', $this ); |
|
211 | 211 | } |
212 | 212 | |
213 | 213 | /** |
214 | - * Ensures that our email messages are not messed up by template plugins. |
|
215 | - * |
|
216 | - * @return array wp_mail_data. |
|
217 | - */ |
|
218 | - public function ensure_email_content( $args ) { |
|
219 | - $args['message'] = $this->wp_mail_data['email']; |
|
220 | - return $args; |
|
214 | + * Ensures that our email messages are not messed up by template plugins. |
|
215 | + * |
|
216 | + * @return array wp_mail_data. |
|
217 | + */ |
|
218 | + public function ensure_email_content( $args ) { |
|
219 | + $args['message'] = $this->wp_mail_data['email']; |
|
220 | + return $args; |
|
221 | 221 | } |
222 | 222 | |
223 | 223 | /** |
224 | - * A little house keeping after an email is sent. |
|
225 | - * |
|
226 | - */ |
|
227 | - public function after_sending() { |
|
224 | + * A little house keeping after an email is sent. |
|
225 | + * |
|
226 | + */ |
|
227 | + public function after_sending() { |
|
228 | 228 | |
229 | 229 | do_action( 'getpaid_after_send_email', $this->wp_mail_data ); |
230 | - remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
231 | - remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
232 | - remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
233 | - remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 ); |
|
230 | + remove_filter( 'wp_mail_from', array( $this, 'get_from_address' ), 1000 ); |
|
231 | + remove_filter( 'wp_mail_from_name', array( $this, 'get_from_name' ), 1000 ); |
|
232 | + remove_filter( 'wp_mail_content_type', array( $this, 'get_content_type' ), 1000 ); |
|
233 | + remove_filter( 'wp_mail', array( $this, 'ensure_email_content' ), 1000 ); |
|
234 | 234 | |
235 | - } |
|
235 | + } |
|
236 | 236 | |
237 | 237 | } |
@@ -50,7 +50,7 @@ discard block |
||
50 | 50 | */ |
51 | 51 | function getpaid_get_invoice_subscription_group( $invoice_id, $subscription_id ) { |
52 | 52 | $subscription_groups = getpaid_get_invoice_subscription_groups( $invoice_id ); |
53 | - $matching_group = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) ); |
|
53 | + $matching_group = wp_list_filter( $subscription_groups, compact( 'subscription_id' ) ); |
|
54 | 54 | return reset( $matching_group ); |
55 | 55 | } |
56 | 56 | |
@@ -63,11 +63,11 @@ discard block |
||
63 | 63 | */ |
64 | 64 | function getpaid_get_subscription( $subscription ) { |
65 | 65 | |
66 | - if ( ! is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
67 | - $subscription = new WPInv_Subscription( $subscription ); |
|
68 | - } |
|
66 | + if ( ! is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
67 | + $subscription = new WPInv_Subscription( $subscription ); |
|
68 | + } |
|
69 | 69 | |
70 | - return $subscription->exists() ? $subscription : false; |
|
70 | + return $subscription->exists() ? $subscription : false; |
|
71 | 71 | } |
72 | 72 | |
73 | 73 | /** |
@@ -81,28 +81,28 @@ discard block |
||
81 | 81 | */ |
82 | 82 | function getpaid_get_subscriptions( $args = array(), $return = 'results' ) { |
83 | 83 | |
84 | - // Do not retrieve all fields if we just want the count. |
|
85 | - if ( 'count' == $return ) { |
|
86 | - $args['fields'] = 'id'; |
|
87 | - $args['number'] = 1; |
|
88 | - } |
|
84 | + // Do not retrieve all fields if we just want the count. |
|
85 | + if ( 'count' == $return ) { |
|
86 | + $args['fields'] = 'id'; |
|
87 | + $args['number'] = 1; |
|
88 | + } |
|
89 | 89 | |
90 | - // Do not count all matches if we just want the results. |
|
91 | - if ( 'results' == $return ) { |
|
92 | - $args['count_total'] = false; |
|
93 | - } |
|
90 | + // Do not count all matches if we just want the results. |
|
91 | + if ( 'results' == $return ) { |
|
92 | + $args['count_total'] = false; |
|
93 | + } |
|
94 | 94 | |
95 | - $query = new GetPaid_Subscriptions_Query( $args ); |
|
95 | + $query = new GetPaid_Subscriptions_Query( $args ); |
|
96 | 96 | |
97 | - if ( 'results' == $return ) { |
|
98 | - return $query->get_results(); |
|
99 | - } |
|
97 | + if ( 'results' == $return ) { |
|
98 | + return $query->get_results(); |
|
99 | + } |
|
100 | 100 | |
101 | - if ( 'count' == $return ) { |
|
102 | - return $query->get_total(); |
|
103 | - } |
|
101 | + if ( 'count' == $return ) { |
|
102 | + return $query->get_total(); |
|
103 | + } |
|
104 | 104 | |
105 | - return $query; |
|
105 | + return $query; |
|
106 | 106 | } |
107 | 107 | |
108 | 108 | /** |
@@ -112,18 +112,18 @@ discard block |
||
112 | 112 | */ |
113 | 113 | function getpaid_get_subscription_statuses() { |
114 | 114 | |
115 | - return apply_filters( |
|
116 | - 'getpaid_get_subscription_statuses', |
|
117 | - array( |
|
118 | - 'pending' => __( 'Pending', 'invoicing' ), |
|
119 | - 'trialling' => __( 'Trialing', 'invoicing' ), |
|
120 | - 'active' => __( 'Active', 'invoicing' ), |
|
121 | - 'failing' => __( 'Failing', 'invoicing' ), |
|
122 | - 'expired' => __( 'Expired', 'invoicing' ), |
|
123 | - 'completed' => __( 'Complete', 'invoicing' ), |
|
124 | - 'cancelled' => __( 'Cancelled', 'invoicing' ), |
|
125 | - ) |
|
126 | - ); |
|
115 | + return apply_filters( |
|
116 | + 'getpaid_get_subscription_statuses', |
|
117 | + array( |
|
118 | + 'pending' => __( 'Pending', 'invoicing' ), |
|
119 | + 'trialling' => __( 'Trialing', 'invoicing' ), |
|
120 | + 'active' => __( 'Active', 'invoicing' ), |
|
121 | + 'failing' => __( 'Failing', 'invoicing' ), |
|
122 | + 'expired' => __( 'Expired', 'invoicing' ), |
|
123 | + 'completed' => __( 'Complete', 'invoicing' ), |
|
124 | + 'cancelled' => __( 'Cancelled', 'invoicing' ), |
|
125 | + ) |
|
126 | + ); |
|
127 | 127 | |
128 | 128 | } |
129 | 129 | |
@@ -133,8 +133,8 @@ discard block |
||
133 | 133 | * @return string |
134 | 134 | */ |
135 | 135 | function getpaid_get_subscription_status_label( $status ) { |
136 | - $statuses = getpaid_get_subscription_statuses(); |
|
137 | - return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
136 | + $statuses = getpaid_get_subscription_statuses(); |
|
137 | + return isset( $statuses[ $status ] ) ? $statuses[ $status ] : ucfirst( sanitize_text_field( $status ) ); |
|
138 | 138 | } |
139 | 139 | |
140 | 140 | /** |
@@ -144,18 +144,18 @@ discard block |
||
144 | 144 | */ |
145 | 145 | function getpaid_get_subscription_status_classes() { |
146 | 146 | |
147 | - return apply_filters( |
|
148 | - 'getpaid_get_subscription_status_classes', |
|
149 | - array( |
|
150 | - 'pending' => 'badge-dark', |
|
151 | - 'trialling' => 'badge-info', |
|
152 | - 'active' => 'badge-success', |
|
153 | - 'failing' => 'badge-warning', |
|
154 | - 'expired' => 'badge-danger', |
|
155 | - 'completed' => 'badge-primary', |
|
156 | - 'cancelled' => 'badge-secondary', |
|
157 | - ) |
|
158 | - ); |
|
147 | + return apply_filters( |
|
148 | + 'getpaid_get_subscription_status_classes', |
|
149 | + array( |
|
150 | + 'pending' => 'badge-dark', |
|
151 | + 'trialling' => 'badge-info', |
|
152 | + 'active' => 'badge-success', |
|
153 | + 'failing' => 'badge-warning', |
|
154 | + 'expired' => 'badge-danger', |
|
155 | + 'completed' => 'badge-primary', |
|
156 | + 'cancelled' => 'badge-secondary', |
|
157 | + ) |
|
158 | + ); |
|
159 | 159 | |
160 | 160 | } |
161 | 161 | |
@@ -166,15 +166,15 @@ discard block |
||
166 | 166 | */ |
167 | 167 | function getpaid_get_subscription_status_counts( $args = array() ) { |
168 | 168 | |
169 | - $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
170 | - $counts = array(); |
|
169 | + $statuses = array_keys( getpaid_get_subscription_statuses() ); |
|
170 | + $counts = array(); |
|
171 | 171 | |
172 | - foreach ( $statuses as $status ) { |
|
173 | - $_args = wp_parse_args( "status=$status", $args ); |
|
174 | - $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' ); |
|
175 | - } |
|
172 | + foreach ( $statuses as $status ) { |
|
173 | + $_args = wp_parse_args( "status=$status", $args ); |
|
174 | + $counts[ $status ] = getpaid_get_subscriptions( $_args, 'count' ); |
|
175 | + } |
|
176 | 176 | |
177 | - return $counts; |
|
177 | + return $counts; |
|
178 | 178 | |
179 | 179 | } |
180 | 180 | |
@@ -185,32 +185,32 @@ discard block |
||
185 | 185 | */ |
186 | 186 | function getpaid_get_subscription_periods() { |
187 | 187 | |
188 | - return apply_filters( |
|
189 | - 'getpaid_get_subscription_periods', |
|
190 | - array( |
|
188 | + return apply_filters( |
|
189 | + 'getpaid_get_subscription_periods', |
|
190 | + array( |
|
191 | 191 | |
192 | - 'day' => array( |
|
193 | - 'singular' => __( '%s day', 'invoicing' ), |
|
194 | - 'plural' => __( '%d days', 'invoicing' ), |
|
195 | - ), |
|
192 | + 'day' => array( |
|
193 | + 'singular' => __( '%s day', 'invoicing' ), |
|
194 | + 'plural' => __( '%d days', 'invoicing' ), |
|
195 | + ), |
|
196 | 196 | |
197 | - 'week' => array( |
|
198 | - 'singular' => __( '%s week', 'invoicing' ), |
|
199 | - 'plural' => __( '%d weeks', 'invoicing' ), |
|
200 | - ), |
|
197 | + 'week' => array( |
|
198 | + 'singular' => __( '%s week', 'invoicing' ), |
|
199 | + 'plural' => __( '%d weeks', 'invoicing' ), |
|
200 | + ), |
|
201 | 201 | |
202 | - 'month' => array( |
|
203 | - 'singular' => __( '%s month', 'invoicing' ), |
|
204 | - 'plural' => __( '%d months', 'invoicing' ), |
|
205 | - ), |
|
202 | + 'month' => array( |
|
203 | + 'singular' => __( '%s month', 'invoicing' ), |
|
204 | + 'plural' => __( '%d months', 'invoicing' ), |
|
205 | + ), |
|
206 | 206 | |
207 | - 'year' => array( |
|
208 | - 'singular' => __( '%s year', 'invoicing' ), |
|
209 | - 'plural' => __( '%d years', 'invoicing' ), |
|
210 | - ), |
|
207 | + 'year' => array( |
|
208 | + 'singular' => __( '%s year', 'invoicing' ), |
|
209 | + 'plural' => __( '%d years', 'invoicing' ), |
|
210 | + ), |
|
211 | 211 | |
212 | - ) |
|
213 | - ); |
|
212 | + ) |
|
213 | + ); |
|
214 | 214 | |
215 | 215 | } |
216 | 216 | |
@@ -221,7 +221,7 @@ discard block |
||
221 | 221 | * @return int |
222 | 222 | */ |
223 | 223 | function getpaid_get_subscription_trial_period_interval( $trial_period ) { |
224 | - return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
224 | + return (int) preg_replace( '/[^0-9]/', '', $trial_period ); |
|
225 | 225 | } |
226 | 226 | |
227 | 227 | /** |
@@ -231,7 +231,7 @@ discard block |
||
231 | 231 | * @return string |
232 | 232 | */ |
233 | 233 | function getpaid_get_subscription_trial_period_period( $trial_period ) { |
234 | - return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
234 | + return preg_replace( '/[^a-z]/', '', strtolower( $trial_period ) ); |
|
235 | 235 | } |
236 | 236 | |
237 | 237 | /** |
@@ -242,8 +242,8 @@ discard block |
||
242 | 242 | * @return string |
243 | 243 | */ |
244 | 244 | function getpaid_get_subscription_period_label( $period, $interval = 1, $singular_prefix = '1' ) { |
245 | - $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix ); |
|
246 | - return strtolower( sanitize_text_field( $label ) ); |
|
245 | + $label = (int) $interval > 1 ? getpaid_get_plural_subscription_period_label( $period, $interval ) : getpaid_get_singular_subscription_period_label( $period, $singular_prefix ); |
|
246 | + return strtolower( sanitize_text_field( $label ) ); |
|
247 | 247 | } |
248 | 248 | |
249 | 249 | /** |
@@ -254,22 +254,22 @@ discard block |
||
254 | 254 | */ |
255 | 255 | function getpaid_get_singular_subscription_period_label( $period, $singular_prefix = '1' ) { |
256 | 256 | |
257 | - $periods = getpaid_get_subscription_periods(); |
|
258 | - $period = strtolower( $period ); |
|
257 | + $periods = getpaid_get_subscription_periods(); |
|
258 | + $period = strtolower( $period ); |
|
259 | 259 | |
260 | - if ( isset( $periods[ $period ] ) ) { |
|
261 | - return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
262 | - } |
|
260 | + if ( isset( $periods[ $period ] ) ) { |
|
261 | + return sprintf( $periods[ $period ]['singular'], $singular_prefix ); |
|
262 | + } |
|
263 | 263 | |
264 | - // Backwards compatibility. |
|
265 | - foreach ( $periods as $key => $data ) { |
|
266 | - if ( strpos( $key, $period ) === 0 ) { |
|
267 | - return sprintf( $data['singular'], $singular_prefix ); |
|
268 | - } |
|
269 | - } |
|
264 | + // Backwards compatibility. |
|
265 | + foreach ( $periods as $key => $data ) { |
|
266 | + if ( strpos( $key, $period ) === 0 ) { |
|
267 | + return sprintf( $data['singular'], $singular_prefix ); |
|
268 | + } |
|
269 | + } |
|
270 | 270 | |
271 | - // Invalid string. |
|
272 | - return ''; |
|
271 | + // Invalid string. |
|
272 | + return ''; |
|
273 | 273 | } |
274 | 274 | |
275 | 275 | /** |
@@ -281,22 +281,22 @@ discard block |
||
281 | 281 | */ |
282 | 282 | function getpaid_get_plural_subscription_period_label( $period, $interval ) { |
283 | 283 | |
284 | - $periods = getpaid_get_subscription_periods(); |
|
285 | - $period = strtolower( $period ); |
|
284 | + $periods = getpaid_get_subscription_periods(); |
|
285 | + $period = strtolower( $period ); |
|
286 | 286 | |
287 | - if ( isset( $periods[ $period ] ) ) { |
|
288 | - return sprintf( $periods[ $period ]['plural'], $interval ); |
|
289 | - } |
|
287 | + if ( isset( $periods[ $period ] ) ) { |
|
288 | + return sprintf( $periods[ $period ]['plural'], $interval ); |
|
289 | + } |
|
290 | 290 | |
291 | - // Backwards compatibility. |
|
292 | - foreach ( $periods as $key => $data ) { |
|
293 | - if ( strpos( $key, $period ) === 0 ) { |
|
294 | - return sprintf( $data['plural'], $interval ); |
|
295 | - } |
|
296 | - } |
|
291 | + // Backwards compatibility. |
|
292 | + foreach ( $periods as $key => $data ) { |
|
293 | + if ( strpos( $key, $period ) === 0 ) { |
|
294 | + return sprintf( $data['plural'], $interval ); |
|
295 | + } |
|
296 | + } |
|
297 | 297 | |
298 | - // Invalid string. |
|
299 | - return ''; |
|
298 | + // Invalid string. |
|
299 | + return ''; |
|
300 | 300 | } |
301 | 301 | |
302 | 302 | /** |
@@ -307,101 +307,101 @@ discard block |
||
307 | 307 | */ |
308 | 308 | function getpaid_get_formatted_subscription_amount( $subscription ) { |
309 | 309 | |
310 | - $initial = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
311 | - $recurring = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
312 | - $period = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
313 | - $bill_times = $subscription->get_bill_times(); |
|
310 | + $initial = wpinv_price( $subscription->get_initial_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
311 | + $recurring = wpinv_price( $subscription->get_recurring_amount(), $subscription->get_parent_payment()->get_currency() ); |
|
312 | + $period = getpaid_get_subscription_period_label( $subscription->get_period(), $subscription->get_frequency(), '' ); |
|
313 | + $bill_times = $subscription->get_bill_times(); |
|
314 | 314 | |
315 | - if ( ! empty( $bill_times ) ) { |
|
316 | - $bill_times = $subscription->get_frequency() * $bill_times; |
|
317 | - $bill_times = getpaid_get_subscription_period_label( $subscription->get_period(), $bill_times ); |
|
318 | - } |
|
315 | + if ( ! empty( $bill_times ) ) { |
|
316 | + $bill_times = $subscription->get_frequency() * $bill_times; |
|
317 | + $bill_times = getpaid_get_subscription_period_label( $subscription->get_period(), $bill_times ); |
|
318 | + } |
|
319 | 319 | |
320 | - // Trial periods. |
|
321 | - if ( $subscription->has_trial_period() ) { |
|
320 | + // Trial periods. |
|
321 | + if ( $subscription->has_trial_period() ) { |
|
322 | 322 | |
323 | - $trial_period = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() ); |
|
324 | - $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() ); |
|
323 | + $trial_period = getpaid_get_subscription_trial_period_period( $subscription->get_trial_period() ); |
|
324 | + $trial_interval = getpaid_get_subscription_trial_period_interval( $subscription->get_trial_period() ); |
|
325 | 325 | |
326 | - if ( empty( $bill_times ) ) { |
|
326 | + if ( empty( $bill_times ) ) { |
|
327 | 327 | |
328 | - return sprintf( |
|
328 | + return sprintf( |
|
329 | 329 | |
330 | - // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period |
|
331 | - _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ), |
|
332 | - $initial, |
|
333 | - getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
334 | - $recurring, |
|
335 | - $period |
|
330 | + // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period |
|
331 | + _x( '%1$s trial for %2$s then %3$s / %4$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year)', 'invoicing' ), |
|
332 | + $initial, |
|
333 | + getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
334 | + $recurring, |
|
335 | + $period |
|
336 | 336 | |
337 | - ); |
|
337 | + ); |
|
338 | 338 | |
339 | - } |
|
339 | + } |
|
340 | 340 | |
341 | - return sprintf( |
|
341 | + return sprintf( |
|
342 | 342 | |
343 | - // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period, $5: is the bill times |
|
344 | - _x( '%1$s trial for %2$s then %3$s / %4$s for %5$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year for 4 years)', 'invoicing' ), |
|
345 | - $initial, |
|
346 | - getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
347 | - $recurring, |
|
348 | - $period, |
|
349 | - $bill_times |
|
350 | - ); |
|
343 | + // translators: $1: is the initial amount, $2: is the trial period, $3: is the recurring amount, $4: is the recurring period, $5: is the bill times |
|
344 | + _x( '%1$s trial for %2$s then %3$s / %4$s for %5$s', 'Subscription amount. (e.g.: $10 trial for 1 month then $120 / year for 4 years)', 'invoicing' ), |
|
345 | + $initial, |
|
346 | + getpaid_get_subscription_period_label( $trial_period, $trial_interval ), |
|
347 | + $recurring, |
|
348 | + $period, |
|
349 | + $bill_times |
|
350 | + ); |
|
351 | 351 | |
352 | - } |
|
352 | + } |
|
353 | 353 | |
354 | - if ( $initial != $recurring ) { |
|
354 | + if ( $initial != $recurring ) { |
|
355 | 355 | |
356 | - if ( empty( $bill_times ) ) { |
|
356 | + if ( empty( $bill_times ) ) { |
|
357 | 357 | |
358 | - return sprintf( |
|
358 | + return sprintf( |
|
359 | 359 | |
360 | - // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period |
|
361 | - _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ), |
|
362 | - $initial, |
|
363 | - $recurring, |
|
364 | - $period |
|
360 | + // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period |
|
361 | + _x( 'Initial payment of %1$s which renews at %2$s / %3$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year)', 'invoicing' ), |
|
362 | + $initial, |
|
363 | + $recurring, |
|
364 | + $period |
|
365 | 365 | |
366 | - ); |
|
366 | + ); |
|
367 | 367 | |
368 | - } |
|
368 | + } |
|
369 | 369 | |
370 | - return sprintf( |
|
370 | + return sprintf( |
|
371 | 371 | |
372 | - // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period, $4: is the bill times |
|
373 | - _x( 'Initial payment of %1$s which renews at %2$s / %3$s for %4$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year for 5 years)', 'invoicing' ), |
|
374 | - $initial, |
|
375 | - $recurring, |
|
376 | - $period, |
|
377 | - $bill_times |
|
372 | + // translators: $1: is the initial amount, $2: is the recurring amount, $3: is the recurring period, $4: is the bill times |
|
373 | + _x( 'Initial payment of %1$s which renews at %2$s / %3$s for %4$s', 'Subscription amount. (e.g.:Initial payment of $100 which renews at $120 / year for 5 years)', 'invoicing' ), |
|
374 | + $initial, |
|
375 | + $recurring, |
|
376 | + $period, |
|
377 | + $bill_times |
|
378 | 378 | |
379 | - ); |
|
379 | + ); |
|
380 | 380 | |
381 | - } |
|
381 | + } |
|
382 | 382 | |
383 | - if ( empty( $bill_times ) ) { |
|
383 | + if ( empty( $bill_times ) ) { |
|
384 | 384 | |
385 | - return sprintf( |
|
385 | + return sprintf( |
|
386 | 386 | |
387 | - // translators: $1: is the recurring amount, $2: is the recurring period |
|
388 | - _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ), |
|
389 | - $initial, |
|
390 | - $period |
|
387 | + // translators: $1: is the recurring amount, $2: is the recurring period |
|
388 | + _x( '%1$s / %2$s', 'Subscription amount. (e.g.: $120 / year)', 'invoicing' ), |
|
389 | + $initial, |
|
390 | + $period |
|
391 | 391 | |
392 | - ); |
|
392 | + ); |
|
393 | 393 | |
394 | - } |
|
394 | + } |
|
395 | 395 | |
396 | - return sprintf( |
|
396 | + return sprintf( |
|
397 | 397 | |
398 | - // translators: $1: is the bill times, $2: is the recurring amount, $3: is the recurring period |
|
399 | - _x( '%2$s / %3$s for %1$s', 'Subscription amount. (e.g.: $120 / year for 5 years)', 'invoicing' ), |
|
400 | - $bill_times, |
|
401 | - $initial, |
|
402 | - $period |
|
398 | + // translators: $1: is the bill times, $2: is the recurring amount, $3: is the recurring period |
|
399 | + _x( '%2$s / %3$s for %1$s', 'Subscription amount. (e.g.: $120 / year for 5 years)', 'invoicing' ), |
|
400 | + $bill_times, |
|
401 | + $initial, |
|
402 | + $period |
|
403 | 403 | |
404 | - ); |
|
404 | + ); |
|
405 | 405 | |
406 | 406 | } |
407 | 407 | |
@@ -412,7 +412,7 @@ discard block |
||
412 | 412 | * @return WPInv_Subscription|false |
413 | 413 | */ |
414 | 414 | function getpaid_get_invoice_subscription( $invoice ) { |
415 | - return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
415 | + return getpaid_subscriptions()->get_invoice_subscription( $invoice ); |
|
416 | 416 | } |
417 | 417 | |
418 | 418 | /** |
@@ -421,10 +421,10 @@ discard block |
||
421 | 421 | * @param WPInv_Invoice $invoice |
422 | 422 | */ |
423 | 423 | function getpaid_activate_invoice_subscription( $invoice ) { |
424 | - $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
425 | - if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
426 | - $subscription->activate(); |
|
427 | - } |
|
424 | + $subscription = getpaid_get_invoice_subscription( $invoice ); |
|
425 | + if ( is_a( $subscription, 'WPInv_Subscription' ) ) { |
|
426 | + $subscription->activate(); |
|
427 | + } |
|
428 | 428 | } |
429 | 429 | |
430 | 430 | /** |
@@ -433,7 +433,7 @@ discard block |
||
433 | 433 | * @return WPInv_Subscriptions |
434 | 434 | */ |
435 | 435 | function getpaid_subscriptions() { |
436 | - return getpaid()->get( 'subscriptions' ); |
|
436 | + return getpaid()->get( 'subscriptions' ); |
|
437 | 437 | } |
438 | 438 | |
439 | 439 | /** |
@@ -452,15 +452,15 @@ discard block |
||
452 | 452 | return false; |
453 | 453 | } |
454 | 454 | |
455 | - // Fetch the invoice subscription. |
|
456 | - $subscription = getpaid_get_subscriptions( |
|
457 | - array( |
|
458 | - 'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(), |
|
459 | - 'number' => 1, |
|
460 | - ) |
|
461 | - ); |
|
455 | + // Fetch the invoice subscription. |
|
456 | + $subscription = getpaid_get_subscriptions( |
|
457 | + array( |
|
458 | + 'invoice_in' => $invoice->is_renewal() ? $invoice->get_parent_id() : $invoice->get_id(), |
|
459 | + 'number' => 1, |
|
460 | + ) |
|
461 | + ); |
|
462 | 462 | |
463 | - return empty( $subscription ) ? false : $subscription[0]; |
|
463 | + return empty( $subscription ) ? false : $subscription[0]; |
|
464 | 464 | |
465 | 465 | } |
466 | 466 | |
@@ -477,48 +477,48 @@ discard block |
||
477 | 477 | */ |
478 | 478 | function getpaid_get_recurring_item_key( $cart_item ) { |
479 | 479 | |
480 | - $cart_key = 'renews_'; |
|
481 | - $interval = $cart_item->get_recurring_interval(); |
|
482 | - $period = $cart_item->get_recurring_period( true ); |
|
483 | - $length = $cart_item->get_recurring_limit() * $interval; |
|
484 | - $trial_period = $cart_item->get_trial_period( true ); |
|
485 | - $trial_length = $cart_item->get_trial_interval(); |
|
486 | - |
|
487 | - // First start with the billing interval and period |
|
488 | - switch ( $interval ) { |
|
489 | - case 1 : |
|
490 | - if ( 'day' == $period ) { |
|
491 | - $cart_key .= 'daily'; |
|
492 | - } else { |
|
493 | - $cart_key .= sprintf( '%sly', $period ); |
|
494 | - } |
|
495 | - break; |
|
496 | - case 2 : |
|
497 | - $cart_key .= sprintf( 'every_2nd_%s', $period ); |
|
498 | - break; |
|
499 | - case 3 : |
|
500 | - $cart_key .= sprintf( 'every_3rd_%s', $period ); |
|
501 | - break; |
|
502 | - default: |
|
503 | - $cart_key .= sprintf( 'every_%dth_%s', $interval, $period ); |
|
504 | - break; |
|
505 | - } |
|
506 | - |
|
507 | - // Maybe add the optional maximum billing periods... |
|
508 | - if ( $length > 0 ) { |
|
509 | - $cart_key .= '_for_'; |
|
510 | - $cart_key .= sprintf( '%d_%s', $length, $period ); |
|
511 | - if ( $length > 1 ) { |
|
512 | - $cart_key .= 's'; |
|
513 | - } |
|
514 | - } |
|
515 | - |
|
516 | - // And an optional free trial. |
|
517 | - if ( $cart_item->has_free_trial() ) { |
|
518 | - $cart_key .= sprintf( '_after_a_%d_%s_trial', $trial_length, $trial_period ); |
|
519 | - } |
|
520 | - |
|
521 | - return apply_filters( 'getpaid_get_recurring_item_key', $cart_key, $cart_item ); |
|
480 | + $cart_key = 'renews_'; |
|
481 | + $interval = $cart_item->get_recurring_interval(); |
|
482 | + $period = $cart_item->get_recurring_period( true ); |
|
483 | + $length = $cart_item->get_recurring_limit() * $interval; |
|
484 | + $trial_period = $cart_item->get_trial_period( true ); |
|
485 | + $trial_length = $cart_item->get_trial_interval(); |
|
486 | + |
|
487 | + // First start with the billing interval and period |
|
488 | + switch ( $interval ) { |
|
489 | + case 1 : |
|
490 | + if ( 'day' == $period ) { |
|
491 | + $cart_key .= 'daily'; |
|
492 | + } else { |
|
493 | + $cart_key .= sprintf( '%sly', $period ); |
|
494 | + } |
|
495 | + break; |
|
496 | + case 2 : |
|
497 | + $cart_key .= sprintf( 'every_2nd_%s', $period ); |
|
498 | + break; |
|
499 | + case 3 : |
|
500 | + $cart_key .= sprintf( 'every_3rd_%s', $period ); |
|
501 | + break; |
|
502 | + default: |
|
503 | + $cart_key .= sprintf( 'every_%dth_%s', $interval, $period ); |
|
504 | + break; |
|
505 | + } |
|
506 | + |
|
507 | + // Maybe add the optional maximum billing periods... |
|
508 | + if ( $length > 0 ) { |
|
509 | + $cart_key .= '_for_'; |
|
510 | + $cart_key .= sprintf( '%d_%s', $length, $period ); |
|
511 | + if ( $length > 1 ) { |
|
512 | + $cart_key .= 's'; |
|
513 | + } |
|
514 | + } |
|
515 | + |
|
516 | + // And an optional free trial. |
|
517 | + if ( $cart_item->has_free_trial() ) { |
|
518 | + $cart_key .= sprintf( '_after_a_%d_%s_trial', $trial_length, $trial_period ); |
|
519 | + } |
|
520 | + |
|
521 | + return apply_filters( 'getpaid_get_recurring_item_key', $cart_key, $cart_item ); |
|
522 | 522 | } |
523 | 523 | |
524 | 524 | /** |
@@ -529,17 +529,17 @@ discard block |
||
529 | 529 | */ |
530 | 530 | function getpaid_get_subscription_groups( $invoice ) { |
531 | 531 | |
532 | - // Generate subscription groups. |
|
533 | - $subscription_groups = array(); |
|
534 | - foreach ( $invoice->get_items() as $item ) { |
|
532 | + // Generate subscription groups. |
|
533 | + $subscription_groups = array(); |
|
534 | + foreach ( $invoice->get_items() as $item ) { |
|
535 | 535 | |
536 | - if ( $item->is_recurring() ) { |
|
537 | - $subscription_groups[ getpaid_get_recurring_item_key( $item ) ][] = $item; |
|
538 | - } |
|
536 | + if ( $item->is_recurring() ) { |
|
537 | + $subscription_groups[ getpaid_get_recurring_item_key( $item ) ][] = $item; |
|
538 | + } |
|
539 | 539 | |
540 | - } |
|
540 | + } |
|
541 | 541 | |
542 | - return $subscription_groups; |
|
542 | + return $subscription_groups; |
|
543 | 543 | } |
544 | 544 | |
545 | 545 | /** |
@@ -553,57 +553,57 @@ discard block |
||
553 | 553 | */ |
554 | 554 | function getpaid_calculate_subscription_totals( $invoice ) { |
555 | 555 | |
556 | - // Generate subscription groups. |
|
557 | - $subscription_groups = getpaid_get_subscription_groups( $invoice ); |
|
556 | + // Generate subscription groups. |
|
557 | + $subscription_groups = getpaid_get_subscription_groups( $invoice ); |
|
558 | 558 | |
559 | - // Now let's calculate the totals for each group of subscriptions |
|
560 | - $subscription_totals = array(); |
|
559 | + // Now let's calculate the totals for each group of subscriptions |
|
560 | + $subscription_totals = array(); |
|
561 | 561 | |
562 | - foreach ( $subscription_groups as $subscription_key => $items ) { |
|
562 | + foreach ( $subscription_groups as $subscription_key => $items ) { |
|
563 | 563 | |
564 | - if ( empty( $subscription_totals[ $subscription_key ] ) ) { |
|
564 | + if ( empty( $subscription_totals[ $subscription_key ] ) ) { |
|
565 | 565 | |
566 | - $subscription_totals[ $subscription_key ] = array( |
|
567 | - 'initial_total' => 0, |
|
568 | - 'recurring_total' => 0, |
|
569 | - 'items' => array(), |
|
570 | - 'trialling' => false, |
|
571 | - ); |
|
566 | + $subscription_totals[ $subscription_key ] = array( |
|
567 | + 'initial_total' => 0, |
|
568 | + 'recurring_total' => 0, |
|
569 | + 'items' => array(), |
|
570 | + 'trialling' => false, |
|
571 | + ); |
|
572 | 572 | |
573 | - } |
|
573 | + } |
|
574 | 574 | |
575 | - /** |
|
576 | - * Get the totals of the group. |
|
577 | - * @var GetPaid_Form_Item $item |
|
578 | - */ |
|
579 | - foreach ( $items as $item ) { |
|
575 | + /** |
|
576 | + * Get the totals of the group. |
|
577 | + * @var GetPaid_Form_Item $item |
|
578 | + */ |
|
579 | + foreach ( $items as $item ) { |
|
580 | 580 | |
581 | - $subscription_totals[ $subscription_key ]['items'][$item->get_id()] = $item->prepare_data_for_saving(); |
|
582 | - $subscription_totals[ $subscription_key ]['item_id'] = $item->get_id(); |
|
583 | - $subscription_totals[ $subscription_key ]['period'] = $item->get_recurring_period( true ); |
|
584 | - $subscription_totals[ $subscription_key ]['interval'] = $item->get_recurring_interval(); |
|
585 | - $subscription_totals[ $subscription_key ]['initial_total'] += $item->get_sub_total() + $item->item_tax - $item->item_discount; |
|
586 | - $subscription_totals[ $subscription_key ]['recurring_total'] += $item->get_recurring_sub_total() + $item->item_tax - $item->recurring_item_discount; |
|
587 | - $subscription_totals[ $subscription_key ]['recurring_limit'] = $item->get_recurring_limit(); |
|
581 | + $subscription_totals[ $subscription_key ]['items'][$item->get_id()] = $item->prepare_data_for_saving(); |
|
582 | + $subscription_totals[ $subscription_key ]['item_id'] = $item->get_id(); |
|
583 | + $subscription_totals[ $subscription_key ]['period'] = $item->get_recurring_period( true ); |
|
584 | + $subscription_totals[ $subscription_key ]['interval'] = $item->get_recurring_interval(); |
|
585 | + $subscription_totals[ $subscription_key ]['initial_total'] += $item->get_sub_total() + $item->item_tax - $item->item_discount; |
|
586 | + $subscription_totals[ $subscription_key ]['recurring_total'] += $item->get_recurring_sub_total() + $item->item_tax - $item->recurring_item_discount; |
|
587 | + $subscription_totals[ $subscription_key ]['recurring_limit'] = $item->get_recurring_limit(); |
|
588 | 588 | |
589 | - // Calculate the next renewal date. |
|
590 | - $period = $item->get_recurring_period( true ); |
|
591 | - $interval = $item->get_recurring_interval(); |
|
589 | + // Calculate the next renewal date. |
|
590 | + $period = $item->get_recurring_period( true ); |
|
591 | + $interval = $item->get_recurring_interval(); |
|
592 | 592 | |
593 | - // If the subscription item has a trial period... |
|
594 | - if ( $item->has_free_trial() ) { |
|
595 | - $period = $item->get_trial_period( true ); |
|
596 | - $interval = $item->get_trial_interval(); |
|
597 | - $subscription_totals[ $subscription_key ]['trialling'] = $interval . ' ' . $period; |
|
598 | - } |
|
593 | + // If the subscription item has a trial period... |
|
594 | + if ( $item->has_free_trial() ) { |
|
595 | + $period = $item->get_trial_period( true ); |
|
596 | + $interval = $item->get_trial_interval(); |
|
597 | + $subscription_totals[ $subscription_key ]['trialling'] = $interval . ' ' . $period; |
|
598 | + } |
|
599 | 599 | |
600 | - $subscription_totals[ $subscription_key ]['renews_on'] = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", current_time( 'timestamp' ) ) ); |
|
600 | + $subscription_totals[ $subscription_key ]['renews_on'] = date( 'Y-m-d H:i:s', strtotime( "+$interval $period", current_time( 'timestamp' ) ) ); |
|
601 | 601 | |
602 | - } |
|
602 | + } |
|
603 | 603 | |
604 | - } |
|
604 | + } |
|
605 | 605 | |
606 | - return apply_filters( 'getpaid_calculate_subscription_totals', $subscription_totals, $invoice ); |
|
606 | + return apply_filters( 'getpaid_calculate_subscription_totals', $subscription_totals, $invoice ); |
|
607 | 607 | } |
608 | 608 | |
609 | 609 | /** |
@@ -614,17 +614,17 @@ discard block |
||
614 | 614 | */ |
615 | 615 | function getpaid_should_group_subscriptions( $invoice ) { |
616 | 616 | |
617 | - $recurring_items = 0; |
|
617 | + $recurring_items = 0; |
|
618 | 618 | |
619 | - foreach ( $invoice->get_items() as $item ) { |
|
619 | + foreach ( $invoice->get_items() as $item ) { |
|
620 | 620 | |
621 | - if ( $item->is_recurring() ) { |
|
622 | - $recurring_items ++; |
|
623 | - } |
|
621 | + if ( $item->is_recurring() ) { |
|
622 | + $recurring_items ++; |
|
623 | + } |
|
624 | 624 | |
625 | - } |
|
625 | + } |
|
626 | 626 | |
627 | - return apply_filters( 'getpaid_should_group_subscriptions', $recurring_items > 1, $invoice ); |
|
627 | + return apply_filters( 'getpaid_should_group_subscriptions', $recurring_items > 1, $invoice ); |
|
628 | 628 | } |
629 | 629 | |
630 | 630 | /** |
@@ -635,40 +635,40 @@ discard block |
||
635 | 635 | * @return int |
636 | 636 | */ |
637 | 637 | function getpaid_count_subscription_invoices( $parent_invoice_id, $subscription_id = false ) { |
638 | - global $wpdb; |
|
638 | + global $wpdb; |
|
639 | 639 | |
640 | - $parent_invoice_id = (int) $parent_invoice_id; |
|
640 | + $parent_invoice_id = (int) $parent_invoice_id; |
|
641 | 641 | |
642 | - if ( false === $subscription_id || ! (bool) get_post_meta( $parent_invoice_id, '_wpinv_subscription_id', true ) ) { |
|
642 | + if ( false === $subscription_id || ! (bool) get_post_meta( $parent_invoice_id, '_wpinv_subscription_id', true ) ) { |
|
643 | 643 | |
644 | - return (int) $wpdb->get_var( |
|
645 | - $wpdb->prepare( |
|
646 | - "SELECT COUNT(ID) FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
647 | - $parent_invoice_id, |
|
648 | - $parent_invoice_id |
|
649 | - ) |
|
650 | - ); |
|
644 | + return (int) $wpdb->get_var( |
|
645 | + $wpdb->prepare( |
|
646 | + "SELECT COUNT(ID) FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
647 | + $parent_invoice_id, |
|
648 | + $parent_invoice_id |
|
649 | + ) |
|
650 | + ); |
|
651 | 651 | |
652 | - } |
|
652 | + } |
|
653 | 653 | |
654 | - $invoice_ids = $wpdb->get_col( |
|
655 | - $wpdb->prepare( |
|
656 | - "SELECT ID FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
657 | - $parent_invoice_id, |
|
658 | - $parent_invoice_id |
|
659 | - ) |
|
660 | - ); |
|
654 | + $invoice_ids = $wpdb->get_col( |
|
655 | + $wpdb->prepare( |
|
656 | + "SELECT ID FROM $wpdb->posts WHERE ( post_parent=%d OR ID=%d ) AND post_status IN ( 'publish', 'wpi-processing', 'wpi-renewal' )", |
|
657 | + $parent_invoice_id, |
|
658 | + $parent_invoice_id |
|
659 | + ) |
|
660 | + ); |
|
661 | 661 | |
662 | - $count = 0; |
|
662 | + $count = 0; |
|
663 | 663 | |
664 | - foreach ( wp_parse_id_list( $invoice_ids ) as $invoice_id ) { |
|
664 | + foreach ( wp_parse_id_list( $invoice_ids ) as $invoice_id ) { |
|
665 | 665 | |
666 | - if ( $invoice_id == $parent_invoice_id || $subscription_id == (int) get_post_meta( $invoice_id, '_wpinv_subscription_id', true ) ) { |
|
667 | - $count ++; |
|
668 | - continue; |
|
669 | - } |
|
666 | + if ( $invoice_id == $parent_invoice_id || $subscription_id == (int) get_post_meta( $invoice_id, '_wpinv_subscription_id', true ) ) { |
|
667 | + $count ++; |
|
668 | + continue; |
|
669 | + } |
|
670 | 670 | |
671 | - } |
|
671 | + } |
|
672 | 672 | |
673 | - return $count; |
|
673 | + return $count; |
|
674 | 674 | } |
@@ -239,7 +239,7 @@ |
||
239 | 239 | do_action( 'getpaid_checkout_invoice_exception', $invoice ); |
240 | 240 | } |
241 | 241 | |
242 | - // Do we have any errors? |
|
242 | + // Do we have any errors? |
|
243 | 243 | if ( wpinv_get_errors() ) { |
244 | 244 | $response['data'] = getpaid_get_errors_html( true, false ); |
245 | 245 | } else { |
@@ -24,14 +24,14 @@ |
||
24 | 24 | } |
25 | 25 | |
26 | 26 | /** |
27 | - * Highlights sub menus. |
|
28 | - */ |
|
29 | - public function set_admin_menu_class() { |
|
30 | - global $current_screen, $parent_file, $submenu_file; |
|
27 | + * Highlights sub menus. |
|
28 | + */ |
|
29 | + public function set_admin_menu_class() { |
|
30 | + global $current_screen, $parent_file, $submenu_file; |
|
31 | 31 | |
32 | 32 | if ( ! empty( $current_screen->id ) && in_array( $current_screen->id , array( 'wpi_discount', 'wpi_payment_form', 'wpi_invoice' ) ) ) { |
33 | - $parent_file = 'wpinv'; |
|
34 | - $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
|
33 | + $parent_file = 'wpinv'; |
|
34 | + $submenu_file = 'edit.php?post_type=' . $current_screen->id; |
|
35 | 35 | } |
36 | 36 | |
37 | 37 | } |
@@ -276,26 +276,26 @@ discard block |
||
276 | 276 | } |
277 | 277 | |
278 | 278 | function wpinv_get_chosen_gateway( $invoice_id = 0 ) { |
279 | - $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
279 | + $gateways = array_keys( wpinv_get_enabled_payment_gateways() ); |
|
280 | 280 | |
281 | 281 | $chosen = false; |
282 | 282 | if ( $invoice_id > 0 && $invoice = wpinv_get_invoice( $invoice_id ) ) { |
283 | 283 | $chosen = $invoice->get_gateway(); |
284 | 284 | } |
285 | 285 | |
286 | - $chosen = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen; |
|
286 | + $chosen = isset( $_REQUEST['payment-mode'] ) ? sanitize_text_field( $_REQUEST['payment-mode'] ) : $chosen; |
|
287 | 287 | |
288 | - if ( false !== $chosen ) { |
|
289 | - $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen ); |
|
290 | - } |
|
288 | + if ( false !== $chosen ) { |
|
289 | + $chosen = preg_replace('/[^a-zA-Z0-9-_]+/', '', $chosen ); |
|
290 | + } |
|
291 | 291 | |
292 | - if ( ! empty ( $chosen ) ) { |
|
293 | - $enabled_gateway = urldecode( $chosen ); |
|
294 | - } else if ( !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) { |
|
295 | - $enabled_gateway = 'manual'; |
|
296 | - } else { |
|
297 | - $enabled_gateway = wpinv_get_default_gateway(); |
|
298 | - } |
|
292 | + if ( ! empty ( $chosen ) ) { |
|
293 | + $enabled_gateway = urldecode( $chosen ); |
|
294 | + } else if ( !empty( $invoice ) && (float)$invoice->get_subtotal() <= 0 ) { |
|
295 | + $enabled_gateway = 'manual'; |
|
296 | + } else { |
|
297 | + $enabled_gateway = wpinv_get_default_gateway(); |
|
298 | + } |
|
299 | 299 | |
300 | 300 | if ( !wpinv_is_gateway_active( $enabled_gateway ) && !empty( $gateways ) ) { |
301 | 301 | if(wpinv_is_gateway_active( wpinv_get_default_gateway()) ){ |
@@ -306,7 +306,7 @@ discard block |
||
306 | 306 | |
307 | 307 | } |
308 | 308 | |
309 | - return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway ); |
|
309 | + return apply_filters( 'wpinv_chosen_gateway', $enabled_gateway ); |
|
310 | 310 | } |
311 | 311 | |
312 | 312 | function wpinv_record_gateway_error( $title = '', $message = '' ) { |
@@ -314,21 +314,21 @@ discard block |
||
314 | 314 | } |
315 | 315 | |
316 | 316 | function wpinv_count_sales_by_gateway( $gateway_id = 'paypal', $status = 'publish' ) { |
317 | - $ret = 0; |
|
318 | - $args = array( |
|
319 | - 'meta_key' => '_wpinv_gateway', |
|
320 | - 'meta_value' => $gateway_id, |
|
321 | - 'nopaging' => true, |
|
322 | - 'post_type' => 'wpi_invoice', |
|
323 | - 'post_status' => $status, |
|
324 | - 'fields' => 'ids' |
|
325 | - ); |
|
326 | - |
|
327 | - $payments = new WP_Query( $args ); |
|
328 | - |
|
329 | - if( $payments ) |
|
330 | - $ret = $payments->post_count; |
|
331 | - return $ret; |
|
317 | + $ret = 0; |
|
318 | + $args = array( |
|
319 | + 'meta_key' => '_wpinv_gateway', |
|
320 | + 'meta_value' => $gateway_id, |
|
321 | + 'nopaging' => true, |
|
322 | + 'post_type' => 'wpi_invoice', |
|
323 | + 'post_status' => $status, |
|
324 | + 'fields' => 'ids' |
|
325 | + ); |
|
326 | + |
|
327 | + $payments = new WP_Query( $args ); |
|
328 | + |
|
329 | + if( $payments ) |
|
330 | + $ret = $payments->post_count; |
|
331 | + return $ret; |
|
332 | 332 | } |
333 | 333 | |
334 | 334 | /** |
@@ -13,464 +13,464 @@ discard block |
||
13 | 13 | */ |
14 | 14 | abstract class GetPaid_Payment_Gateway { |
15 | 15 | |
16 | - /** |
|
17 | - * Set if the place checkout button should be renamed on selection. |
|
18 | - * |
|
19 | - * @var string |
|
20 | - */ |
|
21 | - public $checkout_button_text; |
|
22 | - |
|
23 | - /** |
|
24 | - * Boolean whether the method is enabled. |
|
25 | - * |
|
26 | - * @var bool |
|
27 | - */ |
|
28 | - public $enabled = true; |
|
29 | - |
|
30 | - /** |
|
31 | - * Payment method id. |
|
32 | - * |
|
33 | - * @var string |
|
34 | - */ |
|
35 | - public $id; |
|
36 | - |
|
37 | - /** |
|
38 | - * Payment method order. |
|
39 | - * |
|
40 | - * @var int |
|
41 | - */ |
|
42 | - public $order = 10; |
|
43 | - |
|
44 | - /** |
|
45 | - * Payment method title for the frontend. |
|
46 | - * |
|
47 | - * @var string |
|
48 | - */ |
|
49 | - public $title; |
|
50 | - |
|
51 | - /** |
|
52 | - * Payment method description for the frontend. |
|
53 | - * |
|
54 | - * @var string |
|
55 | - */ |
|
56 | - public $description; |
|
57 | - |
|
58 | - /** |
|
59 | - * Gateway title. |
|
60 | - * |
|
61 | - * @var string |
|
62 | - */ |
|
63 | - public $method_title = ''; |
|
64 | - |
|
65 | - /** |
|
66 | - * Gateway description. |
|
67 | - * |
|
68 | - * @var string |
|
69 | - */ |
|
70 | - public $method_description = ''; |
|
71 | - |
|
72 | - /** |
|
73 | - * Countries this gateway is allowed for. |
|
74 | - * |
|
75 | - * @var array |
|
76 | - */ |
|
77 | - public $countries; |
|
78 | - |
|
79 | - /** |
|
80 | - * Currencies this gateway is allowed for. |
|
81 | - * |
|
82 | - * @var array |
|
83 | - */ |
|
84 | - public $currencies; |
|
85 | - |
|
86 | - /** |
|
87 | - * Currencies this gateway is not allowed for. |
|
88 | - * |
|
89 | - * @var array |
|
90 | - */ |
|
91 | - public $exclude_currencies; |
|
92 | - |
|
93 | - /** |
|
94 | - * Maximum transaction amount, zero does not define a maximum. |
|
95 | - * |
|
96 | - * @var int |
|
97 | - */ |
|
98 | - public $max_amount = 0; |
|
99 | - |
|
100 | - /** |
|
101 | - * Optional URL to view a transaction. |
|
102 | - * |
|
103 | - * @var string |
|
104 | - */ |
|
105 | - public $view_transaction_url = ''; |
|
106 | - |
|
107 | - /** |
|
108 | - * Optional URL to view a subscription. |
|
109 | - * |
|
110 | - * @var string |
|
111 | - */ |
|
112 | - public $view_subscription_url = ''; |
|
113 | - |
|
114 | - /** |
|
115 | - * Optional label to show for "new payment method" in the payment |
|
116 | - * method/token selection radio selection. |
|
117 | - * |
|
118 | - * @var string |
|
119 | - */ |
|
120 | - public $new_method_label = ''; |
|
121 | - |
|
122 | - /** |
|
123 | - * Contains a user's saved tokens for this gateway. |
|
124 | - * |
|
125 | - * @var array |
|
126 | - */ |
|
127 | - protected $tokens = array(); |
|
128 | - |
|
129 | - /** |
|
130 | - * An array of features that this gateway supports. |
|
131 | - * |
|
132 | - * @var array |
|
133 | - */ |
|
134 | - protected $supports = array(); |
|
135 | - |
|
136 | - /** |
|
137 | - * Class constructor. |
|
138 | - */ |
|
139 | - public function __construct() { |
|
140 | - |
|
141 | - // Register gateway. |
|
142 | - add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) ); |
|
143 | - |
|
144 | - $this->enabled = wpinv_is_gateway_active( $this->id ); |
|
145 | - |
|
146 | - // Add support for various features. |
|
147 | - foreach ( $this->supports as $feature ) { |
|
148 | - add_filter( "wpinv_{$this->id}_support_{$feature}", '__return_true' ); |
|
149 | - add_filter( "getpaid_{$this->id}_support_{$feature}", '__return_true' ); |
|
150 | - add_filter( "getpaid_{$this->id}_supports_{$feature}", '__return_true' ); |
|
151 | - } |
|
152 | - |
|
153 | - // Invoice addons. |
|
154 | - if ( $this->supports( 'addons' ) ) { |
|
155 | - add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 ); |
|
156 | - } |
|
157 | - |
|
158 | - // Gateway settings. |
|
159 | - add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) ); |
|
16 | + /** |
|
17 | + * Set if the place checkout button should be renamed on selection. |
|
18 | + * |
|
19 | + * @var string |
|
20 | + */ |
|
21 | + public $checkout_button_text; |
|
22 | + |
|
23 | + /** |
|
24 | + * Boolean whether the method is enabled. |
|
25 | + * |
|
26 | + * @var bool |
|
27 | + */ |
|
28 | + public $enabled = true; |
|
29 | + |
|
30 | + /** |
|
31 | + * Payment method id. |
|
32 | + * |
|
33 | + * @var string |
|
34 | + */ |
|
35 | + public $id; |
|
36 | + |
|
37 | + /** |
|
38 | + * Payment method order. |
|
39 | + * |
|
40 | + * @var int |
|
41 | + */ |
|
42 | + public $order = 10; |
|
43 | + |
|
44 | + /** |
|
45 | + * Payment method title for the frontend. |
|
46 | + * |
|
47 | + * @var string |
|
48 | + */ |
|
49 | + public $title; |
|
50 | + |
|
51 | + /** |
|
52 | + * Payment method description for the frontend. |
|
53 | + * |
|
54 | + * @var string |
|
55 | + */ |
|
56 | + public $description; |
|
57 | + |
|
58 | + /** |
|
59 | + * Gateway title. |
|
60 | + * |
|
61 | + * @var string |
|
62 | + */ |
|
63 | + public $method_title = ''; |
|
64 | + |
|
65 | + /** |
|
66 | + * Gateway description. |
|
67 | + * |
|
68 | + * @var string |
|
69 | + */ |
|
70 | + public $method_description = ''; |
|
71 | + |
|
72 | + /** |
|
73 | + * Countries this gateway is allowed for. |
|
74 | + * |
|
75 | + * @var array |
|
76 | + */ |
|
77 | + public $countries; |
|
78 | + |
|
79 | + /** |
|
80 | + * Currencies this gateway is allowed for. |
|
81 | + * |
|
82 | + * @var array |
|
83 | + */ |
|
84 | + public $currencies; |
|
85 | + |
|
86 | + /** |
|
87 | + * Currencies this gateway is not allowed for. |
|
88 | + * |
|
89 | + * @var array |
|
90 | + */ |
|
91 | + public $exclude_currencies; |
|
92 | + |
|
93 | + /** |
|
94 | + * Maximum transaction amount, zero does not define a maximum. |
|
95 | + * |
|
96 | + * @var int |
|
97 | + */ |
|
98 | + public $max_amount = 0; |
|
99 | + |
|
100 | + /** |
|
101 | + * Optional URL to view a transaction. |
|
102 | + * |
|
103 | + * @var string |
|
104 | + */ |
|
105 | + public $view_transaction_url = ''; |
|
106 | + |
|
107 | + /** |
|
108 | + * Optional URL to view a subscription. |
|
109 | + * |
|
110 | + * @var string |
|
111 | + */ |
|
112 | + public $view_subscription_url = ''; |
|
113 | + |
|
114 | + /** |
|
115 | + * Optional label to show for "new payment method" in the payment |
|
116 | + * method/token selection radio selection. |
|
117 | + * |
|
118 | + * @var string |
|
119 | + */ |
|
120 | + public $new_method_label = ''; |
|
121 | + |
|
122 | + /** |
|
123 | + * Contains a user's saved tokens for this gateway. |
|
124 | + * |
|
125 | + * @var array |
|
126 | + */ |
|
127 | + protected $tokens = array(); |
|
128 | + |
|
129 | + /** |
|
130 | + * An array of features that this gateway supports. |
|
131 | + * |
|
132 | + * @var array |
|
133 | + */ |
|
134 | + protected $supports = array(); |
|
135 | + |
|
136 | + /** |
|
137 | + * Class constructor. |
|
138 | + */ |
|
139 | + public function __construct() { |
|
140 | + |
|
141 | + // Register gateway. |
|
142 | + add_filter( 'wpinv_payment_gateways', array( $this, 'register_gateway' ) ); |
|
143 | + |
|
144 | + $this->enabled = wpinv_is_gateway_active( $this->id ); |
|
145 | + |
|
146 | + // Add support for various features. |
|
147 | + foreach ( $this->supports as $feature ) { |
|
148 | + add_filter( "wpinv_{$this->id}_support_{$feature}", '__return_true' ); |
|
149 | + add_filter( "getpaid_{$this->id}_support_{$feature}", '__return_true' ); |
|
150 | + add_filter( "getpaid_{$this->id}_supports_{$feature}", '__return_true' ); |
|
151 | + } |
|
152 | + |
|
153 | + // Invoice addons. |
|
154 | + if ( $this->supports( 'addons' ) ) { |
|
155 | + add_action( "getpaid_process_{$this->id}_invoice_addons", array( $this, 'process_addons' ), 10, 2 ); |
|
156 | + } |
|
157 | + |
|
158 | + // Gateway settings. |
|
159 | + add_filter( "wpinv_gateway_settings_{$this->id}", array( $this, 'admin_settings' ) ); |
|
160 | 160 | |
161 | 161 | |
162 | - // Gateway checkout fiellds. |
|
163 | - add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 ); |
|
164 | - |
|
165 | - // Process payment. |
|
166 | - add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 ); |
|
167 | - |
|
168 | - // Change the checkout button text. |
|
169 | - if ( ! empty( $this->checkout_button_text ) ) { |
|
170 | - add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) ); |
|
171 | - } |
|
172 | - |
|
173 | - // Check if a gateway is valid for a given currency. |
|
174 | - add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 ); |
|
175 | - |
|
176 | - // Generate the transaction url. |
|
177 | - add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 ); |
|
178 | - |
|
179 | - // Generate the subscription url. |
|
180 | - add_filter( 'getpaid_remote_subscription_profile_url', array( $this, 'generate_subscription_url' ), 10, 2 ); |
|
181 | - |
|
182 | - // Confirm payments. |
|
183 | - add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 ); |
|
184 | - |
|
185 | - // Verify IPNs. |
|
186 | - add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) ); |
|
187 | - |
|
188 | - } |
|
189 | - |
|
190 | - /** |
|
191 | - * Checks if this gateway is a given gateway. |
|
192 | - * |
|
193 | - * @since 1.0.19 |
|
194 | - * @return bool |
|
195 | - */ |
|
196 | - public function is( $gateway ) { |
|
197 | - return $gateway == $this->id; |
|
198 | - } |
|
199 | - |
|
200 | - /** |
|
201 | - * Returns a users saved tokens for this gateway. |
|
202 | - * |
|
203 | - * @since 1.0.19 |
|
204 | - * @return array |
|
205 | - */ |
|
206 | - public function get_tokens( $sandbox = null ) { |
|
207 | - |
|
208 | - if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) { |
|
209 | - $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true ); |
|
210 | - |
|
211 | - if ( is_array( $tokens ) ) { |
|
212 | - $this->tokens = $tokens; |
|
213 | - } |
|
214 | - |
|
215 | - } |
|
216 | - |
|
217 | - if ( ! is_bool( $sandbox ) ) { |
|
218 | - return $this->tokens; |
|
219 | - } |
|
220 | - |
|
221 | - // Filter tokens. |
|
222 | - $args = array( 'type' => $sandbox ? 'sandbox' : 'live' ); |
|
223 | - return wp_list_filter( $this->tokens, $args ); |
|
224 | - |
|
225 | - } |
|
226 | - |
|
227 | - /** |
|
228 | - * Saves a token for this gateway. |
|
229 | - * |
|
230 | - * @since 1.0.19 |
|
231 | - */ |
|
232 | - public function save_token( $token ) { |
|
233 | - |
|
234 | - $tokens = $this->get_tokens(); |
|
235 | - $tokens[] = $token; |
|
236 | - |
|
237 | - update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens ); |
|
238 | - |
|
239 | - $this->tokens = $tokens; |
|
240 | - |
|
241 | - } |
|
242 | - |
|
243 | - /** |
|
244 | - * Return the title for admin screens. |
|
245 | - * |
|
246 | - * @return string |
|
247 | - */ |
|
248 | - public function get_method_title() { |
|
249 | - return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this ); |
|
250 | - } |
|
251 | - |
|
252 | - /** |
|
253 | - * Return the description for admin screens. |
|
254 | - * |
|
255 | - * @return string |
|
256 | - */ |
|
257 | - public function get_method_description() { |
|
258 | - return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this ); |
|
259 | - } |
|
260 | - |
|
261 | - /** |
|
262 | - * Get the success url. |
|
263 | - * |
|
264 | - * @param WPInv_Invoice $invoice Invoice object. |
|
265 | - * @return string |
|
266 | - */ |
|
267 | - public function get_return_url( $invoice ) { |
|
268 | - |
|
269 | - // Payment success url |
|
270 | - $return_url = add_query_arg( |
|
271 | - array( |
|
272 | - 'payment-confirm' => $this->id, |
|
273 | - 'invoice_key' => $invoice->get_key(), |
|
274 | - 'utm_nooverride' => 1 |
|
275 | - ), |
|
276 | - wpinv_get_success_page_uri() |
|
277 | - ); |
|
278 | - |
|
279 | - return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this ); |
|
280 | - } |
|
281 | - |
|
282 | - /** |
|
283 | - * Confirms payments when rendering the success page. |
|
284 | - * |
|
285 | - * @param string $content Success page content. |
|
286 | - * @return string |
|
287 | - */ |
|
288 | - public function confirm_payment( $content ) { |
|
289 | - |
|
290 | - // Retrieve the invoice. |
|
291 | - $invoice_id = getpaid_get_current_invoice_id(); |
|
292 | - $invoice = wpinv_get_invoice( $invoice_id ); |
|
293 | - |
|
294 | - // Ensure that it exists and that it is pending payment. |
|
295 | - if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) { |
|
296 | - return $content; |
|
297 | - } |
|
298 | - |
|
299 | - // Can the user view this invoice?? |
|
300 | - if ( ! wpinv_user_can_view_invoice( $invoice ) ) { |
|
301 | - return $content; |
|
302 | - } |
|
303 | - |
|
304 | - // Show payment processing indicator. |
|
305 | - return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) ); |
|
306 | - } |
|
307 | - |
|
308 | - /** |
|
309 | - * Processes ipns and marks payments as complete. |
|
310 | - * |
|
311 | - * @return void |
|
312 | - */ |
|
313 | - public function verify_ipn() {} |
|
314 | - |
|
315 | - /** |
|
316 | - * Processes invoice addons. |
|
317 | - * |
|
318 | - * @param WPInv_Invoice $invoice |
|
319 | - * @param GetPaid_Form_Item[] $items |
|
320 | - * @return WPInv_Invoice |
|
321 | - */ |
|
322 | - public function process_addons( $invoice, $items ) { |
|
323 | - |
|
324 | - } |
|
325 | - |
|
326 | - /** |
|
327 | - * Get a link to the transaction on the 3rd party gateway site (if applicable). |
|
328 | - * |
|
329 | - * @param string $transaction_url transaction url. |
|
330 | - * @param WPInv_Invoice $invoice Invoice object. |
|
331 | - * @return string transaction URL, or empty string. |
|
332 | - */ |
|
333 | - public function filter_transaction_url( $transaction_url, $invoice ) { |
|
334 | - |
|
335 | - $transaction_id = $invoice->get_transaction_id(); |
|
336 | - |
|
337 | - if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) { |
|
338 | - $transaction_url = sprintf( $this->view_transaction_url, $transaction_id ); |
|
339 | - $replace = $this->is_sandbox( $invoice ) ? 'sandbox' : ''; |
|
340 | - $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url ); |
|
341 | - } |
|
342 | - |
|
343 | - return $transaction_url; |
|
344 | - } |
|
345 | - |
|
346 | - /** |
|
347 | - * Get a link to the subscription on the 3rd party gateway site (if applicable). |
|
348 | - * |
|
349 | - * @param string $subscription_url transaction url. |
|
350 | - * @param WPInv_Subscription $subscription Subscription objectt. |
|
351 | - * @return string subscription URL, or empty string. |
|
352 | - */ |
|
353 | - public function generate_subscription_url( $subscription_url, $subscription ) { |
|
354 | - |
|
355 | - $profile_id = $subscription->get_profile_id(); |
|
356 | - |
|
357 | - if ( $this->id == $subscription->get_gateway() && ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) { |
|
358 | - |
|
359 | - $subscription_url = sprintf( $this->view_subscription_url, $profile_id ); |
|
360 | - $replace = $this->is_sandbox( $subscription->get_parent_invoice() ) ? 'sandbox' : ''; |
|
361 | - $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url ); |
|
362 | - |
|
363 | - } |
|
364 | - |
|
365 | - return $subscription_url; |
|
366 | - } |
|
367 | - |
|
368 | - /** |
|
369 | - * Check if the gateway is available for use. |
|
370 | - * |
|
371 | - * @return bool |
|
372 | - */ |
|
373 | - public function is_available() { |
|
374 | - return ! empty( $this->enabled ); |
|
375 | - } |
|
376 | - |
|
377 | - /** |
|
378 | - * Return the gateway's title. |
|
379 | - * |
|
380 | - * @return string |
|
381 | - */ |
|
382 | - public function get_title() { |
|
383 | - return apply_filters( 'getpaid_gateway_title', $this->title, $this ); |
|
384 | - } |
|
385 | - |
|
386 | - /** |
|
387 | - * Return the gateway's description. |
|
388 | - * |
|
389 | - * @return string |
|
390 | - */ |
|
391 | - public function get_description() { |
|
392 | - return apply_filters( 'getpaid_gateway_description', $this->description, $this ); |
|
393 | - } |
|
394 | - |
|
395 | - /** |
|
396 | - * Process Payment. |
|
397 | - * |
|
398 | - * |
|
399 | - * @param WPInv_Invoice $invoice Invoice. |
|
400 | - * @param array $submission_data Posted checkout fields. |
|
401 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
402 | - * @return void |
|
403 | - */ |
|
404 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
405 | - // Process the payment then either redirect to the success page or the gateway. |
|
406 | - do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission ); |
|
407 | - } |
|
408 | - |
|
409 | - /** |
|
410 | - * Process refund. |
|
411 | - * |
|
412 | - * If the gateway declares 'refunds' support, this will allow it to refund. |
|
413 | - * a passed in amount. |
|
414 | - * |
|
415 | - * @param WPInv_Invoice $invoice Invoice. |
|
416 | - * @param float $amount Refund amount. |
|
417 | - * @param string $reason Refund reason. |
|
418 | - * @return WP_Error|bool True or false based on success, or a WP_Error object. |
|
419 | - */ |
|
420 | - public function process_refund( $invoice, $amount = null, $reason = '' ) { |
|
421 | - return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason ); |
|
422 | - } |
|
423 | - |
|
424 | - /** |
|
425 | - * Displays the payment fields, credit cards etc. |
|
426 | - * |
|
427 | - * @param int $invoice_id 0 or invoice id. |
|
428 | - * @param GetPaid_Payment_Form $form Current payment form. |
|
429 | - */ |
|
430 | - public function payment_fields( $invoice_id, $form ) { |
|
431 | - do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form ); |
|
432 | - } |
|
433 | - |
|
434 | - /** |
|
435 | - * Filters the gateway settings. |
|
436 | - * |
|
437 | - * @param array $admin_settings |
|
438 | - */ |
|
439 | - public function admin_settings( $admin_settings ) { |
|
440 | - return $admin_settings; |
|
441 | - } |
|
442 | - |
|
443 | - /** |
|
444 | - * Retrieves the value of a gateway setting. |
|
445 | - * |
|
446 | - * @param string $option |
|
447 | - */ |
|
448 | - public function get_option( $option, $default = false ) { |
|
449 | - return wpinv_get_option( $this->id . '_' . $option, $default ); |
|
450 | - } |
|
451 | - |
|
452 | - /** |
|
453 | - * Check if a gateway supports a given feature. |
|
454 | - * |
|
455 | - * Gateways should override this to declare support (or lack of support) for a feature. |
|
456 | - * For backward compatibility, gateways support 'products' by default, but nothing else. |
|
457 | - * |
|
458 | - * @param string $feature string The name of a feature to test support for. |
|
459 | - * @return bool True if the gateway supports the feature, false otherwise. |
|
460 | - * @since 1.0.19 |
|
461 | - */ |
|
462 | - public function supports( $feature ) { |
|
463 | - return getpaid_payment_gateway_supports( $this->id, $feature ); |
|
464 | - } |
|
465 | - |
|
466 | - /** |
|
467 | - * Returns the credit card form html. |
|
468 | - * |
|
469 | - * @param bool $save whether or not to display the save button. |
|
470 | - */ |
|
162 | + // Gateway checkout fiellds. |
|
163 | + add_action( "wpinv_{$this->id}_cc_form", array( $this, 'payment_fields' ), 10, 2 ); |
|
164 | + |
|
165 | + // Process payment. |
|
166 | + add_action( "getpaid_gateway_{$this->id}", array( $this, 'process_payment' ), 10, 3 ); |
|
167 | + |
|
168 | + // Change the checkout button text. |
|
169 | + if ( ! empty( $this->checkout_button_text ) ) { |
|
170 | + add_filter( "getpaid_gateway_{$this->id}_checkout_button_label", array( $this, 'rename_checkout_button' ) ); |
|
171 | + } |
|
172 | + |
|
173 | + // Check if a gateway is valid for a given currency. |
|
174 | + add_filter( "getpaid_gateway_{$this->id}_is_valid_for_currency", array( $this, 'validate_currency' ), 10, 2 ); |
|
175 | + |
|
176 | + // Generate the transaction url. |
|
177 | + add_filter( "getpaid_gateway_{$this->id}_transaction_url", array( $this, 'filter_transaction_url' ), 10, 2 ); |
|
178 | + |
|
179 | + // Generate the subscription url. |
|
180 | + add_filter( 'getpaid_remote_subscription_profile_url', array( $this, 'generate_subscription_url' ), 10, 2 ); |
|
181 | + |
|
182 | + // Confirm payments. |
|
183 | + add_filter( "wpinv_payment_confirm_{$this->id}", array( $this, 'confirm_payment' ), 10, 2 ); |
|
184 | + |
|
185 | + // Verify IPNs. |
|
186 | + add_action( "wpinv_verify_{$this->id}_ipn", array( $this, 'verify_ipn' ) ); |
|
187 | + |
|
188 | + } |
|
189 | + |
|
190 | + /** |
|
191 | + * Checks if this gateway is a given gateway. |
|
192 | + * |
|
193 | + * @since 1.0.19 |
|
194 | + * @return bool |
|
195 | + */ |
|
196 | + public function is( $gateway ) { |
|
197 | + return $gateway == $this->id; |
|
198 | + } |
|
199 | + |
|
200 | + /** |
|
201 | + * Returns a users saved tokens for this gateway. |
|
202 | + * |
|
203 | + * @since 1.0.19 |
|
204 | + * @return array |
|
205 | + */ |
|
206 | + public function get_tokens( $sandbox = null ) { |
|
207 | + |
|
208 | + if ( is_user_logged_in() && $this->supports( 'tokens' ) && 0 == count( $this->tokens ) ) { |
|
209 | + $tokens = get_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", true ); |
|
210 | + |
|
211 | + if ( is_array( $tokens ) ) { |
|
212 | + $this->tokens = $tokens; |
|
213 | + } |
|
214 | + |
|
215 | + } |
|
216 | + |
|
217 | + if ( ! is_bool( $sandbox ) ) { |
|
218 | + return $this->tokens; |
|
219 | + } |
|
220 | + |
|
221 | + // Filter tokens. |
|
222 | + $args = array( 'type' => $sandbox ? 'sandbox' : 'live' ); |
|
223 | + return wp_list_filter( $this->tokens, $args ); |
|
224 | + |
|
225 | + } |
|
226 | + |
|
227 | + /** |
|
228 | + * Saves a token for this gateway. |
|
229 | + * |
|
230 | + * @since 1.0.19 |
|
231 | + */ |
|
232 | + public function save_token( $token ) { |
|
233 | + |
|
234 | + $tokens = $this->get_tokens(); |
|
235 | + $tokens[] = $token; |
|
236 | + |
|
237 | + update_user_meta( get_current_user_id(), "getpaid_{$this->id}_tokens", $tokens ); |
|
238 | + |
|
239 | + $this->tokens = $tokens; |
|
240 | + |
|
241 | + } |
|
242 | + |
|
243 | + /** |
|
244 | + * Return the title for admin screens. |
|
245 | + * |
|
246 | + * @return string |
|
247 | + */ |
|
248 | + public function get_method_title() { |
|
249 | + return apply_filters( 'getpaid_gateway_method_title', $this->method_title, $this ); |
|
250 | + } |
|
251 | + |
|
252 | + /** |
|
253 | + * Return the description for admin screens. |
|
254 | + * |
|
255 | + * @return string |
|
256 | + */ |
|
257 | + public function get_method_description() { |
|
258 | + return apply_filters( 'getpaid_gateway_method_description', $this->method_description, $this ); |
|
259 | + } |
|
260 | + |
|
261 | + /** |
|
262 | + * Get the success url. |
|
263 | + * |
|
264 | + * @param WPInv_Invoice $invoice Invoice object. |
|
265 | + * @return string |
|
266 | + */ |
|
267 | + public function get_return_url( $invoice ) { |
|
268 | + |
|
269 | + // Payment success url |
|
270 | + $return_url = add_query_arg( |
|
271 | + array( |
|
272 | + 'payment-confirm' => $this->id, |
|
273 | + 'invoice_key' => $invoice->get_key(), |
|
274 | + 'utm_nooverride' => 1 |
|
275 | + ), |
|
276 | + wpinv_get_success_page_uri() |
|
277 | + ); |
|
278 | + |
|
279 | + return apply_filters( 'getpaid_gateway_success_url', $return_url, $invoice, $this ); |
|
280 | + } |
|
281 | + |
|
282 | + /** |
|
283 | + * Confirms payments when rendering the success page. |
|
284 | + * |
|
285 | + * @param string $content Success page content. |
|
286 | + * @return string |
|
287 | + */ |
|
288 | + public function confirm_payment( $content ) { |
|
289 | + |
|
290 | + // Retrieve the invoice. |
|
291 | + $invoice_id = getpaid_get_current_invoice_id(); |
|
292 | + $invoice = wpinv_get_invoice( $invoice_id ); |
|
293 | + |
|
294 | + // Ensure that it exists and that it is pending payment. |
|
295 | + if ( empty( $invoice_id ) || ! $invoice->needs_payment() ) { |
|
296 | + return $content; |
|
297 | + } |
|
298 | + |
|
299 | + // Can the user view this invoice?? |
|
300 | + if ( ! wpinv_user_can_view_invoice( $invoice ) ) { |
|
301 | + return $content; |
|
302 | + } |
|
303 | + |
|
304 | + // Show payment processing indicator. |
|
305 | + return wpinv_get_template_html( 'wpinv-payment-processing.php', compact( 'invoice' ) ); |
|
306 | + } |
|
307 | + |
|
308 | + /** |
|
309 | + * Processes ipns and marks payments as complete. |
|
310 | + * |
|
311 | + * @return void |
|
312 | + */ |
|
313 | + public function verify_ipn() {} |
|
314 | + |
|
315 | + /** |
|
316 | + * Processes invoice addons. |
|
317 | + * |
|
318 | + * @param WPInv_Invoice $invoice |
|
319 | + * @param GetPaid_Form_Item[] $items |
|
320 | + * @return WPInv_Invoice |
|
321 | + */ |
|
322 | + public function process_addons( $invoice, $items ) { |
|
323 | + |
|
324 | + } |
|
325 | + |
|
326 | + /** |
|
327 | + * Get a link to the transaction on the 3rd party gateway site (if applicable). |
|
328 | + * |
|
329 | + * @param string $transaction_url transaction url. |
|
330 | + * @param WPInv_Invoice $invoice Invoice object. |
|
331 | + * @return string transaction URL, or empty string. |
|
332 | + */ |
|
333 | + public function filter_transaction_url( $transaction_url, $invoice ) { |
|
334 | + |
|
335 | + $transaction_id = $invoice->get_transaction_id(); |
|
336 | + |
|
337 | + if ( ! empty( $this->view_transaction_url ) && ! empty( $transaction_id ) ) { |
|
338 | + $transaction_url = sprintf( $this->view_transaction_url, $transaction_id ); |
|
339 | + $replace = $this->is_sandbox( $invoice ) ? 'sandbox' : ''; |
|
340 | + $transaction_url = str_replace( '{sandbox}', $replace, $transaction_url ); |
|
341 | + } |
|
342 | + |
|
343 | + return $transaction_url; |
|
344 | + } |
|
345 | + |
|
346 | + /** |
|
347 | + * Get a link to the subscription on the 3rd party gateway site (if applicable). |
|
348 | + * |
|
349 | + * @param string $subscription_url transaction url. |
|
350 | + * @param WPInv_Subscription $subscription Subscription objectt. |
|
351 | + * @return string subscription URL, or empty string. |
|
352 | + */ |
|
353 | + public function generate_subscription_url( $subscription_url, $subscription ) { |
|
354 | + |
|
355 | + $profile_id = $subscription->get_profile_id(); |
|
356 | + |
|
357 | + if ( $this->id == $subscription->get_gateway() && ! empty( $this->view_subscription_url ) && ! empty( $profile_id ) ) { |
|
358 | + |
|
359 | + $subscription_url = sprintf( $this->view_subscription_url, $profile_id ); |
|
360 | + $replace = $this->is_sandbox( $subscription->get_parent_invoice() ) ? 'sandbox' : ''; |
|
361 | + $subscription_url = str_replace( '{sandbox}', $replace, $subscription_url ); |
|
362 | + |
|
363 | + } |
|
364 | + |
|
365 | + return $subscription_url; |
|
366 | + } |
|
367 | + |
|
368 | + /** |
|
369 | + * Check if the gateway is available for use. |
|
370 | + * |
|
371 | + * @return bool |
|
372 | + */ |
|
373 | + public function is_available() { |
|
374 | + return ! empty( $this->enabled ); |
|
375 | + } |
|
376 | + |
|
377 | + /** |
|
378 | + * Return the gateway's title. |
|
379 | + * |
|
380 | + * @return string |
|
381 | + */ |
|
382 | + public function get_title() { |
|
383 | + return apply_filters( 'getpaid_gateway_title', $this->title, $this ); |
|
384 | + } |
|
385 | + |
|
386 | + /** |
|
387 | + * Return the gateway's description. |
|
388 | + * |
|
389 | + * @return string |
|
390 | + */ |
|
391 | + public function get_description() { |
|
392 | + return apply_filters( 'getpaid_gateway_description', $this->description, $this ); |
|
393 | + } |
|
394 | + |
|
395 | + /** |
|
396 | + * Process Payment. |
|
397 | + * |
|
398 | + * |
|
399 | + * @param WPInv_Invoice $invoice Invoice. |
|
400 | + * @param array $submission_data Posted checkout fields. |
|
401 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
402 | + * @return void |
|
403 | + */ |
|
404 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
405 | + // Process the payment then either redirect to the success page or the gateway. |
|
406 | + do_action( 'getpaid_process_invoice_payment_' . $this->id, $invoice, $submission_data, $submission ); |
|
407 | + } |
|
408 | + |
|
409 | + /** |
|
410 | + * Process refund. |
|
411 | + * |
|
412 | + * If the gateway declares 'refunds' support, this will allow it to refund. |
|
413 | + * a passed in amount. |
|
414 | + * |
|
415 | + * @param WPInv_Invoice $invoice Invoice. |
|
416 | + * @param float $amount Refund amount. |
|
417 | + * @param string $reason Refund reason. |
|
418 | + * @return WP_Error|bool True or false based on success, or a WP_Error object. |
|
419 | + */ |
|
420 | + public function process_refund( $invoice, $amount = null, $reason = '' ) { |
|
421 | + return apply_filters( 'getpaid_process_invoice_refund_' . $this->id, false, $invoice, $amount, $reason ); |
|
422 | + } |
|
423 | + |
|
424 | + /** |
|
425 | + * Displays the payment fields, credit cards etc. |
|
426 | + * |
|
427 | + * @param int $invoice_id 0 or invoice id. |
|
428 | + * @param GetPaid_Payment_Form $form Current payment form. |
|
429 | + */ |
|
430 | + public function payment_fields( $invoice_id, $form ) { |
|
431 | + do_action( 'getpaid_getpaid_gateway_payment_fields_' . $this->id, $invoice_id, $form ); |
|
432 | + } |
|
433 | + |
|
434 | + /** |
|
435 | + * Filters the gateway settings. |
|
436 | + * |
|
437 | + * @param array $admin_settings |
|
438 | + */ |
|
439 | + public function admin_settings( $admin_settings ) { |
|
440 | + return $admin_settings; |
|
441 | + } |
|
442 | + |
|
443 | + /** |
|
444 | + * Retrieves the value of a gateway setting. |
|
445 | + * |
|
446 | + * @param string $option |
|
447 | + */ |
|
448 | + public function get_option( $option, $default = false ) { |
|
449 | + return wpinv_get_option( $this->id . '_' . $option, $default ); |
|
450 | + } |
|
451 | + |
|
452 | + /** |
|
453 | + * Check if a gateway supports a given feature. |
|
454 | + * |
|
455 | + * Gateways should override this to declare support (or lack of support) for a feature. |
|
456 | + * For backward compatibility, gateways support 'products' by default, but nothing else. |
|
457 | + * |
|
458 | + * @param string $feature string The name of a feature to test support for. |
|
459 | + * @return bool True if the gateway supports the feature, false otherwise. |
|
460 | + * @since 1.0.19 |
|
461 | + */ |
|
462 | + public function supports( $feature ) { |
|
463 | + return getpaid_payment_gateway_supports( $this->id, $feature ); |
|
464 | + } |
|
465 | + |
|
466 | + /** |
|
467 | + * Returns the credit card form html. |
|
468 | + * |
|
469 | + * @param bool $save whether or not to display the save button. |
|
470 | + */ |
|
471 | 471 | public function get_cc_form( $save = false ) { |
472 | 472 | |
473 | - ob_start(); |
|
473 | + ob_start(); |
|
474 | 474 | |
475 | 475 | $id_prefix = esc_attr( uniqid( $this->id ) ); |
476 | 476 | |
@@ -565,11 +565,11 @@ discard block |
||
565 | 565 | 'name' => $this->id . '[cc_cvv2]', |
566 | 566 | 'id' => "$id_prefix-cc-cvv2", |
567 | 567 | 'label' => __( 'CCV', 'invoicing' ), |
568 | - 'label_type' => 'vertical', |
|
569 | - 'class' => 'form-control-sm', |
|
570 | - 'extra_attributes' => array( |
|
571 | - 'autocomplete' => "cc-csc", |
|
572 | - ), |
|
568 | + 'label_type' => 'vertical', |
|
569 | + 'class' => 'form-control-sm', |
|
570 | + 'extra_attributes' => array( |
|
571 | + 'autocomplete' => "cc-csc", |
|
572 | + ), |
|
573 | 573 | ) |
574 | 574 | ); |
575 | 575 | ?> |
@@ -579,192 +579,192 @@ discard block |
||
579 | 579 | |
580 | 580 | <?php |
581 | 581 | |
582 | - if ( $save ) { |
|
583 | - echo $this->save_payment_method_checkbox(); |
|
584 | - } |
|
582 | + if ( $save ) { |
|
583 | + echo $this->save_payment_method_checkbox(); |
|
584 | + } |
|
585 | 585 | |
586 | - ?> |
|
586 | + ?> |
|
587 | 587 | </div> |
588 | 588 | |
589 | 589 | </div> |
590 | 590 | <?php |
591 | 591 | |
592 | - return ob_get_clean(); |
|
592 | + return ob_get_clean(); |
|
593 | + |
|
594 | + } |
|
593 | 595 | |
596 | + /** |
|
597 | + * Displays a new payment method entry form. |
|
598 | + * |
|
599 | + * @since 1.0.19 |
|
600 | + */ |
|
601 | + public function new_payment_method_entry( $form ) { |
|
602 | + echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>"; |
|
594 | 603 | } |
595 | 604 | |
596 | - /** |
|
597 | - * Displays a new payment method entry form. |
|
598 | - * |
|
599 | - * @since 1.0.19 |
|
600 | - */ |
|
601 | - public function new_payment_method_entry( $form ) { |
|
602 | - echo "<div class='getpaid-new-payment-method-form' style='display:none;'>$form</div>"; |
|
603 | - } |
|
604 | - |
|
605 | - /** |
|
606 | - * Grab and display our saved payment methods. |
|
607 | - * |
|
608 | - * @since 1.0.19 |
|
609 | - */ |
|
610 | - public function saved_payment_methods() { |
|
611 | - $html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">'; |
|
612 | - |
|
613 | - foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) { |
|
614 | - $html .= $this->get_saved_payment_method_option_html( $token ); |
|
615 | - } |
|
616 | - |
|
617 | - $html .= $this->get_new_payment_method_option_html(); |
|
618 | - $html .= '</ul>'; |
|
619 | - |
|
620 | - echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this ); |
|
621 | - } |
|
622 | - |
|
623 | - /** |
|
624 | - * Gets saved payment method HTML from a token. |
|
625 | - * |
|
626 | - * @since 1.0.19 |
|
627 | - * @param array $token Payment Token. |
|
628 | - * @return string Generated payment method HTML |
|
629 | - */ |
|
630 | - public function get_saved_payment_method_option_html( $token ) { |
|
631 | - |
|
632 | - return sprintf( |
|
633 | - '<li class="getpaid-payment-method form-group"> |
|
605 | + /** |
|
606 | + * Grab and display our saved payment methods. |
|
607 | + * |
|
608 | + * @since 1.0.19 |
|
609 | + */ |
|
610 | + public function saved_payment_methods() { |
|
611 | + $html = '<ul class="getpaid-saved-payment-methods list-unstyled m-0 mt-2" data-count="' . esc_attr( count( $this->get_tokens( $this->is_sandbox() ) ) ) . '">'; |
|
612 | + |
|
613 | + foreach ( $this->get_tokens( $this->is_sandbox() ) as $token ) { |
|
614 | + $html .= $this->get_saved_payment_method_option_html( $token ); |
|
615 | + } |
|
616 | + |
|
617 | + $html .= $this->get_new_payment_method_option_html(); |
|
618 | + $html .= '</ul>'; |
|
619 | + |
|
620 | + echo apply_filters( 'getpaid_payment_gateway_form_saved_payment_methods_html', $html, $this ); |
|
621 | + } |
|
622 | + |
|
623 | + /** |
|
624 | + * Gets saved payment method HTML from a token. |
|
625 | + * |
|
626 | + * @since 1.0.19 |
|
627 | + * @param array $token Payment Token. |
|
628 | + * @return string Generated payment method HTML |
|
629 | + */ |
|
630 | + public function get_saved_payment_method_option_html( $token ) { |
|
631 | + |
|
632 | + return sprintf( |
|
633 | + '<li class="getpaid-payment-method form-group"> |
|
634 | 634 | <label> |
635 | 635 | <input name="getpaid-%1$s-payment-method" type="radio" value="%2$s" data-currency="%5$s" style="width:auto;" class="getpaid-saved-payment-method-token-input" %4$s /> |
636 | 636 | <span>%3$s</span> |
637 | 637 | </label> |
638 | 638 | </li>', |
639 | - esc_attr( $this->id ), |
|
640 | - esc_attr( $token['id'] ), |
|
641 | - esc_html( $token['name'] ), |
|
642 | - checked( empty( $token['default'] ), false, false ), |
|
643 | - empty( $token['currency'] ) ? 'none' : esc_attr( $token['currency'] ) |
|
644 | - ); |
|
645 | - |
|
646 | - } |
|
647 | - |
|
648 | - /** |
|
649 | - * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method. |
|
650 | - * |
|
651 | - * @since 1.0.19 |
|
652 | - */ |
|
653 | - public function get_new_payment_method_option_html() { |
|
654 | - |
|
655 | - $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this ); |
|
656 | - |
|
657 | - return sprintf( |
|
658 | - '<li class="getpaid-new-payment-method"> |
|
639 | + esc_attr( $this->id ), |
|
640 | + esc_attr( $token['id'] ), |
|
641 | + esc_html( $token['name'] ), |
|
642 | + checked( empty( $token['default'] ), false, false ), |
|
643 | + empty( $token['currency'] ) ? 'none' : esc_attr( $token['currency'] ) |
|
644 | + ); |
|
645 | + |
|
646 | + } |
|
647 | + |
|
648 | + /** |
|
649 | + * Displays a radio button for entering a new payment method (new CC details) instead of using a saved method. |
|
650 | + * |
|
651 | + * @since 1.0.19 |
|
652 | + */ |
|
653 | + public function get_new_payment_method_option_html() { |
|
654 | + |
|
655 | + $label = apply_filters( 'getpaid_new_payment_method_label', $this->new_method_label ? $this->new_method_label : __( 'Use a new payment method', 'invoicing' ), $this ); |
|
656 | + |
|
657 | + return sprintf( |
|
658 | + '<li class="getpaid-new-payment-method"> |
|
659 | 659 | <label> |
660 | 660 | <input name="getpaid-%1$s-payment-method" type="radio" data-currency="none" value="new" style="width:auto;" /> |
661 | 661 | <span>%2$s</span> |
662 | 662 | </label> |
663 | 663 | </li>', |
664 | - esc_attr( $this->id ), |
|
665 | - esc_html( $label ) |
|
666 | - ); |
|
667 | - |
|
668 | - } |
|
669 | - |
|
670 | - /** |
|
671 | - * Outputs a checkbox for saving a new payment method to the database. |
|
672 | - * |
|
673 | - * @since 1.0.19 |
|
674 | - */ |
|
675 | - public function save_payment_method_checkbox() { |
|
676 | - |
|
677 | - return aui()->input( |
|
678 | - array( |
|
679 | - 'type' => 'checkbox', |
|
680 | - 'name' => esc_attr( "getpaid-$this->id-new-payment-method" ), |
|
681 | - 'id' => esc_attr( uniqid( $this->id ) ), |
|
682 | - 'required' => false, |
|
683 | - 'label' => esc_html__( 'Save payment method', 'invoicing' ), |
|
684 | - 'value' => 'true', |
|
685 | - 'checked' => true, |
|
686 | - 'wrap_class' => 'getpaid-save-payment-method pt-1 pb-1', |
|
687 | - ) |
|
688 | - ); |
|
689 | - |
|
690 | - } |
|
691 | - |
|
692 | - /** |
|
693 | - * Registers the gateway. |
|
694 | - * |
|
695 | - * @return array |
|
696 | - */ |
|
697 | - public function register_gateway( $gateways ) { |
|
698 | - |
|
699 | - $gateways[ $this->id ] = array( |
|
700 | - |
|
701 | - 'admin_label' => $this->method_title, |
|
664 | + esc_attr( $this->id ), |
|
665 | + esc_html( $label ) |
|
666 | + ); |
|
667 | + |
|
668 | + } |
|
669 | + |
|
670 | + /** |
|
671 | + * Outputs a checkbox for saving a new payment method to the database. |
|
672 | + * |
|
673 | + * @since 1.0.19 |
|
674 | + */ |
|
675 | + public function save_payment_method_checkbox() { |
|
676 | + |
|
677 | + return aui()->input( |
|
678 | + array( |
|
679 | + 'type' => 'checkbox', |
|
680 | + 'name' => esc_attr( "getpaid-$this->id-new-payment-method" ), |
|
681 | + 'id' => esc_attr( uniqid( $this->id ) ), |
|
682 | + 'required' => false, |
|
683 | + 'label' => esc_html__( 'Save payment method', 'invoicing' ), |
|
684 | + 'value' => 'true', |
|
685 | + 'checked' => true, |
|
686 | + 'wrap_class' => 'getpaid-save-payment-method pt-1 pb-1', |
|
687 | + ) |
|
688 | + ); |
|
689 | + |
|
690 | + } |
|
691 | + |
|
692 | + /** |
|
693 | + * Registers the gateway. |
|
694 | + * |
|
695 | + * @return array |
|
696 | + */ |
|
697 | + public function register_gateway( $gateways ) { |
|
698 | + |
|
699 | + $gateways[ $this->id ] = array( |
|
700 | + |
|
701 | + 'admin_label' => $this->method_title, |
|
702 | 702 | 'checkout_label' => $this->title, |
703 | - 'ordering' => $this->order, |
|
703 | + 'ordering' => $this->order, |
|
704 | 704 | |
705 | - ); |
|
705 | + ); |
|
706 | 706 | |
707 | - return $gateways; |
|
707 | + return $gateways; |
|
708 | 708 | |
709 | - } |
|
709 | + } |
|
710 | 710 | |
711 | - /** |
|
712 | - * Checks whether or not this is a sandbox request. |
|
713 | - * |
|
714 | - * @param WPInv_Invoice|null $invoice Invoice object or null. |
|
715 | - * @return bool |
|
716 | - */ |
|
717 | - public function is_sandbox( $invoice = null ) { |
|
711 | + /** |
|
712 | + * Checks whether or not this is a sandbox request. |
|
713 | + * |
|
714 | + * @param WPInv_Invoice|null $invoice Invoice object or null. |
|
715 | + * @return bool |
|
716 | + */ |
|
717 | + public function is_sandbox( $invoice = null ) { |
|
718 | 718 | |
719 | - if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) { |
|
720 | - return $invoice->get_mode() == 'test'; |
|
721 | - } |
|
719 | + if ( ! empty( $invoice ) && ! $invoice->needs_payment() ) { |
|
720 | + return $invoice->get_mode() == 'test'; |
|
721 | + } |
|
722 | 722 | |
723 | - return wpinv_is_test_mode( $this->id ); |
|
723 | + return wpinv_is_test_mode( $this->id ); |
|
724 | 724 | |
725 | - } |
|
725 | + } |
|
726 | 726 | |
727 | - /** |
|
728 | - * Renames the checkout button |
|
729 | - * |
|
730 | - * @return string |
|
731 | - */ |
|
732 | - public function rename_checkout_button() { |
|
733 | - return $this->checkout_button_text; |
|
734 | - } |
|
727 | + /** |
|
728 | + * Renames the checkout button |
|
729 | + * |
|
730 | + * @return string |
|
731 | + */ |
|
732 | + public function rename_checkout_button() { |
|
733 | + return $this->checkout_button_text; |
|
734 | + } |
|
735 | 735 | |
736 | - /** |
|
737 | - * Validate gateway currency |
|
738 | - * |
|
739 | - * @return bool |
|
740 | - */ |
|
741 | - public function validate_currency( $validation, $currency ) { |
|
736 | + /** |
|
737 | + * Validate gateway currency |
|
738 | + * |
|
739 | + * @return bool |
|
740 | + */ |
|
741 | + public function validate_currency( $validation, $currency ) { |
|
742 | 742 | |
743 | - // Required currencies. |
|
744 | - if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) { |
|
745 | - return false; |
|
746 | - } |
|
743 | + // Required currencies. |
|
744 | + if ( ! empty( $this->currencies ) && ! in_array( $currency, $this->currencies ) ) { |
|
745 | + return false; |
|
746 | + } |
|
747 | 747 | |
748 | - // Excluded currencies. |
|
749 | - if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) { |
|
750 | - return false; |
|
751 | - } |
|
748 | + // Excluded currencies. |
|
749 | + if ( ! empty( $this->exclude_currencies ) && in_array( $currency, $this->exclude_currencies ) ) { |
|
750 | + return false; |
|
751 | + } |
|
752 | 752 | |
753 | - return $validation; |
|
754 | - } |
|
753 | + return $validation; |
|
754 | + } |
|
755 | 755 | |
756 | - /** |
|
757 | - * Displays an error |
|
758 | - * |
|
759 | - */ |
|
760 | - public function show_error( $code, $message, $type ) { |
|
756 | + /** |
|
757 | + * Displays an error |
|
758 | + * |
|
759 | + */ |
|
760 | + public function show_error( $code, $message, $type ) { |
|
761 | 761 | |
762 | - if ( is_admin() ) { |
|
763 | - getpaid_admin()->{"show_$type"}( $message ); |
|
764 | - } |
|
762 | + if ( is_admin() ) { |
|
763 | + getpaid_admin()->{"show_$type"}( $message ); |
|
764 | + } |
|
765 | 765 | |
766 | - wpinv_set_error( $code, $message, $type ); |
|
766 | + wpinv_set_error( $code, $message, $type ); |
|
767 | 767 | |
768 | - } |
|
768 | + } |
|
769 | 769 | |
770 | 770 | } |
@@ -13,58 +13,58 @@ discard block |
||
13 | 13 | class GetPaid_Authorize_Net_Gateway extends GetPaid_Authorize_Net_Legacy_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'authorizenet'; |
21 | 21 | |
22 | 22 | /** |
23 | - * An array of features that this gateway supports. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
23 | + * An array of features that this gateway supports. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | 27 | protected $supports = array( 'subscription', 'sandbox', 'tokens', 'addons', 'single_subscription_group', 'multiple_subscription_groups' ); |
28 | 28 | |
29 | 29 | /** |
30 | - * Payment method order. |
|
31 | - * |
|
32 | - * @var int |
|
33 | - */ |
|
30 | + * Payment method order. |
|
31 | + * |
|
32 | + * @var int |
|
33 | + */ |
|
34 | 34 | public $order = 4; |
35 | 35 | |
36 | 36 | /** |
37 | - * Endpoint for requests from Authorize.net. |
|
38 | - * |
|
39 | - * @var string |
|
40 | - */ |
|
41 | - protected $notify_url; |
|
42 | - |
|
43 | - /** |
|
44 | - * Endpoint for requests to Authorize.net. |
|
45 | - * |
|
46 | - * @var string |
|
47 | - */ |
|
37 | + * Endpoint for requests from Authorize.net. |
|
38 | + * |
|
39 | + * @var string |
|
40 | + */ |
|
41 | + protected $notify_url; |
|
42 | + |
|
43 | + /** |
|
44 | + * Endpoint for requests to Authorize.net. |
|
45 | + * |
|
46 | + * @var string |
|
47 | + */ |
|
48 | 48 | protected $endpoint; |
49 | 49 | |
50 | 50 | /** |
51 | - * Currencies this gateway is allowed for. |
|
52 | - * |
|
53 | - * @var array |
|
54 | - */ |
|
55 | - public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' ); |
|
51 | + * Currencies this gateway is allowed for. |
|
52 | + * |
|
53 | + * @var array |
|
54 | + */ |
|
55 | + public $currencies = array( 'USD', 'CAD', 'GBP', 'DKK', 'NOK', 'PLN', 'SEK', 'AUD', 'EUR', 'NZD' ); |
|
56 | 56 | |
57 | 57 | /** |
58 | - * URL to view a transaction. |
|
59 | - * |
|
60 | - * @var string |
|
61 | - */ |
|
58 | + * URL to view a transaction. |
|
59 | + * |
|
60 | + * @var string |
|
61 | + */ |
|
62 | 62 | public $view_transaction_url = 'https://{sandbox}authorize.net/ui/themes/sandbox/Transaction/TransactionReceipt.aspx?transid=%s'; |
63 | 63 | |
64 | 64 | /** |
65 | - * Class constructor. |
|
66 | - */ |
|
67 | - public function __construct() { |
|
65 | + * Class constructor. |
|
66 | + */ |
|
67 | + public function __construct() { |
|
68 | 68 | |
69 | 69 | $this->title = __( 'Credit Card / Debit Card', 'invoicing' ); |
70 | 70 | $this->method_title = __( 'Authorize.Net', 'invoicing' ); |
@@ -76,11 +76,11 @@ discard block |
||
76 | 76 | } |
77 | 77 | |
78 | 78 | /** |
79 | - * Displays the payment method select field. |
|
80 | - * |
|
81 | - * @param int $invoice_id 0 or invoice id. |
|
82 | - * @param GetPaid_Payment_Form $form Current payment form. |
|
83 | - */ |
|
79 | + * Displays the payment method select field. |
|
80 | + * |
|
81 | + * @param int $invoice_id 0 or invoice id. |
|
82 | + * @param GetPaid_Payment_Form $form Current payment form. |
|
83 | + */ |
|
84 | 84 | public function payment_fields( $invoice_id, $form ) { |
85 | 85 | |
86 | 86 | // Let the user select a payment method. |
@@ -91,16 +91,16 @@ discard block |
||
91 | 91 | } |
92 | 92 | |
93 | 93 | /** |
94 | - * Creates a customer profile. |
|
95 | - * |
|
96 | - * |
|
97 | - * @param WPInv_Invoice $invoice Invoice. |
|
94 | + * Creates a customer profile. |
|
95 | + * |
|
96 | + * |
|
97 | + * @param WPInv_Invoice $invoice Invoice. |
|
98 | 98 | * @param array $submission_data Posted checkout fields. |
99 | 99 | * @param bool $save Whether or not to save the payment as a token. |
100 | 100 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile |
101 | - * @return string|WP_Error Payment profile id. |
|
102 | - */ |
|
103 | - public function create_customer_profile( $invoice, $submission_data, $save = true ) { |
|
101 | + * @return string|WP_Error Payment profile id. |
|
102 | + */ |
|
103 | + public function create_customer_profile( $invoice, $submission_data, $save = true ) { |
|
104 | 104 | |
105 | 105 | // Remove non-digits from the number |
106 | 106 | $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] ); |
@@ -175,14 +175,14 @@ discard block |
||
175 | 175 | } |
176 | 176 | |
177 | 177 | /** |
178 | - * Retrieves a customer profile. |
|
179 | - * |
|
180 | - * |
|
181 | - * @param string $profile_id profile id. |
|
182 | - * @return string|WP_Error Profile id. |
|
178 | + * Retrieves a customer profile. |
|
179 | + * |
|
180 | + * |
|
181 | + * @param string $profile_id profile id. |
|
182 | + * @return string|WP_Error Profile id. |
|
183 | 183 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-profile |
184 | - */ |
|
185 | - public function get_customer_profile( $profile_id ) { |
|
184 | + */ |
|
185 | + public function get_customer_profile( $profile_id ) { |
|
186 | 186 | |
187 | 187 | // Generate args. |
188 | 188 | $args = array( |
@@ -197,17 +197,17 @@ discard block |
||
197 | 197 | } |
198 | 198 | |
199 | 199 | /** |
200 | - * Creates a customer profile. |
|
201 | - * |
|
202 | - * |
|
200 | + * Creates a customer profile. |
|
201 | + * |
|
202 | + * |
|
203 | 203 | * @param string $profile_id profile id. |
204 | - * @param WPInv_Invoice $invoice Invoice. |
|
204 | + * @param WPInv_Invoice $invoice Invoice. |
|
205 | 205 | * @param array $submission_data Posted checkout fields. |
206 | 206 | * @param bool $save Whether or not to save the payment as a token. |
207 | 207 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-create-customer-profile |
208 | - * @return string|WP_Error Profile id. |
|
209 | - */ |
|
210 | - public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) { |
|
208 | + * @return string|WP_Error Profile id. |
|
209 | + */ |
|
210 | + public function create_customer_payment_profile( $customer_profile, $invoice, $submission_data, $save ) { |
|
211 | 211 | |
212 | 212 | // Remove non-digits from the number |
213 | 213 | $submission_data['authorizenet']['cc_number'] = preg_replace('/\D/', '', $submission_data['authorizenet']['cc_number'] ); |
@@ -282,13 +282,13 @@ discard block |
||
282 | 282 | } |
283 | 283 | |
284 | 284 | /** |
285 | - * Retrieves payment details from cache. |
|
286 | - * |
|
287 | - * |
|
285 | + * Retrieves payment details from cache. |
|
286 | + * |
|
287 | + * |
|
288 | 288 | * @param array $payment_details. |
289 | - * @return array|false Profile id. |
|
290 | - */ |
|
291 | - public function retrieve_payment_profile_from_cache( $payment_details, $customer_profile, $invoice ) { |
|
289 | + * @return array|false Profile id. |
|
290 | + */ |
|
291 | + public function retrieve_payment_profile_from_cache( $payment_details, $customer_profile, $invoice ) { |
|
292 | 292 | |
293 | 293 | $cached_information = get_option( 'getpaid_authorize_net_cached_profiles', array() ); |
294 | 294 | $payment_details = hash_hmac( 'sha256', json_encode( $payment_details ), SECURE_AUTH_KEY ); |
@@ -313,13 +313,13 @@ discard block |
||
313 | 313 | } |
314 | 314 | |
315 | 315 | /** |
316 | - * Securely adds payment details to cache. |
|
317 | - * |
|
318 | - * |
|
316 | + * Securely adds payment details to cache. |
|
317 | + * |
|
318 | + * |
|
319 | 319 | * @param array $payment_details. |
320 | 320 | * @param string $payment_profile_id. |
321 | - */ |
|
322 | - public function add_payment_profile_to_cache( $payment_details, $payment_profile_id ) { |
|
321 | + */ |
|
322 | + public function add_payment_profile_to_cache( $payment_details, $payment_profile_id ) { |
|
323 | 323 | |
324 | 324 | $cached_information = get_option( 'getpaid_authorize_net_cached_profiles', array() ); |
325 | 325 | $cached_information = is_array( $cached_information ) ? $cached_information : array(); |
@@ -331,15 +331,15 @@ discard block |
||
331 | 331 | } |
332 | 332 | |
333 | 333 | /** |
334 | - * Retrieves a customer payment profile. |
|
335 | - * |
|
336 | - * |
|
337 | - * @param string $customer_profile_id customer profile id. |
|
334 | + * Retrieves a customer payment profile. |
|
335 | + * |
|
336 | + * |
|
337 | + * @param string $customer_profile_id customer profile id. |
|
338 | 338 | * @param string $payment_profile_id payment profile id. |
339 | - * @return string|WP_Error Profile id. |
|
339 | + * @return string|WP_Error Profile id. |
|
340 | 340 | * @link https://developer.authorize.net/api/reference/index.html#customer-profiles-get-customer-payment-profile |
341 | - */ |
|
342 | - public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) { |
|
341 | + */ |
|
342 | + public function get_customer_payment_profile( $customer_profile_id, $payment_profile_id ) { |
|
343 | 343 | |
344 | 344 | // Generate args. |
345 | 345 | $args = array( |
@@ -355,15 +355,15 @@ discard block |
||
355 | 355 | } |
356 | 356 | |
357 | 357 | /** |
358 | - * Charges a customer payment profile. |
|
359 | - * |
|
358 | + * Charges a customer payment profile. |
|
359 | + * |
|
360 | 360 | * @param string $customer_profile_id customer profile id. |
361 | 361 | * @param string $payment_profile_id payment profile id. |
362 | - * @param WPInv_Invoice $invoice Invoice. |
|
362 | + * @param WPInv_Invoice $invoice Invoice. |
|
363 | 363 | * @link https://developer.authorize.net/api/reference/index.html#payment-transactions-charge-a-customer-profile |
364 | - * @return WP_Error|object |
|
365 | - */ |
|
366 | - public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) { |
|
364 | + * @return WP_Error|object |
|
365 | + */ |
|
366 | + public function charge_customer_payment_profile( $customer_profile_id, $payment_profile_id, $invoice ) { |
|
367 | 367 | |
368 | 368 | // Generate args. |
369 | 369 | $args = array( |
@@ -409,41 +409,41 @@ discard block |
||
409 | 409 | } |
410 | 410 | |
411 | 411 | /** |
412 | - * Processes a customer charge. |
|
413 | - * |
|
412 | + * Processes a customer charge. |
|
413 | + * |
|
414 | 414 | * @param stdClass $result Api response. |
415 | - * @param WPInv_Invoice $invoice Invoice. |
|
416 | - */ |
|
417 | - public function process_charge_response( $result, $invoice ) { |
|
415 | + * @param WPInv_Invoice $invoice Invoice. |
|
416 | + */ |
|
417 | + public function process_charge_response( $result, $invoice ) { |
|
418 | 418 | |
419 | 419 | wpinv_clear_errors(); |
420 | - $response_code = (int) $result->transactionResponse->responseCode; |
|
420 | + $response_code = (int) $result->transactionResponse->responseCode; |
|
421 | 421 | |
422 | - // Succeeded. |
|
423 | - if ( 1 == $response_code || 4 == $response_code ) { |
|
422 | + // Succeeded. |
|
423 | + if ( 1 == $response_code || 4 == $response_code ) { |
|
424 | 424 | |
425 | - // Maybe set a transaction id. |
|
426 | - if ( ! empty( $result->transactionResponse->transId ) ) { |
|
427 | - $invoice->set_transaction_id( $result->transactionResponse->transId ); |
|
428 | - } |
|
425 | + // Maybe set a transaction id. |
|
426 | + if ( ! empty( $result->transactionResponse->transId ) ) { |
|
427 | + $invoice->set_transaction_id( $result->transactionResponse->transId ); |
|
428 | + } |
|
429 | 429 | |
430 | - $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true ); |
|
430 | + $invoice->add_note( sprintf( __( 'Authentication code: %s (%s).', 'invoicing' ), $result->transactionResponse->authCode, $result->transactionResponse->accountNumber ), false, false, true ); |
|
431 | 431 | |
432 | - if ( 1 == $response_code ) { |
|
433 | - return $invoice->mark_paid(); |
|
434 | - } |
|
432 | + if ( 1 == $response_code ) { |
|
433 | + return $invoice->mark_paid(); |
|
434 | + } |
|
435 | 435 | |
436 | - $invoice->set_status( 'wpi-onhold' ); |
|
437 | - $invoice->add_note( |
|
436 | + $invoice->set_status( 'wpi-onhold' ); |
|
437 | + $invoice->add_note( |
|
438 | 438 | sprintf( |
439 | 439 | __( 'Held for review: %s', 'invoicing' ), |
440 | 440 | $result->transactionResponse->messages->message[0]->description |
441 | 441 | ) |
442 | - ); |
|
442 | + ); |
|
443 | 443 | |
444 | - return $invoice->save(); |
|
444 | + return $invoice->save(); |
|
445 | 445 | |
446 | - } |
|
446 | + } |
|
447 | 447 | |
448 | 448 | wpinv_set_error( 'card_declined', __( 'Credit card declined.', 'invoicing' ) ); |
449 | 449 | |
@@ -455,13 +455,13 @@ discard block |
||
455 | 455 | } |
456 | 456 | |
457 | 457 | /** |
458 | - * Returns payment information. |
|
459 | - * |
|
460 | - * |
|
461 | - * @param array $card Card details. |
|
462 | - * @return array |
|
463 | - */ |
|
464 | - public function get_payment_information( $card ) { |
|
458 | + * Returns payment information. |
|
459 | + * |
|
460 | + * |
|
461 | + * @param array $card Card details. |
|
462 | + * @return array |
|
463 | + */ |
|
464 | + public function get_payment_information( $card ) { |
|
465 | 465 | return array( |
466 | 466 | |
467 | 467 | 'creditCard' => array ( |
@@ -474,25 +474,25 @@ discard block |
||
474 | 474 | } |
475 | 475 | |
476 | 476 | /** |
477 | - * Returns the customer profile meta name. |
|
478 | - * |
|
479 | - * |
|
480 | - * @param WPInv_Invoice $invoice Invoice. |
|
481 | - * @return string |
|
482 | - */ |
|
483 | - public function get_customer_profile_meta_name( $invoice ) { |
|
477 | + * Returns the customer profile meta name. |
|
478 | + * |
|
479 | + * |
|
480 | + * @param WPInv_Invoice $invoice Invoice. |
|
481 | + * @return string |
|
482 | + */ |
|
483 | + public function get_customer_profile_meta_name( $invoice ) { |
|
484 | 484 | return $this->is_sandbox( $invoice ) ? 'getpaid_authorizenet_sandbox_customer_profile_id' : 'getpaid_authorizenet_customer_profile_id'; |
485 | 485 | } |
486 | 486 | |
487 | 487 | /** |
488 | - * Validates the submitted data. |
|
489 | - * |
|
490 | - * |
|
491 | - * @param array $submission_data Posted checkout fields. |
|
488 | + * Validates the submitted data. |
|
489 | + * |
|
490 | + * |
|
491 | + * @param array $submission_data Posted checkout fields. |
|
492 | 492 | * @param WPInv_Invoice $invoice |
493 | - * @return WP_Error|string The payment profile id |
|
494 | - */ |
|
495 | - public function validate_submission_data( $submission_data, $invoice ) { |
|
493 | + * @return WP_Error|string The payment profile id |
|
494 | + */ |
|
495 | + public function validate_submission_data( $submission_data, $invoice ) { |
|
496 | 496 | |
497 | 497 | // Validate authentication details. |
498 | 498 | $auth = $this->get_auth_params(); |
@@ -524,13 +524,13 @@ discard block |
||
524 | 524 | } |
525 | 525 | |
526 | 526 | /** |
527 | - * Returns invoice line items. |
|
528 | - * |
|
529 | - * |
|
530 | - * @param WPInv_Invoice $invoice Invoice. |
|
531 | - * @return array |
|
532 | - */ |
|
533 | - public function get_line_items( $invoice ) { |
|
527 | + * Returns invoice line items. |
|
528 | + * |
|
529 | + * |
|
530 | + * @param WPInv_Invoice $invoice Invoice. |
|
531 | + * @return array |
|
532 | + */ |
|
533 | + public function get_line_items( $invoice ) { |
|
534 | 534 | $items = array(); |
535 | 535 | |
536 | 536 | foreach ( $invoice->get_items() as $item ) { |
@@ -568,15 +568,15 @@ discard block |
||
568 | 568 | } |
569 | 569 | |
570 | 570 | /** |
571 | - * Process Payment. |
|
572 | - * |
|
573 | - * |
|
574 | - * @param WPInv_Invoice $invoice Invoice. |
|
575 | - * @param array $submission_data Posted checkout fields. |
|
576 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
577 | - * @return array |
|
578 | - */ |
|
579 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
571 | + * Process Payment. |
|
572 | + * |
|
573 | + * |
|
574 | + * @param WPInv_Invoice $invoice Invoice. |
|
575 | + * @param array $submission_data Posted checkout fields. |
|
576 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
577 | + * @return array |
|
578 | + */ |
|
579 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
580 | 580 | |
581 | 581 | // Validate the submitted data. |
582 | 582 | $payment_profile_id = $this->validate_submission_data( $submission_data, $invoice ); |
@@ -609,45 +609,45 @@ discard block |
||
609 | 609 | |
610 | 610 | exit; |
611 | 611 | |
612 | - } |
|
612 | + } |
|
613 | 613 | |
614 | - /** |
|
615 | - * Processes the initial payment. |
|
616 | - * |
|
614 | + /** |
|
615 | + * Processes the initial payment. |
|
616 | + * |
|
617 | 617 | * @param WPInv_Invoice $invoice Invoice. |
618 | - */ |
|
619 | - protected function process_initial_payment( $invoice ) { |
|
618 | + */ |
|
619 | + protected function process_initial_payment( $invoice ) { |
|
620 | 620 | |
621 | - $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
621 | + $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
622 | 622 | $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
623 | - $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
|
623 | + $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
|
624 | 624 | |
625 | - // Do we have an error? |
|
626 | - if ( is_wp_error( $result ) ) { |
|
627 | - wpinv_set_error( $result->get_error_code(), $result->get_error_message() ); |
|
628 | - wpinv_send_back_to_checkout( $invoice ); |
|
629 | - } |
|
625 | + // Do we have an error? |
|
626 | + if ( is_wp_error( $result ) ) { |
|
627 | + wpinv_set_error( $result->get_error_code(), $result->get_error_message() ); |
|
628 | + wpinv_send_back_to_checkout( $invoice ); |
|
629 | + } |
|
630 | 630 | |
631 | - // Process the response. |
|
632 | - $this->process_charge_response( $result, $invoice ); |
|
631 | + // Process the response. |
|
632 | + $this->process_charge_response( $result, $invoice ); |
|
633 | 633 | |
634 | - if ( wpinv_get_errors() ) { |
|
635 | - wpinv_send_back_to_checkout( $invoice ); |
|
636 | - } |
|
634 | + if ( wpinv_get_errors() ) { |
|
635 | + wpinv_send_back_to_checkout( $invoice ); |
|
636 | + } |
|
637 | 637 | |
638 | - } |
|
638 | + } |
|
639 | 639 | |
640 | 640 | /** |
641 | - * Processes recurring payments. |
|
642 | - * |
|
641 | + * Processes recurring payments. |
|
642 | + * |
|
643 | 643 | * @param WPInv_Invoice $invoice Invoice. |
644 | 644 | * @param WPInv_Subscription[]|WPInv_Subscription $subscriptions Subscriptions. |
645 | - */ |
|
646 | - public function process_subscription( $invoice, $subscriptions ) { |
|
645 | + */ |
|
646 | + public function process_subscription( $invoice, $subscriptions ) { |
|
647 | 647 | |
648 | 648 | // Check if there is an initial amount to charge. |
649 | 649 | if ( (float) $invoice->get_total() > 0 ) { |
650 | - $this->process_initial_payment( $invoice ); |
|
650 | + $this->process_initial_payment( $invoice ); |
|
651 | 651 | } |
652 | 652 | |
653 | 653 | // Activate the subscriptions. |
@@ -665,36 +665,36 @@ discard block |
||
665 | 665 | } |
666 | 666 | } |
667 | 667 | |
668 | - // Redirect to the success page. |
|
668 | + // Redirect to the success page. |
|
669 | 669 | wpinv_send_to_success_page( array( 'invoice_key' => $invoice->get_key() ) ); |
670 | 670 | |
671 | 671 | } |
672 | 672 | |
673 | - /** |
|
674 | - * (Maybe) renews an authorize.net subscription profile. |
|
675 | - * |
|
676 | - * |
|
673 | + /** |
|
674 | + * (Maybe) renews an authorize.net subscription profile. |
|
675 | + * |
|
676 | + * |
|
677 | 677 | * @param WPInv_Subscription $subscription |
678 | - */ |
|
679 | - public function maybe_renew_subscription( $subscription ) { |
|
678 | + */ |
|
679 | + public function maybe_renew_subscription( $subscription ) { |
|
680 | 680 | |
681 | 681 | // Ensure its our subscription && it's active. |
682 | 682 | if ( $this->id == $subscription->get_gateway() && $subscription->has_status( 'active trialling' ) ) { |
683 | 683 | $this->renew_subscription( $subscription ); |
684 | 684 | } |
685 | 685 | |
686 | - } |
|
686 | + } |
|
687 | 687 | |
688 | 688 | /** |
689 | - * Renews a subscription. |
|
690 | - * |
|
689 | + * Renews a subscription. |
|
690 | + * |
|
691 | 691 | * @param WPInv_Subscription $subscription |
692 | - */ |
|
693 | - public function renew_subscription( $subscription ) { |
|
692 | + */ |
|
693 | + public function renew_subscription( $subscription ) { |
|
694 | 694 | |
695 | - // Generate the renewal invoice. |
|
696 | - $new_invoice = $subscription->create_payment(); |
|
697 | - $old_invoice = $subscription->get_parent_payment(); |
|
695 | + // Generate the renewal invoice. |
|
696 | + $new_invoice = $subscription->create_payment(); |
|
697 | + $old_invoice = $subscription->get_parent_payment(); |
|
698 | 698 | |
699 | 699 | if ( empty( $new_invoice ) ) { |
700 | 700 | $old_invoice->add_note( __( 'Error generating a renewal invoice.', 'invoicing' ), false, false, false ); |
@@ -703,37 +703,37 @@ discard block |
||
703 | 703 | } |
704 | 704 | |
705 | 705 | // Charge the payment method. |
706 | - $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
707 | - $customer_profile = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true ); |
|
708 | - $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice ); |
|
709 | - |
|
710 | - // Do we have an error? |
|
711 | - if ( is_wp_error( $result ) ) { |
|
712 | - |
|
713 | - $old_invoice->add_note( |
|
714 | - sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ), |
|
715 | - true, |
|
716 | - false, |
|
717 | - true |
|
718 | - ); |
|
719 | - $subscription->failing(); |
|
720 | - return; |
|
721 | - |
|
722 | - } |
|
723 | - |
|
724 | - // Process the response. |
|
725 | - $this->process_charge_response( $result, $new_invoice ); |
|
726 | - |
|
727 | - if ( wpinv_get_errors() ) { |
|
728 | - |
|
729 | - $old_invoice->add_note( |
|
730 | - sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ), |
|
731 | - true, |
|
732 | - false, |
|
733 | - true |
|
734 | - ); |
|
735 | - $subscription->failing(); |
|
736 | - return; |
|
706 | + $payment_profile_id = get_post_meta( $old_invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
|
707 | + $customer_profile = get_user_meta( $old_invoice->get_user_id(), $this->get_customer_profile_meta_name( $old_invoice ), true ); |
|
708 | + $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $new_invoice ); |
|
709 | + |
|
710 | + // Do we have an error? |
|
711 | + if ( is_wp_error( $result ) ) { |
|
712 | + |
|
713 | + $old_invoice->add_note( |
|
714 | + sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), $result->get_error_message() ), |
|
715 | + true, |
|
716 | + false, |
|
717 | + true |
|
718 | + ); |
|
719 | + $subscription->failing(); |
|
720 | + return; |
|
721 | + |
|
722 | + } |
|
723 | + |
|
724 | + // Process the response. |
|
725 | + $this->process_charge_response( $result, $new_invoice ); |
|
726 | + |
|
727 | + if ( wpinv_get_errors() ) { |
|
728 | + |
|
729 | + $old_invoice->add_note( |
|
730 | + sprintf( __( 'Error renewing subscription : ( %s ).', 'invoicing' ), getpaid_get_errors_html() ), |
|
731 | + true, |
|
732 | + false, |
|
733 | + true |
|
734 | + ); |
|
735 | + $subscription->failing(); |
|
736 | + return; |
|
737 | 737 | |
738 | 738 | } |
739 | 739 | |
@@ -742,13 +742,13 @@ discard block |
||
742 | 742 | } |
743 | 743 | |
744 | 744 | /** |
745 | - * Processes invoice addons. |
|
746 | - * |
|
747 | - * @param WPInv_Invoice $invoice |
|
748 | - * @param GetPaid_Form_Item[] $items |
|
749 | - * @return WPInv_Invoice |
|
750 | - */ |
|
751 | - public function process_addons( $invoice, $items ) { |
|
745 | + * Processes invoice addons. |
|
746 | + * |
|
747 | + * @param WPInv_Invoice $invoice |
|
748 | + * @param GetPaid_Form_Item[] $items |
|
749 | + * @return WPInv_Invoice |
|
750 | + */ |
|
751 | + public function process_addons( $invoice, $items ) { |
|
752 | 752 | |
753 | 753 | global $getpaid_authorize_addons; |
754 | 754 | |
@@ -768,7 +768,7 @@ discard block |
||
768 | 768 | $invoice->recalculate_total(); |
769 | 769 | |
770 | 770 | $payment_profile_id = get_post_meta( $invoice->get_id(), 'getpaid_authorizenet_profile_id', true ); |
771 | - $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
|
771 | + $customer_profile = get_user_meta( $invoice->get_user_id(), $this->get_customer_profile_meta_name( $invoice ), true ); |
|
772 | 772 | |
773 | 773 | add_filter( 'getpaid_authorizenet_charge_customer_payment_profile_args', array( $this, 'filter_addons_request' ), 10, 2 ); |
774 | 774 | $result = $this->charge_customer_payment_profile( $customer_profile, $payment_profile_id, $invoice ); |
@@ -783,11 +783,11 @@ discard block |
||
783 | 783 | } |
784 | 784 | |
785 | 785 | /** |
786 | - * Processes invoice addons. |
|
787 | - * |
|
786 | + * Processes invoice addons. |
|
787 | + * |
|
788 | 788 | * @param array $args |
789 | - * @return array |
|
790 | - */ |
|
789 | + * @return array |
|
790 | + */ |
|
791 | 791 | public function filter_addons_request( $args ) { |
792 | 792 | |
793 | 793 | global $getpaid_authorize_addons; |
@@ -821,11 +821,11 @@ discard block |
||
821 | 821 | } |
822 | 822 | |
823 | 823 | /** |
824 | - * Filters the gateway settings. |
|
825 | - * |
|
826 | - * @param array $admin_settings |
|
827 | - */ |
|
828 | - public function admin_settings( $admin_settings ) { |
|
824 | + * Filters the gateway settings. |
|
825 | + * |
|
826 | + * @param array $admin_settings |
|
827 | + */ |
|
828 | + public function admin_settings( $admin_settings ) { |
|
829 | 829 | |
830 | 830 | $currencies = sprintf( |
831 | 831 | __( 'Supported Currencies: %s', 'invoicing' ), |
@@ -865,7 +865,7 @@ discard block |
||
865 | 865 | 'readonly' => true, |
866 | 866 | ); |
867 | 867 | |
868 | - return $admin_settings; |
|
869 | - } |
|
868 | + return $admin_settings; |
|
869 | + } |
|
870 | 870 | |
871 | 871 | } |
@@ -16,165 +16,165 @@ |
||
16 | 16 | */ |
17 | 17 | class GetPaid_MaxMind_Geolocation { |
18 | 18 | |
19 | - /** |
|
20 | - * The service responsible for interacting with the MaxMind database. |
|
21 | - * |
|
22 | - * @var GetPaid_MaxMind_Database_Service |
|
23 | - */ |
|
24 | - private $database_service; |
|
25 | - |
|
26 | - /** |
|
27 | - * Initialize the integration. |
|
28 | - */ |
|
29 | - public function __construct() { |
|
30 | - |
|
31 | - /** |
|
32 | - * Supports overriding the database service to be used. |
|
33 | - * |
|
34 | - * @since 1.0.19 |
|
35 | - * @return mixed|null The geolocation database service. |
|
36 | - */ |
|
37 | - $this->database_service = apply_filters( 'getpaid_maxmind_geolocation_database_service', null ); |
|
38 | - if ( null === $this->database_service ) { |
|
39 | - $this->database_service = new GetPaid_MaxMind_Database_Service( $this->get_database_prefix() ); |
|
40 | - } |
|
41 | - |
|
42 | - // Bind to the scheduled updater action. |
|
43 | - add_action( 'getpaid_update_geoip_databases', array( $this, 'update_database' ) ); |
|
44 | - |
|
45 | - // Bind to the geolocation filter for MaxMind database lookups. |
|
46 | - add_filter( 'getpaid_get_geolocation', array( $this, 'get_geolocation' ), 10, 2 ); |
|
47 | - |
|
48 | - // Handle maxmind key updates. |
|
49 | - add_filter( 'wpinv_settings_sanitize_maxmind_license_key', array( $this, 'handle_key_updates' ) ); |
|
50 | - |
|
51 | - } |
|
52 | - |
|
53 | - /** |
|
54 | - * Get database service. |
|
55 | - * |
|
56 | - * @return GetPaid_MaxMind_Database_Service|null |
|
57 | - */ |
|
58 | - public function get_database_service() { |
|
59 | - return $this->database_service; |
|
60 | - } |
|
61 | - |
|
62 | - /** |
|
63 | - * Checks to make sure that the license key is valid. |
|
64 | - * |
|
65 | - * @param string $license_key The new license key. |
|
66 | - * @return string |
|
67 | - */ |
|
68 | - public function handle_key_updates( $license_key ) { |
|
69 | - |
|
70 | - // Trim whitespaces and strip slashes. |
|
71 | - $license_key = trim( $license_key ); |
|
72 | - |
|
73 | - // Abort if the license key is empty or unchanged. |
|
74 | - if ( empty( $license_key ) ) { |
|
75 | - return $license_key; |
|
76 | - } |
|
77 | - |
|
78 | - // Abort if a database exists and the license key is unchaged. |
|
79 | - if ( file_exists( $this->database_service->get_database_path() && $license_key == wpinv_get_option( 'maxmind_license_key' ) ) ) { |
|
80 | - return $license_key; |
|
81 | - } |
|
82 | - |
|
83 | - // Check the license key by attempting to download the Geolocation database. |
|
84 | - $tmp_database_path = $this->database_service->download_database( $license_key ); |
|
85 | - if ( is_wp_error( $tmp_database_path ) ) { |
|
86 | - getpaid_admin()->show_error( $tmp_database_path->get_error_message() ); |
|
87 | - return $license_key; |
|
88 | - } |
|
89 | - |
|
90 | - $this->update_database( /** @scrutinizer ignore-type */ $tmp_database_path ); |
|
91 | - |
|
92 | - return $license_key; |
|
93 | - } |
|
94 | - |
|
95 | - /** |
|
96 | - * Updates the database used for geolocation queries. |
|
97 | - * |
|
98 | - * @param string $tmp_database_path Temporary database path. |
|
99 | - */ |
|
100 | - public function update_database( $tmp_database_path = null ) { |
|
101 | - |
|
102 | - // Allow us to easily interact with the filesystem. |
|
103 | - require_once ABSPATH . 'wp-admin/includes/file.php'; |
|
104 | - WP_Filesystem(); |
|
105 | - global $wp_filesystem; |
|
106 | - |
|
107 | - // Remove any existing archives to comply with the MaxMind TOS. |
|
108 | - $target_database_path = $this->database_service->get_database_path(); |
|
109 | - |
|
110 | - // If there's no database path, we can't store the database. |
|
111 | - if ( empty( $target_database_path ) ) { |
|
112 | - return; |
|
113 | - } |
|
114 | - |
|
115 | - if ( $wp_filesystem->exists( $target_database_path ) ) { |
|
116 | - $wp_filesystem->delete( $target_database_path ); |
|
117 | - } |
|
118 | - |
|
119 | - // We can't download a database if there's no license key configured. |
|
120 | - $license_key = wpinv_get_option( 'maxmind_license_key' ); |
|
121 | - if ( empty( $license_key ) ) { |
|
122 | - return; |
|
123 | - } |
|
124 | - |
|
125 | - if ( empty( $tmp_database_path ) ) { |
|
126 | - $tmp_database_path = $this->database_service->download_database( $license_key ); |
|
127 | - } |
|
128 | - |
|
129 | - if ( is_wp_error( $tmp_database_path ) ) { |
|
130 | - wpinv_error_log( $tmp_database_path->get_error_message() ); |
|
131 | - return; |
|
132 | - } |
|
133 | - |
|
134 | - // Move the new database into position. |
|
135 | - $wp_filesystem->move( $tmp_database_path, $target_database_path, true ); |
|
136 | - $wp_filesystem->delete( dirname( $tmp_database_path ) ); |
|
137 | - } |
|
138 | - |
|
139 | - /** |
|
140 | - * Performs a geolocation lookup against the MaxMind database for the given IP address. |
|
141 | - * |
|
142 | - * @param array $data Geolocation data. |
|
143 | - * @param string $ip_address The IP address to geolocate. |
|
144 | - * @return array Geolocation including country code, state, city and postcode based on an IP address. |
|
145 | - */ |
|
146 | - public function get_geolocation( $data, $ip_address ) { |
|
147 | - |
|
148 | - if ( ! empty( $data['country'] ) || empty( $ip_address ) ) { |
|
149 | - return $data; |
|
150 | - } |
|
151 | - |
|
152 | - $country_code = $this->database_service->get_iso_country_code_for_ip( $ip_address ); |
|
153 | - |
|
154 | - return array( |
|
155 | - 'country' => $country_code, |
|
156 | - 'state' => '', |
|
157 | - 'city' => '', |
|
158 | - 'postcode' => '', |
|
159 | - ); |
|
160 | - |
|
161 | - } |
|
162 | - |
|
163 | - /** |
|
164 | - * Fetches the prefix for the MaxMind database file. |
|
165 | - * |
|
166 | - * @return string |
|
167 | - */ |
|
168 | - private function get_database_prefix() { |
|
169 | - |
|
170 | - $prefix = get_option( 'wpinv_maxmind_database_prefix' ); |
|
171 | - |
|
172 | - if ( empty( $prefix ) ) { |
|
173 | - $prefix = md5( uniqid( 'wpinv' ) ); |
|
174 | - update_option( 'wpinv_maxmind_database_prefix', $prefix ); |
|
175 | - } |
|
176 | - |
|
177 | - return $prefix; |
|
178 | - } |
|
19 | + /** |
|
20 | + * The service responsible for interacting with the MaxMind database. |
|
21 | + * |
|
22 | + * @var GetPaid_MaxMind_Database_Service |
|
23 | + */ |
|
24 | + private $database_service; |
|
25 | + |
|
26 | + /** |
|
27 | + * Initialize the integration. |
|
28 | + */ |
|
29 | + public function __construct() { |
|
30 | + |
|
31 | + /** |
|
32 | + * Supports overriding the database service to be used. |
|
33 | + * |
|
34 | + * @since 1.0.19 |
|
35 | + * @return mixed|null The geolocation database service. |
|
36 | + */ |
|
37 | + $this->database_service = apply_filters( 'getpaid_maxmind_geolocation_database_service', null ); |
|
38 | + if ( null === $this->database_service ) { |
|
39 | + $this->database_service = new GetPaid_MaxMind_Database_Service( $this->get_database_prefix() ); |
|
40 | + } |
|
41 | + |
|
42 | + // Bind to the scheduled updater action. |
|
43 | + add_action( 'getpaid_update_geoip_databases', array( $this, 'update_database' ) ); |
|
44 | + |
|
45 | + // Bind to the geolocation filter for MaxMind database lookups. |
|
46 | + add_filter( 'getpaid_get_geolocation', array( $this, 'get_geolocation' ), 10, 2 ); |
|
47 | + |
|
48 | + // Handle maxmind key updates. |
|
49 | + add_filter( 'wpinv_settings_sanitize_maxmind_license_key', array( $this, 'handle_key_updates' ) ); |
|
50 | + |
|
51 | + } |
|
52 | + |
|
53 | + /** |
|
54 | + * Get database service. |
|
55 | + * |
|
56 | + * @return GetPaid_MaxMind_Database_Service|null |
|
57 | + */ |
|
58 | + public function get_database_service() { |
|
59 | + return $this->database_service; |
|
60 | + } |
|
61 | + |
|
62 | + /** |
|
63 | + * Checks to make sure that the license key is valid. |
|
64 | + * |
|
65 | + * @param string $license_key The new license key. |
|
66 | + * @return string |
|
67 | + */ |
|
68 | + public function handle_key_updates( $license_key ) { |
|
69 | + |
|
70 | + // Trim whitespaces and strip slashes. |
|
71 | + $license_key = trim( $license_key ); |
|
72 | + |
|
73 | + // Abort if the license key is empty or unchanged. |
|
74 | + if ( empty( $license_key ) ) { |
|
75 | + return $license_key; |
|
76 | + } |
|
77 | + |
|
78 | + // Abort if a database exists and the license key is unchaged. |
|
79 | + if ( file_exists( $this->database_service->get_database_path() && $license_key == wpinv_get_option( 'maxmind_license_key' ) ) ) { |
|
80 | + return $license_key; |
|
81 | + } |
|
82 | + |
|
83 | + // Check the license key by attempting to download the Geolocation database. |
|
84 | + $tmp_database_path = $this->database_service->download_database( $license_key ); |
|
85 | + if ( is_wp_error( $tmp_database_path ) ) { |
|
86 | + getpaid_admin()->show_error( $tmp_database_path->get_error_message() ); |
|
87 | + return $license_key; |
|
88 | + } |
|
89 | + |
|
90 | + $this->update_database( /** @scrutinizer ignore-type */ $tmp_database_path ); |
|
91 | + |
|
92 | + return $license_key; |
|
93 | + } |
|
94 | + |
|
95 | + /** |
|
96 | + * Updates the database used for geolocation queries. |
|
97 | + * |
|
98 | + * @param string $tmp_database_path Temporary database path. |
|
99 | + */ |
|
100 | + public function update_database( $tmp_database_path = null ) { |
|
101 | + |
|
102 | + // Allow us to easily interact with the filesystem. |
|
103 | + require_once ABSPATH . 'wp-admin/includes/file.php'; |
|
104 | + WP_Filesystem(); |
|
105 | + global $wp_filesystem; |
|
106 | + |
|
107 | + // Remove any existing archives to comply with the MaxMind TOS. |
|
108 | + $target_database_path = $this->database_service->get_database_path(); |
|
109 | + |
|
110 | + // If there's no database path, we can't store the database. |
|
111 | + if ( empty( $target_database_path ) ) { |
|
112 | + return; |
|
113 | + } |
|
114 | + |
|
115 | + if ( $wp_filesystem->exists( $target_database_path ) ) { |
|
116 | + $wp_filesystem->delete( $target_database_path ); |
|
117 | + } |
|
118 | + |
|
119 | + // We can't download a database if there's no license key configured. |
|
120 | + $license_key = wpinv_get_option( 'maxmind_license_key' ); |
|
121 | + if ( empty( $license_key ) ) { |
|
122 | + return; |
|
123 | + } |
|
124 | + |
|
125 | + if ( empty( $tmp_database_path ) ) { |
|
126 | + $tmp_database_path = $this->database_service->download_database( $license_key ); |
|
127 | + } |
|
128 | + |
|
129 | + if ( is_wp_error( $tmp_database_path ) ) { |
|
130 | + wpinv_error_log( $tmp_database_path->get_error_message() ); |
|
131 | + return; |
|
132 | + } |
|
133 | + |
|
134 | + // Move the new database into position. |
|
135 | + $wp_filesystem->move( $tmp_database_path, $target_database_path, true ); |
|
136 | + $wp_filesystem->delete( dirname( $tmp_database_path ) ); |
|
137 | + } |
|
138 | + |
|
139 | + /** |
|
140 | + * Performs a geolocation lookup against the MaxMind database for the given IP address. |
|
141 | + * |
|
142 | + * @param array $data Geolocation data. |
|
143 | + * @param string $ip_address The IP address to geolocate. |
|
144 | + * @return array Geolocation including country code, state, city and postcode based on an IP address. |
|
145 | + */ |
|
146 | + public function get_geolocation( $data, $ip_address ) { |
|
147 | + |
|
148 | + if ( ! empty( $data['country'] ) || empty( $ip_address ) ) { |
|
149 | + return $data; |
|
150 | + } |
|
151 | + |
|
152 | + $country_code = $this->database_service->get_iso_country_code_for_ip( $ip_address ); |
|
153 | + |
|
154 | + return array( |
|
155 | + 'country' => $country_code, |
|
156 | + 'state' => '', |
|
157 | + 'city' => '', |
|
158 | + 'postcode' => '', |
|
159 | + ); |
|
160 | + |
|
161 | + } |
|
162 | + |
|
163 | + /** |
|
164 | + * Fetches the prefix for the MaxMind database file. |
|
165 | + * |
|
166 | + * @return string |
|
167 | + */ |
|
168 | + private function get_database_prefix() { |
|
169 | + |
|
170 | + $prefix = get_option( 'wpinv_maxmind_database_prefix' ); |
|
171 | + |
|
172 | + if ( empty( $prefix ) ) { |
|
173 | + $prefix = md5( uniqid( 'wpinv' ) ); |
|
174 | + update_option( 'wpinv_maxmind_database_prefix', $prefix ); |
|
175 | + } |
|
176 | + |
|
177 | + return $prefix; |
|
178 | + } |
|
179 | 179 | |
180 | 180 | } |
@@ -13,30 +13,30 @@ discard block |
||
13 | 13 | class GetPaid_Manual_Gateway extends GetPaid_Payment_Gateway { |
14 | 14 | |
15 | 15 | /** |
16 | - * Payment method id. |
|
17 | - * |
|
18 | - * @var string |
|
19 | - */ |
|
16 | + * Payment method id. |
|
17 | + * |
|
18 | + * @var string |
|
19 | + */ |
|
20 | 20 | public $id = 'manual'; |
21 | 21 | |
22 | 22 | /** |
23 | - * An array of features that this gateway supports. |
|
24 | - * |
|
25 | - * @var array |
|
26 | - */ |
|
23 | + * An array of features that this gateway supports. |
|
24 | + * |
|
25 | + * @var array |
|
26 | + */ |
|
27 | 27 | protected $supports = array( 'subscription', 'addons', 'single_subscription_group', 'multiple_subscription_groups' ); |
28 | 28 | |
29 | 29 | /** |
30 | - * Payment method order. |
|
31 | - * |
|
32 | - * @var int |
|
33 | - */ |
|
34 | - public $order = 11; |
|
30 | + * Payment method order. |
|
31 | + * |
|
32 | + * @var int |
|
33 | + */ |
|
34 | + public $order = 11; |
|
35 | 35 | |
36 | 36 | /** |
37 | - * Class constructor. |
|
38 | - */ |
|
39 | - public function __construct() { |
|
37 | + * Class constructor. |
|
38 | + */ |
|
39 | + public function __construct() { |
|
40 | 40 | parent::__construct(); |
41 | 41 | |
42 | 42 | $this->title = __( 'Test Gateway', 'invoicing' ); |
@@ -46,15 +46,15 @@ discard block |
||
46 | 46 | } |
47 | 47 | |
48 | 48 | /** |
49 | - * Process Payment. |
|
50 | - * |
|
51 | - * |
|
52 | - * @param WPInv_Invoice $invoice Invoice. |
|
53 | - * @param array $submission_data Posted checkout fields. |
|
54 | - * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
55 | - * @return array |
|
56 | - */ |
|
57 | - public function process_payment( $invoice, $submission_data, $submission ) { |
|
49 | + * Process Payment. |
|
50 | + * |
|
51 | + * |
|
52 | + * @param WPInv_Invoice $invoice Invoice. |
|
53 | + * @param array $submission_data Posted checkout fields. |
|
54 | + * @param GetPaid_Payment_Form_Submission $submission Checkout submission. |
|
55 | + * @return array |
|
56 | + */ |
|
57 | + public function process_payment( $invoice, $submission_data, $submission ) { |
|
58 | 58 | |
59 | 59 | // Mark it as paid. |
60 | 60 | $invoice->mark_paid(); |
@@ -85,12 +85,12 @@ discard block |
||
85 | 85 | } |
86 | 86 | |
87 | 87 | /** |
88 | - * (Maybe) renews a manual subscription profile. |
|
89 | - * |
|
90 | - * |
|
88 | + * (Maybe) renews a manual subscription profile. |
|
89 | + * |
|
90 | + * |
|
91 | 91 | * @param WPInv_Subscription $subscription |
92 | - */ |
|
93 | - public function maybe_renew_subscription( $subscription ) { |
|
92 | + */ |
|
93 | + public function maybe_renew_subscription( $subscription ) { |
|
94 | 94 | |
95 | 95 | // Ensure its our subscription && it's active. |
96 | 96 | if ( $this->id == $subscription->get_gateway() && $subscription->has_status( 'active trialling' ) ) { |
@@ -110,13 +110,13 @@ discard block |
||
110 | 110 | } |
111 | 111 | |
112 | 112 | /** |
113 | - * Processes invoice addons. |
|
114 | - * |
|
115 | - * @param WPInv_Invoice $invoice |
|
116 | - * @param GetPaid_Form_Item[] $items |
|
117 | - * @return WPInv_Invoice |
|
118 | - */ |
|
119 | - public function process_addons( $invoice, $items ) { |
|
113 | + * Processes invoice addons. |
|
114 | + * |
|
115 | + * @param WPInv_Invoice $invoice |
|
116 | + * @param GetPaid_Form_Item[] $items |
|
117 | + * @return WPInv_Invoice |
|
118 | + */ |
|
119 | + public function process_addons( $invoice, $items ) { |
|
120 | 120 | |
121 | 121 | foreach ( $items as $item ) { |
122 | 122 | $invoice->add_item( $item ); |