EuVatApi.php
174 lines
| 1 | <?php |
| 2 | |
| 3 | namespace ProfilePress\Core\Membership\Services\EUVATChecker; |
| 4 | |
| 5 | |
| 6 | use ProfilePress\Core\Membership\Services\TaxService; |
| 7 | |
| 8 | class EuVatApi |
| 9 | { |
| 10 | const API_URL = 'https://ec.europa.eu/taxation_customs/vies/checkVatService.wsdl'; |
| 11 | |
| 12 | /** |
| 13 | * Check a VAT number against the supplied country code. |
| 14 | * |
| 15 | * @param string $vat_number The VAT number to check. |
| 16 | * @param string $country_code The country code. |
| 17 | * |
| 18 | * @return EUVATAPIResponse |
| 19 | */ |
| 20 | public static function check_vat($vat_number, $country_code) |
| 21 | { |
| 22 | $result = new EuVatApiResponse($vat_number, $country_code); |
| 23 | |
| 24 | if ( ! $vat_number) { |
| 25 | $result->error = EuVatApiResponse::NO_VAT_NUMBER; |
| 26 | |
| 27 | return $result; |
| 28 | } |
| 29 | |
| 30 | if ( ! $country_code) { |
| 31 | |
| 32 | $result->error = EuVatApiResponse::NO_COUNTRY_CODE; |
| 33 | |
| 34 | return $result; |
| 35 | } |
| 36 | |
| 37 | // Check country is in the EU. |
| 38 | if ( ! in_array($country_code, self::get_eu_countries(), true)) { |
| 39 | $result->error = EuVatApiResponse::INVALID_COUNTRY_CODE; |
| 40 | |
| 41 | return $result; |
| 42 | } |
| 43 | |
| 44 | // Sanitize VAT number (remove white space, etc). |
| 45 | $vat_number = str_replace([' ', '.', '-'], '', strtoupper($vat_number)); |
| 46 | |
| 47 | // Check prefix. |
| 48 | $vat_prefix_for_country = self::get_vat_number_prefix($country_code); |
| 49 | $vat_number_prefix = substr($vat_number, 0, 2); |
| 50 | |
| 51 | // If prefix is a valid VAT prefix but doesn't match selected country, return an error. |
| 52 | if ($vat_prefix_for_country !== $vat_number_prefix) { |
| 53 | $result->error = EuVatApiResponse::VAT_NUMBER_INVALID_FOR_COUNTRY; |
| 54 | |
| 55 | return $result; |
| 56 | } |
| 57 | |
| 58 | // Strip country code if VAT number starts with it. |
| 59 | if ($vat_prefix_for_country === $vat_number_prefix) { |
| 60 | $vat_number = substr($vat_number, 2); |
| 61 | } |
| 62 | |
| 63 | $result = self::vies_request($result, $vat_number, $country_code, $vat_prefix_for_country); |
| 64 | |
| 65 | // Catch all for invalid VAT number if no error set. |
| 66 | if ( ! $result->is_valid() && empty($result->error)) { |
| 67 | $result->error = EuVatApiResponse::INVALID_VAT_NUMBER; |
| 68 | } |
| 69 | |
| 70 | return $result; |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * Makes a request to the VIES API |
| 75 | * |
| 76 | * @param EuVatApiResponse $result |
| 77 | * @param string $vat_number |
| 78 | * @param string $country_code |
| 79 | * @param string $vat_prefix_for_country |
| 80 | * |
| 81 | * @return EuVatApiResponse |
| 82 | */ |
| 83 | private static function vies_request($result, $vat_number, $country_code, $vat_prefix_for_country) |
| 84 | { |
| 85 | try { |
| 86 | |
| 87 | $cache_key = md5('ppress_eu_vat_vies_' . $country_code . '_' . $vat_number . '_' . $vat_prefix_for_country); |
| 88 | |
| 89 | $response = get_transient($cache_key); |
| 90 | |
| 91 | if (empty($response) || false === $response) { |
| 92 | |
| 93 | // Create the SOAP client for VIES API call. |
| 94 | $client = new \SoapClient(self::API_URL); |
| 95 | |
| 96 | // API parameters. |
| 97 | $parameters = [ |
| 98 | 'countryCode' => $vat_prefix_for_country, |
| 99 | 'vatNumber' => $vat_number, |
| 100 | ]; |
| 101 | |
| 102 | // Fetch response. |
| 103 | $response = $client->checkVat($parameters); |
| 104 | |
| 105 | // Save response for a day |
| 106 | set_transient($cache_key, $response, DAY_IN_SECONDS); |
| 107 | } |
| 108 | |
| 109 | $result->valid = filter_var($response->valid, FILTER_VALIDATE_BOOLEAN); |
| 110 | |
| 111 | // 3 dashes are returned in name and address field if not found |
| 112 | if ($response->name && '---' !== $response->name) { |
| 113 | $result->name = $response->name; |
| 114 | } |
| 115 | |
| 116 | if ($response->address && '---' !== $response->address) { |
| 117 | $address = explode("\n", $response->address); |
| 118 | |
| 119 | // Add country code to address |
| 120 | $address[] = $country_code; |
| 121 | |
| 122 | $result->address = implode(', ', array_filter($address)); |
| 123 | } |
| 124 | } catch (\Exception $exception) { |
| 125 | // Handle error. |
| 126 | $result->error = $exception->getMessage(); |
| 127 | } |
| 128 | |
| 129 | // Translate common errors. |
| 130 | if ('MS_UNAVAILABLE' === $result->error) { |
| 131 | $result->error = EuVatApiResponse::API_ERROR; |
| 132 | } elseif ('INVALID_INPUT' === $result->error) { |
| 133 | $result->error = EuVatApiResponse::INVALID_INPUT; |
| 134 | } |
| 135 | |
| 136 | return $result; |
| 137 | } |
| 138 | |
| 139 | /** |
| 140 | * Return the vat number prefix. |
| 141 | * |
| 142 | * @param string $country |
| 143 | * |
| 144 | * @return string |
| 145 | */ |
| 146 | private static function get_vat_number_prefix($country) |
| 147 | { |
| 148 | switch ($country) { |
| 149 | // Greek VAT numbers begin with EL, not GR. |
| 150 | case 'GR' : |
| 151 | $vat_prefix = 'EL'; |
| 152 | break; |
| 153 | // makes monaco use france's tax rate |
| 154 | case 'MC' : |
| 155 | $vat_prefix = 'FR'; |
| 156 | break; |
| 157 | // makes UK use Northern ireland's tax rate |
| 158 | case 'GB' : |
| 159 | $vat_prefix = 'XI'; |
| 160 | break; |
| 161 | default : |
| 162 | $vat_prefix = $country; |
| 163 | break; |
| 164 | } |
| 165 | |
| 166 | return $vat_prefix; |
| 167 | } |
| 168 | |
| 169 | private static function get_eu_countries() |
| 170 | { |
| 171 | return TaxService::init()->get_eu_countries(); |
| 172 | } |
| 173 | } |
| 174 |