osm.php

<?php
/*
  +--------------------------------------------------------------------+
  | CiviCRM OSM Geocoding module (SYS-OSM)                             |
  +--------------------------------------------------------------------+
  | Copyright SYSTOPIA (c) 2014-2015                                   |
  +--------------------------------------------------------------------+
  | This is free software; you can copy, modify, and distribute it     |
  | under the terms of the GNU Affero General Public License           |
  | Version 3, 19 November 2007 and the CiviCRM Licensing Exception.   |
  |                                                                    |
  | SYS-OSM is distributed in the hope that it will be useful, but     |
  | WITHOUT ANY WARRANTY; without even the implied warranty of         |
  | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.               |
  | See the GNU Affero General Public License for more details.        |
  |                                                                    |
  | You should have received a copy of the GNU Affero General Public   |
  | License and the SYS-OSM Licensing Exception along                  |
  | with this program; if not, contact SYSTOPIA                        |
  | at info[AT]systopia[DOT]de. If you have questions about the        |
  | GNU Affero General Public License or the licensing of CiviCRM,     |
  | see the CiviCRM license FAQ at http://civicrm.org/licensing        |
  +--------------------------------------------------------------------+
*/
  
require_once 'osm.civix.php';

/**
 * Implementation of hook_civicrm_config
 */
function osm_civicrm_config(&$config) {
  _osm_civix_civicrm_config($config);
}

/**
 * Implementation of hook_civicrm_install
 */
function osm_civicrm_install() {
  return _osm_civix_civicrm_install();
}

/**
 * Implementation of hook_civicrm_enable
 */
function osm_civicrm_enable() {
  return _osm_civix_civicrm_enable();
}

/**
 * Implementation of hook_civicrmPre
 *
 * Used to prevent NULL geo_code_1 & geo_code_2 values being written to the database
 * when the address data being written is otherwise no different to the existing
 * address
 *
 */
function osm_civicrm_pre($op, $objectName, $id, &$params) {
  if ($objectName === 'Address' && $op === 'edit' && !is_null($id)) {

    if ($params['manual_geo_code'] == 1) {
      return;
    }

    $params = array_map(function($value) {
      return $value === "null" ? NULL : $value;
    }, $params);

    $curr_addr = \Civi\Api4\Address::get(FALSE)
      ->addWhere('id', '=', $id)
      ->execute()
      ->first();

    $fields_to_check = [
      'city',
      'country_id',
      'county_id',
      'postal_code',
      'state_province_id',
      'street_address',
      'supplemental_address_1',
      'supplemental_address_2',
      'supplemental_address_3',
    ];

    $fields_match = TRUE;
    foreach ($fields_to_check as $field) {
      if (isset($params[$field])) {
        $fields_match = (strtolower($curr_addr[$field]) == strtolower($params[$field]));
        if (!$fields_match) {
          break;
        }
      }
    }

    if ($fields_match) {
      // Address data is the same, now decide if we keep existing or use
      // new geo_code_x values (we don't want NULL or "Null Island")
      $curr_addr_has_geo_codes = (!empty($curr_addr['geo_code_1']) && !empty($curr_addr['geo_code_2']));
      $new_addr_has_geo_codes = (!empty($params['geo_code_1']) && !empty($params['geo_code_2']));

      if ($curr_addr_has_geo_codes && !$new_addr_has_geo_codes) {
        unset($params['geo_code_1']);
        unset($params['geo_code_2']);
      }
    }

  }
}