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

132 lines
3.1 KiB
PHP
Raw Normal View History

2014-06-13 13:20:14 +00:00
<?php
/**
* Order Factory
2014-06-13 13:20:14 +00:00
*
2015-11-03 13:31:20 +00:00
* The WooCommerce order factory creating the right order objects.
2014-06-13 13:20:14 +00:00
*
* @version 3.0.0
2020-08-05 16:36:24 +00:00
* @package WooCommerce\Classes
*/
defined( 'ABSPATH' ) || exit;
/**
* Order factory class
2014-06-13 13:20:14 +00:00
*/
class WC_Order_Factory {
/**
* Get order.
2014-06-13 13:20:14 +00:00
*
2017-11-01 11:41:53 +00:00
* @param mixed $order_id (default: false) Order ID to get.
2015-02-03 15:55:40 +00:00
* @return WC_Order|bool
2014-06-13 13:20:14 +00:00
*/
2016-11-17 16:12:04 +00:00
public static function get_order( $order_id = false ) {
$order_id = self::get_order_id( $order_id );
2014-06-13 13:20:14 +00:00
2016-11-17 16:12:04 +00:00
if ( ! $order_id ) {
2014-06-13 13:20:14 +00:00
return false;
}
$order_type = WC_Data_Store::load( 'order' )->get_order_type( $order_id );
$order_type_data = wc_get_order_type( $order_type );
if ( $order_type_data ) {
$classname = $order_type_data['class_name'];
2014-06-13 13:20:14 +00:00
} else {
$classname = false;
2014-06-13 13:20:14 +00:00
}
// Filter classname so that the class can be overridden if extended.
$classname = apply_filters( 'woocommerce_order_class', $classname, $order_type, $order_id );
2014-06-13 13:20:14 +00:00
2014-07-07 10:44:27 +00:00
if ( ! class_exists( $classname ) ) {
return false;
2014-07-07 10:44:27 +00:00
}
2014-06-13 13:20:14 +00:00
2016-11-22 10:46:19 +00:00
try {
2017-03-21 23:37:38 +00:00
return new $classname( $order_id );
2016-11-22 10:46:19 +00:00
} catch ( Exception $e ) {
wc_caught_exception( $e, __FUNCTION__, array( $order_id ) );
2016-11-22 10:46:19 +00:00
return false;
}
2014-06-13 13:20:14 +00:00
}
2016-06-21 19:07:31 +00:00
/**
* Get order item.
2017-11-01 11:41:53 +00:00
*
* @param int $item_id Order item ID to get.
2016-08-19 12:43:33 +00:00
* @return WC_Order_Item|false if not found
2016-06-21 19:07:31 +00:00
*/
public static function get_order_item( $item_id = 0 ) {
if ( is_numeric( $item_id ) ) {
$item_type = WC_Data_Store::load( 'order-item' )->get_order_item_type( $item_id );
2016-11-17 21:30:34 +00:00
$id = $item_id;
2016-06-21 19:07:31 +00:00
} elseif ( $item_id instanceof WC_Order_Item ) {
2016-11-17 21:30:34 +00:00
$item_type = $item_id->get_type();
$id = $item_id->get_id();
} elseif ( is_object( $item_id ) && ! empty( $item_id->order_item_type ) ) {
$id = $item_id->order_item_id;
2016-06-21 19:07:31 +00:00
$item_type = $item_id->order_item_type;
} else {
$item_type = false;
2016-11-17 21:30:34 +00:00
$id = false;
2016-06-21 19:07:31 +00:00
}
2016-11-17 21:30:34 +00:00
if ( $id && $item_type ) {
$classname = false;
2016-06-21 19:07:31 +00:00
switch ( $item_type ) {
case 'line_item':
case 'product':
$classname = 'WC_Order_Item_Product';
break;
case 'coupon':
$classname = 'WC_Order_Item_Coupon';
break;
case 'fee':
$classname = 'WC_Order_Item_Fee';
break;
case 'shipping':
$classname = 'WC_Order_Item_Shipping';
break;
case 'tax':
$classname = 'WC_Order_Item_Tax';
break;
2016-06-21 19:07:31 +00:00
}
2017-05-23 18:16:30 +00:00
$classname = apply_filters( 'woocommerce_get_order_item_classname', $classname, $item_type, $id );
if ( $classname && class_exists( $classname ) ) {
try {
2017-03-21 23:37:38 +00:00
return new $classname( $id );
} catch ( Exception $e ) {
return false;
}
}
2016-06-21 19:07:31 +00:00
}
2016-08-19 12:43:33 +00:00
return false;
2016-06-21 19:07:31 +00:00
}
2016-11-17 16:12:04 +00:00
/**
* Get the order ID depending on what was passed.
*
2017-03-15 16:36:53 +00:00
* @since 3.0.0
2017-11-01 11:41:53 +00:00
* @param mixed $order Order data to convert to an ID.
2016-11-17 16:12:04 +00:00
* @return int|bool false on failure
*/
2016-11-21 14:30:56 +00:00
public static function get_order_id( $order ) {
2016-11-17 16:12:04 +00:00
global $post;
if ( false === $order && is_a( $post, 'WP_Post' ) && 'shop_order' === get_post_type( $post ) ) {
return absint( $post->ID );
2016-11-17 16:12:04 +00:00
} elseif ( is_numeric( $order ) ) {
return $order;
} elseif ( $order instanceof WC_Abstract_Order ) {
return $order->get_id();
} elseif ( ! empty( $order->ID ) ) {
return $order->ID;
} else {
return false;
}
}
}