phpcs - Fix error, "Visibility must be declared on method"
[civicrm-core.git] / CRM / Utils / Address / USPS.php
CommitLineData
6a488035
TO
1<?php
2/*
3 +--------------------------------------------------------------------+
39de6fd5 4 | CiviCRM version 4.6 |
6a488035 5 +--------------------------------------------------------------------+
06b69b18 6 | Copyright CiviCRM LLC (c) 2004-2014 |
6a488035
TO
7 +--------------------------------------------------------------------+
8 | This file is a part of CiviCRM. |
9 | |
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. |
13 | |
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. |
18 | |
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 +--------------------------------------------------------------------+
26*/
27
28/**
29 *
30 * @package CRM
06b69b18 31 * @copyright CiviCRM LLC (c) 2004-2014
6a488035
TO
32 * $Id$
33 *
34 */
35
36/**
37 * Address utilties
38 */
39class CRM_Utils_Address_USPS {
40
5bc392e6
EM
41 /**
42 * @param $values
43 *
44 * @return bool
45 */
00be9182 46 public static function checkAddress(&$values) {
6a488035
TO
47 if (!isset($values['street_address']) ||
48 (!isset($values['city']) &&
49 !isset($values['state_province']) &&
50 !isset($values['postal_code'])
51 )
52 ) {
53 return FALSE;
54 }
55
56
57 $userID = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::ADDRESS_STANDARDIZATION_PREFERENCES_NAME,
58 'address_standardization_userid'
59 );
60 $url = CRM_Core_BAO_Setting::getItem(CRM_Core_BAO_Setting::ADDRESS_STANDARDIZATION_PREFERENCES_NAME,
61 'address_standardization_url'
62 );
63
64 if (empty($userID) ||
65 empty($url)
66 ) {
67 return FALSE;
68 }
69
70 $address2 = str_replace(',', '', $values['street_address']);
71
72 $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>';
73
74 require_once 'HTTP/Request.php';
75 $request = new HTTP_Request();
76
77 $request->setURL($url);
78
79 $request->addQueryString('API', 'Verify');
80 $request->addQueryString('XML', $XMLQuery);
81
82 $response = $request->sendRequest();
83
84 $session = CRM_Core_Session::singleton();
85
86 $code = $request->getResponseCode();
87 if ($code != 200) {
88 $session->setStatus(ts('USPS Address Lookup Failed with HTTP status code: %1',
89 array(1 => $code)
90 ));
91 return FALSE;
92 }
93
94 $responseBody = $request->getResponseBody();
95
96 $xml = simplexml_load_string($responseBody);
97
98 if (is_null($xml) || is_null($xml->Address)) {
99 $session->setStatus(ts('Your USPS API Lookup has Failed.'));
100 return FALSE;
101 }
102
103 if ($xml->Number == '80040b1a') {
104 $session->setStatus(ts('Your USPS API Authorization has Failed.'));
105 return FALSE;
106 }
107
108 if (array_key_exists('Error', $xml->Address)) {
109 $session->setStatus(ts('Address not found in USPS database.'));
110 return FALSE;
111 }
112
113 $values['street_address'] = (string)$xml->Address->Address2;
114 $values['city'] = (string)$xml->Address->City;
115 $values['state_province'] = (string)$xml->Address->State;
116 $values['postal_code'] = (string)$xml->Address->Zip5;
117 $values['postal_code_suffix'] = (string)$xml->Address->Zip4;
118
119 if (array_key_exists('Address1', $xml->Address)) {
120 $values['supplemental_address_1'] = (string)$xml->Address->Address1;
121 }
122
123 return TRUE;
124 }
125}
126