woocommerce / woocommerce-gateway-stripe

includes/admin/class-wc-stripe-privacy.php

Spacing +113 added lines, -113 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if ( ! class_exists( 'WC_Abstract_Privacy' ) ) {
+if ( ! class_exists('WC_Abstract_Privacy')) {
 	return;
 }
 
@@ -9,20 +9,20 @@ 
 	 *
 	 */
 	public function __construct() {
-		parent::__construct( __( 'Stripe', 'woocommerce-gateway-stripe' ) );
+		parent::__construct(__('Stripe', 'woocommerce-gateway-stripe'));
 
-		$this->add_exporter( 'woocommerce-gateway-stripe-order-data', __( 'WooCommerce Stripe Order Data', 'woocommerce-gateway-stripe' ), array( $this, 'order_data_exporter' ) );
+		$this->add_exporter('woocommerce-gateway-stripe-order-data', __('WooCommerce Stripe Order Data', 'woocommerce-gateway-stripe'), array($this, 'order_data_exporter'));
 
-		if ( function_exists( 'wcs_get_subscriptions' ) ) {
-			$this->add_exporter( 'woocommerce-gateway-stripe-subscriptions-data', __( 'WooCommerce Stripe Subscriptions Data', 'woocommerce-gateway-stripe' ), array( $this, 'subscriptions_data_exporter' ) );
+		if (function_exists('wcs_get_subscriptions')) {
+			$this->add_exporter('woocommerce-gateway-stripe-subscriptions-data', __('WooCommerce Stripe Subscriptions Data', 'woocommerce-gateway-stripe'), array($this, 'subscriptions_data_exporter'));
 		}
 
-		$this->add_exporter( 'woocommerce-gateway-stripe-customer-data', __( 'WooCommerce Stripe Customer Data', 'woocommerce-gateway-stripe' ), array( $this, 'customer_data_exporter' ) );
+		$this->add_exporter('woocommerce-gateway-stripe-customer-data', __('WooCommerce Stripe Customer Data', 'woocommerce-gateway-stripe'), array($this, 'customer_data_exporter'));
 
-		$this->add_eraser( 'woocommerce-gateway-stripe-customer-data', __( 'WooCommerce Stripe Customer Data', 'woocommerce-gateway-stripe' ), array( $this, 'customer_data_eraser' ) );
-		$this->add_eraser( 'woocommerce-gateway-stripe-order-data', __( 'WooCommerce Stripe Data', 'woocommerce-gateway-stripe' ), array( $this, 'order_data_eraser' ) );
+		$this->add_eraser('woocommerce-gateway-stripe-customer-data', __('WooCommerce Stripe Customer Data', 'woocommerce-gateway-stripe'), array($this, 'customer_data_eraser'));
+		$this->add_eraser('woocommerce-gateway-stripe-order-data', __('WooCommerce Stripe Data', 'woocommerce-gateway-stripe'), array($this, 'order_data_eraser'));
 
-		add_filter( 'woocommerce_get_settings_account', array( $this, 'account_settings' ) );
+		add_filter('woocommerce_get_settings_account', array($this, 'account_settings'));
 	}
 
 	/**
@@ -31,14 +31,14 @@ 
 	 * @param array $settings
 	 * @return array $settings Updated
 	 */
-	public function account_settings( $settings ) {
+	public function account_settings($settings) {
 		$insert_setting = array(
 			array(
-				'title'       => __( 'Retain Stripe Data', 'woocommerce-gateway-stripe' ),
-				'desc_tip'    => __( 'Retains any Stripe data such as Stripe customer ID, source ID.', 'woocommerce-gateway-stripe' ),
+				'title'       => __('Retain Stripe Data', 'woocommerce-gateway-stripe'),
+				'desc_tip'    => __('Retains any Stripe data such as Stripe customer ID, source ID.', 'woocommerce-gateway-stripe'),
 				'id'          => 'woocommerce_gateway_stripe_retention',
 				'type'        => 'relative_date_selector',
-				'placeholder' => __( 'N/A', 'woocommerce-gateway-stripe' ),
+				'placeholder' => __('N/A', 'woocommerce-gateway-stripe'),
 				'default'     => '',
 				'autoload'    => false,
 			),
@@ -46,15 +46,15 @@ 
 
 		$index = null;
 
-		foreach ( $settings as $key => $value) {
-			if ( 'sectionend' === $value[ 'type' ] && 'personal_data_retention' === $value[ 'id' ] ) {
+		foreach ($settings as $key => $value) {
+			if ('sectionend' === $value['type'] && 'personal_data_retention' === $value['id']) {
 				$index = $key;
 				break;
 			}
 		}
 
-		if ( ! is_null( $index ) ) {
-			array_splice( $settings, $index, 0, $insert_setting );
+		if ( ! is_null($index)) {
+			array_splice($settings, $index, 0, $insert_setting);
 		}
 
 		return $settings;
@@ -68,22 +68,22 @@ 
 	 *
 	 * @return array WP_Post
 	 */
-	protected function get_stripe_orders( $email_address, $page ) {
-		$user = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
+	protected function get_stripe_orders($email_address, $page) {
+		$user = get_user_by('email', $email_address); // Check if user has an ID in the DB to load stored personal data.
 
 		$order_query = array(
-			'payment_method' => array( 'stripe', 'stripe_alipay', 'stripe_bancontact', 'stripe_eps', 'stripe_giropay', 'stripe_ideal', 'stripe_multibanco', 'stripe_p24', 'stripe_sepa', 'stripe_sofort' ),
+			'payment_method' => array('stripe', 'stripe_alipay', 'stripe_bancontact', 'stripe_eps', 'stripe_giropay', 'stripe_ideal', 'stripe_multibanco', 'stripe_p24', 'stripe_sepa', 'stripe_sofort'),
 			'limit'          => 10,
 			'page'           => $page,
 		);
 
-		if ( $user instanceof WP_User ) {
+		if ($user instanceof WP_User) {
 			$order_query['customer_id'] = (int) $user->ID;
 		} else {
 			$order_query['billing_email'] = $email_address;
 		}
 
-		return wc_get_orders( $order_query );
+		return wc_get_orders($order_query);
 	}
 
 	/**
@@ -92,7 +92,7 @@ 
 	 */
 	public function get_privacy_message() {
 		/* translators: %s URL to docs */
-		return wpautop( sprintf( __( 'By using this extension, you may be storing personal data or sharing data with an external service. <a href="%s" target="_blank">Learn more about how this works, including what you may want to include in your privacy policy.</a>', 'woocommerce-gateway-stripe' ), 'https://docs.woocommerce.com/document/privacy-payments/#woocommerce-gateway-stripe' ) );
+		return wpautop(sprintf(__('By using this extension, you may be storing personal data or sharing data with an external service. <a href="%s" target="_blank">Learn more about how this works, including what you may want to include in your privacy policy.</a>', 'woocommerce-gateway-stripe'), 'https://docs.woocommerce.com/document/privacy-payments/#woocommerce-gateway-stripe'));
 	}
 
 	/**
@@ -103,34 +103,34 @@ 
 	 *
 	 * @return array
 	 */
-	public function order_data_exporter( $email_address, $page = 1 ) {
+	public function order_data_exporter($email_address, $page = 1) {
 		$done           = false;
 		$data_to_export = array();
 
-		$orders = $this->get_stripe_orders( $email_address, (int) $page );
+		$orders = $this->get_stripe_orders($email_address, (int) $page);
 
 		$done = true;
 
-		if ( 0 < count( $orders ) ) {
-			foreach ( $orders as $order ) {
+		if (0 < count($orders)) {
+			foreach ($orders as $order) {
 				$data_to_export[] = array(
 					'group_id'    => 'woocommerce_orders',
-					'group_label' => __( 'Orders', 'woocommerce-gateway-stripe' ),
+					'group_label' => __('Orders', 'woocommerce-gateway-stripe'),
 					'item_id'     => 'order-' . $order->get_id(),
 					'data'        => array(
 						array(
-							'name'  => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
-							'value' => get_post_meta( $order->get_id(), '_stripe_source_id', true ),
+							'name'  => __('Stripe payment id', 'woocommerce-gateway-stripe'),
+							'value' => get_post_meta($order->get_id(), '_stripe_source_id', true),
 						),
 						array(
-							'name'  => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
-							'value' => get_post_meta( $order->get_id(), '_stripe_customer_id', true ),
+							'name'  => __('Stripe customer id', 'woocommerce-gateway-stripe'),
+							'value' => get_post_meta($order->get_id(), '_stripe_customer_id', true),
 						),
 					),
 				);
 			}
 
-			$done = 10 > count( $orders );
+			$done = 10 > count($orders);
 		}
 
 		return array(
@@ -147,7 +147,7 @@ 
 	 *
 	 * @return array
 	 */
-	public function subscriptions_data_exporter( $email_address, $page = 1 ) {
+	public function subscriptions_data_exporter($email_address, $page = 1) {
 		$done           = false;
 		$page           = (int) $page;
 		$data_to_export = array();
@@ -156,7 +156,7 @@ 
 			'relation' => 'AND',
 			array(
 				'key'     => '_payment_method',
-				'value'   => array( 'stripe', 'stripe_alipay', 'stripe_bancontact', 'stripe_eps', 'stripe_giropay', 'stripe_ideal', 'stripe_multibanco', 'stripe_p24', 'stripe_sepa', 'stripe_sofort' ),
+				'value'   => array('stripe', 'stripe_alipay', 'stripe_bancontact', 'stripe_eps', 'stripe_giropay', 'stripe_ideal', 'stripe_multibanco', 'stripe_p24', 'stripe_sepa', 'stripe_sofort'),
 				'compare' => 'IN',
 			),
 			array(
@@ -172,30 +172,30 @@ 
 			'meta_query'     => $meta_query,
 		);
 
-		$subscriptions = wcs_get_subscriptions( $subscription_query );
+		$subscriptions = wcs_get_subscriptions($subscription_query);
 
 		$done = true;
 
-		if ( 0 < count( $subscriptions ) ) {
-			foreach ( $subscriptions as $subscription ) {
+		if (0 < count($subscriptions)) {
+			foreach ($subscriptions as $subscription) {
 				$data_to_export[] = array(
 					'group_id'    => 'woocommerce_subscriptions',
-					'group_label' => __( 'Subscriptions', 'woocommerce-gateway-stripe' ),
+					'group_label' => __('Subscriptions', 'woocommerce-gateway-stripe'),
 					'item_id'     => 'subscription-' . $subscription->get_id(),
 					'data'        => array(
 						array(
-							'name'  => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
-							'value' => get_post_meta( $subscription->get_id(), '_stripe_source_id', true ),
+							'name'  => __('Stripe payment id', 'woocommerce-gateway-stripe'),
+							'value' => get_post_meta($subscription->get_id(), '_stripe_source_id', true),
 						),
 						array(
-							'name'  => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
-							'value' => get_post_meta( $subscription->get_id(), '_stripe_customer_id', true ),
+							'name'  => __('Stripe customer id', 'woocommerce-gateway-stripe'),
+							'value' => get_post_meta($subscription->get_id(), '_stripe_customer_id', true),
 						),
 					),
 				);
 			}
 
-			$done = 10 > count( $subscriptions );
+			$done = 10 > count($subscriptions);
 		}
 
 		return array(
@@ -211,24 +211,24 @@ 
 	 * @param int    $page  Page.
 	 * @return array An array of personal data in name value pairs
 	 */
-	public function customer_data_exporter( $email_address, $page ) {
-		$user           = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
+	public function customer_data_exporter($email_address, $page) {
+		$user           = get_user_by('email', $email_address); // Check if user has an ID in the DB to load stored personal data.
 		$data_to_export = array();
 
-		if ( $user instanceof WP_User ) {
-			$stripe_user = new WC_Stripe_Customer( $user->ID );
+		if ($user instanceof WP_User) {
+			$stripe_user = new WC_Stripe_Customer($user->ID);
 
 			$data_to_export[] = array(
 				'group_id'    => 'woocommerce_customer',
-				'group_label' => __( 'Customer Data', 'woocommerce-gateway-stripe' ),
+				'group_label' => __('Customer Data', 'woocommerce-gateway-stripe'),
 				'item_id'     => 'user',
 				'data'        => array(
 					array(
-						'name'  => __( 'Stripe payment id', 'woocommerce-gateway-stripe' ),
-						'value' => get_user_meta( $user->ID, '_stripe_source_id', true ),
+						'name'  => __('Stripe payment id', 'woocommerce-gateway-stripe'),
+						'value' => get_user_meta($user->ID, '_stripe_source_id', true),
 					),
 					array(
-						'name'  => __( 'Stripe customer id', 'woocommerce-gateway-stripe' ),
+						'name'  => __('Stripe customer id', 'woocommerce-gateway-stripe'),
 						'value' => $stripe_user->get_id(),
 					),
 				),
@@ -248,25 +248,25 @@ 
 	 * @param int    $page  Page.
 	 * @return array An array of personal data in name value pairs
 	 */
-	public function customer_data_eraser( $email_address, $page ) {
+	public function customer_data_eraser($email_address, $page) {
 		$page               = (int) $page;
-		$user               = get_user_by( 'email', $email_address ); // Check if user has an ID in the DB to load stored personal data.
+		$user               = get_user_by('email', $email_address); // Check if user has an ID in the DB to load stored personal data.
 		$stripe_customer_id = '';
 		$stripe_source_id   = '';
 
-		if ( $user instanceof WP_User ) {
-			$stripe_customer_id = get_user_meta( $user->ID, '_stripe_customer_id', true );
-			$stripe_source_id   = get_user_meta( $user->ID, '_stripe_source_id', true );
+		if ($user instanceof WP_User) {
+			$stripe_customer_id = get_user_meta($user->ID, '_stripe_customer_id', true);
+			$stripe_source_id   = get_user_meta($user->ID, '_stripe_source_id', true);
 		}
 
 		$items_removed = false;
 		$messages      = array();
 
-		if ( ! empty( $stripe_customer_id ) || ! empty( $stripe_source_id ) ) {
+		if ( ! empty($stripe_customer_id) || ! empty($stripe_source_id)) {
 			$items_removed = true;
-			delete_user_meta( $user->ID, '_stripe_customer_id' );
-			delete_user_meta( $user->ID, '_stripe_source_id' );
-			$messages[] = __( 'Stripe User Data Erased.', 'woocommerce-gateway-stripe' );
+			delete_user_meta($user->ID, '_stripe_customer_id');
+			delete_user_meta($user->ID, '_stripe_source_id');
+			$messages[] = __('Stripe User Data Erased.', 'woocommerce-gateway-stripe');
 		}
 
 		return array(
@@ -284,29 +284,29 @@ 
 	 * @param int    $page  Page.
 	 * @return array An array of personal data in name value pairs
 	 */
-	public function order_data_eraser( $email_address, $page ) {
-		$orders = $this->get_stripe_orders( $email_address, (int) $page );
+	public function order_data_eraser($email_address, $page) {
+		$orders = $this->get_stripe_orders($email_address, (int) $page);
 
 		$items_removed  = false;
 		$items_retained = false;
 		$messages       = array();
 
-		foreach ( (array) $orders as $order ) {
-			$order = wc_get_order( $order->get_id() );
+		foreach ((array) $orders as $order) {
+			$order = wc_get_order($order->get_id());
 
-			list( $removed, $retained, $msgs ) = $this->maybe_handle_order( $order );
+			list($removed, $retained, $msgs) = $this->maybe_handle_order($order);
 			$items_removed                    |= $removed;
 			$items_retained                   |= $retained;
-			$messages                          = array_merge( $messages, $msgs );
+			$messages                          = array_merge($messages, $msgs);
 
-			list( $removed, $retained, $msgs ) = $this->maybe_handle_subscription( $order );
+			list($removed, $retained, $msgs) = $this->maybe_handle_subscription($order);
 			$items_removed                    |= $removed;
 			$items_retained                   |= $retained;
-			$messages                          = array_merge( $messages, $msgs );
+			$messages                          = array_merge($messages, $msgs);
 		}
 
 		// Tell core if we have more orders to work on still
-		$done = count( $orders ) < 10;
+		$done = count($orders) < 10;
 
 		return array(
 			'items_removed'  => $items_removed,
@@ -322,47 +322,47 @@ 
 	 * @param WC_Order $order
 	 * @return array
 	 */
-	protected function maybe_handle_subscription( $order ) {
-		if ( ! class_exists( 'WC_Subscriptions' ) ) {
-			return array( false, false, array() );
+	protected function maybe_handle_subscription($order) {
+		if ( ! class_exists('WC_Subscriptions')) {
+			return array(false, false, array());
 		}
 
-		if ( ! wcs_order_contains_subscription( $order ) ) {
-			return array( false, false, array() );
+		if ( ! wcs_order_contains_subscription($order)) {
+			return array(false, false, array());
 		}
 
-		$subscription    = current( wcs_get_subscriptions_for_order( $order->get_id() ) );
+		$subscription    = current(wcs_get_subscriptions_for_order($order->get_id()));
 		$subscription_id = $subscription->get_id();
 
-		$stripe_source_id = get_post_meta( $subscription_id, '_stripe_source_id', true );
+		$stripe_source_id = get_post_meta($subscription_id, '_stripe_source_id', true);
 
-		if ( empty( $stripe_source_id ) ) {
-			return array( false, false, array() );
+		if (empty($stripe_source_id)) {
+			return array(false, false, array());
 		}
 
-		if ( ! $this->is_retention_expired( $order->get_date_created()->getTimestamp() ) ) {
+		if ( ! $this->is_retention_expired($order->get_date_created()->getTimestamp())) {
 			/* translators: %d Order ID */
-			return array( false, true, array( sprintf( __( 'Order ID %d is less than set retention days. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe' ), $order->get_id() ) ) );
+			return array(false, true, array(sprintf(__('Order ID %d is less than set retention days. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe'), $order->get_id())));
 		}
 
-		if ( $subscription->has_status( apply_filters( 'wc_stripe_privacy_eraser_subs_statuses', array( 'on-hold', 'active' ) ) ) ) {
+		if ($subscription->has_status(apply_filters('wc_stripe_privacy_eraser_subs_statuses', array('on-hold', 'active')))) {
 			/* translators: %d Order ID */
-			return array( false, true, array( sprintf( __( 'Order ID %d contains an active Subscription. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe' ), $order->get_id() ) ) );
+			return array(false, true, array(sprintf(__('Order ID %d contains an active Subscription. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe'), $order->get_id())));
 		}
 
-		$renewal_orders = WC_Subscriptions_Renewal_Order::get_renewal_orders( $order->get_id() );
+		$renewal_orders = WC_Subscriptions_Renewal_Order::get_renewal_orders($order->get_id());
 
-		foreach ( $renewal_orders as $renewal_order_id ) {
-			delete_post_meta( $renewal_order_id, '_stripe_source_id' );
-			delete_post_meta( $renewal_order_id, '_stripe_refund_id' );
-			delete_post_meta( $renewal_order_id, '_stripe_customer_id' );
+		foreach ($renewal_orders as $renewal_order_id) {
+			delete_post_meta($renewal_order_id, '_stripe_source_id');
+			delete_post_meta($renewal_order_id, '_stripe_refund_id');
+			delete_post_meta($renewal_order_id, '_stripe_customer_id');
 		}
 
-		delete_post_meta( $subscription_id, '_stripe_source_id' );
-		delete_post_meta( $subscription_id, '_stripe_refund_id' );
-		delete_post_meta( $subscription_id, '_stripe_customer_id' );
+		delete_post_meta($subscription_id, '_stripe_source_id');
+		delete_post_meta($subscription_id, '_stripe_refund_id');
+		delete_post_meta($subscription_id, '_stripe_customer_id');
 
-		return array( true, false, array( __( 'Stripe Subscription Data Erased.', 'woocommerce-gateway-stripe' ) ) );
+		return array(true, false, array(__('Stripe Subscription Data Erased.', 'woocommerce-gateway-stripe')));
 	}
 
 	/**
@@ -371,61 +371,61 @@ 
 	 * @param WC_Order $order
 	 * @return array
 	 */
-	protected function maybe_handle_order( $order ) {
+	protected function maybe_handle_order($order) {
 		$order_id           = $order->get_id();
-		$stripe_source_id   = get_post_meta( $order_id, '_stripe_source_id', true );
-		$stripe_refund_id   = get_post_meta( $order_id, '_stripe_refund_id', true );
-		$stripe_customer_id = get_post_meta( $order_id, '_stripe_customer_id', true );
+		$stripe_source_id   = get_post_meta($order_id, '_stripe_source_id', true);
+		$stripe_refund_id   = get_post_meta($order_id, '_stripe_refund_id', true);
+		$stripe_customer_id = get_post_meta($order_id, '_stripe_customer_id', true);
 
-		if ( ! $this->is_retention_expired( $order->get_date_created()->getTimestamp() ) ) {
+		if ( ! $this->is_retention_expired($order->get_date_created()->getTimestamp())) {
 			/* translators: %d Order ID */
-			return array( false, true, array( sprintf( __( 'Order ID %d is less than set retention days. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe' ), $order->get_id() ) ) );
+			return array(false, true, array(sprintf(__('Order ID %d is less than set retention days. Personal data retained. (Stripe)', 'woocommerce-gateway-stripe'), $order->get_id())));
 		}
 
-		if ( empty( $stripe_source_id ) && empty( $stripe_refund_id ) && empty( $stripe_customer_id ) ) {
-			return array( false, false, array() );
+		if (empty($stripe_source_id) && empty($stripe_refund_id) && empty($stripe_customer_id)) {
+			return array(false, false, array());
 		}
 
-		delete_post_meta( $order_id, '_stripe_source_id' );
-		delete_post_meta( $order_id, '_stripe_refund_id' );
-		delete_post_meta( $order_id, '_stripe_customer_id' );
+		delete_post_meta($order_id, '_stripe_source_id');
+		delete_post_meta($order_id, '_stripe_refund_id');
+		delete_post_meta($order_id, '_stripe_customer_id');
 
-		return array( true, false, array( __( 'Stripe personal data erased.', 'woocommerce-gateway-stripe' ) ) );
+		return array(true, false, array(__('Stripe personal data erased.', 'woocommerce-gateway-stripe')));
 	}
 
 	/**
 	 * Checks if create date is passed retention duration.
 	 *
 	 */
-	public function is_retention_expired( $created_date ) {
-		$retention  = wc_parse_relative_date_option( get_option( 'woocommerce_gateway_stripe_retention' ) );
+	public function is_retention_expired($created_date) {
+		$retention  = wc_parse_relative_date_option(get_option('woocommerce_gateway_stripe_retention'));
 		$is_expired = false;
-		$time_span  = time() - strtotime( $created_date );
-		if ( empty( $retention ) || empty( $created_date ) ) {
+		$time_span  = time() - strtotime($created_date);
+		if (empty($retention) || empty($created_date)) {
 			return false;
 		}
-		switch ( $retention['unit'] ) {
+		switch ($retention['unit']) {
 			case 'days':
 				$retention = $retention['number'] * DAY_IN_SECONDS;
-				if ( $time_span > $retention ) {
+				if ($time_span > $retention) {
 					$is_expired = true;
 				}
 				break;
 			case 'weeks':
 				$retention = $retention['number'] * WEEK_IN_SECONDS;
-				if ( $time_span > $retention ) {
+				if ($time_span > $retention) {
 					$is_expired = true;
 				}
 				break;
 			case 'months':
 				$retention = $retention['number'] * MONTH_IN_SECONDS;
-				if ( $time_span > $retention ) {
+				if ($time_span > $retention) {
 					$is_expired = true;
 				}
 				break;
 			case 'years':
 				$retention = $retention['number'] * YEAR_IN_SECONDS;
-				if ( $time_span > $retention ) {
+				if ($time_span > $retention) {
 					$is_expired = true;
 				}
 				break;