• Home
  • WC_Order_Data_Store_CPT

PHP Class WC_Order_Data_Store_CPT

Author: WooThemes
Inheritance: extends Abstract_WC_Order_Data_Store_CPT, implements WC_Object_Data_Store_Interface, implements WC_Order_Data_Store_Interface
Show file Open project: woocommerce/woocommerce

Protected Properties

Property Type Description
$internal_meta_keys array Data stored in meta keys, but not considered "meta" for an order.

Public Methods

Method Description
create ( WC_Order &$order ) Method to create a new order in the database.
get_download_permissions_granted ( WC_Order | integer $order ) : boolean Gets information about whether permissions were generated yet.
get_order_count ( string $type ) : integer Return count of orders with type.
get_order_id_by_order_key ( string $order_key ) : integer Finds an Order ID based on an order key.
get_orders ( array $args = [] ) : array Get all orders matching the passed in args.
get_recorded_coupon_usage_counts ( WC_Order | integer $order ) : boolean Gets information about whether coupon counts were updated.
get_recorded_sales ( WC_Order | integer $order ) : boolean Gets information about whether sales were recorded.
get_stock_reduced ( WC_Order | integer $order ) : boolean Gets information about whether stock was reduced.
get_total_refunded ( $order ) : string Get amount already refunded.
get_total_shipping_refunded ( $order ) : float Get the total shipping refunded.
get_total_tax_refunded ( $order ) : float Get the total tax refunded.
get_unpaid_orders ( $date ) : array Get unpaid orders after a certain date,
search_orders ( string $term ) : array Search order data for a term and return ids.
set_download_permissions_granted ( WC_Order | integer $order, boolean $set ) Stores information about whether permissions were generated yet.
set_recorded_coupon_usage_counts ( WC_Order | integer $order, boolean $set ) Stores information about whether coupon counts were updated.
set_recorded_sales ( WC_Order | integer $order, boolean $set ) Stores information about whether sales were recorded.
set_stock_reduced ( WC_Order | integer $order, boolean $set ) Stores information about whether stock was reduced.

Protected Methods

Method Description
get_post_excerpt ( WC_Order $order ) : string Excerpt for post.
read_order_data ( &$order, object $post_object ) Read order data. Can be overridden by child classes to load other props.
update_post_meta ( &$order ) Helper method that updates all the post meta for an order based on it's settings in the WC_Order class.

Private Methods

Method Description
get_orders_generate_customer_meta_query ( array $values, string $relation = 'or' ) : array Generate meta query for wc_get_orders.

Method Details

create() public method

Method to create a new order in the database.
public create ( WC_Order &$order )
$order WC_Order

get_download_permissions_granted() public method

Gets information about whether permissions were generated yet.
public get_download_permissions_granted ( WC_Order | integer $order ) : boolean
$order WC_Order | integer
return boolean

get_order_count() public method

Return count of orders with type.
public get_order_count ( string $type ) : integer
$type string
return integer

get_order_id_by_order_key() public method

Finds an Order ID based on an order key.
public get_order_id_by_order_key ( string $order_key ) : integer
$order_key string An order key has generated by
return integer The ID of an order, or 0 if the order could not be found

get_orders() public method

Get all orders matching the passed in args.
See also: wc_get_orders()
public get_orders ( array $args = [] ) : array
$args array
return array of orders

get_post_excerpt() protected method

Excerpt for post.
protected get_post_excerpt ( WC_Order $order ) : string
$order WC_Order
return string

get_recorded_coupon_usage_counts() public method

Gets information about whether coupon counts were updated.
public get_recorded_coupon_usage_counts ( WC_Order | integer $order ) : boolean
$order WC_Order | integer
return boolean

get_recorded_sales() public method

Gets information about whether sales were recorded.
public get_recorded_sales ( WC_Order | integer $order ) : boolean
$order WC_Order | integer
return boolean

get_stock_reduced() public method

Gets information about whether stock was reduced.
public get_stock_reduced ( WC_Order | integer $order ) : boolean
$order WC_Order | integer
return boolean

get_total_refunded() public method

Get amount already refunded.
public get_total_refunded ( $order ) : string
return string

get_total_shipping_refunded() public method

Get the total shipping refunded.
public get_total_shipping_refunded ( $order ) : float
return float

get_total_tax_refunded() public method

Get the total tax refunded.
public get_total_tax_refunded ( $order ) : float
return float

get_unpaid_orders() public method

Get unpaid orders after a certain date,
public get_unpaid_orders ( $date ) : array
return array

read_order_data() protected method

Read order data. Can be overridden by child classes to load other props.
Since: 2.7.0
protected read_order_data ( &$order, object $post_object )
$post_object object

search_orders() public method

Search order data for a term and return ids.
public search_orders ( string $term ) : array
$term string
return array of ids

set_download_permissions_granted() public method

Stores information about whether permissions were generated yet.
public set_download_permissions_granted ( WC_Order | integer $order, boolean $set )
$order WC_Order | integer
$set boolean

set_recorded_coupon_usage_counts() public method

Stores information about whether coupon counts were updated.
public set_recorded_coupon_usage_counts ( WC_Order | integer $order, boolean $set )
$order WC_Order | integer
$set boolean

set_recorded_sales() public method

Stores information about whether sales were recorded.
public set_recorded_sales ( WC_Order | integer $order, boolean $set )
$order WC_Order | integer
$set boolean

set_stock_reduced() public method

Stores information about whether stock was reduced.
public set_stock_reduced ( WC_Order | integer $order, boolean $set )
$order WC_Order | integer
$set boolean

update_post_meta() protected method

Helper method that updates all the post meta for an order based on it's settings in the WC_Order class.
Since: 2.7.0
protected update_post_meta ( &$order )

Property Details

$internal_meta_keys protected property

Data stored in meta keys, but not considered "meta" for an order.
Since: 2.7.0
protected array $internal_meta_keys
return array