PostsModule::get_sticky_posts() - Code Metrics - Inspection of "249 fix/delete posts by custom taxonomy test" - sudar/bulk-delete - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — dev/6.0.0 (#382)

by Rajan

created 2018-08-13 02:32 UTC

PostsModule::get_sticky_posts() A

↳ Parent: PostsModule

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	0
dl	0
loc	4
ccs	0
cts	3
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace BulkWP\BulkDelete\Core\Posts;

use BulkWP\BulkDelete\Core\Base\BaseModule;

defined( 'ABSPATH' ) || exit; // Exit if accessed directly.

/**
 * Module for deleting posts.
 *
 * @since 6.0.0
 */
abstract class PostsModule extends BaseModule {
	/**
	 * Build query params for WP_Query by using delete options.
	 *
	 * Return an empty query array to short-circuit deletion.
	 *
	 * @param array $options Delete options.
	 *
	 * @return array Query.
	 */
	abstract protected function build_query( $options );

	/**
	 * Item Type. Possible values 'posts', 'pages', 'users' etc.
	 *
	 * @var string
	 */
	protected $item_type = 'posts';

	/**
	 * Handle common filters.
	 *
	 * @param array $request Request array.
	 *
	 * @return array User options.
	 */
	protected function parse_common_filters( $request ) {
		$options = array();

		$options['restrict']     = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
		$options['limit_to']     = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
		$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );

		$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
		$options['days']    = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );

		return $options;
	}

	/**
	 * Filter JS Array and add pro hooks.
	 *
	 * @since 5.5
	 *
	 * @param array $js_array JavaScript Array.
	 *
	 * @return array Modified JavaScript Array
	 */
	public function filter_js_array( $js_array ) {
		$js_array['msg']['deletePostsWarning'] = __( 'Are you sure you want to delete all the posts based on the selected option?', 'bulk-delete' );
		$js_array['msg']['selectPostOption']   = __( 'Please select posts from at least one option', 'bulk-delete' );

		$js_array['validators']['delete_posts_by_category'] = 'validateSelect2';
		$js_array['error_msg']['delete_posts_by_category']  = 'selectCategory';
		$js_array['msg']['selectCategory']                  = __( 'Please select at least one category', 'bulk-delete' );

		$js_array['validators']['delete_posts_by_tag']     = 'validateSelect2';
		$js_array['error_msg']['delete_posts_by_category'] = 'selectTag';
		$js_array['msg']['selectTag']                      = __( 'Please select at least one tag', 'bulk-delete' );

		$js_array['validators']['delete_posts_by_url'] = 'validateUrl';
		$js_array['error_msg']['delete_posts_by_url']  = 'enterUrl';
		$js_array['msg']['enterUrl']                   = __( 'Please enter at least one post url', 'bulk-delete' );

		$js_array['dt_iterators'][] = '_cats';
		$js_array['dt_iterators'][] = '_tags';
		$js_array['dt_iterators'][] = '_taxs';
		$js_array['dt_iterators'][] = '_post_status';

		return $js_array;
	}

	/**
	 * Perform the deletion.
	 *
	 * @param array $options Array of Delete options.
	 *
	 * @return int Number of items that were deleted.
	 */
	protected function do_delete( $options ) {
		$query = $this->build_query( $options );

		if ( empty( $query ) ) {
			// Short circuit deletion, if nothing needs to be deleted.
			return 0;
		}

		return $this->delete_posts_from_query( $query, $options );
	}

	/**
	 * Build the query using query params and then Delete posts.
	 *
	 * @param array $query   Params for WP Query.
	 * @param array $options Delete Options.
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_posts_from_query( $query, $options ) {
		$query        = bd_build_query_options( $options, $query );
		$post_ids     = bd_query( $query );
		$force_delete = isset( $options['force_delete'] ) ? $options['force_delete'] : false;

		return $this->delete_posts_by_id( $post_ids, $force_delete );
	}

	/**
	 * Render the "private post" setting fields.
	 */
	protected function render_private_post_settings() {
		if ( $this->are_private_posts_present() ) {
			bd_render_private_post_settings( $this->field_slug );
		}
	}

	/**
	 * Render Category dropdown.
	 */
	protected function render_category_dropdown() {
		$categories = $this->get_categories();
		?>

		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_category[]" data-placeholder="<?php _e( 'Select Categories', 'bulk-delete' ); ?>"
				class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $categories ), 'select2-taxonomy' ) ); ?>"
				data-taxonomy="category" multiple>

			<option value="all">
				<?php _e( 'All Categories', 'bulk-delete' ); ?>
			</option>

			<?php foreach ( $categories as $category ) : ?>
				<option value="<?php echo absint( $category->cat_ID ); ?>">
					<?php echo esc_html( $category->cat_name ), ' (', absint( $category->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
				</option>
			<?php endforeach; ?>

		</select>
		<?php
	}

	/**
	 * Render Tags dropdown.
	 */
	protected function render_tags_dropdown() {
		$tags = $this->get_tags();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
		?>

		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" data-placeholder="<?php _e( 'Select Tags', 'bulk-delete' ); ?>"
				class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $tags ), 'select2-taxonomy' ) ); ?>"
				data-taxonomy="post_tag" multiple>

			<option value="all">
				<?php _e( 'All Tags', 'bulk-delete' ); ?>
			</option>

			<?php foreach ( $tags as $tag ) : ?>

				<option value="<?php echo absint( $tag->term_id ); ?>">
					<?php echo esc_html( $tag->name ), ' (', absint( $tag->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
				</option>
			<?php endforeach; ?>
		</select>
		<?php
	}

	/**
	 * Render Sticky Posts dropdown.
	 */
	protected function render_sticky_post_dropdown() {
		$posts = $this->get_sticky_posts();
		?>
		<table class="optiontable">
			<tr>
				<td scope="row">
					<input type="checkbox" class="smbd_sticky_post_options" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" value="All">
					<label>All</label>
				</td>
			</tr>
			<?php
			foreach ( $posts as $post ) :
				$user = get_userdata( $post->post_author );
				?>
			<tr>
				<td scope="row">
				<input type="checkbox" class="smbd_sticky_post_options" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" value="<?php echo absint( $post->ID ); ?>">
				<label><?php echo esc_html( $post->post_title . ' Published by ' . $user->display_name . ' on ' . $post->post_date ); ?></label>
				</td>
			</tr>
			<?php endforeach; ?>
		</table>
		<?php
	}

	/**
	 * Get the list of sticky posts.
	 *
	 * @return array List of sticky posts.
	 */
	protected function get_sticky_posts() {
		$posts = get_posts( array( 'post__in' => get_option( 'sticky_posts' ) ) );

		return $posts;
	}

	/**
	 * Get the list of categories.
	 *
	 * @return array List of categories.
	 */
	protected function get_categories() {
		$enhanced_select_threshold = $this->get_enhanced_select_threshold();

		$categories = get_categories(
			array(
				'hide_empty' => false,
				'number'     => $enhanced_select_threshold,
			)
		);

		return $categories;
	}

	/**
	 * Are tags present in this WordPress installation?
	 *
	 * Only one tag is retrieved to check if tags are present for performance reasons.
	 *
	 * @return bool True if tags are present, False otherwise.
	 */
	protected function are_tags_present() {
		$tags = $this->get_tags( 1 );
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

		return ( count( $tags ) > 0 );
	}

	/**
	 * Are sticky post present in this WordPress?
	 *
	 * Only one post is retrieved to check if stick post are present for performance reasons.
	 *
	 * @return bool True if posts are present, False otherwise.
	 */
	protected function are_sticky_post_present() {
		$sticky_post_ids = get_option( 'sticky_posts' );

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

		return ( count( $sticky_post_ids ) > 0 );
	}

	/**
	 * Get the list of tags.
	 *
	 * @param int $max_count The maximum number of tags to be returned (Optional). Default 0.
	 *                       If 0 then the maximum number of tags specified in `get_enhanced_select_threshold` will be returned.
	 */
	protected function get_tags( $max_count = 0 ) {
		if ( absint( $max_count ) === 0 ) {
			$max_count = $this->get_enhanced_select_threshold();

		}
	}

	/**
	 * Delete sticky posts.
	 *
	 * @param bool $force_delete Whether to bypass trash and force deletion.
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_sticky_posts( $force_delete ) {
		$sticky_post_ids = get_option( 'sticky_posts' );

		if ( ! is_array( $sticky_post_ids ) ) {
			return 0;
		}

		return $this->delete_posts_by_id( $sticky_post_ids, $force_delete );
	}

	/**
	 * Delete posts by ids.
	 *
	 * @param int[] $post_ids     List of post ids to delete.
	 * @param bool  $force_delete True to force delete posts, False otherwise.
	 *
	 * @return int Number of posts deleted.
	 */
	protected function delete_posts_by_id( $post_ids, $force_delete ) {
		foreach ( $post_ids as $post_id ) {
			// `$force_delete` parameter to `wp_delete_post` won't work for custom post types.
			// See https://core.trac.wordpress.org/ticket/43672
			if ( $force_delete ) {
				wp_delete_post( $post_id, true );
			} else {
				wp_trash_post( $post_id );
			}
		}

		return count( $post_ids );
	}
}


1		<?php
2		namespace BulkWP\BulkDelete\Core\Posts;
3
4		use BulkWP\BulkDelete\Core\Base\BaseModule;
5
6	1	defined( 'ABSPATH' ) \|\| exit; // Exit if accessed directly.
7
8		/**
9		* Module for deleting posts.
10		*
11		* @since 6.0.0
12		*/
13		abstract class PostsModule extends BaseModule {
14		/**
15		* Build query params for WP_Query by using delete options.
16		*
17		* Return an empty query array to short-circuit deletion.
18		*
19		* @param array $options Delete options.
20		*
21		* @return array Query.
22		*/
23		abstract protected function build_query( $options );
24
25		/**
26		* Item Type. Possible values 'posts', 'pages', 'users' etc.
27		*
28		* @var string
29		*/
30		protected $item_type = 'posts';
31
32		/**
33		* Handle common filters.
34		*
35		* @param array $request Request array.
36		*
37		* @return array User options.
38		*/
39		protected function parse_common_filters( $request ) {
40		$options = array();
41
42		$options['restrict'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_restrict', false );
43		$options['limit_to'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_limit_to', 0 ) );
44		$options['force_delete'] = bd_array_get_bool( $request, 'smbd_' . $this->field_slug . '_force_delete', false );
45
46		$options['date_op'] = bd_array_get( $request, 'smbd_' . $this->field_slug . '_op' );
47		$options['days'] = absint( bd_array_get( $request, 'smbd_' . $this->field_slug . '_days' ) );
48
49		return $options;
50		}
51
52		/**
53		* Filter JS Array and add pro hooks.
54		*
55		* @since 5.5
56		*
57		* @param array $js_array JavaScript Array.
58		*
59		* @return array Modified JavaScript Array
60		*/
61		public function filter_js_array( $js_array ) {
62		$js_array['msg']['deletePostsWarning'] = __( 'Are you sure you want to delete all the posts based on the selected option?', 'bulk-delete' );
63		$js_array['msg']['selectPostOption'] = __( 'Please select posts from at least one option', 'bulk-delete' );
64
65		$js_array['validators']['delete_posts_by_category'] = 'validateSelect2';
66		$js_array['error_msg']['delete_posts_by_category'] = 'selectCategory';
67		$js_array['msg']['selectCategory'] = __( 'Please select at least one category', 'bulk-delete' );
68
69		$js_array['validators']['delete_posts_by_tag'] = 'validateSelect2';
70		$js_array['error_msg']['delete_posts_by_category'] = 'selectTag';
71		$js_array['msg']['selectTag'] = __( 'Please select at least one tag', 'bulk-delete' );
72
73		$js_array['validators']['delete_posts_by_url'] = 'validateUrl';
74		$js_array['error_msg']['delete_posts_by_url'] = 'enterUrl';
75		$js_array['msg']['enterUrl'] = __( 'Please enter at least one post url', 'bulk-delete' );
76
77		$js_array['dt_iterators'][] = '_cats';
78		$js_array['dt_iterators'][] = '_tags';
79		$js_array['dt_iterators'][] = '_taxs';
80		$js_array['dt_iterators'][] = '_post_status';
81
82		return $js_array;
83		}
84
85		/**
86		* Perform the deletion.
87		*
88		* @param array $options Array of Delete options.
89		*
90		* @return int Number of items that were deleted.
91		*/
92	65	protected function do_delete( $options ) {
93	65	$query = $this->build_query( $options );
94
95	65	if ( empty( $query ) ) {
96		// Short circuit deletion, if nothing needs to be deleted.
97		return 0;
98		}
99
100	65	return $this->delete_posts_from_query( $query, $options );
101		}
102
103		/**
104		* Build the query using query params and then Delete posts.
105		*
106		* @param array $query Params for WP Query.
107		* @param array $options Delete Options.
108		*
109		* @return int Number of posts deleted.
110		*/
111	74	protected function delete_posts_from_query( $query, $options ) {
112	74	$query = bd_build_query_options( $options, $query );
113	74	$post_ids = bd_query( $query );
114	74	$force_delete = isset( $options['force_delete'] ) ? $options['force_delete'] : false;
115
116	74	return $this->delete_posts_by_id( $post_ids, $force_delete );
117		}
118
119		/**
120		* Render the "private post" setting fields.
121		*/
122		protected function render_private_post_settings() {
123		if ( $this->are_private_posts_present() ) {
124		bd_render_private_post_settings( $this->field_slug );
125		}
126		}
127
128		/**
129		* Render Category dropdown.
130		*/
131		protected function render_category_dropdown() {
132		$categories = $this->get_categories();
133		?>
134
135		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>_category[]" data-placeholder="<?php _e( 'Select Categories', 'bulk-delete' ); ?>"
136		class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $categories ), 'select2-taxonomy' ) ); ?>"
137		data-taxonomy="category" multiple>
138
139		<option value="all">
140		<?php _e( 'All Categories', 'bulk-delete' ); ?>
141		</option>
142
143		<?php foreach ( $categories as $category ) : ?>
144		<option value="<?php echo absint( $category->cat_ID ); ?>">
145		<?php echo esc_html( $category->cat_name ), ' (', absint( $category->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
146		</option>
147		<?php endforeach; ?>
148
149		</select>
150		<?php
151		}
152
153		/**
154		* Render Tags dropdown.
155		*/
156		protected function render_tags_dropdown() {
157		$tags = $this->get_tags();
		0 ignored issues – show Bug introduced 2018-08-13 02:39 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$tags` is correct as `$this->get_tags()` targeting `BulkWP\BulkDelete\Core\P...PostsModule::get_tags()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
158		?>
159
160		<select name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" data-placeholder="<?php _e( 'Select Tags', 'bulk-delete' ); ?>"
161		class="<?php echo sanitize_html_class( $this->enable_ajax_if_needed_to_dropdown_class_name( count( $tags ), 'select2-taxonomy' ) ); ?>"
162		data-taxonomy="post_tag" multiple>
163
164		<option value="all">
165		<?php _e( 'All Tags', 'bulk-delete' ); ?>
166		</option>
167
168		<?php foreach ( $tags as $tag ) : ?>
		0 ignored issues – show Bug introduced 2018-08-13 02:39 UTC by Report Bug Copy Issue Report The expression `$tags` of type `null` is not traversable. Loading history...
169		<option value="<?php echo absint( $tag->term_id ); ?>">
170		<?php echo esc_html( $tag->name ), ' (', absint( $tag->count ), ' ', __( 'Posts', 'bulk-delete' ), ')'; ?>
171		</option>
172		<?php endforeach; ?>
173		</select>
174		<?php
175		}
176
177		/**
178		* Render Sticky Posts dropdown.
179		*/
180		protected function render_sticky_post_dropdown() {
181		$posts = $this->get_sticky_posts();
182		?>
183		<table class="optiontable">
184		<tr>
185		<td scope="row">
186		<input type="checkbox" class="smbd_sticky_post_options" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" value="All">
187		<label>All</label>
188		</td>
189		</tr>
190		<?php
191		foreach ( $posts as $post ) :
192		$user = get_userdata( $post->post_author );
193		?>
194		<tr>
195		<td scope="row">
196		<input type="checkbox" class="smbd_sticky_post_options" name="smbd_<?php echo esc_attr( $this->field_slug ); ?>[]" value="<?php echo absint( $post->ID ); ?>">
197		<label><?php echo esc_html( $post->post_title . ' Published by ' . $user->display_name . ' on ' . $post->post_date ); ?></label>
198		</td>
199		</tr>
200		<?php endforeach; ?>
201		</table>
202		<?php
203		}
204
205		/**
206		* Get the list of sticky posts.
207		*
208		* @return array List of sticky posts.
209		*/
210		protected function get_sticky_posts() {
211		$posts = get_posts( array( 'post__in' => get_option( 'sticky_posts' ) ) );
212
213		return $posts;
214		}
215
216		/**
217		* Get the list of categories.
218		*
219		* @return array List of categories.
220		*/
221		protected function get_categories() {
222		$enhanced_select_threshold = $this->get_enhanced_select_threshold();
223
224		$categories = get_categories(
225		array(
226		'hide_empty' => false,
227		'number' => $enhanced_select_threshold,
228		)
229		);
230
231		return $categories;
232		}
233
234		/**
235		* Are tags present in this WordPress installation?
236		*
237		* Only one tag is retrieved to check if tags are present for performance reasons.
238		*
239		* @return bool True if tags are present, False otherwise.
240		*/
241		protected function are_tags_present() {
242		$tags = $this->get_tags( 1 );
		0 ignored issues – show Bug introduced 2018-08-13 02:39 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$tags` is correct as `$this->get_tags(1)` targeting `BulkWP\BulkDelete\Core\P...PostsModule::get_tags()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
243
244		return ( count( $tags ) > 0 );
245		}
246
247		/**
248		* Are sticky post present in this WordPress?
249		*
250		* Only one post is retrieved to check if stick post are present for performance reasons.
251		*
252		* @return bool True if posts are present, False otherwise.
253		*/
254		protected function are_sticky_post_present() {
255		$sticky_post_ids = get_option( 'sticky_posts' );
256
257		if ( ! is_array( $sticky_post_ids ) ) {
258		return false;
259		}
260
261		return ( count( $sticky_post_ids ) > 0 );
262		}
263
264		/**
265		* Get the list of tags.
266		*
267		* @param int $max_count The maximum number of tags to be returned (Optional). Default 0.
268		* If 0 then the maximum number of tags specified in `get_enhanced_select_threshold` will be returned.
269		*/
270		protected function get_tags( $max_count = 0 ) {
271		if ( absint( $max_count ) === 0 ) {
272		$max_count = $this->get_enhanced_select_threshold();
		0 ignored issues – show Unused Code introduced 2018-08-11 21:08 UTC by Report Bug Copy Issue Report The assignment to `$max_count` is dead and can be removed. Loading history...
273		}
274		}
275
276		/**
277		* Delete sticky posts.
278		*
279		* @param bool $force_delete Whether to bypass trash and force deletion.
280		*
281		* @return int Number of posts deleted.
282		*/
283		protected function delete_sticky_posts( $force_delete ) {
284		$sticky_post_ids = get_option( 'sticky_posts' );
285
286		if ( ! is_array( $sticky_post_ids ) ) {
287		return 0;
288		}
289
290		return $this->delete_posts_by_id( $sticky_post_ids, $force_delete );
291		}
292
293		/**
294		* Delete posts by ids.
295		*
296		* @param int[] $post_ids List of post ids to delete.
297		* @param bool $force_delete True to force delete posts, False otherwise.
298		*
299		* @return int Number of posts deleted.
300		*/
301	83	protected function delete_posts_by_id( $post_ids, $force_delete ) {
302	83	foreach ( $post_ids as $post_id ) {
303		// `$force_delete` parameter to `wp_delete_post` won't work for custom post types.
304		// See https://core.trac.wordpress.org/ticket/43672
305	81	if ( $force_delete ) {
306	22	wp_delete_post( $post_id, true );
307		} else {
308	81	wp_trash_post( $post_id );
309		}
310		}
311
312	83	return count( $post_ids );
313		}
314		}
315

sudar / bulk-delete

Pull Request — dev/6.0.0 (#382)

PostsModule::get_sticky_posts() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like