Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

PHPCS passing for abstract-wc-payment-gateway.php

This commit is contained in:
Gerhard Potgieter 2018-03-05 13:48:54 +02:00
parent 440358a4f2
commit 940ab475d4
1 changed files with 54 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
includes/abstracts/abstract-wc-payment-gateway.php
View File

@ -1,4 +1,13 @@
<?php
/**
* Abstract payment gateway
*
* Hanldes generic payment gateway functionality which is extended by idividual payment gateways.
*
* @class WC_Payment_Gateway
* @version 2.1.0
* @package WooCommerce/Abstracts
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
@ -13,91 +22,103 @@ if ( ! defined( 'ABSPATH' ) ) {
* @extends WC_Settings_API
* @version 2.1.0
* @package WooCommerce/Abstracts
* @category Abstract Class
* @author WooThemes
*/
abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Set if the place order button should be renamed on selection.
*
* @var string
*/
public $order_button_text;
/**
* yes or no based on whether the method is enabled.
* Yes or no based on whether the method is enabled.
*
* @var string
*/
public $enabled = 'yes';
/**
* Payment method title for the frontend.
*
* @var string
*/
public $title;
/**
* Payment method description for the frontend.
*
* @var string
*/
public $description;
/**
* Chosen payment method id.
*
* @var bool
*/
public $chosen;
/**
* Gateway title.
*
* @var string
*/
public $method_title = '';
/**
* Gateway description.
*
* @var string
*/
public $method_description = '';
/**
* True if the gateway shows fields on the checkout.
*
* @var bool
*/
public $has_fields;
/**
* Countries this gateway is allowed for.
*
* @var array
*/
public $countries;
/**
* Available for all counties or specific.
*
* @var string
*/
public $availability;
/**
* Icon for the gateway.
*
* @var string
*/
public $icon;
/**
* Supported features such as 'default_credit_card_form', 'refunds'.
*
* @var array
*/
public $supports = array( 'products' );
/**
* Maximum transaction amount, zero does not define a maximum.
*
* @var int
*/
public $max_amount = 0;
/**
* Optional URL to view a transaction.
*
* @var string
*/
public $view_transaction_url = '';
@ -105,23 +126,26 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Optional label to show for "new payment method" in the payment
* method/token selection radio selection.
*
* @var string
*/
public $new_method_label = '';
/**
* Contains a users saved tokens for this gateway.
*
* @var array
*/
protected $tokens = array();
/**
* Returns a users saved tokens for this gateway.
*
* @since 2.6.0
* @return array
*/
public function get_tokens() {
if ( sizeof( $this->tokens ) > 0 ) {
if ( count( $this->tokens ) > 0 ) {
return $this->tokens;
}
@ -134,6 +158,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Return the title for admin screens.
*
* @return string
*/
public function get_method_title() {
@ -142,6 +167,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Return the description for admin screens.
*
* @return string
*/
public function get_method_description() {
@ -168,7 +194,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Get the return url (thank you page).
*
* @param WC_Order $order
* @param WC_Order $order Order object.
* @return string
*/
public function get_return_url( $order = null ) {
@ -218,7 +244,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
$order = wc_get_order( $order_id );
$total = (float) $order->get_total();
// Gets order total from cart/checkout.
// Gets order total from cart/checkout.
} elseif ( 0 < WC()->cart->total ) {
$total = (float) WC()->cart->total;
}
@ -300,7 +326,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
* 'redirect' => $this->get_return_url( $order )
* );
*
* @param int $order_id
* @param int $order_id Order ID.
* @return array
*/
public function process_payment( $order_id ) {
@ -313,9 +339,9 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
* If the gateway declares 'refunds' support, this will allow it to refund.
* a passed in amount.
*
* @param int $order_id
* @param float $amount
* @param string $reason
* @param int $order_id Order ID.
* @param float $amount Refund amount.
* @param string $reason Refund reason.
* @return boolean True or false based on success, or a WP_Error object.
*/
public function process_refund( $order_id, $amount = null, $reason = '' ) {
@ -329,15 +355,18 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
*
* @return bool
*/
public function validate_fields() { return true; }
public function validate_fields() {
return true;
}
/**
* If There are no payment fields show the description if set.
* Override this in your gateway if you have some.
*/
public function payment_fields() {
if ( $description = $this->get_description() ) {
echo wpautop( wptexturize( $description ) );
$description = $this->get_description();
if ( $description ) {
echo wpautop( wptexturize( $description ) ); // @codingStandardsIgnoreLine.
}
if ( $this->supports( 'default_credit_card_form' ) ) {
@ -361,12 +390,13 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Core credit card form which gateways can used if needed. Deprecated - inherit WC_Payment_Gateway_CC instead.
* @param array $args
* @param array $fields
*
* @param array $args Arguments.
* @param array $fields Fields.
*/
public function credit_card_form( $args = array(), $fields = array() ) {
wc_deprecated_function( 'credit_card_form', '2.6', 'WC_Payment_Gateway_CC->form' );
$cc_form = new WC_Payment_Gateway_CC;
$cc_form = new WC_Payment_Gateway_CC();
$cc_form->id = $this->id;
$cc_form->supports = $this->supports;
$cc_form->form();
@ -374,6 +404,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Enqueues our tokenization script to handle some of the new form options.
*
* @since 2.6.0
*/
public function tokenization_script() {
@ -387,6 +418,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Grab and display our saved payment methods.
*
* @since 2.6.0
*/
public function saved_payment_methods() {
@ -399,14 +431,15 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
$html .= $this->get_new_payment_method_option_html();
$html .= '</ul>';
echo apply_filters( 'wc_payment_gateway_form_saved_payment_methods_html', $html, $this );
echo apply_filters( 'wc_payment_gateway_form_saved_payment_methods_html', $html, $this ); // @codingStandardsIgnoreLine
}
/**
* Gets saved payment method HTML from a token.
*
* @since 2.6.0
* @param WC_Payment_Token $token Payment Token
* @return string Generated payment method HTML
* @param WC_Payment_Token $token Payment Token.
* @return string Generated payment method HTML
*/
public function get_saved_payment_method_option_html( $token ) {
$html = sprintf(
@ -426,6 +459,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Displays a radio button for entering a new payment method (new CC details) instead of using a saved method.
* Only displayed when a gateway supports tokenization.
*
* @since 2.6.0
*/
public function get_new_payment_method_option_html() {
@ -444,6 +478,7 @@ abstract class WC_Payment_Gateway extends WC_Settings_API {
/**
* Outputs a checkbox for saving a new payment method to the database.
*
* @since 2.6.0
*/
public function save_payment_method_checkbox() {