ActionScheduler_wpCommentLogger::get_comment_count() - Code Metrics - Inspection of "maybe scrutinizer will stop complaining so much" - MinnPost/object-sync-for-salesforce - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed

Push — 135-map-multiple-wordpress-obj... ( 3634c2...bb35fb )

by Jonathan

created 2019-03-12 15:25 UTC

ActionScheduler_wpCommentLogger::get_comment_count() B

↳ Parent: Project

Complexity

Conditions	8
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	8
nc	2
nop	0
dl	0
loc	39
rs	8.0515
c	0
b	0
f	0

<?php

/**
 * Class ActionScheduler_wpCommentLogger
 */
class ActionScheduler_wpCommentLogger extends ActionScheduler_Logger {
	const AGENT = 'ActionScheduler';
	const TYPE = 'action_log';

	/**
	 * @param string $action_id
	 * @param string $message
	 * @param DateTime $date
	 *
	 * @return string The log entry ID
	 */
	public function log( $action_id, $message, DateTime $date = NULL ) {

		if ( empty($date) ) {
			$date = as_get_datetime_object();
		} else {
			$date = as_get_datetime_object( clone $date );
		}
		$comment_id = $this->create_wp_comment( $action_id, $message, $date );
		return $comment_id;
	}

	protected function create_wp_comment( $action_id, $message, DateTime $date ) {

		$comment_date_gmt = $date->format('Y-m-d H:i:s');
		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
		$comment_data = array(
			'comment_post_ID' => $action_id,
			'comment_date' => $date->format('Y-m-d H:i:s'),
			'comment_date_gmt' => $comment_date_gmt,
			'comment_author' => self::AGENT,
			'comment_content' => $message,
			'comment_agent' => self::AGENT,
			'comment_type' => self::TYPE,
		);
		return wp_insert_comment($comment_data);
	}

	/**
	 * @param string $entry_id
	 *
	 * @return ActionScheduler_LogEntry
	 */
	public function get_entry( $entry_id ) {
		$comment = $this->get_comment( $entry_id );
		if ( empty($comment) || $comment->comment_type != self::TYPE ) {
			return new ActionScheduler_NullLogEntry();
		}

		$date = as_get_datetime_object( $comment->comment_date_gmt );
		ActionScheduler_TimezoneHelper::set_local_timezone( $date );
		return new ActionScheduler_LogEntry( $comment->comment_post_ID, $comment->comment_content, $date );
	}

	/**
	 * @param string $action_id
	 *
	 * @return ActionScheduler_LogEntry[]
	 */
	public function get_logs( $action_id ) {
		$status = 'all';
		if ( get_post_status($action_id) == 'trash' ) {

			$status = 'post-trashed';
		}
		$comments = get_comments(array(
			'post_id' => $action_id,
			'orderby' => 'comment_date_gmt',
			'order' => 'ASC',
			'type' => self::TYPE,
			'status' => $status,
		));
		$logs = array();
		foreach ( $comments as $c ) {
			$entry = $this->get_entry( $c );
			if ( !empty($entry) ) {

				$logs[] = $entry;
			}
		}
		return $logs;
	}

	protected function get_comment( $comment_id ) {
		return get_comment( $comment_id );
	}



	/**
	 * @param WP_Comment_Query $query
	 */
	public function filter_comment_queries( $query ) {
		foreach ( array('ID', 'parent', 'post_author', 'post_name', 'post_parent', 'type', 'post_type', 'post_id', 'post_ID') as $key ) {

			if ( !empty($query->query_vars[$key]) ) {

				return; // don't slow down queries that wouldn't include action_log comments anyway
			}
		}
		$query->query_vars['action_log_filter'] = TRUE;

		add_filter( 'comments_clauses', array( $this, 'filter_comment_query_clauses' ), 10, 2 );
	}

	/**
	 * @param array $clauses
	 * @param WP_Comment_Query $query
	 *
	 * @return array
	 */
	public function filter_comment_query_clauses( $clauses, $query ) {
		if ( !empty($query->query_vars['action_log_filter']) ) {

			$clauses['where'] .= $this->get_where_clause();
		}
		return $clauses;
	}

	/**
	 * Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not
	 * the WP_Comment_Query class handled by @see self::filter_comment_queries().
	 *
	 * @param string $where
	 * @param WP_Query $query
	 *
	 * @return string
	 */
	public function filter_comment_feed( $where, $query ) {

		if ( is_comment_feed() ) {
			$where .= $this->get_where_clause();
		}
		return $where;
	}

	/**
	 * Return a SQL clause to exclude Action Scheduler comments.
	 *
	 * @return string
	 */
	protected function get_where_clause() {
		global $wpdb;
		return sprintf( " AND {$wpdb->comments}.comment_type != '%s'", self::TYPE );
	}

	/**
	 * Remove action log entries from wp_count_comments()
	 *
	 * @param array $stats
	 * @param int $post_id
	 *
	 * @return object
	 */
	public function filter_comment_count( $stats, $post_id ) {
		global $wpdb;

		if ( 0 === $post_id ) {
			$stats = $this->get_comment_count();
		}

		return $stats;
	}

	/**
	 * Retrieve the comment counts from our cache, or the database if the cached version isn't set.
	 *
	 * @return object
	 */
	protected function get_comment_count() {
		global $wpdb;

		$stats = get_transient( 'as_comment_count' );

		if ( ! $stats ) {
			$stats = array();
$myVar = 'Value';
$higher = false;

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

			$count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} WHERE comment_type NOT IN('order_note','action_log') GROUP BY comment_approved", ARRAY_A );


			$total = 0;
			$stats = array();
			$approved = array( '0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed' );


			foreach ( (array) $count as $row ) {
				// Don't count post-trashed toward totals
				if ( 'post-trashed' != $row['comment_approved'] && 'trash' != $row['comment_approved'] ) {
					$total += $row['num_comments'];
				}
				if ( isset( $approved[ $row['comment_approved'] ] ) ) {
					$stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
				}
			}

			$stats['total_comments'] = $total;
			$stats['all']            = $total;

			foreach ( $approved as $key ) {
				if ( empty( $stats[ $key ] ) ) {
					$stats[ $key ] = 0;
				}
			}

			$stats = (object) $stats;
			set_transient( 'as_comment_count', $stats );
		}

		return $stats;
	}

	/**
	 * Delete comment count cache whenever there is new comment or the status of a comment changes. Cache
	 * will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called.
	 */
	public function delete_comment_count_cache() {
		delete_transient( 'as_comment_count' );
	}

	/**
	 * @codeCoverageIgnore
	 */
	public function init() {
		add_action( 'action_scheduler_before_process_queue', array( $this, 'disable_comment_counting' ), 10, 0 );
		add_action( 'action_scheduler_after_process_queue', array( $this, 'enable_comment_counting' ), 10, 0 );

		parent::init();

		add_action( 'pre_get_comments', array( $this, 'filter_comment_queries' ), 10, 1 );
		add_action( 'wp_count_comments', array( $this, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
		add_action( 'comment_feed_where', array( $this, 'filter_comment_feed' ), 10, 2 );

		// Delete comments count cache whenever there is a new comment or a comment status changes
		add_action( 'wp_insert_comment', array( $this, 'delete_comment_count_cache' ) );
		add_action( 'wp_set_comment_status', array( $this, 'delete_comment_count_cache' ) );
	}

	public function disable_comment_counting() {
		wp_defer_comment_counting(true);
	}
	public function enable_comment_counting() {
		wp_defer_comment_counting(false);
	}

}


1			<?php
2
3			/**
4			* Class ActionScheduler_wpCommentLogger
5			*/
6			class ActionScheduler_wpCommentLogger extends ActionScheduler_Logger {
7			const AGENT = 'ActionScheduler';
8			const TYPE = 'action_log';
9
10			/**
11			* @param string $action_id
12			* @param string $message
13			* @param DateTime $date
14			*
15			* @return string The log entry ID
16			*/
17			public function log( $action_id, $message, DateTime $date = NULL ) {
			0 ignored issues – show Coding Style introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report `TRUE`, `FALSE` and `NULL` must be lowercase; expected `null`, but found `NULL`. Loading history...
18			if ( empty($date) ) {
19			$date = as_get_datetime_object();
20			} else {
21			$date = as_get_datetime_object( clone $date );
22			}
23			$comment_id = $this->create_wp_comment( $action_id, $message, $date );
24			return $comment_id;
25			}
26
27			protected function create_wp_comment( $action_id, $message, DateTime $date ) {
28
29			$comment_date_gmt = $date->format('Y-m-d H:i:s');
30			ActionScheduler_TimezoneHelper::set_local_timezone( $date );
31			$comment_data = array(
32			'comment_post_ID' => $action_id,
33			'comment_date' => $date->format('Y-m-d H:i:s'),
34			'comment_date_gmt' => $comment_date_gmt,
35			'comment_author' => self::AGENT,
36			'comment_content' => $message,
37			'comment_agent' => self::AGENT,
38			'comment_type' => self::TYPE,
39			);
40			return wp_insert_comment($comment_data);
41			}
42
43			/**
44			* @param string $entry_id
45			*
46			* @return ActionScheduler_LogEntry
47			*/
48			public function get_entry( $entry_id ) {
49			$comment = $this->get_comment( $entry_id );
50			if ( empty($comment) \|\| $comment->comment_type != self::TYPE ) {
51			return new ActionScheduler_NullLogEntry();
52			}
53
54			$date = as_get_datetime_object( $comment->comment_date_gmt );
55			ActionScheduler_TimezoneHelper::set_local_timezone( $date );
56			return new ActionScheduler_LogEntry( $comment->comment_post_ID, $comment->comment_content, $date );
57			}
58
59			/**
60			* @param string $action_id
61			*
62			* @return ActionScheduler_LogEntry[]
63			*/
64			public function get_logs( $action_id ) {
65			$status = 'all';
66			if ( get_post_status($action_id) == 'trash' ) {
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Found "== '". Use Yoda Condition checks, you must Loading history...
67			$status = 'post-trashed';
68			}
69			$comments = get_comments(array(
70			'post_id' => $action_id,
71			'orderby' => 'comment_date_gmt',
72			'order' => 'ASC',
73			'type' => self::TYPE,
74			'status' => $status,
75			));
76			$logs = array();
77			foreach ( $comments as $c ) {
78			$entry = $this->get_entry( $c );
79			if ( !empty($entry) ) {
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Expected 1 space after "!"; 0 found Loading history...
80			$logs[] = $entry;
81			}
82			}
83			return $logs;
84			}
85
86			protected function get_comment( $comment_id ) {
87			return get_comment( $comment_id );
88			}
89
90
91
92			/**
93			* @param WP_Comment_Query $query
94			*/
95			public function filter_comment_queries( $query ) {
96			foreach ( array('ID', 'parent', 'post_author', 'post_name', 'post_parent', 'type', 'post_type', 'post_id', 'post_ID') as $key ) {
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report No space after opening parenthesis of array is bad style Loading history... introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report No space before closing parenthesis of array is bad style Loading history...
97			if ( !empty($query->query_vars[$key]) ) {
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Expected 1 space after "!"; 0 found Loading history... introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Array keys should be surrounded by spaces unless they contain a string or an integer. Loading history...
98			return; // don't slow down queries that wouldn't include action_log comments anyway
99			}
100			}
101			$query->query_vars['action_log_filter'] = TRUE;
			0 ignored issues – show Coding Style introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report `TRUE`, `FALSE` and `NULL` must be lowercase; expected `true`, but found `TRUE`. Loading history...
102			add_filter( 'comments_clauses', array( $this, 'filter_comment_query_clauses' ), 10, 2 );
103			}
104
105			/**
106			* @param array $clauses
107			* @param WP_Comment_Query $query
108			*
109			* @return array
110			*/
111			public function filter_comment_query_clauses( $clauses, $query ) {
112			if ( !empty($query->query_vars['action_log_filter']) ) {
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Expected 1 space after "!"; 0 found Loading history...
113			$clauses['where'] .= $this->get_where_clause();
114			}
115			return $clauses;
116			}
117
118			/**
119			* Make sure Action Scheduler logs are excluded from comment feeds, which use WP_Query, not
120			* the WP_Comment_Query class handled by @see self::filter_comment_queries().
121			*
122			* @param string $where
123			* @param WP_Query $query
124			*
125			* @return string
126			*/
127			public function filter_comment_feed( $where, $query ) {
			0 ignored issues – show Unused Code introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report The parameter `$query` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
128			if ( is_comment_feed() ) {
129			$where .= $this->get_where_clause();
130			}
131			return $where;
132			}
133
134			/**
135			* Return a SQL clause to exclude Action Scheduler comments.
136			*
137			* @return string
138			*/
139			protected function get_where_clause() {
140			global $wpdb;
141			return sprintf( " AND {$wpdb->comments}.comment_type != '%s'", self::TYPE );
142			}
143
144			/**
145			* Remove action log entries from wp_count_comments()
146			*
147			* @param array $stats
148			* @param int $post_id
149			*
150			* @return object
151			*/
152			public function filter_comment_count( $stats, $post_id ) {
153			global $wpdb;
154
155			if ( 0 === $post_id ) {
156			$stats = $this->get_comment_count();
157			}
158
159			return $stats;
160			}
161
162			/**
163			* Retrieve the comment counts from our cache, or the database if the cached version isn't set.
164			*
165			* @return object
166			*/
167			protected function get_comment_count() {
168			global $wpdb;
169
170			$stats = get_transient( 'as_comment_count' );
171
172			if ( ! $stats ) {
173			$stats = array();
			0 ignored issues – show Unused Code introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report `$stats` 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...
174
175			$count = $wpdb->get_results( "SELECT comment_approved, COUNT( * ) AS num_comments FROM {$wpdb->comments} WHERE comment_type NOT IN('order_note','action_log') GROUP BY comment_approved", ARRAY_A );
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Usage of a direct database call is discouraged. Loading history... introduced 2019-03-12 15:37 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...
176
177			$total = 0;
178			$stats = array();
179			$approved = array( '0' => 'moderated', '1' => 'approved', 'spam' => 'spam', 'trash' => 'trash', 'post-trashed' => 'post-trashed' );
			0 ignored issues – show introduced 2019-03-12 15:37 UTC by Report Bug Copy Issue Report Detected usage of 0, possible slow query. Loading history...
180
181			foreach ( (array) $count as $row ) {
182			// Don't count post-trashed toward totals
183			if ( 'post-trashed' != $row['comment_approved'] && 'trash' != $row['comment_approved'] ) {
184			$total += $row['num_comments'];
185			}
186			if ( isset( $approved[ $row['comment_approved'] ] ) ) {
187			$stats[ $approved[ $row['comment_approved'] ] ] = $row['num_comments'];
188			}
189			}
190
191			$stats['total_comments'] = $total;
192			$stats['all'] = $total;
193
194			foreach ( $approved as $key ) {
195			if ( empty( $stats[ $key ] ) ) {
196			$stats[ $key ] = 0;
197			}
198			}
199
200			$stats = (object) $stats;
201			set_transient( 'as_comment_count', $stats );
202			}
203
204			return $stats;
205			}
206
207			/**
208			* Delete comment count cache whenever there is new comment or the status of a comment changes. Cache
209			* will be regenerated next time ActionScheduler_wpCommentLogger::filter_comment_count() is called.
210			*/
211			public function delete_comment_count_cache() {
212			delete_transient( 'as_comment_count' );
213			}
214
215			/**
216			* @codeCoverageIgnore
217			*/
218			public function init() {
219			add_action( 'action_scheduler_before_process_queue', array( $this, 'disable_comment_counting' ), 10, 0 );
220			add_action( 'action_scheduler_after_process_queue', array( $this, 'enable_comment_counting' ), 10, 0 );
221
222			parent::init();
223
224			add_action( 'pre_get_comments', array( $this, 'filter_comment_queries' ), 10, 1 );
225			add_action( 'wp_count_comments', array( $this, 'filter_comment_count' ), 20, 2 ); // run after WC_Comments::wp_count_comments() to make sure we exclude order notes and action logs
226			add_action( 'comment_feed_where', array( $this, 'filter_comment_feed' ), 10, 2 );
227
228			// Delete comments count cache whenever there is a new comment or a comment status changes
229			add_action( 'wp_insert_comment', array( $this, 'delete_comment_count_cache' ) );
230			add_action( 'wp_set_comment_status', array( $this, 'delete_comment_count_cache' ) );
231			}
232
233			public function disable_comment_counting() {
234			wp_defer_comment_counting(true);
235			}
236			public function enable_comment_counting() {
237			wp_defer_comment_counting(false);
238			}
239
240			}
241

MinnPost / object-sync-for-salesforce

Push — 135-map-multiple-wordpress-obj... ( 3634c2...bb35fb )

ActionScheduler_wpCommentLogger::get_comment_count() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like