actions.php
8 years ago
functions.php
8 years ago
manual.php
8 years ago
offline-donations.php
8 years ago
paypal-standard.php
8 years ago
functions.php
355 lines
| 1 | <?php |
| 2 | /** |
| 3 | * Gateway Functions |
| 4 | * |
| 5 | * @package Give |
| 6 | * @subpackage Gateways |
| 7 | * @copyright Copyright (c) 2016, WordImpress |
| 8 | * @license https://opensource.org/licenses/gpl-license GNU Public License |
| 9 | * @since 1.0 |
| 10 | */ |
| 11 | |
| 12 | // Exit if accessed directly. |
| 13 | if ( ! defined( 'ABSPATH' ) ) { |
| 14 | exit; |
| 15 | } |
| 16 | |
| 17 | /** |
| 18 | * Returns a list of all available gateways. |
| 19 | * |
| 20 | * @since 1.0 |
| 21 | * @return array $gateways All the available gateways |
| 22 | */ |
| 23 | function give_get_payment_gateways() { |
| 24 | // Default, built-in gateways |
| 25 | $gateways = array( |
| 26 | 'paypal' => array( |
| 27 | 'admin_label' => __( 'PayPal Standard', 'give' ), |
| 28 | 'checkout_label' => __( 'PayPal', 'give' ), |
| 29 | ), |
| 30 | 'manual' => array( |
| 31 | 'admin_label' => __( 'Test Donation', 'give' ), |
| 32 | 'checkout_label' => __( 'Test Donation', 'give' ) |
| 33 | ), |
| 34 | ); |
| 35 | |
| 36 | return apply_filters( 'give_payment_gateways', $gateways ); |
| 37 | |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * Returns a list of all enabled gateways. |
| 42 | * |
| 43 | * @since 1.0 |
| 44 | * |
| 45 | * @param int $form_id Form ID |
| 46 | * |
| 47 | * @return array $gateway_list All the available gateways |
| 48 | */ |
| 49 | function give_get_enabled_payment_gateways( $form_id = 0 ) { |
| 50 | |
| 51 | $gateways = give_get_payment_gateways(); |
| 52 | |
| 53 | $enabled = isset( $_POST['gateways'] ) ? $_POST['gateways'] : give_get_option( 'gateways' ); |
| 54 | |
| 55 | $gateway_list = array(); |
| 56 | |
| 57 | foreach ( $gateways as $key => $gateway ) { |
| 58 | if ( isset( $enabled[ $key ] ) && $enabled[ $key ] == 1 ) { |
| 59 | $gateway_list[ $key ] = $gateway; |
| 60 | } |
| 61 | } |
| 62 | |
| 63 | // Set order of payment gateway in list. |
| 64 | $gateway_list = give_get_ordered_payment_gateways( $gateway_list ); |
| 65 | |
| 66 | return apply_filters( 'give_enabled_payment_gateways', $gateway_list, $form_id ); |
| 67 | } |
| 68 | |
| 69 | /** |
| 70 | * Checks whether a specified gateway is activated. |
| 71 | * |
| 72 | * @since 1.0 |
| 73 | * |
| 74 | * @param string $gateway Name of the gateway to check for |
| 75 | * |
| 76 | * @return boolean true if enabled, false otherwise |
| 77 | */ |
| 78 | function give_is_gateway_active( $gateway ) { |
| 79 | $gateways = give_get_enabled_payment_gateways(); |
| 80 | |
| 81 | $ret = array_key_exists( $gateway, $gateways ); |
| 82 | |
| 83 | return apply_filters( 'give_is_gateway_active', $ret, $gateway, $gateways ); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Gets the default payment gateway selected from the Give Settings |
| 88 | * |
| 89 | * @since 1.0 |
| 90 | * |
| 91 | * @param $form_id int ID of the Give Form |
| 92 | * |
| 93 | * @return string Gateway ID |
| 94 | */ |
| 95 | function give_get_default_gateway( $form_id ) { |
| 96 | |
| 97 | $enabled_gateways = array_keys( give_get_enabled_payment_gateways() ); |
| 98 | $default_gateway = give_get_option('default_gateway'); |
| 99 | $default = ! empty( $default_gateway ) && give_is_gateway_active( $default_gateway ) ? $default_gateway : $enabled_gateways[0]; |
| 100 | $form_default = give_get_meta( $form_id, '_give_default_gateway', true ); |
| 101 | |
| 102 | // Single Form settings varies compared to the Global default settings. |
| 103 | if ( |
| 104 | ! empty( $form_default ) && |
| 105 | $form_id !== null && |
| 106 | $default !== $form_default && |
| 107 | 'global' !== $form_default && |
| 108 | give_is_gateway_active( $form_default ) |
| 109 | ) { |
| 110 | $default = $form_default; |
| 111 | } |
| 112 | |
| 113 | return apply_filters( 'give_default_gateway', $default ); |
| 114 | } |
| 115 | |
| 116 | /** |
| 117 | * Returns the admin label for the specified gateway |
| 118 | * |
| 119 | * @since 1.0 |
| 120 | * |
| 121 | * @param string $gateway Name of the gateway to retrieve a label for |
| 122 | * |
| 123 | * @return string Gateway admin label |
| 124 | */ |
| 125 | function give_get_gateway_admin_label( $gateway ) { |
| 126 | $gateways = give_get_payment_gateways(); |
| 127 | $label = isset( $gateways[ $gateway ] ) ? $gateways[ $gateway ]['admin_label'] : $gateway; |
| 128 | $payment = isset( $_GET['id'] ) ? absint( $_GET['id'] ) : false; |
| 129 | |
| 130 | if ( $gateway == 'manual' && $payment ) { |
| 131 | if ( give_donation_amount( $payment ) == 0 ) { |
| 132 | $label = __( 'Test Donation', 'give' ); |
| 133 | } |
| 134 | } |
| 135 | |
| 136 | return apply_filters( 'give_gateway_admin_label', $label, $gateway ); |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Returns the checkout label for the specified gateway |
| 141 | * |
| 142 | * @since 1.0 |
| 143 | * |
| 144 | * @param string $gateway Name of the gateway to retrieve a label for |
| 145 | * |
| 146 | * @return string Checkout label for the gateway |
| 147 | */ |
| 148 | function give_get_gateway_checkout_label( $gateway ) { |
| 149 | $gateways = give_get_payment_gateways(); |
| 150 | $label = isset( $gateways[ $gateway ] ) ? $gateways[ $gateway ]['checkout_label'] : $gateway; |
| 151 | |
| 152 | if ( $gateway == 'manual' ) { |
| 153 | $label = __( 'Test Donation', 'give' ); |
| 154 | } |
| 155 | |
| 156 | return apply_filters( 'give_gateway_checkout_label', $label, $gateway ); |
| 157 | } |
| 158 | |
| 159 | /** |
| 160 | * Returns the options a gateway supports |
| 161 | * |
| 162 | * @since 1.8 |
| 163 | * |
| 164 | * @param string $gateway ID of the gateway to retrieve a label for |
| 165 | * |
| 166 | * @return array Options the gateway supports |
| 167 | */ |
| 168 | function give_get_gateway_supports( $gateway ) { |
| 169 | $gateways = give_get_enabled_payment_gateways(); |
| 170 | $supports = isset( $gateways[ $gateway ]['supports'] ) ? $gateways[ $gateway ]['supports'] : array(); |
| 171 | |
| 172 | return apply_filters( 'give_gateway_supports', $supports, $gateway ); |
| 173 | } |
| 174 | |
| 175 | /** |
| 176 | * Sends all the payment data to the specified gateway |
| 177 | * |
| 178 | * @since 1.0 |
| 179 | * |
| 180 | * @param string $gateway Name of the gateway |
| 181 | * @param array $payment_data All the payment data to be sent to the gateway |
| 182 | * |
| 183 | * @return void |
| 184 | */ |
| 185 | function give_send_to_gateway( $gateway, $payment_data ) { |
| 186 | |
| 187 | $payment_data['gateway_nonce'] = wp_create_nonce( 'give-gateway' ); |
| 188 | |
| 189 | /** |
| 190 | * Fires while loading payment gateway via AJAX. |
| 191 | * |
| 192 | * The dynamic portion of the hook name '$gateway' must match the ID used when registering the gateway. |
| 193 | * |
| 194 | * @since 1.0 |
| 195 | * |
| 196 | * @param array $payment_data All the payment data to be sent to the gateway. |
| 197 | */ |
| 198 | do_action( "give_gateway_{$gateway}", $payment_data ); |
| 199 | } |
| 200 | |
| 201 | |
| 202 | /** |
| 203 | * Determines the currently selected donation payment gateway. |
| 204 | * |
| 205 | * @access public |
| 206 | * @since 1.0 |
| 207 | * |
| 208 | * @param int $form_id The ID of the Form |
| 209 | * |
| 210 | * @return string $enabled_gateway The slug of the gateway |
| 211 | */ |
| 212 | function give_get_chosen_gateway( $form_id ) { |
| 213 | |
| 214 | $request_form_id = isset( $_REQUEST['give_form_id'] ) ? $_REQUEST['give_form_id'] : 0; |
| 215 | |
| 216 | // Back to check if 'form-id' is present. |
| 217 | if ( empty( $request_form_id ) ) { |
| 218 | $request_form_id = isset( $_REQUEST['form-id'] ) ? $_REQUEST['form-id'] : 0; |
| 219 | } |
| 220 | |
| 221 | $request_payment_mode = isset( $_REQUEST['payment-mode'] ) ? $_REQUEST['payment-mode'] : ''; |
| 222 | $chosen = false; |
| 223 | |
| 224 | // If both 'payment-mode' and 'form-id' then set for only this form. |
| 225 | if ( ! empty( $request_form_id ) && $form_id == $request_form_id ) { |
| 226 | $chosen = $request_payment_mode; |
| 227 | } elseif ( empty( $request_form_id ) && $request_payment_mode ) { |
| 228 | // If no 'form-id' but there is 'payment-mode'. |
| 229 | $chosen = $request_payment_mode; |
| 230 | } |
| 231 | |
| 232 | // Get the enable gateway based of chosen var. |
| 233 | if ( $chosen && give_is_gateway_active( $chosen ) ) { |
| 234 | $enabled_gateway = urldecode( $chosen ); |
| 235 | } else { |
| 236 | $enabled_gateway = give_get_default_gateway( $form_id ); |
| 237 | } |
| 238 | |
| 239 | return apply_filters( 'give_chosen_gateway', $enabled_gateway ); |
| 240 | |
| 241 | } |
| 242 | |
| 243 | /** |
| 244 | * Record a log entry |
| 245 | * |
| 246 | * A wrapper function for the Give_Logging class add() method. |
| 247 | * |
| 248 | * @since 1.0 |
| 249 | * @since 2.0 Use global logs object |
| 250 | * |
| 251 | * @param string $title Log title. Default is empty. |
| 252 | * @param string $message Log message. Default is empty. |
| 253 | * @param int $parent Parent log. Default is 0. |
| 254 | * @param string $type Log type. Default is null. |
| 255 | * |
| 256 | * @return int ID of the new log entry. |
| 257 | */ |
| 258 | function give_record_log( $title = '', $message = '', $parent = 0, $type = null ) { |
| 259 | return Give()->logs->add( $title, $message, $parent, $type ); |
| 260 | } |
| 261 | |
| 262 | /** |
| 263 | * Record a gateway error. |
| 264 | * |
| 265 | * A simple wrapper function for give_record_log(). |
| 266 | * |
| 267 | * @access public |
| 268 | * @since 1.0 |
| 269 | * |
| 270 | * @param string $title Title of the log entry (default: empty) |
| 271 | * @param string $message Message to store in the log entry (default: empty) |
| 272 | * @param int $parent Parent log entry (default: 0) |
| 273 | * |
| 274 | * @return int ID of the new log entry |
| 275 | */ |
| 276 | function give_record_gateway_error( $title = '', $message = '', $parent = 0 ) { |
| 277 | $title = empty( $title ) ? esc_html__( 'Payment Error', 'give' ) : $title; |
| 278 | |
| 279 | return give_record_log( $title, $message, $parent, 'gateway_error' ); |
| 280 | } |
| 281 | |
| 282 | /** |
| 283 | * Counts the number of donations made with a gateway. |
| 284 | * |
| 285 | * @since 1.0 |
| 286 | * |
| 287 | * @param string $gateway_id |
| 288 | * @param array|string $status |
| 289 | * |
| 290 | * @return int |
| 291 | */ |
| 292 | function give_count_sales_by_gateway( $gateway_id = 'paypal', $status = 'publish' ) { |
| 293 | |
| 294 | $ret = 0; |
| 295 | $args = array( |
| 296 | 'meta_key' => '_give_payment_gateway', |
| 297 | 'meta_value' => $gateway_id, |
| 298 | 'nopaging' => true, |
| 299 | 'post_type' => 'give_payment', |
| 300 | 'post_status' => $status, |
| 301 | 'fields' => 'ids', |
| 302 | ); |
| 303 | |
| 304 | $payments = new WP_Query( $args ); |
| 305 | |
| 306 | if ( $payments ) { |
| 307 | $ret = $payments->post_count; |
| 308 | } |
| 309 | |
| 310 | return $ret; |
| 311 | } |
| 312 | |
| 313 | |
| 314 | /** |
| 315 | * Returns a ordered list of all available gateways. |
| 316 | * |
| 317 | * @since 1.4.5 |
| 318 | * |
| 319 | * @param array $gateways List of payment gateways |
| 320 | * |
| 321 | * @return array $gateways All the available gateways |
| 322 | */ |
| 323 | function give_get_ordered_payment_gateways( $gateways ) { |
| 324 | |
| 325 | // Get gateways setting. |
| 326 | $gateways_setting = isset( $_POST['gateways'] ) ? $_POST['gateways'] : give_get_option( 'gateways' ); |
| 327 | |
| 328 | // Return from here if we do not have gateways setting. |
| 329 | if ( empty( $gateways_setting ) ) { |
| 330 | return $gateways; |
| 331 | } |
| 332 | |
| 333 | // Reverse array to order payment gateways. |
| 334 | $gateways_setting = array_reverse( $gateways_setting ); |
| 335 | |
| 336 | // Reorder gateways array |
| 337 | foreach ( $gateways_setting as $gateway_key => $value ) { |
| 338 | |
| 339 | $new_gateway_value = isset( $gateways[ $gateway_key ] ) ? $gateways[ $gateway_key ] : ''; |
| 340 | unset( $gateways[ $gateway_key ] ); |
| 341 | |
| 342 | if ( ! empty( $new_gateway_value ) ) { |
| 343 | $gateways = array_merge( array( $gateway_key => $new_gateway_value ), $gateways ); |
| 344 | } |
| 345 | } |
| 346 | |
| 347 | /** |
| 348 | * Filter payment gateways order. |
| 349 | * |
| 350 | * @since 1.7 |
| 351 | * |
| 352 | * @param array $gateways All the available gateways |
| 353 | */ |
| 354 | return apply_filters( 'give_payment_gateways_order', $gateways ); |
| 355 | } |