Give_Notices::settings_errors() - Code Metrics - Inspection of "Update: ajax related notice" - ravinderk/Give - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — feature/issue/1723 ( c6f4b8...6d8805 )

by Ravinder

created 2018-08-27 05:30 UTC

Give_Notices::settings_errors() C

↳ Parent: Give_Notices::print_js()

Complexity

Conditions	7
Paths	11

Size

Total Lines	45
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	7
eloc	26
nc	11
nop	0
dl	0
loc	45
rs	6.7272
c	0
b	0
f	0

<?php

/**
 * Admin Notices Class.
 *
 * @package     Give
 * @subpackage  Admin/Notices
 * @copyright   Copyright (c) 2016, WordImpress
 * @license     https://opensource.org/licenses/gpl-license GNU Public License
 * @since       1.0
 */

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

/**
 * Give_Notices Class
 *
 * @since 1.0
 */
class Give_Notices {
	/**
	 * List of notices
	 * @var array
	 * @since  1.8
	 * @access private
	 */
	private static $notices = array();


	/**
	 * Flag to check if any notice auto dismissible among all notices
	 *
	 * @since  1.8.9
	 * @access private
	 * @var bool
	 */
	private static $has_auto_dismissible_notice = false;

	/**
	 * Flag to check if any notice has dismiss interval among all notices
	 *
	 * @since  1.8.9
	 * @access private
	 * @var bool
	 */
	private static $has_dismiss_interval_notice = false;

	/**
	 * Get things started.
	 *
	 * @since 1.0
	 */
	public function __construct() {
		add_action( 'admin_notices', array( $this, 'render_notices' ), 999 );
		add_action( 'give_dismiss_notices', array( $this, 'dismiss_notices' ) );
	}

	/**
	 * Register notice.
	 *
	 * @since  1.8.9
	 * @access public
	 *
	 * @param $notice_args
	 *
	 * @return bool
	 */
	public function register_notice( $notice_args ) {
		$notice_args = wp_parse_args(
			$notice_args,
			array(
				'id'                    => '',
				'description'           => '',
				'auto_dismissible'      => false,

				// Value: error/updated
				'type'                  => 'error',

				// Value: null/user/all
				'dismissible_type'      => null,

				// Value: shortly/permanent/null/custom
				'dismiss_interval'      => null,

				// Only set it when custom is defined.
				'dismiss_interval_time' => null,

			)
		);

		// Bailout.
		if ( empty( $notice_args['id'] ) ) {
			return false;
		}

		self::$notices[ $notice_args['id'] ] = $notice_args;

		// Auto set show param if not already set.
		if ( ! isset( self::$notices[ $notice_args['id'] ]['show'] ) ) {
			self::$notices[ $notice_args['id'] ]['show'] = $this->is_notice_dismissed( $notice_args ) ? false : true;
		}

		// Auto set time interval for shortly.
		if ( 'shortly' === self::$notices[ $notice_args['id'] ]['dismiss_interval'] ) {
			self::$notices[ $notice_args['id'] ]['dismiss_interval_time'] = DAY_IN_SECONDS;
		}

		return true;
	}

	/**
	 * Get give style admin notice.
	 *
	 * @since  1.8
	 * @access public
	 *
	 * @param string $message
	 * @param string $type
	 *
	 * @return string
	 */
	public static function notice_html( $message, $type = 'updated' ) {
		ob_start();
		?>
		<div class="<?php echo $type; ?> notice">
			<p><?php echo $message; ?></p>
		</div>
		<?php

		return ob_get_clean();
	}

	/**
	 * Display notice.
	 *
	 * @since 1.8.9
	 *
	 */
	public function render_notices() {
		// Bailout.
		if ( empty( self::$notices ) ) {
			return;
		}

		$output = '';

		foreach ( self::$notices as $notice_id => $notice ) {
			// Check flag set to true to show notice.
			if ( ! $notice['show'] ) {
				continue;
			}

			// Check if notice dismissible or not.
			if ( ! self::$has_auto_dismissible_notice ) {
				self::$has_auto_dismissible_notice = $notice['auto_dismissible'];
			}

			// Check if notice dismissible or not.
			if ( ! self::$has_dismiss_interval_notice ) {
				self::$has_dismiss_interval_notice = $notice['dismiss_interval'];
			}

			$css_id = ( false === strpos( $notice['id'], 'give' ) ? "give-{$notice['id']}" : $notice['id'] );

			$css_class = $notice['type'] . ' give-notice notice is-dismissible';
			$output    .= sprintf(
				'<div id="%1$s" class="%2$s" data-auto-dismissible="%3$s" data-dismissible-type="%4$s" data-dismiss-interval="%5$s" data-notice-id="%6$s" data-security="%7$s" data-dismiss-interval-time="%8$s">' . " \n",
				$css_id,
				$css_class,
				$notice['auto_dismissible'],
				$notice['dismissible_type'],
				$notice['dismiss_interval'],
				$notice['id'],
				wp_create_nonce( "give_edit_{$notice_id}_notice" ),
				$notice['dismiss_interval_time']
			);
			$output    .= "<p>{$notice['description']}</p>";
			$output    .= "</div> \n";
		}

		echo $output;

		$this->print_js();
	}

	/**
	 * Print notice js.
	 *
	 * @since  1.8.9
	 * @access private
	 */
	private function print_js() {
		if ( self::$has_auto_dismissible_notice ) :
			?>
			<script>
				jQuery(document).ready(function () {
					// auto hide setting message in 5 seconds.
					window.setTimeout(
						function () {
							jQuery('.give-notice[data-auto-dismissible="1"]').slideUp();
						},
						5000
					);
				})
			</script>
			<?php
		endif;

		if ( self::$has_dismiss_interval_notice ) :
			?>
			<script>
				jQuery(document).ready(function () {
					var $body = jQuery('body');

					$body.on('click', '.give_dismiss_notice', function (e) {
						var $parent = jQuery(this).parents('.give-notice');
						$parent.find('button.notice-dismiss').trigger('click');

						return false;
					});

					$body.on('click', 'button.notice-dismiss', function (e) {
						var $parent = jQuery(this).parents('.give-notice');
						e.preventDefault();

						var data = {
							'give-action'          : 'dismiss_notices',
							'notice_id'            : $parent.data('notice-id'),
							'dismissible_type'     : $parent.data('dismissible-type'),
							'dismiss_interval'     : $parent.data('dismiss-interval'),
							'dismiss_interval_time': $parent.data('dismiss-interval-time'),
							'_wpnonce'             : $parent.data('security')
						};

						// Bailout.
						if (
							! data.dismiss_interval ||
							! data.dismissible_type
						) {
							return false;
						}

						jQuery.post(
							'<?php echo admin_url(); ?>admin-ajax.php',
							data,
							function (response) {

							})
					})
				});
			</script>
			<?php
		endif;
	}


	/**
	 * Hide notice.
	 *
	 * @since  1.8.9
	 * @access public
	 */
	public function dismiss_notices() {
		$_post     = give_clean( $_POST );
		$notice_id = esc_attr( $_post['notice_id'] );

		// Bailout.
		if (
			empty( $notice_id ) ||
			empty( $_post['dismissible_type'] ) ||
			empty( $_post['dismiss_interval'] ) ||
			! check_ajax_referer( "give_edit_{$notice_id}_notice", '_wpnonce' )
		) {
			wp_send_json_error();
		}

		$notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'] );
		if ( 'user' === $_post['dismissible_type'] ) {
			$current_user = wp_get_current_user();
			$notice_key   = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'], $current_user->ID );
		}

		$notice_dismiss_time = ! empty( $_post['dismiss_interval_time'] ) ? $_post['dismiss_interval_time'] : null;

		// Save option to hide notice.
		Give_Cache::set( $notice_key, true, $notice_dismiss_time, true );

		wp_send_json_success();
	}


	/**
	 * Get notice key.
	 *
	 * @since  1.8.9
	 * @access public
	 *
	 * @param string $notice_id
	 * @param string $dismiss_interval
	 * @param int    $user_id
	 *
	 * @return string
	 */
	public function get_notice_key( $notice_id, $dismiss_interval = null, $user_id = 0 ) {
		$notice_key = "_give_notice_{$notice_id}";

		if( ! empty( $dismiss_interval ) ) {
			$notice_key .= "_{$dismiss_interval}";
		}

		if ( $user_id ) {
			$notice_key .= "_{$user_id}";
		}

		$notice_key = sanitize_key( $notice_key );

		return $notice_key;
	}


	/**
	 * Check if notice dismissed or not
	 *
	 * @since  1.8.9
	 * @access public
	 *
	 * @param array $notice
	 *
	 * @return bool|null
	 */
	public function is_notice_dismissed( $notice ) {
		$notice_key = $this->get_notice_key( $notice['id'], $notice['dismiss_interval'] );

		if ( 'user' === $notice['dismissible_type'] ) {
			$current_user = wp_get_current_user();
			$notice_key   = Give()->notices->get_notice_key( $notice['id'], $notice['dismiss_interval'], $current_user->ID );
		}

		$notice_data = Give_Cache::get( $notice_key, true );

		return ! empty( $notice_data ) && ! is_wp_error( $notice_data );
	}
}

1			<?php
			0 ignored issues – show Coding Style Compatibility introduced 2016-12-08 11:11 UTC by Report Bug Copy Issue Report For compatibility and reusability of your code, PSR1 recommends that a file should introduce either new symbols (like classes, functions, etc.) or have side-effects (like outputting something, or including other files), but not both at the same time. The first symbol is defined on line 22 and the first side effect is on line 14. The PSR-1: Basic Coding Standard recommends that a file should either introduce new symbols, that is classes, functions, constants or similar, or have side effects. Side effects are anything that executes logic, like for example printing output, changing ini settings or writing to a file. The idea behind this recommendation is that merely auto-loading a class should not change the state of an application. It also promotes a cleaner style of programming and makes your code less prone to errors, because the logic is not spread out all over the place. To learn more about the PSR-1, please see the PHP-FIG site on the PSR-1. Loading history...
2			/**
3			* Admin Notices Class.
4			*
5			* @package Give
6			* @subpackage Admin/Notices
7			* @copyright Copyright (c) 2016, WordImpress
8			* @license https://opensource.org/licenses/gpl-license GNU Public License
9			* @since 1.0
10			*/
11
12			// Exit if accessed directly.
13			if ( ! defined( 'ABSPATH' ) ) {
14			exit;
15			}
16
17			/**
18			* Give_Notices Class
19			*
20			* @since 1.0
21			*/
22			class Give_Notices {
23			/**
24			* List of notices
25			* @var array
26			* @since 1.8
27			* @access private
28			*/
29			private static $notices = array();
30
31
32			/**
33			* Flag to check if any notice auto dismissible among all notices
34			*
35			* @since 1.8.9
36			* @access private
37			* @var bool
38			*/
39			private static $has_auto_dismissible_notice = false;
40
41			/**
42			* Flag to check if any notice has dismiss interval among all notices
43			*
44			* @since 1.8.9
45			* @access private
46			* @var bool
47			*/
48			private static $has_dismiss_interval_notice = false;
49
50			/**
51			* Get things started.
52			*
53			* @since 1.0
54			*/
55			public function __construct() {
56			add_action( 'admin_notices', array( $this, 'render_notices' ), 999 );
57			add_action( 'give_dismiss_notices', array( $this, 'dismiss_notices' ) );
58			}
59
60			/**
61			* Register notice.
62			*
63			* @since 1.8.9
64			* @access public
65			*
66			* @param $notice_args
67			*
68			* @return bool
69			*/
70			public function register_notice( $notice_args ) {
71			$notice_args = wp_parse_args(
72			$notice_args,
73			array(
74			'id' => '',
75			'description' => '',
76			'auto_dismissible' => false,
77
78			// Value: error/updated
79			'type' => 'error',
80
81			// Value: null/user/all
82			'dismissible_type' => null,
83
84			// Value: shortly/permanent/null/custom
85			'dismiss_interval' => null,
86
87			// Only set it when custom is defined.
88			'dismiss_interval_time' => null,
89
90			)
91			);
92
93			// Bailout.
94			if ( empty( $notice_args['id'] ) ) {
95			return false;
96			}
97
98			self::$notices[ $notice_args['id'] ] = $notice_args;
99
100			// Auto set show param if not already set.
101			if ( ! isset( self::$notices[ $notice_args['id'] ]['show'] ) ) {
102			self::$notices[ $notice_args['id'] ]['show'] = $this->is_notice_dismissed( $notice_args ) ? false : true;
103			}
104
105			// Auto set time interval for shortly.
106			if ( 'shortly' === self::$notices[ $notice_args['id'] ]['dismiss_interval'] ) {
107			self::$notices[ $notice_args['id'] ]['dismiss_interval_time'] = DAY_IN_SECONDS;
108			}
109
110			return true;
111			}
112
113			/**
114			* Get give style admin notice.
115			*
116			* @since 1.8
117			* @access public
118			*
119			* @param string $message
120			* @param string $type
121			*
122			* @return string
123			*/
124			public static function notice_html( $message, $type = 'updated' ) {
125			ob_start();
126			?>
127			<div class="<?php echo $type; ?> notice">
128			<p><?php echo $message; ?></p>
129			</div>
130			<?php
131
132			return ob_get_clean();
133			}
134
135			/**
136			* Display notice.
137			*
138			* @since 1.8.9
139			*
140			*/
141			public function render_notices() {
142			// Bailout.
143			if ( empty( self::$notices ) ) {
144			return;
145			}
146
147			$output = '';
148
149			foreach ( self::$notices as $notice_id => $notice ) {
150			// Check flag set to true to show notice.
151			if ( ! $notice['show'] ) {
152			continue;
153			}
154
155			// Check if notice dismissible or not.
156			if ( ! self::$has_auto_dismissible_notice ) {
157			self::$has_auto_dismissible_notice = $notice['auto_dismissible'];
158			}
159
160			// Check if notice dismissible or not.
161			if ( ! self::$has_dismiss_interval_notice ) {
162			self::$has_dismiss_interval_notice = $notice['dismiss_interval'];
163			}
164
165			$css_id = ( false === strpos( $notice['id'], 'give' ) ? "give-{$notice['id']}" : $notice['id'] );
166
167			$css_class = $notice['type'] . ' give-notice notice is-dismissible';
168			$output .= sprintf(
169			'<div id="%1$s" class="%2$s" data-auto-dismissible="%3$s" data-dismissible-type="%4$s" data-dismiss-interval="%5$s" data-notice-id="%6$s" data-security="%7$s" data-dismiss-interval-time="%8$s">' . " \n",
170			$css_id,
171			$css_class,
172			$notice['auto_dismissible'],
173			$notice['dismissible_type'],
174			$notice['dismiss_interval'],
175			$notice['id'],
176			wp_create_nonce( "give_edit_{$notice_id}_notice" ),
177			$notice['dismiss_interval_time']
178			);
179			$output .= "<p>{$notice['description']}</p>";
180			$output .= "</div> \n";
181			}
182
183			echo $output;
184
185			$this->print_js();
186			}
187
188			/**
189			* Print notice js.
190			*
191			* @since 1.8.9
192			* @access private
193			*/
194			private function print_js() {
195			if ( self::$has_auto_dismissible_notice ) :
196			?>
197			<script>
198			jQuery(document).ready(function () {
199			// auto hide setting message in 5 seconds.
200			window.setTimeout(
201			function () {
202			jQuery('.give-notice[data-auto-dismissible="1"]').slideUp();
203			},
204			5000
205			);
206			})
207			</script>
208			<?php
209			endif;
210
211			if ( self::$has_dismiss_interval_notice ) :
212			?>
213			<script>
214			jQuery(document).ready(function () {
215			var $body = jQuery('body');
216
217			$body.on('click', '.give_dismiss_notice', function (e) {
218			var $parent = jQuery(this).parents('.give-notice');
219			$parent.find('button.notice-dismiss').trigger('click');
220
221			return false;
222			});
223
224			$body.on('click', 'button.notice-dismiss', function (e) {
225			var $parent = jQuery(this).parents('.give-notice');
226			e.preventDefault();
227
228			var data = {
229			'give-action' : 'dismiss_notices',
230			'notice_id' : $parent.data('notice-id'),
231			'dismissible_type' : $parent.data('dismissible-type'),
232			'dismiss_interval' : $parent.data('dismiss-interval'),
233			'dismiss_interval_time': $parent.data('dismiss-interval-time'),
234			'_wpnonce' : $parent.data('security')
235			};
236
237			// Bailout.
238			if (
239			! data.dismiss_interval \|\|
240			! data.dismissible_type
241			) {
242			return false;
243			}
244
245			jQuery.post(
246			'<?php echo admin_url(); ?>admin-ajax.php',
247			data,
248			function (response) {
249
250			})
251			})
252			});
253			</script>
254			<?php
255			endif;
256			}
257
258
259			/**
260			* Hide notice.
261			*
262			* @since 1.8.9
263			* @access public
264			*/
265			public function dismiss_notices() {
266			$_post = give_clean( $_POST );
267			$notice_id = esc_attr( $_post['notice_id'] );
268
269			// Bailout.
270			if (
271			empty( $notice_id ) \|\|
272			empty( $_post['dismissible_type'] ) \|\|
273			empty( $_post['dismiss_interval'] ) \|\|
274			! check_ajax_referer( "give_edit_{$notice_id}_notice", '_wpnonce' )
275			) {
276			wp_send_json_error();
277			}
278
279			$notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'] );
280			if ( 'user' === $_post['dismissible_type'] ) {
281			$current_user = wp_get_current_user();
282			$notice_key = Give()->notices->get_notice_key( $notice_id, $_post['dismiss_interval'], $current_user->ID );
283			}
284
285			$notice_dismiss_time = ! empty( $_post['dismiss_interval_time'] ) ? $_post['dismiss_interval_time'] : null;
286
287			// Save option to hide notice.
288			Give_Cache::set( $notice_key, true, $notice_dismiss_time, true );
289
290			wp_send_json_success();
291			}
292
293
294			/**
295			* Get notice key.
296			*
297			* @since 1.8.9
298			* @access public
299			*
300			* @param string $notice_id
301			* @param string $dismiss_interval
302			* @param int $user_id
303			*
304			* @return string
305			*/
306			public function get_notice_key( $notice_id, $dismiss_interval = null, $user_id = 0 ) {
307			$notice_key = "_give_notice_{$notice_id}";
308
309			if( ! empty( $dismiss_interval ) ) {
310			$notice_key .= "_{$dismiss_interval}";
311			}
312
313			if ( $user_id ) {
314			$notice_key .= "_{$user_id}";
315			}
316
317			$notice_key = sanitize_key( $notice_key );
318
319			return $notice_key;
320			}
321
322
323			/**
324			* Check if notice dismissed or not
325			*
326			* @since 1.8.9
327			* @access public
328			*
329			* @param array $notice
330			*
331			* @return bool\|null
332			*/
333			public function is_notice_dismissed( $notice ) {
334			$notice_key = $this->get_notice_key( $notice['id'], $notice['dismiss_interval'] );
335
336			if ( 'user' === $notice['dismissible_type'] ) {
337			$current_user = wp_get_current_user();
338			$notice_key = Give()->notices->get_notice_key( $notice['id'], $notice['dismiss_interval'], $current_user->ID );
339			}
340
341			$notice_data = Give_Cache::get( $notice_key, true );
342
343			return ! empty( $notice_data ) && ! is_wp_error( $notice_data );
344			}
345			}

ravinderk / Give

Push — feature/issue/1723 ( c6f4b8...6d8805 )

Give_Notices::settings_errors() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like