Give_Tools_Delete_Test_Transactions::headers() - Code Metrics - Inspection of "Fix #1971" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — issues/1971 ( 0bed62 )

by Ravinder

created 2017-08-09 07:19 UTC

Give_Tools_Delete_Test_Transactions::headers() A

↳ Parent: Give_Tools_Delete_Test_Transactions

Complexity

Conditions	3
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	7
Ratio	100 %

Importance

Changes

Metric	Value
cc	3
eloc	4
nc	2
nop	0
dl	7
loc	7
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Delete Test Transactions
 *
 * This class handles batch processing of deleting test transactions
 *
 * @subpackage  Admin/Tools/Give_Tools_Delete_Test_Transactions
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.5
 */

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

/**
 * Give_Tools_Delete_Test_Transactions Class
 *
 * @since 1.5
 */
class Give_Tools_Delete_Test_Transactions extends Give_Batch_Export {

	/**
	 * Our export type. Used for export-type specific filters/actions
	 * @var string
	 * @since 1.5
	 */
	public $export_type = '';

	/**
	 * Allows for a non-form batch processing to be run.
	 * @since  1.5
	 * @var boolean
	 */
	public $is_void = true;

	/**
	 * Sets the number of items to pull on each step
	 * @since  1.5
	 * @var integer
	 */
	public $per_step = 30;

	/**
	 * Get the Export Data
	 *
	 * @access public
	 * @since 1.5
	 * @global object $wpdb Used to query the database using the WordPress Database API
	 *
	 * @return array|bool $data The data for the CSV file
	 */
	public function get_data() {
		global $wpdb;

		$items = $this->get_stored_data( 'give_temp_delete_test_ids' );

		if ( ! is_array( $items ) ) {
			return false;
		}

		$offset     = ( $this->step - 1 ) * $this->per_step;
		$step_items = array_slice( $items, $offset, $this->per_step );

		if ( $step_items ) {


			$step_ids = array(
				'other' => array(),
			);

			foreach ( $step_items as $item ) {

				$step_ids['other'][] = $item['id'];

			}

			$sql = array();

			foreach ( $step_ids as $type => $ids ) {

				if ( empty( $ids ) ) {
					continue;
				}

				$parent_query = '';
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

				switch ( $type ) {
					case 'other':

						$temp_ids = implode( ',', $ids );

						// Get all the test logs of the donations ids.
						$parent_query = "SELECT DISTINCT post_id as id FROM $wpdb->postmeta WHERE meta_key = '_give_log_payment_id' AND meta_value IN ( $temp_ids )";
						$parent_ids = $wpdb->get_results( $parent_query, 'ARRAY_A' );


						// List of all test logs.
						if ( $parent_ids ) {
							foreach ( $parent_ids as $parent_id ) {
								// Adding all the test log in post ids that are going to get deleted.
								$ids[] = $parent_id['id'];
							}
						}
						$ids = implode( ',', $ids );

						$sql[] = "DELETE FROM $wpdb->posts WHERE id IN ($ids)";
						$sql[] = "DELETE FROM $wpdb->postmeta WHERE post_id IN ($ids)";
						$sql[] = "DELETE FROM $wpdb->comments WHERE comment_post_ID IN ($ids)";
						$sql[] = "DELETE FROM $wpdb->commentmeta WHERE comment_id NOT IN (SELECT comment_ID FROM $wpdb->comments)";
						break;
				}


			}

			if ( ! empty( $sql ) ) {
				foreach ( $sql as $query ) {
					$wpdb->query( $query );

				}
				do_action( 'give_delete_log_cache' );
			}
			return true;
		}
		return false;
	}

	/**
	 * Return the calculated completion percentage
	 *
	 * @since 1.5
	 * @return int
	 */
	public function get_percentage_complete() {

		$items = $this->get_stored_data( 'give_temp_delete_test_ids', false );

		$total = count( $items );

		$percentage = 100;

		if ( $total > 0 ) {
			$percentage = ( ( $this->per_step * $this->step ) / $total ) * 100;
		}

		if ( $percentage > 100 ) {
			$percentage = 100;
		}

		return $percentage;
	}

	/**
	 * Set the properties specific to the payments export
	 *
	 * @since 1.5
	 *
	 * @param array $request The Form Data passed into the batch processing
	 */
	public function set_properties( $request ) {
	}

	/**
	 * Process a step
	 *
	 * @since 1.5
	 * @return bool
	 */
	public function process_step() {


		if ( ! $this->can_export() ) {
			wp_die( __( 'You do not have permission to delete test transactions.', 'give' ), __( 'Error', 'give' ), array( 'response' => 403 ) );
		}

		$had_data = $this->get_data();

		if ( $had_data ) {
			$this->done = false;

			return true;
		} else {
			update_option( 'give_earnings_total', give_get_total_earnings( true ) );
			Give_Cache::delete( Give_Cache::get_key('give_estimated_monthly_stats' ) );


			$this->delete_data( 'give_temp_delete_test_ids' );

			// Reset the sequential order numbers
			if ( give_get_option( 'enable_sequential' ) ) {
				delete_option( 'give_last_payment_number' );
			}

			$this->done    = true;
			$this->message = __( 'Test transactions successfully deleted.', 'give' );

			return false;
		}
	}

	/**
	 * Headers
	 */
	public function headers() {

		ignore_user_abort( true );

		if ( ! give_is_func_disabled( 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) {
			set_time_limit( 0 );
		}
	}

	/**
	 * Perform the export
	 *
	 * @access public
	 * @since 1.5
	 * @return void
	 */
	public function export() {

		// Set headers
		$this->headers();

		give_die();
	}

	/**
	 * Pre Fetch
	 */
	public function pre_fetch() {

		if ( $this->step == 1 ) {

			$this->delete_data( 'give_temp_delete_test_ids' );
		}

		$items = get_option( 'give_temp_delete_test_ids', false );

		if ( false === $items ) {
			$items = array();

			$args = apply_filters( 'give_tools_reset_stats_total_args', array(
				'post_type'      => 'give_payment',
				'post_status'    => 'any',
				'posts_per_page' => - 1,
				// ONLY TEST MODE TRANSACTIONS!!!
				'meta_key'   => '_give_payment_mode',

				'meta_value' => 'test'

			) );

			$posts = get_posts( $args );
			foreach ( $posts as $post ) {

				$items[] = array(
					'id'   => (int) $post->ID,
					'type' => $post->post_type,
				);
			}

			// Allow filtering of items to remove with an unassociative array for each item.
			// The array contains the unique ID of the item, and a 'type' for you to use in the execution of the get_data method.
			$items = apply_filters( 'give_delete_test_items', $items );

			$this->store_data( 'give_temp_delete_test_ids', $items );
		}

	}

	/**
	 * Given a key, get the information from the Database Directly
	 *
	 * @since  1.5
	 *
	 * @param  string $key The option_name
	 *
	 * @return mixed       Returns the data from the database
	 */
	private function get_stored_data( $key ) {
		global $wpdb;
		$value = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = '%s'", $key ) );


		return empty( $value ) ? false : maybe_unserialize( $value );
	}

	/**
	 * Give a key, store the value
	 *
	 * @since  1.5
	 *
	 * @param  string $key The option_name
	 * @param  mixed $value The value to store
	 *
	 * @return void
	 */
	private function store_data( $key, $value ) {

		global $wpdb;

		$value = maybe_serialize( $value );

		$data = array(
			'option_name'  => $key,
			'option_value' => $value,
			'autoload'     => 'no',
		);

		$formats = array(
			'%s',
			'%s',
			'%s',
		);

		$wpdb->replace( $wpdb->options, $data, $formats );

	}

	/**
	 * Delete an option
	 *
	 * @since  1.5
	 *
	 * @param  string $key The option_name to delete
	 *
	 * @return void
	 */
	private function delete_data( $key ) {
		global $wpdb;
		$wpdb->delete( $wpdb->options, array( 'option_name' => $key ) );
	}

}


1		<?php
2		/**
3		* Delete Test Transactions
4		*
5		* This class handles batch processing of deleting test transactions
6		*
7		* @subpackage Admin/Tools/Give_Tools_Delete_Test_Transactions
8		* @copyright Copyright (c) 2016, WordImpress
9		* @license https://opensource.org/licenses/gpl-license GNU Public License
10		* @since 1.5
11		*/
12
13		// Exit if accessed directly.
14		if ( ! defined( 'ABSPATH' ) ) {
15		exit;
16		}
17
18		/**
19		* Give_Tools_Delete_Test_Transactions Class
20		*
21		* @since 1.5
22		*/
23		class Give_Tools_Delete_Test_Transactions extends Give_Batch_Export {
24
25		/**
26		* Our export type. Used for export-type specific filters/actions
27		* @var string
28		* @since 1.5
29		*/
30		public $export_type = '';
31
32		/**
33		* Allows for a non-form batch processing to be run.
34		* @since 1.5
35		* @var boolean
36		*/
37		public $is_void = true;
38
39		/**
40		* Sets the number of items to pull on each step
41		* @since 1.5
42		* @var integer
43		*/
44		public $per_step = 30;
45
46		/**
47		* Get the Export Data
48		*
49		* @access public
50		* @since 1.5
51		* @global object $wpdb Used to query the database using the WordPress Database API
52		*
53		* @return array\|bool $data The data for the CSV file
54		*/
55		public function get_data() {
56		global $wpdb;
57
58		$items = $this->get_stored_data( 'give_temp_delete_test_ids' );
59
60		if ( ! is_array( $items ) ) {
61		return false;
62		}
63
64		$offset = ( $this->step - 1 ) * $this->per_step;
65		$step_items = array_slice( $items, $offset, $this->per_step );
66
67		if ( $step_items ) {
		0 ignored issues – show Bug Best Practice introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report The expression `$step_items` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `! empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
68
69		$step_ids = array(
70		'other' => array(),
71		);
72
73		foreach ( $step_items as $item ) {
74
75		$step_ids['other'][] = $item['id'];
76
77		}
78
79		$sql = array();
80
81		foreach ( $step_ids as $type => $ids ) {
82
83		if ( empty( $ids ) ) {
84		continue;
85		}
86
87		$parent_query = '';
		0 ignored issues – show Unused Code introduced 2017-08-09 07:23 UTC by Report Bug Copy Issue Report `$parent_query` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
88
89		switch ( $type ) {
90		case 'other':
91
92		$temp_ids = implode( ',', $ids );
93
94		// Get all the test logs of the donations ids.
95		$parent_query = "SELECT DISTINCT post_id as id FROM $wpdb->postmeta WHERE meta_key = '_give_log_payment_id' AND meta_value IN ( $temp_ids )";
96		$parent_ids = $wpdb->get_results( $parent_query, 'ARRAY_A' );
		0 ignored issues – show introduced 2017-08-09 07:23 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-08-09 07:23 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
97
98		// List of all test logs.
99		if ( $parent_ids ) {
100		foreach ( $parent_ids as $parent_id ) {
101		// Adding all the test log in post ids that are going to get deleted.
102		$ids[] = $parent_id['id'];
103		}
104		}
105		$ids = implode( ',', $ids );
106
107		$sql[] = "DELETE FROM $wpdb->posts WHERE id IN ($ids)";
108		$sql[] = "DELETE FROM $wpdb->postmeta WHERE post_id IN ($ids)";
109		$sql[] = "DELETE FROM $wpdb->comments WHERE comment_post_ID IN ($ids)";
110		$sql[] = "DELETE FROM $wpdb->commentmeta WHERE comment_id NOT IN (SELECT comment_ID FROM $wpdb->comments)";
111		break;
112		}
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Blank line found after control structure Loading history...
113
114		}
115
116		if ( ! empty( $sql ) ) {
117		foreach ( $sql as $query ) {
118		$wpdb->query( $query );
		0 ignored issues – show introduced 2017-08-09 07:23 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-08-09 07:23 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
119		}
120		do_action( 'give_delete_log_cache' );
121		}
122		return true;
123		}
124		return false;
125		}
126
127		/**
128		* Return the calculated completion percentage
129		*
130		* @since 1.5
131		* @return int
132		*/
133		public function get_percentage_complete() {
134
135		$items = $this->get_stored_data( 'give_temp_delete_test_ids', false );
		0 ignored issues – show Unused Code introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report The call to `Give_Tools_Delete_Test_T...ions::get_stored_data()` has too many arguments starting with `false`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
136		$total = count( $items );
137
138		$percentage = 100;
139
140		if ( $total > 0 ) {
141		$percentage = ( ( $this->per_step * $this->step ) / $total ) * 100;
142		}
143
144		if ( $percentage > 100 ) {
145		$percentage = 100;
146		}
147
148		return $percentage;
149		}
150
151		/**
152		* Set the properties specific to the payments export
153		*
154		* @since 1.5
155		*
156		* @param array $request The Form Data passed into the batch processing
157		*/
158		public function set_properties( $request ) {
159		}
160
161		/**
162		* Process a step
163		*
164		* @since 1.5
165		* @return bool
166		*/
167	View Code Duplication	public function process_step() {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
168
169		if ( ! $this->can_export() ) {
170		wp_die( __( 'You do not have permission to delete test transactions.', 'give' ), __( 'Error', 'give' ), array( 'response' => 403 ) );
171		}
172
173		$had_data = $this->get_data();
174
175		if ( $had_data ) {
176		$this->done = false;
177
178		return true;
179		} else {
180		update_option( 'give_earnings_total', give_get_total_earnings( true ) );
181		Give_Cache::delete( Give_Cache::get_key('give_estimated_monthly_stats' ) );
		0 ignored issues – show Coding Style introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Expected 1 spaces after opening bracket; 0 found Loading history...
182
183		$this->delete_data( 'give_temp_delete_test_ids' );
184
185		// Reset the sequential order numbers
186		if ( give_get_option( 'enable_sequential' ) ) {
187		delete_option( 'give_last_payment_number' );
188		}
189
190		$this->done = true;
191		$this->message = __( 'Test transactions successfully deleted.', 'give' );
192
193		return false;
194		}
195		}
196
197		/**
198		* Headers
199		*/
200	View Code Duplication	public function headers() {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
201		ignore_user_abort( true );
202
203		if ( ! give_is_func_disabled( 'set_time_limit' ) && ! ini_get( 'safe_mode' ) ) {
204		set_time_limit( 0 );
205		}
206		}
207
208		/**
209		* Perform the export
210		*
211		* @access public
212		* @since 1.5
213		* @return void
214		*/
215		public function export() {
216
217		// Set headers
218		$this->headers();
219
220		give_die();
221		}
222
223		/**
224		* Pre Fetch
225		*/
226		public function pre_fetch() {
227
228		if ( $this->step == 1 ) {
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Found "== 1". Use Yoda Condition checks, you must Loading history...
229		$this->delete_data( 'give_temp_delete_test_ids' );
230		}
231
232		$items = get_option( 'give_temp_delete_test_ids', false );
233
234		if ( false === $items ) {
235		$items = array();
236
237		$args = apply_filters( 'give_tools_reset_stats_total_args', array(
238		'post_type' => 'give_payment',
239		'post_status' => 'any',
240		'posts_per_page' => - 1,
241		// ONLY TEST MODE TRANSACTIONS!!!
242		'meta_key' => '_give_payment_mode',
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Detected usage of meta_key, possible slow query. Loading history...
243		'meta_value' => 'test'
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Detected usage of meta_value, possible slow query. Loading history... introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Each line in an array declaration must end in a comma Loading history...
244		) );
245
246		$posts = get_posts( $args );
247	View Code Duplication	foreach ( $posts as $post ) {
		0 ignored issues – show Duplication introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
248		$items[] = array(
249		'id' => (int) $post->ID,
250		'type' => $post->post_type,
251		);
252		}
253
254		// Allow filtering of items to remove with an unassociative array for each item.
255		// The array contains the unique ID of the item, and a 'type' for you to use in the execution of the get_data method.
256		$items = apply_filters( 'give_delete_test_items', $items );
257
258		$this->store_data( 'give_temp_delete_test_ids', $items );
259		}
260
261		}
262
263		/**
264		* Given a key, get the information from the Database Directly
265		*
266		* @since 1.5
267		*
268		* @param string $key The option_name
269		*
270		* @return mixed Returns the data from the database
271		*/
272		private function get_stored_data( $key ) {
273		global $wpdb;
274		$value = $wpdb->get_var( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = '%s'", $key ) );
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call without caching is prohibited. Use wp_cache_get / wp_cache_set. Loading history...
275
276		return empty( $value ) ? false : maybe_unserialize( $value );
277		}
278
279		/**
280		* Give a key, store the value
281		*
282		* @since 1.5
283		*
284		* @param string $key The option_name
285		* @param mixed $value The value to store
286		*
287		* @return void
288		*/
289	View Code Duplication	private function store_data( $key, $value ) {
		0 ignored issues – show Duplication introduced 2017-07-31 10:46 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
290		global $wpdb;
291
292		$value = maybe_serialize( $value );
293
294		$data = array(
295		'option_name' => $key,
296		'option_value' => $value,
297		'autoload' => 'no',
298		);
299
300		$formats = array(
301		'%s',
302		'%s',
303		'%s',
304		);
305
306		$wpdb->replace( $wpdb->options, $data, $formats );
		0 ignored issues – show introduced 2017-07-29 03:17 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history...
307		}
308
309		/**
310		* Delete an option
311		*
312		* @since 1.5
313		*
314		* @param string $key The option_name to delete
315		*
316		* @return void
317		*/
318		private function delete_data( $key ) {
319		global $wpdb;
320		$wpdb->delete( $wpdb->options, array( 'option_name' => $key ) );
321		}
322
323		}
324

ravinderk / Give

Push — issues/1971 ( 0bed62 )

Give_Tools_Delete_Test_Transactions::headers() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like