wc-notice-functions.php ➔ wc_add_notice() - Code Metrics - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

wc-notice-functions.php ➔ wc_add_notice() A
last analyzed 2017-04-11 22:39 UTC

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	17
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * WooCommerce Message Functions
 *
 * Functions for error/message handling and display.
 *
 * @author 		WooThemes
 * @category 	Core
 * @package 	WooCommerce/Functions
 * @version     2.1.0
 */

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

/**
 * Get the count of notices added, either for all notices (default) or for one.
 * particular notice type specified by $notice_type.
 *
 * @since 2.1
 * @param string $notice_type The name of the notice type - either error, success or notice. [optional]
 * @return int
 */
function wc_notice_count( $notice_type = '' ) {
	if ( ! did_action( 'woocommerce_init' ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return;
	}

	$notice_count = 0;
	$all_notices  = WC()->session->get( 'wc_notices', array() );

	if ( isset( $all_notices[$notice_type] ) ) {

		$notice_count = absint( sizeof( $all_notices[$notice_type] ) );

	} elseif ( empty( $notice_type ) ) {

		foreach ( $all_notices as $notices ) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
			$notice_count += absint( sizeof( $all_notices ) );
		}

	}

	return $notice_count;
}

/**
 * Check if a notice has already been added.
 *
 * @since 2.1
 * @param string $message The text to display in the notice.
 * @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
 * @return bool
 */
function wc_has_notice( $message, $notice_type = 'success' ) {
	if ( ! did_action( 'woocommerce_init' ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return false;
	}

	$notices = WC()->session->get( 'wc_notices', array() );
	$notices = isset( $notices[ $notice_type ] ) ? $notices[ $notice_type ] : array();
	return array_search( $message, $notices ) !== false;
}

/**
 * Add and store a notice.
 *
 * @since 2.1
 * @param string $message The text to display in the notice.
 * @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
 */
function wc_add_notice( $message, $notice_type = 'success' ) {
	if ( ! did_action( 'woocommerce_init' ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return;
	}

	$notices = WC()->session->get( 'wc_notices', array() );

	// Backward compatibility
	if ( 'success' === $notice_type ) {
		$message = apply_filters( 'woocommerce_add_message', $message );
	}

	$notices[$notice_type][] = apply_filters( 'woocommerce_add_' . $notice_type, $message );

	WC()->session->set( 'wc_notices', $notices );
}

/**
 * Unset all notices.
 *
 * @since 2.1
 */
function wc_clear_notices() {

	if ( ! did_action( 'woocommerce_init' ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return;
	}
	WC()->session->set( 'wc_notices', null );
}

/**
 * Prints messages and errors which are stored in the session, then clears them.
 *
 * @since 2.1
 */
function wc_print_notices() {
	if ( ! did_action( 'woocommerce_init' ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return;
	}

	$all_notices  = WC()->session->get( 'wc_notices', array() );
	$notice_types = apply_filters( 'woocommerce_notice_types', array( 'error', 'success', 'notice' ) );

	foreach ( $notice_types as $notice_type ) {
		if ( wc_notice_count( $notice_type ) > 0 ) {
			wc_get_template( "notices/{$notice_type}.php", array(
				'messages' => array_filter( $all_notices[ $notice_type ] )
			) );
		}
	}

	wc_clear_notices();
}
add_action( 'woocommerce_shortcode_before_product_cat_loop', 'wc_print_notices', 10 );
add_action( 'woocommerce_before_shop_loop', 'wc_print_notices', 10 );
add_action( 'woocommerce_before_single_product', 'wc_print_notices', 10 );

/**
 * Print a single notice immediately.
 *
 * @since 2.1
 * @param string $message The text to display in the notice.
 * @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
 */
function wc_print_notice( $message, $notice_type = 'success' ) {
	if ( 'success' === $notice_type ) {
		$message = apply_filters( 'woocommerce_add_message', $message );
	}

	wc_get_template( "notices/{$notice_type}.php", array(
		'messages' => array( apply_filters( 'woocommerce_add_' . $notice_type, $message ) )
	) );
}

/**
 * Returns all queued notices, optionally filtered by a notice type.
 *
 * @since 2.1
 * @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
 * @return array|mixed
 */
function wc_get_notices( $notice_type = '' ) {
	if ( ! did_action( 'woocommerce_init' ) ) {
		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
		return;
	}

	$all_notices = WC()->session->get( 'wc_notices', array() );

	if ( empty ( $notice_type ) ) {
		$notices = $all_notices;
	} elseif ( isset( $all_notices[$notice_type] ) ) {
		$notices = $all_notices[$notice_type];
	} else {
		$notices = array();
	}

	return $notices;
}

/**
 * Add notices for WP Errors.
 * @param  WP_Error $errors
 */
function wc_add_wp_error_notices( $errors ) {
	if ( is_wp_error( $errors ) && $errors->get_error_messages() ) {
		foreach ( $errors->get_error_messages() as $error ) {
			wc_add_notice( $error, 'error');
		}
	}
}


1		<?php
2		/**
3		* WooCommerce Message Functions
4		*
5		* Functions for error/message handling and display.
6		*
7		* @author WooThemes
8		* @category Core
9		* @package WooCommerce/Functions
10		* @version 2.1.0
11		*/
12
13		if ( ! defined( 'ABSPATH' ) ) {
14		exit; // Exit if accessed directly
15		}
16
17		/**
18		* Get the count of notices added, either for all notices (default) or for one.
19		* particular notice type specified by $notice_type.
20		*
21		* @since 2.1
22		* @param string $notice_type The name of the notice type - either error, success or notice. [optional]
23		* @return int
24		*/
25		function wc_notice_count( $notice_type = '' ) {
26		if ( ! did_action( 'woocommerce_init' ) ) {
27		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
28		return;
29		}
30
31		$notice_count = 0;
32		$all_notices = WC()->session->get( 'wc_notices', array() );
33
34		if ( isset( $all_notices[$notice_type] ) ) {
35
36		$notice_count = absint( sizeof( $all_notices[$notice_type] ) );
37
38		} elseif ( empty( $notice_type ) ) {
39
40		foreach ( $all_notices as $notices ) {
		0 ignored issues – show Bug introduced 2016-06-06 17:28 UTC by Report Bug Copy Issue Report The expression `$all_notices` of type `array\|string` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
41		$notice_count += absint( sizeof( $all_notices ) );
42		}
43
44		}
45
46		return $notice_count;
47		}
48
49		/**
50		* Check if a notice has already been added.
51		*
52		* @since 2.1
53		* @param string $message The text to display in the notice.
54		* @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
55		* @return bool
56		*/
57		function wc_has_notice( $message, $notice_type = 'success' ) {
58		if ( ! did_action( 'woocommerce_init' ) ) {
59		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
60		return false;
61		}
62
63		$notices = WC()->session->get( 'wc_notices', array() );
64		$notices = isset( $notices[ $notice_type ] ) ? $notices[ $notice_type ] : array();
65		return array_search( $message, $notices ) !== false;
66		}
67
68		/**
69		* Add and store a notice.
70		*
71		* @since 2.1
72		* @param string $message The text to display in the notice.
73		* @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
74		*/
75		function wc_add_notice( $message, $notice_type = 'success' ) {
76		if ( ! did_action( 'woocommerce_init' ) ) {
77		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
78		return;
79		}
80
81		$notices = WC()->session->get( 'wc_notices', array() );
82
83		// Backward compatibility
84		if ( 'success' === $notice_type ) {
85		$message = apply_filters( 'woocommerce_add_message', $message );
86		}
87
88		$notices[$notice_type][] = apply_filters( 'woocommerce_add_' . $notice_type, $message );
89
90		WC()->session->set( 'wc_notices', $notices );
91		}
92
93		/**
94		* Unset all notices.
95		*
96		* @since 2.1
97		*/
98	View Code Duplication	function wc_clear_notices() {
		0 ignored issues – show Duplication introduced 2016-01-04 11:07 UTC by Report Bug Copy Issue Report This function 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...
99		if ( ! did_action( 'woocommerce_init' ) ) {
100		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
101		return;
102		}
103		WC()->session->set( 'wc_notices', null );
104		}
105
106		/**
107		* Prints messages and errors which are stored in the session, then clears them.
108		*
109		* @since 2.1
110		*/
111		function wc_print_notices() {
112		if ( ! did_action( 'woocommerce_init' ) ) {
113		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
114		return;
115		}
116
117		$all_notices = WC()->session->get( 'wc_notices', array() );
118		$notice_types = apply_filters( 'woocommerce_notice_types', array( 'error', 'success', 'notice' ) );
119
120		foreach ( $notice_types as $notice_type ) {
121		if ( wc_notice_count( $notice_type ) > 0 ) {
122		wc_get_template( "notices/{$notice_type}.php", array(
123		'messages' => array_filter( $all_notices[ $notice_type ] )
124		) );
125		}
126		}
127
128		wc_clear_notices();
129		}
130		add_action( 'woocommerce_shortcode_before_product_cat_loop', 'wc_print_notices', 10 );
131		add_action( 'woocommerce_before_shop_loop', 'wc_print_notices', 10 );
132		add_action( 'woocommerce_before_single_product', 'wc_print_notices', 10 );
133
134		/**
135		* Print a single notice immediately.
136		*
137		* @since 2.1
138		* @param string $message The text to display in the notice.
139		* @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
140		*/
141		function wc_print_notice( $message, $notice_type = 'success' ) {
142		if ( 'success' === $notice_type ) {
143		$message = apply_filters( 'woocommerce_add_message', $message );
144		}
145
146		wc_get_template( "notices/{$notice_type}.php", array(
147		'messages' => array( apply_filters( 'woocommerce_add_' . $notice_type, $message ) )
148		) );
149		}
150
151		/**
152		* Returns all queued notices, optionally filtered by a notice type.
153		*
154		* @since 2.1
155		* @param string $notice_type The singular name of the notice type - either error, success or notice. [optional]
156		* @return array\|mixed
157		*/
158		function wc_get_notices( $notice_type = '' ) {
159		if ( ! did_action( 'woocommerce_init' ) ) {
160		_doing_it_wrong( __FUNCTION__, __( 'This function should not be called before woocommerce_init.', 'woocommerce' ), '2.3' );
161		return;
162		}
163
164		$all_notices = WC()->session->get( 'wc_notices', array() );
165
166		if ( empty ( $notice_type ) ) {
167		$notices = $all_notices;
168		} elseif ( isset( $all_notices[$notice_type] ) ) {
169		$notices = $all_notices[$notice_type];
170		} else {
171		$notices = array();
172		}
173
174		return $notices;
175		}
176
177		/**
178		* Add notices for WP Errors.
179		* @param WP_Error $errors
180		*/
181		function wc_add_wp_error_notices( $errors ) {
182		if ( is_wp_error( $errors ) && $errors->get_error_messages() ) {
183		foreach ( $errors->get_error_messages() as $error ) {
184		wc_add_notice( $error, 'error');
185		}
186		}
187		}
188

woothemes / woocommerce

wc-notice-functions.php ➔ wc_add_notice() A last analyzed 2017-04-11 22:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

wc-notice-functions.php ➔ wc_add_notice() A
last analyzed 2017-04-11 22:39 UTC