Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/includes/class-wc-order.php

1640 lines
51 KiB
PHP
Raw Normal View History

First Commit - from Jigoshop Source
2011-08-09 15:16:18 +00:00
<?php
check if ABSPATH is defined
2015-11-06 09:22:19 +00:00
if ( ! defined( 'ABSPATH' ) ) {
Order class
2016-06-21 19:06:39 +00:00
exit;
check if ABSPATH is defined
2015-11-06 09:22:19 +00:00
}
First Commit - from Jigoshop Source
2011-08-09 15:16:18 +00:00
/**
Order class
2016-06-21 19:06:39 +00:00
* Order Class.
*
* These are regular WooCommerce orders, which extend the abstract order class.
Localise comment emails. Closes #1353.
2012-08-08 08:21:27 +00:00
*
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
* @class WC_Order
* @version 2.2.0
* @package WooCommerce/Classes
* @category Class
* @author WooThemes
First Commit - from Jigoshop Source
2011-08-09 15:16:18 +00:00
*/
Created WC_Abstract_Order, extended by WC_Order
2014-06-13 13:35:53 +00:00
class WC_Order extends WC_Abstract_Order {
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
Order class
2016-06-21 19:06:39 +00:00
/**
* Data stored in meta keys, but not considered "meta" for an order.
* @since 2.7.0
* @var array
*/
protected $_internal_meta_keys = array(
'_customer_user', '_order_key', '_order_currency', '_billing_first_name',
'_billing_last_name', '_billing_company', '_billing_address_1', '_billing_address_2',
'_billing_city', '_billing_state', '_billing_postcode', '_billing_country',
'_billing_email', '_billing_phone', '_shipping_first_name', '_shipping_last_name',
'_shipping_company', '_shipping_address_1', '_shipping_address_2', '_shipping_city',
'_shipping_state', '_shipping_postcode', '_shipping_country', '_completed_date',
'_paid_date', '_edit_lock', '_edit_last', '_cart_discount', '_cart_discount_tax',
'_order_shipping', '_order_shipping_tax', '_order_tax', '_order_total', '_order_total',
'_payment_method', '_payment_method_title', '_transaction_id', '_customer_ip_address',
'_customer_user_agent', '_created_via', '_order_version', '_prices_include_tax',
'_customer_note', '_date_completed', '_date_paid', '_payment_tokens',
);
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
/**
Order class
2016-06-21 19:06:39 +00:00
* Stores data about status changes so relevant hooks can be fired.
* @var bool|array
*/
protected $_status_transition = false;
/**
* Extend the abstract _data properties and then read the order object.
*
* @param int|object|WC_Order $order Order to init.
*/
public function __construct( $order = 0 ) {
$this->_data = array_merge( $this->_data, array(
API get refunds
2016-08-22 12:04:57 +00:00
'customer_id' => 0,
Create refund with crud
2016-08-22 10:00:31 +00:00
'order_key' => '',
Order class
2016-06-21 19:06:39 +00:00
'billing' => array(
'first_name' => '',
'last_name' => '',
'company' => '',
'address_1' => '',
'address_2' => '',
'city' => '',
'state' => '',
'postcode' => '',
'country' => '',
'email' => '',
'phone' => '',
),
'shipping' => array(
'first_name' => '',
'last_name' => '',
'company' => '',
'address_1' => '',
'address_2' => '',
'city' => '',
'state' => '',
'postcode' => '',
'country' => '',
),
'payment_method' => '',
'payment_method_title' => '',
'transaction_id' => '',
'customer_ip_address' => '',
'customer_user_agent' => '',
'created_via' => '',
'customer_note' => '',
'date_completed' => '',
'date_paid' => '',
'cart_hash' => '',
) );
parent::__construct( $order );
}
/**
* When a payment is complete this function is called.
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
*
Order class
2016-06-21 19:06:39 +00:00
* Most of the time this should mark an order as 'processing' so that admin can process/post the items.
* If the cart contains only downloadable items then the order is 'completed' since the admin needs to take no action.
* Stock levels are reduced at this point.
* Sales are also recorded for products.
* Finally, record the date of payment.
*
Address and CRUD unit tests
2016-06-22 13:07:42 +00:00
* Order must exist.
*
Order class
2016-06-21 19:06:39 +00:00
* @param string $transaction_id Optional transaction id to store in post meta.
Address and CRUD unit tests
2016-06-22 13:07:42 +00:00
* @return bool success
Order class
2016-06-21 19:06:39 +00:00
*/
public function payment_complete( $transaction_id = '' ) {
Address and CRUD unit tests
2016-06-22 13:07:42 +00:00
if ( ! $this->get_id() ) {
return false;
}
Order class
2016-06-21 19:06:39 +00:00
do_action( 'woocommerce_pre_payment_complete', $this->get_id() );
if ( ! empty( WC()->session ) ) {
WC()->session->set( 'order_awaiting_payment', false );
}
Address and CRUD unit tests
2016-06-22 13:07:42 +00:00
if ( $this->has_status( apply_filters( 'woocommerce_valid_order_statuses_for_payment_complete', array( 'on-hold', 'pending', 'failed', 'cancelled' ), $this ) ) ) {
Order class
2016-06-21 19:06:39 +00:00
$order_needs_processing = false;
if ( sizeof( $this->get_items() ) > 0 ) {
foreach ( $this->get_items() as $item ) {
if ( $item->is_type( 'line_item' ) && ( $product = $item->get_product() ) ) {
$virtual_downloadable_item = $product->is_downloadable() && $product->is_virtual();
if ( apply_filters( 'woocommerce_order_item_needs_processing', ! $virtual_downloadable_item, $product, $this->get_id() ) ) {
$order_needs_processing = true;
break;
}
}
}
}
if ( ! empty( $transaction_id ) ) {
$this->set_transaction_id( $transaction_id );
}
$this->set_status( apply_filters( 'woocommerce_payment_complete_order_status', $order_needs_processing ? 'processing' : 'completed', $this->get_id() ) );
$this->set_date_paid( current_time( 'timestamp' ) );
$this->save();
do_action( 'woocommerce_payment_complete', $this->get_id() );
} else {
do_action( 'woocommerce_payment_complete_order_status_' . $this->get_status(), $this->get_id() );
}
Address and CRUD unit tests
2016-06-22 13:07:42 +00:00
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Gets order total - formatted for display.
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
* @return string
*/
add $display_refunded parameter to get_formatted_order_total #8793
2015-08-13 13:45:49 +00:00
public function get_formatted_order_total( $tax_display = '', $display_refunded = true ) {
Order class
2016-06-21 19:06:39 +00:00
$formatted_total = wc_price( $this->get_total(), array( 'currency' => $this->get_currency() ) );
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
$order_total = $this->get_total();
$total_refunded = $this->get_total_refunded();
$tax_string = '';
// Tax for inclusive prices
if ( wc_tax_enabled() && 'incl' == $tax_display ) {
$tax_string_array = array();
if ( 'itemized' == get_option( 'woocommerce_tax_total_display' ) ) {
foreach ( $this->get_tax_totals() as $code => $tax ) {
Order class
2016-06-21 19:06:39 +00:00
$tax_amount = ( $total_refunded && $display_refunded ) ? wc_price( WC_Tax::round( $tax->amount - $this->get_total_tax_refunded_by_rate_id( $tax->rate_id ) ), array( 'currency' => $this->get_currency() ) ) : $tax->formatted_amount;
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
$tax_string_array[] = sprintf( '%s %s', $tax_amount, $tax->label );
}
} else {
add $display_refunded parameter to get_formatted_order_total #8793
2015-08-13 13:45:49 +00:00
$tax_amount = ( $total_refunded && $display_refunded ) ? $this->get_total_tax() - $this->get_total_tax_refunded() : $this->get_total_tax();
Order class
2016-06-21 19:06:39 +00:00
$tax_string_array[] = sprintf( '%s %s', wc_price( $tax_amount, array( 'currency' => $this->get_currency() ) ), WC()->countries->tax_or_vat() );
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
}
if ( ! empty( $tax_string_array ) ) {
Lowercase includes %s string only
2016-03-14 10:41:45 +00:00
$tax_string = ' ' . sprintf( __( '(includes %s)', 'woocommerce' ), implode( ', ', $tax_string_array ) );
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
}
}
add $display_refunded parameter to get_formatted_order_total #8793
2015-08-13 13:45:49 +00:00
if ( $total_refunded && $display_refunded ) {
Order class
2016-06-21 19:06:39 +00:00
$formatted_total = '<del>' . strip_tags( $formatted_total ) . '</del> <ins>' . wc_price( $order_total - $total_refunded, array( 'currency' => $this->get_currency() ) ) . $tax_string . '</ins>';
Move refund logic into main order class. These methods are not defined in the abstract.
2015-07-15 15:02:26 +00:00
} else {
$formatted_total .= $tax_string;
}
return apply_filters( 'woocommerce_get_formatted_order_total', $formatted_total, $this );
}
Order class
2016-06-21 19:06:39 +00:00
/*
|--------------------------------------------------------------------------
| CRUD methods
|--------------------------------------------------------------------------
|
| Methods which create, read, update and delete orders from the database.
| Written in abstract fashion so that the way orders are stored can be
| changed more easily in the future.
|
| A save method is included for convenience (chooses update or create based
| on if the order exists yet).
|
*/
/**
* Insert data into the database.
* @since 2.7.0
*/
public function create() {
parent::create();
// Store additonal order data
if ( $this->get_id() ) {
Create refund with crud
2016-08-22 10:00:31 +00:00
$this->set_order_key( 'wc_' . apply_filters( 'woocommerce_generate_order_key', uniqid( 'order_' ) ) );
API get refunds
2016-08-22 12:04:57 +00:00
$this->update_post_meta( '_customer_user', $this->get_customer_id() );
Create refund with crud
2016-08-22 10:00:31 +00:00
$this->update_post_meta( '_order_key', $this->get_order_key() );
Order class
2016-06-21 19:06:39 +00:00
$this->update_post_meta( '_billing_first_name', $this->get_billing_first_name() );
$this->update_post_meta( '_billing_last_name', $this->get_billing_last_name() );
$this->update_post_meta( '_billing_company', $this->get_billing_company() );
$this->update_post_meta( '_billing_address_1', $this->get_billing_address_1() );
$this->update_post_meta( '_billing_address_2', $this->get_billing_address_2() );
$this->update_post_meta( '_billing_city', $this->get_billing_city() );
$this->update_post_meta( '_billing_state', $this->get_billing_state() );
$this->update_post_meta( '_billing_postcode', $this->get_billing_postcode() );
$this->update_post_meta( '_billing_country', $this->get_billing_country() );
$this->update_post_meta( '_billing_email', $this->get_billing_email() );
$this->update_post_meta( '_billing_phone', $this->get_billing_phone() );
$this->update_post_meta( '_shipping_first_name', $this->get_shipping_first_name() );
$this->update_post_meta( '_shipping_last_name', $this->get_shipping_last_name() );
$this->update_post_meta( '_shipping_company', $this->get_shipping_company() );
$this->update_post_meta( '_shipping_address_1', $this->get_shipping_address_1() );
$this->update_post_meta( '_shipping_address_2', $this->get_shipping_address_2() );
$this->update_post_meta( '_shipping_city', $this->get_shipping_city() );
$this->update_post_meta( '_shipping_state', $this->get_shipping_state() );
$this->update_post_meta( '_shipping_postcode', $this->get_shipping_postcode() );
$this->update_post_meta( '_shipping_country', $this->get_shipping_country() );
$this->update_post_meta( '_payment_method', $this->get_payment_method() );
$this->update_post_meta( '_payment_method_title', $this->get_payment_method_title() );
$this->update_post_meta( '_transaction_id', $this->get_transaction_id() );
$this->update_post_meta( '_customer_ip_address', $this->get_customer_ip_address() );
$this->update_post_meta( '_customer_user_agent', $this->get_customer_user_agent() );
$this->update_post_meta( '_created_via', $this->get_created_via() );
$this->update_post_meta( '_customer_note', $this->get_customer_note() );
$this->update_post_meta( '_date_completed', $this->get_date_completed() );
$this->update_post_meta( '_date_paid', $this->get_date_paid() );
$this->update_post_meta( '_cart_hash', $this->get_cart_hash() );
do_action( 'woocommerce_new_order', $this->get_id() );
}
}
/**
* Read from the database.
* @since 2.7.0
* @param int $id ID of object to read.
*/
public function read( $id ) {
parent::read( $id );
// Read additonal order data
if ( $order_id = $this->get_id() ) {
$post_object = get_post( $this->get_id() );
Create refund with crud
2016-08-22 10:00:31 +00:00
$this->set_order_key( get_post_meta( $this->get_id(), '_order_key', true ) );
API get refunds
2016-08-22 12:04:57 +00:00
$this->set_customer_id( get_post_meta( $this->get_id(), '_customer_user', true ) );
Order class
2016-06-21 19:06:39 +00:00
$this->set_billing_first_name( get_post_meta( $order_id, '_billing_first_name', true ) );
$this->set_billing_last_name( get_post_meta( $order_id, '_billing_last_name', true ) );
$this->set_billing_company( get_post_meta( $order_id, '_billing_company', true ) );
$this->set_billing_address_1( get_post_meta( $order_id, '_billing_address_1', true ) );
$this->set_billing_address_2( get_post_meta( $order_id, '_billing_address_2', true ) );
$this->set_billing_city( get_post_meta( $order_id, '_billing_city', true ) );
$this->set_billing_state( get_post_meta( $order_id, '_billing_state', true ) );
$this->set_billing_postcode( get_post_meta( $order_id, '_billing_postcode', true ) );
$this->set_billing_country( get_post_meta( $order_id, '_billing_country', true ) );
$this->set_billing_email( get_post_meta( $order_id, '_billing_email', true ) );
$this->set_billing_phone( get_post_meta( $order_id, '_billing_phone', true ) );
$this->set_shipping_first_name( get_post_meta( $order_id, '_shipping_first_name', true ) );
$this->set_shipping_last_name( get_post_meta( $order_id, '_shipping_last_name', true ) );
$this->set_shipping_company( get_post_meta( $order_id, '_shipping_company', true ) );
$this->set_shipping_address_1( get_post_meta( $order_id, '_shipping_address_1', true ) );
$this->set_shipping_address_2( get_post_meta( $order_id, '_shipping_address_2', true ) );
$this->set_shipping_city( get_post_meta( $order_id, '_shipping_city', true ) );
$this->set_shipping_state( get_post_meta( $order_id, '_shipping_state', true ) );
$this->set_shipping_postcode( get_post_meta( $order_id, '_shipping_postcode', true ) );
$this->set_shipping_country( get_post_meta( $order_id, '_shipping_country', true ) );
$this->set_payment_method( get_post_meta( $order_id, '_payment_method', true ) );
$this->set_payment_method_title( get_post_meta( $order_id, '_payment_method_title', true ) );
$this->set_transaction_id( get_post_meta( $order_id, '_transaction_id', true ) );
$this->set_customer_ip_address( get_post_meta( $order_id, '_customer_ip_address', true ) );
$this->set_customer_user_agent( get_post_meta( $order_id, '_customer_user_agent', true ) );
$this->set_created_via( get_post_meta( $order_id, '_created_via', true ) );
$this->set_customer_note( get_post_meta( $order_id, '_customer_note', true ) );
$this->set_date_completed( get_post_meta( $order_id, '_completed_date', true ) );
$this->set_date_paid( get_post_meta( $order_id, '_paid_date', true ) );
$this->set_cart_hash( get_post_meta( $order_id, '_cart_hash', true ) );
$this->set_customer_note( $post_object->post_excerpt );
// Map user data
if ( ! $this->get_billing_email() && ( $user = $this->get_user() ) ) {
$this->set_billing_email( $user->user_email );
}
}
}
/**
* Update data in the database.
* @since 2.7.0
*/
public function update() {
// Store additonal order data
Create refund with crud
2016-08-22 10:00:31 +00:00
$this->update_post_meta( '_order_key', $this->get_order_key() );
API get refunds
2016-08-22 12:04:57 +00:00
$this->update_post_meta( '_customer_user', $this->get_customer_id() );
Order class
2016-06-21 19:06:39 +00:00
$this->update_post_meta( '_billing_first_name', $this->get_billing_first_name() );
$this->update_post_meta( '_billing_last_name', $this->get_billing_last_name() );
$this->update_post_meta( '_billing_company', $this->get_billing_company() );
$this->update_post_meta( '_billing_address_1', $this->get_billing_address_1() );
$this->update_post_meta( '_billing_address_2', $this->get_billing_address_2() );
$this->update_post_meta( '_billing_city', $this->get_billing_city() );
$this->update_post_meta( '_billing_state', $this->get_billing_state() );
$this->update_post_meta( '_billing_postcode', $this->get_billing_postcode() );
$this->update_post_meta( '_billing_country', $this->get_billing_country() );
$this->update_post_meta( '_billing_email', $this->get_billing_email() );
$this->update_post_meta( '_billing_phone', $this->get_billing_phone() );
$this->update_post_meta( '_shipping_first_name', $this->get_shipping_first_name() );
$this->update_post_meta( '_shipping_last_name', $this->get_shipping_last_name() );
$this->update_post_meta( '_shipping_company', $this->get_shipping_company() );
$this->update_post_meta( '_shipping_address_1', $this->get_shipping_address_1() );
$this->update_post_meta( '_shipping_address_2', $this->get_shipping_address_2() );
$this->update_post_meta( '_shipping_city', $this->get_shipping_city() );
$this->update_post_meta( '_shipping_state', $this->get_shipping_state() );
$this->update_post_meta( '_shipping_postcode', $this->get_shipping_postcode() );
$this->update_post_meta( '_shipping_country', $this->get_shipping_country() );
$this->update_post_meta( '_payment_method', $this->get_payment_method() );
$this->update_post_meta( '_payment_method_title', $this->get_payment_method_title() );
$this->update_post_meta( '_transaction_id', $this->get_transaction_id() );
$this->update_post_meta( '_customer_ip_address', $this->get_customer_ip_address() );
$this->update_post_meta( '_customer_user_agent', $this->get_customer_user_agent() );
$this->update_post_meta( '_created_via', $this->get_created_via() );
$this->update_post_meta( '_customer_note', $this->get_customer_note() );
$this->update_post_meta( '_date_completed', $this->get_date_completed() );
$this->update_post_meta( '_date_paid', $this->get_date_paid() );
$this->update_post_meta( '_cart_hash', $this->get_cart_hash() );
$customer_changed = $this->update_post_meta( '_customer_user', $this->get_customer_id() );
// Update parent
parent::update();
// If customer changed, update any downloadable permissions
if ( $customer_changed ) {
$wpdb->update( $wpdb->prefix . "woocommerce_downloadable_product_permissions",
array(
'user_id' => $this->get_customer_id(),
'user_email' => $this->get_billing_email(),
),
array(
'order_id' => $this->get_id(),
),
array(
'%d',
'%s',
),
array(
'%d',
)
);
}
// Handle status change
$this->status_transition();
}
/**
* Set order status.
* @since 2.7.0
* @param string $new_status Status to change the order to. No internal wc- prefix is required.
* @param string $note (default: '') Optional note to add.
* @param bool $manual_update is this a manual order status change?
* @param array details of change
*/
public function set_status( $new_status, $note = '', $manual_update = false ) {
$result = parent::set_status( $new_status );
if ( ! empty( $result['from'] ) && $result['from'] !== $result['to'] ) {
$this->_status_transition = array(
'from' => ! empty( $this->_status_transition['from'] ) ? $this->_status_transition['from'] : $result['from'],
'to' => $result['to'],
'note' => $note,
'manual' => (bool) $manual_update,
);
if ( 'pending' === $result['from'] && ! $manual_update ) {
$this->set_date_paid( current_time( 'timestamp' ) );
}
if ( 'completed' === $result['to'] ) {
$this->set_date_completed( current_time( 'timestamp' ) );
}
}
return $result;
}
/**
Address and CRUD unit tests
2016-06-22 13:07:42 +00:00
* Updates status of order immediately. Order must exist.
Order class
2016-06-21 19:06:39 +00:00
* @uses WC_Order::set_status()
*/
public function update_status( $new_status, $note = '', $manual = false ) {
if ( ! $this->get_id() ) {
return false;
}
$this->set_status( $new_status, $note, $manual );
$this->save();
return true;
}
/**
* Handle the status transition.
*/
protected function status_transition() {
if ( $this->_status_transition ) {
if ( ! empty( $this->_status_transition['from'] ) ) {
$transition_note = sprintf( __( 'Order status changed from %s to %s.', 'woocommerce' ), wc_get_order_status_name( $this->_status_transition['from'] ), wc_get_order_status_name( $this->_status_transition['to'] ) );
do_action( 'woocommerce_order_status_' . $this->_status_transition['from'] . '_to_' . $this->_status_transition['to'], $this->get_id() );
do_action( 'woocommerce_order_status_changed', $this->get_id(), $this->_status_transition['from'], $this->_status_transition['to'] );
} else {
$transition_note = sprintf( __( 'Order status set to %s.', 'woocommerce' ), wc_get_order_status_name( $this->_status_transition['to'] ) );
}
do_action( 'woocommerce_order_status_' . $this->_status_transition['to'], $this->get_id() );
// Note the transition occured
$this->add_order_note( trim( $this->_status_transition['note'] . ' ' . $transition_note ), 0, $this->_status_transition['manual'] );
// This has ran, so reset status transition variable
$this->_status_transition = false;
}
}
/*
|--------------------------------------------------------------------------
| Getters
|--------------------------------------------------------------------------
|
| Methods for getting data from the order object.
|
*/
API get refunds
2016-08-22 12:04:57 +00:00
/**
* Get all class data in array format.
* @since 2.7.0
* @return array
*/
public function get_data() {
return array_merge(
$this->_data,
array(
'number' => $this->get_order_number(),
'meta_data' => $this->get_meta_data(),
'line_items' => $this->get_items( 'line_item' ),
'tax_lines' => $this->get_items( 'tax' ),
'shipping_lines' => $this->get_items( 'shipping' ),
'fee_lines' => $this->get_items( 'fee' ),
'coupon_lines' => $this->get_items( 'coupon' ),
)
);
}
/**
* get_order_number function.
*
* Gets the order number for display (by default, order ID).
*
* @return string
*/
public function get_order_number() {
return apply_filters( 'woocommerce_order_number', $this->get_id(), $this );
}
Create refund with crud
2016-08-22 10:00:31 +00:00
/**
* Get order key.
* @since 2.7.0
* @return string
*/
public function get_order_key() {
return $this->_data['order_key'];
}
API get refunds
2016-08-22 12:04:57 +00:00
/**
* Get customer_id
* @return int
*/
public function get_customer_id() {
return $this->_data['customer_id'];
}
/**
* Alias for get_customer_id().
* @return int
*/
public function get_user_id() {
return $this->get_customer_id();
}
/**
* Get the user associated with the order. False for guests.
* @return WP_User|false
*/
public function get_user() {
return $this->get_user_id() ? get_user_by( 'id', $this->get_user_id() ) : false;
}
Order class
2016-06-21 19:06:39 +00:00
/**
* Get billing_first_name
* @return string
*/
public function get_billing_first_name() {
return $this->_data['billing']['first_name'];
}
/**
* Get billing_last_name
* @return string
*/
public function get_billing_last_name() {
return $this->_data['billing']['last_name'];
}
/**
* Get billing_company
* @return string
*/
public function get_billing_company() {
return $this->_data['billing']['company'];
}
/**
* Get billing_address_1
* @return string
*/
public function get_billing_address_1() {
return $this->_data['billing']['address_1'];
}
/**
* Get billing_address_2
* @return string $value
*/
public function get_billing_address_2() {
return $this->_data['billing']['address_2'];
}
/**
* Get billing_city
* @return string $value
*/
public function get_billing_city() {
return $this->_data['billing']['city'];
}
/**
* Get billing_state
* @return string
*/
public function get_billing_state() {
return $this->_data['billing']['state'];
}
/**
* Get billing_postcode
* @return string
*/
public function get_billing_postcode() {
return $this->_data['billing']['postcode'];
}
/**
* Get billing_country
* @return string
*/
public function get_billing_country() {
return $this->_data['billing']['country'];
}
/**
* Get billing_email
* @return string
*/
public function get_billing_email() {
@Since changes
2016-06-29 11:58:38 +00:00
return $this->_data['billing']['email'];
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Get billing_phone
* @return string
*/
public function get_billing_phone() {
return $this->_data['billing']['phone'];
}
/**
* Get shipping_first_name
* @return string
*/
public function get_shipping_first_name() {
return $this->_data['shipping']['first_name'];
}
/**
* Get shipping_last_name
* @return string
*/
public function get_shipping_last_name() {
return $this->_data['shipping']['last_name'];
}
/**
* Get shipping_company
* @return string
*/
public function get_shipping_company() {
return $this->_data['shipping']['company'];
}
/**
* Get shipping_address_1
* @return string
*/
public function get_shipping_address_1() {
return $this->_data['shipping']['address_1'];
}
/**
* Get shipping_address_2
* @return string
*/
public function get_shipping_address_2() {
return $this->_data['shipping']['address_2'];
}
/**
* Get shipping_city
* @return string
*/
public function get_shipping_city() {
return $this->_data['shipping']['city'];
}
/**
* Get shipping_state
* @return string
*/
public function get_shipping_state() {
return $this->_data['shipping']['state'];
}
/**
* Get shipping_postcode
* @return string
*/
public function get_shipping_postcode() {
return $this->_data['shipping']['postcode'];
}
/**
* Get shipping_country
* @return string
*/
public function get_shipping_country() {
return $this->_data['shipping']['country'];
}
/**
* Get the payment method.
* @return string
*/
public function get_payment_method() {
return $this->_data['payment_method'];
}
/**
* Get payment_method_title
* @return string
*/
public function get_payment_method_title() {
return $this->_data['payment_method_title'];
}
/**
* Get transaction_id
* @return string
*/
public function get_transaction_id() {
return $this->_data['transaction_id'];
}
/**
* Get customer_ip_address
* @return string
*/
public function get_customer_ip_address() {
return $this->_data['customer_ip_address'];
}
/**
* Get customer_user_agent
* @return string
*/
public function get_customer_user_agent() {
return $this->_data['customer_user_agent'];
}
/**
* Get created_via
* @return string
*/
public function get_created_via() {
return $this->_data['created_via'];
}
/**
* Get customer_note
* @return string
*/
public function get_customer_note() {
return $this->_data['customer_note'];
}
/**
* Get date_completed
* @return int
*/
public function get_date_completed() {
return absint( $this->_data['date_completed'] );
}
/**
* Get date_paid
* @return int
*/
public function get_date_paid() {
return absint( $this->_data['date_paid'] );
}
/**
* Returns the requested address in raw, non-formatted way.
* @since 2.4.0
* @param string $type Billing or shipping. Anything else besides 'billing' will return shipping address.
* @return array The stored address after filter.
*/
public function get_address( $type = 'billing' ) {
return apply_filters( 'woocommerce_get_order_address', isset( $this->_data[ $type ] ) ? $this->_data[ $type ] : array(), $type, $this );
}
/**
* Get a formatted shipping address for the order.
*
* @return string
*/
public function get_shipping_address_map_url() {
$address = apply_filters( 'woocommerce_shipping_address_map_url_parts', $this->get_address( 'shipping' ), $this );
return apply_filters( 'woocommerce_shipping_address_map_url', 'http://maps.google.com/maps?&q=' . urlencode( implode( ', ', $address ) ) . '&z=16', $this );
}
/**
* Get a formatted billing full name.
* @return string
*/
public function get_formatted_billing_full_name() {
return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce' ), $this->get_billing_first_name(), $this->get_billing_last_name() );
}
/**
* Get a formatted shipping full name.
* @return string
*/
public function get_formatted_shipping_full_name() {
return sprintf( _x( '%1$s %2$s', 'full name', 'woocommerce' ), $this->get_shipping_first_name(), $this->get_shipping_last_name() );
}
/**
* Get a formatted billing address for the order.
* @return string
*/
public function get_formatted_billing_address() {
return WC()->countries->get_formatted_address( apply_filters( 'woocommerce_order_formatted_billing_address', $this->get_address( 'billing' ), $this ) );
}
/**
* Get a formatted shipping address for the order.
* @return string
*/
public function get_formatted_shipping_address() {
if ( $this->get_shipping_address_1() || $this->get_shipping_address_2() ) {
return WC()->countries->get_formatted_address( apply_filters( 'woocommerce_order_formatted_shipping_address', $this->get_address( 'shipping' ), $this ) );
} else {
return '';
}
}
/**
* Get cart hash
* @return string
*/
public function get_cart_hash() {
return $this->_data['cart_hash'];
}
/*
|--------------------------------------------------------------------------
| Setters
|--------------------------------------------------------------------------
|
| Functions for setting order data. These should not update anything in the
| database itself and should only change what is stored in the class
| object. However, for backwards compatibility pre 2.7.0 some of these
| setters may handle both.
|
*/
Create refund with crud
2016-08-22 10:00:31 +00:00
/**
* Set order_key.
* @param string $value Max length 20 chars.
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Create refund with crud
2016-08-22 10:00:31 +00:00
*/
public function set_order_key( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'order_key', substr( $value, 0, 20 ) );
Create refund with crud
2016-08-22 10:00:31 +00:00
}
API get refunds
2016-08-22 12:04:57 +00:00
/**
* Set customer_id
* @param int $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
API get refunds
2016-08-22 12:04:57 +00:00
*/
public function set_customer_id( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'customer_id', absint( $value ) );
API get refunds
2016-08-22 12:04:57 +00:00
}
Order class
2016-06-21 19:06:39 +00:00
/**
* Set billing_first_name
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_first_name( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['first_name'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_last_name
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_last_name( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['last_name'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_company
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_company( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['company'] = $value;
eturn true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_address_1
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_address_1( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['address_1'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_address_2
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_address_2( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['address_2'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_city
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_city( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['city'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_state
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_state( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['state'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_postcode
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_postcode( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['postcode'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_country
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_country( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['country'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_email
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_email( $value ) {
Setters
2016-08-23 14:25:50 +00:00
if ( $value && ! is_email( sanitize_email( $value ) ) ) {
return $this->error( 'Invalid email address', $value );
}
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['email'] = sanitize_email( $value );
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set billing_phone
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_billing_phone( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['billing']['phone'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_first_name
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_first_name( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['first_name'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_last_name
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_last_name( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['last_name'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_company
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_company( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['company'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_address_1
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_address_1( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['address_1'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_address_2
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_address_2( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['address_2'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_city
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_city( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['city'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_state
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_state( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['state'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_postcode
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_postcode( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['postcode'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set shipping_country
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_shipping_country( $value ) {
2d array handling
2016-08-23 14:49:34 +00:00
$this->_data['shipping']['country'] = $value;
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set the payment method.
* @param string $payment_method Supports WC_Payment_Gateway for bw compatibility with < 2.7
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_payment_method( $payment_method = '' ) {
if ( is_object( $payment_method ) ) {
$this->set_payment_method( $payment_method->id );
$this->set_payment_method_title( $payment_method->get_title() );
} elseif ( '' === $payment_method ) {
Setters
2016-08-23 14:25:50 +00:00
$this->set_prop( 'payment_method', '' );
$this->set_prop( 'payment_method_title', '' );
Order class
2016-06-21 19:06:39 +00:00
} else {
Setters
2016-08-23 14:25:50 +00:00
$this->set_prop( 'payment_method', $payment_method );
Order class
2016-06-21 19:06:39 +00:00
}
Setters
2016-08-23 14:25:50 +00:00
return true;
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set payment_method_title
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_payment_method_title( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'payment_method_title', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set transaction_id
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_transaction_id( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'transaction_id', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set customer_ip_address
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_customer_ip_address( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'customer_ip_address', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set customer_user_agent
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_customer_user_agent( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'customer_user_agent', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set created_via
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_created_via( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'created_via', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set customer_note
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_customer_note( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'customer_note', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set date_completed
* @param string $timestamp
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_date_completed( $timestamp ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'date_completed', is_numeric( $timestamp ) ? $timestamp : strtotime( $timestamp ) );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set date_paid
* @param string $timestamp
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_date_paid( $timestamp ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'date_paid', is_numeric( $timestamp ) ? $timestamp : strtotime( $timestamp ) );
Order class
2016-06-21 19:06:39 +00:00
}
/**
* Set cart hash
* @param string $value
Setters
2016-08-23 14:25:50 +00:00
* @return bool|WP_Error Returns success true or false/WP Error on failure.
Order class
2016-06-21 19:06:39 +00:00
*/
public function set_cart_hash( $value ) {
Setters
2016-08-23 14:25:50 +00:00
return $this->set_prop( 'cart_hash', $value );
Order class
2016-06-21 19:06:39 +00:00
}
/*
|--------------------------------------------------------------------------
| Conditionals
|--------------------------------------------------------------------------
|
| Checks if a condition is true or false.
|
*/
Create refund with crud
2016-08-22 10:00:31 +00:00
/**
* Check if an order key is valid.
*
* @param mixed $key
* @return bool
*/
public function key_is_valid( $key ) {
return $key === $this->get_order_key();
}
Order class
2016-06-21 19:06:39 +00:00
/**
* See if order matches cart_hash.
* @return bool
*/
Unit test conditional functions
2016-06-22 14:38:28 +00:00
public function has_cart_hash( $cart_hash = '' ) {
Order class
2016-06-21 19:06:39 +00:00
return hash_equals( $this->get_cart_hash(), $cart_hash );
}
/**
* Checks if an order can be edited, specifically for use on the Edit Order screen.
* @return bool
*/
public function is_editable() {
return apply_filters( 'wc_order_is_editable', in_array( $this->get_status(), array( 'pending', 'on-hold', 'auto-draft' ) ), $this );
}
/**
* Returns if an order has been paid for based on the order status.
* @since 2.5.0
* @return bool
*/
public function is_paid() {
return apply_filters( 'woocommerce_order_is_paid', $this->has_status( apply_filters( 'woocommerce_order_is_paid_statuses', array( 'processing', 'completed' ) ) ), $this );
}
/**
* Checks if product download is permitted.
*
* @return bool
*/
public function is_download_permitted() {
return apply_filters( 'woocommerce_order_is_download_permitted', $this->has_status( 'completed' ) || ( 'yes' === get_option( 'woocommerce_downloads_grant_access_after_payment' ) && $this->has_status( 'processing' ) ), $this );
}
/**
* Checks if an order needs display the shipping address, based on shipping method.
* @return bool
*/
public function needs_shipping_address() {
if ( 'no' === get_option( 'woocommerce_calc_shipping' ) ) {
return false;
}
$hide = apply_filters( 'woocommerce_order_hide_shipping_address', array( 'local_pickup' ), $this );
$needs_address = false;
foreach ( $this->get_shipping_methods() as $shipping_method ) {
Merge branch 'master' into orders-crud-classes # Conflicts: # includes/abstracts/abstract-wc-order.php
2016-08-03 11:32:27 +00:00
// Remove any instance IDs after :
$shipping_method_id = current( explode( ':', $shipping_method['method_id'] ) );
if ( ! in_array( $shipping_method_id, $hide ) ) {
Order class
2016-06-21 19:06:39 +00:00
$needs_address = true;
break;
}
}
return apply_filters( 'woocommerce_order_needs_shipping_address', $needs_address, $hide, $this );
}
/**
* Returns true if the order contains a downloadable product.
* @return bool
*/
public function has_downloadable_item() {
foreach ( $this->get_items() as $item ) {
if ( $item->is_type( 'line_item' ) && ( $product = $item->get_product() ) && $product->is_downloadable() && $product->has_file() ) {
return true;
}
}
return false;
}
/**
* Checks if an order needs payment, based on status and order total.
*
* @return bool
*/
public function needs_payment() {
$valid_order_statuses = apply_filters( 'woocommerce_valid_order_statuses_for_payment', array( 'pending', 'failed' ), $this );
return apply_filters( 'woocommerce_order_needs_payment', ( $this->has_status( $valid_order_statuses ) && $this->get_total() > 0 ), $this, $valid_order_statuses );
}
/*
|--------------------------------------------------------------------------
| URLs and Endpoints
|--------------------------------------------------------------------------
*/
/**
* Generates a URL so that a customer can pay for their (unpaid - pending) order. Pass 'true' for the checkout version which doesn't offer gateway choices.
*
* @param bool $on_checkout
* @return string
*/
public function get_checkout_payment_url( $on_checkout = false ) {
$pay_url = wc_get_endpoint_url( 'order-pay', $this->get_id(), wc_get_page_permalink( 'checkout' ) );
if ( 'yes' == get_option( 'woocommerce_force_ssl_checkout' ) || is_ssl() ) {
$pay_url = str_replace( 'http:', 'https:', $pay_url );
}
if ( $on_checkout ) {
$pay_url = add_query_arg( 'key', $this->get_order_key(), $pay_url );
} else {
$pay_url = add_query_arg( array( 'pay_for_order' => 'true', 'key' => $this->get_order_key() ), $pay_url );
}
return apply_filters( 'woocommerce_get_checkout_payment_url', $pay_url, $this );
}
/**
* Generates a URL for the thanks page (order received).
*
* @return string
*/
public function get_checkout_order_received_url() {
$order_received_url = wc_get_endpoint_url( 'order-received', $this->get_id(), wc_get_page_permalink( 'checkout' ) );
if ( 'yes' === get_option( 'woocommerce_force_ssl_checkout' ) || is_ssl() ) {
$order_received_url = str_replace( 'http:', 'https:', $order_received_url );
}
$order_received_url = add_query_arg( 'key', $this->get_order_key(), $order_received_url );
return apply_filters( 'woocommerce_get_checkout_order_received_url', $order_received_url, $this );
}
/**
* Generates a URL so that a customer can cancel their (unpaid - pending) order.
*
* @param string $redirect
*
* @return string
*/
public function get_cancel_order_url( $redirect = '' ) {
return apply_filters( 'woocommerce_get_cancel_order_url', wp_nonce_url( add_query_arg( array(
'cancel_order' => 'true',
'order' => $this->get_order_key(),
'order_id' => $this->get_id(),
'redirect' => $redirect
), $this->get_cancel_endpoint() ), 'woocommerce-cancel_order' ) );
}
/**
* Generates a raw (unescaped) cancel-order URL for use by payment gateways.
*
* @param string $redirect
*
* @return string The unescaped cancel-order URL.
*/
public function get_cancel_order_url_raw( $redirect = '' ) {
return apply_filters( 'woocommerce_get_cancel_order_url_raw', add_query_arg( array(
'cancel_order' => 'true',
'order' => $this->get_order_key(),
'order_id' => $this->get_id(),
'redirect' => $redirect,
'_wpnonce' => wp_create_nonce( 'woocommerce-cancel_order' )
), $this->get_cancel_endpoint() ) );
}
/**
* Helper method to return the cancel endpoint.
*
* @return string the cancel endpoint; either the cart page or the home page.
*/
public function get_cancel_endpoint() {
$cancel_endpoint = wc_get_page_permalink( 'cart' );
if ( ! $cancel_endpoint ) {
$cancel_endpoint = home_url();
}
if ( false === strpos( $cancel_endpoint, '?' ) ) {
$cancel_endpoint = trailingslashit( $cancel_endpoint );
}
return $cancel_endpoint;
}
/**
* Generates a URL to view an order from the my account page.
*
* @return string
*/
public function get_view_order_url() {
return apply_filters( 'woocommerce_get_view_order_url', wc_get_endpoint_url( 'view-order', $this->get_id(), wc_get_page_permalink( 'myaccount' ) ), $this );
}
/*
|--------------------------------------------------------------------------
| Order notes.
|--------------------------------------------------------------------------
*/
/**
Refund unit tests
2016-06-22 15:31:05 +00:00
* Adds a note (comment) to the order. Order must exist.
Order class
2016-06-21 19:06:39 +00:00
*
* @param string $note Note to add.
* @param int $is_customer_note (default: 0) Is this a note for the customer?
* @param bool added_by_user Was the note added by a user?
* @return int Comment ID.
*/
public function add_order_note( $note, $is_customer_note = 0, $added_by_user = false ) {
Refund unit tests
2016-06-22 15:31:05 +00:00
if ( ! $this->get_id() ) {
return 0;
}
Order class
2016-06-21 19:06:39 +00:00
if ( is_user_logged_in() && current_user_can( 'edit_shop_order', $this->get_id() ) && $added_by_user ) {
$user = get_user_by( 'id', get_current_user_id() );
$comment_author = $user->display_name;
$comment_author_email = $user->user_email;
} else {
$comment_author = __( 'WooCommerce', 'woocommerce' );
$comment_author_email = strtolower( __( 'WooCommerce', 'woocommerce' ) ) . '@';
$comment_author_email .= isset( $_SERVER['HTTP_HOST'] ) ? str_replace( 'www.', '', $_SERVER['HTTP_HOST'] ) : 'noreply.com';
$comment_author_email = sanitize_email( $comment_author_email );
}
$commentdata = apply_filters( 'woocommerce_new_order_note_data', array(
'comment_post_ID' => $this->get_id(),
'comment_author' => $comment_author,
'comment_author_email' => $comment_author_email,
'comment_author_url' => '',
'comment_content' => $note,
'comment_agent' => 'WooCommerce',
'comment_type' => 'order_note',
'comment_parent' => 0,
'comment_approved' => 1,
), array( 'order_id' => $this->get_id(), 'is_customer_note' => $is_customer_note ) );
$comment_id = wp_insert_comment( $commentdata );
if ( $is_customer_note ) {
add_comment_meta( $comment_id, 'is_customer_note', 1 );
do_action( 'woocommerce_new_customer_note', array( 'order_id' => $this->get_id(), 'customer_note' => $commentdata['comment_content'] ) );
}
return $comment_id;
}
/**
* List order notes (public) for the customer.
*
* @return array
*/
public function get_customer_order_notes() {
$notes = array();
$args = array(
'post_id' => $this->get_id(),
'approve' => 'approve',
'type' => ''
);
remove_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ) );
$comments = get_comments( $args );
foreach ( $comments as $comment ) {
if ( ! get_comment_meta( $comment->comment_ID, 'is_customer_note', true ) ) {
continue;
}
$comment->comment_content = make_clickable( $comment->comment_content );
$notes[] = $comment;
}
add_filter( 'comments_clauses', array( 'WC_Comments', 'exclude_order_comments' ) );
return $notes;
}
/*
|--------------------------------------------------------------------------
| Refunds
|--------------------------------------------------------------------------
*/
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get order refunds.
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
* @since 2.2
Show order refunds in totals Fixes #9589 @claudiosmweb
2015-11-30 15:25:48 +00:00
* @return array of WC_Order_Refund objects
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
*/
public function get_refunds() {
Refund unit tests
2016-06-22 15:31:05 +00:00
$this->refunds = wc_get_orders( array(
'type' => 'shop_order_refund',
'parent' => $this->get_id(),
'limit' => -1,
) );
Show refunded line items inline
2014-07-25 15:48:19 +00:00
return $this->refunds;
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
}
created method to get the total amount already refunded
2014-07-08 19:59:38 +00:00
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get amount already refunded.
created method to get the total amount already refunded
2014-07-08 19:59:38 +00:00
*
* @since 2.2
Scrutinizer Auto-Fixes This commit consists of patches automatically generated for this project on https://scrutinizer-ci.com
2015-11-05 16:05:03 +00:00
* @return string
created method to get the total amount already refunded
2014-07-08 19:59:38 +00:00
*/
public function get_total_refunded() {
global $wpdb;
$total = $wpdb->get_var( $wpdb->prepare( "
SELECT SUM( postmeta.meta_value )
FROM $wpdb->postmeta AS postmeta
Use order types where required
2014-07-11 11:43:42 +00:00
INNER JOIN $wpdb->posts AS posts ON ( posts.post_type = 'shop_order_refund' AND posts.post_parent = %d )
created method to get the total amount already refunded
2014-07-08 19:59:38 +00:00
WHERE postmeta.meta_key = '_refund_amount'
fixed order get_total_refunded() method
2014-07-21 02:48:23 +00:00
AND postmeta.post_id = posts.ID
Order class
2016-06-21 19:06:39 +00:00
", $this->get_id() ) );
created method to get the total amount already refunded
2014-07-08 19:59:38 +00:00
return $total;
}
Show refunded line items inline
2014-07-25 15:48:19 +00:00
Display taxes labels in order totals when order has refunded, closes #7229
2015-01-29 20:50:08 +00:00
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get the total tax refunded.
Display taxes labels in order totals when order has refunded, closes #7229
2015-01-29 20:50:08 +00:00
*
* @since 2.3
* @return float
*/
public function get_total_tax_refunded() {
global $wpdb;
$total = $wpdb->get_var( $wpdb->prepare( "
SELECT SUM( order_itemmeta.meta_value )
FROM {$wpdb->prefix}woocommerce_order_itemmeta AS order_itemmeta
INNER JOIN $wpdb->posts AS posts ON ( posts.post_type = 'shop_order_refund' AND posts.post_parent = %d )
INNER JOIN {$wpdb->prefix}woocommerce_order_items AS order_items ON ( order_items.order_id = posts.ID AND order_items.order_item_type = 'tax' )
WHERE order_itemmeta.order_item_id = order_items.order_item_id
AND order_itemmeta.meta_key IN ('tax_amount', 'shipping_tax_amount')
Order class
2016-06-21 19:06:39 +00:00
", $this->get_id() ) );
Display taxes labels in order totals when order has refunded, closes #7229
2015-01-29 20:50:08 +00:00
return abs( $total );
}
Show refunded total shipping and taxes Closes #8222
2015-06-01 10:06:11 +00:00
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get the total shipping refunded.
Show refunded total shipping and taxes Closes #8222
2015-06-01 10:06:11 +00:00
*
* @since 2.4
* @return float
*/
public function get_total_shipping_refunded() {
global $wpdb;
$total = $wpdb->get_var( $wpdb->prepare( "
SELECT SUM( order_itemmeta.meta_value )
FROM {$wpdb->prefix}woocommerce_order_itemmeta AS order_itemmeta
INNER JOIN $wpdb->posts AS posts ON ( posts.post_type = 'shop_order_refund' AND posts.post_parent = %d )
INNER JOIN {$wpdb->prefix}woocommerce_order_items AS order_items ON ( order_items.order_id = posts.ID AND order_items.order_item_type = 'shipping' )
WHERE order_itemmeta.order_item_id = order_items.order_item_id
AND order_itemmeta.meta_key IN ('cost')
Order class
2016-06-21 19:06:39 +00:00
", $this->get_id() ) );
Show refunded total shipping and taxes Closes #8222
2015-06-01 10:06:11 +00:00
return abs( $total );
}
Take item qty into consideration when refunding orders Fixes #8675
2015-07-29 12:13:41 +00:00
/**
* Gets the count of order items of a certain type that have been refunded.
* @since 2.4.0
* @param string $item_type
* @return string
*/
public function get_item_count_refunded( $item_type = '' ) {
if ( empty( $item_type ) ) {
$item_type = array( 'line_item' );
}
if ( ! is_array( $item_type ) ) {
$item_type = array( $item_type );
}
$count = 0;
foreach ( $this->get_refunds() as $refund ) {
foreach ( $refund->get_items( $item_type ) as $refunded_item ) {
qty -> quantity
2016-08-16 11:36:38 +00:00
$count += $refunded_item->get_quantity();
Take item qty into consideration when refunding orders Fixes #8675
2015-07-29 12:13:41 +00:00
}
}
return apply_filters( 'woocommerce_get_item_count_refunded', $count, $item_type, $this );
}
/**
* Get the total number of items refunded.
*
* @since 2.4.0
* @param string $item_type type of the item we're checking, if not a line_item
* @return integer
*/
public function get_total_qty_refunded( $item_type = 'line_item' ) {
$qty = 0;
foreach ( $this->get_refunds() as $refund ) {
foreach ( $refund->get_items( $item_type ) as $refunded_item ) {
qty -> quantity
2016-08-16 11:36:38 +00:00
$qty += $refunded_item->get_quantity();
Take item qty into consideration when refunding orders Fixes #8675
2015-07-29 12:13:41 +00:00
}
}
return $qty;
}
Show refunded line items inline
2014-07-25 15:48:19 +00:00
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get the refunded amount for a line item.
Line and indendation fix
2014-09-20 18:54:33 +00:00
*
Show refunded line items inline
2014-07-25 15:48:19 +00:00
* @param int $item_id ID of the item we're checking
* @param string $item_type type of the item we're checking, if not a line_item
scrutinizer patches
2014-09-07 23:37:55 +00:00
* @return integer
Show refunded line items inline
2014-07-25 15:48:19 +00:00
*/
public function get_qty_refunded_for_item( $item_id, $item_type = 'line_item' ) {
$qty = 0;
foreach ( $this->get_refunds() as $refund ) {
foreach ( $refund->get_items( $item_type ) as $refunded_item ) {
Order class
2016-06-21 19:06:39 +00:00
if ( absint( $refunded_item->get_meta( '_refunded_item_id' ) ) === $item_id ) {
qty -> quantity
2016-08-16 11:36:38 +00:00
$qty += $refunded_item->get_quantity();
Show refunded line items inline
2014-07-25 15:48:19 +00:00
}
}
}
return $qty;
}
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get the refunded amount for a line item.
Line and indendation fix
2014-09-20 18:54:33 +00:00
*
Show refunded line items inline
2014-07-25 15:48:19 +00:00
* @param int $item_id ID of the item we're checking
* @param string $item_type type of the item we're checking, if not a line_item
scrutinizer patches
2014-09-07 23:37:55 +00:00
* @return integer
Show refunded line items inline
2014-07-25 15:48:19 +00:00
*/
public function get_total_refunded_for_item( $item_id, $item_type = 'line_item' ) {
$total = 0;
foreach ( $this->get_refunds() as $refund ) {
foreach ( $refund->get_items( $item_type ) as $refunded_item ) {
Order class
2016-06-21 19:06:39 +00:00
if ( absint( $refunded_item->get_meta( '_refunded_item_id' ) ) === $item_id ) {
$total += $refunded_item->get_total();
Show refunded line items inline
2014-07-25 15:48:19 +00:00
}
}
}
return $total * -1;
}
/**
Fixed php docs standards
2015-11-03 13:31:20 +00:00
* Get the refunded amount for a line item.
Line and indendation fix
2014-09-20 18:54:33 +00:00
*
Show refunded line items inline
2014-07-25 15:48:19 +00:00
* @param int $item_id ID of the item we're checking
* @param int $tax_id ID of the tax we're checking
* @param string $item_type type of the item we're checking, if not a line_item
Scrutinizer Auto-Fixes This commit consists of patches automatically generated for this project on https://scrutinizer-ci.com
2015-11-05 16:05:03 +00:00
* @return double
Show refunded line items inline
2014-07-25 15:48:19 +00:00
*/
public function get_tax_refunded_for_item( $item_id, $tax_id, $item_type = 'line_item' ) {
$total = 0;
foreach ( $this->get_refunds() as $refund ) {
foreach ( $refund->get_items( $item_type ) as $refunded_item ) {
Order class
2016-06-21 19:06:39 +00:00
if ( absint( $refunded_item->get_meta( '_refunded_item_id' ) ) === $item_id ) {
$total += $refunded_item->get_total_tax();
Show refunded line items inline
2014-07-25 15:48:19 +00:00
}
}
}
Round tax total
2015-05-01 13:57:56 +00:00
return wc_round_tax_total( $total ) * -1;
Line and indendation fix
2014-09-20 18:54:33 +00:00
}
Display taxes labels in order totals when order has refunded, closes #7229
2015-01-29 20:50:08 +00:00
/**
* Get total tax refunded by rate ID.
*
* @param int $rate_id
*
* @return float
*/
public function get_total_tax_refunded_by_rate_id( $rate_id ) {
$total = 0;
foreach ( $this->get_refunds() as $refund ) {
foreach ( $refund->get_items( 'tax' ) as $refunded_item ) {
Order class
2016-06-21 19:06:39 +00:00
if ( absint( $refunded_item->get_rate_id() ) === $rate_id ) {
API get refunds
2016-08-22 12:04:57 +00:00
$total += abs( $refunded_item->get_tax_total() ) + abs( $refunded_item->get_shipping_tax_total() );
Display taxes labels in order totals when order has refunded, closes #7229
2015-01-29 20:50:08 +00:00
}
}
}
return $total;
}
Moved refund hooks to avoid emails after API refund failure
2015-10-06 13:43:33 +00:00
/**
* How much money is left to refund?
* @return string
*/
public function get_remaining_refund_amount() {
Round get_remaining_refund_amount Fixes #10060
2016-01-13 11:07:05 +00:00
return wc_format_decimal( $this->get_total() - $this->get_total_refunded(), wc_get_price_decimals() );
Moved refund hooks to avoid emails after API refund failure
2015-10-06 13:43:33 +00:00
}
/**
* How many items are left to refund?
* @return int
*/
public function get_remaining_refund_items() {
return absint( $this->get_item_count() - $this->get_item_count_refunded() );
}
created get_refunds() method for WC_Order class
2014-07-08 18:23:22 +00:00
}