WC_Post_Data::update_post_metadata() - Code Metrics - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

WC_Post_Data::update_post_metadata() A
last analyzed 2017-04-11 22:39 UTC

↳ Parent: WC_Post_Data

Complexity

Conditions	4
Paths	2

Size

Total Lines	14
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
dl	0
loc	14
rs	9.2
c	0
b	0
f	0
eloc	6
nc	2
nop	5

<?php

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

/**
 * Post Data.
 *
 * Standardises certain post data on save.
 *
 * @class 		WC_Post_Data
 * @version		2.2.0
 * @package		WooCommerce/Classes/Data
 * @category	Class
 * @author 		WooThemes
 */
class WC_Post_Data {

	/**
	 * Editing term.
	 *
	 * @var object
	 */
	private static $editing_term = null;

	/**
	 * Hook in methods.
	 */
	public static function init() {
		add_action( 'set_object_terms', array( __CLASS__, 'set_object_terms' ), 10, 6 );

		add_action( 'transition_post_status', array( __CLASS__, 'transition_post_status' ), 10, 3 );
		add_action( 'woocommerce_product_set_stock_status', array( __CLASS__, 'delete_product_query_transients' ) );
		add_action( 'woocommerce_product_set_visibility', array( __CLASS__, 'delete_product_query_transients' ) );

		add_action( 'edit_term', array( __CLASS__, 'edit_term' ), 10, 3 );
		add_action( 'edited_term', array( __CLASS__, 'edited_term' ), 10, 3 );
		add_filter( 'update_order_item_metadata', array( __CLASS__, 'update_order_item_metadata' ), 10, 5 );
		add_filter( 'update_post_metadata', array( __CLASS__, 'update_post_metadata' ), 10, 5 );
		add_filter( 'wp_insert_post_data', array( __CLASS__, 'wp_insert_post_data' ) );
		add_action( 'pre_post_update', array( __CLASS__, 'pre_post_update' ) );
		add_action( 'update_post_meta', array( __CLASS__, 'sync_product_stock_status' ), 10, 4 );
	}

	/**
	 * Delete transients when terms are set.
	 */
	public static function set_object_terms( $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids ) {
		foreach ( array_merge( $tt_ids, $old_tt_ids ) as $id ) {
			delete_transient( 'wc_ln_count_' . md5( sanitize_key( $taxonomy ) . sanitize_key( $id ) ) );
		}
	}

	/**
	 * When a post status changes.
	 */
	public static function transition_post_status( $new_status, $old_status, $post ) {
		if ( ( 'publish' === $new_status || 'publish' === $old_status ) && in_array( $post->post_type, array( 'product', 'product_variation' ) ) ) {
			self::delete_product_query_transients();
		}
	}

	/**
	 * Delete product view transients when needed e.g. when post status changes, or visibility/stock status is modified.
	 */
	public static function delete_product_query_transients() {
		// Increments the transient version to invalidate cache
		WC_Cache_Helper::get_transient_version( 'product_query', true );

		// If not using an external caching system, we can clear the transients out manually and avoid filling our DB
		if ( ! wp_using_ext_object_cache() ) {
			global $wpdb;

			$wpdb->query( "
				DELETE FROM `$wpdb->options`
				WHERE `option_name` LIKE ('\_transient\_wc\_uf\_pid\_%')
				OR `option_name` LIKE ('\_transient\_timeout\_wc\_uf\_pid\_%')
				OR `option_name` LIKE ('\_transient\_wc\_products\_will\_display\_%')
				OR `option_name` LIKE ('\_transient\_timeout\_wc\_products\_will\_display\_%')
			" );
		}
	}

	/**
	 * When editing a term, check for product attributes.
	 * @param  id $term_id
	 * @param  id $tt_id
	 * @param  string $taxonomy
	 */
	public static function edit_term( $term_id, $tt_id, $taxonomy ) {
		if ( strpos( $taxonomy, 'pa_' ) === 0 ) {
			self::$editing_term = get_term_by( 'id', $term_id, $taxonomy );
		} else {
			self::$editing_term = null;
		}
	}

	/**
	 * When a term is edited, check for product attributes and update variations.
	 * @param  id $term_id
	 * @param  id $tt_id
	 * @param  string $taxonomy
	 */
	public static function edited_term( $term_id, $tt_id, $taxonomy ) {
		if ( ! is_null( self::$editing_term ) && strpos( $taxonomy, 'pa_' ) === 0 ) {
			$edited_term = get_term_by( 'id', $term_id, $taxonomy );

			if ( $edited_term->slug !== self::$editing_term->slug ) {
				global $wpdb;

				$wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->postmeta} SET meta_value = %s WHERE meta_key = %s AND meta_value = %s;", $edited_term->slug, 'attribute_' . sanitize_title( $taxonomy ), self::$editing_term->slug ) );
			}
		} else {
			self::$editing_term = null;
		}
	}

	/**
	 * Ensure floats are correctly converted to strings based on PHP locale.
	 *
	 * @param  null $check
	 * @param  int $object_id
	 * @param  string $meta_key
	 * @param  mixed $meta_value
	 * @param  mixed $prev_value
	 * @return null|bool
	 */
	public static function update_order_item_metadata( $check, $object_id, $meta_key, $meta_value, $prev_value ) {
		if ( ! empty( $meta_value ) && is_float( $meta_value ) ) {

			// Convert float to string
			$meta_value = wc_float_to_string( $meta_value );

			// Update meta value with new string
			update_metadata( 'order_item', $object_id, $meta_key, $meta_value, $prev_value );

			// Return
			return true;
		}
		return $check;
	}

	/**
	 * Ensure floats are correctly converted to strings based on PHP locale.
	 *
	 * @param  null $check
	 * @param  int $object_id
	 * @param  string $meta_key
	 * @param  mixed $meta_value
	 * @param  mixed $prev_value
	 * @return null|bool
	 */
	public static function update_post_metadata( $check, $object_id, $meta_key, $meta_value, $prev_value ) {
		if ( ! empty( $meta_value ) && is_float( $meta_value ) && in_array( get_post_type( $object_id ), array_merge( wc_get_order_types(), array( 'shop_coupon', 'product', 'product_variation' ) ) ) ) {

			// Convert float to string
			$meta_value = wc_float_to_string( $meta_value );

			// Update meta value with new string
			update_metadata( 'post', $object_id, $meta_key, $meta_value, $prev_value );

			// Return
			return true;
		}
		return $check;
	}

	/**
	 * When setting stock level, ensure the stock status is kept in sync.
	 * @param  int $meta_id
	 * @param  int $object_id
	 * @param  string $meta_key
	 * @param  mixed $_meta_value
	 */
	public static function sync_product_stock_status( $meta_id, $object_id, $meta_key, $_meta_value ) {

		if ( '_stock' === $meta_key && 'product' !== get_post_type( $object_id ) ) {
			$product = wc_get_product( $object_id );
			$product->check_stock_status();
		}
	}

	/**
	 * Forces the order posts to have a title in a certain format (containing the date).
	 * Forces certain product data based on the product's type, e.g. grouped products cannot have a parent.
	 *
	 * @param array $data
	 * @return array
	 */
	public static function wp_insert_post_data( $data ) {
		if ( 'shop_order' === $data['post_type'] && isset( $data['post_date'] ) ) {
			$order_title = 'Order';
			if ( $data['post_date'] ) {
				$order_title.= ' &ndash; ' . date_i18n( 'F j, Y @ h:i A', strtotime( $data['post_date'] ) );
			}
			$data['post_title'] = $order_title;
		}

		elseif ( 'product' === $data['post_type'] && isset( $_POST['product-type'] ) ) {
			$product_type = stripslashes( $_POST['product-type'] );
			switch ( $product_type ) {
				case 'grouped' :
				case 'variable' :
					$data['post_parent'] = 0;
				break;
			}
		}

		return $data;
	}

	/**
	 * Some functions, like the term recount, require the visibility to be set prior. Lets save that here.
	 *
	 * @param int $post_id
	 */
	public static function pre_post_update( $post_id ) {
		$product_type = empty( $_POST['product-type'] ) ? 'simple' : sanitize_title( stripslashes( $_POST['product-type'] ) );

		if ( isset( $_POST['_visibility'] ) ) {

			if ( update_post_meta( $post_id, '_visibility', wc_clean( $_POST['_visibility'] ) ) ) {
				do_action( 'woocommerce_product_set_visibility', $post_id, wc_clean( $_POST['_visibility'] ) );
			}
		}
		if ( isset( $_POST['_stock_status'] ) && 'variable' !== $product_type ) {
			wc_update_product_stock_status( $post_id, wc_clean( $_POST['_stock_status'] ) );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
		}
	}
}

WC_Post_Data::init();


1		<?php
2
3		if ( ! defined( 'ABSPATH' ) ) {
4		exit; // Exit if accessed directly
5		}
6
7		/**
8		* Post Data.
9		*
10		* Standardises certain post data on save.
11		*
12		* @class WC_Post_Data
13		* @version 2.2.0
14		* @package WooCommerce/Classes/Data
15		* @category Class
16		* @author WooThemes
17		*/
18		class WC_Post_Data {
19
20		/**
21		* Editing term.
22		*
23		* @var object
24		*/
25		private static $editing_term = null;
26
27		/**
28		* Hook in methods.
29		*/
30		public static function init() {
31		add_action( 'set_object_terms', array( __CLASS__, 'set_object_terms' ), 10, 6 );
32
33		add_action( 'transition_post_status', array( __CLASS__, 'transition_post_status' ), 10, 3 );
34		add_action( 'woocommerce_product_set_stock_status', array( __CLASS__, 'delete_product_query_transients' ) );
35		add_action( 'woocommerce_product_set_visibility', array( __CLASS__, 'delete_product_query_transients' ) );
36
37		add_action( 'edit_term', array( __CLASS__, 'edit_term' ), 10, 3 );
38		add_action( 'edited_term', array( __CLASS__, 'edited_term' ), 10, 3 );
39		add_filter( 'update_order_item_metadata', array( __CLASS__, 'update_order_item_metadata' ), 10, 5 );
40		add_filter( 'update_post_metadata', array( __CLASS__, 'update_post_metadata' ), 10, 5 );
41		add_filter( 'wp_insert_post_data', array( __CLASS__, 'wp_insert_post_data' ) );
42		add_action( 'pre_post_update', array( __CLASS__, 'pre_post_update' ) );
43		add_action( 'update_post_meta', array( __CLASS__, 'sync_product_stock_status' ), 10, 4 );
44		}
45
46		/**
47		* Delete transients when terms are set.
48		*/
49		public static function set_object_terms( $object_id, $terms, $tt_ids, $taxonomy, $append, $old_tt_ids ) {
50		foreach ( array_merge( $tt_ids, $old_tt_ids ) as $id ) {
51		delete_transient( 'wc_ln_count_' . md5( sanitize_key( $taxonomy ) . sanitize_key( $id ) ) );
52		}
53		}
54
55		/**
56		* When a post status changes.
57		*/
58		public static function transition_post_status( $new_status, $old_status, $post ) {
59		if ( ( 'publish' === $new_status \|\| 'publish' === $old_status ) && in_array( $post->post_type, array( 'product', 'product_variation' ) ) ) {
60		self::delete_product_query_transients();
61		}
62		}
63
64		/**
65		* Delete product view transients when needed e.g. when post status changes, or visibility/stock status is modified.
66		*/
67		public static function delete_product_query_transients() {
68		// Increments the transient version to invalidate cache
69		WC_Cache_Helper::get_transient_version( 'product_query', true );
70
71		// If not using an external caching system, we can clear the transients out manually and avoid filling our DB
72		if ( ! wp_using_ext_object_cache() ) {
73		global $wpdb;
74
75		$wpdb->query( "
76		DELETE FROM `$wpdb->options`
77		WHERE `option_name` LIKE ('\_transient\_wc\_uf\_pid\_%')
78		OR `option_name` LIKE ('\_transient\_timeout\_wc\_uf\_pid\_%')
79		OR `option_name` LIKE ('\_transient\_wc\_products\_will\_display\_%')
80		OR `option_name` LIKE ('\_transient\_timeout\_wc\_products\_will\_display\_%')
81		" );
82		}
83		}
84
85		/**
86		* When editing a term, check for product attributes.
87		* @param id $term_id
88		* @param id $tt_id
89		* @param string $taxonomy
90		*/
91		public static function edit_term( $term_id, $tt_id, $taxonomy ) {
92		if ( strpos( $taxonomy, 'pa_' ) === 0 ) {
93		self::$editing_term = get_term_by( 'id', $term_id, $taxonomy );
94		} else {
95		self::$editing_term = null;
96		}
97		}
98
99		/**
100		* When a term is edited, check for product attributes and update variations.
101		* @param id $term_id
102		* @param id $tt_id
103		* @param string $taxonomy
104		*/
105		public static function edited_term( $term_id, $tt_id, $taxonomy ) {
106		if ( ! is_null( self::$editing_term ) && strpos( $taxonomy, 'pa_' ) === 0 ) {
107		$edited_term = get_term_by( 'id', $term_id, $taxonomy );
108
109		if ( $edited_term->slug !== self::$editing_term->slug ) {
110		global $wpdb;
111
112		$wpdb->query( $wpdb->prepare( "UPDATE {$wpdb->postmeta} SET meta_value = %s WHERE meta_key = %s AND meta_value = %s;", $edited_term->slug, 'attribute_' . sanitize_title( $taxonomy ), self::$editing_term->slug ) );
113		}
114		} else {
115		self::$editing_term = null;
116		}
117		}
118
119		/**
120		* Ensure floats are correctly converted to strings based on PHP locale.
121		*
122		* @param null $check
123		* @param int $object_id
124		* @param string $meta_key
125		* @param mixed $meta_value
126		* @param mixed $prev_value
127		* @return null\|bool
128		*/
129		public static function update_order_item_metadata( $check, $object_id, $meta_key, $meta_value, $prev_value ) {
130		if ( ! empty( $meta_value ) && is_float( $meta_value ) ) {
131
132		// Convert float to string
133		$meta_value = wc_float_to_string( $meta_value );
134
135		// Update meta value with new string
136		update_metadata( 'order_item', $object_id, $meta_key, $meta_value, $prev_value );
137
138		// Return
139		return true;
140		}
141		return $check;
142		}
143
144		/**
145		* Ensure floats are correctly converted to strings based on PHP locale.
146		*
147		* @param null $check
148		* @param int $object_id
149		* @param string $meta_key
150		* @param mixed $meta_value
151		* @param mixed $prev_value
152		* @return null\|bool
153		*/
154		public static function update_post_metadata( $check, $object_id, $meta_key, $meta_value, $prev_value ) {
155		if ( ! empty( $meta_value ) && is_float( $meta_value ) && in_array( get_post_type( $object_id ), array_merge( wc_get_order_types(), array( 'shop_coupon', 'product', 'product_variation' ) ) ) ) {
156
157		// Convert float to string
158		$meta_value = wc_float_to_string( $meta_value );
159
160		// Update meta value with new string
161		update_metadata( 'post', $object_id, $meta_key, $meta_value, $prev_value );
162
163		// Return
164		return true;
165		}
166		return $check;
167		}
168
169		/**
170		* When setting stock level, ensure the stock status is kept in sync.
171		* @param int $meta_id
172		* @param int $object_id
173		* @param string $meta_key
174		* @param mixed $_meta_value
175		*/
176		public static function sync_product_stock_status( $meta_id, $object_id, $meta_key, $_meta_value ) {
		0 ignored issues – show Unused Code introduced 2015-11-21 02:57 UTC by Report Bug Copy Issue Report The parameter `$_meta_value` 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...
177		if ( '_stock' === $meta_key && 'product' !== get_post_type( $object_id ) ) {
178		$product = wc_get_product( $object_id );
179		$product->check_stock_status();
180		}
181		}
182
183		/**
184		* Forces the order posts to have a title in a certain format (containing the date).
185		* Forces certain product data based on the product's type, e.g. grouped products cannot have a parent.
186		*
187		* @param array $data
188		* @return array
189		*/
190		public static function wp_insert_post_data( $data ) {
191		if ( 'shop_order' === $data['post_type'] && isset( $data['post_date'] ) ) {
192		$order_title = 'Order';
193		if ( $data['post_date'] ) {
194		$order_title.= ' – ' . date_i18n( 'F j, Y @ h:i A', strtotime( $data['post_date'] ) );
195		}
196		$data['post_title'] = $order_title;
197		}
198
199		elseif ( 'product' === $data['post_type'] && isset( $_POST['product-type'] ) ) {
200		$product_type = stripslashes( $_POST['product-type'] );
201		switch ( $product_type ) {
202		case 'grouped' :
203		case 'variable' :
204		$data['post_parent'] = 0;
205		break;
206		}
207		}
208
209		return $data;
210		}
211
212		/**
213		* Some functions, like the term recount, require the visibility to be set prior. Lets save that here.
214		*
215		* @param int $post_id
216		*/
217		public static function pre_post_update( $post_id ) {
218		$product_type = empty( $_POST['product-type'] ) ? 'simple' : sanitize_title( stripslashes( $_POST['product-type'] ) );
219
220	View Code Duplication	if ( isset( $_POST['_visibility'] ) ) {
		0 ignored issues – show Duplication introduced 2015-11-21 02:58 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...
221		if ( update_post_meta( $post_id, '_visibility', wc_clean( $_POST['_visibility'] ) ) ) {
222		do_action( 'woocommerce_product_set_visibility', $post_id, wc_clean( $_POST['_visibility'] ) );
223		}
224		}
225		if ( isset( $_POST['_stock_status'] ) && 'variable' !== $product_type ) {
226		wc_update_product_stock_status( $post_id, wc_clean( $_POST['_stock_status'] ) );
		0 ignored issues – show Documentation introduced 2015-11-21 02:57 UTC by Report Bug Copy Issue Report `wc_clean($_POST['_stock_status'])` is of type `string\|array`, but the function expects a `integer`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
227		}
228		}
229		}
230
231		WC_Post_Data::init();
232

woothemes / woocommerce

WC_Post_Data::update_post_metadata() A last analyzed 2017-04-11 22:39 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

WC_Post_Data::update_post_metadata() A
last analyzed 2017-04-11 22:39 UTC