PaymentsModule::privacy_export() - Code Metrics - Inspection of "Add initial personal data exporter for subscriptio..." - pronamic/wp-pronamic-ideal - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — develop ( 8ebc76...5a0ded )

by Reüel
created 2018-05-08 14:45 UTC
PaymentsModule::privacy_export() B

↳ Parent: PaymentsModule
Complexity

Conditions	6
Paths	9
Size

Total Lines	50
Code Lines	26
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	6
eloc	26
c	0
b	0
f	0
nc	9
nop	2
dl	0
loc	50
rs	8.6315
<?php
/**
 * Payments Module
 *
 * @author    Pronamic <[email protected]>
 * @copyright 2005-2018 Pronamic
 * @license   GPL-3.0-or-later
 * @package   Pronamic\WordPress\Pay\Subscriptions
 */

namespace Pronamic\WordPress\Pay\Payments;

use Pronamic\WordPress\Pay\Plugin;
use Pronamic\WordPress\Pay\Core\Statuses;

/**
 * Title: Payments module
 * Description:
 * Copyright: Copyright (c) 2005 - 2018
 * Company: Pronamic
 *
 * @see https://woocommerce.com/2017/04/woocommerce-3-0-release/
 * @see https://woocommerce.wordpress.com/2016/10/27/the-new-crud-classes-in-woocommerce-2-7/
 * @author Remco Tolsma
 * @version 3.7.0
 * @since 3.7.0
 */
class PaymentsModule {
	/**
	 * Plugin.
	 *
	 * @var Plugin $plugin
	 */
	public $plugin;

	/**
	 * Free payments to complete at shutdown.
	 *
	 * @var array
	 */
	public $free = array();

	/**
	 * Construct and initialize a payments module object.
	 *
	 * @param Plugin $plugin The plugin.
	 */
	public function __construct( Plugin $plugin ) {
		$this->plugin = $plugin;

		// Exclude payment notes.
		add_filter( 'comments_clauses', array( $this, 'exclude_payment_comment_notes' ), 10, 2 );

		// Payment redirect URL.
		add_filter( 'pronamic_payment_redirect_url', array( $this, 'payment_redirect_url' ), 5, 2 );

		// Listen to payment status changes so we can log these in a note.
		add_action( 'pronamic_payment_status_update', array( $this, 'log_payment_status_update' ), 10, 4 );

		// Shutdown.
		add_action( 'shutdown', array( $this, 'update_free_payments' ) );

		// Payment Status Checker.
		$status_checker = new StatusChecker();

		// The 'pronamic_ideal_check_transaction_status' hook is scheduled to request the payment status.
		add_action( 'pronamic_ideal_check_transaction_status', array( $status_checker, 'check_status' ), 10, 3 );

		// Privacy personal data exporter.
		add_filter( 'wp_privacy_personal_data_exporters', array( $this, 'register_privacy_exporter' ), 10 );
	}

	/**
	 * Comments clauses.
	 *
	 * @param array             $clauses Array with query clauses for the comments query.
	 * @param \WP_Comment_Query $query   A WordPress comment query object.
	 *
	 * @return array
	 */
	public function exclude_payment_comment_notes( $clauses, $query ) {
		$type = $query->query_vars['type'];

		// Ignore payment notes comments if it's not specifically requested.
		if ( 'payment_note' !== $type ) {
			$clauses['where'] .= " AND comment_type != 'payment_note'";
		}

		return $clauses;
	}

	/**
	 * Payment redirect URL filter.
	 *
	 * @param string  $url     A payment redirect URL.
	 * @param Payment $payment The payment to get a redirect URL for.
	 *
	 * @return string
	 */
	public function payment_redirect_url( $url, $payment ) {
		$page_id = null;

		switch ( $payment->status ) {
			case Statuses::CANCELLED:
				$page_id = pronamic_pay_get_page_id( 'cancel' );

				break;
			case Statuses::EXPIRED:
				$page_id = pronamic_pay_get_page_id( 'expired' );

				break;
			case Statuses::FAILURE:
				$page_id = pronamic_pay_get_page_id( 'error' );

				break;
			case Statuses::OPEN:
				$page_id = pronamic_pay_get_page_id( 'unknown' );

				break;
			case Statuses::SUCCESS:
				$page_id = pronamic_pay_get_page_id( 'completed' );

				break;
			default:
				$page_id = pronamic_pay_get_page_id( 'unknown' );

				break;
		}

		if ( ! empty( $page_id ) ) {
			$page_url = get_permalink( $page_id );

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

		return $url;
	}

	/**
	 * Payment status update.
	 *
	 * @param Payment $payment      The status updated payment.
	 * @param bool    $can_redirect Whether or not redirects should be performed.
	 * @param string  $old_status   Old meta status.
	 * @param string  $new_status   New meta status.
	 *
	 * @return void
	 */
	public function log_payment_status_update( $payment, $can_redirect, $old_status, $new_status ) {
		$note = sprintf(
			__( 'Payment status changed from "%1$s" to "%2$s".', 'pronamic_ideal' ),
			esc_html( $this->plugin->payments_data_store->get_meta_status_label( $old_status ) ),
			esc_html( $this->plugin->payments_data_store->get_meta_status_label( $new_status ) )
		);

		if ( null === $old_status ) {

			$note = sprintf(
				__( 'Payment created with status "%1$s".', 'pronamic_ideal' ),
				esc_html( $this->plugin->payments_data_store->get_meta_status_label( $new_status ) )
			);
		}

		$payment->add_note( $note );
	}

	/**
	 * Update free payments.
	 */
	public function update_free_payments() {
		$can_redirect = false;

		foreach ( $this->free as $payment_id ) {
			$payment = get_pronamic_payment( $payment_id );

			Plugin::update_payment( $payment, $can_redirect );
		}
	}

	/**
	 * Register privacy personal data exporter.
	 *
	 * @param $exporters
	 *
	 * @return array
	 */
	public function register_privacy_exporter( $exporters ) {
		if ( ! is_array( $exporters ) ) {
			return $exporters;
		}

		$exporters['pronamic-pay-payments'] = array(
			'exporter_friendly_name' => __( 'Pronamic Pay', 'pronamic_ideal' ),
			'callback'               => array( $this, 'privacy_export' ),
		);

		return $exporters;
	}

	/**
	 * Privacy personal data exporter.
	 *
	 * @param string $email_address Email address.
	 * @param int    $page          Page.
	 *
	 * @return array
	 */
	public function privacy_export( $email_address, $page = 1 ) {
	public function privacy_export( $email_address, /** @scrutinizer ignore-unused */ $page = 1 ) {
		$items = array();

		$meta_key_email = pronamic_pay_plugin()->payments_data_store->meta_key_prefix . 'email';

		// Get payments.
		$payments = get_pronamic_payments_by_meta( $meta_key_email, $email_address );

		foreach ( $payments as $payment ) {
			$data = array();

			// Get payment meta.
			$payment_meta = get_post_meta( $payment->get_id() );

			foreach ( $payment_meta as $meta_key => $meta_value ) {
				if ( '_pronamic_' !== substr( $meta_key, 0, 10 ) ) {
					continue;
				}

				// Format value.
				if ( 1 === count( $meta_value ) ) {
					$meta_value = array_shift( $meta_value );
				} else {
					$meta_value = wp_json_encode( $meta_value );
				}

				// Add meta to export data.
				$data[] = array(
					'name'  => $meta_key,
					'value' => $meta_value,
				);
			}

			// Add item to export data.
			if ( ! empty( $data ) ) {
				$items[] = array(
					'group_id'    => 'pronamic-payments',
					'group_label' => __( 'Payments', 'pronamic_ideal' ),
					'item_id'     => 'pronamic-payment-' . $payment->get_id(),
					'data'        => $data,
				);
			}
		}

		$done = true;

		// Return export data.
		return array(
			'data' => $items,
			'done' => $done,
		);
	}
}

pronamic / wp-pronamic-ideal

Push — develop ( 8ebc76...5a0ded )

PaymentsModule::privacy_export() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
