3 +--------------------------------------------------------------------+
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2020 |
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
10 | CiviCRM is free software; you can copy, modify, and distribute it |
11 | under the terms of the GNU Affero General Public License |
12 | Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
14 | CiviCRM is distributed in the hope that it will be useful, but |
15 | WITHOUT ANY WARRANTY; without even the implied warranty of |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
17 | See the GNU Affero General Public License for more details. |
19 | You should have received a copy of the GNU Affero General Public |
20 | License and the CiviCRM Licensing Exception along |
21 | with this program; if not, contact CiviCRM LLC |
22 | at info[AT]civicrm[DOT]org. If you have questions about the |
23 | GNU Affero General Public License or the licensing of CiviCRM, |
24 | see the CiviCRM license FAQ at http://civicrm.org/licensing |
25 +--------------------------------------------------------------------+
30 * @copyright CiviCRM LLC (c) 2004-2020
36 class CRM_Utils_Address_USPS
{
39 * Whether USPS validation should be disabled during import.
43 protected static $_disabled = FALSE;
46 * Disable the USPS validation.
48 * @param bool $disable
50 public static function disable($disable = TRUE) {
51 self
::$_disabled = $disable;
55 * Check address against USPS.
57 * @param array $values
61 public static function checkAddress(&$values) {
62 if (self
::$_disabled) {
65 if (!isset($values['street_address']) ||
66 (!isset($values['city']) &&
67 !isset($values['state_province']) &&
68 !isset($values['postal_code'])
74 $userID = Civi
::settings()->get('address_standardization_userid');
75 $url = Civi
::settings()->get('address_standardization_url');
83 $address2 = str_replace(',', '', $values['street_address']);
85 $XMLQuery = '<AddressValidateRequest USERID="' . $userID . '"><Address ID="0"><Address1>' . CRM_Utils_Array
::value('supplemental_address_1', $values, '') . '</Address1><Address2>' . $address2 . '</Address2><City>' . $values['city'] . '</City><State>' . $values['state_province'] . '</State><Zip5>' . $values['postal_code'] . '</Zip5><Zip4>' . CRM_Utils_Array
::value('postal_code_suffix', $values, '') . '</Zip4></Address></AddressValidateRequest>';
87 require_once 'HTTP/Request.php';
88 $request = new HTTP_Request();
90 $request->setURL($url);
92 $request->addQueryString('API', 'Verify');
93 $request->addQueryString('XML', $XMLQuery);
95 $response = $request->sendRequest();
97 $session = CRM_Core_Session
::singleton();
99 $code = $request->getResponseCode();
101 $session->setStatus(ts('USPS Address Lookup Failed with HTTP status code: %1',
107 $responseBody = $request->getResponseBody();
109 $xml = simplexml_load_string($responseBody);
111 if (is_null($xml) ||
is_null($xml->Address
)) {
112 $session->setStatus(ts('Your USPS API Lookup has Failed.'));
116 if ($xml->Number
== '80040b1a') {
117 $session->setStatus(ts('Your USPS API Authorization has Failed.'));
121 if (array_key_exists('Error', $xml->Address
)) {
122 $session->setStatus(ts('Address not found in USPS database.'));
126 $values['street_address'] = (string) $xml->Address
->Address2
;
127 $values['city'] = (string) $xml->Address
->City
;
128 $values['state_province'] = (string) $xml->Address
->State
;
129 $values['postal_code'] = (string) $xml->Address
->Zip5
;
130 $values['postal_code_suffix'] = (string) $xml->Address
->Zip4
;
132 if (array_key_exists('Address1', $xml->Address
)) {
133 $values['supplemental_address_1'] = (string) $xml->Address
->Address1
;