WC_Report_Taxes_By_Code

WC_Report_Taxes_By_Code

Contents

Description Description

Source Source

File: includes/admin/reports/class-wc-report-taxes-by-code.php

18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
class WC_Report_Taxes_By_Code extends WC_Admin_Report {
 
    /**
     * Get the legend for the main chart sidebar.
     *
     * @return array
     */
    public function get_chart_legend() {
        return array();
    }
 
    /**
     * Output an export link.
     */
    public function get_export_button() {
 
        $current_range = ! empty( $_GET['range'] ) ? sanitize_text_field( wp_unslash( $_GET['range'] ) ) : 'last_month';
        ?>
        <a
            href="#"
            download="report-<?php echo esc_attr( $current_range ); ?>-<?php echo esc_attr( date_i18n( 'Y-m-d', current_time( 'timestamp' ) ) ); ?>.csv"
            class="export_csv"
            data-export="table"
        >
            <?php esc_html_e( 'Export CSV', 'woocommerce' ); ?>
        </a>
        <?php
    }
 
    /**
     * Output the report.
     */
    public function output_report() {
 
        $ranges = array(
            'year'       => __( 'Year', 'woocommerce' ),
            'last_month' => __( 'Last month', 'woocommerce' ),
            'month'      => __( 'This month', 'woocommerce' ),
        );
 
        $current_range = ! empty( $_GET['range'] ) ? sanitize_text_field( wp_unslash( $_GET['range'] ) ) : 'last_month';
 
        if ( ! in_array( $current_range, array( 'custom', 'year', 'last_month', 'month', '7day' ) ) ) {
            $current_range = 'last_month';
        }
 
        $this->check_current_range_nonce( $current_range );
        $this->calculate_current_range( $current_range );
 
        $hide_sidebar = true;
 
        include WC()->plugin_path() . '/includes/admin/views/html-report-by-date.php';
    }
 
    /**
     * Get the main chart.
     */
    public function get_main_chart() {
        global $wpdb;
 
        $query_data = array(
            'order_item_name'     => array(
                'type'     => 'order_item',
                'function' => '',
                'name'     => 'tax_rate',
            ),
            'tax_amount'          => array(
                'type'            => 'order_item_meta',
                'order_item_type' => 'tax',
                'function'        => '',
                'name'            => 'tax_amount',
            ),
            'shipping_tax_amount' => array(
                'type'            => 'order_item_meta',
                'order_item_type' => 'tax',
                'function'        => '',
                'name'            => 'shipping_tax_amount',
            ),
            'rate_id'             => array(
                'type'            => 'order_item_meta',
                'order_item_type' => 'tax',
                'function'        => '',
                'name'            => 'rate_id',
            ),
            'ID'                  => array(
                'type'     => 'post_data',
                'function' => '',
                'name'     => 'post_id',
            ),
        );
 
        $query_where = array(
            array(
                'key'      => 'order_item_type',
                'value'    => 'tax',
                'operator' => '=',
            ),
            array(
                'key'      => 'order_item_name',
                'value'    => '',
                'operator' => '!=',
            ),
        );
 
        // We exclude on-hold orders as they are still pending payment.
        $tax_rows_orders = $this->get_order_report_data(
            array(
                'data'         => $query_data,
                'where'        => $query_where,
                'order_by'     => 'posts.post_date ASC',
                'query_type'   => 'get_results',
                'filter_range' => true,
                'order_types'  => wc_get_order_types( 'sales-reports' ),
                'order_status' => array( 'completed', 'processing', 'refunded' ),
            )
        );
 
        $tax_rows_partial_refunds = $this->get_order_report_data(
            array(
                'data'                => $query_data,
                'where'               => $query_where,
                'order_by'            => 'posts.post_date ASC',
                'query_type'          => 'get_results',
                'filter_range'        => true,
                'order_types'         => array( 'shop_order_refund' ),
                'parent_order_status' => array( 'completed', 'processing' ), // Partial refunds inside refunded orders should be ignored.
            )
        );
 
        $tax_rows_full_refunds = $this->get_order_report_data(
            array(
                'data'                => $query_data,
                'where'               => $query_where,
                'order_by'            => 'posts.post_date ASC',
                'query_type'          => 'get_results',
                'filter_range'        => true,
                'order_types'         => array( 'shop_order_refund' ),
                'parent_order_status' => array( 'refunded' ),
            )
        );
 
        // Merge.
        $tax_rows = array();
 
        foreach ( $tax_rows_orders + $tax_rows_partial_refunds as $tax_row ) {
            $key                                    = $tax_row->rate_id;
            $tax_rows[ $key ]                       = isset( $tax_rows[ $key ] ) ? $tax_rows[ $key ] : (object) array(
                'tax_amount'          => 0,
                'shipping_tax_amount' => 0,
                'total_orders'        => 0,
            );
            $tax_rows[ $key ]->total_orders        += 1;
            $tax_rows[ $key ]->tax_rate             = $tax_row->tax_rate;
            $tax_rows[ $key ]->tax_amount          += wc_round_tax_total( $tax_row->tax_amount );
            $tax_rows[ $key ]->shipping_tax_amount += wc_round_tax_total( $tax_row->shipping_tax_amount );
        }
 
        foreach ( $tax_rows_full_refunds as $tax_row ) {
            $key                                    = $tax_row->rate_id;
            $tax_rows[ $key ]                       = isset( $tax_rows[ $key ] ) ? $tax_rows[ $key ] : (object) array(
                'tax_amount'          => 0,
                'shipping_tax_amount' => 0,
                'total_orders'        => 0,
            );
            $tax_rows[ $key ]->tax_rate             = $tax_row->tax_rate;
            $tax_rows[ $key ]->tax_amount          += wc_round_tax_total( $tax_row->tax_amount );
            $tax_rows[ $key ]->shipping_tax_amount += wc_round_tax_total( $tax_row->shipping_tax_amount );
        }
        ?>
        <table class="widefat">
            <thead>
                <tr>
                    <th><?php esc_html_e( 'Tax', 'woocommerce' ); ?></th>
                    <th><?php esc_html_e( 'Rate', 'woocommerce' ); ?></th>
                    <th class="total_row"><?php esc_html_e( 'Number of orders', 'woocommerce' ); ?></th>
                    <th class="total_row"><?php esc_html_e( 'Tax amount', 'woocommerce' ); ?> <?php echo wc_help_tip( __( 'This is the sum of the "Tax rows" tax amount within your orders.', 'woocommerce' ) ); ?></th>
                    <th class="total_row"><?php esc_html_e( 'Shipping tax amount', 'woocommerce' ); ?> <?php echo wc_help_tip( __( 'This is the sum of the "Tax rows" shipping tax amount within your orders.', 'woocommerce' ) ); ?></th>
                    <th class="total_row"><?php esc_html_e( 'Total tax', 'woocommerce' ); ?> <?php echo wc_help_tip( __( 'This is the total tax for the rate (shipping tax + product tax).', 'woocommerce' ) ); ?></th>
                </tr>
            </thead>
            <?php if ( ! empty( $tax_rows ) ) : ?>
                <tbody>
                    <?php
                    foreach ( $tax_rows as $rate_id => $tax_row ) {
                        $rate = $wpdb->get_var( $wpdb->prepare( "SELECT tax_rate FROM {$wpdb->prefix}woocommerce_tax_rates WHERE tax_rate_id = %d;", $rate_id ) );
                        ?>
                        <tr>
                            <th scope="row"><?php echo wp_kses_post( apply_filters( 'woocommerce_reports_taxes_tax_rate', $tax_row->tax_rate, $rate_id, $tax_row ) ); ?></th>
                            <td><?php echo wp_kses_post( apply_filters( 'woocommerce_reports_taxes_rate', $rate, $rate_id, $tax_row ) ); ?>%</td>
                            <td class="total_row"><?php echo esc_html( $tax_row->total_orders ); ?></td>
                            <td class="total_row"><?php echo wc_price( $tax_row->tax_amount ); // phpcs:ignore ?></td>
                            <td class="total_row"><?php echo wc_price( $tax_row->shipping_tax_amount ); // phpcs:ignore ?></td>
                            <td class="total_row"><?php echo wc_price( $tax_row->tax_amount + $tax_row->shipping_tax_amount ); // phpcs:ignore ?></td>
                        </tr>
                        <?php
                    }
                    ?>
                </tbody>
                <tfoot>
                    <tr>
                        <th scope="row" colspan="3"><?php esc_html_e( 'Total', 'woocommerce' ); ?></th>
                        <th class="total_row"><?php echo wc_price( wc_round_tax_total( array_sum( wp_list_pluck( (array) $tax_rows, 'tax_amount' ) ) ) ); // phpcs:ignore ?></th>
                        <th class="total_row"><?php echo wc_price( wc_round_tax_total( array_sum( wp_list_pluck( (array) $tax_rows, 'shipping_tax_amount' ) ) ) ); // phpcs:ignore ?></th>
                        <th class="total_row"><strong><?php echo wc_price( wc_round_tax_total( array_sum( wp_list_pluck( (array) $tax_rows, 'tax_amount' ) ) + array_sum( wp_list_pluck( (array) $tax_rows, 'shipping_tax_amount' ) ) ) ); // phpcs:ignore ?></strong></th>
                    </tr>
                </tfoot>
            <?php else : ?>
                <tbody>
                    <tr>
                        <td><?php esc_html_e( 'No taxes found in this period', 'woocommerce' ); ?></td>
                    </tr>
                </tbody>
            <?php endif; ?>
        </table>
        <?php
    }
}

Expand full source code Collapse full source code

Top ↑

Top ↑

Methods Methods

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.