3 +--------------------------------------------------------------------+
4 | CiviCRM version 4.7 |
5 +--------------------------------------------------------------------+
6 | Copyright CiviCRM LLC (c) 2004-2015 |
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 +--------------------------------------------------------------------+
31 * @copyright CiviCRM LLC (c) 2004-2015
35 * Class that uses Yahoo! PlaceFinder API to retrieve the lat/long of an address
36 * Documentation is at http://developer.yahoo.com/geo/placefinder/
38 class CRM_Utils_Geocode_Yahoo
{
41 * Server to retrieve the lat/long
45 static protected $_server = 'query.yahooapis.com';
52 static protected $_uri = '/v1/public/yql';
55 * Function that takes an address array and gets the latitude / longitude
56 * and postal code for this address. Note that at a later stage, we could
57 * make this function also clean up the address into a more valid format
59 * @param array $values
60 * Associative array of address data: country, street_address, city, state_province, postal code.
61 * @param bool $stateName
62 * This parameter currently has no function.
65 * true if we modified the address, false otherwise
67 public static function format(&$values, $stateName = FALSE) {
68 CRM_Utils_System
::checkPHPVersion(5, TRUE);
70 $config = CRM_Core_Config
::singleton();
72 $whereComponents = array();
74 if (!empty($values['street_address'])) {
75 $whereComponents['street'] = $values['street_address'];
78 if ($city = CRM_Utils_Array
::value('city', $values)) {
79 $whereComponents['city'] = $city;
82 if (!empty($values['state_province'])) {
83 if (!empty($values['state_province_id'])) {
84 $stateProvince = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_StateProvince', $values['state_province_id']);
88 $stateProvince = CRM_Core_DAO
::getFieldValue('CRM_Core_DAO_StateProvince',
89 $values['state_province'],
95 $stateProvince = $values['state_province'];
99 // dont add state twice if replicated in city (happens in NZ and other countries, CRM-2632)
100 if ($stateProvince != $city) {
101 $whereComponents['state'] = $stateProvince;
105 if (!empty($values['postal_code'])) {
106 $whereComponents['postal'] = $values['postal_code'];
109 if (!empty($values['country'])) {
110 $whereComponents['country'] = $values['country'];
113 foreach ($whereComponents as $componentName => $componentValue) {
114 $whereComponents[$componentName] = urlencode("$componentName=\"$componentValue\"");
117 $add = 'q=' . urlencode('select * from geo.placefinder where ');
119 $add .= implode(urlencode(' and '), $whereComponents);
121 $add .= "&appid=" . urlencode($config->mapAPIKey
);
123 $query = 'http://' . self
::$_server . self
::$_uri . '?' . $add;
125 require_once 'HTTP/Request.php';
126 $request = new HTTP_Request($query);
127 $request->sendRequest();
128 $string = $request->getResponseBody();
129 // see CRM-11359 for why we suppress errors with @
130 $xml = @simplexml_load_string
($string);
132 if ($xml === FALSE) {
133 // account blocked maybe?
134 CRM_Core_Error
::debug_var('Geocoding failed. Message from Yahoo:', $string);
138 if ($xml->getName() == 'error') {
139 CRM_Core_Error
::debug_var('query', $query);
140 CRM_Core_Error
::debug_log_message('Geocoding failed. Message from Yahoo: ' . (string) $xml->description
);
144 if (is_a($xml->results
->Result
, 'SimpleXMLElement')) {
146 $result = get_object_vars($xml->results
->Result
);
147 foreach ($result as $key => $val) {
148 if (is_scalar($val) &&
151 $ret[(string) $key] = (string) $val;
155 $values['geo_code_1'] = $ret['latitude'];
156 $values['geo_code_2'] = $ret['longitude'];
158 if (!empty($ret['postal'])) {
159 $current_pc = CRM_Utils_Array
::value('postal_code', $values);
160 $skip_postal = FALSE;
163 $current_pc_suffix = CRM_Utils_Array
::value('postal_code_suffix', $values);
164 $current_pc_complete = $current_pc . $current_pc_suffix;
165 $new_pc_complete = preg_replace("/[+-]/", '', $ret['postal']);
167 // if a postal code was already entered, don't change it, except to make it more precise
168 if (strpos($new_pc_complete, $current_pc_complete) !== 0) {
169 // Don't bother anonymous users with the message - they can't change a form they just submitted anyway
170 if (CRM_Utils_System
::isUserLoggedIn()) {
171 $msg = ts('The Yahoo Geocoding system returned a different postal code (%1) than the one you entered (%2). If you want the Yahoo value, please delete the current postal code and save again.', array(
173 2 => $current_pc_suffix ?
"$current_pc-$current_pc_suffix" : $current_pc,
176 CRM_Core_Session
::setStatus($msg, ts('Postal Code Mismatch'), 'error');
183 $values['postal_code'] = $ret['postal'];
185 /* the following logic to split the string was borrowed from
186 CRM/Core/BAO/Address.php -- CRM_Core_BAO_Address::fixAddress.
187 This is actually the function that calls the geocoding
188 script to begin with, but the postal code business takes
189 place before geocoding gets called.
192 if (preg_match('/^(\d{4,5})[+-](\d{4})$/',
197 $values['postal_code'] = $match[1];
198 $values['postal_code_suffix'] = $match[2];
205 // reset the geo code values if we did not get any good values
206 $values['geo_code_1'] = $values['geo_code_2'] = 'null';