WC_Data::read_meta_data() - Code Metrics - Inspection of "leave wp meta alone and handle serialisation" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 9138d8...c7ae2c )

by Mike

created 2016-08-15 16:37 UTC

WC_Data::read_meta_data() D

↳ Parent: WC_Data

Complexity

Conditions	9
Paths	16

Size

Total Lines	45
Code Lines	29

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	9
eloc	29
c	3
b	0
f	0
nc	16
nop	0
dl	0
loc	45
rs	4.909

<?php
if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
* Abstract WC Data Class
*
* Implemented by classes using the same CRUD(s) pattern.
*
* @version  2.6.0
* @package  WooCommerce/Abstracts
* @category Abstract Class
* @author   WooThemes
*/
abstract class WC_Data {

	/**
	 * Core data for this object, name value pairs (name + default value).
	 * @var array
	 */
	protected $_data = array();

	/**
	 * Stores meta in cache for future reads.
	 * A group must be set to to enable caching.
	 * @var string
	 */
	protected $_cache_group = '';

	/**
	 * Meta type. This should match up with
	 * the types avaiable at https://codex.wordpress.org/Function_Reference/add_metadata.
	 * WP defines 'post', 'user', 'comment', and 'term'.
	 */
	protected $_meta_type = 'post';

	/**
	 * This only needs set if you are using a custom metadata type (for example payment tokens.
	 * This should be the name of the field your table uses for associating meta with objects.
	 * For example, in payment_tokenmeta, this would be payment_token_id.
	 * @var string
	 */
	protected $object_id_field_for_meta = '';

	/**
	 * Stores additonal meta data.
	 * @var array
	 */
	protected $_meta_data = array();

	/**
	 * Internal meta keys we don't want exposed for the object.
	 * @var array
	 */
	protected $_internal_meta_keys = array();

	/**
	 * Returns the unique ID for this object.
	 * @return int
	 */
	abstract public function get_id();

	/**
	 * Creates new object in the database.
	 */
	abstract public function create();

	/**
	 * Read object from the database.
	 * @param int ID of the object to load.
	 */
	abstract public function read( $id );

	/**
	 * Updates object data in the database.
	 */
	abstract public function update();

	/**
	 * Updates object data in the database.
	 */
	abstract public function delete();

	/**
	 * Save should create or update based on object existance.
	 */
	abstract public function save();

	/**
	 * Change data to JSON format.
	 * @return string Data in JSON format.
	 */
	public function __toString() {
		return json_encode( $this->get_data() );
	}

	/**
	 * Returns all data for this object.
	 * @return array
	 */
	public function get_data() {
		return array_merge( $this->_data, array( 'meta_data' => $this->get_meta_data() ) );
	}

	/**
	 * Get All Meta Data.
	 * @since 2.6.0
	 * @return array
	 */
	public function get_meta_data() {
		return $this->_meta_data;
	}

	/**
	 * Internal meta keys we don't want exposed as part of meta_data. This is in
	 * addition to all data props with _ prefix.
	 * @since 2.6.0
	 * @return array
	 */
	protected function prefix_key( $key ) {
		return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
	}

	/**
	 * Internal meta keys we don't want exposed as part of meta_data. This is in
	 * addition to all data props with _ prefix.
	 * @since 2.6.0
	 * @return array
	 */
	protected function get_internal_meta_keys() {
		return array_merge( array_map( array( $this, 'prefix_key' ), array_keys( $this->_data ) ), $this->_internal_meta_keys );
	}

	/**
	 * Get Meta Data by Key.
	 * @since 2.6.0
	 * @param  string $key
	 * @param  bool $single return first found meta with key, or all with $key
	 * @return mixed
	 */
	public function get_meta( $key = '', $single = true ) {
		$array_keys = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
		$value    = '';

		if ( ! empty( $array_keys ) ) {
			if ( $single ) {
				$value = $this->_meta_data[ current( $array_keys ) ]->value;
			} else {
				$value = array_intersect_key( $this->_meta_data, array_flip( $array_keys ) );
			}
		}

		return $value;
	}

	/**
	 * Set all meta data from array.
	 * @since 2.6.0
	 * @param array $data Key/Value pairs
	 */
	public function set_meta_data( $data ) {
		if ( ! empty( $data ) && is_array( $data ) ) {
			foreach ( $data as $meta ) {
				$meta = (array) $meta;
				if ( isset( $meta['key'], $meta['value'], $meta['meta_id'] ) ) {
					$this->_meta_data[] = (object) array(
						'key'     => $meta['key'],
						'value'   => $meta['value'],
						'meta_id' => $meta['meta_id'],
					);
				}
			}
		}
	}

	/**
	 * Add meta data.
	 * @since 2.6.0
	 * @param string $key Meta key
	 * @param string $value Meta value
	 * @param bool $unique Should this be a unique key?
	 */
	public function add_meta_data( $key, $value, $unique = false ) {
		if ( $unique ) {
			$array_keys       = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
			$this->_meta_data = array_diff_key( $this->_meta_data, array_fill_keys( $array_keys, '' ) );
		}
		$this->_meta_data[] = (object) array(
			'key'   => $key,
			'value' => $value,
		);
	}

	/**
	 * Update meta data by key or ID, if provided.
	 * @since 2.6.0
	 * @param  string $key
	 * @param  string $value
	 * @param  int $meta_id
	 */
	public function update_meta_data( $key, $value, $meta_id = '' ) {
		$array_key = '';
		if ( $meta_id ) {
			$array_key = array_keys( wp_list_pluck( $this->_meta_data, 'meta_id' ), $meta_id );
		}
		if ( $array_key ) {
			$this->_meta_data[ current( $array_key ) ] = (object) array(
				'key'     => $key,
				'value'   => $value,
				'meta_id' => $meta_id,
			);
		} else {
			$this->add_meta_data( $key, $value, true );
		}
	}

	/**
	 * Delete meta data.
	 * @since 2.6.0
	 * @param array $key Meta key
	 */
	public function delete_meta_data( $key ) {
		$array_keys         = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
		$this->_meta_data   = array_diff_key( $this->_meta_data, array_fill_keys( $array_keys, '' ) );
	}

	/**
	 * Read Meta Data from the database. Ignore any internal properties.
	 * @since 2.6.0
	 */
	protected function read_meta_data() {
		$this->_meta_data = array();
		$cache_loaded     = false;

		if ( ! $this->get_id() ) {
			return;
		}

		if ( ! empty( $this->_cache_group ) ) {
			$cache_key   = WC_Cache_Helper::get_cache_prefix( $this->_cache_group ) . $this->get_id();
			$cached_meta = wp_cache_get( $cache_key, $this->_cache_group );

			if ( false !== $cached_meta ) {
				$this->_meta_data = $cached_meta;
				$cache_loaded = true;
			}
		}

		if ( ! $cache_loaded ) {
			global $wpdb;
			$db_info = $this->_get_db_info();
			$raw_meta_data = $wpdb->get_results( $wpdb->prepare( "
				SELECT " . $db_info['meta_id_field'] . ", meta_key, meta_value
				FROM " . $db_info['table'] . "
				WHERE " . $db_info['object_id_field'] . "=%d AND meta_key NOT LIKE 'wp\_%%' ORDER BY " . $db_info['meta_id_field'] . "
			", $this->get_id() ) );

			if ( $raw_meta_data ) {
				foreach ( $raw_meta_data as $meta ) {
					if ( in_array( $meta->meta_key, $this->get_internal_meta_keys() ) ) {
						continue;
					}
					$this->_meta_data[] = (object) array(
						'key'     => $meta->meta_key,
						'value'   => maybe_unserialize( $meta->meta_value ),
						'meta_id' => $meta->{ $db_info['meta_id_field'] },
					);
				}
			}

			if ( ! empty( $this->_cache_group ) ) {
				wp_cache_set( $cache_key, $this->_meta_data, $this->_cache_group );
			}
		}
	}

	/**
	 * Update Meta Data in the database.
	 * @since 2.6.0
	 */
	protected function save_meta_data() {
		global $wpdb;
		$db_info = $this->_get_db_info();
		$all_meta_ids = array_map( 'absint', $wpdb->get_col( $wpdb->prepare( "
			SELECT " . $db_info['meta_id_field'] . " FROM " . $db_info['table'] . "
			WHERE " . $db_info['object_id_field'] . " = %d", $this->get_id() ) . "
			AND meta_key NOT IN ('" . implode( "','", array_map( 'esc_sql', $this->get_internal_meta_keys() ) ) . "')
			AND meta_key NOT LIKE 'wp\_%%';
		" ) );
		$set_meta_ids = array();

		foreach ( $this->_meta_data as $array_key => $meta ) {
			if ( empty( $meta->meta_id ) ) {
				$new_meta_id    = add_metadata( $this->_meta_type, $this->get_id(), $meta->key, $meta->value, false );
				$set_meta_ids[] = $new_meta_id;
				$this->_meta_data[ $array_key ]->meta_id = $new_meta_id;
			} else {
				update_metadata_by_mid( $this->_meta_type, $meta->meta_id, $meta->value, $meta->key );
				$set_meta_ids[] = absint( $meta->meta_id );
			}
		}

		// Delete no longer set meta data
		$delete_meta_ids = array_diff( $all_meta_ids, $set_meta_ids );
		foreach ( $delete_meta_ids as $meta_id ) {
			delete_metadata_by_mid( $this->_meta_type, $meta_id );
		}

		if ( ! empty( $this->_cache_group ) ) {
			WC_Cache_Helper::incr_cache_prefix( $this->_cache_group );
		}
		$this->read_meta_data();
	}

	/**
	 * Table structure is slightly different between meta types, this function will return what we need to know.
	 * @since 2.6.0
	 * @return array Array elements: table, object_id_field, meta_id_field
	 */
	protected function _get_db_info() {
		global $wpdb;

		$meta_id_field   = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
		$table           = $wpdb->prefix;

		// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
		if ( ! in_array( $this->_meta_type, array( 'post', 'user', 'comment', 'term' ) ) ) {
			$table .= 'woocommerce_';
		}

		$table .= $this->_meta_type . 'meta';
		$object_id_field = $this->_meta_type . '_id';

		// Figure out our field names.
		if ( 'user' === $this->_meta_type ) {
			$meta_id_field   = 'umeta_id';
		}

		if ( ! empty( $this->object_id_field_for_meta ) ) {
			$object_id_field = $this->object_id_field_for_meta;
		}

		return array(
			'table'           => $table,
			'object_id_field' => $object_id_field,
			'meta_id_field'   => $meta_id_field,
		);
	}

}


1			<?php
2			if ( ! defined( 'ABSPATH' ) ) {
3			exit;
4			}
5
6			/**
7			* Abstract WC Data Class
8			*
9			* Implemented by classes using the same CRUD(s) pattern.
10			*
11			* @version 2.6.0
12			* @package WooCommerce/Abstracts
13			* @category Abstract Class
14			* @author WooThemes
15			*/
16			abstract class WC_Data {
17
18			/**
19			* Core data for this object, name value pairs (name + default value).
20			* @var array
21			*/
22			protected $_data = array();
23
24			/**
25			* Stores meta in cache for future reads.
26			* A group must be set to to enable caching.
27			* @var string
28			*/
29			protected $_cache_group = '';
30
31			/**
32			* Meta type. This should match up with
33			* the types avaiable at https://codex.wordpress.org/Function_Reference/add_metadata.
34			* WP defines 'post', 'user', 'comment', and 'term'.
35			*/
36			protected $_meta_type = 'post';
37
38			/**
39			* This only needs set if you are using a custom metadata type (for example payment tokens.
40			* This should be the name of the field your table uses for associating meta with objects.
41			* For example, in payment_tokenmeta, this would be payment_token_id.
42			* @var string
43			*/
44			protected $object_id_field_for_meta = '';
45
46			/**
47			* Stores additonal meta data.
48			* @var array
49			*/
50			protected $_meta_data = array();
51
52			/**
53			* Internal meta keys we don't want exposed for the object.
54			* @var array
55			*/
56			protected $_internal_meta_keys = array();
57
58			/**
59			* Returns the unique ID for this object.
60			* @return int
61			*/
62			abstract public function get_id();
63
64			/**
65			* Creates new object in the database.
66			*/
67			abstract public function create();
68
69			/**
70			* Read object from the database.
71			* @param int ID of the object to load.
72			*/
73			abstract public function read( $id );
74
75			/**
76			* Updates object data in the database.
77			*/
78			abstract public function update();
79
80			/**
81			* Updates object data in the database.
82			*/
83			abstract public function delete();
84
85			/**
86			* Save should create or update based on object existance.
87			*/
88			abstract public function save();
89
90			/**
91			* Change data to JSON format.
92			* @return string Data in JSON format.
93			*/
94			public function __toString() {
95			return json_encode( $this->get_data() );
96			}
97
98			/**
99			* Returns all data for this object.
100			* @return array
101			*/
102			public function get_data() {
103			return array_merge( $this->_data, array( 'meta_data' => $this->get_meta_data() ) );
104			}
105
106			/**
107			* Get All Meta Data.
108			* @since 2.6.0
109			* @return array
110			*/
111			public function get_meta_data() {
112			return $this->_meta_data;
113			}
114
115			/**
116			* Internal meta keys we don't want exposed as part of meta_data. This is in
117			* addition to all data props with _ prefix.
118			* @since 2.6.0
119			* @return array
120			*/
121			protected function prefix_key( $key ) {
122			return '_' === substr( $key, 0, 1 ) ? $key : '_' . $key;
123			}
124
125			/**
126			* Internal meta keys we don't want exposed as part of meta_data. This is in
127			* addition to all data props with _ prefix.
128			* @since 2.6.0
129			* @return array
130			*/
131			protected function get_internal_meta_keys() {
132			return array_merge( array_map( array( $this, 'prefix_key' ), array_keys( $this->_data ) ), $this->_internal_meta_keys );
133			}
134
135			/**
136			* Get Meta Data by Key.
137			* @since 2.6.0
138			* @param string $key
139			* @param bool $single return first found meta with key, or all with $key
140			* @return mixed
141			*/
142			public function get_meta( $key = '', $single = true ) {
143			$array_keys = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
144			$value = '';
145
146			if ( ! empty( $array_keys ) ) {
147			if ( $single ) {
148			$value = $this->_meta_data[ current( $array_keys ) ]->value;
149			} else {
150			$value = array_intersect_key( $this->_meta_data, array_flip( $array_keys ) );
151			}
152			}
153
154			return $value;
155			}
156
157			/**
158			* Set all meta data from array.
159			* @since 2.6.0
160			* @param array $data Key/Value pairs
161			*/
162			public function set_meta_data( $data ) {
163			if ( ! empty( $data ) && is_array( $data ) ) {
164			foreach ( $data as $meta ) {
165			$meta = (array) $meta;
166			if ( isset( $meta['key'], $meta['value'], $meta['meta_id'] ) ) {
167			$this->_meta_data[] = (object) array(
168			'key' => $meta['key'],
169			'value' => $meta['value'],
170			'meta_id' => $meta['meta_id'],
171			);
172			}
173			}
174			}
175			}
176
177			/**
178			* Add meta data.
179			* @since 2.6.0
180			* @param string $key Meta key
181			* @param string $value Meta value
182			* @param bool $unique Should this be a unique key?
183			*/
184			public function add_meta_data( $key, $value, $unique = false ) {
185			if ( $unique ) {
186			$array_keys = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
187			$this->_meta_data = array_diff_key( $this->_meta_data, array_fill_keys( $array_keys, '' ) );
188			}
189			$this->_meta_data[] = (object) array(
190			'key' => $key,
191			'value' => $value,
192			);
193			}
194
195			/**
196			* Update meta data by key or ID, if provided.
197			* @since 2.6.0
198			* @param string $key
199			* @param string $value
200			* @param int $meta_id
201			*/
202			public function update_meta_data( $key, $value, $meta_id = '' ) {
203			$array_key = '';
204			if ( $meta_id ) {
205			$array_key = array_keys( wp_list_pluck( $this->_meta_data, 'meta_id' ), $meta_id );
206			}
207			if ( $array_key ) {
208			$this->_meta_data[ current( $array_key ) ] = (object) array(
209			'key' => $key,
210			'value' => $value,
211			'meta_id' => $meta_id,
212			);
213			} else {
214			$this->add_meta_data( $key, $value, true );
215			}
216			}
217
218			/**
219			* Delete meta data.
220			* @since 2.6.0
221			* @param array $key Meta key
222			*/
223			public function delete_meta_data( $key ) {
224			$array_keys = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
225			$this->_meta_data = array_diff_key( $this->_meta_data, array_fill_keys( $array_keys, '' ) );
226			}
227
228			/**
229			* Read Meta Data from the database. Ignore any internal properties.
230			* @since 2.6.0
231			*/
232			protected function read_meta_data() {
233			$this->_meta_data = array();
234			$cache_loaded = false;
235
236			if ( ! $this->get_id() ) {
237			return;
238			}
239
240			if ( ! empty( $this->_cache_group ) ) {
241			$cache_key = WC_Cache_Helper::get_cache_prefix( $this->_cache_group ) . $this->get_id();
242			$cached_meta = wp_cache_get( $cache_key, $this->_cache_group );
243
244			if ( false !== $cached_meta ) {
245			$this->_meta_data = $cached_meta;
246			$cache_loaded = true;
247			}
248			}
249
250			if ( ! $cache_loaded ) {
251			global $wpdb;
252			$db_info = $this->_get_db_info();
253			$raw_meta_data = $wpdb->get_results( $wpdb->prepare( "
254			SELECT " . $db_info['meta_id_field'] . ", meta_key, meta_value
255			FROM " . $db_info['table'] . "
256			WHERE " . $db_info['object_id_field'] . "=%d AND meta_key NOT LIKE 'wp\_%%' ORDER BY " . $db_info['meta_id_field'] . "
257			", $this->get_id() ) );
258
259			if ( $raw_meta_data ) {
260			foreach ( $raw_meta_data as $meta ) {
261			if ( in_array( $meta->meta_key, $this->get_internal_meta_keys() ) ) {
262			continue;
263			}
264			$this->_meta_data[] = (object) array(
265			'key' => $meta->meta_key,
266			'value' => maybe_unserialize( $meta->meta_value ),
267			'meta_id' => $meta->{ $db_info['meta_id_field'] },
268			);
269			}
270			}
271
272			if ( ! empty( $this->_cache_group ) ) {
273			wp_cache_set( $cache_key, $this->_meta_data, $this->_cache_group );
274			}
275			}
276			}
277
278			/**
279			* Update Meta Data in the database.
280			* @since 2.6.0
281			*/
282			protected function save_meta_data() {
283			global $wpdb;
284			$db_info = $this->_get_db_info();
285			$all_meta_ids = array_map( 'absint', $wpdb->get_col( $wpdb->prepare( "
286			SELECT " . $db_info['meta_id_field'] . " FROM " . $db_info['table'] . "
287			WHERE " . $db_info['object_id_field'] . " = %d", $this->get_id() ) . "
288			AND meta_key NOT IN ('" . implode( "','", array_map( 'esc_sql', $this->get_internal_meta_keys() ) ) . "')
289			AND meta_key NOT LIKE 'wp\_%%';
290			" ) );
291			$set_meta_ids = array();
292
293			foreach ( $this->_meta_data as $array_key => $meta ) {
294			if ( empty( $meta->meta_id ) ) {
295			$new_meta_id = add_metadata( $this->_meta_type, $this->get_id(), $meta->key, $meta->value, false );
296			$set_meta_ids[] = $new_meta_id;
297			$this->_meta_data[ $array_key ]->meta_id = $new_meta_id;
298			} else {
299			update_metadata_by_mid( $this->_meta_type, $meta->meta_id, $meta->value, $meta->key );
300			$set_meta_ids[] = absint( $meta->meta_id );
301			}
302			}
303
304			// Delete no longer set meta data
305			$delete_meta_ids = array_diff( $all_meta_ids, $set_meta_ids );
306			foreach ( $delete_meta_ids as $meta_id ) {
307			delete_metadata_by_mid( $this->_meta_type, $meta_id );
308			}
309
310			if ( ! empty( $this->_cache_group ) ) {
311			WC_Cache_Helper::incr_cache_prefix( $this->_cache_group );
312			}
313			$this->read_meta_data();
314			}
315
316			/**
317			* Table structure is slightly different between meta types, this function will return what we need to know.
318			* @since 2.6.0
319			* @return array Array elements: table, object_id_field, meta_id_field
320			*/
321			protected function _get_db_info() {
322			global $wpdb;
323
324			$meta_id_field = 'meta_id'; // for some reason users calls this umeta_id so we need to track this as well.
325			$table = $wpdb->prefix;
326
327			// If we are dealing with a type of metadata that is not a core type, the table should be prefixed.
328			if ( ! in_array( $this->_meta_type, array( 'post', 'user', 'comment', 'term' ) ) ) {
329			$table .= 'woocommerce_';
330			}
331
332			$table .= $this->_meta_type . 'meta';
333			$object_id_field = $this->_meta_type . '_id';
334
335			// Figure out our field names.
336			if ( 'user' === $this->_meta_type ) {
337			$meta_id_field = 'umeta_id';
338			}
339
340			if ( ! empty( $this->object_id_field_for_meta ) ) {
341			$object_id_field = $this->object_id_field_for_meta;
342			}
343
344			return array(
345			'table' => $table,
346			'object_id_field' => $object_id_field,
347			'meta_id_field' => $meta_id_field,
348			);
349			}
350
351			}
352

woothemes / woocommerce

Push — master ( 9138d8...c7ae2c )

WC_Data::read_meta_data() D

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like