WordImpress / Give

includes/admin/tools/export/give-export-donations-exporter.php

Spacing +151 added lines, -151 removed lines

@@ -12,7 +12,7 @@ 
  */
 
 // Exit if accessed directly.
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -85,28 +85,28 @@ 
 	 *
 	 * @param array $request The Form Data passed into the batch processing.
 	 */
-	public function set_properties( $request ) {
+	public function set_properties($request) {
 
 		// Set data from form submission
-		if ( isset( $_POST['form'] ) ) {
-			$this->data = give_clean( wp_parse_args( $_POST['form'] ) );
+		if (isset($_POST['form'])) {
+			$this->data = give_clean(wp_parse_args($_POST['form']));
 		}
 
 		$this->form       = $this->data['forms'];
-		$this->categories = ! empty( $request['give_forms_categories'] ) ? (array) $request['give_forms_categories'] : array();
-		$this->tags       = ! empty( $request['give_forms_tags'] ) ? (array) $request['give_forms_tags'] : array();
-		$this->form_id    = $this->get_form_ids( $request );
-		$this->price_id   = isset( $request['give_price_option'] ) && ( 'all' !== $request['give_price_option'] && '' !== $request['give_price_option'] ) ? absint( $request['give_price_option'] ) : null;
-		$this->start      = isset( $request['start'] ) ? sanitize_text_field( $request['start'] ) : '';
-		$this->end        = isset( $request['end'] ) ? sanitize_text_field( $request['end'] ) : '';
-		$this->status     = isset( $request['status'] ) ? sanitize_text_field( $request['status'] ) : 'complete';
+		$this->categories = ! empty($request['give_forms_categories']) ? (array) $request['give_forms_categories'] : array();
+		$this->tags       = ! empty($request['give_forms_tags']) ? (array) $request['give_forms_tags'] : array();
+		$this->form_id    = $this->get_form_ids($request);
+		$this->price_id   = isset($request['give_price_option']) && ('all' !== $request['give_price_option'] && '' !== $request['give_price_option']) ? absint($request['give_price_option']) : null;
+		$this->start      = isset($request['start']) ? sanitize_text_field($request['start']) : '';
+		$this->end        = isset($request['end']) ? sanitize_text_field($request['end']) : '';
+		$this->status     = isset($request['status']) ? sanitize_text_field($request['status']) : 'complete';
 
 		/**
 		 * Hook to use after setting properties.
 		 *
 		 * @since 2.1.3
 		 */
-		do_action( 'give_export_donations_form_data', $this->data );
+		do_action('give_export_donations_form_data', $this->data);
 	}
 
 	/**
@@ -118,13 +118,13 @@ 
 	 *
 	 * @return array|boolean|null $form get all the donation id that need to be exported
 	 */
-	public function get_form_ids( $request = array() ) {
-		$form = ! empty( $request['forms'] ) && 0 !== $request['forms'] ? absint( $request['forms'] ) : null;
+	public function get_form_ids($request = array()) {
+		$form = ! empty($request['forms']) && 0 !== $request['forms'] ? absint($request['forms']) : null;
 
-		$form_ids = ! empty( $request['form_ids'] ) ? sanitize_text_field( $request['form_ids'] ) : null;
+		$form_ids = ! empty($request['form_ids']) ? sanitize_text_field($request['form_ids']) : null;
 
-		if ( empty( $form ) && ! empty( $form_ids ) && ( ! empty( $this->categories ) || ! empty( $this->tags ) ) ) {
-			$form = explode( ',', $form_ids );
+		if (empty($form) && ! empty($form_ids) && ( ! empty($this->categories) || ! empty($this->tags))) {
+			$form = explode(',', $form_ids);
 		}
 
 		return $form;
@@ -141,14 +141,14 @@ 
 	 */
 	public function csv_cols() {
 
-		$columns = isset( $this->data['give_give_donations_export_option'] ) ? $this->data['give_give_donations_export_option'] : array();
+		$columns = isset($this->data['give_give_donations_export_option']) ? $this->data['give_give_donations_export_option'] : array();
 
 		// We need columns.
-		if ( empty( $columns ) ) {
+		if (empty($columns)) {
 			return false;
 		}
 
-		$this->cols = $this->get_cols( $columns );
+		$this->cols = $this->get_cols($columns);
 
 		return $this->cols;
 	}
@@ -163,83 +163,83 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_cols( $columns ) {
+	private function get_cols($columns) {
 
 		$cols = array();
 
-		foreach ( $columns as $key => $value ) {
+		foreach ($columns as $key => $value) {
 
-			switch ( $key ) {
+			switch ($key) {
 				case 'donation_id' :
-					$cols['donation_id'] = __( 'Donation ID', 'give' );
+					$cols['donation_id'] = __('Donation ID', 'give');
 					break;
 				case 'seq_id' :
-					$cols['seq_id'] = __( 'Donation Number', 'give' );
+					$cols['seq_id'] = __('Donation Number', 'give');
 					break;
 				case 'first_name' :
-					$cols['first_name'] = __( 'First Name', 'give' );
+					$cols['first_name'] = __('First Name', 'give');
 					break;
 				case 'last_name' :
-					$cols['last_name'] = __( 'Last Name', 'give' );
+					$cols['last_name'] = __('Last Name', 'give');
 					break;
 				case 'email' :
-					$cols['email'] = __( 'Email Address', 'give' );
+					$cols['email'] = __('Email Address', 'give');
 					break;
 				case 'company' :
-					$cols['company'] = __( 'Company Name', 'give' );
+					$cols['company'] = __('Company Name', 'give');
 					break;
 				case 'address' :
-					$cols['address_line1']   = __( 'Address 1', 'give' );
-					$cols['address_line2']   = __( 'Address 2', 'give' );
-					$cols['address_city']    = __( 'City', 'give' );
-					$cols['address_state']   = __( 'State', 'give' );
-					$cols['address_zip']     = __( 'Zip', 'give' );
-					$cols['address_country'] = __( 'Country', 'give' );
+					$cols['address_line1']   = __('Address 1', 'give');
+					$cols['address_line2']   = __('Address 2', 'give');
+					$cols['address_city']    = __('City', 'give');
+					$cols['address_state']   = __('State', 'give');
+					$cols['address_zip']     = __('Zip', 'give');
+					$cols['address_country'] = __('Country', 'give');
 					break;
 				case 'donation_total' :
-					$cols['donation_total'] = __( 'Donation Total', 'give' );
+					$cols['donation_total'] = __('Donation Total', 'give');
 					break;
 				case 'currency_code' :
-					$cols['currency_code'] = __( 'Currency Code', 'give' );
+					$cols['currency_code'] = __('Currency Code', 'give');
 					break;
 				case 'currency_symbol' :
-					$cols['currency_symbol'] = __( 'Currency Symbol', 'give' );
+					$cols['currency_symbol'] = __('Currency Symbol', 'give');
 					break;
 				case 'donation_status' :
-					$cols['donation_status'] = __( 'Donation Status', 'give' );
+					$cols['donation_status'] = __('Donation Status', 'give');
 					break;
 				case 'payment_gateway' :
-					$cols['payment_gateway'] = __( 'Payment Gateway', 'give' );
+					$cols['payment_gateway'] = __('Payment Gateway', 'give');
 					break;
 				case 'form_id' :
-					$cols['form_id'] = __( 'Form ID', 'give' );
+					$cols['form_id'] = __('Form ID', 'give');
 					break;
 				case 'form_title' :
-					$cols['form_title'] = __( 'Form Title', 'give' );
+					$cols['form_title'] = __('Form Title', 'give');
 					break;
 				case 'form_level_id' :
-					$cols['form_level_id'] = __( 'Level ID', 'give' );
+					$cols['form_level_id'] = __('Level ID', 'give');
 					break;
 				case 'form_level_title' :
-					$cols['form_level_title'] = __( 'Level Title', 'give' );
+					$cols['form_level_title'] = __('Level Title', 'give');
 					break;
 				case 'donation_date' :
-					$cols['donation_date'] = __( 'Donation Date', 'give' );
+					$cols['donation_date'] = __('Donation Date', 'give');
 					break;
 				case 'donation_time' :
-					$cols['donation_time'] = __( 'Donation Time', 'give' );
+					$cols['donation_time'] = __('Donation Time', 'give');
 					break;
 				case 'userid' :
-					$cols['userid'] = __( 'User ID', 'give' );
+					$cols['userid'] = __('User ID', 'give');
 					break;
 				case 'donorid' :
-					$cols['donorid'] = __( 'Donor ID', 'give' );
+					$cols['donorid'] = __('Donor ID', 'give');
 					break;
 				case 'donor_ip' :
-					$cols['donor_ip'] = __( 'Donor IP Address', 'give' );
+					$cols['donor_ip'] = __('Donor IP Address', 'give');
 					break;
 				default:
-					$cols[ $key ] = $key;
+					$cols[$key] = $key;
 
 			}
 		}
@@ -252,7 +252,7 @@ 
 		 * @param array $cols columns name for CSV
 		 * @param array $columns columns select by admin to export
 		 */
-		return (array) apply_filters( 'give_export_donation_get_columns_name', $cols, $columns );
+		return (array) apply_filters('give_export_donation_get_columns_name', $cols, $columns);
 	}
 
 	/**
@@ -264,24 +264,24 @@ 
 	 *
 	 * @return array $args donation argument
 	 */
-	public function get_donation_argument( $args = array() ) {
+	public function get_donation_argument($args = array()) {
 		$defaults = array(
 			'number' => 30,
 			'page'   => $this->step,
 			'status' => $this->status,
 		);
 		// Date query.
-		if ( ! empty( $this->start ) || ! empty( $this->end ) ) {
-			if ( ! empty( $this->start ) ) {
-				$defaults['date_query'][0]['after'] = date( 'Y-n-d 00:00:00', strtotime( $this->start ) );
+		if ( ! empty($this->start) || ! empty($this->end)) {
+			if ( ! empty($this->start)) {
+				$defaults['date_query'][0]['after'] = date('Y-n-d 00:00:00', strtotime($this->start));
 			}
-			if ( ! empty( $this->end ) ) {
-				$defaults['date_query'][0]['before'] = date( 'Y-n-d 00:00:00', strtotime( $this->end ) );
+			if ( ! empty($this->end)) {
+				$defaults['date_query'][0]['before'] = date('Y-n-d 00:00:00', strtotime($this->end));
 			}
 		}
 
-		if ( ! empty( $this->form_id ) ) {
-			$defaults['give_forms'] = is_array( $this->form_id ) ? $this->form_id : array( $this->form_id );
+		if ( ! empty($this->form_id)) {
+			$defaults['give_forms'] = is_array($this->form_id) ? $this->form_id : array($this->form_id);
 		}
 
 		/**
@@ -290,7 +290,7 @@ 
 		 *
 		 * @since 2.1.3
 		 */
-		return apply_filters( 'give_export_donations_donation_query_args', wp_parse_args( $args, $defaults ) );
+		return apply_filters('give_export_donations_donation_query_args', wp_parse_args($args, $defaults));
 	}
 
 	/**
@@ -309,119 +309,119 @@ 
 		$data = array();
 		$i    = 0;
 		// Payment query.
-		$payments = give_get_payments( $this->get_donation_argument() );
+		$payments = give_get_payments($this->get_donation_argument());
 
-		if ( $payments ) {
+		if ($payments) {
 
-			foreach ( $payments as $payment ) {
+			foreach ($payments as $payment) {
 
 				$columns      = $this->csv_cols();
-				$payment      = new Give_Payment( $payment->ID );
+				$payment      = new Give_Payment($payment->ID);
 				$payment_meta = $payment->payment_meta;
 				$address      = $payment->address;
 
 				// Set columns
-				if ( ! empty( $columns['donation_id'] ) ) {
-					$data[ $i ]['donation_id'] = $payment->ID;
+				if ( ! empty($columns['donation_id'])) {
+					$data[$i]['donation_id'] = $payment->ID;
 				}
 
-				if ( ! empty( $columns['seq_id'] ) ) {
-					$data[ $i ]['seq_id'] = Give()->seq_donation_number->get_serial_code( $payment->ID );
+				if ( ! empty($columns['seq_id'])) {
+					$data[$i]['seq_id'] = Give()->seq_donation_number->get_serial_code($payment->ID);
 				}
 
-				if ( ! empty( $columns['first_name'] ) ) {
-					$data[ $i ]['first_name'] = isset( $payment->first_name ) ? $payment->first_name : '';
+				if ( ! empty($columns['first_name'])) {
+					$data[$i]['first_name'] = isset($payment->first_name) ? $payment->first_name : '';
 				}
 
-				if ( ! empty( $columns['last_name'] ) ) {
-					$data[ $i ]['last_name'] = isset( $payment->last_name ) ? $payment->last_name : '';
+				if ( ! empty($columns['last_name'])) {
+					$data[$i]['last_name'] = isset($payment->last_name) ? $payment->last_name : '';
 				}
 
-				if ( ! empty( $columns['email'] ) ) {
-					$data[ $i ]['email'] = $payment->email;
+				if ( ! empty($columns['email'])) {
+					$data[$i]['email'] = $payment->email;
 				}
 
-				if ( ! empty( $columns['company'] ) ) {
-					$data[ $i ]['company'] = empty( $payment_meta['_give_donation_company'] ) ? '' : str_replace( "\'", "'", $payment_meta['_give_donation_company'] );
+				if ( ! empty($columns['company'])) {
+					$data[$i]['company'] = empty($payment_meta['_give_donation_company']) ? '' : str_replace("\'", "'", $payment_meta['_give_donation_company']);
 				}
 
-				if ( ! empty( $columns['address_line1'] ) ) {
-					$data[ $i ]['address_line1']   = isset( $address['line1'] ) ? $address['line1'] : '';
-					$data[ $i ]['address_line2']   = isset( $address['line2'] ) ? $address['line2'] : '';
-					$data[ $i ]['address_city']    = isset( $address['city'] ) ? $address['city'] : '';
-					$data[ $i ]['address_state']   = isset( $address['state'] ) ? $address['state'] : '';
-					$data[ $i ]['address_zip']     = isset( $address['zip'] ) ? $address['zip'] : '';
-					$data[ $i ]['address_country'] = isset( $address['country'] ) ? $address['country'] : '';
+				if ( ! empty($columns['address_line1'])) {
+					$data[$i]['address_line1']   = isset($address['line1']) ? $address['line1'] : '';
+					$data[$i]['address_line2']   = isset($address['line2']) ? $address['line2'] : '';
+					$data[$i]['address_city']    = isset($address['city']) ? $address['city'] : '';
+					$data[$i]['address_state']   = isset($address['state']) ? $address['state'] : '';
+					$data[$i]['address_zip']     = isset($address['zip']) ? $address['zip'] : '';
+					$data[$i]['address_country'] = isset($address['country']) ? $address['country'] : '';
 				}
 
-				if ( ! empty( $columns['donation_total'] ) ) {
-					$data[ $i ]['donation_total'] = give_format_amount( give_donation_amount( $payment->ID ) );
+				if ( ! empty($columns['donation_total'])) {
+					$data[$i]['donation_total'] = give_format_amount(give_donation_amount($payment->ID));
 				}
 
-				if ( ! empty( $columns['currency_code'] ) ) {
-					$data[ $i ]['currency_code'] = empty( $payment_meta['_give_payment_currency'] ) ? give_get_currency() : $payment_meta['_give_payment_currency'];
+				if ( ! empty($columns['currency_code'])) {
+					$data[$i]['currency_code'] = empty($payment_meta['_give_payment_currency']) ? give_get_currency() : $payment_meta['_give_payment_currency'];
 				}
 
-				if ( ! empty( $columns['currency_symbol'] ) ) {
-					$currency_code = $data[ $i ]['currency_code'];
-					$data[ $i ]['currency_symbol'] =  give_currency_symbol( $currency_code, true );
+				if ( ! empty($columns['currency_symbol'])) {
+					$currency_code = $data[$i]['currency_code'];
+					$data[$i]['currency_symbol'] = give_currency_symbol($currency_code, true);
 				}
 
-				if ( ! empty( $columns['donation_status'] ) ) {
-					$data[ $i ]['donation_status'] = give_get_payment_status( $payment, true );
+				if ( ! empty($columns['donation_status'])) {
+					$data[$i]['donation_status'] = give_get_payment_status($payment, true);
 				}
 
-				if ( ! empty( $columns['payment_gateway'] ) ) {
-					$data[ $i ]['payment_gateway'] = $payment->gateway;
+				if ( ! empty($columns['payment_gateway'])) {
+					$data[$i]['payment_gateway'] = $payment->gateway;
 				}
 
-				if ( ! empty( $columns['form_id'] ) ) {
-					$data[ $i ]['form_id'] = $payment->form_id;
+				if ( ! empty($columns['form_id'])) {
+					$data[$i]['form_id'] = $payment->form_id;
 				}
 
-				if ( ! empty( $columns['form_title'] ) ) {
-					$data[ $i ]['form_title'] = get_the_title( $payment->form_id );
+				if ( ! empty($columns['form_title'])) {
+					$data[$i]['form_title'] = get_the_title($payment->form_id);
 				}
 
-				if ( ! empty( $columns['form_level_id'] ) ) {
-					$data[ $i ]['form_level_id'] = $payment->price_id;
+				if ( ! empty($columns['form_level_id'])) {
+					$data[$i]['form_level_id'] = $payment->price_id;
 				}
 
-				if ( ! empty( $columns['form_level_title'] ) ) {
-					$var_prices = give_has_variable_prices( $payment_meta['form_id'] );
-					if ( empty( $var_prices ) ) {
-						$data[ $i ]['form_level_title'] = '';
+				if ( ! empty($columns['form_level_title'])) {
+					$var_prices = give_has_variable_prices($payment_meta['form_id']);
+					if (empty($var_prices)) {
+						$data[$i]['form_level_title'] = '';
 					} else {
 						$prices_atts = '';
-						if ( $variable_prices = give_get_variable_prices( $payment_meta['form_id'] ) ) {
-							foreach ( $variable_prices as $variable_price ) {
-								$prices_atts[ $variable_price['_give_id']['level_id'] ] = give_format_amount( $variable_price['_give_amount'] );
+						if ($variable_prices = give_get_variable_prices($payment_meta['form_id'])) {
+							foreach ($variable_prices as $variable_price) {
+								$prices_atts[$variable_price['_give_id']['level_id']] = give_format_amount($variable_price['_give_amount']);
 							}
 						}
-						$data[ $i ]['form_level_title'] = give_get_price_option_name( $payment->form_id, $payment->price_id );
+						$data[$i]['form_level_title'] = give_get_price_option_name($payment->form_id, $payment->price_id);
 					}
 				}
 
-				if ( ! empty( $columns['donation_date'] ) ) {
-					$payment_date                = strtotime( $payment->date );
-					$data[ $i ]['donation_date'] = date( give_date_format(), $payment_date );
+				if ( ! empty($columns['donation_date'])) {
+					$payment_date                = strtotime($payment->date);
+					$data[$i]['donation_date'] = date(give_date_format(), $payment_date);
 				}
 
-				if ( ! empty( $columns['donation_time'] ) ) {
-					$payment_date                = strtotime( $payment->date );
-					$data[ $i ]['donation_time'] = date_i18n( 'H', $payment_date ) . ':' . date( 'i', $payment_date );
+				if ( ! empty($columns['donation_time'])) {
+					$payment_date                = strtotime($payment->date);
+					$data[$i]['donation_time'] = date_i18n('H', $payment_date).':'.date('i', $payment_date);
 				}
 
-				if ( ! empty( $columns['userid'] ) ) {
-					$data[ $i ]['userid'] = $payment->user_id;
+				if ( ! empty($columns['userid'])) {
+					$data[$i]['userid'] = $payment->user_id;
 				}
 
-				if ( ! empty( $columns['donorid'] ) ) {
-					$data[ $i ]['donorid'] = $payment->customer_id;
+				if ( ! empty($columns['donorid'])) {
+					$data[$i]['donorid'] = $payment->customer_id;
 				}
 
-				if ( ! empty( $columns['donor_ip'] ) ) {
-					$data[ $i ]['donor_ip'] = give_get_payment_user_ip( $payment->ID );
+				if ( ! empty($columns['donor_ip'])) {
+					$data[$i]['donor_ip'] = give_get_payment_user_ip($payment->ID);
 				}
 
 				// Add custom field data.
@@ -452,15 +452,15 @@ 
 				);
 
 				// Removing above keys...
-				foreach ( $remove_keys as $key ) {
-					unset( $columns[ $key ] );
+				foreach ($remove_keys as $key) {
+					unset($columns[$key]);
 				}
 
 				// Now loop through remaining meta fields.
-				foreach ( $columns as $col ) {
-					$field_data         = get_post_meta( $payment->ID, $col, true );
-					$data[ $i ][ $col ] = $field_data;
-					unset( $columns[ $col ] );
+				foreach ($columns as $col) {
+					$field_data         = get_post_meta($payment->ID, $col, true);
+					$data[$i][$col] = $field_data;
+					unset($columns[$col]);
 				}
 
 				/**
@@ -475,27 +475,27 @@ 
 				 *
 				 * @return array Donation data
 				 */
-				$data[ $i ] = apply_filters( 'give_export_donation_data', $data[ $i ], $payment, $columns, $this );
+				$data[$i] = apply_filters('give_export_donation_data', $data[$i], $payment, $columns, $this);
 
 				$new_data = array();
-				$old_data = $data[ $i ];
+				$old_data = $data[$i];
 
 				// sorting the columns bas on row
-				foreach ( $this->csv_cols() as $key => $value ) {
-					if ( array_key_exists( $key, $old_data ) ) {
-						$new_data[ $key ] = $old_data[ $key ];
+				foreach ($this->csv_cols() as $key => $value) {
+					if (array_key_exists($key, $old_data)) {
+						$new_data[$key] = $old_data[$key];
 					}
 				}
 
-				$data[ $i ] = $new_data;
+				$data[$i] = $new_data;
 
 				// Increment iterator.
-				$i ++;
+				$i++;
 
 			}
 
-			$data = apply_filters( 'give_export_get_data', $data );
-			$data = apply_filters( "give_export_get_data_{$this->export_type}", $data );
+			$data = apply_filters('give_export_get_data', $data);
+			$data = apply_filters("give_export_get_data_{$this->export_type}", $data);
 
 			return $data;
 
@@ -513,17 +513,17 @@ 
 	 * @return int
 	 */
 	public function get_percentage_complete() {
-		$args = $this->get_donation_argument( array( 'number' => - 1 ) );
-		if ( isset( $args['page'] ) ) {
-			unset( $args['page'] );
+		$args = $this->get_donation_argument(array('number' => -1));
+		if (isset($args['page'])) {
+			unset($args['page']);
 		}
-		$query      = give_get_payments( $args );
-		$total      = count( $query );
+		$query      = give_get_payments($args);
+		$total      = count($query);
 		$percentage = 100;
-		if ( $total > 0 ) {
-			$percentage = ( ( 30 * $this->step ) / $total ) * 100;
+		if ($total > 0) {
+			$percentage = ((30 * $this->step) / $total) * 100;
 		}
-		if ( $percentage > 100 ) {
+		if ($percentage > 100) {
 			$percentage = 100;
 		}
 
@@ -545,23 +545,23 @@ 
 		$data     = $this->get_data();
 		$cols     = $this->get_csv_cols();
 
-		if ( $data ) {
+		if ($data) {
 
 			// Output each row
-			foreach ( $data as $row ) {
+			foreach ($data as $row) {
 				$i = 1;
-				foreach ( $row as $col_id => $column ) {
+				foreach ($row as $col_id => $column) {
 					// Make sure the column is valid
-					if ( array_key_exists( $col_id, $cols ) ) {
-						$row_data .= '"' . preg_replace( '/"/', "'", $column ) . '"';
-						$row_data .= $i == count( $cols ) ? '' : ',';
-						$i ++;
+					if (array_key_exists($col_id, $cols)) {
+						$row_data .= '"'.preg_replace('/"/', "'", $column).'"';
+						$row_data .= $i == count($cols) ? '' : ',';
+						$i++;
 					}
 				}
 				$row_data .= "\r\n";
 			}
 
-			$this->stash_step_data( $row_data );
+			$this->stash_step_data($row_data);
 
 			return $row_data;
 		}