2015-10-07 14:42:25 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* WooCommerce API Taxes Class
|
|
|
|
*
|
|
|
|
* Handles requests to the /taxes endpoint
|
|
|
|
*
|
|
|
|
* @author WooThemes
|
|
|
|
* @category API
|
|
|
|
* @package WooCommerce/API
|
|
|
|
* @since 2.5.0
|
|
|
|
*/
|
|
|
|
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
|
|
exit; // Exit if accessed directly
|
|
|
|
}
|
|
|
|
|
|
|
|
class WC_API_Taxes extends WC_API_Resource {
|
|
|
|
|
|
|
|
/** @var string $base the route base */
|
|
|
|
protected $base = '/taxes';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Register the routes for this class
|
|
|
|
*
|
|
|
|
* GET /taxes
|
|
|
|
* GET /taxes/count
|
|
|
|
* GET /taxes/<id>
|
|
|
|
*
|
|
|
|
* @since 2.1
|
|
|
|
* @param array $routes
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function register_routes( $routes ) {
|
|
|
|
|
|
|
|
# GET/POST /taxes
|
|
|
|
$routes[ $this->base ] = array(
|
2015-10-07 20:44:04 +00:00
|
|
|
array( array( $this, 'get_taxes' ), WC_API_Server::READABLE ),
|
2015-10-07 14:42:25 +00:00
|
|
|
array( array( $this, 'create_tax' ), WC_API_Server::CREATABLE | WC_API_Server::ACCEPT_DATA ),
|
|
|
|
);
|
|
|
|
|
|
|
|
# GET /taxes/count
|
|
|
|
$routes[ $this->base . '/count'] = array(
|
|
|
|
array( array( $this, 'get_taxes_count' ), WC_API_Server::READABLE ),
|
|
|
|
);
|
|
|
|
|
|
|
|
# GET/PUT/DELETE /taxes/<id>
|
|
|
|
$routes[ $this->base . '/(?P<id>\d+)' ] = array(
|
|
|
|
array( array( $this, 'get_tax' ), WC_API_Server::READABLE ),
|
|
|
|
array( array( $this, 'edit_tax' ), WC_API_SERVER::EDITABLE | WC_API_SERVER::ACCEPT_DATA ),
|
|
|
|
array( array( $this, 'delete_tax' ), WC_API_SERVER::DELETABLE ),
|
|
|
|
);
|
|
|
|
|
2015-10-07 20:44:04 +00:00
|
|
|
# POST|PUT /taxes/classes
|
|
|
|
$routes[ $this->base . '/classes' ] = array(
|
|
|
|
array( array( $this, 'get_tax_classes' ), WC_API_Server::READABLE ),
|
|
|
|
);
|
|
|
|
|
2015-10-07 14:42:25 +00:00
|
|
|
# POST|PUT /taxes/bulk
|
|
|
|
$routes[ $this->base . '/bulk' ] = array(
|
|
|
|
array( array( $this, 'bulk' ), WC_API_Server::EDITABLE | WC_API_Server::ACCEPT_DATA ),
|
|
|
|
);
|
|
|
|
|
|
|
|
return $routes;
|
|
|
|
}
|
|
|
|
|
2015-10-07 20:44:04 +00:00
|
|
|
/**
|
|
|
|
* Get all taxes
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param string $fields
|
|
|
|
* @param string $type
|
|
|
|
* @param array $filter
|
|
|
|
* @param int $page
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_taxes( $fields = null, $type = null, $filter = array(), $page = 1 ) {
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the tax for the given ID
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param int $id the tax ID
|
|
|
|
* @param string $fields fields to include in response
|
|
|
|
*
|
|
|
|
* @return array|WP_Error
|
|
|
|
*/
|
|
|
|
public function get_tax( $id, $fields = null ) {
|
|
|
|
global $wpdb;
|
|
|
|
|
|
|
|
try {
|
|
|
|
$id = absint( $id );
|
|
|
|
|
|
|
|
// Permissions check
|
|
|
|
if ( ! current_user_can( 'manage_woocommerce' ) ) {
|
|
|
|
throw new WC_API_Exception( 'woocommerce_api_user_cannot_read_tax_rate', __( 'You do not have permission to read tax rate', 'woocommerce' ), 401 );
|
|
|
|
}
|
|
|
|
|
|
|
|
// Get tax rate details
|
|
|
|
$tax = $wpdb->get_row( $wpdb->prepare( "
|
|
|
|
SELECT *
|
|
|
|
FROM {$wpdb->prefix}woocommerce_tax_rates
|
|
|
|
WHERE tax_rate_id = %d
|
|
|
|
", $id ) );
|
|
|
|
|
|
|
|
if ( is_wp_error( $tax ) || is_null( $tax ) ) {
|
|
|
|
throw new WC_API_Exception( 'woocommerce_api_invalid_tax_rate_id', __( 'A tax rate with the provided ID could not be found', 'woocommerce' ), 404 );
|
|
|
|
}
|
|
|
|
|
|
|
|
$tax_data = array(
|
|
|
|
'id' => $tax->tax_rate_id,
|
|
|
|
'country' => $tax->tax_rate_country,
|
|
|
|
'state' => $tax->tax_rate_state,
|
|
|
|
'postcode' => '',
|
|
|
|
'city' => '',
|
|
|
|
'rate' => $tax->tax_rate,
|
|
|
|
'name' => $tax->tax_rate_name,
|
|
|
|
'priority' => (int) $tax->tax_rate_priority,
|
|
|
|
'compound' => (bool) $tax->tax_rate_compound,
|
|
|
|
'shipping' => (bool) $tax->tax_rate_shipping,
|
|
|
|
'order' => (int) $tax->tax_rate_order,
|
|
|
|
'class' => $tax->tax_rate_class ? $tax->tax_rate_class : 'standard'
|
|
|
|
);
|
|
|
|
|
|
|
|
// Get locales from a tax rate
|
|
|
|
$locales = $wpdb->get_results( $wpdb->prepare( "
|
|
|
|
SELECT location_code, location_type
|
|
|
|
FROM {$wpdb->prefix}woocommerce_tax_rate_locations
|
|
|
|
WHERE tax_rate_id = %d
|
|
|
|
", $id ) );
|
|
|
|
|
|
|
|
if ( ! is_wp_error( $tax ) && ! is_null( $tax ) ) {
|
|
|
|
foreach ( $locales as $locale ) {
|
|
|
|
$tax_data[ $locale->location_type ] = $locale->location_code;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
return array( 'tax' => apply_filters( 'woocommerce_api_tax_response', $tax_data, $tax, $fields, $this ) );
|
|
|
|
} catch ( WC_API_Exception $e ) {
|
|
|
|
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2015-10-07 14:42:25 +00:00
|
|
|
/**
|
2015-10-07 20:02:06 +00:00
|
|
|
* Get all tax classes
|
2015-10-07 14:42:25 +00:00
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param string $fields
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
2015-10-07 20:02:06 +00:00
|
|
|
public function get_tax_classes( $fields = null ) {
|
|
|
|
try {
|
|
|
|
// Permissions check
|
|
|
|
if ( ! current_user_can( 'manage_woocommerce' ) ) {
|
|
|
|
throw new WC_API_Exception( 'woocommerce_api_user_cannot_read_tax_classes', __( 'You do not have permission to read tax classes', 'woocommerce' ), 401 );
|
|
|
|
}
|
2015-10-07 14:42:25 +00:00
|
|
|
|
2015-10-07 20:02:06 +00:00
|
|
|
$tax_classes = array();
|
|
|
|
|
|
|
|
$classes = WC_Tax::get_tax_classes();
|
|
|
|
|
|
|
|
foreach ( $classes as $class ) {
|
|
|
|
$tax_classes[] = apply_filters( 'woocommerce_api_tax_class_response', array(
|
|
|
|
'id' => sanitize_title( $class ),
|
|
|
|
'name' => $class
|
|
|
|
), $class, $fields, $this );
|
|
|
|
}
|
|
|
|
|
|
|
|
return array( 'tax_classes' => apply_filters( 'woocommerce_api_tax_classes_response', $tax_classes, $classes, $fields, $this ) );
|
|
|
|
} catch ( WC_API_Exception $e ) {
|
|
|
|
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
|
|
|
|
}
|
2015-10-07 14:42:25 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the total number of taxes
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param array $filter
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function get_taxes_count( $filter = array() ) {
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Create a tax
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function create_tax( $data ) {
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Edit a tax
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param int $id the tax ID
|
|
|
|
* @param array $data
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function edit_tax( $id, $data ) {
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Delete a tax
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param int $id the tax ID
|
|
|
|
* @param bool $force true to permanently delete tax, false to move to trash
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function delete_tax( $id, $force = false ) {
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Bulk update or insert taxes
|
|
|
|
* Accepts an array with taxes in the formats supported by
|
|
|
|
* WC_API_Taxes->create_tax() and WC_API_Taxes->edit_tax()
|
|
|
|
*
|
|
|
|
* @since 2.5.0
|
|
|
|
*
|
|
|
|
* @param array $data
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function bulk( $data ) {
|
|
|
|
|
|
|
|
}
|
|
|
|
}
|