woocommerce/includes/class-wc-order-item.php

394 lines
9.5 KiB
PHP
Raw Normal View History

2016-06-21 19:10:09 +00:00
<?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.7.0
* @since 2.7.0
* @package WooCommerce/Classes
* @author WooThemes
*/
class WC_Order_Item extends WC_Data implements ArrayAccess {
/**
* Order Data array. This is the core order data exposed in APIs since 2.7.0.
2016-06-21 19:10:09 +00:00
* @since 2.7.0
* @var array
*/
protected $data = array(
2016-08-16 11:27:00 +00:00
'order_id' => 0,
'name' => '',
'type' => '',
2016-06-21 19:10:09 +00:00
);
2016-08-03 11:52:51 +00:00
/**
* May store an order to prevent retriving it multiple times.
* @var object
*/
protected $order;
2016-08-03 11:52:51 +00:00
2016-06-21 19:10:09 +00:00
/**
* Stores meta in cache for future reads.
* A group must be set to to enable caching.
* @var string
*/
protected $cache_group = 'order_itemmeta';
2016-06-21 19:10:09 +00:00
/**
* 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 = 'order_item';
2016-06-21 19:10:09 +00:00
/**
* Constructor.
* @param int|object|array $read ID to load from the DB (optional) or already queried data.
2016-06-21 19:10:09 +00:00
*/
public function __construct( $read = 0 ) {
parent::__construct( $read );
if ( $read instanceof WC_Order_Item ) {
if ( $this->is_type( $read->get_type() ) ) {
$this->set_props( $read->get_data() );
2016-06-21 19:10:09 +00:00
}
} elseif ( is_array( $read ) ) {
$this->set_props( $read );
2016-06-21 19:10:09 +00:00
} else {
$this->read( $read );
2016-06-21 19:10:09 +00:00
}
}
/**
* Type checking
* @param string|array $Type
* @return boolean
*/
public function is_type( $type ) {
return is_array( $type ) ? in_array( $this->get_type(), $type ) : $type === $this->get_type();
}
/**
2016-08-16 11:36:38 +00:00
* Get quantity.
2016-06-21 19:10:09 +00:00
* @return int
*/
2016-08-16 11:36:38 +00:00
public function get_quantity() {
2016-06-21 19:10:09 +00:00
return 1;
}
2016-08-03 11:52:51 +00:00
/**
* Get parent order object.
* @return int
*/
public function get_order() {
if ( ! $this->order ) {
$this->order = wc_get_order( $this->get_order_id() );
2016-08-03 11:52:51 +00:00
}
return $this->order;
2016-08-03 11:52:51 +00:00
}
2016-06-21 19:10:09 +00:00
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
*/
/**
* Get order ID this meta belongs to.
* @return int
*/
public function get_order_id() {
return $this->data['order_id'];
2016-06-21 19:10:09 +00:00
}
/**
* Get order item name.
* @return string
*/
public function get_name() {
return $this->data['name'];
2016-06-21 19:10:09 +00:00
}
/**
* Get order item type.
* @return string
*/
public function get_type() {
return $this->data['type'];
2016-06-21 19:10:09 +00:00
}
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
*/
/**
* Set order ID.
* @param int $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
public function set_order_id( $value ) {
$this->data['order_id'] = absint( $value );
2016-06-21 19:10:09 +00:00
}
/**
* Set order item name.
* @param string $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
public function set_name( $value ) {
$this->data['name'] = wc_clean( $value );
2016-06-21 19:10:09 +00:00
}
/**
* Set order item type.
* @param string $value
2016-08-24 09:46:29 +00:00
* @throws WC_Data_Exception
2016-06-21 19:10:09 +00:00
*/
2016-08-03 11:54:16 +00:00
protected function set_type( $value ) {
$this->data['type'] = wc_clean( $value );
2016-06-21 19:10:09 +00:00
}
/*
|--------------------------------------------------------------------------
| CRUD methods
|--------------------------------------------------------------------------
|
| Methods which create, read, update and delete data from the database.
|
*/
/**
* Insert data into the database.
* @since 2.7.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(),
2016-06-21 19:10:09 +00:00
) );
$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.7.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(),
2016-06-21 19:10:09 +00:00
), 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.7.0
* @param int|object $item ID of object to read, or already queried object.
*/
public function read( $item ) {
global $wpdb;
2016-08-24 15:06:35 +00:00
$this->set_defaults();
2016-06-21 19:10:09 +00:00
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 ) );
2016-08-16 12:55:10 +00:00
} elseif ( ! empty( $item->order_item_id ) ) {
2016-06-21 19:10:09 +00:00
$data = $item;
} else {
$data = false;
}
if ( ! $data ) {
return;
2016-06-21 19:10:09 +00:00
}
$this->set_id( $data->order_item_id );
$this->set_props( array(
'order_id' => $data->order_id,
'name' => $data->order_item_name,
'type' => $data->order_item_type,
) );
$this->read_meta_data();
2016-06-21 19:10:09 +00:00
}
/**
* Save data to the database.
* @since 2.7.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.7.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
|--------------------------------------------------------------------------
*/
/**
* 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 ) {
if ( "" === $meta->value || is_serialized( $meta->value ) || ( ! empty( $hideprefix ) && substr( $meta->key, 0, 1 ) === $hideprefix ) ) {
continue;
}
2016-08-08 14:22:00 +00:00
$meta->key = rawurldecode( $meta->key );
$meta->value = rawurldecode( $meta->value );
$attribute_key = str_replace( 'attribute_', '', $meta->key );
2016-06-21 19:10:09 +00:00
$display_key = wc_attribute_label( $attribute_key, is_callable( array( $this, 'get_product' ) ) ? $this->get_product() : false );
$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(
2016-06-21 19:10:09 +00:00
'key' => $meta->key,
2016-08-08 14:22:00 +00:00
'value' => $meta->value,
2016-06-21 19:10:09 +00:00
'display_key' => apply_filters( 'woocommerce_order_item_display_meta_key', $display_key ),
2016-08-08 14:22:00 +00:00
'display_value' => apply_filters( 'woocommerce_order_item_display_meta_value', wpautop( make_clickable( $display_value ) ) ),
2016-06-21 19:10:09 +00:00
);
}
return $formatted_meta;
}
/*
|--------------------------------------------------------------------------
| 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 ) {
foreach ( $value as $meta_id => $meta ) {
$this->update_meta_data( $meta->key, $meta->value, $meta_id );
}
return;
}
if ( array_key_exists( $offset, $this->data ) ) {
$this->data[ $offset ] = $value;
2016-06-21 19:10:09 +00:00
}
$this->update_meta_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();
2016-06-21 19:10:09 +00:00
return;
}
if ( array_key_exists( $offset, $this->data ) ) {
unset( $this->data[ $offset ] );
2016-06-21 19:10:09 +00:00
}
$this->delete_meta_data( '_' . $offset );
}
/**
* offsetExists for ArrayAccess
* @param string $offset
* @return bool
*/
public function offsetExists( $offset ) {
if ( 'item_meta_array' === $offset || 'item_meta' === $offset || array_key_exists( $offset, $this->data ) ) {
2016-06-21 19:10:09 +00:00
return true;
}
return array_key_exists( '_' . $offset, wp_list_pluck( $this->meta_data, 'value', 'key' ) );
2016-06-21 19:10:09 +00:00
}
/**
* offsetGet for ArrayAccess
* @param string $offset
* @return mixed
*/
public function offsetGet( $offset ) {
if ( 'item_meta_array' === $offset ) {
$return = array();
foreach ( $this->meta_data as $meta ) {
$return[ $meta->id ] = $meta;
2016-06-21 19:10:09 +00:00
}
return $return;
}
$meta_values = wp_list_pluck( $this->meta_data, 'value', 'key' );
2016-06-21 19:10:09 +00:00
if ( 'item_meta' === $offset ) {
return $meta_values;
} elseif ( array_key_exists( $offset, $this->data ) ) {
return $this->data[ $offset ];
2016-06-21 19:10:09 +00:00
} elseif ( array_key_exists( '_' . $offset, $meta_values ) ) {
// Item meta was expanded in previous versions, with prefixes removed. This maintains support.
return $meta_values[ '_' . $offset ];
}
return null;
}
}