'refund-item',
'plural' => 'refund-items',
'ajax' => false,
) );
$this->get_counts();
}
/**
* Get the base URL for the order item list table.
*
* @since 3.0
*
* @return string Base URL.
*/
public function get_base_url() {}
/**
* Retrieve the view types.
*
* @since 3.0
*
* @return array $views All the views available.
*/
public function get_views() {
return array();
}
/**
* Retrieve the table columns.
*
* @since 3.0
*
* @return array $columns Array of all the list table columns.
*/
public function get_columns() {
$columns = array(
'cb' => '' . edd_format_amount( $amount, true, $this->get_order_currency_decimals( $item->order_id ) ) . ' ';
if ( 'after' === $currency_pos ) {
$formatted_amount .= $symbol;
}
return $formatted_amount;
}
/**
* This private function returns the form input for refundable items,
* or amounts for items which have already been refunded.
*
* @param Order_Item $item The item object.
* @param string $column_name ID of the column being displayed.
* @param string $item_id Unique ID of the order item for the refund modal.
* @param string $object_type The item type.
* @return string
*/
private function get_adjustable_column( $item, $column_name, $item_id, $object_type ) {
if ( 'refunded' === $item->status ) {
return $this->format_currency( $item, $column_name, 0 );
}
$currency_pos = edd_get_option( 'currency_position', 'before' );
// Maximum amounts that can be refunded.
$refundable_amounts = $item->get_refundable_amounts();
$amount_remaining = array_key_exists( $column_name, $refundable_amounts ) ? $refundable_amounts[ $column_name ] : $item->{$column_name};
/*
* Original amount.
* For subtotals, we actually do subtotal minus discounts for simplicity so that the end user
* doesn't have to juggle that.
*/
$original_amount = $item->{$column_name};
if ( 'subtotal' === $column_name && ! empty( $item->discount ) ) {
$original_amount -= $item->discount;
}
ob_start();
?>
get_refundable_amounts();
$item_quantity = 'order_item' === $object_type ? $refundable_amounts['quantity'] : 1;
ob_start();
?>
currency );
} else {
$currency_decimals = 2;
}
}
return $currency_decimals;
}
/**
* Retrieves the currency symbol for a given order item.
*
* @param int $order_id
*
* @since 3.0
* @return string|null
*/
private function get_currency_symbol( $order_id ) {
static $symbol = null;
if ( is_null( $symbol ) ) {
$order = edd_get_order( $order_id );
if ( $order ) {
$symbol = edd_currency_symbol( $order->currency );
}
}
return $symbol;
}
/**
* Render the checkbox column
*
* @since 3.0
*
* @param Order_Item|Order_Adjustment $item Order Item or Order Adjustment object.
*
* @return string
*/
public function column_cb( $item ) {
$object_type = $this->get_object_type( $item );
$refundable_amounts = $item->get_refundable_amounts();
$total_remaining = array_key_exists( 'total', $refundable_amounts ) ? floatval( $refundable_amounts['total'] ) : 0.00;
if ( 'refunded' !== $item->status && 0.00 != $total_remaining ) {
return sprintf(
'%3$s ',
/*$1%s*/
'refund_' . esc_attr( $object_type ),
/*$2%s*/
esc_attr( $item->id ),
/* translators: product name */
esc_html( sprintf( __( 'Select %s', 'easy-digital-downloads' ), $this->get_item_display_name( $item ) ) )
);
}
return '';
}
/**
* Render the Name Column
*
* @since 3.0
*
* @param Order_Item|Order_Adjustment $item Order Item object.
*
* @return string Data shown in the Name column
*/
public function column_name( $item ) {
$checkbox_id = 'refund_' . $this->get_object_type( $item ) . '-' . $item->id;
$display_name = esc_html( $this->get_item_display_name( $item ) );
$status_label = ! empty( $item->status ) && 'complete' !== $item->status ? ' — ' . edd_get_status_label( $item->status ) : '';
if ( 'refunded' === $item->status ) {
return '' . $display_name . ' ' . esc_html( $status_label );
}
return '' . $display_name . ' ' . $status_label;
}
/**
* Message to be displayed when there are no items
*
* @since 3.0
*/
public function no_items() {
esc_html_e( 'No items found.', 'easy-digital-downloads' );
}
/**
* Retrieve the bulk actions
*
* @since 3.0
* @return array $actions Array of the bulk actions
*/
public function get_bulk_actions() { return array(); }
/**
* Process the bulk actions
*
* @since 3.0
*/
public function process_bulk_action() {}
/**
* Retrieve the order_item code counts
*
* @todo Fees aren't included in this count, but where does this actually get used anyway?
*
* @since 3.0
*/
public function get_counts() {
// Maybe retrieve counts.
if ( ! edd_is_add_order_page() ) {
// Check for an order ID
$order_id = ! empty( $_POST['order_id'] )
? absint( $_POST['order_id'] ) // WPCS: CSRF ok.
: 0;
// Get counts
$this->counts = edd_get_order_item_counts( array(
'order_id' => $order_id,
) );
}
}
/**
* Retrieve all order data to be shown on the refund table.
* This includes order items and order adjustments.
*
* @since 3.0
* @return Order[]|Order_Adjustment[] All order items and order adjustments associated with the current order.
*/
public function get_data() {
$order = $this->get_order();
if ( empty( $order ) ) {
return array();
}
// Get order items.
$order_items = edd_get_order_items( array(
'order_id' => $order->id,
'number' => 999,
) );
// Get order fees
$order_fees = $order->get_fees();
// Get order credits.
$credits = edd_get_order_adjustments( array(
'object_id' => $order->id,
'object_type' => 'order',
'type' => 'credit',
) );
return array_merge( $order_items, $order_fees, $credits );
}
/**
* Setup the final data for the table
*
* @since 3.0
*/
public function prepare_items() {
$this->_column_headers = array(
$this->get_columns(),
array(),
$this->get_sortable_columns(),
);
$this->items = $this->get_data();
}
/**
* Generates content for a single row of the table
*
* @since 3.0
*
* @param Order_Item|Order_Adjustment $item Order item object.
*/
public function single_row( $item ) {
$is_adjustment = $item instanceof Order_Adjustment;
$item_class = $is_adjustment ? $item->object_id : $item->order_id;
// Status.
$classes = array_map( 'sanitize_html_class', array(
'order-' . $item_class,
$item->status,
'refunditem',
) );
// Turn into a string.
$class = implode( ' ', $classes );
$item_id = $this->get_item_unique_id( $item );
$is_credit = $is_adjustment && 'credit' === $item->type;
?>
="id ); ?>" class="">
single_row_columns( $item ); ?>
_args['singular'];
wp_nonce_field( 'edd_process_refund', 'edd_process_refund' );
$this->screen->render_screen_reader_content( 'heading_list' );
?>
print_column_headers(); ?>
>
display_rows_or_placeholder(); ?>
get_order() );
$this->display_tablenav( 'bottom' );
?>
items as $item ) {
if ( empty( $order_id ) ) {
$order_id = $item->order_id;
}
$this->single_row( $item );
}
$currency_symbol = $this->get_currency_symbol( $order_id );
// Now we need to add the columns for the totals.
?>
%1$s%2$s %3$s ',
$before, // phpcs:ignore
esc_attr( $amount ),
$after // phpcs:ignore
);
?>
get_order();
if ( $order && $order->get_tax_rate() ) :
?>
%2$s %3$s',
$before, // phpcs:ignore
esc_attr( $amount ),
$after // phpcs:ignore
);
?>
%2$s %3$s',
$before, // phpcs:ignore
esc_attr( $amount ),
$after // phpcs:ignore
);
?>