civigeometry.php

<?php

require_once 'civigeometry.civix.php';
use CRM_Civigeometry_ExtensionUtil as E;

/**
 * Implements hook_civicrm_config().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_config
 */
function civigeometry_civicrm_config(&$config) {
  _civigeometry_civix_civicrm_config($config);
  Civi::service('dispatcher')->addListener('hook_civicrm_post', 'civigeometry_symfony_civicrm_post', -99);
}

/**
 * Implements hook_civicrm_install().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_install
 */
function civigeometry_civicrm_install() {
  _civigeometry_civix_civicrm_install();
}

/**
 * Implements hook_civicrm_enable().
 *
 * @link http://wiki.civicrm.org/confluence/display/CRMDOC/hook_civicrm_enable
 */
function civigeometry_civicrm_enable() {
  _civigeometry_civix_civicrm_enable();
}

/**
 * Implements hook_civicrm_permission().
 *
 * Declares CMS based Permissions for this Extension.
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_permission/
 */
function civigeometry_civicrm_permission(&$permissions) {
  $prefix = E::ts('CiviCRM Geometry Extension: ');
  $permissions['administer geometry'] = [
    'label' => $prefix . E::ts('Administer Geometry'),
    'description' => E::ts('Create and Update Geometries and Geometry Collections in the System'),
  ];
  $permissions['access geometry'] = [
    'label' => $prefix . E::ts('Access Geometry'),
    'description' => E::ts('Access Geometries and their collections'),
  ];
}

/**
 * Implements hook_civicrm_alterAPIPermissions().
 *
 * Declares what permissions are required to do what API Access when check_permissions is passed as true.
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_permission/
 */
function civigeometry_civicrm_alterAPIPermissions($entity, $action, &$params, &$permissions) {
  $permissions['address']['getgeometries'] = [['access civicrm', 'access AJAX API']];
  $permissions['geometry']['create'] = $permissions['geometry']['delete'] = [['administer geometry', 'administer civicrm']];
  $permissions['geometry']['default'] = array('access geometry');
  $permissions['geometry_collection']['create'] = [['administer geometry', 'administer civicrm']];
  $permissions['geometry_collection']['default'] = ['access geometry'];
  $permissions['geometry_collection']['unarchive'] = $permissions['geometry_collection']['archive'] = $permissions['geometry_collection']['delete'] = $permissions['geometry_collection']['create'];
  $permissions['geometry_type']['create'] = $permissions['geometry_type']['delete'] = [['administer geometry', 'administer civicrm']];
  $permissions['geometry_type']['default'] = ['access geometry'];
  $permissions['geometry_collection_type'] = $permissions['geometry_type'];
}

/**
 *
 * Callback function for enqueuing new geoplaceAddress tasks
 *
 * @param int $objectId
 *
 */
function _civigeometry_geoplaceAddress($objectId) {
  $queue = CRM_CiviGeometry_Helper::singleton()->getQueue();
  $address = civicrm_api3('Address', 'get', ['id' => $objectId])['values'][$objectId];
  if (!empty($address['geo_code_2']) && !empty($address['geo_code_1'])) {
    $task = new CRM_Queue_Task(
      ['CRM_CiviGeometry_Tasks', 'geoplaceAddress'],
      [$objectId],
      sprintf('CiviGeometry Geoplace Address %s', $objectId)
    );
    $queue->createItem($task);
  }
}

/**
 *
 * Callback function for enqueuing new archive geometry cleanup tasks
 *
 * @param int $objectId
 *
 */
function _civigeometry_archiveGeometry($objectId) {
  $dao = new CRM_CiviGeometry_DAO_GeometryEntity();
  $dao->whereAdd(CRM_Core_DAO::composeQuery('geometry_id = %1', [1 => [$objectId, 'Positive']]));
  $dao->whereAdd("entity_table = 'civicrm_address'");
  $dao->delete(TRUE);
}

/**
 *
 * Callback function for enqueuing new geometry relationships tasks
 *
 * @param int $objectId
 *
 */
function _civigeometry_buildGeometryRelationships($objectId) {
  $queue = CRM_CiviGeometry_Helper::singleton()->getQueue();
  $task = new CRM_Queue_Task(
      ['CRM_CiviGeometry_Tasks', 'buildGeometryRelationships'],
      [$objectId],
      sprintf('Build Geometry Relationships for Geometry %s', $objectId)
  );
  $queue->createItem($task);
}

/**
 * Implements hook_civicrm_post().
 *
 * This adds records to civigeometry_address_geometry when:
 * 1. Whenever an address is updated or created
 * 2. Whenever a geometry is created
 *
 * Removes any records from the civigeomety_address_geometry table when:
 * 1. A geometry gets archived.
 */
function civigeometry_symfony_civicrm_post($event) {
  $hookValues = $event->getHookValues();
  // Hook value keys are
  // 0 = op
  // 1 = objectName
  // 2 = objectId
  // 3 = objectREf
  if ($hookValues[0] !== 'delete' && $hookValues[0] !== 'geoplace' && $hookValues[1] == 'Address') {
    if (CRM_Core_Transaction::isActive()) {
      CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT,
        '_civigeometry_geoplaceAddress', [$hookValues[2]]
      );
    }
    else {
      _civigeometry_geoplaceAddress($hookValues[2]);
    }
  }
  // If a geometry has been archived ensure that all address records of it in the GeometryEntity table are removed.
  if ($hookValues[0] == 'archive' && $hookValues[1] == 'Geometry') {
    if (CRM_Core_Transaction::isActive()) {
      CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT,
        '_civigeometry_archiveGeometry', [$hookValues[2]]
      );
    }
    else {
      _civigeometry_archiveGeometry($hookValues[2]);
    }
  }
  if ($hookValues[0] == 'create' && $hookValues[1] == 'Geometry') {
    if (CRM_Core_Transaction::isActive()) {
      CRM_Core_Transaction::addCallback(CRM_Core_Transaction::PHASE_POST_COMMIT,
        '_civigeometry_buildGeometryRelationships', [$hookValues[2]]
      );
    }
    else {
      _civigeometry_buildGeometryRelationships($hookValues[2]);
    }
  }
}

/**
 * Implements hook_civicrm_merge().
 *
 * @link https://docs.civicrm.org/dev/en/latest/hooks/hook_civicrm_merge/
 */
function civigeometry_civicrm_merge($type, &$data, $mainId = NULL, $otherId = NULL, $tables = NULL) {
  switch ($type) {
    case 'eidRefs':
      $data['civigeometry_geometry_entity'] = ['entity_table' => 'entity_id'];
      break;

    case 'sqls':
      $data[] = "DELETE cge FROM civigeometry_geometry_entity cge
                 INNER JOIN civicrm_address ca ON ca.id = cge.entity_id AND cge.entity_table = 'civicrm_address'
                 WHERE ca.contact_id = {$otherId}";
      break;

  }
}