WPInv_Subscription::get_child_payments() - Code Metrics - Inspection of "authorize.net improvements" - AyeCode/invoicing - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Pull Request — master (#390)

by Brian
created 2020-09-05 10:12 UTC
WPInv_Subscription::get_child_payments() A

↳ Parent: WPInv_Subscription
Complexity

Conditions	1
Paths	1
Size

Total Lines	11
Code Lines	8
Duplication

Lines	0
Ratio	0 %
Importance

Changes	1
Bugs	0	Features	0
Metric	Value
cc	1
eloc	8
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	11
rs	10
<?php

// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}


/**
 * The Subscription Class
 *
 * @since  1.0.0
 */
class WPInv_Subscription {

	private $subs_db;

	public $id                = 0;
	public $customer_id       = 0;
	public $period            = '';
	public $initial_amount    = '';
	public $recurring_amount  = '';
	public $bill_times        = 0;
	public $transaction_id    = '';
	public $parent_payment_id = 0;
	public $product_id        = 0;
	public $created           = '0000-00-00 00:00:00';
	public $expiration        = '0000-00-00 00:00:00';
	public $trial_period      = '';
	public $status            = 'pending';
	public $profile_id        = '';
	public $gateway           = '';
	public $customer;

	/**
	 * Get us started
	 *
	 * @since  1.0.0
	 * @return void
	 */
	function __construct( $_id_or_object = 0, $_by_profile_id = false ) {

		$this->subs_db = new WPInv_Subscriptions_DB;

		if( $_by_profile_id ) {

			$_sub = $this->subs_db->get_by( 'profile_id', $_id_or_object );

			if( empty( $_sub ) ) {
				return false;

			}

			$_id_or_object = $_sub;

		}

		return $this->setup_subscription( $_id_or_object );
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
	}

	/**
	 * Setup the subscription object
	 *
	 * @since  1.0.0
	 * @return void
	 */
	private function setup_subscription( $id_or_object = 0 ) {

		if( empty( $id_or_object ) ) {
			return false;

		}

		if( is_numeric( $id_or_object ) ) {

			$sub = $this->subs_db->get( $id_or_object );

		} elseif( is_object( $id_or_object ) ) {

			$sub = $id_or_object;

		}

		if( empty( $sub ) ) {
			return false;

		}

		foreach( $sub as $key => $value ) {
			$this->$key = $value;
		}

		$this->customer = get_userdata( $this->customer_id );
		$this->gateway  = wpinv_get_payment_gateway( $this->parent_payment_id );
		$this->gateway  = /** @scrutinizer ignore-deprecated */ wpinv_get_payment_gateway( $this->parent_payment_id );

		do_action( 'wpinv_recurring_setup_subscription', $this );

		return $this;

	}

	/**
	 * Magic __get function to dispatch a call to retrieve a private property
	 *
	 * @since 1.0.0
	 */
	public function __get( $key ) {

		if( method_exists( $this, 'get_' . $key ) ) {

			return call_user_func( array( $this, 'get_' . $key ) );

		} else {

			return new WP_Error( 'wpinv-subscription-invalid-property', sprintf( __( 'Can\'t get property %s', 'invoicing' ), $key ) );

		}

	}

	/**
	 * Creates a subscription
	 *
	 * @since  1.0.0
	 * @param  array  $data Array of attributes for a subscription
	 * @return mixed  false if data isn't passed and class not instantiated for creation
	 */
	public function create( $data = array() ) {

		if ( $this->id != 0 ) {
			return false;
		}

		$defaults = array(
			'customer_id'       => 0,
			'frequency'         => '',
			'period'            => '',
			'initial_amount'    => '',
			'recurring_amount'  => '',
			'bill_times'        => 0,
			'parent_payment_id' => 0,
			'product_id'        => 0,
			'created'           => '',
			'expiration'        => '',
			'status'            => '',
			'profile_id'        => '',
		);

		$args = wp_parse_args( $data, $defaults );
if ( ! in_array($value, array('this-is-allowed', 'and-this-too'), true)) {
    throw new \InvalidArgumentException('This input is not allowed.');
}

		if( $args['expiration'] && strtotime( 'NOW', current_time( 'timestamp' ) ) > strtotime( $args['expiration'], current_time( 'timestamp' ) ) ) {

			if( 'active' == $args['status'] || 'trialling' == $args['status'] ) {

				// Force an active subscription to expired if expiration date is in the past
				$args['status'] = 'expired';

			}
		}

		do_action( 'wpinv_subscription_pre_create', $args );

		$id = $this->subs_db->insert( $args, 'subscription' );

		do_action( 'wpinv_subscription_post_create', $id, $args );

		return $this->setup_subscription( $id );
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {

	}

	/**
	 * Updates a subscription
	 *
	 * @since  1.0.0
	 * @param  array $args Array of fields to update
	 * @return bool
	 */
	public function update( $args = array() ) {

		$ret = $this->subs_db->update( $this->id, $args );

		do_action( 'wpinv_recurring_update_subscription', $this->id, $args, $this );

		if ( $ret && isset( $args['profile_id'] ) ) {
			update_post_meta( $this->parent_payment_id, 'subscription_id', $args['profile_id'] );
		}

		return $ret;

	}

	/**
	 * Delete the subscription
	 *
	 * @since  1.0.0
	 * @return bool
	 */
	public function delete() {
		return $this->subs_db->delete( $this->id );
	}

    /**
     * Retrieves the parent payment ID
     *
     * @since  1.0.0
     * @return int
     */
    public function get_original_payment_id() {
        return $this->parent_payment_id;
    }

    /**
     * Retrieve renewal payments for a subscription
     *
     * @since  1.0.0
     * @return array
     */
    public function get_child_payments() {
        $payments = get_posts( array(
            'post_parent'    => (int) $this->parent_payment_id,
            'posts_per_page' => '999',
            'post_status'    => array( 'publish', 'wpi-processing', 'wpi-renewal' ),
            'orderby'        => 'ID',
            'order'          => 'DESC',
            'post_type'      => 'wpi_invoice'
        ) );

        return $payments;
    }

    /**
     * Counts the number of payments made to the subscription
     *
     * @since  2.4
     * @return int
     */
    public function get_total_payments() {
        $child_payments = $this->get_child_payments();
        $total_payments = !empty( $child_payments ) ? count( $child_payments ) : 0;

        if ( 'pending' != $this->status ) {
                $total_payments++;
        }

        return $total_payments;
    }

    /**
     * Returns the number of times the subscription has been billed
     *
     * @since  1.0.2
     * @return int
     */
    public function get_times_billed() {
        $times_billed = (int)$this->get_total_payments();

        if ( ! empty( $this->trial_period ) && $times_billed > 0 ) {
            $times_billed--;
        }

        return $times_billed;
    }

    /**
     * Records a new payment on the subscription
     *
     * @since  2.4
     * @param  array $args Array of values for the payment, including amount and transaction ID
	 * @param  WPInv_Invoice $invoice
     * @return bool
     */
    public function add_payment( $args = array(), $invoice = false ) {

		// Process each payment once.
        if ( ! empty( $args['transaction_id'] ) && $this->payment_exists( $args['transaction_id'] ) ) {
            return false;
        }

		// Are we creating a new invoice?
		if ( empty( $invoice ) ) {
			$invoice = $this->create_payment();

			if ( empty( $invoice ) ) {
				return false;
			}

			$invoice->set_status( 'wpi-renewal' );

		}

		// Maybe set a transaction id.
		if ( ! empty( $args['transaction_id'] ) ) {
			$invoice->set_transaction_id( $args['transaction_id'] );
		}

		// Set the completed date.
		$invoice->set_completed_date( current_time( 'mysql' ) );

		// And the gateway.
		if ( ! empty( $args['gateway'] ) ) {
			$invoice->set_gateway( $args['gateway'] );
		}

		$invoice->save();

		if ( ! $invoice->get_id() ) {
			return 0;

		}

		do_action( 'getpaid_after_create_subscription_renewal_invoice', $invoice, $this );
		do_action( 'wpinv_recurring_add_subscription_payment', $invoice, $this );
        do_action( 'wpinv_recurring_record_payment', $invoice->get_id(), $this->parent_payment_id, $invoice->get_recurring_total(), $invoice->get_transaction_id() );

        update_post_meta( $invoice->get_id(), '_wpinv_subscription_id', $this->id );

        return $invoice->get_id();

	}

	/**
     * Creates a new invoice and returns it.
     *
     * @since  1.0.19
     * @param  array $args Array of values for the payment, including amount and transaction ID
     * @return WPInv_Invoice|bool
     */
    public function create_payment() {

		// Do we have a parent invoice?
        if ( ! $this->parent_payment_id ) {
            return false;
        }

		// Ensure that the parent invoice is available.
        $parent_invoice = wpinv_get_invoice( $this->parent_payment_id );
        if ( empty( $parent_invoice ) ) {
            return false;
        }

		// Duplicate the parent invoice.
		$invoice = new WPInv_Invoice();
		$invoice->set_props( $parent_invoice->get_data() );
		$invoice->set_id( 0 );
		$invoice->set_parent_id( $parent_invoice->get_parent() );
		$invoice->set_transaction_id( '' );
		$invoice->set_key( $invoice->generate_key( 'renewal_' ) );
		$invoice->set_number( '' );
		$invoice->set_completed_date( '' );
		$invoice->set_status( 'wpi-pending' );
		$invoice->recalculate_total();
		$invoice->save();

		return $invoice->get_id() ? $invoice : false;
    }

	/**
	 * Retrieves the transaction ID from the subscription
	 *
	 * @since  1.0.0
	 * @return bool
	 */
	public function get_transaction_id() {

		if( empty( $this->transaction_id ) ) {

			$txn_id = wpinv_get_payment_transaction_id( $this->parent_payment_id );
			$txn_id = /** @scrutinizer ignore-deprecated */ wpinv_get_payment_transaction_id( $this->parent_payment_id );

			if( ! empty( $txn_id ) && (int) $this->parent_payment_id !== (int) $txn_id ) {
				$this->set_transaction_id( $txn_id );
			}

		}

		return $this->transaction_id;

	}

	/**
	 * Stores the transaction ID for the subscription purchase
	 *
	 * @since  1.0.0.4
	 * @return bool
	 */
	public function set_transaction_id( $txn_id = '' ) {
		$this->update( array( 'transaction_id' => $txn_id ) );
		$this->transaction_id = $txn_id;
	}

	/**
	 * Renews a subscription
	 *
	 * @since  1.0.0
	 * @return bool
	 */
	public function renew() {

		// Calculate new expiration
		$expires        = $this->get_expiration_time();
		$base_date      = $expires > current_time( 'timestamp' ) ? $expires : current_time( 'timestamp' );
		$frequency      = isset( $this->frequency ) ? $this->frequency : 1;

		$new_expiration = strtotime( "+ {$frequency} {$this->period}", strtotime( $base_date ) );
		$new_expiration = apply_filters( 'wpinv_subscription_renewal_expiration', date( 'Y-m-d H:i:s', $new_expiration ), $this->id, $this );

		do_action( 'wpinv_subscription_pre_renew', $this->id, $new_expiration, $this );

		$this->status = 'active';
		$times_billed = $this->get_times_billed();

		// Complete subscription if applicable
		if ( $this->bill_times > 0 && $times_billed >= $this->bill_times ) {
			$this->complete();
			$this->status = 'completed';
			return;
		}

		$args = array(
			'expiration' => $new_expiration,
			'status'     => $this->status,
		);

        $this->subs_db->update( $this->id, $args );

		$this->expiration = $new_expiration;

		do_action( 'wpinv_subscription_post_renew', $this->id, $new_expiration, $this );
		do_action( 'wpinv_recurring_set_subscription_status', $this->id, $this->status, $this );

	}

	/**
	 * Marks a subscription as completed
	 *
	 * Subscription is completed when the number of payments matches the billing_times field
	 *
	 * @since  1.0.0
	 * @return void
	 */
	public function complete() {

		// Only mark a subscription as complete if it's not already cancelled.
		if ( 'cancelled' === $this->status ) {
			return;
		}

		$args = array(
			'status' => 'completed'
		);

		if( $this->subs_db->update( $this->id, $args ) ) {

			$this->status = 'completed';

			do_action( 'wpinv_subscription_completed', $this->id, $this );

		}

	}

	/**
	 * Marks a subscription as expired
	 *
	 * Subscription is completed when the billing times is reached
	 *
	 * @since  1.0.0
	 * @param  $check_expiration bool True if expiration date should be checked with merchant processor before expiring
	 * @return void
	 */
	public function expire( $check_expiration = false ) {

		$expiration = $this->expiration;

		if( $check_expiration ) {

			// check_expiration() updates $this->expiration so compare to $expiration above

			if( $expiration < $this->get_expiration() && current_time( 'timestamp' ) < $this->get_expiration_time() ) {

				return false; // Do not mark as expired since real expiration date is in the future

			}

		}

		$args = array(
			'status' => 'expired'
		);

		if( $this->subs_db->update( $this->id, $args ) ) {

			$this->status = 'expired';

			do_action( 'wpinv_subscription_expired', $this->id, $this );

		}

	}

	/**
	 * Marks a subscription as failing
	 *
	 * @since  2.4.2
	 * @return void
	 */
	public function failing() {

		$args = array(
			'status' => 'failing'
		);

		if( $this->subs_db->update( $this->id, $args ) ) {

			$this->status = 'failing';

			do_action( 'wpinv_subscription_failing', $this->id, $this );
			do_action( 'wpinv_recurring_payment_failed', $this );

		}

	}

    /**
     * Marks a subscription as cancelled
     *
     * @since  1.0.0
     * @return void
     */
    public function cancel() {
        if ( 'cancelled' === $this->status ) {
            return; // Already cancelled
        }

        $args = array(
            'status' => 'cancelled'
        );

        if ( $this->subs_db->update( $this->id, $args ) ) {
            if ( is_user_logged_in() ) {
                $userdata = get_userdata( get_current_user_id() );
                $user     = $userdata->display_name;
            } else {
                $user = __( 'gateway', 'invoicing' );
            }

            $note = sprintf( __( 'Subscription has been cancelled by %s', 'invoicing' ), $user );
            wpinv_insert_payment_note( $this->parent_payment_id, $note, '', '', true );
            /** @scrutinizer ignore-deprecated */ wpinv_insert_payment_note( $this->parent_payment_id, $note, '', '', true );

            $this->status = 'cancelled';

            do_action( 'wpinv_subscription_cancelled', $this->id, $this );
        }
    }

	/**
	 * Determines if subscription can be cancelled
	 *
	 * This method is filtered by payment gateways in order to return true on subscriptions
	 * that can be cancelled with a profile ID through the merchant processor
	 *
	 * @since  1.0.0
	 * @return bool
	 */
	public function can_cancel() {
        $ret = false;
	    if( $this->gateway === 'manual' || in_array( $this->status, $this->get_cancellable_statuses() ) ) {
            $ret = true;
        }
		return apply_filters( 'wpinv_subscription_can_cancel', $ret, $this );
	}

    /**
     * Returns an array of subscription statuses that can be cancelled
     *
     * @access      public
     * @since       1.0.0
     * @return      array
     */
    public function get_cancellable_statuses() {
        return apply_filters( 'wpinv_recurring_cancellable_statuses', array( 'active', 'trialling', 'failing' ) );
    }

	/**
	 * Retrieves the URL to cancel subscription
	 *
	 * @since  1.0.0
	 * @return string
	 */
	public function get_cancel_url() {

		$url = wp_nonce_url( add_query_arg( array( 'wpinv_action' => 'cancel_subscription', 'sub_id' => $this->id ) ), 'wpinv-recurring-cancel' );

		return apply_filters( 'wpinv_subscription_cancel_url', $url, $this );
	}

	/**
	 * Determines if subscription can be manually renewed
	 *
	 * This method is filtered by payment gateways in order to return true on subscriptions
	 * that can be renewed manually
	 *
	 * @since  2.5
	 * @return bool
	 */
	public function can_renew() {

		return apply_filters( 'wpinv_subscription_can_renew', true, $this );
	}

	/**
	 * Retrieves the URL to renew a subscription
	 *
	 * @since  2.5
	 * @return string
	 */
	public function get_renew_url() {

		$url = wp_nonce_url( add_query_arg( array( 'wpinv_action' => 'renew_subscription', 'sub_id' => $this->id ) ), 'wpinv-recurring-renew' );

		return apply_filters( 'wpinv_subscription_renew_url', $url, $this );
	}

	/**
	 * Determines if subscription can have their payment method updated
	 *
	 * @since  1.0.0
	 * @return bool
	 */
	public function can_update() {
		return apply_filters( 'wpinv_subscription_can_update', false, $this );
	}

	/**
	 * Retrieves the URL to update subscription
	 *
	 * @since  1.0.0
	 * @return void
	 */
	public function get_update_url() {

		$url = add_query_arg( array( 'action' => 'update', 'subscription_id' => $this->id ) );

		return apply_filters( 'wpinv_subscription_update_url', $url, $this );

	}

	/**
	 * Determines if subscription is active
	 *
	 * @since  1.0.0
	 * @return void
	 */
	public function is_active() {

		$ret = false;

		if( ! $this->is_expired() && ( $this->status == 'active' || $this->status == 'cancelled' || $this->status == 'trialling' ) ) {
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
if ($a->getObject()) {
			$ret = true;
		}

		return apply_filters( 'wpinv_subscription_is_active', $ret, $this->id, $this );


	}

	/**
	 * Determines if subscription is expired
	 *
	 * @since  1.0.0
	 * @return void
	 */
	public function is_expired() {

		$ret = false;

		if ( $this->status == 'expired' ) {

			$ret = true;

		} elseif( 'active' === $this->status || 'cancelled' === $this->status || $this->status == 'trialling'  ) {

			$ret        = false;
			$expiration = $this->get_expiration_time();

			if( $expiration && strtotime( 'NOW', current_time( 'timestamp' ) ) > $expiration ) {
				$ret = true;

				if ( 'active' === $this->status || $this->status == 'trialling'  ) {
					$this->expire();
				}
			}

		}

		return apply_filters( 'wpinv_subscription_is_expired', $ret, $this->id, $this );


	}

	/**
	 * Retrieves the expiration date
	 *
	 * @since  1.0.0
	 * @return string
	 */
	public function get_expiration() {
		return $this->expiration;
	}

	/**
	 * Retrieves the expiration date in a timestamp
	 *
	 * @since  1.0.0
	 * @return int
	 */
	public function get_expiration_time() {
		return strtotime( $this->expiration, current_time( 'timestamp' ) );
	}

	/**
	 * Retrieves the subscription status
	 *
	 * @since  1.0.0
	 * @return int
	 */
	public function get_status() {

		// Monitor for page load delays on pages with large subscription lists (IE: Subscriptions table in admin)
		$this->is_expired();
		return $this->status;

	}

	/**
	 * Retrieves the subscription status label
	 *
	 * @since  1.0.0
	 * @return int
	 */
	public function get_status_label() {

		switch( $this->get_status() ) {
			case 'active' :
				$status = __( 'Active', 'invoicing' );
				break;

			case 'cancelled' :
				$status = __( 'Cancelled', 'invoicing' );
				break;

			case 'expired' :
				$status = __( 'Expired', 'invoicing' );
				break;

			case 'pending' :
				$status = __( 'Pending', 'invoicing' );
				break;

			case 'failing' :
				$status = __( 'Failing', 'invoicing' );
				break;

			case 'trialling' :
				$status = __( 'Trialling', 'invoicing' );
				break;

			case 'completed' :
				$status = __( 'Completed', 'invoicing' );
				break;

			default:
				$status = ucfirst( $this->get_status() );
				break;
		}

		return $status;

	}

    /**
     * Retrieves the subscription status label
     *
     * @since  1.0.0
     * @return int
     */
    public function get_status_label_html() {

        switch( $get_status = $this->get_status() ) {
            case 'active' :
                $status = __( 'Active', 'invoicing' );
                $class = 'label-info';
                break;

            case 'cancelled' :
                $status = __( 'Cancelled', 'invoicing' );
                $class = 'label-danger';
                break;

            case 'expired' :
                $status = __( 'Expired', 'invoicing' );
                $class = 'label-default';
                break;

            case 'pending' :
                $status = __( 'Pending', 'invoicing' );
                $class = 'label-primary';
                break;

            case 'failing' :
                $status = __( 'Failing', 'invoicing' );
                $class = 'label-danger';
                break;

            case 'trialling' :
                $status = __( 'Trialling', 'invoicing' );
                $class = 'label-info';
                break;

            case 'completed' :
                $status = __( 'Completed', 'invoicing' );
                $class = 'label-success';
                break;

            default:
                $status = ucfirst( $this->get_status() );
                $class = 'label-default';
                break;
        }

        $label = '<span class="sub-status label label-sub-' . $get_status . ' ' . $class . '">' . $status . '</span>';

        return apply_filters( 'wpinv_subscription_status_label_html', $label, $get_status, $status );

    }

    /**
     * Determines if a payment exists with the specified transaction ID
     *
     * @since  2.4
     * @param  string $txn_id The transaction ID from the merchant processor
     * @return bool
     */
    public function payment_exists( $txn_id = '' ) {
		$invoice_id = WPInv_Invoice::get_invoice_id_by_field( $txn_id, 'transaction_id' );
        return ! empty( $invoice_id );
    }

}

Pull Request — master (#390)

WPInv_Subscription::get_child_payments() A

Complexity

Size

Duplication

Importance

1 path for user data to reach this point

Used in variable context

General Strategies to prevent injection

AyeCode / invoicing

Pull Request — master (#390)

WPInv_Subscription::get_child_payments() A

Complexity

Size

Duplication

Importance

1 path for user data to reach this point

Used in variable context

General Strategies to prevent injection

Duplication Side-by-Side

Filter issues like
