AdditionalPayments.php
1 year ago
Appearance.php
2 years ago
CustomizeStore.php
3 weeks ago
ExperimentalShippingRecommendation.php
3 weeks ago
ExtendStore.php
1 year ago
GetMobileApp.php
3 years ago
LaunchYourStore.php
3 weeks ago
Marketing.php
3 weeks ago
Payments.php
3 weeks ago
Products.php
3 weeks ago
ReviewShippingOptions.php
4 years ago
Shipping.php
3 weeks ago
StoreCreation.php
4 years ago
StoreDetails.php
3 weeks ago
Tax.php
3 weeks ago
TourInAppMarketplace.php
2 years ago
WooCommercePayments.php
3 weeks ago
Tax.php
287 lines
| 1 | <?php |
| 2 | |
| 3 | namespace Automattic\WooCommerce\Admin\Features\OnboardingTasks\Tasks; |
| 4 | |
| 5 | use Automattic\WooCommerce\Admin\API\Reports\Taxes\Stats\DataStore as TaxDataStore; |
| 6 | use Automattic\WooCommerce\Admin\Features\Features; |
| 7 | use Automattic\WooCommerce\Admin\Features\OnboardingTasks\Task; |
| 8 | use Automattic\WooCommerce\Admin\PluginsHelper; |
| 9 | use Automattic\WooCommerce\Internal\Admin\WCAdminAssets; |
| 10 | |
| 11 | /** |
| 12 | * Tax Task |
| 13 | */ |
| 14 | class Tax extends Task { |
| 15 | |
| 16 | private const TAX_RATE_EXISTS_CACHE_KEY = 'woocommerce_onboarding_task_tax_rates_exist'; |
| 17 | |
| 18 | /** |
| 19 | * Used to cache is_complete() method result. |
| 20 | * |
| 21 | * @var null |
| 22 | */ |
| 23 | private $is_complete_result = null; |
| 24 | |
| 25 | /** |
| 26 | * Constructor |
| 27 | * |
| 28 | * @param TaskList $task_list Parent task list. |
| 29 | */ |
| 30 | public function __construct( $task_list ) { |
| 31 | parent::__construct( $task_list ); |
| 32 | add_action( 'admin_enqueue_scripts', array( $this, 'possibly_add_return_notice_script' ) ); |
| 33 | add_action( 'woocommerce_tax_rate_added', array( $this, 'on_tax_rate_added' ) ); |
| 34 | add_action( 'woocommerce_tax_rate_deleted', array( $this, 'on_tax_rate_deleted' ) ); |
| 35 | } |
| 36 | |
| 37 | /** |
| 38 | * Adds a return to task list notice when completing the task. |
| 39 | */ |
| 40 | public function possibly_add_return_notice_script() { |
| 41 | $page = isset( $_GET['page'] ) ? $_GET['page'] : ''; // phpcs:ignore csrf ok, sanitization ok. |
| 42 | $tab = isset( $_GET['tab'] ) ? $_GET['tab'] : ''; // phpcs:ignore csrf ok, sanitization ok. |
| 43 | |
| 44 | if ( $page !== 'wc-settings' || $tab !== 'tax' ) { |
| 45 | return; |
| 46 | } |
| 47 | |
| 48 | if ( ! $this->is_active() || $this->is_complete() ) { |
| 49 | return; |
| 50 | } |
| 51 | |
| 52 | WCAdminAssets::register_script( 'wp-admin-scripts', 'onboarding-tax-notice', true ); |
| 53 | } |
| 54 | |
| 55 | /** |
| 56 | * ID. |
| 57 | * |
| 58 | * @return string |
| 59 | */ |
| 60 | public function get_id() { |
| 61 | return 'tax'; |
| 62 | } |
| 63 | |
| 64 | /** |
| 65 | * Contextual image URL. |
| 66 | * |
| 67 | * @return string |
| 68 | */ |
| 69 | public function get_image_url() { |
| 70 | return WC()->plugin_url() . '/assets/images/task_list/tax-illustration.svg'; |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Alt text for the contextual image. |
| 75 | * |
| 76 | * @return string |
| 77 | */ |
| 78 | public function get_image_alt() { |
| 79 | return __( 'Tax illustration', 'woocommerce' ); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * Title. |
| 84 | * |
| 85 | * @return string |
| 86 | */ |
| 87 | public function get_title() { |
| 88 | return __( 'Collect sales tax', 'woocommerce' ); |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Content. |
| 93 | * |
| 94 | * @return string |
| 95 | */ |
| 96 | public function get_content() { |
| 97 | return self::can_use_automated_taxes() |
| 98 | ? __( |
| 99 | 'Good news! WooCommerce Tax can automate your sales tax calculations for you.', |
| 100 | 'woocommerce' |
| 101 | ) |
| 102 | : __( |
| 103 | 'Set your store location and configure tax rate settings.', |
| 104 | 'woocommerce' |
| 105 | ); |
| 106 | } |
| 107 | |
| 108 | /** |
| 109 | * Time. |
| 110 | * |
| 111 | * @return string |
| 112 | */ |
| 113 | public function get_time() { |
| 114 | return __( '1 minute', 'woocommerce' ); |
| 115 | } |
| 116 | |
| 117 | /** |
| 118 | * Action label. |
| 119 | * |
| 120 | * @return string |
| 121 | */ |
| 122 | public function get_action_label() { |
| 123 | return self::can_use_automated_taxes() |
| 124 | ? __( 'Yes please', 'woocommerce' ) |
| 125 | : __( "Let's go", 'woocommerce' ); |
| 126 | } |
| 127 | |
| 128 | /** |
| 129 | * Task completion. |
| 130 | * |
| 131 | * @return bool |
| 132 | */ |
| 133 | public function is_complete() { |
| 134 | if ( $this->is_complete_result === null ) { |
| 135 | $wc_connect_taxes_enabled = get_option( 'wc_connect_taxes_enabled' ); |
| 136 | $is_wc_connect_taxes_enabled = ( $wc_connect_taxes_enabled === 'yes' ) || ( $wc_connect_taxes_enabled === true ); // seems that in some places boolean is used, and other places 'yes' | 'no' is used |
| 137 | |
| 138 | // phpcs:ignore WooCommerce.Commenting.CommentHooks.MissingHookComment -- We will replace this with a formal system by WC 9.6 so lets not advertise it yet. |
| 139 | $third_party_complete = apply_filters( 'woocommerce_admin_third_party_tax_setup_complete', false ); |
| 140 | |
| 141 | /** |
| 142 | * Ideally we would check against `wc_tax_enabled()` instead of `false !== get_option( 'woocommerce_no_sales_tax' )`, |
| 143 | * however, tax is disabled by default making this task complete by default if we use it. If we change taxes |
| 144 | * to be enabled by default in the future, this can be updated to check against `wc_tax_enabled()` which is |
| 145 | * more accurate for this evaluation. |
| 146 | */ |
| 147 | $this->is_complete_result = $is_wc_connect_taxes_enabled || |
| 148 | $third_party_complete || |
| 149 | false !== get_option( 'woocommerce_no_sales_tax' ) || |
| 150 | $this->has_existing_tax_rates(); |
| 151 | } |
| 152 | |
| 153 | return $this->is_complete_result; |
| 154 | } |
| 155 | |
| 156 | /** |
| 157 | * Determines if a tax rate exists in the database. Result is indefinitely cached. |
| 158 | * |
| 159 | * @return bool |
| 160 | */ |
| 161 | private function has_existing_tax_rates() { |
| 162 | global $wpdb; |
| 163 | $has_existing_tax_rates = wp_cache_get( self::TAX_RATE_EXISTS_CACHE_KEY ); |
| 164 | if ( false === $has_existing_tax_rates ) { |
| 165 | $rate_exists = (bool) $wpdb->get_var( "SELECT 1 FROM {$wpdb->prefix}woocommerce_tax_rates limit 1" ); |
| 166 | $has_existing_tax_rates = $rate_exists ? 'yes' : 'no'; |
| 167 | wp_cache_set( self::TAX_RATE_EXISTS_CACHE_KEY, $has_existing_tax_rates ); |
| 168 | } |
| 169 | |
| 170 | return 'yes' === $has_existing_tax_rates; |
| 171 | } |
| 172 | |
| 173 | /** |
| 174 | * Marks the task as actioned any time a tax rate has been added. Called from the `woocommerce_tax_rate_added` hook. |
| 175 | * |
| 176 | * @return void |
| 177 | */ |
| 178 | public function on_tax_rate_added() { |
| 179 | $this->mark_actioned(); |
| 180 | wp_cache_set( self::TAX_RATE_EXISTS_CACHE_KEY, 'yes' ); |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * Clears the tax rate exists cache when a tax rate is deleted. Called from the `woocommerce_tax_rate_added` hook. |
| 185 | * |
| 186 | * @return void |
| 187 | */ |
| 188 | public function on_tax_rate_deleted() { |
| 189 | wp_cache_delete( self::TAX_RATE_EXISTS_CACHE_KEY ); |
| 190 | } |
| 191 | |
| 192 | /** |
| 193 | * Additional data. |
| 194 | * |
| 195 | * @return array |
| 196 | */ |
| 197 | public function get_additional_data() { |
| 198 | return array( |
| 199 | 'avalara_activated' => PluginsHelper::is_plugin_active( 'woocommerce-avatax' ), |
| 200 | 'tax_jar_activated' => class_exists( 'WC_Taxjar' ), |
| 201 | 'stripe_tax_activated' => PluginsHelper::is_plugin_active( 'stripe-tax-for-woocommerce' ), |
| 202 | 'woocommerce_tax_activated' => PluginsHelper::is_plugin_active( 'woocommerce-tax' ), |
| 203 | 'woocommerce_shipping_activated' => PluginsHelper::is_plugin_active( 'woocommerce-shipping' ), |
| 204 | 'woocommerce_tax_countries' => self::get_automated_support_countries(), |
| 205 | 'stripe_tax_countries' => self::get_stripe_tax_support_countries(), |
| 206 | ); |
| 207 | } |
| 208 | |
| 209 | /** |
| 210 | * Check if the store has any enabled gateways. |
| 211 | * |
| 212 | * @return bool |
| 213 | */ |
| 214 | public static function can_use_automated_taxes() { |
| 215 | if ( ! class_exists( 'WC_Taxjar' ) ) { |
| 216 | return false; |
| 217 | } |
| 218 | |
| 219 | return in_array( WC()->countries->get_base_country(), self::get_automated_support_countries(), true ); |
| 220 | } |
| 221 | |
| 222 | /** |
| 223 | * Get an array of countries that support automated tax. |
| 224 | * |
| 225 | * @return array |
| 226 | */ |
| 227 | public static function get_automated_support_countries() { |
| 228 | // https://developers.taxjar.com/api/reference/#countries . |
| 229 | $tax_supported_countries = array_merge( |
| 230 | array( 'US', 'CA', 'AU', 'GB' ), |
| 231 | WC()->countries->get_european_union_countries() |
| 232 | ); |
| 233 | |
| 234 | return $tax_supported_countries; |
| 235 | } |
| 236 | |
| 237 | /** |
| 238 | * Get an array of countries that support Stripe tax. |
| 239 | * |
| 240 | * @return array |
| 241 | */ |
| 242 | private static function get_stripe_tax_support_countries() { |
| 243 | // https://docs.stripe.com/tax/supported-countries#supported-countries accurate as of 2024-08-26. |
| 244 | // countries with remote sales not included. |
| 245 | return array( |
| 246 | 'AU', |
| 247 | 'AT', |
| 248 | 'BE', |
| 249 | 'BG', |
| 250 | 'CA', |
| 251 | 'HR', |
| 252 | 'CY', |
| 253 | 'CZ', |
| 254 | 'DK', |
| 255 | 'EE', |
| 256 | 'FI', |
| 257 | 'FR', |
| 258 | 'DE', |
| 259 | 'GR', |
| 260 | 'HK', |
| 261 | 'HU', |
| 262 | 'IE', |
| 263 | 'IT', |
| 264 | 'JP', |
| 265 | 'LV', |
| 266 | 'LT', |
| 267 | 'LU', |
| 268 | 'MT', |
| 269 | 'NL', |
| 270 | 'NZ', |
| 271 | 'NO', |
| 272 | 'PL', |
| 273 | 'PT', |
| 274 | 'RO', |
| 275 | 'SG', |
| 276 | 'SK', |
| 277 | 'SI', |
| 278 | 'ES', |
| 279 | 'SE', |
| 280 | 'CH', |
| 281 | 'AE', |
| 282 | 'GB', |
| 283 | 'US', |
| 284 | ); |
| 285 | } |
| 286 | } |
| 287 |