WC_Order_Item::save_meta_data() - Code Metrics - Inspection of "Order CRUD - data manipulation and abstraction" - woothemes/woocommerce - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#10259)

by Mike

created 2016-03-04 11:56 UTC

WC_Order_Item::save_meta_data() B

↳ Parent: WC_Order_Item

Complexity

Conditions	4
Paths	6

Size

Total Lines	24
Code Lines	15

Duplication

Lines	24
Ratio	100 %

Importance

Changes	4
Bugs	0	Features	0

Metric	Value
c	4
b	0
f	0
dl	24
loc	24
rs	8.6845
cc	4
eloc	15
nc	6
nop	0

<?php

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Order Item
 *
 * A class which represents an item within an order and handles CRUD.
 * Uses ArrayAccess to be BW compatible with WC_Orders::get_items().
 *
 * @version     2.6.0
 * @since       2.6.0
 * @package     WooCommerce/Classes
 * @author      WooThemes
 */
class WC_Order_Item implements ArrayAccess, WC_Data {

	/**
	 * Data array, with defaults.
	 * @since 2.6.0
	 * @var array
	 */
	protected $_data = array(
		'order_id'      => 0,
		'order_item_id' => 0,
		'name'          => '',
		'type'          => '',
	);

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

	/**
	 * Constructor.
	 * @param int|object|array $order_item ID to load from the DB (optional) or already queried data.
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 */
	public function __construct( $item = 0 ) {
		if ( $item instanceof WC_Order_Item ) {
			if ( $this->is_type( $item->get_type() ) ) {
				$this->set_all( $item->get_data() );
			}
		} elseif ( is_array( $item ) ) {
			$this->set_all( $item );
		} else {
			$this->read( $item );
		}
	}

	/**
	 * Set all data based on input array.
	 * @param array $data
	 * @access private
	 */
	public function set_all( $data ) {
		foreach ( $data as $key => $value ) {
			if ( is_callable( array( $this, "set_$key" ) ) ) {
				$this->{"set_$key"}( $value );
			} elseif ( 'meta_data' !== $key ) {
				$this->_data[ $key ] = $value;
			} else {
				foreach ( $value as $meta_id => $meta ) {
					$this->_meta_data[ $meta_id ] = $meta;
				}
			}
		}
	}

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

	/**
	 * Type checking
	 * @param  string|array  $Type
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 * @return boolean
	 */
	public function is_type( $type ) {
		return is_array( $type ) ? in_array( $this->get_type(), $type ) : $type === $this->get_type();
	}

	/**
	 * Get qty.
	 * @return int
	 */
	public function get_qty() {
		return 1;
	}

	/*
	|--------------------------------------------------------------------------
	| Getters
	|--------------------------------------------------------------------------
	*/

	/**
	 * Get all class data in array format.
	 * @since 2.6.0
	 * @return array
	 */
	public function get_data() {
		return array_merge( $this->_data, array( 'meta_data' => $this->get_meta_data() ) );
	}

	/**
	 * Get order item ID.
	 * @return int
	 */
	public function get_id() {
		return $this->get_order_item_id();
	}

	/**
	 * Get order ID this meta belongs to.
	 * @return int
	 */
	public function get_order_id() {
		return absint( $this->_data['order_id'] );
	}

	/**
	 * Get order item ID this meta belongs to.
	 * @return int
	 */
	public function get_order_item_id() {
		return absint( $this->_data['order_item_id'] );
	}

	/**
	 * Get order item name.
	 * @return string
	 */
	public function get_name() {
		return $this->_data['name'];
	}

	/**
	 * Get order item type.
	 * @return string
	 */
	public function get_type() {
		return $this->_data['type'];
	}

	/*
	|--------------------------------------------------------------------------
	| Setters
	|--------------------------------------------------------------------------
	*/

	/**
	 * Set ID
	 * @param int $value
	 */
	public function set_id( $value ) {
		$this->set_order_item_id( $value );
	}

	/**
	 * Set order ID.
	 * @param int $value
	 */
	public function set_order_id( $value ) {
		$this->_data['order_id'] = absint( $value );
	}

	/**
	 * Set order item ID.
	 * @param int $value
	 */
	public function set_order_item_id( $value ) {
		$this->_data['order_item_id'] = absint( $value );
	}

	/**
	 * Set order item name.
	 * @param string $value
	 */
	public function set_name( $value ) {
		$this->_data['name'] = wc_clean( $value );
	}

	/**
	 * Set order item type.
	 * @param string $value
	 */
	public function set_type( $value ) {
		$this->_data['type'] = wc_clean( $value );

	}

	/*
	|--------------------------------------------------------------------------
	| CRUD methods
	|--------------------------------------------------------------------------
	|
	| Methods which create, read, update and delete data from the database.
	|
	*/

	/**
	 * Insert data into the database.
	 * @since 2.6.0
	 */
	public function create() {

		global $wpdb;

		$wpdb->insert( $wpdb->prefix . 'woocommerce_order_items', array(
			'order_item_name' => $this->get_name(),
			'order_item_type' => $this->get_type(),
			'order_id'        => $this->get_order_id()
		) );
		$this->set_id( $wpdb->insert_id );

		do_action( 'woocommerce_new_order_item', $this->get_id(), $this, $this->get_order_id() );
	}

	/**
	 * Update data in the database.
	 * @since 2.6.0
	 */
	public function update() {

		global $wpdb;

		$wpdb->update( $wpdb->prefix . 'woocommerce_order_items', array(
			'order_item_name' => $this->get_name(),
			'order_item_type' => $this->get_type(),
			'order_id'        => $this->get_order_id()
		), array( 'order_item_id' => $this->get_id() ) );

		do_action( 'woocommerce_update_order_item', $this->get_id(), $this, $this->get_order_id() );
	}

	/**
	 * Read from the database.
	 * @since 2.6.0
	 * @param int|object $item ID of object to read, or already queried object.
	 */
	public function read( $item ) {
		global $wpdb;

		if ( is_numeric( $item ) && ! empty( $item ) ) {
			$data = $wpdb->get_row( $wpdb->prepare( "SELECT * FROM {$wpdb->prefix}woocommerce_order_items WHERE order_item_id = %d LIMIT 1;", $item ) );
		} elseif ( ! empty( $item->order_item_id ) ) {
			$data = $item;
		} else {
			$data = false;
		}

		if ( $data ) {
			$this->set_order_id( $data->order_id );
			$this->set_id( $data->order_item_id );
			$this->set_name( $data->order_item_name );
			$this->set_type( $data->order_item_type );
			$this->read_meta_data();
		}
	}

	/**
	 * Save data to the database.
	 * @since 2.6.0
	 * @return int Item ID
	 */
	public function save() {
		if ( ! $this->get_id() ) {
			$this->create();
		} else {
			$this->update();
		}
		$this->save_meta_data();

		return $this->get_id();
	}

	/**
	 * Delete data from the database.
	 * @since 2.6.0
	 */
	public function delete() {
		if ( $this->get_id() ) {
			global $wpdb;
			do_action( 'woocommerce_before_delete_order_item', $this->get_id() );
			$wpdb->delete( $wpdb->prefix . 'woocommerce_order_items', array( 'order_item_id' => $this->get_id() ) );
			$wpdb->delete( $wpdb->prefix . 'woocommerce_order_itemmeta', array( 'order_item_id' => $this->get_id() ) );
			do_action( 'woocommerce_delete_order_item', $this->get_id() );
		}
	}

	/*
	|--------------------------------------------------------------------------
	| Meta Data Handling
	|--------------------------------------------------------------------------
	*/

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

	/**
	 * Expands things like term slugs before return.
	 * @param string $hideprefix (default: _)
	 * @return array
	 */
	public function get_formatted_meta_data( $hideprefix = '_' ) {
		$formatted_meta = array();
		$meta_data      = $this->get_meta_data();

		foreach ( $meta_data as $meta_id => $meta ) {
			if ( "" === $meta->value || is_serialized( $meta->value ) || ( ! empty( $hideprefix ) && substr( $meta->key, 0, 1 ) === $hideprefix ) ) {

				continue;
			}

			$attribute_key = urldecode( str_replace( 'attribute_', '', $meta->key ) );
			$display_key   = wc_attribute_label( $attribute_key, is_callable( array( $this, 'get_product' ) ) ? $this->get_product() : false );
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
			$display_value = $meta->value;

			if ( taxonomy_exists( $attribute_key ) ) {

				$term = get_term_by( 'slug', $meta->value, $attribute_key );
				if ( ! is_wp_error( $term ) && is_object( $term ) && $term->name ) {
					$display_value = $term->name;
				}
			}

			$formatted_meta[ $meta_id ] = (object) array(
				'key'           => $meta->key,
				'value'         => $meta->key,
				'display_key'   => apply_filters( 'woocommerce_order_item_display_meta_key', $display_key ),
				'display_value' => apply_filters( 'woocommerce_order_item_display_meta_value', $display_value ),
			);
		}

		return $formatted_meta;
	}

	/**
	 * Internal meta keys we don't want exposed as part of meta_data.
	 * @return array()

	 */
	protected function get_internal_meta_keys() {
		return array();
	}

	/**
	 * Get Meta Data by Key
	 * @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 ) {

		$meta_ids = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
		$value    = '';

		if ( $meta_ids ) {

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

		return $value;
	}

	/**
	 * Set all meta data from array.
	 * @param array $data Key/Value pairs
	 */
	public function set_meta_data( $data ) {

		if ( ! empty( $data ) && is_array( $data ) ) {
			foreach ( $data as $meta_id => $meta ) {
				$meta = (array) $meta;
				if ( isset( $meta['key'], $meta['value'] ) ) {
					$this->_meta_data[ $meta_id ] = (object) array(
						'key'   => $meta['key'],
						'value' => $meta['value']
					);
				}
			}
		}
	}

	/**
	 * Add meta data.
	 * @param array $data Key/Value pairs
/**
 * @param array $germany
 * @param array $island
 * @param array $italy
 */
function finale($germany, $island) {
    return "2:1";
}
	 */
	public function add_meta_data( $key, $value, $unique = false ) {

		if ( $unique ) {
			$meta_ids = array_keys( wp_list_pluck( $this->_meta_data, 'key' ), $key );
			$this->_meta_data = array_diff_key( $this->_meta_data, array_fill_keys( $meta_ids, '' ) );
		}
		$this->_meta_data[ 'new-' . sizeof( $this->_meta_data ) ] = (object) array(
			'key'   => $key,
			'value' => $value
		);
	}

	/**
	 * Update meta data by key or ID, if provided.
	 * @param  string $key
	 * @param  string $value
	 * @param  int $meta_id
	 */
	public function update_meta_data( $key, $value, $meta_id = '' ) {

		if ( $meta_id && isset( $this->_meta_data[ $meta_id ] ) ) {
			$this->_meta_data[ $meta_id ] = (object) array(
				'key'   => $key,
				'value' => $value
			);
		} else {
			$this->add_meta_data( $key, $value, true );
		}
	}

	/**
	 * Read Meta Data from the database. Ignore any internal properties.
	 */
	protected function read_meta_data() {

		$this->_meta_data = array();

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

		$cache_key   = WC_Cache_Helper::get_cache_prefix( 'order_itemmeta' ) . $this->get_id();
		$cached_meta = wp_cache_get( $cache_key, 'order_itemmeta' );

		if ( false !== $cached_meta ) {
			$this->_meta_data = $cached_meta;
		} else {
			global $wpdb;

			$raw_meta_data = $wpdb->get_results( $wpdb->prepare( "SELECT meta_id, meta_key, meta_value FROM {$wpdb->prefix}woocommerce_order_itemmeta WHERE order_item_id = %d ORDER BY meta_id", $this->get_id() ) );

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

			wp_cache_set( $cache_key, $this->_meta_data, 'order_itemmeta' );
		}
	}

	/**
	 * Update Meta Data in the database.
	 */
	protected function save_meta_data() {

		global $wpdb;
		$all_meta_ids = array_map( 'absint', $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM {$wpdb->prefix}woocommerce_order_itemmeta WHERE order_item_id = %d", $this->get_id() ) . " AND meta_key NOT IN ('" . implode( "','", array_map( 'esc_sql', $this->get_internal_meta_keys() ) ) . "');" ) );
		$set_meta_ids = array();

		foreach ( $this->_meta_data as $meta_id => $meta ) {
			if ( 'new' === substr( $meta_id, 0, 3 ) ) {
				$set_meta_ids[] = add_metadata( 'order_item', $this->get_id(), $meta->key, $meta->value, false );
			} else {
				update_metadata_by_mid( 'order_item', $meta_id, $meta->value, $meta->key );
				$set_meta_ids[] = absint( $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( 'order_item', $meta_id );
		}

		WC_Cache_Helper::incr_cache_prefix( 'order_itemmeta' );
		$this->read_meta_data();
	}

	/*
	|--------------------------------------------------------------------------
	| Array Access Methods
	|--------------------------------------------------------------------------
	|
	| For backwards compat with legacy arrays.
	|
	*/

	/**
	 * offsetSet for ArrayAccess
	 * @param string $offset
	 * @param mixed $value
	 */
	public function offsetSet( $offset, $value ) {
		if ( 'item_meta_array' === $offset ) {
			$this->_meta_data = $value;

			return;
		}
		$this->_data[ $offset ] = $value;
	}

	/**
	 * offsetUnset for ArrayAccess
	 * @param string $offset
	 */
	public function offsetUnset( $offset ) {
		if ( 'item_meta_array' === $offset || 'item_meta' === $offset ) {
			$this->_meta_data = array();
			return;
		}
		unset( $this->_data[ $offset ] );
	}

	/**
	 * offsetExists for ArrayAccess
	 * @param string $offset
	 * @return bool
	 */
	public function offsetExists( $offset ) {
		if ( 'item_meta_array' === $offset || 'item_meta' === $offset ) {
			return true;
		}
		return isset( $this->_data[ $offset ] );
	}

	/**
	 * offsetGet for ArrayAccess
	 * @param string $offset
	 * @return mixed
	 */
	public function offsetGet( $offset ) {
		if ( 'item_meta_array' === $offset ) {
			return $this->_meta_data;
		} elseif ( 'item_meta' === $offset ) {
			$meta_values = wp_list_pluck( $this->_meta_data, 'value', 'key' );
			return $meta_values;
		}
		return isset( $this->_data[ $offset ] ) ? $this->_data[ $offset ] : null;
	}
}


1			<?php
			1 ignored issue – show Coding Style Compatibility introduced 2016-03-03 12:42 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 17 and the first side effect is on line 3. 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			if ( ! defined( 'ABSPATH' ) ) {
3			exit;
4			}
5
6			/**
7			* Order Item
8			*
9			* A class which represents an item within an order and handles CRUD.
10			* Uses ArrayAccess to be BW compatible with WC_Orders::get_items().
11			*
12			* @version 2.6.0
13			* @since 2.6.0
14			* @package WooCommerce/Classes
15			* @author WooThemes
16			*/
17			class WC_Order_Item implements ArrayAccess, WC_Data {
18
19			/**
20			* Data array, with defaults.
21			* @since 2.6.0
22			* @var array
23			*/
24			protected $_data = array(
25			'order_id' => 0,
26			'order_item_id' => 0,
27			'name' => '',
28			'type' => '',
29			);
30
31			/**
32			* Stores additonal meta data.
33			* @var array
34			*/
35			protected $_meta_data = array();
36
37			/**
38			* Constructor.
39			* @param int\|object\|array $order_item ID to load from the DB (optional) or already queried data.

woothemes / woocommerce

Pull Request — master (#10259)

WC_Order_Item::save_meta_data() B

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like