PaymentData::get_customer_name() - Code Metrics - Inspection of "Added comment about filter." - wp-pay-extensions/memberpress - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions
Push — develop ( d3f65e...bf2dba )

by Remco
created 2019-01-16 13:45 UTC
PaymentData::get_customer_name() A

↳ Parent: PaymentData
Complexity

Conditions	1
Paths	1
Size

Total Lines	2
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	2
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	2
ccs	0
cts	2
cp	0
crap	2
rs	10
c	0
b	0
f	0
<?php
/**
 * Payment data
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2019 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Extensions\MemberPress
 */

namespace Pronamic\WordPress\Pay\Extensions\MemberPress;

use MeprOptions;
use MeprTransaction;
use MeprUser;
use Pronamic\WordPress\Money\Money;
use Pronamic\WordPress\Pay\Core\Util as Core_Util;
use Pronamic\WordPress\Pay\Payments\PaymentData as Pay_PaymentData;
use Pronamic\WordPress\Pay\Payments\Item;
use Pronamic\WordPress\Pay\Payments\Items;
use Pronamic\WordPress\Pay\Subscriptions\Subscription;

/**
 * WordPress pay MemberPress payment data
 *
 * @author  Remco Tolsma
 * @version 2.0.3
 * @since   1.0.0
 */
class PaymentData extends Pay_PaymentData {
	/**
	 * MemberPress transaction.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprTransaction.php
	 *
	 * @var MeprTransaction
	 */
	private $transaction;

	/**
	 * MemberPress transaction user.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprTransaction.php#L596-L600
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php
	 *
	 * @var MeprUser
	 */
	private $user;

	/**
	 * MemberPress transaction subscription.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprTransaction.php#L602-L617
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprSubscription.php
	 *
	 * @var MeprSubscription|false

	 */
	private $subscription;

	/**
	 * Constructs and initialize payment data object.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprTransaction.php
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprTransaction.php#L596-L600
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/lib/MeprBaseGateway.php
	 *
	 * @param MeprTransaction $transaction MemberPress transaction object.
	 * @param Gateway         $gateway     MemberPress gateway object.
	 */
	public function __construct( MeprTransaction $transaction, Gateway $gateway ) {
		parent::__construct();

		$this->transaction = $transaction;
		$this->gateway     = $gateway;


		$this->user = $transaction->user();

		$this->subscription = $transaction->subscription();

		$this->recurring = $this->subscription && $this->subscription->txn_count > 1;

	}

	/**
	 * Get source slug.
	 *
	 * @link https://github.com/pronamic/wp-pronamic-ideal/blob/5.0.0/classes/Payments/AbstractPaymentData.php#L56-L61
	 *
	 * @return string
	 */
	public function get_source() {
		return 'memberpress';
	}

	/**
	 * Get source ID.
	 *
	 * @link https://github.com/pronamic/wp-pronamic-ideal/blob/5.0.0/classes/Payments/AbstractPaymentData.php#L63-L70
	 *
	 * @return string|int
	 */
	public function get_source_id() {
		return $this->transaction->id;
	}

	/**
	 * Get order ID.
	 *
	 * @link https://github.com/pronamic/wp-pronamic-ideal/blob/5.0.0/classes/Payments/AbstractPaymentData.php#L88-L93
	 *
	 * @return string|int
	 */
	public function get_order_id() {
		return $this->transaction->id;
	}

	/**
	 * Get description.
	 *
	 * @link https://github.com/pronamic/wp-pronamic-ideal/blob/5.0.0/classes/Payments/AbstractPaymentData.php#L81-L86
	 *
	 * @return string
	 */
	public function get_description() {
		return $this->transaction->product()->post_title;
	}

	/**
	 * Get items.
	 *
	 * @link https://github.com/pronamic/wp-pronamic-ideal/blob/5.0.0/classes/Payments/AbstractPaymentData.php#L95-L100
	 *
	 * @return Items
	 */
	public function get_items() {
		$items = new Items();
		$items = /** @scrutinizer ignore-deprecated */ new Items();

		/*
		 * Price.
		 *
		 * Note: MemberPress uses trial amount for prorated upgrade/downgrade too.
		 */
		$price = $this->transaction->total;

		$subscription = $this->transaction->subscription();

		if ( $subscription && $subscription->in_trial() ) {
			$price = $subscription->trial_amount;
		}

		// Item.
		$item = new Item();
		$item = /** @scrutinizer ignore-deprecated */ new Item();
		$item->set_number( $this->get_order_id() );
		$item->set_description( $this->get_description() );
		$item->set_price( $price );
		$item->set_quantity( 1 );

		$items->addItem( $item );
		/** @scrutinizer ignore-deprecated */ $items->addItem( $item );

		return $items;
	}

	/**
	 * Get currency alphabetic code.
	 *
	 * @link https://github.com/pronamic/wp-pronamic-ideal/blob/5.0.0/classes/Payments/AbstractPaymentData.php#L213-L218
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprOptions.php#L162-L163
	 *
	 * @return string
	 */
	public function get_currency_alphabetic_code() {
		$mepr_options = MeprOptions::fetch();

		// @link https://gitlab.com/pronamic/memberpress/blob/1.2.4/app/models/MeprOptions.php#L136-137
		return $mepr_options->currency_code;
	}

	/**
	 * Get email.
	 *
	 * @link https://github.com/wp-premium/memberpress-business/blob/1.2.7/app/models/MeprUser.php#L1103-L1105
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L1229-L1231
	 *
	 * @return string
	 */
	public function get_email() {
		return $this->user->user_email;
	}

	/**
	 * Get first name.
	 *
	 * @link https://github.com/wp-premium/memberpress-business/blob/1.2.7/app/models/MeprUser.php#L316-L319
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L376-L378
	 *
	 * @return string
	 */
	public function get_first_name() {
		return $this->user->first_name;
	}

	/**
	 * Get last name.
	 *
	 * @link https://github.com/wp-premium/memberpress-business/blob/1.2.7/app/models/MeprUser.php#L316-L319
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L376-L378
	 *
	 * @return string
	 */
	public function get_last_name() {
		return $this->user->last_name;
	}

	/**
	 * Get customer name.
	 *
	 * @link https://github.com/wp-premium/memberpress-business/blob/1.2.7/app/models/MeprUser.php#L316-L319
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L376-L378
	 *
	 * @return string
	 */
	public function get_customer_name() {
		return $this->user->get_full_name();
	}

	/**
	 * Get address.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L1115-L1140
	 *
	 * @return string|null
	 */
	public function get_address() {
		$value = $this->user->address( 'one', false );

		if ( false === $value ) {
			return null;
		}

		return $value;
	}

	/**
	 * Get city.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L1115-L1140
	 *
	 * @return string|null
	 */
	public function get_city() {
		$value = $this->user->address( 'city', false );

		if ( false === $value ) {
			return null;
		}

		return $value;
	}

	/**
	 * Get ZIP.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L1115-L1140
	 *
	 * @return string|null
	 */
	public function get_zip() {
		$value = $this->user->address( 'zip', false );

		if ( false === $value ) {
			return null;
		}

		return $value;
	}

	/**
	 * Get country.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprUser.php#L1115-L1140
	 *
	 * @return string|null
	 */
	public function get_country() {
		$value = $this->user->address( 'country', false );

		if ( false === $value ) {
			return null;
		}

		return $value;
	}

	/**
	 * Get normal return URL.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/gateways/MeprPayPalStandardGateway.php#L1121
	 *
	 * @return string
	 */
	public function get_normal_return_url() {
		$mepr_options = MeprOptions::fetch();

		// @link https://gitlab.com/pronamic/memberpress/blob/1.2.4/app/models/MeprOptions.php#L768-782
		// @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/models/MeprOptions.php#L806-L835
		return $mepr_options->thankyou_page_url( 'trans_num=' . $this->transaction->id );
	}

	/**
	 * Get cancel URL.
	 *
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/lib/MeprBaseGateway.php#L130-L135
	 * @link https://github.com/wp-premium/memberpress-basic/blob/1.3.18/app/gateways/MeprPayPalStandardGateway.php#L1128-L1152
	 *
	 * @return string
	 */
	public function get_cancel_url() {
		if ( isset( $this->transaction->product_id ) && $this->transaction->product_id > 0 ) {
			$product = new MeprProduct( $this->transaction->product_id );


			$url = $this->gateway->message_page_url( $product, 'cancel' );

			if ( false !== $url ) {
				return $url;
			}
		}

		$mepr_options = MeprOptions::fetch();

		return $mepr_options->account_page_url( 'action=subscriptions' );
	}

	/**
	 * Get success URL.
	 *
	 * @return string
	 */
	public function get_success_url() {
		return $this->get_normal_return_url();
	}

	/**
	 * Get error URL.
	 *
	 * @return string
	 */
	public function get_error_url() {
		$mepr_options = MeprOptions::fetch();

		return $mepr_options->account_page_url( 'action=subscriptions' );
	}

	/**
	 * Get subscription.
	 *
	 * @since 2.0.0
	 *
	 * @return Subscription|false
	 */
	public function get_subscription() {
		$product = $this->transaction->product();

		if ( $product->is_one_time_payment() ) {
			return false;
		}

		$mp_subscription = $this->transaction->subscription();

		if ( ! $mp_subscription ) {
			return false;
		}

		$frequency = '';

		if ( $mp_subscription->limit_cycles ) {
			$frequency = $mp_subscription->limit_cycles;
		}

		$subscription                  = new Subscription();
		$subscription->frequency       = $frequency;
		$subscription->interval        = $product->period;
		$subscription->interval_period = Core_Util::to_period( $product->period_type );
		$subscription->description     = sprintf(
			'Order #%s - %s',
			$this->get_source_id(),
			$this->get_description()
		);

		$subscription->set_amount(
			new Money(
				$this->transaction->total,
				$this->get_currency_alphabetic_code()
			)
		);

		return $subscription;
	}

	/**
	 * Get subscription source ID.
	 *
	 * @since  2.0.0
	 * @return string
	 */
	public function get_subscription_source_id() {
		$subscription = $this->get_subscription();

		if ( ! $subscription ) {
			return false;

		}

		if ( ! empty( $this->transaction->subscription_id ) ) {
			return $this->transaction->subscription_id;
		}

		return $this->get_source_id();
	}
}

wp-pay-extensions / memberpress

Push — develop ( d3f65e...bf2dba )

PaymentData::get_customer_name() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
